Get Resource Shares

ram_get_resource_shares

R Documentation

Retrieves details about the resource shares that you own or that are shared with you¶

Description¶

Retrieves details about the resource shares that you own or that are shared with you.

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

Usage¶

ram_get_resource_shares(resourceShareArns, resourceShareStatus,
  resourceOwner, name, tagFilters, nextToken, maxResults, permissionArn,
  permissionVersion)

Arguments¶

resourceShareArns

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

resourceShareStatus

Specifies that you want to retrieve details of only those resource shares that have this status.

resourceOwner

[required] Specifies that you want to retrieve details of only those resource shares that match the following:

SELF – resource shares that your account shares with other accounts
OTHER-ACCOUNTS – resource shares that other accounts share with your account

name

Specifies the name of an individual resource share that you want to retrieve details about.

tagFilters

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

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.

permissionArn

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

permissionVersion

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

Value¶

A list with the following syntax:

list(
  resourceShares = list(
    list(
      resourceShareArn = "string",
      name = "string",
      owningAccountId = "string",
      allowExternalPrincipals = TRUE|FALSE,
      status = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED",
      statusMessage = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      featureSet = "CREATED_FROM_POLICY"|"PROMOTING_TO_STANDARD"|"STANDARD",
      resourceShareConfiguration = list(
        retainSharingOnAccountLeaveOrganization = TRUE|FALSE
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$get_resource_shares(
  resourceShareArns = list(
    "string"
  ),
  resourceShareStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED",
  resourceOwner = "SELF"|"OTHER-ACCOUNTS",
  name = "string",
  tagFilters = list(
    list(
      tagKey = "string",
      tagValues = list(
        "string"
      )
    )
  ),
  nextToken = "string",
  maxResults = 123,
  permissionArn = "string",
  permissionVersion = 123
)