GetChannelSchedule - AWS Elemental MediaTailor

GetChannelSchedule

Retrieves information about your channel's schedule.

URI

/v1/channel/channelName/schedule

HTTP methods

GET

Operation ID: GetChannelSchedule

Retrieves information about your channel's schedule.

Path parameters
NameTypeRequiredDescription
channelNameStringTrue

The identifier for the channel you are working on.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

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

maxResultsStringFalse

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

durationMinutesStringFalse

The schedule duration in minutes. The maximum duration is 4320 minutes (three days).

Responses
Status codeResponse modelDescription
200GetChannelScheduleResponse

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

Response bodies

{ "NextToken": "string", "Items": [ { "VodSourceName": "string", "ChannelName": "string", "LiveSourceName": "string", "SourceLocationName": "string", "ScheduleEntryType": enum, "ScheduleAdBreaks": [ { "VodSourceName": "string", "SourceLocationName": "string", "ApproximateDurationSeconds": integer, "ApproximateStartTime": integer } ], "ApproximateDurationSeconds": integer, "Arn": "string", "ApproximateStartTime": integer, "ProgramName": "string" } ] }

Properties

GetChannelScheduleResponse

Returns the schedule entries for the channel.

PropertyTypeRequiredDescription
Items

Array of type ScheduleEntry

False

A list of schedule entries for the channel.

NextToken

string

False

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

ScheduleAdBreak

The schedule's ad break properties.

PropertyTypeRequiredDescription
ApproximateDurationSeconds

integer

Format: int64

False

The approximate duration of the ad break, in seconds.

ApproximateStartTime

integer

Format: date-time

False

The approximate time that the ad will start playing.

SourceLocationName

string

False

The name of the source location containing the VOD source used for the ad break.

VodSourceName

string

False

The name of the VOD source used for the ad break.

ScheduleEntry

The properties for a schedule.

PropertyTypeRequiredDescription
ApproximateDurationSeconds

integer

Format: int64

False

The approximate duration of this program, in seconds.

ApproximateStartTime

integer

Format: date-time

False

The approximate time that the program will start playing.

Arn

string

True

The ARN of the program.

ChannelName

string

True

The name of the channel that uses this schedule.

LiveSourceName

string

False

The name of the live source used for the program.

ProgramName

string

True

The name of the program.

ScheduleAdBreaks

Array of type ScheduleAdBreak

False

The schedule's ad break properties.

ScheduleEntryType

string

Values: PROGRAM | FILLER_SLATE

False

The type of schedule entry.

Valid values: PROGRAM or FILLER_SLATE.

SourceLocationName

string

True

The name of the source location.

VodSourceName

string

False

The name of the VOD source.

See also

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

GetChannelSchedule