Answer - AWS Well-Architected Tool

Answer

An answer of the question.

Contents

ChoiceAnswers

A list of selected choices to a question in your workload.

Type: Array of ChoiceAnswer objects

Required: No

Choices

List of choices available for a question.

Type: Array of Choice objects

Required: No

HelpfulResourceDisplayText

The helpful resource text to be displayed for a custom lens.

This field does not apply to AWS official lenses.

Type: String

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

Required: No

HelpfulResourceUrl

The helpful resource URL.

For AWS official lenses, this is the helpful resource URL for a question or choice.

For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

Type: String

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

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

IsApplicable

Defines whether this question is applicable to a lens review.

Type: Boolean

Required: No

JiraConfiguration

Configuration of the Jira integration.

Type: JiraConfiguration object

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

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

QuestionDescription

The description of the question.

Type: String

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

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

Reason

The reason why the question is not applicable to your workload.

Type: String

Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE

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

SelectedChoices

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

Type: Array of strings

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

Required: No

See Also

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