IoT / Client / list_billing_groups

list_billing_groups#

IoT.Client.list_billing_groups(**kwargs)#

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

See also: AWS API Documentation

Request Syntax

response = client.list_billing_groups(
    nextToken='string',
    maxResults=123,
    namePrefixFilter='string'
)
Parameters:
  • nextToken (string) – To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

  • maxResults (integer) – The maximum number of results to return per request.

  • namePrefixFilter (string) – Limit the results to billing groups whose names have the given prefix.

Return type:

dict

Returns:

Response Syntax

{
    'billingGroups': [
        {
            'groupName': 'string',
            'groupArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • billingGroups (list) –

      The list of billing groups.

      • (dict) –

        The name and ARN of a group.

        • groupName (string) –

          The group name.

        • groupArn (string) –

          The group ARN.

    • nextToken (string) –

      The token to use to get the next set of results, or null if there are no additional results.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.ThrottlingException