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

DescribeChannel

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

Request Syntax


GET /channel/ChannelName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ChannelName

The name of the channel.

Required: Yes

Request Body

The request does not have a request body.

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,
   "LogConfiguration": { 
      "LogTypes": [ "string" ]
   },
   "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 ARN of 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

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

LogConfiguration

The log configuration for the channel.

Type: LogConfigurationForChannel object

Outputs

The channel's output properties.

Type: Array of ResponseOutputItem objects

PlaybackMode

The channel's playback mode.

Type: String

tags

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.

Type: String to string map

Tier

The channel's tier.

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.