v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436232180.1 KB

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

post/#X-Amz-Target=AWSBCMPricingCalculator.CreateWorkloadEstimate

Headers

X-Amz-Target'AWSBCMPricingCalculator.CreateWorkloadEstimate' required

Request body

namestring required

A descriptive name for the workload estimate.

clientTokenstring

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

rateType'BEFORE_DISCOUNTS' | 'AFTER_DISCOUNTS' | 'AFTER_DISCOUNTS_AND_COMMITMENTS'

The type of pricing rates to use for the estimate.

tagsobject

The tags to apply to the workload estimate.

Response

Success

idstring required

The unique identifier for the created workload estimate.

namestring

The name of the created workload estimate.

createdAtstring date-time

The timestamp when the workload estimate was created.

expiresAtstring date-time

The timestamp when the workload estimate will expire.

rateType'BEFORE_DISCOUNTS' | 'AFTER_DISCOUNTS' | 'AFTER_DISCOUNTS_AND_COMMITMENTS'

The type of pricing rates used for the estimate.

rateTimestampstring date-time

The timestamp of the pricing rates used for the estimate.

status'UPDATING' | 'VALID' | 'INVALID' | 'ACTION_NEEDED'

The current status of the workload estimate.

totalCostnumber double

The total estimated cost for the workload.

costCurrency'USD'

The currency of the estimated cost.

failureMessagestring

An error message if the workload estimate creation failed.