Billing / Client / list_billing_views

list_billing_views#

Billing.Client.list_billing_views(**kwargs)#

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

See also: AWS API Documentation

Request Syntax

response = client.list_billing_views(
    activeTimeRange={
        'activeAfterInclusive': datetime(2015, 1, 1),
        'activeBeforeInclusive': datetime(2015, 1, 1)
    },
    arns=[
        'string',
    ],
    billingViewTypes=[
        'PRIMARY'|'BILLING_GROUP'|'CUSTOM',
    ],
    ownerAccountId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • activeTimeRange (dict) –

    The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

    • activeAfterInclusive (datetime) – [REQUIRED]

      The inclusive time range start date.

    • activeBeforeInclusive (datetime) – [REQUIRED]

      The inclusive time range end date.

  • arns (list) –

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

    • (string) –

  • billingViewTypes (list) –

    The type of billing view.

    • (string) –

  • ownerAccountId (string) – The list of owners of the billing view.

  • maxResults (integer) – The maximum number of billing views to retrieve. Default is 100.

  • nextToken (string) – The pagination token that is used on subsequent calls to list billing views.

Return type:

dict

Returns:

Response Syntax

{
    'billingViews': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'ownerAccountId': 'string',
            'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • billingViews (list) –

      A list of BillingViewListElement retrieved.

      • (dict) –

        A representation of a billing view.

        • arn (string) –

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

        • name (string) –

          A list of names of the Billing view.

        • description (string) –

          The description of the billing view.

        • ownerAccountId (string) –

          The list of owners of the Billing view.

        • billingViewType (string) –

          The type of billing view.

    • nextToken (string) –

      The pagination token to use on subsequent calls to list billing views.

Exceptions

  • Billing.Client.exceptions.ThrottlingException

  • Billing.Client.exceptions.AccessDeniedException

  • Billing.Client.exceptions.ValidationException

  • Billing.Client.exceptions.InternalServerException