create-program¶

Description¶

Creates a program.

Synopsis¶

  create-program
[--ad-breaks <value>]
--channel-name <value>
--program-name <value>
--schedule-configuration <value>
--source-location-name <value>
--vod-source-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--ad-breaks (list)

The ad break configuration settings.

(structure)

Ad break configuration parameters.

MessageType -> (string)

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

OffsetMillis -> (long)

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

Slate -> (structure)

Ad break slate configuration.

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.

SpliceInsertMessage -> (structure)

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

AvailNum -> (integer)

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

AvailsExpected -> (integer)

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

SpliceEventId -> (integer)

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

UniqueProgramId -> (integer)

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

Shorthand Syntax:

MessageType=string,OffsetMillis=long,Slate={SourceLocationName=string,VodSourceName=string},SpliceInsertMessage={AvailNum=integer,AvailsExpected=integer,SpliceEventId=integer,UniqueProgramId=integer} ...

JSON Syntax:

[
  {
    "MessageType": "SPLICE_INSERT",
    "OffsetMillis": long,
    "Slate": {
      "SourceLocationName": "string",
      "VodSourceName": "string"
    },
    "SpliceInsertMessage": {
      "AvailNum": integer,
      "AvailsExpected": integer,
      "SpliceEventId": integer,
      "UniqueProgramId": integer
    }
  }
  ...
]

--channel-name (string)

The identifier for the channel you are working on.

--program-name (string)

The identifier for the program you are working on.

--schedule-configuration (structure)

The schedule configuration settings.

Transition -> (structure)

Program transition configurations.

RelativePosition -> (string)

The position where this program will be inserted relative to the RelativePosition.

RelativeProgram -> (string)

The name of the program that this program will be inserted next to, as defined by RelativePosition.

ScheduledStartTimeMillis -> (long)

The date and time that the program is scheduled to start, in epoch milliseconds.

Type -> (string)

Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.

ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.

Note the following considerations when using ABSOLUTE transitions:

If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.

If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.

RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.

Shorthand Syntax:

Transition={RelativePosition=string,RelativeProgram=string,ScheduledStartTimeMillis=long,Type=string}

JSON Syntax:

{
  "Transition": {
    "RelativePosition": "BEFORE_PROGRAM"|"AFTER_PROGRAM",
    "RelativeProgram": "string",
    "ScheduledStartTimeMillis": long,
    "Type": "string"
  }
}

--source-location-name (string)

The name of the source location.

--vod-source-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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¶

AdBreaks -> (list)

The ad break configuration settings.

(structure)

Ad break configuration parameters.

MessageType -> (string)

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

OffsetMillis -> (long)

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

Slate -> (structure)

Ad break slate configuration.

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.

SpliceInsertMessage -> (structure)

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

AvailNum -> (integer)

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

AvailsExpected -> (integer)

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

SpliceEventId -> (integer)

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

UniqueProgramId -> (integer)

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

Arn -> (string)

The ARN of the program.

ChannelName -> (string)

The name of the channel that the program belongs to.

CreationTime -> (timestamp)

The timestamp of when the program was created.

ProgramName -> (string)

The name of the program.

ScheduledStartTime -> (timestamp)

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)

The source location name.

VodSourceName -> (string)

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

Table of Contents

Feedback

User Guide

create-program¶

Description¶

Synopsis¶

Options¶

Output¶