ImprovementSummary - AWS Well-Architected Tool

ImprovementSummary

An improvement summary of a lens review in a workload.

Contents

ImprovementPlans

The improvement plan details.

This value is only applicable to custom lenses.

Type: Array of ChoiceImprovementPlan objects

Required: No

ImprovementPlanUrl

The improvement plan URL for a question in an AWS official lenses.

This value is only available if the question has been answered.

Type: String

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

Required: No

JiraConfiguration

Configuration of the Jira integration.

Type: JiraConfiguration object

Required: No

PillarId

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary:PillarId.

Type: String

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

Required: No

QuestionId

The ID of the question.

Type: String

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

Required: No

QuestionTitle

The title of the question.

Type: String

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

Required: No

Risk

The risk for a given workload, lens review, pillar, or question.

Type: String

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

Required: No

See Also

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