ListChannels - AWS Elemental MediaTailor

ListChannels

Retrieves information about the channels that are associated with the current AWS account.

URI

/v1/channels

HTTP methods

GET

Operation ID: ListChannels

Retrieves a list of channels that are associated with this account.

Query parameters
Name Type Required Description
nextToken String False

Pagination token from the GET list request. Use the token to fetch the next page of results.

maxResults String False

Upper bound on number of records to return. The maximum number of results is 100.

Responses
Status code Response model Description
200 ListChannelsResponse

Success.

Schemas

Response bodies

{ "NextToken": "string", "Items": [ { "FillerSlate": { "VodSourceName": "string", "SourceLocationName": "string" }, "ChannelState": "string", "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

Channel

The configuration parameters for a channel.

Property Type Required Description
Arn

string

True

The ARN of the channel.

ChannelName

string

True

The name of the channel.

ChannelState

string

True

Returns the state whether the channel is running 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. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

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 type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, 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.

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.

ListChannelsResponse

Returns a list of channels.

Property Type Required Description
Items

Array of type Channel

False

An array of channels that are associated with this account.

NextToken

string

False

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

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.

See also

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

ListChannels