POST
/workloads/{WorkloadId}/checkSummaries
http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/checkSummariesList of Trusted Advisor checks summarized for all accounts related to the workload.
Access Token Required: API Key
Path Parameters
WorkloadIdstringrequired
Query Params
MaxResultsstring
Pagination limit
NextTokenstring
Pagination token
Body Params
LensArnstringrequired
Well-Architected Lens ARN.
ChoiceIdstringrequired
The ID of a choice.
PillarIdstringrequired
<p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
NextTokenstring
The token to use to retrieve the next set of results.
MaxResultsinteger
The maximum number of results to return for this request.
QuestionIdstringrequired
The ID of the question.
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/workloads/{WorkloadId}/checkSummaries' \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}