DescribeChannelCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MediaTailorClient, DescribeChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, DescribeChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // DescribeChannelRequest
  ChannelName: "STRING_VALUE", // required
};
const command = new DescribeChannelCommand(input);
const response = await client.send(command);
// { // DescribeChannelResponse
//   Arn: "STRING_VALUE",
//   ChannelName: "STRING_VALUE",
//   ChannelState: "RUNNING" || "STOPPED",
//   CreationTime: new Date("TIMESTAMP"),
//   FillerSlate: { // SlateSource
//     SourceLocationName: "STRING_VALUE",
//     VodSourceName: "STRING_VALUE",
//   },
//   LastModifiedTime: new Date("TIMESTAMP"),
//   Outputs: [ // ResponseOutputs
//     { // ResponseOutputItem
//       DashPlaylistSettings: { // DashPlaylistSettings
//         ManifestWindowSeconds: Number("int"),
//         MinBufferTimeSeconds: Number("int"),
//         MinUpdatePeriodSeconds: Number("int"),
//         SuggestedPresentationDelaySeconds: Number("int"),
//       },
//       HlsPlaylistSettings: { // HlsPlaylistSettings
//         ManifestWindowSeconds: Number("int"),
//         AdMarkupType: [ // adMarkupTypes
//           "DATERANGE" || "SCTE35_ENHANCED",
//         ],
//       },
//       ManifestName: "STRING_VALUE", // required
//       PlaybackUrl: "STRING_VALUE", // required
//       SourceGroup: "STRING_VALUE", // required
//     },
//   ],
//   PlaybackMode: "STRING_VALUE",
//   Tags: { // __mapOf__string
//     "<keys>": "STRING_VALUE",
//   },
//   Tier: "STRING_VALUE",
//   LogConfiguration: { // LogConfigurationForChannel
//     LogTypes: [ // LogTypes
//       "AS_RUN",
//     ],
//   },
//   TimeShiftConfiguration: { // TimeShiftConfiguration
//     MaxTimeDelaySeconds: Number("int"), // required
//   },
//   Audiences: [ // Audiences
//     "STRING_VALUE",
//   ],
// };

DescribeChannelCommand Input

See DescribeChannelCommandInput for more details

Parameter
Type
Description
ChannelName
Required
string | undefined

The name of the channel.

DescribeChannelCommand Output

See DescribeChannelCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LogConfiguration
Required
LogConfigurationForChannel | undefined

The log configuration for the channel.

Arn
string | undefined

The ARN of the channel.

Audiences
string[] | undefined

The list of audiences defined in channel.

ChannelName
string | undefined

The name of the channel.

ChannelState
ChannelState | undefined

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

CreationTime
Date | undefined

The timestamp of when the channel was created.

FillerSlate
SlateSource | undefined

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

LastModifiedTime
Date | undefined

The timestamp of when the channel was last modified.

Outputs
ResponseOutputItem[] | undefined

The channel's output properties.

PlaybackMode
string | undefined

The channel's playback mode.

Tags
Record<string, string> | undefined

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 | undefined

The channel's tier.

TimeShiftConfiguration
TimeShiftConfiguration | undefined

The time-shifted viewing configuration for the channel.

Throws

Name
Fault
Details
MediaTailorServiceException
Base exception class for all service exceptions from MediaTailor service.