Class DescribeChannelCommandProtected

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

Example

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"),
//       },
//       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",
//     ],
//   },
// };

Param

DescribeChannelCommandInput

Returns

DescribeChannelCommandOutput

See

• DescribeChannelCommandInput for command's input shape.
• DescribeChannelCommandOutput for command's response shape.
• config for MediaTailorClient's config shape.

Throws

MediaTailorServiceException

Base exception class for all service exceptions from MediaTailor service.