channel_schedules
Creates, updates, deletes, gets or lists a channel_schedules resource.
Overview
| Name | channel_schedules |
| Type | Resource |
| Id | aws.mediatailor.channel_schedules |
Fields
The following fields are returned by SELECT queries:
- get_channel_schedule
| Name | Datatype | Description |
|---|---|---|
approximate_duration_seconds | integer (int64) | The approximate duration of this program, in seconds. |
approximate_start_time | string (date-time) | The approximate time that the program will start playing. |
arn | string | The ARN of the program. |
audiences | array | The list of audiences defined in ScheduleEntry. |
channel_name | string | The name of the channel that uses this schedule. |
live_source_name | string | The name of the live source used for the program. |
program_name | string | The name of the program. |
schedule_ad_breaks | array | The schedule's ad break properties. |
schedule_entry_type | string | The type of schedule entry. (PROGRAM, FILLER_SLATE, ALTERNATE_MEDIA) |
source_location_name | string | The name of the source location. |
vod_source_name | string | The name of the VOD source. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_channel_schedule | select | channel_name, region | durationMinutes, maxResults, nextToken, audience | Retrieves information about your channel's schedule. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
channel_name | string | The name of the channel associated with this Channel Schedule. |
region | string | AWS region (default: us-east-1) |
audience | string | The single audience for GetChannelScheduleRequest. |
durationMinutes | string | The duration in minutes of the channel schedule. |
maxResults | integer | The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results. |
nextToken | string | (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results. For the first GetChannelScheduleRequest request, omit this value. For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. If the previous response didn't include a NextToken element, there are no more channel schedules to get. |
SELECT examples
- get_channel_schedule
Retrieves information about your channel's schedule.
SELECT
approximate_duration_seconds,
approximate_start_time,
arn,
audiences,
channel_name,
live_source_name,
program_name,
schedule_ad_breaks,
schedule_entry_type,
source_location_name,
vod_source_name
FROM aws.mediatailor.channel_schedules
WHERE channel_name = '{{ channel_name }}' -- required
AND region = '{{ region }}' -- required
AND durationMinutes = '{{ durationMinutes }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND audience = '{{ audience }}'
;