Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mediatailor ]

describe-channel

Description

Describes the properties of a specific channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-channel
--channel-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

The identifier for the channel you are working on.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

The ARN of the channel.

ChannelName -> (string)

The name of the channel.

ChannelState -> (string)

Indicates whether the channel is in a running state or not.

CreationTime -> (timestamp)

The timestamp of when the channel was created.

FillerSlate -> (structure)

Contains information about the slate used to fill gaps between programs in the schedule.

SourceLocationName -> (string)

The name of the source location where the slate VOD source is stored.

VodSourceName -> (string)

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

LastModifiedTime -> (timestamp)

The timestamp of when the channel was last modified.

Outputs -> (list)

The channel's output properties.

(structure)

This response includes only the "property" : "type" property.

DashPlaylistSettings -> (structure)

DASH manifest configuration settings.

ManifestWindowSeconds -> (integer)

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

MinBufferTimeSeconds -> (integer)

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

MinUpdatePeriodSeconds -> (integer)

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

SuggestedPresentationDelaySeconds -> (integer)

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

HlsPlaylistSettings -> (structure)

HLS manifest configuration settings.

ManifestWindowSeconds -> (integer)

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

ManifestName -> (string)

The name of the manifest for the channel that will appear in the channel output's playback URL.

PlaybackUrl -> (string)

The URL used for playback by content players.

SourceGroup -> (string)

A string used to associate a package configuration source group with a channel output.

PlaybackMode -> (string)

The channel's playback mode.

Tags -> (map)

The tags assigned to the channel.

key -> (string)

value -> (string)