IoT / Client / describe_billing_group

describe_billing_group#

IoT.Client.describe_billing_group(**kwargs)#

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

See also: AWS API Documentation

Request Syntax

response = client.describe_billing_group(
    billingGroupName='string'
)
Parameters:

billingGroupName (string) –

[REQUIRED]

The name of the billing group.

Return type:

dict

Returns:

Response Syntax

{
    'billingGroupName': 'string',
    'billingGroupId': 'string',
    'billingGroupArn': 'string',
    'version': 123,
    'billingGroupProperties': {
        'billingGroupDescription': 'string'
    },
    'billingGroupMetadata': {
        'creationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • billingGroupName (string) –

      The name of the billing group.

    • billingGroupId (string) –

      The ID of the billing group.

    • billingGroupArn (string) –

      The ARN of the billing group.

    • version (integer) –

      The version of the billing group.

    • billingGroupProperties (dict) –

      The properties of the billing group.

      • billingGroupDescription (string) –

        The description of the billing group.

    • billingGroupMetadata (dict) –

      Additional information about the billing group.

      • creationDate (datetime) –

        The date the billing group was created.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.ResourceNotFoundException