Menu
AWS IoT
Developer Guide

AttachPolicy

Attaches a policy to the specified target.

Request syntax:

PUT /target-policies/policyName Content-type: application/json { "target": "string" }

URI Request Parameters:

Name

Type

Req?

Description

policyName

PolicyName

yes

The name of the policy to attach.

Request Body Parameters:

Name

Type

Req?

Description

target

PolicyTarget

yes

The identity to which the policy is attached.

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

LimitExceededException

The number of attached entities exceeds the limit.

HTTP response code: 410

CLI

Synopsis:

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

cli-input-json format:

{ "policyName": "string", "target": "string" }

cli-input-json fields:

Name

Type

Description

policyName

string

length max:128 min:1

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

The name of the policy to attach.

target

string

The identity to which the policy is attached.

Output:

None

On this page: