List Resources
ram_list_resources | R Documentation |
Lists the resources that you added to a resource share or the resources that are shared with you¶
Description¶
Lists the resources that you added to a resource share or the resources that are shared with you.
Usage¶
ram_list_resources(resourceOwner, principal, resourceType, resourceArns,
resourceShareArns, nextToken, maxResults, resourceRegionScope)
Arguments¶
resourceOwner
[required] Specifies that you want to list only the resource shares that match the following:
SELF
– resources that your account shares with other accountsOTHER-ACCOUNTS
– resources that other accounts share with your account
principal
Specifies that you want to list only the resource shares that are associated with the specified principal.
resourceType
Specifies that you want to list only the resource shares that include resources of the specified resource type.
For valid values, query the
list_resource_types
operation.resourceArns
Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
resourceShareArns
Specifies that you want to list only resources in the resource shares identified by the specified 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'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.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"
)