Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
Request Syntax
POST /channel/ChannelName
HTTP/1.1
Content-type: application/json
{
"Audiences": [ "string
" ],
"FillerSlate": {
"SourceLocationName": "string
",
"VodSourceName": "string
"
},
"Outputs": [
{
"DashPlaylistSettings": {
"ManifestWindowSeconds": number
,
"MinBufferTimeSeconds": number
,
"MinUpdatePeriodSeconds": number
,
"SuggestedPresentationDelaySeconds": number
},
"HlsPlaylistSettings": {
"AdMarkupType": [ "string
" ],
"ManifestWindowSeconds": number
},
"ManifestName": "string
",
"SourceGroup": "string
"
}
],
"PlaybackMode": "string
",
"tags": {
"string
" : "string
"
},
"Tier": "string
",
"TimeShiftConfiguration": {
"MaxTimeDelaySeconds": number
}
}
URI Request Parameters
The request uses the following URI parameters.
- ChannelName
-
The name of the channel.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Audiences
-
The list of audiences defined in channel.
Type: Array of strings
Required: No
- FillerSlate
-
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the
LINEAR
PlaybackMode
. MediaTailor doesn't support filler slate for channels using theLOOP
PlaybackMode
.Type: SlateSource object
Required: No
- Outputs
-
The channel's output properties.
Type: Array of RequestOutputItem objects
Required: Yes
- PlaybackMode
-
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.Type: String
Valid Values:
LOOP | LINEAR
Required: Yes
-
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.
Type: String to string map
Required: No
- Tier
-
The tier of the channel.
Type: String
Valid Values:
BASIC | STANDARD
Required: No
- TimeShiftConfiguration
-
The time-shifted viewing configuration you want to associate to the channel.
Type: TimeShiftConfiguration object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"Audiences": [ "string" ],
"ChannelName": "string",
"ChannelState": "string",
"CreationTime": number,
"FillerSlate": {
"SourceLocationName": "string",
"VodSourceName": "string"
},
"LastModifiedTime": number,
"Outputs": [
{
"DashPlaylistSettings": {
"ManifestWindowSeconds": number,
"MinBufferTimeSeconds": number,
"MinUpdatePeriodSeconds": number,
"SuggestedPresentationDelaySeconds": number
},
"HlsPlaylistSettings": {
"AdMarkupType": [ "string" ],
"ManifestWindowSeconds": number
},
"ManifestName": "string",
"PlaybackUrl": "string",
"SourceGroup": "string"
}
],
"PlaybackMode": "string",
"tags": {
"string" : "string"
},
"Tier": "string",
"TimeShiftConfiguration": {
"MaxTimeDelaySeconds": number
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) to assign to the channel.
Type: String
- Audiences
-
The list of audiences defined in channel.
Type: Array of strings
- ChannelName
-
The name to assign to the channel.
Type: String
- ChannelState
-
Indicates whether the channel is in a running state or not.
Type: String
Valid Values:
RUNNING | STOPPED
- CreationTime
-
The timestamp of when the channel was created.
Type: Timestamp
- FillerSlate
-
Contains information about the slate used to fill gaps between programs in the schedule.
Type: SlateSource object
- LastModifiedTime
-
The timestamp of when the channel was last modified.
Type: Timestamp
- Outputs
-
The output properties to assign to the channel.
Type: Array of ResponseOutputItem objects
- PlaybackMode
-
The playback mode to assign to the channel.
Type: String
-
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.
Type: String to string map
- Tier
-
The tier of the channel.
Type: String
- TimeShiftConfiguration
-
The time-shifted viewing configuration assigned to the channel.
Type: TimeShiftConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: