/policies/{policyName}/version

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/policies//version' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policyDocument": "string"
}'

Response Example

200 - Example 1

{
    "policyArn": "string",
    "policyDocument": "string",
    "policyVersionId": "string",
    "isDefaultVersion": true
}

Request

Path Params

policyName

string

required

The policy name.

Query Params

setAsDefault

string

optional

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Body Params application/json

policyDocument

string

required

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Examples

Responses

🟢200Success

application/json

Body

The output of the CreatePolicyVersion operation.

policyArn

string

optional

The policy ARN.

policyDocument

string

optional

The JSON document that describes the policy.

policyVersionId

string

optional

The policy version ID.

Match pattern:

[0-9]+

isDefaultVersion

boolean

optional

Specifies whether the policy version is the default.

🟠480ResourceNotFoundException

🟠481MalformedPolicyException

🟠482VersionsLimitExceededException

🟠483InvalidRequestException

🟠484ThrottlingException

🟠485UnauthorizedException

🟠486ServiceUnavailableException

🟠487InternalFailureException

Modified at 2022-09-10 23:12:14

/policies/{policyName}

/policies/{policyName}/version