Billing / Paginator / ListBillingViews

ListBillingViews

class Billing.Paginator.ListBillingViews

paginator = client.get_paginator('list_billing_views')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Billing.Client.list_billing_views().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    activeTimeRange={
        'activeAfterInclusive': datetime(2015, 1, 1),
        'activeBeforeInclusive': datetime(2015, 1, 1)
    },
    arns=[
        'string',
    ],
    billingViewTypes=[
        'PRIMARY'|'BILLING_GROUP'|'CUSTOM',
    ],
    ownerAccountId='string',
    sourceAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• sourceAccountId (string) – Filters the results to include only billing views that use the specified account as a source.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'billingViews': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'ownerAccountId': 'string',
            'sourceAccountId': 'string',
            'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM',
            'healthStatus': {
                'statusCode': 'HEALTHY'|'UNHEALTHY'|'CREATING'|'UPDATING',
                'statusReasons': [
                    'SOURCE_VIEW_UNHEALTHY'|'SOURCE_VIEW_UPDATING'|'SOURCE_VIEW_ACCESS_DENIED'|'SOURCE_VIEW_NOT_FOUND'|'CYCLIC_DEPENDENCY'|'SOURCE_VIEW_DEPTH_EXCEEDED'|'AGGREGATE_SOURCE'|'VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT',
                ]
            }
        },
    ],
    '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.

      • sourceAccountId (string) –

        The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

      • billingViewType (string) –

        The type of billing view.

      • healthStatus (dict) –

        The current health status of the billing view.

        • statusCode (string) –

          The current health status code of the billing view.

        • statusReasons (list) –

          A list of reasons explaining the current health status, if applicable.

          • (string) –

  • NextToken (string) –

    A token to resume pagination.