[ aws . wellarchitected ]

get-lens-review-report

Description

Get lens review report.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-lens-review-report
--workload-id <value>
--lens-alias <value>
[--milestone-number <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 AWS Region.

--lens-alias (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

--milestone-number (integer)

The milestone number.

A workload can have a maximum of 100 milestones.

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

See ‘aws help’ for descriptions of global parameters.

Output

WorkloadId -> (string)

The ID assigned to the workload. This ID is unique within an AWS Region.

MilestoneNumber -> (integer)

The milestone number.

A workload can have a maximum of 100 milestones.

LensReviewReport -> (structure)

A report of a lens review.

LensAlias -> (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

Base64String -> (string)

The Base64-encoded string representation of a lens review report.

This data can be used to create a PDF file.