GetResourcePolicies - AWS RAM

GetResourcePolicies

Retrieves the resource policies for the specified resources that you own and have shared.

Request Syntax

POST /getresourcepolicies HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "principal": "string", "resourceArns": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

resourceArns

Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

Type: Array of strings

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 the principal.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "policies": [ "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

policies

An array of resource policy documents in JSON format.

Type: Array of strings

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

MalformedArnException

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

HTTP Status Code: 400

ResourceArnNotFoundException

The specified Amazon Resource Name (ARN) was not found.

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

See Also

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