Menu
AWS IoT
Developer Guide

GetPolicy

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

Request syntax:

GET /policies/policyName

URI Request Parameters:

Name

Type

Req?

Description

policyName

PolicyName

yes

The name of the policy.

Response syntax:

Content-type: application/json { "policyName": "string", "policyArn": "string", "policyDocument": "string", "defaultVersionId": "string" }

Response Body Parameters:

Name

Type

Req?

Description

policyName

PolicyName

no

The policy name.

policyArn

PolicyArn

no

The policy ARN.

policyDocument

PolicyDocument

no

The JSON document that describes the policy.

defaultVersionId

PolicyVersionId

no

The default policy version ID.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot get-policy \ --policy-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "policyName": "string" }

cli-input-json fields:

Name

Type

Description

policyName

string

length max:128 min:1

pattern: [w+=,.@-]+

The name of the policy.

Output:

{ "policyName": "string", "policyArn": "string", "policyDocument": "string", "defaultVersionId": "string" }

cli output fields:

Name

Type

Description

policyName

string

length max:128 min:1

pattern: [w+=,.@-]+

The policy name.

policyArn

string

The policy ARN.

policyDocument

string

The JSON document that describes the policy.

defaultVersionId

string

pattern: [0-9]+

The default policy version ID.

On this page: