Get Lens

wellarchitected_get_lens

R Documentation

Get an existing lens¶

Description¶

Get an existing lens.

Usage¶

wellarchitected_get_lens(LensAlias, LensVersion)

Arguments¶

LensAlias

[required] 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-east-1::lens/serverless⁠. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as ⁠arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef⁠.

Each lens is identified by its LensSummary$LensAlias.

LensVersion

The lens version to be retrieved.

Value¶

A list with the following syntax:

list(
  Lens = list(
    LensArn = "string",
    LensVersion = "string",
    Name = "string",
    Description = "string",
    Owner = "string",
    ShareInvitationId = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax¶

svc$get_lens(
  LensAlias = "string",
  LensVersion = "string"
)