[ aws . wellarchitected ]

update-lens-review

Description

Update lens review.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-lens-review
--workload-id <value>
--lens-alias <value>
[--lens-notes <value>]
[--pillar-notes <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 .

--lens-notes (string)

The notes associated with the workload.

--pillar-notes (map)

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

key -> (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

value -> (string)

The notes associated with the workload.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

LensReview -> (structure)

A lens review of a question.

LensAlias -> (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

LensVersion -> (string)

The version of the lens.

LensName -> (string)

The full name of the lens.

LensStatus -> (string)

The status of the lens.

PillarReviewSummaries -> (list)

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

(structure)

A pillar review summary of a lens review.

PillarId -> (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

PillarName -> (string)

The name of the pillar.

Notes -> (string)

The notes associated with the workload.

RiskCounts -> (map)

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

key -> (string)

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

value -> (integer)

A non-negative integer that denotes how many.

UpdatedAt -> (timestamp)

The date and time recorded.

Notes -> (string)

The notes associated with the workload.

RiskCounts -> (map)

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

key -> (string)

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

value -> (integer)

A non-negative integer that denotes how many.

NextToken -> (string)

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