Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPolicy

Gets information about the specified policy with the policy document of the default version.

Requires permission to access the GetPolicy action.

Request Syntax


GET /policies/policyName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

policyName

The name of the policy.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationDate": number,
   "defaultVersionId": "string",
   "generationId": "string",
   "lastModifiedDate": number,
   "policyArn": "string",
   "policyDocument": "string",
   "policyName": "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.

creationDate

The date the policy was created.

Type: Timestamp

defaultVersionId

The default policy version ID.

Type: String

Pattern: [0-9]+

generationId

The generation ID of the policy.

Type: String

lastModifiedDate

The date the policy was last modified.

Type: Timestamp

policyArn

The policy ARN.

Type: String

policyDocument

The JSON document that describes the policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 404600.

Pattern: [\s\S]*

policyName

The policy name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401