POST
/workloadsSummaries
http://wellarchitected.{region}.amazonaws.com/workloadsSummariesPaginated list of workloads.
Access Token Required: API Key
Query Params
MaxResultsstring
Pagination limit
NextTokenstring
Pagination token
Body Params
NextTokenstring
The token to use to retrieve the next set of results.
MaxResultsinteger
The maximum number of results to return for this request.
WorkloadNamePrefixstring
An optional string added to the beginning of each workload name returned in the results.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://wellarchitected.{region}.amazonaws.com/workloadsSummaries' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}