BillingandCostManagementPricingCalculator / Client / get_bill_scenario

get_bill_scenario#

BillingandCostManagementPricingCalculator.Client.get_bill_scenario(**kwargs)#

Retrieves details of a specific bill scenario.

See also: AWS API Documentation

Request Syntax

response = client.get_bill_scenario(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The unique identifier of the bill scenario to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    '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'
}

Response Structure

  • (dict) –

    • id (string) –

      The unique identifier of the retrieved bill scenario.

    • name (string) –

      The name of the retrieved 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 retrieval failed.

Exceptions