[ aws . wellarchitected ]

list-lens-review-improvements

Description

List lens review improvements.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-lens-review-improvements
--workload-id <value>
--lens-alias <value>
[--pillar-id <value>]
[--milestone-number <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workload-id (string)

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

--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-west-2::lens/serverless .

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

Each lens is identified by its LensSummary$LensAlias .

--pillar-id (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

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

--max-results (integer)

The maximum number of results to return for this request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

WorkloadId -> (string)

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

MilestoneNumber -> (integer)

The milestone number.

A workload can have a maximum of 100 milestones.

LensAlias -> (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-west-2::lens/serverless .

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

Each lens is identified by its LensSummary$LensAlias .

LensArn -> (string)

The ARN for the lens.

ImprovementSummaries -> (list)

List of improvement summaries of lens review in a workload.

(structure)

An improvement summary of a lens review in a workload.

QuestionId -> (string)

The ID of the question.

PillarId -> (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

QuestionTitle -> (string)

The title of the question.

Risk -> (string)

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

ImprovementPlanUrl -> (string)

The improvement plan URL for a question.

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

ImprovementPlans -> (list)

The improvement plan details.

(structure)

The choice level improvement plan.

ChoiceId -> (string)

The ID of a choice.

DisplayText -> (string)

The display text for the improvement plan.

ImprovementPlanUrl -> (string)

The improvement plan URL for a question.

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

NextToken -> (string)

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