- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeBillingGroupCommand
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, DescribeBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DescribeBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DescribeBillingGroupRequest
billingGroupName: "STRING_VALUE", // required
};
const command = new DescribeBillingGroupCommand(input);
const response = await client.send(command);
// { // DescribeBillingGroupResponse
// billingGroupName: "STRING_VALUE",
// billingGroupId: "STRING_VALUE",
// billingGroupArn: "STRING_VALUE",
// version: Number("long"),
// billingGroupProperties: { // BillingGroupProperties
// billingGroupDescription: "STRING_VALUE",
// },
// billingGroupMetadata: { // BillingGroupMetadata
// creationDate: new Date("TIMESTAMP"),
// },
// };
DescribeBillingGroupCommand Input
See DescribeBillingGroupCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
billingGroupNameRequired | string | undefined | The name of the billing group. |
DescribeBillingGroupCommand Output
See DescribeBillingGroupCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
billingGroupArn | string | undefined | The ARN of the billing group. |
billingGroupId | string | undefined | The ID of the billing group. |
billingGroupMetadata | BillingGroupMetadata | undefined | Additional information about the billing group. |
billingGroupName | string | undefined | The name of the billing group. |
billingGroupProperties | BillingGroupProperties | undefined | The properties of the billing group. |
version | number | undefined | The version of the billing group. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | An unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| ThrottlingException | client | The rate exceeds the limit. |
| IoTServiceException | Base exception class for all service exceptions from IoT service. |