Channels: schedule

200 response

400 response

403 response

404 response

429 response

500 response

502 response

504 response

200 response

400 response

403 response

404 response

429 response

500 response

502 response

504 response

200 response

400 response

403 response

404 response

422 response

429 response

500 response

502 response

504 response

string

string

Array of type ScheduleAction

A list of schedule actions to create.

Array of type ScheduleAction

List of actions that have been created in the schedule.

Array of type string

A list of schedule actions to delete.

Array of type ScheduleAction

List of actions that have been deleted from the schedule.

BatchScheduleActionCreateRequest

Schedule actions to create in the schedule.

BatchScheduleActionDeleteRequest

Schedule actions to delete from the schedule.

BatchScheduleActionCreateResult

Schedule actions created in the schedule.

BatchScheduleActionDeleteResult

Schedule actions deleted from the schedule.

string

Array of type ValidationError

A collection of validation error responses.

string

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".

FollowPoint

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

string

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

string

string

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

string

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

string

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)

InputTimecodeSource

The source of the timecodes in the source being clipped.

StartTimecode

Settings to identify the start of the clip.

StopTimecode

Settings to identify the end of the clip.

string

key used to extract the password from EC2 Parameter store

string

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".

string

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>"

string

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.

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.

Array of type string

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.

string

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

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.

Array of type string

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.

string

string

string

integer

Format: int64

Minimum: 0

Maximum: 86400000

Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed.

string

Key used to extract the password from EC2 Parameter store

string

URI of the HTML5 content to be rendered into the live stream.

string

Username if credentials are required to access a file. This must be a reference to an AWS parameter store name from which the password can be retrieved. AWS Parameter store format: \"ssm://<parameter name>\"

Array of type PipelinePauseStateSettings

PipelineId

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

string

string

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.

ScheduleActionSettings

Settings for this schedule action.

ScheduleActionStartSettings

The time for the action to start in the channel.

HlsId3SegmentTaggingScheduleActionSettings

Action to insert HLS ID3 segment tagging

HlsTimedMetadataScheduleActionSettings

Action to insert HLS metadata

InputPrepareScheduleActionSettings

Action to prepare an input for a future immediate input switch

InputSwitchScheduleActionSettings

Action to switch the input

MotionGraphicsActivateScheduleActionSettings

Action to activate a motion graphics image overlay

MotionGraphicsDeactivateScheduleActionSettings

Action to deactivate a motion graphics image overlay

PauseStateScheduleActionSettings

Action to pause or unpause one or both channel pipelines

Scte35ReturnToNetworkScheduleActionSettings

Action to insert SCTE-35 return_to_network message

Scte35SpliceInsertScheduleActionSettings

Action to insert SCTE-35 splice_insert message

Scte35TimeSignalScheduleActionSettings

Action to insert SCTE-35 time_signal message

StaticImageActivateScheduleActionSettings

Action to activate a static image overlay

StaticImageDeactivateScheduleActionSettings

Action to deactivate a static image overlay

FixedModeScheduleActionStartSettings

Option for specifying the start time for an action.

FollowModeScheduleActionStartSettings

Option for specifying an action as relative to another action.

ImmediateModeScheduleActionStartSettings

Option for specifying an action that should be applied immediately.

string

The next token; for use in pagination.

Array of type ScheduleAction

The list of actions in the schedule.

Scte35ArchiveAllowedFlag

Corresponds to SCTE-35 archive_allowed_flag.

Scte35DeviceRestrictions

Corresponds to SCTE-35 device_restrictions parameter.

Scte35NoRegionalBlackoutFlag

Corresponds to SCTE-35 no_regional_blackout_flag parameter.

Scte35WebDeliveryAllowedFlag

Corresponds to SCTE-35 web_delivery_allowed_flag parameter.

Scte35DescriptorSettings

SCTE-35 Descriptor Settings.

Scte35SegmentationDescriptor

SCTE-35 Segmentation Descriptor.

integer

Format: int64

Minimum: 0

Maximum: 4294967295

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

Scte35DeliveryRestrictions

Holds the four SCTE-35 delivery restriction parameters.

Scte35SegmentationCancelIndicator

Corresponds to SCTE-35 segmentation_event_cancel_indicator.

integer

Format: int64

Minimum: 0

Maximum: 1099511627775

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.

integer

Format: int64

Minimum: 0

Maximum: 4294967295

Corresponds to SCTE-35 segmentation_event_id.

integer

Minimum: 0

Maximum: 255

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").

string

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.

integer

Minimum: 0

Maximum: 255

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").

integer

Minimum: 0

Maximum: 255

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

integer

Minimum: 0

Maximum: 255

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

integer

Minimum: 0

Maximum: 255

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

integer

Minimum: 0

Maximum: 255

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

integer

Format: int64

Minimum: 0

Maximum: 8589934591

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.

integer

Format: int64

Minimum: 0

Maximum: 4294967295

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

Array of type Scte35Descriptor

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

string

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.

integer

Minimum: 0

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.

integer

Minimum: 0

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).

integer

Minimum: 0

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).

integer

Minimum: 1

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.

InputLocation

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.

integer

Minimum: 0

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.

integer

Minimum: 0

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.

integer

Minimum: 0

Maximum: 7

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.

integer

Minimum: 0

Maximum: 100

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

integer

Minimum: 1

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.

integer

Minimum: 0

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

integer

Minimum: 0

Maximum: 7

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

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.

string

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.

string

Path to the source of the error.

string

The error message.