List Share Invitations

wellarchitected_list_share_invitations

R Documentation

List the share invitations

Description

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

Usage

wellarchitected_list_share_invitations(WorkloadNamePrefix,
  LensNamePrefix, ShareResourceType, NextToken, MaxResults,
  ProfileNamePrefix, TemplateNamePrefix)

Arguments

WorkloadNamePrefix

LensNamePrefix

An optional string added to the beginning of each lens name returned in the results.

ShareResourceType

The type of share invitations to be returned.

NextToken

MaxResults

The maximum number of results to return for this request.

ProfileNamePrefix

An optional string added to the beginning of each profile name returned in the results.

TemplateNamePrefix

An optional string added to the beginning of each review template name returned in the results.

Value

A list with the following syntax:

list(
  ShareInvitationSummaries = list(
    list(
      ShareInvitationId = "string",
      SharedBy = "string",
      SharedWith = "string",
      PermissionType = "READONLY"|"CONTRIBUTOR",
      ShareResourceType = "WORKLOAD"|"LENS"|"PROFILE"|"TEMPLATE",
      WorkloadName = "string",
      WorkloadId = "string",
      LensName = "string",
      LensArn = "string",
      ProfileName = "string",
      ProfileArn = "string",
      TemplateName = "string",
      TemplateArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_share_invitations(
  WorkloadNamePrefix = "string",
  LensNamePrefix = "string",
  ShareResourceType = "WORKLOAD"|"LENS"|"PROFILE"|"TEMPLATE",
  NextToken = "string",
  MaxResults = 123,
  ProfileNamePrefix = "string",
  TemplateNamePrefix = "string"
)