[ aws . wellarchitected ]

get-lens

Description

Get an existing lens.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

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

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)