Get Resource Share Associations
ram_get_resource_share_associations | R Documentation |
Retrieves the lists of resources and principals that associated for resource shares that you own¶
Description¶
Retrieves the lists of resources and principals that associated for resource shares that you own.
Usage¶
ram_get_resource_share_associations(associationType, resourceShareArns,
resourceArn, principal, associationStatus, nextToken, maxResults)
Arguments¶
associationType
[required] Specifies whether you want to retrieve the associations that involve a specified resource or principal.
PRINCIPAL
– list the principals whose associations you want to see.RESOURCE
– list the resources whose associations you want to see.
resourceShareArns
Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.
resourceArn
Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.
You cannot specify this parameter if the association type is
PRINCIPAL
.principal
Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or user.
You cannot specify this parameter if the association type is
RESOURCE
.associationStatus
Specifies that you want to retrieve only associations that have this status.
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'sNextToken
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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.
Value¶
A list with the following syntax:
list(
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
)
),
nextToken = "string"
)