ChannelPolicy - AWS Elemental MediaTailor

ChannelPolicy

Manages a channel's IAM policy. IAM policies are used to control access to your channel.

URI

/v1/channel/channelName/policy

HTTP methods

GET

Operation ID: GetChannelPolicy

Retrieves information about a channel's IAM policy.

Path parameters
NameTypeRequiredDescription
channelNameStringTrue

The identifier for the channel you are working on.

Responses
Status codeResponse modelDescription
200GetChannelPolicyResponse

Success.

PUT

Operation ID: PutChannelPolicy

Creates an IAM policy for the channel.

Path parameters
NameTypeRequiredDescription
channelNameStringTrue

The identifier for the channel you are working on.

Responses
Status codeResponse modelDescription
200PutChannelPolicyResponse

Success.

DELETE

Operation ID: DeleteChannelPolicy

Deletes a channel's IAM policy.

Path parameters
NameTypeRequiredDescription
channelNameStringTrue

The identifier for the channel you are working on.

Responses
Status codeResponse modelDescription
200DeleteChannelPolicyResponse

Success.

OPTIONS

Enable CORS by returning the correct headers

Path parameters
NameTypeRequiredDescription
channelNameStringTrue

The identifier for the channel you are working on.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "Policy": "string" }
{ }

Response bodies

{ "Policy": "string" }
{ }
{ }

Properties

DeleteChannelPolicyRequest

This response includes only the "type" : "object" property.

DeleteChannelPolicyResponse

This response includes only the "type" : "object" property.

GetChannelPolicyResponse

Returns the channel's IAM policy.

PropertyTypeRequiredDescription
Policy

string

False

The IAM policy for the channel.

PutChannelPolicyRequest

Adds an IAM policy for the channel.

PropertyTypeRequiredDescription
Policy

string

True

Adds an IAM role that determines the permissions of your channel.

PutChannelPolicyResponse

This response includes only the "type" : "object" property.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetChannelPolicy

PutChannelPolicy

DeleteChannelPolicy