_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) ) |
schedule_action_settings
Settings for this schedule action. | STRUCT( "hls_id3_segment_tagging_settings" STRUCT( "tag" VARCHAR, "id3" VARCHAR ), "hls_timed_metadata_settings" STRUCT( "id3" VARCHAR ), "input_prepare_settings" STRUCT( "input_attachment_name_reference" VARCHAR, "input_clipping_settings" STRUCT( "input_timecode_source" VARCHAR, "start_timecode" STRUCT( "timecode" VARCHAR ), "stop_timecode" STRUCT( "last_frame_clipping_behavior" VARCHAR, "timecode" VARCHAR ) ), "url_path" VARCHAR[] ), "input_switch_settings" STRUCT( "input_attachment_name_reference" VARCHAR, "input_clipping_settings" STRUCT( "input_timecode_source" VARCHAR, "start_timecode" STRUCT( "timecode" VARCHAR ), "stop_timecode" STRUCT( "last_frame_clipping_behavior" VARCHAR, "timecode" VARCHAR ) ), "url_path" VARCHAR[] ), "motion_graphics_image_activate_settings" STRUCT( "duration" BIGINT, "password_param" VARCHAR, "url" VARCHAR, "username" VARCHAR ), "motion_graphics_image_deactivate_settings" BOOLEAN, "pause_state_settings" STRUCT( "pipelines" STRUCT( "pipeline_id" VARCHAR )[] ), "scte35_input_settings" STRUCT( "input_attachment_name_reference" VARCHAR, "mode" VARCHAR ), "scte35_return_to_network_settings" STRUCT( "splice_event_id" BIGINT ), "scte35_splice_insert_settings" STRUCT( "duration" BIGINT, "splice_event_id" BIGINT ), "scte35_time_signal_settings" STRUCT( "scte35_descriptors" STRUCT( "scte35_descriptor_settings" STRUCT( "segmentation_descriptor_scte35_descriptor_settings" STRUCT( "delivery_restrictions" STRUCT( "archive_allowed_flag" VARCHAR, "device_restrictions" VARCHAR, "no_regional_blackout_flag" VARCHAR, "web_delivery_allowed_flag" VARCHAR ), "segment_num" BIGINT, "segmentation_cancel_indicator" VARCHAR, "segmentation_duration" BIGINT, "segmentation_event_id" BIGINT, "segmentation_type_id" BIGINT, "segmentation_upid" VARCHAR, "segmentation_upid_type" BIGINT, "segments_expected" BIGINT, "sub_segment_num" BIGINT, "sub_segments_expected" BIGINT ) ) )[] ), "static_image_activate_settings" STRUCT( "duration" BIGINT, "fade_in" BIGINT, "fade_out" BIGINT, "height" BIGINT, "image" STRUCT( "password_param" VARCHAR, "uri" VARCHAR, "username" VARCHAR ), "image_x" BIGINT, "image_y" BIGINT, "layer" BIGINT, "opacity" BIGINT, "width" BIGINT ), "static_image_deactivate_settings" STRUCT( "fade_out" BIGINT, "layer" BIGINT ), "static_image_output_activate_settings" STRUCT( "duration" BIGINT, "fade_in" BIGINT, "fade_out" BIGINT, "height" BIGINT, "image" STRUCT( "password_param" VARCHAR, "uri" VARCHAR, "username" VARCHAR ), "image_x" BIGINT, "image_y" BIGINT, "layer" BIGINT, "opacity" BIGINT, "output_names" VARCHAR[], "width" BIGINT ), "static_image_output_deactivate_settings" STRUCT( "fade_out" BIGINT, "layer" BIGINT, "output_names" VARCHAR[] ) ) |
Show child fields- schedule_action_settings.hls_id3_segment_tagging_settings
Action to insert HLS ID3 segment tagging Show child fields- schedule_action_settings.hls_id3_segment_tagging_settings.id3
Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure
- schedule_action_settings.hls_id3_segment_tagging_settings.tag
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
- schedule_action_settings.hls_timed_metadata_settings
Action to insert HLS metadata Show child fields- schedule_action_settings.hls_timed_metadata_settings.id3
Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure
- schedule_action_settings.input_prepare_settings
Action to prepare an input for a future immediate input switch Show child fields- schedule_action_settings.input_prepare_settings.input_attachment_name_reference
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.
- schedule_action_settings.input_prepare_settings.input_clipping_settings
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. Show child fields- schedule_action_settings.input_prepare_settings.input_clipping_settings.input_timecode_source
The source of the timecodes in the source being clipped.
- schedule_action_settings.input_prepare_settings.input_clipping_settings.start_timecode
Settings to identify the start of the clip. Show child fields- schedule_action_settings.input_prepare_settings.input_clipping_settings.start_timecode.timecode
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.
- schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode
Settings to identify the end of the clip. Show child fields- schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior
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.
- schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.timecode
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.
- schedule_action_settings.input_prepare_settings.url_path[]
- schedule_action_settings.input_switch_settings
Action to switch the input Show child fields- schedule_action_settings.input_switch_settings.input_attachment_name_reference
The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.
- schedule_action_settings.input_switch_settings.input_clipping_settings
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. Show child fields- schedule_action_settings.input_switch_settings.input_clipping_settings.input_timecode_source
The source of the timecodes in the source being clipped.
- schedule_action_settings.input_switch_settings.input_clipping_settings.start_timecode
Settings to identify the start of the clip. Show child fields- schedule_action_settings.input_switch_settings.input_clipping_settings.start_timecode.timecode
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.
- schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode
Settings to identify the end of the clip. Show child fields- schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior
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.
- schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.timecode
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.
- schedule_action_settings.input_switch_settings.url_path[]
- schedule_action_settings.motion_graphics_image_activate_settings
Action to activate a motion graphics image overlay Show child fields- schedule_action_settings.motion_graphics_image_activate_settings.duration
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.
- schedule_action_settings.motion_graphics_image_activate_settings.password_param
Key used to extract the password from EC2 Parameter store
- schedule_action_settings.motion_graphics_image_activate_settings.url
URI of the HTML5 content to be rendered into the live stream.
- schedule_action_settings.motion_graphics_image_activate_settings.username
Documentation update needed
- schedule_action_settings.motion_graphics_image_deactivate_settings
Action to deactivate a motion graphics image overlay
- schedule_action_settings.pause_state_settings
Action to pause or unpause one or both channel pipelines Show child fields- schedule_action_settings.pause_state_settings.pipelines[]
Show child fields- schedule_action_settings.pause_state_settings.pipelines[].pipeline_id
Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").
- schedule_action_settings.scte35_input_settings
Action to specify scte35 input Show child fields- schedule_action_settings.scte35_input_settings.input_attachment_name_reference
In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)"
- schedule_action_settings.scte35_input_settings.mode
Whether the SCTE-35 input should be the active input or a fixed input.
- schedule_action_settings.scte35_return_to_network_settings
Action to insert SCTE-35 return_to_network message Show child fields- schedule_action_settings.scte35_return_to_network_settings.splice_event_id
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
- schedule_action_settings.scte35_splice_insert_settings
Action to insert SCTE-35 splice_insert message Show child fields- schedule_action_settings.scte35_splice_insert_settings.duration
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.
- schedule_action_settings.scte35_splice_insert_settings.splice_event_id
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
- schedule_action_settings.scte35_time_signal_settings
Action to insert SCTE-35 time_signal message Show child fields- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[]
Show child fields- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings
SCTE-35 Descriptor Settings. Show child fields- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings
SCTE-35 Segmentation Descriptor. Show child fields- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.delivery_restrictions
Holds the four SCTE-35 delivery restriction parameters. Show child fields- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.delivery_restrictions.archive_allowed_flag
Corresponds to SCTE-35 archive_allowed_flag.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.delivery_restrictions.device_restrictions
Corresponds to SCTE-35 device_restrictions parameter.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.delivery_restrictions.no_regional_blackout_flag
Corresponds to SCTE-35 no_regional_blackout_flag parameter.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.delivery_restrictions.web_delivery_allowed_flag
Corresponds to SCTE-35 web_delivery_allowed_flag parameter.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segment_num
Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_cancel_indicator
Corresponds to SCTE-35 segmentation_event_cancel_indicator.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_duration
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.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_event_id
Corresponds to SCTE-35 segmentation_event_id.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_type_id
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").
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_upid
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.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segmentation_upid_type
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").
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.segments_expected
Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.sub_segment_num
Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
- schedule_action_settings.scte35_time_signal_settings.scte35_descriptors[].scte35_descriptor_settings.segmentation_descriptor_scte35_descriptor_settings.sub_segments_expected
Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
- schedule_action_settings.static_image_activate_settings
Action to activate a static image overlay Show child fields- schedule_action_settings.static_image_activate_settings.duration
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.
- schedule_action_settings.static_image_activate_settings.fade_in
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).
- schedule_action_settings.static_image_activate_settings.fade_out
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).
- schedule_action_settings.static_image_activate_settings.height
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.
- schedule_action_settings.static_image_activate_settings.image
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. Show child fields- schedule_action_settings.static_image_activate_settings.image.password_param
key used to extract the password from EC2 Parameter store
- schedule_action_settings.static_image_activate_settings.image.uri
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".
- schedule_action_settings.static_image_activate_settings.image.username
Documentation update needed
- schedule_action_settings.static_image_activate_settings.image_x
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.
- schedule_action_settings.static_image_activate_settings.image_y
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.
- schedule_action_settings.static_image_activate_settings.layer
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.
- schedule_action_settings.static_image_activate_settings.opacity
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
- schedule_action_settings.static_image_activate_settings.width
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.
- schedule_action_settings.static_image_deactivate_settings
Action to deactivate a static image overlay Show child fields- schedule_action_settings.static_image_deactivate_settings.fade_out
The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
- schedule_action_settings.static_image_deactivate_settings.layer
The image overlay layer to deactivate, 0 to 7. Default is 0.
- schedule_action_settings.static_image_output_activate_settings
Action to activate a static image overlay in one or more specified outputs Show child fields- schedule_action_settings.static_image_output_activate_settings.duration
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.
- schedule_action_settings.static_image_output_activate_settings.fade_in
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).
- schedule_action_settings.static_image_output_activate_settings.fade_out
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).
- schedule_action_settings.static_image_output_activate_settings.height
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.
- schedule_action_settings.static_image_output_activate_settings.image
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. Show child fields- schedule_action_settings.static_image_output_activate_settings.image.password_param
key used to extract the password from EC2 Parameter store
- schedule_action_settings.static_image_output_activate_settings.image.uri
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".
- schedule_action_settings.static_image_output_activate_settings.image.username
Documentation update needed
- schedule_action_settings.static_image_output_activate_settings.image_x
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.
- schedule_action_settings.static_image_output_activate_settings.image_y
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.
- schedule_action_settings.static_image_output_activate_settings.layer
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.
- schedule_action_settings.static_image_output_activate_settings.opacity
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
- schedule_action_settings.static_image_output_activate_settings.output_names[]
- schedule_action_settings.static_image_output_activate_settings.width
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.
- schedule_action_settings.static_image_output_deactivate_settings
Action to deactivate a static image overlay in one or more specified outputs Show child fields- schedule_action_settings.static_image_output_deactivate_settings.fade_out
The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
- schedule_action_settings.static_image_output_deactivate_settings.layer
The image overlay layer to deactivate, 0 to 7. Default is 0.
- schedule_action_settings.static_image_output_deactivate_settings.output_names[]
|