SetDefaultPolicyVersionCommand

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.

Requires permission to access the SetDefaultPolicyVersion  action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, SetDefaultPolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, SetDefaultPolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // SetDefaultPolicyVersionRequest
  policyName: "STRING_VALUE", // required
  policyVersionId: "STRING_VALUE", // required
};
const command = new SetDefaultPolicyVersionCommand(input);
const response = await client.send(command);
// {};

SetDefaultPolicyVersionCommand Input

Parameter
Type
Description
policyName
Required
string | undefined

The policy name.

policyVersionId
Required
string | undefined

The policy version ID.

SetDefaultPolicyVersionCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource does not exist.

ServiceUnavailableException
server

The service is temporarily unavailable.

ThrottlingException
client

The rate exceeds the limit.

UnauthorizedException
client

You are not authorized to perform this operation.

IoTServiceException
Base exception class for all service exceptions from IoT service.