ListResources - AWS RAM

ListResources

Lists the resources that you added to a resource share or the resources that are shared with you.

Request Syntax

POST /listresources HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "principal": "string", "resourceArns": [ "string" ], "resourceOwner": "string", "resourceRegionScope": "string", "resourceShareArns": [ "string" ], "resourceType": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

resourceOwner

Specifies that you want to list only the resource shares that match the following:

  • SELF – resources that your account shares with other accounts

  • OTHER-ACCOUNTS – resources that other accounts share with your account

Type: String

Valid Values: SELF | OTHER-ACCOUNTS

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

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.

Type: String

Required: No

principal

Specifies that you want to list only the resource shares that are associated with the specified principal.

Type: String

Required: No

resourceArns

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

Type: Array of strings

Required: No

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.

Type: String

Valid Values: ALL | REGIONAL | GLOBAL

Required: No

resourceShareArns

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

Type: Array of strings

Required: No

resourceType

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resources": [ { "arn": "string", "creationTime": number, "lastUpdatedTime": number, "resourceGroupArn": "string", "resourceRegionScope": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "type": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Type: String

resources

An array of objects that contain information about the resources.

Type: Array of Resource objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The specified value for NextToken is not valid.

HTTP Status Code: 400

InvalidParameterException

A parameter is not valid.

HTTP Status Code: 400

InvalidResourceTypeException

The specified resource type is not valid.

HTTP Status Code: 400

MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

ServerInternalException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500

ServiceUnavailableException

The service is not available.

HTTP Status Code: 503

UnknownResourceException

A specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: