list_billing_groups

BillingConductor.Client.list_billing_groups(**kwargs)

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

See also: AWS API Documentation

Request Syntax

response = client.list_billing_groups(
    BillingPeriod='string',
    MaxResults=123,
    NextToken='string',
    Filters={
        'Arns': [
            'string',
        ],
        'PricingPlan': 'string',
        'Statuses': [
            'ACTIVE'|'PRIMARY_ACCOUNT_MISSING',
        ]
    }
)

Parameters

• BillingPeriod (string) -- The preferred billing period to get billing groups.
• MaxResults (integer) -- The maximum number of billing groups to retrieve.
• NextToken (string) -- The pagination token that's used on subsequent calls to get billing groups.
• Filters (dict) --

  A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

  • Arns (list) --

    The list of billing group Amazon Resource Names (ARNs) to retrieve information.

    • (string) --
  • PricingPlan (string) --

    The pricing plan Amazon Resource Names (ARNs) to retrieve information.

  • Statuses (list) --

    A list of billing groups to retrieve their current status for a specific time range

    • (string) --

Return type

dict

Returns

Response Syntax

{
    'BillingGroups': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Description': 'string',
            'PrimaryAccountId': 'string',
            'ComputationPreference': {
                'PricingPlanArn': 'string'
            },
            'Size': 123,
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'Status': 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING',
            'StatusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • BillingGroups (list) --

    A list of BillingGroupListElement retrieved.

    • (dict) --

      A representation of a billing group.

      • Name (string) --

        The name of the billing group.

      • Arn (string) --

        The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.

      • Description (string) --

        The description of the billing group.

      • PrimaryAccountId (string) --

        The account ID that serves as the main account in a billing group.

      • ComputationPreference (dict) --

        The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

        • PricingPlanArn (string) --

          The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.

      • Size (integer) --

        The number of accounts in the particular billing group.

      • CreationTime (integer) --

        The time when the billing group was created.

      • LastModifiedTime (integer) --

        The most recent time when the billing group was modified.

      • Status (string) --

        The billing group status. Only one of the valid values can be used.

      • StatusReason (string) --

        The reason why the billing group is in its current status.

  • NextToken (string) --

    The pagination token that's used on subsequent calls to get billing groups.

Exceptions

• BillingConductor.Client.exceptions.ThrottlingException
• BillingConductor.Client.exceptions.AccessDeniedException
• BillingConductor.Client.exceptions.ValidationException
• BillingConductor.Client.exceptions.InternalServerException
• BillingConductor.Client.exceptions.ResourceNotFoundException