Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wellarchitected ]



Get an existing lens.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--lens-alias <value>
[--lens-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


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

--lens-version (string)

The lens version to be retrieved.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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


Lens -> (structure)

A lens return object.

LensArn -> (string)

The ARN of a lens.

LensVersion -> (string)

The version of a lens.

Name -> (string)

The full name of the lens.

Description -> (string)

The description of the lens.

Owner -> (string)

The Amazon Web Services account ID that owns the lens.

ShareInvitationId -> (string)

The ID assigned to the share invitation.

Tags -> (map)

The tags assigned to the lens.

key -> (string)

value -> (string)