channels

Creates, updates, deletes, gets or lists a channels resource.

Overview

Name	channels
Type	Resource
Id	aws.mediatailor.channels

Fields

The following fields are returned by SELECT queries:

describe_channel

Name	Datatype	Description
arn	string	The ARN of the channel.
audiences	array	The list of audiences defined in channel.
channel_name	string	The name of the channel.
channel_state	string	Indicates whether the channel is in a running state or not. (RUNNING, STOPPED)
creation_time	string (date-time)	The timestamp of when the channel was created.
filler_slate	object	Slate VOD source configuration.
last_modified_time	string (date-time)	The timestamp of when the channel was last modified.
log_configuration	object	The log configuration for the channel.
outputs	array	The channel's output properties.
playback_mode	string	The channel's playback mode.
tags	object	The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
tier	string	The channel's tier.
time_shift_configuration	object	The configuration for time-shifted viewing.

list_channels

Name	Datatype	Description
arn	string	The ARN of the channel.
audiences	array	The list of audiences defined in channel.
channel_name	string	The name of the channel.
channel_state	string	Returns the state whether the channel is running or not.
creation_time	string (date-time)	The timestamp of when the channel was created.
filler_slate	object	Slate VOD source configuration.
last_modified_time	string (date-time)	The timestamp of when the channel was last modified.
log_configuration	object	The log configuration.
outputs	array	The channel's output properties.
playback_mode	string	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	The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
tier	string	The tier for this channel. STANDARD tier channels can contain live programs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_channel	select	channel_name, region		Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
list_channels	select	region	maxResults, nextToken	Retrieves information about the channels that are associated with the current AWS account.
create_channel	insert	channel_name, region, PlaybackMode		Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
update_channel	update	channel_name, region		Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
delete_channel	delete	channel_name, region		Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
configure_logs_for_channel	exec	region, ChannelName, LogTypes		Configures Amazon CloudWatch log settings for a channel.
start_channel	exec	channel_name, region		Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
stop_channel	exec	channel_name, region		Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

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.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results. The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
nextToken	string	Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. For the first ListChannels request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

SELECT examples

describe_channel

Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

SELECT
arn,
audiences,
channel_name,
channel_state,
creation_time,
filler_slate,
last_modified_time,
log_configuration,
outputs,
playback_mode,
tags,
tier,
time_shift_configuration
FROM aws.mediatailor.channels
WHERE channel_name = '{{ channel_name }}' -- required
AND region = '{{ region }}' -- required
;

list_channels

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

SELECT
arn,
audiences,
channel_name,
channel_state,
creation_time,
filler_slate,
last_modified_time,
log_configuration,
outputs,
playback_mode,
tags,
tier
FROM aws.mediatailor.channels
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_channel

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

INSERT INTO aws.mediatailor.channels (
FillerSlate,
Outputs,
PlaybackMode,
Tags,
Tier,
TimeShiftConfiguration,
Audiences,
channel_name,
region
)
SELECT 
'{{ FillerSlate }}',
'{{ Outputs }}',
'{{ PlaybackMode }}' /* required */,
'{{ Tags }}',
'{{ Tier }}',
'{{ TimeShiftConfiguration }}',
'{{ Audiences }}',
'{{ channel_name }}',
'{{ region }}'
RETURNING
arn,
audiences,
channel_name,
channel_state,
creation_time,
filler_slate,
last_modified_time,
outputs,
playback_mode,
tags,
tier,
time_shift_configuration
;

Manifest

# Description fields are for documentation purposes
- name: channels
props:
  - name: channel_name
    value: "{{ channel_name }}"
    description: Required parameter for the channels resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channels resource.
  - name: FillerSlate
    description: |
      Slate VOD source configuration.
    value:
      SourceLocationName: "{{ SourceLocationName }}"
      VodSourceName: "{{ VodSourceName }}"
  - name: Outputs
    description: |
      An object that represents an object in the CreateChannel request.
    value:
      - DashPlaylistSettings:
          ManifestWindowSeconds: {{ ManifestWindowSeconds }}
          MinBufferTimeSeconds: {{ MinBufferTimeSeconds }}
          MinUpdatePeriodSeconds: {{ MinUpdatePeriodSeconds }}
          SuggestedPresentationDelaySeconds: {{ SuggestedPresentationDelaySeconds }}
        HlsPlaylistSettings:
          ManifestWindowSeconds: {{ ManifestWindowSeconds }}
          AdMarkupType:
            - "{{ AdMarkupType }}"
        ManifestName: "{{ ManifestName }}"
        SourceGroup: "{{ SourceGroup }}"
  - name: PlaybackMode
    value: "{{ PlaybackMode }}"
    valid_values: ['LOOP', 'LINEAR']
  - name: Tags
    value: "{{ Tags }}"
  - name: Tier
    value: "{{ Tier }}"
    valid_values: ['BASIC', 'STANDARD']
  - name: TimeShiftConfiguration
    description: |
      The configuration for time-shifted viewing.
    value:
      MaxTimeDelaySeconds: {{ MaxTimeDelaySeconds }}
  - name: Audiences
    value:
      - "{{ Audiences }}"

UPDATE examples

update_channel

Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

UPDATE aws.mediatailor.channels
SET 
FillerSlate = '{{ FillerSlate }}',
Outputs = '{{ Outputs }}',
TimeShiftConfiguration = '{{ TimeShiftConfiguration }}',
Audiences = '{{ Audiences }}'
WHERE 
channel_name = '{{ channel_name }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
audiences,
channel_name,
channel_state,
creation_time,
filler_slate,
last_modified_time,
outputs,
playback_mode,
tags,
tier,
time_shift_configuration;

DELETE examples

delete_channel

Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

DELETE FROM aws.mediatailor.channels
WHERE channel_name = '{{ channel_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

configure_logs_for_channel

Configures Amazon CloudWatch log settings for a channel.

EXEC aws.mediatailor.channels.configure_logs_for_channel 
@region='{{ region }}' --required 
@@json=
'{
"ChannelName": "{{ ChannelName }}", 
"LogTypes": "{{ LogTypes }}"
}'
;

start_channel

Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

EXEC aws.mediatailor.channels.start_channel 
@channel_name='{{ channel_name }}' --required, 
@region='{{ region }}' --required
;

stop_channel

Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

EXEC aws.mediatailor.channels.stop_channel 
@channel_name='{{ channel_name }}' --required, 
@region='{{ region }}' --required
;