[ aws . wellarchitected ]
list-lenses¶
Description¶
List the available lenses.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-lenses
[--next-token <value>]
[--max-results <value>]
[--lens-type <value>]
[--lens-status <value>]
[--lens-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--next-token (string)
The token to use to retrieve the next set of results.
--max-results (integer)
The maximum number of results to return for this request.
--lens-type (string)
The type of lenses to be returned.
Possible values:
AWS_OFFICIAL
CUSTOM_SHARED
CUSTOM_SELF
--lens-status (string)
The status of lenses to be returned.
Possible values:
ALL
DRAFT
PUBLISHED
--lens-name (string)
The full name of the lens.
--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¶
LensSummaries -> (list)
List of lens summaries of available lenses.
(structure)
A lens summary of a lens.
LensArn -> (string)
The ARN of the lens.
LensAlias -> (string)
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias .
LensName -> (string)
The full name of the lens.
LensType -> (string)
The type of the lens.
Description -> (string)
The description of the lens.
CreatedAt -> (timestamp)
The date and time recorded.
UpdatedAt -> (timestamp)
The date and time recorded.
LensVersion -> (string)
The version of the lens.
Owner -> (string)
An Amazon Web Services account ID.
LensStatus -> (string)
The status of the lens.
NextToken -> (string)
The token to use to retrieve the next set of results.