CreateProgramCommand

Suggest an Edit

Creates 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, CreateProgramCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, CreateProgramCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // CreateProgramRequest
  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
        },
      ],
    },
  ],
  ChannelName: "STRING_VALUE", // required
  LiveSourceName: "STRING_VALUE",
  ProgramName: "STRING_VALUE", // required
  ScheduleConfiguration: { // ScheduleConfiguration
    Transition: { // Transition
      DurationMillis: Number("long"),
      RelativePosition: "BEFORE_PROGRAM" || "AFTER_PROGRAM", // required
      RelativeProgram: "STRING_VALUE",
      ScheduledStartTimeMillis: Number("long"),
      Type: "STRING_VALUE", // required
    },
    ClipRange: { // ClipRange
      EndOffsetMillis: Number("long"),
      StartOffsetMillis: Number("long"),
    },
  },
  SourceLocationName: "STRING_VALUE", // required
  VodSourceName: "STRING_VALUE",
  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"),
        },
      ],
    },
  ],
};
const command = new CreateProgramCommand(input);
const response = await client.send(command);
// { // CreateProgramResponse
//   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"),
//         },
//       ],
//     },
//   ],
// };

CreateProgramCommand Input

See CreateProgramCommandInput for more details

Parameter
Type
Description
ChannelName
Required
string | undefined

The name of the channel for this Program.

ProgramName
Required
string | undefined

The name of the Program.

ScheduleConfiguration
Required
ScheduleConfiguration | undefined

The schedule configuration settings.

SourceLocationName
Required
string | undefined

The name of the source location.

AdBreaks
AdBreak[] | undefined

The ad break configuration settings.

AudienceMedia
AudienceMedia[] | undefined

The list of AudienceMedia defined in program.

LiveSourceName
string | undefined

The name of the LiveSource for this Program.

VodSourceName
string | undefined

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

CreateProgramCommand Output

See CreateProgramCommandOutput 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 to assign to the program.

AudienceMedia
AudienceMedia[] | undefined

The list of AudienceMedia defined in program.

ChannelName
string | undefined

The name to assign to the channel for this program.

ClipRange
ClipRange | undefined

The clip range configuration settings.

CreationTime
Date | undefined

The time 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 to assign to this program.

ScheduledStartTime
Date | undefined

The scheduled start time for this Program.

SourceLocationName
string | undefined

The name to assign to the source location for this program.

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.