List Pending Invitation Resources

ram_list_pending_invitation_resources

R Documentation

Description¶

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

Usage¶

ram_list_pending_invitation_resources(resourceShareInvitationArn,
  nextToken, maxResults, resourceRegionScope)

Arguments¶

resourceShareInvitationArn

[required] Specifies the Amazon Resource Name (ARN) of the invitation. You can use get_resource_share_invitations to find the ARN of the invitation.

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.

resourceRegionScope

Specifies that you want the results to include only resources that have the specified scope.

ALL – the results include both global and regional resources or resource types.
GLOBAL – the results include only global resources or resource types.
REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

Value¶

A list with the following syntax:

list(
  resources = list(
    list(
      arn = "string",
      type = "string",
      resourceShareArn = "string",
      resourceGroupArn = "string",
      status = "AVAILABLE"|"ZONAL_RESOURCE_INACCESSIBLE"|"LIMIT_EXCEEDED"|"UNAVAILABLE"|"PENDING",
      statusMessage = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      resourceRegionScope = "REGIONAL"|"GLOBAL"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_pending_invitation_resources(
  resourceShareInvitationArn = "string",
  nextToken = "string",
  maxResults = 123,
  resourceRegionScope = "ALL"|"REGIONAL"|"GLOBAL"
)