PATCH

/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}

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

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

LensAliasstringrequired

QuestionIdstringrequired

Body Params

Notesstring

The notes associated with the workload.

Reasonstring

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

IsApplicableboolean

Defines whether this question is applicable to a lens review.

ChoiceUpdatesobject

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

SelectedChoicesarray

List of selected choice IDs in a question answer. The values entered replace the previously selected choices.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}