BillingandCostManagementPricingCalculator / Client / list_bill_scenarios

list_bill_scenarios#

BillingandCostManagementPricingCalculator.Client.list_bill_scenarios(**kwargs)#

Lists all bill scenarios for the account.

See also: AWS API Documentation

Request Syntax

response = client.list_bill_scenarios(
    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)
    },
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – A token to retrieve the next page of results.

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

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 retrieve the next page of results, if any.

Exceptions