Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutChannelPolicy

Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.

Request Syntax


PUT /channelGroup/ChannelGroupName/channel/ChannelName/policy HTTP/1.1
Content-type: application/json

{
   "Policy": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ChannelGroupName

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

ChannelName

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Policy

The policy to attach to the specified channel.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 6144.

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Indicates that an error from the service occurred while trying to process a request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400