Channels channelId Schedule - AWS Elemental MediaLive API Reference

Channels channelId Schedule

URI

/prod/channels/channelId/schedule

HTTP Methods

GET

Operation ID: DescribeSchedule

Get a channel schedule

Path Parameters
Name Type Required Description
channelId String True
Query Parameters
Name Type Required Description
nextToken String False
maxResults String False
Responses
Status Code Response Model Description
200 ScheduleDescribeResultModel

200 response

400 InvalidRequest

400 response

403 AccessDenied

403 response

404 ResourceNotFound

404 response

429 LimitExceeded

429 response

500 InternalServiceError

500 response

502 BadGatewayException

502 response

504 GatewayTimeoutException

504 response

PUT

Operation ID: BatchUpdateSchedule

Update a channel schedule

Path Parameters
Name Type Required Description
channelId String True
Responses
Status Code Response Model Description
200 BatchUpdateScheduleResult

200 response

400 InvalidRequest

400 response

403 AccessDenied

403 response

404 ResourceNotFound

404 response

422 ChannelConfigurationValidationError

422 response

429 LimitExceeded

429 response

500 InternalServiceError

500 response

502 BadGatewayException

502 response

504 GatewayTimeoutException

504 response

DELETE

Operation ID: DeleteSchedule

Delete all schedule actions on a channel.

Path Parameters
Name Type Required Description
channelId String True
Responses
Status Code Response Model Description
200 ScheduleDeleteResultModel

200 response

400 InvalidRequest

400 response

403 AccessDenied

403 response

404 ResourceNotFound

404 response

429 LimitExceeded

429 response

500 InternalServiceError

500 response

502 BadGatewayException

502 response

504 GatewayTimeoutException

504 response

Schemas

Request Bodies

Example PUT

{ "creates": { "scheduleActions": [ { "actionName": "string", "scheduleActionStartSettings": { "fixedModeScheduleActionStartSettings": { "time": "string" }, "followModeScheduleActionStartSettings": { "referenceActionName": "string", "followPoint": enum }, "immediateModeScheduleActionStartSettings": { "time": "string" } }, "scheduleActionSettings": { "scte35ReturnToNetworkSettings": { "spliceEventId": integer }, "scte35SpliceInsertSettings": { "spliceEventId": integer, "duration": integer }, "scte35TimeSignalSettings": { "scte35Descriptors": [ { "scte35DescriptorSettings": { "segmentationDescriptorScte35DescriptorSettings": { "segmentationEventId": integer, "segmentationCancelIndicator": enum, "deliveryRestrictions": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "archiveAllowedFlag": enum, "deviceRestrictions": enum }, "segmentationDuration": integer, "segmentationUpidType": integer, "segmentationUpid": "string", "segmentationTypeId": integer, "segmentNum": integer, "segmentsExpected": integer, "subSegmentNum": integer, "subSegmentsExpected": integer } } } ] }, "staticImageActivateSettings": { "image": { "passwordParam": "string", "uri": "string", "username": "string" }, "layer": integer, "imageX": integer, "imageY": integer, "opacity": integer, "width": integer, "height": integer, "duration": integer, "fadeIn": integer, "fadeOut": integer }, "staticImageDeactivateSettings": { "layer": integer, "fadeOut": integer }, "inputPrepareSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "inputSwitchSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "hlsTimedMetadataSettings": { "id3": "string" }, "hlsId3SegmentTaggingSettings": { "tag": "string" }, "pauseStateSettings": { "pipelines": [ { "pipelineId": enum } ] } } } ] }, "deletes": { "actionNames": [ "string" ] } }

Response Bodies

Example ScheduleDescribeResultModel

{ "scheduleActions": [ { "actionName": "string", "scheduleActionStartSettings": { "fixedModeScheduleActionStartSettings": { "time": "string" }, "followModeScheduleActionStartSettings": { "referenceActionName": "string", "followPoint": enum }, "immediateModeScheduleActionStartSettings": { "time": "string" } }, "scheduleActionSettings": { "scte35ReturnToNetworkSettings": { "spliceEventId": integer }, "scte35SpliceInsertSettings": { "spliceEventId": integer, "duration": integer }, "scte35TimeSignalSettings": { "scte35Descriptors": [ { "scte35DescriptorSettings": { "segmentationDescriptorScte35DescriptorSettings": { "segmentationEventId": integer, "segmentationCancelIndicator": enum, "deliveryRestrictions": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "archiveAllowedFlag": enum, "deviceRestrictions": enum }, "segmentationDuration": integer, "segmentationUpidType": integer, "segmentationUpid": "string", "segmentationTypeId": integer, "segmentNum": integer, "segmentsExpected": integer, "subSegmentNum": integer, "subSegmentsExpected": integer } } } ] }, "staticImageActivateSettings": { "image": { "passwordParam": "string", "uri": "string", "username": "string" }, "layer": integer, "imageX": integer, "imageY": integer, "opacity": integer, "width": integer, "height": integer, "duration": integer, "fadeIn": integer, "fadeOut": integer }, "staticImageDeactivateSettings": { "layer": integer, "fadeOut": integer }, "inputPrepareSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "inputSwitchSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "hlsTimedMetadataSettings": { "id3": "string" }, "hlsId3SegmentTaggingSettings": { "tag": "string" }, "pauseStateSettings": { "pipelines": [ { "pipelineId": enum } ] } } } ], "nextToken": "string" }

Example BatchUpdateScheduleResult

{ "creates": { "scheduleActions": [ { "actionName": "string", "scheduleActionStartSettings": { "fixedModeScheduleActionStartSettings": { "time": "string" }, "followModeScheduleActionStartSettings": { "referenceActionName": "string", "followPoint": enum }, "immediateModeScheduleActionStartSettings": { "time": "string" } }, "scheduleActionSettings": { "scte35ReturnToNetworkSettings": { "spliceEventId": integer }, "scte35SpliceInsertSettings": { "spliceEventId": integer, "duration": integer }, "scte35TimeSignalSettings": { "scte35Descriptors": [ { "scte35DescriptorSettings": { "segmentationDescriptorScte35DescriptorSettings": { "segmentationEventId": integer, "segmentationCancelIndicator": enum, "deliveryRestrictions": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "archiveAllowedFlag": enum, "deviceRestrictions": enum }, "segmentationDuration": integer, "segmentationUpidType": integer, "segmentationUpid": "string", "segmentationTypeId": integer, "segmentNum": integer, "segmentsExpected": integer, "subSegmentNum": integer, "subSegmentsExpected": integer } } } ] }, "staticImageActivateSettings": { "image": { "passwordParam": "string", "uri": "string", "username": "string" }, "layer": integer, "imageX": integer, "imageY": integer, "opacity": integer, "width": integer, "height": integer, "duration": integer, "fadeIn": integer, "fadeOut": integer }, "staticImageDeactivateSettings": { "layer": integer, "fadeOut": integer }, "inputPrepareSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "inputSwitchSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "hlsTimedMetadataSettings": { "id3": "string" }, "hlsId3SegmentTaggingSettings": { "tag": "string" }, "pauseStateSettings": { "pipelines": [ { "pipelineId": enum } ] } } } ] }, "deletes": { "scheduleActions": [ { "actionName": "string", "scheduleActionStartSettings": { "fixedModeScheduleActionStartSettings": { "time": "string" }, "followModeScheduleActionStartSettings": { "referenceActionName": "string", "followPoint": enum }, "immediateModeScheduleActionStartSettings": { "time": "string" } }, "scheduleActionSettings": { "scte35ReturnToNetworkSettings": { "spliceEventId": integer }, "scte35SpliceInsertSettings": { "spliceEventId": integer, "duration": integer }, "scte35TimeSignalSettings": { "scte35Descriptors": [ { "scte35DescriptorSettings": { "segmentationDescriptorScte35DescriptorSettings": { "segmentationEventId": integer, "segmentationCancelIndicator": enum, "deliveryRestrictions": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "archiveAllowedFlag": enum, "deviceRestrictions": enum }, "segmentationDuration": integer, "segmentationUpidType": integer, "segmentationUpid": "string", "segmentationTypeId": integer, "segmentNum": integer, "segmentsExpected": integer, "subSegmentNum": integer, "subSegmentsExpected": integer } } } ] }, "staticImageActivateSettings": { "image": { "passwordParam": "string", "uri": "string", "username": "string" }, "layer": integer, "imageX": integer, "imageY": integer, "opacity": integer, "width": integer, "height": integer, "duration": integer, "fadeIn": integer, "fadeOut": integer }, "staticImageDeactivateSettings": { "layer": integer, "fadeOut": integer }, "inputPrepareSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "inputSwitchSettings": { "inputAttachmentNameReference": "string", "urlPath": [ "string" ], "inputClippingSettings": { "inputTimecodeSource": enum, "startTimecode": { "timecode": "string" }, "stopTimecode": { "timecode": "string", "lastFrameClippingBehavior": enum } } }, "hlsTimedMetadataSettings": { "id3": "string" }, "hlsId3SegmentTaggingSettings": { "tag": "string" }, "pauseStateSettings": { "pipelines": [ { "pipelineId": enum } ] } } } ] } }

Example ScheduleDeleteResultModel

{ }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ChannelConfigurationValidationError

{ "message": "string", "validationErrors": [ { "errorMessage": "string", "elementPath": "string" } ] }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AccessDenied

Property Type Required Description
message

string

False

BadGatewayException

Property Type Required Description
message

string

False

BatchScheduleActionCreateRequest

A list of schedule actions to create (in a request) or that have been created (in a response).

Property Type Required Description
scheduleActions

Array of type ScheduleAction

True

A list of schedule actions to create.

BatchScheduleActionCreateResult

List of actions that have been created in the schedule.

Property Type Required Description
scheduleActions

Array of type ScheduleAction

True

List of actions that have been created in the schedule.

BatchScheduleActionDeleteRequest

A list of schedule actions to delete.

Property Type Required Description
actionNames

Array of type string

True

A list of schedule actions to delete.

BatchScheduleActionDeleteResult

List of actions that have been deleted from the schedule.

Property Type Required Description
scheduleActions

Array of type ScheduleAction

True

List of actions that have been deleted from the schedule.

BatchUpdateScheduleRequest

A request to create actions (add actions to the schedule), delete actions (remove actions from the schedule), or both create and delete actions.

Property Type Required Description
creates

BatchScheduleActionCreateRequest

False

Schedule actions to create in the schedule.

deletes

BatchScheduleActionDeleteRequest

False

Schedule actions to delete from the schedule.

BatchUpdateScheduleResult

Results of a batch schedule update.

Property Type Required Description
creates

BatchScheduleActionCreateResult

False

Schedule actions created in the schedule.

deletes

BatchScheduleActionDeleteResult

False

Schedule actions deleted from the schedule.

ChannelConfigurationValidationError

Property Type Required Description
message

string

False
validationErrors

Array of type ValidationError

False

A collection of validation error responses.

FixedModeScheduleActionStartSettings

Start time for the action.

Property Type Required Description
time

string

True

Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".

FollowModeScheduleActionStartSettings

Settings to specify if an action follows another.

Property Type Required Description
referenceActionName

string

True

The action name of another action that this one refers to.

followPoint

FollowPoint

True

Identifies whether this action starts relative to the start or relative to the end of the reference action.

FollowPoint

Follow reference point.

  • END

  • START

GatewayTimeoutException

Property Type Required Description
message

string

False

HlsId3SegmentTaggingScheduleActionSettings

Settings for the action to insert a user-defined ID3 tag in each HLS segment

Property Type Required Description
tag

string

True

ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html

HlsTimedMetadataScheduleActionSettings

Settings for the action to emit HLS metadata

Property Type Required Description
id3

string

True

Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure

ImmediateModeScheduleActionStartSettings

Settings to configure an action so that it occurs as soon as possible.

Property Type Required Description
time

string

False

The time that the immediate mode action is scheduled to occur. (MediaLive calculates this time to be as soon as possible after receiving the schedule

InputClippingSettings

Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.

Property Type Required Description
inputTimecodeSource

InputTimecodeSource

True

The source of the timecodes in the source being clipped.

startTimecode

StartTimecode

False

Settings to identify the start of the clip.

stopTimecode

StopTimecode

False

Settings to identify the end of the clip.

InputLocation

Input Location

Property Type Required Description
passwordParam

string

False

key used to extract the password from EC2 Parameter store

uri

string

True

Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".

username

string

False

Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>"

InputPrepareScheduleActionSettings

Action to prepare an input for a future immediate input switch.

Property Type Required Description
inputAttachmentNameReference

string

False

The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated.

urlPath

Array of type string

False

The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.

inputClippingSettings

InputClippingSettings

False

Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.

InputSwitchScheduleActionSettings

Settings for the "switch input" action: to switch from ingesting one input to ingesting another input.

Property Type Required Description
inputAttachmentNameReference

string

True

The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.

urlPath

Array of type string

False

The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.

inputClippingSettings

InputClippingSettings

False

Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.

InputTimecodeSource

To clip the file, you must specify the timecode for the start and end of the clip. <br>Specify EMBEDDED to use the timecode embedded in the source content. The embedded timecode must exist in the source content, otherwise MediaLive will output black frames until it reaches the end of the source. <br>Specify ZEROBASED to use a timecode that assumes that the first frame in the file has the timestamp 00:00:00.00. <br> There is no default for this field, you must specify a value.

  • ZEROBASED

  • EMBEDDED

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LastFrameClippingBehavior

If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.

  • EXCLUDE_LAST_FRAME

  • INCLUDE_LAST_FRAME

LimitExceeded

Property Type Required Description
message

string

False

PauseStateScheduleActionSettings

Settings for the action to set pause state of a channel.

Property Type Required Description
pipelines

Array of type PipelinePauseStateSettings

False

PipelineId

Pipeline ID

  • PIPELINE_0

  • PIPELINE_1

PipelinePauseStateSettings

Settings for pausing a pipeline.

Property Type Required Description
pipelineId

PipelineId

True

Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").

ResourceNotFound

Property Type Required Description
message

string

False

ScheduleAction

Contains information on a single schedule action.

Property Type Required Description
actionName

string

True

The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.

scheduleActionStartSettings

ScheduleActionStartSettings

True

The time for the action to start in the channel.

scheduleActionSettings

ScheduleActionSettings

True

Settings for this schedule action.

ScheduleActionSettings

Holds the settings for a single schedule action.

Property Type Required Description
scte35ReturnToNetworkSettings

Scte35ReturnToNetworkScheduleActionSettings

False

Action to insert SCTE-35 return_to_network message

scte35SpliceInsertSettings

Scte35SpliceInsertScheduleActionSettings

False

Action to insert SCTE-35 splice_insert message

scte35TimeSignalSettings

Scte35TimeSignalScheduleActionSettings

False

Action to insert SCTE-35 time_signal message

staticImageActivateSettings

StaticImageActivateScheduleActionSettings

False

Action to activate a static image overlay

staticImageDeactivateSettings

StaticImageDeactivateScheduleActionSettings

False

Action to deactivate a static image overlay

inputPrepareSettings

InputPrepareScheduleActionSettings

False

Action to prepare an input for a future immediate input switch

inputSwitchSettings

InputSwitchScheduleActionSettings

False

Action to switch the input

hlsTimedMetadataSettings

HlsTimedMetadataScheduleActionSettings

False

Action to insert HLS metadata

hlsId3SegmentTaggingSettings

HlsId3SegmentTaggingScheduleActionSettings

False

Action to insert HLS ID3 segment tagging

pauseStateSettings

PauseStateScheduleActionSettings

False

Action to pause or unpause one or both channel pipelines

ScheduleActionStartSettings

Settings to specify when an action should occur. Only one of the options must be selected.

Property Type Required Description
fixedModeScheduleActionStartSettings

FixedModeScheduleActionStartSettings

False

Option for specifying the start time for an action.

followModeScheduleActionStartSettings

FollowModeScheduleActionStartSettings

False

Option for specifying an action as relative to another action.

immediateModeScheduleActionStartSettings

ImmediateModeScheduleActionStartSettings

False

Option for specifying an action that should be applied immediately.

ScheduleDeleteResultModel

Result of a schedule deletion.

ScheduleDescribeResultModel

Results of a schedule describe.

Property Type Required Description
scheduleActions

Array of type ScheduleAction

True

The list of actions in the schedule.

nextToken

string

False

The next token; for use in pagination.

Scte35ArchiveAllowedFlag

Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.

  • ARCHIVE_NOT_ALLOWED

  • ARCHIVE_ALLOWED

Scte35DeliveryRestrictions

Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four "restriction" flags. To declare that there are no restrictions, omit this element.

Property Type Required Description
webDeliveryAllowedFlag

Scte35WebDeliveryAllowedFlag

True

Corresponds to SCTE-35 web_delivery_allowed_flag parameter.

noRegionalBlackoutFlag

Scte35NoRegionalBlackoutFlag

True

Corresponds to SCTE-35 no_regional_blackout_flag parameter.

archiveAllowedFlag

Scte35ArchiveAllowedFlag

True

Corresponds to SCTE-35 archive_allowed_flag.

deviceRestrictions

Scte35DeviceRestrictions

True

Corresponds to SCTE-35 device_restrictions parameter.

Scte35Descriptor

Holds one set of SCTE-35 Descriptor Settings.

Property Type Required Description
scte35DescriptorSettings

Scte35DescriptorSettings

True

SCTE-35 Descriptor Settings.

Scte35DescriptorSettings

SCTE-35 Descriptor settings.

Property Type Required Description
segmentationDescriptorScte35DescriptorSettings

Scte35SegmentationDescriptor

True

SCTE-35 Segmentation Descriptor.

Scte35DeviceRestrictions

Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the "restriction" flags then you must include all four of them.

  • NONE

  • RESTRICT_GROUP0

  • RESTRICT_GROUP1

  • RESTRICT_GROUP2

Scte35NoRegionalBlackoutFlag

Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.

  • REGIONAL_BLACKOUT

  • NO_REGIONAL_BLACKOUT

Scte35ReturnToNetworkScheduleActionSettings

Settings for a SCTE-35 return_to_network message.

Property Type Required Description
spliceEventId

integer

Format: int64

Minimum: 0

Maximum: 4294967295

True

The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.

Scte35SegmentationCancelIndicator

Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.

  • SEGMENTATION_EVENT_NOT_CANCELED

  • SEGMENTATION_EVENT_CANCELED

Scte35SegmentationDescriptor

Corresponds to SCTE-35 segmentation_descriptor.

Property Type Required Description
segmentationEventId

integer

Format: int64

Minimum: 0

Maximum: 4294967295

True

Corresponds to SCTE-35 segmentation_event_id.

segmentationCancelIndicator

Scte35SegmentationCancelIndicator

True

Corresponds to SCTE-35 segmentation_event_cancel_indicator.

deliveryRestrictions

Scte35DeliveryRestrictions

False

Holds the four SCTE-35 delivery restriction parameters.

segmentationDuration

integer

Format: int64

Minimum: 0

Maximum: 1099511627775

False

Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.

segmentationUpidType

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").

segmentationUpid

string

False

Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.

segmentationTypeId

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").

segmentNum

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.

segmentsExpected

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.

subSegmentNum

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.

subSegmentsExpected

integer

Minimum: 0

Maximum: 255

False

Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.

Scte35SpliceInsertScheduleActionSettings

Settings for a SCTE-35 splice_insert message.

Property Type Required Description
spliceEventId

integer

Format: int64

Minimum: 0

Maximum: 4294967295

True

The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.

duration

integer

Format: int64

Minimum: 0

Maximum: 8589934591

False

Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.

Scte35TimeSignalScheduleActionSettings

Settings for a SCTE-35 time_signal.

Property Type Required Description
scte35Descriptors

Array of type Scte35Descriptor

True

The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.

Scte35WebDeliveryAllowedFlag

Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.

  • WEB_DELIVERY_NOT_ALLOWED

  • WEB_DELIVERY_ALLOWED

StartTimecode

Settings to identify the start of the clip.

Property Type Required Description
timecode

string

False

The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.

StaticImageActivateScheduleActionSettings

Settings for the action to activate a static image.

Property Type Required Description
image

InputLocation

True

The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.

layer

integer

Minimum: 0

Maximum: 7

False

The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.

imageX

integer

Minimum: 0

False

Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.

imageY

integer

Minimum: 0

False

Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.

opacity

integer

Minimum: 0

Maximum: 100

False

Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.

width

integer

Minimum: 1

False

The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.

height

integer

Minimum: 1

False

The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.

duration

integer

Minimum: 0

False

The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.

fadeIn

integer

Minimum: 0

False

The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).

fadeOut

integer

Minimum: 0

False

Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).

StaticImageDeactivateScheduleActionSettings

Settings for the action to deactivate the image in a specific layer.

Property Type Required Description
layer

integer

Minimum: 0

Maximum: 7

False

The image overlay layer to deactivate, 0 to 7. Default is 0.

fadeOut

integer

Minimum: 0

False

The time in milliseconds for the image to fade out. Default is 0 (no fade-out).

StopTimecode

Settings to identify the end of the clip.

Property Type Required Description
timecode

string

False

The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.

lastFrameClippingBehavior

LastFrameClippingBehavior

False

If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.

ValidationError

Property Type Required Description
errorMessage

string

False

The error message.

elementPath

string

False

Path to the source of the error.

See Also

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

DescribeSchedule

BatchUpdateSchedule

DeleteSchedule