DescribeProgramCommand

Suggest an Edit

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

Example Syntax

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

import { MediaTailorClient, DescribeProgramCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, DescribeProgramCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // DescribeProgramRequest
  ChannelName: "STRING_VALUE", // required
  ProgramName: "STRING_VALUE", // required
};
const command = new DescribeProgramCommand(input);
const response = await client.send(command);
// { // DescribeProgramResponse
//   AdBreaks: [ // __listOfAdBreak
//     { // AdBreak
//       MessageType: "SPLICE_INSERT" || "TIME_SIGNAL",
//       OffsetMillis: Number("long"), // required
//       Slate: { // SlateSource
//         SourceLocationName: "STRING_VALUE",
//         VodSourceName: "STRING_VALUE",
//       },
//       SpliceInsertMessage: { // SpliceInsertMessage
//         AvailNum: Number("int"),
//         AvailsExpected: Number("int"),
//         SpliceEventId: Number("int"),
//         UniqueProgramId: Number("int"),
//       },
//       TimeSignalMessage: { // TimeSignalMessage
//         SegmentationDescriptors: [ // SegmentationDescriptorList
//           { // SegmentationDescriptor
//             SegmentationEventId: Number("int"),
//             SegmentationUpidType: Number("int"),
//             SegmentationUpid: "STRING_VALUE",
//             SegmentationTypeId: Number("int"),
//             SegmentNum: Number("int"),
//             SegmentsExpected: Number("int"),
//             SubSegmentNum: Number("int"),
//             SubSegmentsExpected: Number("int"),
//           },
//         ],
//       },
//       AdBreakMetadata: [ // AdBreakMetadataList
//         { // KeyValuePair
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//         },
//       ],
//     },
//   ],
//   Arn: "STRING_VALUE",
//   ChannelName: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LiveSourceName: "STRING_VALUE",
//   ProgramName: "STRING_VALUE",
//   ScheduledStartTime: new Date("TIMESTAMP"),
//   SourceLocationName: "STRING_VALUE",
//   VodSourceName: "STRING_VALUE",
//   ClipRange: { // ClipRange
//     EndOffsetMillis: Number("long"),
//     StartOffsetMillis: Number("long"),
//   },
//   DurationMillis: Number("long"),
//   AudienceMedia: [ // __listOfAudienceMedia
//     { // AudienceMedia
//       Audience: "STRING_VALUE",
//       AlternateMedia: [ // __listOfAlternateMedia
//         { // AlternateMedia
//           SourceLocationName: "STRING_VALUE",
//           LiveSourceName: "STRING_VALUE",
//           VodSourceName: "STRING_VALUE",
//           ClipRange: {
//             EndOffsetMillis: Number("long"),
//             StartOffsetMillis: Number("long"),
//           },
//           ScheduledStartTimeMillis: Number("long"),
//           AdBreaks: [
//             {
//               MessageType: "SPLICE_INSERT" || "TIME_SIGNAL",
//               OffsetMillis: Number("long"), // required
//               Slate: {
//                 SourceLocationName: "STRING_VALUE",
//                 VodSourceName: "STRING_VALUE",
//               },
//               SpliceInsertMessage: {
//                 AvailNum: Number("int"),
//                 AvailsExpected: Number("int"),
//                 SpliceEventId: Number("int"),
//                 UniqueProgramId: Number("int"),
//               },
//               TimeSignalMessage: {
//                 SegmentationDescriptors: [
//                   {
//                     SegmentationEventId: Number("int"),
//                     SegmentationUpidType: Number("int"),
//                     SegmentationUpid: "STRING_VALUE",
//                     SegmentationTypeId: Number("int"),
//                     SegmentNum: Number("int"),
//                     SegmentsExpected: Number("int"),
//                     SubSegmentNum: Number("int"),
//                     SubSegmentsExpected: Number("int"),
//                   },
//                 ],
//               },
//               AdBreakMetadata: [
//                 {
//                   Key: "STRING_VALUE", // required
//                   Value: "STRING_VALUE", // required
//                 },
//               ],
//             },
//           ],
//           DurationMillis: Number("long"),
//         },
//       ],
//     },
//   ],
// };

DescribeProgramCommand Input

See DescribeProgramCommandInput for more details

Parameter
Type
Description
ChannelName
Required
string | undefined

The name of the channel associated with this Program.

ProgramName
Required
string | undefined

The name of the program.

DescribeProgramCommand Output

See DescribeProgramCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AdBreaks
AdBreak[] | undefined

The ad break configuration settings.

Arn
string | undefined

The ARN of the program.

AudienceMedia
AudienceMedia[] | undefined

The list of AudienceMedia defined in program.

ChannelName
string | undefined

The name of the channel that the program belongs to.

ClipRange
ClipRange | undefined

The clip range configuration settings.

CreationTime
Date | undefined

The timestamp of when the program was created.

DurationMillis
number | undefined

The duration of the live program in milliseconds.

LiveSourceName
string | undefined

The name of the LiveSource for this Program.

ProgramName
string | undefined

The name of the program.

ScheduledStartTime
Date | undefined

The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

SourceLocationName
string | undefined

The source location name.

VodSourceName
string | undefined

The name that's used to refer to a VOD source.

Throws

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