lens_reviews

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

Overview

Name	lens_reviews
Type	Resource
Id	aws.wellarchitected.lens_reviews

Fields

The following fields are returned by SELECT queries:

get_lens_review

Name	Datatype	Description
lens_review	object	A lens review of a question.
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_lens_reviews

Name	Datatype	Description
lens_review_summaries	array	List of lens summaries of lens reviews of a workload.
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_lens_review	select	workload_id, lens_alias, region	MilestoneNumber	Get lens review.
list_lens_reviews	select	workload_id, region	MilestoneNumber, NextToken, MaxResults	List lens reviews for a particular workload.
update_lens_review	update	workload_id, lens_alias, region		Update lens review for a particular workload.

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
region	string	AWS region (default: us-east-1)
workload_id	string
MaxResults	integer
MilestoneNumber	integer
NextToken	string

SELECT examples

get_lens_review

Get lens review.

SELECT
lens_review,
milestone_number,
workload_id
FROM aws.wellarchitected.lens_reviews
WHERE workload_id = '{{ workload_id }}' -- required
AND lens_alias = '{{ lens_alias }}' -- required
AND region = '{{ region }}' -- required
AND MilestoneNumber = '{{ MilestoneNumber }}'
;

list_lens_reviews

List lens reviews for a particular workload.

SELECT
lens_review_summaries,
milestone_number,
next_token,
workload_id
FROM aws.wellarchitected.lens_reviews
WHERE workload_id = '{{ workload_id }}' -- required
AND region = '{{ region }}' -- required
AND MilestoneNumber = '{{ MilestoneNumber }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

UPDATE examples

update_lens_review

Update lens review for a particular workload.

UPDATE aws.wellarchitected.lens_reviews
SET 
LensNotes = '{{ LensNotes }}',
PillarNotes = '{{ PillarNotes }}',
JiraConfiguration = '{{ JiraConfiguration }}'
WHERE 
workload_id = '{{ workload_id }}' --required
AND lens_alias = '{{ lens_alias }}' --required
AND region = '{{ region }}' --required
RETURNING
lens_review,
workload_id;