Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListCheckSummaries

List of Trusted Advisor checks summarized for all accounts related to the workload.

Request Syntax


POST /workloads/WorkloadId/checkSummaries HTTP/1.1
Content-type: application/json

{
   "ChoiceId": "string",
   "LensArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PillarId": "string",
   "QuestionId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Length Constraints: Fixed length of 32.

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

ChoiceId

The ID of a choice.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

LensArn

Well-Architected Lens ARN.

Type: String

Required: Yes

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

PillarId

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary:PillarId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

QuestionId

The ID of the question.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CheckSummaries": [ 
      { 
         "AccountSummary": { 
            "string" : number 
         },
         "ChoiceId": "string",
         "Description": "string",
         "Id": "string",
         "LensArn": "string",
         "Name": "string",
         "PillarId": "string",
         "Provider": "string",
         "QuestionId": "string",
         "Status": "string",
         "UpdatedAt": 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.

CheckSummaries

List of Trusted Advisor summaries related to the Well-Architected best practice.

Type: Array of CheckSummary objects

NextToken

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

Type: String

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

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400