ListWorkloadEstimateUsage
Lists the usage associated with a workload estimate.
Request Syntax
{
"filters": [
{
"matchOption": "string",
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"workloadEstimateId": "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.
- filters
-
Filters to apply to the list of usage items.
Type: Array of ListUsageFilter objects
Required: No
- maxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Maximum value of 25.
Required: No
- nextToken
-
A token to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\S\s]*Required: No
- workloadEstimateId
-
The unique identifier of the workload estimate to list usage for.
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
Response Syntax
{
"items": [
{
"cost": number,
"currency": "string",
"group": "string",
"historicalUsage": {
"billInterval": {
"end": number,
"start": number
},
"filterExpression": {
"and": [
"Expression"
],
"costCategories": {
"key": "string",
"matchOptions": [ "string" ],
"values": [ "string" ]
},
"dimensions": {
"key": "string",
"matchOptions": [ "string" ],
"values": [ "string" ]
},
"not": "Expression",
"or": [
"Expression"
],
"tags": {
"key": "string",
"matchOptions": [ "string" ],
"values": [ "string" ]
}
},
"location": "string",
"operation": "string",
"serviceCode": "string",
"usageAccountId": "string",
"usageType": "string"
},
"id": "string",
"location": "string",
"operation": "string",
"quantity": {
"amount": number,
"unit": "string"
},
"serviceCode": "string",
"status": "string",
"usageAccountId": "string",
"usageType": "string"
}
],
"nextToken": "string"
}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.
- items
-
The list of usage items associated with the workload estimate.
Type: Array of WorkloadEstimateUsageItem objects
- nextToken
-
A token to retrieve the next page of results, if any.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\S\s]*
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
- 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 AWS support.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input provided fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
