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 ]

export-lens

Description

Export an existing lens.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide . Only the owner of a lens can export it.

Note

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--lens-alias (string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

--lens-version (string)

The lens version to be exported.

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

Output

LensJSON -> (string)

The JSON for the lens.