Menu
AWS IoT
API Reference

GetPolicy

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

Request Syntax

GET /policies/policyName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

policyName

The name of the policy.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "defaultVersionId": "string",
   "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.

defaultVersionId

The default policy version ID.

Type: String

Pattern: [0-9]+

policyArn

The policy ARN.

Type: String

policyDocument

The JSON document that describes the policy.

Type: String

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: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

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