View a markdown version of this page

UpdateAnswer - AWS Well-Architected Tool
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UpdateAnswer

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

Request Syntax

PATCH /workloads/WorkloadId/lensReviews/LensAlias/answers/QuestionId HTTP/1.1
Content-type: application/json

{
   "ChoiceUpdates": { 
      "string" : { 
         "Notes": "string",
         "Reason": "string",
         "Status": "string"
      }
   },
   "IsApplicable": boolean,
   "Notes": "string",
   "Reason": "string",
   "SelectedChoices": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

LensAlias

The alias of the lens.

For AWS 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 AWS 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.

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

Required: Yes

QuestionId

The ID of the question.

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

Required: Yes

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.

ChoiceUpdates

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

Type: String to ChoiceUpdate object map

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

Required: No

IsApplicable

Defines whether this question is applicable to a lens review.

Type: Boolean

Required: No

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.

Type: String

Length Constraints: Maximum length of 2084.

Required: No

Reason

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

Type: String

Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE

Required: No

SelectedChoices

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

Type: Array of strings

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

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Answer": { 
      "ChoiceAnswers": [ 
         { 
            "ChoiceId": "string",
            "Notes": "string",
            "Reason": "string",
            "Status": "string"
         }
      ],
      "Choices": [ 
         { 
            "AdditionalResources": [ 
               { 
                  "Content": [ 
                     { 
                        "DisplayText": "string",
                        "Url": "string"
                     }
                  ],
                  "Type": "string"
               }
            ],
            "ChoiceId": "string",
            "Description": "string",
            "HelpfulResource": { 
               "DisplayText": "string",
               "Url": "string"
            },
            "ImprovementPlan": { 
               "DisplayText": "string",
               "Url": "string"
            },
            "Title": "string"
         }
      ],
      "HelpfulResourceDisplayText": "string",
      "HelpfulResourceUrl": "string",
      "ImprovementPlanUrl": "string",
      "IsApplicable": boolean,
      "JiraConfiguration": { 
         "JiraIssueUrl": "string",
         "LastSyncedTime": number
      },
      "Notes": "string",
      "PillarId": "string",
      "QuestionDescription": "string",
      "QuestionId": "string",
      "QuestionTitle": "string",
      "Reason": "string",
      "Risk": "string",
      "SelectedChoices": [ "string" ]
   },
   "LensAlias": "string",
   "LensArn": "string",
   "WorkloadId": "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.

Answer

An answer of the question.

Type: Answer object

LensAlias

The alias of the lens.

For AWS 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 AWS 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.

Type: String

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

LensArn

The ARN for the lens.

Type: String