# ListWorkloadEstimates


 Lists all workload estimates for the account. 

## Request Syntax


```
{
   "createdAtFilter": { 
      "afterTimestamp": number,
      "beforeTimestamp": number
   },
   "expiresAtFilter": { 
      "afterTimestamp": number,
      "beforeTimestamp": number
   },
   "filters": [ 
      { 
         "matchOption": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [createdAtFilter](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_RequestSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-request-createdAtFilter"></a>
 Filter workload estimates based on the creation date.   
Type: [FilterTimestamp](API_AWSBCMPricingCalculator_FilterTimestamp.md) object  
Required: No

 ** [expiresAtFilter](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_RequestSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-request-expiresAtFilter"></a>
 Filter workload estimates based on the expiration date.   
Type: [FilterTimestamp](API_AWSBCMPricingCalculator_FilterTimestamp.md) object  
Required: No

 ** [filters](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_RequestSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-request-filters"></a>
 Filters to apply to the list of workload estimates.   
Type: Array of [ListWorkloadEstimatesFilter](API_AWSBCMPricingCalculator_ListWorkloadEstimatesFilter.md) objects  
Required: No

 ** [maxResults](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_RequestSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-request-maxResults"></a>
 The maximum number of results to return per page.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_RequestSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-request-nextToken"></a>
 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

## Response Syntax


```
{
   "items": [ 
      { 
         "costCurrency": "string",
         "createdAt": number,
         "expiresAt": number,
         "failureMessage": "string",
         "id": "string",
         "name": "string",
         "rateTimestamp": number,
         "rateType": "string",
         "status": "string",
         "totalCost": number
      }
   ],
   "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](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_ResponseSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-response-items"></a>
 The list of workload estimates for the account.   
Type: Array of [WorkloadEstimateSummary](API_AWSBCMPricingCalculator_WorkloadEstimateSummary.md) objects

 ** [nextToken](#API_AWSBCMPricingCalculator_ListWorkloadEstimates_ResponseSyntax) **   <a name="awscostmanagement-AWSBCMPricingCalculator_ListWorkloadEstimates-response-nextToken"></a>
 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 Error Types](CommonErrors.md).

 ** 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.     
 ** retryAfterSeconds **   
 An internal error has occurred. Retry your request, but if the problem persists, contact AWS support. 
HTTP Status Code: 500

 ** 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 AWS 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 AWS service.     
 ** fieldList **   
 The list of fields that are invalid.   
 ** reason **   
 The reason for the validation exception. 
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bcm-pricing-calculator-2024-06-19/ListWorkloadEstimates)