LensReview - AWS Well-Architected Tool

LensReview

A lens review of a question.

Contents

JiraConfiguration

Jira configuration status of the Lens review.

Type: JiraSelectedQuestionConfiguration object

Required: No

LensAlias

The alias of the lens.

For AWS 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 AWS 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

LensArn

The ARN for the lens.

Type: String

Required: No

LensName

The full name of the lens.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

LensStatus

The status of the lens.

Type: String

Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED

Required: No

LensVersion

The version of the lens.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

NextToken

The token to use to retrieve the next set of results.

Type: String

Required: No

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

PillarReviewSummaries

List of pillar review summaries of lens review in a workload.

Type: Array of PillarReviewSummary objects

Required: No

PrioritizedRiskCounts

A map from risk names to the count of how many questions have that rating.

Type: String to integer map

Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE

Valid Range: Minimum value of 0.

Required: No

Profiles

The profiles associated with the workload.

Type: Array of WorkloadProfile objects

Array Members: Maximum number of 1 item.

Required: No

RiskCounts

A map from risk names to the count of how many questions have that rating.

Type: String to integer map

Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE

Valid Range: Minimum value of 0.

Required: No

UpdatedAt

The date and time recorded in Unix format (seconds).

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: