Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateWorkloadEstimate

Updates an existing workload estimate.

Request Syntax


{
   "expiresAt": number,
   "identifier": "string",
   "name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

expiresAt

The new expiration date for the workload estimate.

Type: Timestamp

Required: No

identifier

The unique identifier of the workload estimate to update.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

name

The new name for the workload estimate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: No

Response Syntax


{
   "costCurrency": "string",
   "createdAt": number,
   "expiresAt": number,
   "failureMessage": "string",
   "id": "string",
   "name": "string",
   "rateTimestamp": number,
   "rateType": "string",
   "status": "string",
   "totalCost": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

costCurrency

The currency of the updated estimated cost.

Type: String

Valid Values: USD

createdAt

The timestamp when the workload estimate was originally created.

Type: Timestamp

expiresAt

The updated expiration timestamp for the workload estimate.

Type: Timestamp

failureMessage

An error message if the workload estimate update failed.

Type: String

id

The unique identifier of the updated workload estimate.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name

The updated name of the workload estimate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

rateTimestamp

The timestamp of the pricing rates used for the updated estimate.

Type: Timestamp

rateType

The type of pricing rates used for the updated estimate.

Type: String

Valid Values: BEFORE_DISCOUNTS | AFTER_DISCOUNTS | AFTER_DISCOUNTS_AND_COMMITMENTS

status

The current status of the updated workload estimate.

Type: String

Valid Values: UPDATING | VALID | INVALID | ACTION_NEEDED

totalCost

The updated total estimated cost for the workload.

Type: Double

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 400

DataUnavailableException

The requested data is currently unavailable.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon support.

retryAfterSeconds: An internal error has occurred. Retry your request, but if the problem persists, contact Amazon support.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

quotaCode: The quota code that exceeded the throttling limit.
retryAfterSeconds: The service code that exceeded the throttling limit. Retry your request, but if the problem persists, contact Amazon support.
serviceCode: The service code that exceeded the throttling limit.

HTTP Status Code: 400

ValidationException

The input provided fails to satisfy the constraints specified by an Amazon service.

fieldList: The list of fields that are invalid.
reason: The reason for the validation exception.

HTTP Status Code: 400