Menu
AWS IoT
Developer Guide

GetPolicyVersion

Gets information about the specified policy version.

Request syntax:

GET /policies/policyName/version/policyVersionId

URI Request Parameters:

Name

Type

Req?

Description

policyName

PolicyName

yes

The name of the policy.

policyVersionId

PolicyVersionId

yes

The policy version ID.

Response syntax:

Content-type: application/json { "policyArn": "string", "policyName": "string", "policyDocument": "string", "policyVersionId": "string", "isDefaultVersion": "boolean" }

Response Body Parameters:

Name

Type

Req?

Description

policyArn

PolicyArn

no

The policy ARN.

policyName

PolicyName

no

The policy name.

policyDocument

PolicyDocument

no

The JSON document that describes the policy.

policyVersionId

PolicyVersionId

no

The policy version ID.

isDefaultVersion

IsDefaultVersion

no

Specifies whether the policy version is the default.

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-version \ --policy-name <value> \ --policy-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "policyName": "string", "policyVersionId": "string" }

cli-input-json fields:

Name

Type

Description

policyName

string

length max:128 min:1

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

The name of the policy.

policyVersionId

string

pattern: [0-9]+

The policy version ID.

Output:

{ "policyArn": "string", "policyName": "string", "policyDocument": "string", "policyVersionId": "string", "isDefaultVersion": "boolean" }

cli output fields:

Name

Type

Description

policyArn

string

The policy ARN.

policyName

string

length max:128 min:1

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

The policy name.

policyDocument

string

The JSON document that describes the policy.

policyVersionId

string

pattern: [0-9]+

The policy version ID.

isDefaultVersion

boolean

Specifies whether the policy version is the default.

On this page: