BillingandCostManagementPricingCalculator / Paginator / ListBillScenarios

ListBillScenarios

class BillingandCostManagementPricingCalculator.Paginator.ListBillScenarios

paginator = client.get_paginator('list_bill_scenarios')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BillingandCostManagementPricingCalculator.Client.list_bill_scenarios().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'STATUS'|'NAME',
            'values': [
                'string',
            ],
            'matchOption': 'EQUALS'|'STARTS_WITH'|'CONTAINS'
        },
    ],
    createdAtFilter={
        'afterTimestamp': datetime(2015, 1, 1),
        'beforeTimestamp': datetime(2015, 1, 1)
    },
    expiresAtFilter={
        'afterTimestamp': datetime(2015, 1, 1),
        'beforeTimestamp': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  Filters to apply to the list of bill scenarios.

  • (dict) –

    Represents a filter for listing bill scenarios.

    • name (string) – [REQUIRED]

      The name of the filter attribute.

    • values (list) – [REQUIRED]

      The values to filter by.

      • (string) –

    • matchOption (string) –

      The match option for the filter (e.g., equals, contains).

• createdAtFilter (dict) –

  Filter bill scenarios based on their creation date.

  • afterTimestamp (datetime) –

    Include results after this timestamp.

  • beforeTimestamp (datetime) –

    Include results before this timestamp.

• expiresAtFilter (dict) –

  Filter bill scenarios based on their expiration date.

  • afterTimestamp (datetime) –

    Include results after this timestamp.

  • beforeTimestamp (datetime) –

    Include results before this timestamp.

• 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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'billInterval': {
                'start': datetime(2015, 1, 1),
                'end': datetime(2015, 1, 1)
            },
            'status': 'READY'|'LOCKED'|'FAILED',
            'createdAt': datetime(2015, 1, 1),
            'expiresAt': datetime(2015, 1, 1),
            'failureMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of bill scenarios for the account.

    • (dict) –

      Provides a summary of a bill scenario.

      • id (string) –

        The unique identifier of the bill scenario.

      • name (string) –

        The name of the bill scenario.

      • billInterval (dict) –

        The time period covered by the bill scenario.

        • start (datetime) –

          The start date and time of the interval.

        • end (datetime) –

          The end date and time of the interval.

      • status (string) –

        The current status of the bill scenario.

      • createdAt (datetime) –

        The timestamp when the bill scenario was created.

      • expiresAt (datetime) –

        The timestamp when the bill scenario will expire.

      • failureMessage (string) –

        An error message if the bill scenario creation or processing failed.

  • NextToken (string) –

    A token to resume pagination.