Skip to content

List Lens Shares

wellarchitected_list_lens_shares R Documentation

List the lens shares associated with the lens

Description

List the lens shares associated with the lens.

Usage

wellarchitected_list_lens_shares(LensAlias, SharedWithPrefix, NextToken,
  MaxResults, Status)

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.

SharedWithPrefix

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.

NextToken

The token to use to retrieve the next set of results.

MaxResults

The maximum number of results to return for this request.

Status

The status of the share request.

Value

A list with the following syntax:

list(
  LensShareSummaries = list(
    list(
      ShareId = "string",
      SharedWith = "string",
      Status = "ACCEPTED"|"REJECTED"|"PENDING"|"REVOKED"|"EXPIRED"|"ASSOCIATING"|"ASSOCIATED"|"FAILED",
      StatusMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_lens_shares(
  LensAlias = "string",
  SharedWithPrefix = "string",
  NextToken = "string",
  MaxResults = 123,
  Status = "ACCEPTED"|"REJECTED"|"PENDING"|"REVOKED"|"EXPIRED"|"ASSOCIATING"|"ASSOCIATED"|"FAILED"
)