ListReviewTemplateAnswersCommand

Suggest an Edit

List the answers of a review template.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WellArchitectedClient, ListReviewTemplateAnswersCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
// const { WellArchitectedClient, ListReviewTemplateAnswersCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
const client = new WellArchitectedClient(config);
const input = { // ListReviewTemplateAnswersInput
  TemplateArn: "STRING_VALUE", // required
  LensAlias: "STRING_VALUE", // required
  PillarId: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListReviewTemplateAnswersCommand(input);
const response = await client.send(command);
// { // ListReviewTemplateAnswersOutput
//   TemplateArn: "STRING_VALUE",
//   LensAlias: "STRING_VALUE",
//   AnswerSummaries: [ // ReviewTemplateAnswerSummaries
//     { // ReviewTemplateAnswerSummary
//       QuestionId: "STRING_VALUE",
//       PillarId: "STRING_VALUE",
//       QuestionTitle: "STRING_VALUE",
//       Choices: [ // Choices
//         { // Choice
//           ChoiceId: "STRING_VALUE",
//           Title: "STRING_VALUE",
//           Description: "STRING_VALUE",
//           HelpfulResource: { // ChoiceContent
//             DisplayText: "STRING_VALUE",
//             Url: "STRING_VALUE",
//           },
//           ImprovementPlan: {
//             DisplayText: "STRING_VALUE",
//             Url: "STRING_VALUE",
//           },
//           AdditionalResources: [ // AdditionalResourcesList
//             { // AdditionalResources
//               Type: "HELPFUL_RESOURCE" || "IMPROVEMENT_PLAN",
//               Content: [ // Urls
//                 {
//                   DisplayText: "STRING_VALUE",
//                   Url: "STRING_VALUE",
//                 },
//               ],
//             },
//           ],
//         },
//       ],
//       SelectedChoices: [ // SelectedChoices
//         "STRING_VALUE",
//       ],
//       ChoiceAnswerSummaries: [ // ChoiceAnswerSummaries
//         { // ChoiceAnswerSummary
//           ChoiceId: "STRING_VALUE",
//           Status: "SELECTED" || "NOT_APPLICABLE" || "UNSELECTED",
//           Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
//         },
//       ],
//       IsApplicable: true || false,
//       AnswerStatus: "UNANSWERED" || "ANSWERED",
//       Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
//       QuestionType: "PRIORITIZED" || "NON_PRIORITIZED",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListReviewTemplateAnswersCommand Input

See ListReviewTemplateAnswersCommandInput for more details

Parameter
Type
Description
LensAlias
Required
string | undefined

The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.

TemplateArn
Required
string | undefined

The ARN of the review template.

MaxResults
number | undefined

The maximum number of results to return for this request.

NextToken
string | undefined

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

PillarId
string | undefined

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

A pillar is identified by its PillarReviewSummary$PillarId.

ListReviewTemplateAnswersCommand Output

See ListReviewTemplateAnswersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AnswerSummaries
ReviewTemplateAnswerSummary[] | undefined

List of answer summaries of a lens review in a review template.

LensAlias
string | undefined

The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.

NextToken
string | undefined

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

TemplateArn
string | undefined

The ARN of the review template.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The requested resource was not found.

ThrottlingException
client

Request was denied due to request throttling.

ValidationException
client

The user input is not valid.

WellArchitectedServiceException
Base exception class for all service exceptions from WellArchitected service.