answers

Creates, updates, deletes, gets or lists an answers resource.

Overview

Name	answers
Type	Resource
Id	aws.wellarchitected.answers

Fields

The following fields are returned by SELECT queries:

get_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.
lens_arn	string	The ARN for the lens.
milestone_number	integer	The milestone number. A workload can have a maximum of 100 milestones.
workload_id	string	The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. (pattern: <code>[0-9a-f]{32}</code>)

list_answers

Name	Datatype	Description
answer_summaries	array	List of answer summaries of lens review in a workload.
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.
lens_arn	string	The ARN for the lens.
milestone_number	integer	The milestone number. A workload can have a maximum of 100 milestones.
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
workload_id	string	The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. (pattern: <code>[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_answer	select	workload_id, lens_alias, question_id, region	MilestoneNumber	Get the answer to a specific question in a workload review.
list_answers	select	workload_id, lens_alias, region	PillarId, MilestoneNumber, NextToken, MaxResults, QuestionPriority	List of answers for a particular workload and lens.
update_answer	update	workload_id, lens_alias, question_id, region		Update the answer to a specific question in a workload review.

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)
workload_id	string
MaxResults	integer	The maximum number of results to return for this request.
MilestoneNumber	integer
NextToken	string
PillarId	string
QuestionPriority	string	The priority of the question.

SELECT examples

get_answer

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

SELECT
answer,
lens_alias,
lens_arn,
milestone_number,
workload_id
FROM aws.wellarchitected.answers
WHERE workload_id = '{{ workload_id }}' -- required
AND lens_alias = '{{ lens_alias }}' -- required
AND question_id = '{{ question_id }}' -- required
AND region = '{{ region }}' -- required
AND MilestoneNumber = '{{ MilestoneNumber }}'
;

list_answers

List of answers for a particular workload and lens.

SELECT
answer_summaries,
lens_alias,
lens_arn,
milestone_number,
next_token,
workload_id
FROM aws.wellarchitected.answers
WHERE workload_id = '{{ workload_id }}' -- required
AND lens_alias = '{{ lens_alias }}' -- required
AND region = '{{ region }}' -- required
AND PillarId = '{{ PillarId }}'
AND MilestoneNumber = '{{ MilestoneNumber }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND QuestionPriority = '{{ QuestionPriority }}'
;

UPDATE examples

update_answer

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

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