Skip to content

Update Answer

wellarchitected_update_answer R Documentation

Update the answer to a specific question in a workload review

Description

Update the answer to a specific question in a workload review.

Usage

wellarchitected_update_answer(WorkloadId, LensAlias, QuestionId,
  SelectedChoices, ChoiceUpdates, Notes, IsApplicable, Reason)

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.
QuestionId

[required] The ID of the question.
SelectedChoices

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.
ChoiceUpdates

A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
Notes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.
IsApplicable

Defines whether this question is applicable to a lens review.
Reason

The reason why a question is not applicable to your workload.

Value

A list with the following syntax:

list(
  WorkloadId = "string",
  LensAlias = "string",
  LensArn = "string",
  Answer = list(
    QuestionId = "string",
    PillarId = "string",
    QuestionTitle = "string",
    QuestionDescription = "string",
    ImprovementPlanUrl = "string",
    HelpfulResourceUrl = "string",
    HelpfulResourceDisplayText = "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"
    ),
    ChoiceAnswers = list(
      list(
        ChoiceId = "string",
        Status = "SELECTED"|"NOT_APPLICABLE"|"UNSELECTED",
        Reason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE",
        Notes = "string"
      )
    ),
    IsApplicable = TRUE|FALSE,
    Risk = "UNANSWERED"|"HIGH"|"MEDIUM"|"NONE"|"NOT_APPLICABLE",
    Notes = "string",
    Reason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE",
    JiraConfiguration = list(
      JiraIssueUrl = "string",
      LastSyncedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$update_answer(
  WorkloadId = "string",
  LensAlias = "string",
  QuestionId = "string",
  SelectedChoices = list(
    "string"
  ),
  ChoiceUpdates = list(
    list(
      Status = "SELECTED"|"NOT_APPLICABLE"|"UNSELECTED",
      Reason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE",
      Notes = "string"
    )
  ),
  Notes = "string",
  IsApplicable = TRUE|FALSE,
  Reason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE"
)