Skip to content

List Answers

wellarchitected_list_answers R Documentation

List of answers for a particular workload and lens

Description

List of answers for a particular workload and lens.

Usage

wellarchitected_list_answers(WorkloadId, LensAlias, PillarId,
  MilestoneNumber, NextToken, MaxResults, QuestionPriority)

Arguments

WorkloadId

[required] The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
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.
MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.
NextToken

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

The maximum number of results to return for this request.
QuestionPriority

The priority of the question.

Value

A list with the following syntax:

list(
  WorkloadId = "string",
  MilestoneNumber = 123,
  LensAlias = "string",
  LensArn = "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,
      Risk = "UNANSWERED"|"HIGH"|"MEDIUM"|"NONE"|"NOT_APPLICABLE",
      Reason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE",
      QuestionType = "PRIORITIZED"|"NON_PRIORITIZED",
      JiraConfiguration = list(
        JiraIssueUrl = "string",
        LastSyncedTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_answers(
  WorkloadId = "string",
  LensAlias = "string",
  PillarId = "string",
  MilestoneNumber = 123,
  NextToken = "string",
  MaxResults = 123,
  QuestionPriority = "PRIORITIZED"|"NONE"
)