BillingandCostManagementPricingCalculator / Client / create_workload_estimate

create_workload_estimate

BillingandCostManagementPricingCalculator.Client.create_workload_estimate(**kwargs)

Creates a new workload estimate to model costs for a specific workload.

See also: AWS API Documentation

Request Syntax

response = client.create_workload_estimate(
    name='string',
    clientToken='string',
    rateType='BEFORE_DISCOUNTS'|'AFTER_DISCOUNTS',
    tags={
        'string': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  A descriptive name for the workload estimate.

• clientToken (string) –

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

  This field is autopopulated if not provided.

• rateType (string) – The type of pricing rates to use for the estimate.

• tags (dict) –

  The tags to apply to the workload estimate.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'createdAt': datetime(2015, 1, 1),
    'expiresAt': datetime(2015, 1, 1),
    'rateType': 'BEFORE_DISCOUNTS'|'AFTER_DISCOUNTS',
    'rateTimestamp': datetime(2015, 1, 1),
    'status': 'UPDATING'|'VALID'|'INVALID'|'ACTION_NEEDED',
    'totalCost': 123.0,
    'costCurrency': 'USD',
    'failureMessage': 'string'
}

Response Structure

• (dict) –

  Mixin for common fields returned by CRUD APIs

  • id (string) –

    The unique identifier for the created workload estimate.

  • name (string) –

    The name of the created workload estimate.

  • createdAt (datetime) –

    The timestamp when the workload estimate was created.

  • expiresAt (datetime) –

    The timestamp when the workload estimate will expire.

  • rateType (string) –

    The type of pricing rates used for the estimate.

  • rateTimestamp (datetime) –

    The timestamp of the pricing rates used for the estimate.

  • status (string) –

    The current status of the workload estimate.

  • totalCost (float) –

    The total estimated cost for the workload.

  • costCurrency (string) –

    The currency of the estimated cost.

  • failureMessage (string) –

    An error message if the workload estimate creation failed.

Exceptions

• BillingandCostManagementPricingCalculator.Client.exceptions.ConflictException

• BillingandCostManagementPricingCalculator.Client.exceptions.ValidationException

• BillingandCostManagementPricingCalculator.Client.exceptions.DataUnavailableException

• BillingandCostManagementPricingCalculator.Client.exceptions.ServiceQuotaExceededException

• BillingandCostManagementPricingCalculator.Client.exceptions.InternalServerException

• BillingandCostManagementPricingCalculator.Client.exceptions.AccessDeniedException

• BillingandCostManagementPricingCalculator.Client.exceptions.ThrottlingException