Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateChannel

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

Request Syntax


PUT /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"
      }
   ],
   "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 the LOOP PlaybackMode.

Type: SlateSource object

Required: No

Outputs

The channel's output properties.

Type: Array of RequestOutputItem objects

Required: Yes

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) associated with the channel.

Type: String

Audiences

The list of audiences defined in channel.

Type: Array of strings

ChannelName

The name of the channel.

Type: String

ChannelState

Returns the state whether the channel is running or not.

Type: String

Valid Values: RUNNING | STOPPED

CreationTime

The timestamp of when the channel was created.

Type: Timestamp

FillerSlate

Type: SlateSource object

LastModifiedTime

The timestamp that indicates when the channel was last modified.

Type: Timestamp

Outputs

The channel's output properties.

Type: Array of ResponseOutputItem objects

PlaybackMode

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.

Type: String

tags

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 associated with this Channel.

Type: String

TimeShiftConfiguration

The time-shifted viewing configuration for the channel.

Type: TimeShiftConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.