Channel - AWS Elemental MediaTailor

Channel

Creates, describes, updates, or deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

URI

/v1/channel/channelName

HTTP methods

GET

Operation ID: DescribeChannel

Describes the properties of a specific channel.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

Responses
Status code Response model Description
200 DescribeChannelResponse

Success.

POST

Operation ID: CreateChannel

Creates a channel.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

Responses
Status code Response model Description
200 DescribeChannelResponse

Success.

PUT

Operation ID: UpdateChannel

Updates an existing channel.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

Responses
Status code Response model Description
200 DescribeChannelResponse

Success.

DELETE

Operation ID: DeleteChannel

Deletes a channel. You must stop the channel before it can be deleted.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

Responses
Status code Response model Description
200 DeleteChannelResponse

Success.

Schemas

Request bodies

{ "FillerSlate": { "VodSourceName": "string", "SourceLocationName": "string" }, "Outputs": [ { "ManifestName": "string", "DashPlaylistSettings": { "ManifestWindowSeconds": integer, "SuggestedPresentationDelaySeconds": integer, "MinBufferTimeSeconds": integer, "MinUpdatePeriodSeconds": integer }, "HlsPlaylistSettings": { "ManifestWindowSeconds": integer }, "SourceGroup": "string" } ], "PlaybackMode": enum, "tags": { } }
{ "Outputs": [ { "ManifestName": "string", "DashPlaylistSettings": { "ManifestWindowSeconds": integer, "SuggestedPresentationDelaySeconds": integer, "MinBufferTimeSeconds": integer, "MinUpdatePeriodSeconds": integer }, "HlsPlaylistSettings": { "ManifestWindowSeconds": integer }, "SourceGroup": "string" } ] }

Response bodies

{ "FillerSlate": { "VodSourceName": "string", "SourceLocationName": "string" }, "ChannelState": enum, "ChannelName": "string", "Outputs": [ { "ManifestName": "string", "DashPlaylistSettings": { "ManifestWindowSeconds": integer, "SuggestedPresentationDelaySeconds": integer, "MinBufferTimeSeconds": integer, "MinUpdatePeriodSeconds": integer }, "PlaybackUrl": "string", "HlsPlaylistSettings": { "ManifestWindowSeconds": integer }, "SourceGroup": "string" } ], "CreationTime": integer, "LastModifiedTime": integer, "Arn": "string", "PlaybackMode": "string", "tags": { } }
{ }

Properties

CreateChannelRequest

The configuration for this channel.

Property Type Required Description
FillerSlate

SlateSource

False

The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses a LINEAR PlaybackMode.

Outputs

Array of type RequestOutputItem

True

The channel's output properties.

PlaybackMode

string

Values: LOOP | LINEAR

True

The type of playback mode to use for this channel.

LINEAR - The programs in the schedule play once back-to-back in the schedule.

LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

tags

object

False

The tags to assign to the channel.

DashPlaylistSettings

Dash manifest configuration parameters.

Property Type Required Description
ManifestWindowSeconds

integer

False

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

MinBufferTimeSeconds

integer

False

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

MinUpdatePeriodSeconds

integer

False

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

SuggestedPresentationDelaySeconds

integer

False

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

DeleteChannelResponse

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

DescribeChannelResponse

Returns a channel's properties.

Property Type Required Description
Arn

string

True

The ARN of the channel.

ChannelName

string

True

The name of the channel.

ChannelState

string

Values: RUNNING | STOPPED

True

Indicates whether the channel is in a running state or not.

CreationTime

integer

Format: date-time

False

The timestamp of when the channel was created.

FillerSlate

SlateSource

False

Contains information about the slate used to fill gaps between programs in the schedule.

LastModifiedTime

integer

Format: date-time

False

The timestamp of when the channel was last modified.

Outputs

Array of type ResponseOutputItem

True

The channel's output properties.

PlaybackMode

string

True

The channel's playback mode.

tags

object

False

The tags assigned to the channel.

HlsPlaylistSettings

HLS playlist configuration parameters.

Property Type Required Description
ManifestWindowSeconds

integer

False

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

RequestOutputItem

The output configuration for this channel.

Property Type Required Description
DashPlaylistSettings

DashPlaylistSettings

False

DASH manifest configuration parameters.

HlsPlaylistSettings

HlsPlaylistSettings

False

HLS playlist configuration parameters.

ManifestName

string

True

The name of the manifest for the channel. The name appears in the PlaybackUrl.

SourceGroup

string

True

A string used to match which HttpPackageConfiguration is used for each VodSource.

ResponseOutputItem

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

Property Type Required Description
DashPlaylistSettings

DashPlaylistSettings

False

DASH manifest configuration settings.

HlsPlaylistSettings

HlsPlaylistSettings

False

HLS manifest configuration settings.

ManifestName

string

True

The name of the manifest for the channel that will appear in the channel output's playback URL.

PlaybackUrl

string

True

The URL used for playback by content players.

SourceGroup

string

True

A string used to associate a package configuration source group with a channel output.

SlateSource

Slate VOD source configuration.

Property Type Required Description
SourceLocationName

string

False

The name of the source location where the slate VOD source is stored.

VodSourceName

string

False

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

UpdateChannelRequest

Updates a channel's Outputs.

Property Type Required Description
Outputs

Array of type RequestOutputItem

True

The channel's output properties.

See also

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

DescribeChannel

CreateChannel

UpdateChannel

DeleteChannel