/billing-groups/{billingGroupName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/billing-groups/'

Response Example

200 - Example 1

{
    "billingGroupName": "string",
    "billingGroupId": "string",
    "billingGroupArn": "string",
    "version": 0,
    "billingGroupProperties": {
        "billingGroupDescription": "string"
    },
    "billingGroupMetadata": {
        "creationDate": "string"
    }
}

Request

Path Params

billingGroupName

string

required

The name of the billing group.

Responses

🟢200Success

application/json

Body

billingGroupName

string

optional

The name of the billing group.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

billingGroupId

string

optional

The ID of the billing group.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9\-]+

billingGroupArn

string

optional

The ARN of the billing group.

version

integer

optional

The version of the billing group.

billingGroupProperties

object

optional

The properties of the billing group.

billingGroupDescription

string

optional

The description of the billing group.

<= 2028 characters

Match pattern:

[\p{Graph}\x20]*

billingGroupMetadata

object

optional

Additional information about the billing group.

creationDate

string <date-time>

optional

The date the billing group was created.

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException

🟠483ResourceNotFoundException

Modified at 2022-09-10 23:12:13

/service-profiles/{Id}