ListWorkloads - AWS Well-Architected Tool

ListWorkloads

List workloads. Paginated.

Request Syntax

POST /workloadsSummaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "WorkloadNamePrefix": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return for this request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The token to use to retrieve the next set of results.

Type: String

Required: No

WorkloadNamePrefix

An optional string added to the beginning of each workload name returned in the results.

Type: String

Length Constraints: Maximum length of 100.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "WorkloadSummaries": [ { "ImprovementStatus": "string", "Lenses": [ "string" ], "Owner": "string", "RiskCounts": { "string" : number }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "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.

NextToken

The token to use to retrieve the next set of results.

Type: String

WorkloadSummaries

A list of workload summaries.

Type: Array of WorkloadSummary objects

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: