CreateReviewTemplate
Create a review template.
Note
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
Request Syntax
POST /reviewTemplates HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "string
",
"Description": "string
",
"Lenses": [ "string
" ],
"Notes": "string
",
"Tags": {
"string
" : "string
"
},
"TemplateName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientRequestToken
-
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.
Important
This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- Description
-
The review template description.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 250.
Pattern:
^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$
Required: Yes
- Lenses
-
Lenses applied to the review template.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- 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
- Tags
-
The tags assigned to the review template.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- TemplateName
-
Name of the review template.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern:
^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"TemplateArn": "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.
- TemplateArn
-
The review template ARN.
Type: String
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}
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
- ServiceQuotaExceededException
-
The user has reached their resource quota.
HTTP Status Code: 402
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The user input is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: