BillingandCostManagementPricingCalculator / Client / create_bill_scenario

create_bill_scenario#

BillingandCostManagementPricingCalculator.Client.create_bill_scenario(**kwargs)#

Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

See also: AWS API Documentation

Request Syntax

response = client.create_bill_scenario(
    name='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    A descriptive name for the bill scenario.

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  • tags (dict) –

    The tags to apply to the bill scenario.

    • (string) –

      • (string) –

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 for the created bill scenario.

    • name (string) –

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

Exceptions