Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateReviewTemplate

Update a review template.

Request Syntax


PATCH /reviewTemplates/TemplateArn HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "LensesToAssociate": [ "string" ],
   "LensesToDisassociate": [ "string" ],
   "Notes": "string",
   "TemplateName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

TemplateArn

The review template ARN.

Length Constraints: Minimum length of 50. Maximum length of 250.

Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The review template description.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 250.

Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$

Required: No

LensesToAssociate

A list of lens aliases or ARNs to apply to the review template.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

Required: No

LensesToDisassociate

A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

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

TemplateName

The review template name.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ReviewTemplate": { 
      "Description": "string",
      "Lenses": [ "string" ],
      "Notes": "string",
      "Owner": "string",
      "QuestionCounts": { 
         "string" : number 
      },
      "ShareInvitationId": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TemplateArn": "string",
      "TemplateName": "string",
      "UpdatedAt": number,
      "UpdateStatus": "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.

ReviewTemplate

A review template.

Type: ReviewTemplate object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The resource has already been processed, was deleted, or is too large.

HTTP Status Code: 409

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400