AWS IoT
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeBillingGroup

Returns information about a billing group.

Request Syntax

GET /billing-groups/billingGroupName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

billingGroupName

The name of the billing group.

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "billingGroupArn": "string", "billingGroupId": "string", "billingGroupMetadata": { "creationDate": number }, "billingGroupName": "string", "billingGroupProperties": { "billingGroupDescription": "string" }, "version": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

billingGroupArn

The ARN of the billing group.

Type: String

billingGroupId

The ID of the billing group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

billingGroupMetadata

Additional information about the billing group.

Type: BillingGroupMetadata object

billingGroupName

The name of the billing group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

billingGroupProperties

The properties of the billing group.

Type: BillingGroupProperties object

version

The version of the billing group.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: