Program - AWS Elemental MediaTailor

Program

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

URI

/v1/channel/channelName/program/programName

HTTP methods

GET

Operation ID: DescribeProgram

Retrieves the properties of the requested program.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

programName String True

The identifier for the program you are working on.

Responses
Status code Response model Description
200 DescribeProgramResponse

Success.

POST

Operation ID: CreateProgram

Creates a program.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

programName String True

The identifier for the program you are working on.

Responses
Status code Response model Description
200 DescribeProgramResponse

Success.

DELETE

Operation ID: DeleteProgram

Deletes a specific program on a specific channel.

Path parameters
Name Type Required Description
channelName String True

The identifier for the channel you are working on.

programName String True

The identifier for the program you are working on.

Responses
Status code Response model Description
200 DeleteProgramResponse

Success.

Schemas

Request bodies

{ "VodSourceName": "string", "SourceLocationName": "string", "ScheduleConfiguration": { "Transition": { "RelativeProgram": "string", "Type": "string", "RelativePosition": enum } }, "AdBreaks": [ { "OffsetMillis": integer, "SpliceInsertMessage": { "SpliceEventId": integer, "AvailsExpected": integer, "AvailNum": integer, "UniqueProgramId": integer }, "Slate": { "VodSourceName": "string", "SourceLocationName": "string" }, "MessageType": enum } ] }

Response bodies

{ "VodSourceName": "string", "SourceLocationName": "string", "ChannelName": "string", "AdBreaks": [ { "OffsetMillis": integer, "SpliceInsertMessage": { "SpliceEventId": integer, "AvailsExpected": integer, "AvailNum": integer, "UniqueProgramId": integer }, "Slate": { "VodSourceName": "string", "SourceLocationName": "string" }, "MessageType": enum } ], "CreationTime": integer, "Arn": "string", "ProgramName": "string" }
{ }

Properties

AdBreak

Ad break configuration parameters.

Property Type Required Description
OffsetMillis

integer

Format: int64

False

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.

SpliceInsertMessage

SpliceInsertMessage

False

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.

Slate

SlateSource

False

Ad break slate configuration.

MessageType

string

Values: SPLICE_INSERT

False

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

CreateProgramRequest

Program configuration parameters.

Property Type Required Description
VodSourceName

string

True

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

SourceLocationName

string

True

The name of the source location.

ScheduleConfiguration

ScheduleConfiguration

True

The schedule configuration settings.

AdBreaks

Array of type AdBreak

False

The ad break configuration settings.

DeleteProgramResponse

This response includes only the "type" : "object" property.

DescribeProgramResponse

This program's configuration parameters.

Property Type Required Description
VodSourceName

string

True

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

SourceLocationName

string

True

The source location name.

ChannelName

string

True

The name of the channel that the program belongs to.

AdBreaks

Array of type AdBreak

False

The ad break configuration settings.

CreationTime

integer

Format: date-time

False

The timestamp of when the program was created.

Arn

string

True

The ARN of the program.

ProgramName

string

True

The name of the program.

ScheduleConfiguration

Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.

Property Type Required Description
Transition

Transition

True

Program transition configurations.

SlateSource

Slate VOD source configuration.

Property Type Required Description
VodSourceName

string

False

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

SourceLocationName

string

False

The name of the source location where the slate VOD source is stored.

SpliceInsertMessage

Splice insert message configuration.

Property Type Required Description
SpliceEventId

integer

False

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.

AvailsExpected

integer

False

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.

AvailNum

integer

False

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.

UniqueProgramId

integer

False

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.

Transition

Program transition configuration.

Property Type Required Description
RelativeProgram

string

False

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

Type

string

True

When the program should be played. RELATIVE means that programs will be played back-to-back.

RelativePosition

string

Values: BEFORE_PROGRAM, AFTER_PROGRAM

True

The position where this program will be inserted relative to the RelativeProgram. Possible values are: AFTER_PROGRAM, and BEFORE_PROGRAM.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeProgram

CreateProgram

DeleteProgram