review_templates

Creates, updates, deletes, gets or lists a review_templates resource.

Overview

Name	review_templates
Type	Resource
Id	aws.wellarchitected.review_templates

Fields

The following fields are returned by SELECT queries:

get_review_template

Name	Datatype	Description
description	string	The review template description. (pattern: <code>[A-Za-z0-9-_.,:/()@!&?#+'’\s]+</code>)
lenses	array	The lenses applied to the review template.
notes	string	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.
owner	string	An Amazon Web Services account ID. (pattern: <code>[0-9]{12}</code>)
question_counts	object	A count of how many total questions are answered and unanswered in the review template.
share_invitation_id	string	The ID assigned to the template share invitation. (pattern: <code>[0-9a-f]{32}</code>)
tags	object	The tags assigned to the review template.
template_arn	string	The review template ARN. (pattern: <code>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}</code>)
template_name	string	The name of the review template. (pattern: <code>[A-Za-z0-9-_.,:/()@!&?#+'’\s]+</code>)
update_status	string	The latest status of a review template. (CURRENT, LENS_NOT_CURRENT)
updated_at	string (date-time)	The date and time when the review template was last updated.

list_review_templates

Name	Datatype	Description
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
review_templates	array	List of review templates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_review_template	select	template_arn, region		Get review template.
list_review_templates	select	region	NextToken, MaxResults	List review templates.
create_review_template	insert	region, TemplateName, Description, Lenses, ClientRequestToken		Create a review template. 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.
update_review_template	update	template_arn, region		Update a review template.
delete_review_template	delete	template_arn, ClientRequestToken, region		Delete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClientRequestToken	string
region	string	AWS region (default: us-east-1)
template_arn	string	The review template ARN.
MaxResults	integer
NextToken	string

SELECT examples

get_review_template

Get review template.

SELECT
description,
lenses,
notes,
owner,
question_counts,
share_invitation_id,
tags,
template_arn,
template_name,
update_status,
updated_at
FROM aws.wellarchitected.review_templates
WHERE template_arn = '{{ template_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_review_templates

List review templates.

SELECT
next_token,
review_templates
FROM aws.wellarchitected.review_templates
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_review_template

Create a review template. 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.

INSERT INTO aws.wellarchitected.review_templates (
TemplateName,
Description,
Lenses,
Notes,
Tags,
ClientRequestToken,
region
)
SELECT 
'{{ TemplateName }}' /* required */,
'{{ Description }}' /* required */,
'{{ Lenses }}' /* required */,
'{{ Notes }}',
'{{ Tags }}',
'{{ ClientRequestToken }}' /* required */,
'{{ region }}'
RETURNING
template_arn
;

Manifest

# Description fields are for documentation purposes
- name: review_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the review_templates resource.
  - name: TemplateName
    value: "{{ TemplateName }}"
  - name: Description
    value: "{{ Description }}"
  - name: Lenses
    value:
      - "{{ Lenses }}"
  - name: Notes
    value: "{{ Notes }}"
    description: |
      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.
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      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. This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

UPDATE examples

update_review_template

Update a review template.

UPDATE aws.wellarchitected.review_templates
SET 
TemplateName = '{{ TemplateName }}',
Description = '{{ Description }}',
Notes = '{{ Notes }}',
LensesToAssociate = '{{ LensesToAssociate }}',
LensesToDisassociate = '{{ LensesToDisassociate }}'
WHERE 
template_arn = '{{ template_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
review_template;

DELETE examples

delete_review_template

Delete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

DELETE FROM aws.wellarchitected.review_templates
WHERE template_arn = '{{ template_arn }}' --required
AND ClientRequestToken = '{{ ClientRequestToken }}' --required
AND region = '{{ region }}' --required
;