Skip to content

List Review Template Answers

wellarchitected_list_review_template_answers R Documentation

List the answers of a review template

Description

List the answers of a review template.

Usage

wellarchitected_list_review_template_answers(TemplateArn, LensAlias,
  PillarId, NextToken, MaxResults)

Arguments

TemplateArn

[required] The ARN of the review template.
LensAlias

[required] 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.
PillarId

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

A pillar is identified by its PillarReviewSummary$PillarId.
NextToken

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

The maximum number of results to return for this request.

Value

A list with the following syntax:

list(
  TemplateArn = "string",
  LensAlias = "string",
  AnswerSummaries = list(
    list(
      QuestionId = "string",
      PillarId = "string",
      QuestionTitle = "string",
      Choices = list(
        list(
          ChoiceId = "string",
          Title = "string",
          Description = "string",
          HelpfulResource = list(
            DisplayText = "string",
            Url = "string"
          ),
          ImprovementPlan = list(
            DisplayText = "string",
            Url = "string"
          ),
          AdditionalResources = list(
            list(
              Type = "HELPFUL_RESOURCE"|"IMPROVEMENT_PLAN",
              Content = list(
                list(
                  DisplayText = "string",
                  Url = "string"
                )
              )
            )
          )
        )
      ),
      SelectedChoices = list(
        "string"
      ),
      ChoiceAnswerSummaries = list(
        list(
          ChoiceId = "string",
          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"
)

Request syntax

svc$list_review_template_answers(
  TemplateArn = "string",
  LensAlias = "string",
  PillarId = "string",
  NextToken = "string",
  MaxResults = 123
)