Menu
AWS IoT
Developer Guide

DetachPrincipalPolicy

DetachPrincipalPolicy

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

https

Request syntax:

DELETE /principal-policies/policyName x-amzn-iot-principal: principal

URI Request Parameters:

Name

Type

Req?

Description

policyName

PolicyName

yes

The name of the policy to detach.

principal

Principal

yes

The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity 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 detach-principal-policy \ --policy-name <value> \ --principal <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "policyName": "string", "principal": "string" }

cli-input-json fields:

Name

Type

Description

policyName

string

length- max:128 min:1

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

The name of the policy to detach.

principal

string

The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.

Output:

None

Errors:

ResourceNotFoundException

The specified resource does not exist.

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.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

ServiceUnavailableException

The service is temporarily unavailable.

InternalFailureException

An unexpected error has occurred.