review_template_answers

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

Overview

Name	review_template_answers
Type	Resource
Id	aws.wellarchitected.review_template_answers

Fields

The following fields are returned by SELECT queries:

get_review_template_answer

Name	Datatype	Description
answer	object	An answer of the question.
lens_alias	string	The alias of the lens. For Amazon Web Services 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 Amazon Web Services 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.
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>)

list_review_template_answers

Name	Datatype	Description
answer_summaries	array	List of answer summaries of a lens review in a review template.
lens_alias	string	The alias of the lens. For Amazon Web Services 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 Amazon Web Services 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.
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
template_arn	string	The ARN of the review template. (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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_review_template_answer	select	template_arn, lens_alias, question_id, region		Get review template answer.
list_review_template_answers	select	template_arn, lens_alias, region	PillarId, NextToken, MaxResults	List the answers of a review template.
update_review_template_answer	update	template_arn, lens_alias, question_id, region		Update a review template answer.

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
lens_alias	string
question_id	string
region	string	AWS region (default: us-east-1)
template_arn	string	The review template ARN.
MaxResults	integer	The maximum number of results to return for this request.
NextToken	string
PillarId	string

SELECT examples

get_review_template_answer

Get review template answer.

SELECT
answer,
lens_alias,
template_arn
FROM aws.wellarchitected.review_template_answers
WHERE template_arn = '{{ template_arn }}' -- required
AND lens_alias = '{{ lens_alias }}' -- required
AND question_id = '{{ question_id }}' -- required
AND region = '{{ region }}' -- required
;

list_review_template_answers

List the answers of a review template.

SELECT
answer_summaries,
lens_alias,
next_token,
template_arn
FROM aws.wellarchitected.review_template_answers
WHERE template_arn = '{{ template_arn }}' -- required
AND lens_alias = '{{ lens_alias }}' -- required
AND region = '{{ region }}' -- required
AND PillarId = '{{ PillarId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

UPDATE examples

update_review_template_answer

Update a review template answer.

UPDATE aws.wellarchitected.review_template_answers
SET 
SelectedChoices = '{{ SelectedChoices }}',
ChoiceUpdates = '{{ ChoiceUpdates }}',
Notes = '{{ Notes }}',
IsApplicable = {{ IsApplicable }},
Reason = '{{ Reason }}'
WHERE 
template_arn = '{{ template_arn }}' --required
AND lens_alias = '{{ lens_alias }}' --required
AND question_id = '{{ question_id }}' --required
AND region = '{{ region }}' --required
RETURNING
answer,
lens_alias,
template_arn;