Get Resource Share Invitations

ram_get_resource_share_invitations

R Documentation

Retrieves details about invitations that you have received for resource shares¶

Description¶

Retrieves details about invitations that you have received for resource shares.

Usage¶

ram_get_resource_share_invitations(resourceShareInvitationArns,
  resourceShareArns, nextToken, maxResults)

Arguments¶

resourceShareInvitationArns

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

resourceShareArns

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

maxResults

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Value¶

A list with the following syntax:

list(
  resourceShareInvitations = list(
    list(
      resourceShareInvitationArn = "string",
      resourceShareName = "string",
      resourceShareArn = "string",
      senderAccountId = "string",
      receiverAccountId = "string",
      invitationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      status = "PENDING"|"ACCEPTED"|"REJECTED"|"EXPIRED",
      resourceShareAssociations = list(
        list(
          resourceShareArn = "string",
          resourceShareName = "string",
          associatedEntity = "string",
          associationType = "PRINCIPAL"|"RESOURCE",
          status = "ASSOCIATING"|"ASSOCIATED"|"FAILED"|"DISASSOCIATING"|"DISASSOCIATED",
          statusMessage = "string",
          creationTime = as.POSIXct(
            "2015-01-01"
          ),
          lastUpdatedTime = as.POSIXct(
            "2015-01-01"
          ),
          external = TRUE|FALSE
        )
      ),
      receiverArn = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$get_resource_share_invitations(
  resourceShareInvitationArns = list(
    "string"
  ),
  resourceShareArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123
)