You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaLive::Types::ScheduleAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass ScheduleAction data as a hash:

{
  action_name: "__string", # required
  schedule_action_settings: { # required
    hls_timed_metadata_settings: {
      id_3: "__string", # required
    },
    input_switch_settings: {
      input_attachment_name_reference: "__string", # required
      input_clipping_settings: {
        input_timecode_source: "ZEROBASED", # required, accepts ZEROBASED, EMBEDDED
        start_timecode: {
          timecode: "__string",
        },
        stop_timecode: {
          last_frame_clipping_behavior: "EXCLUDE_LAST_FRAME", # accepts EXCLUDE_LAST_FRAME, INCLUDE_LAST_FRAME
          timecode: "__string",
        },
      },
      url_path: ["__string"],
    },
    pause_state_settings: {
      pipelines: [
        {
          pipeline_id: "PIPELINE_0", # required, accepts PIPELINE_0, PIPELINE_1
        },
      ],
    },
    scte_35_return_to_network_settings: {
      splice_event_id: 1, # required
    },
    scte_35_splice_insert_settings: {
      duration: 1,
      splice_event_id: 1, # required
    },
    scte_35_time_signal_settings: {
      scte_35_descriptors: [ # required
        {
          scte_35_descriptor_settings: { # required
            segmentation_descriptor_scte_35_descriptor_settings: { # required
              delivery_restrictions: {
                archive_allowed_flag: "ARCHIVE_NOT_ALLOWED", # required, accepts ARCHIVE_NOT_ALLOWED, ARCHIVE_ALLOWED
                device_restrictions: "NONE", # required, accepts NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2
                no_regional_blackout_flag: "REGIONAL_BLACKOUT", # required, accepts REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUT
                web_delivery_allowed_flag: "WEB_DELIVERY_NOT_ALLOWED", # required, accepts WEB_DELIVERY_NOT_ALLOWED, WEB_DELIVERY_ALLOWED
              },
              segment_num: 1,
              segmentation_cancel_indicator: "SEGMENTATION_EVENT_NOT_CANCELED", # required, accepts SEGMENTATION_EVENT_NOT_CANCELED, SEGMENTATION_EVENT_CANCELED
              segmentation_duration: 1,
              segmentation_event_id: 1, # required
              segmentation_type_id: 1,
              segmentation_upid: "__string",
              segmentation_upid_type: 1,
              segments_expected: 1,
              sub_segment_num: 1,
              sub_segments_expected: 1,
            },
          },
        },
      ],
    },
    static_image_activate_settings: {
      duration: 1,
      fade_in: 1,
      fade_out: 1,
      height: 1,
      image: { # required
        password_param: "__string",
        uri: "__string", # required
        username: "__string",
      },
      image_x: 1,
      image_y: 1,
      layer: 1,
      opacity: 1,
      width: 1,
    },
    static_image_deactivate_settings: {
      fade_out: 1,
      layer: 1,
    },
  },
  schedule_action_start_settings: { # required
    fixed_mode_schedule_action_start_settings: {
      time: "__string", # required
    },
    follow_mode_schedule_action_start_settings: {
      follow_point: "END", # required, accepts END, START
      reference_action_name: "__string", # required
    },
    immediate_mode_schedule_action_start_settings: {
    },
  },
}

Contains information on a single schedule action.

Instance Attribute Summary collapse

Instance Attribute Details

#action_nameString

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.

Returns:

  • (String)


11021
11022
11023
11024
11025
11026
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11021

class ScheduleAction < Struct.new(
  :action_name,
  :schedule_action_settings,
  :schedule_action_start_settings)
  include Aws::Structure
end

#schedule_action_settingsTypes::ScheduleActionSettings

Settings for this schedule action.



11021
11022
11023
11024
11025
11026
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11021

class ScheduleAction < Struct.new(
  :action_name,
  :schedule_action_settings,
  :schedule_action_start_settings)
  include Aws::Structure
end

#schedule_action_start_settingsTypes::ScheduleActionStartSettings

The time for the action to start in the channel.



11021
11022
11023
11024
11025
11026
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 11021

class ScheduleAction < Struct.new(
  :action_name,
  :schedule_action_settings,
  :schedule_action_start_settings)
  include Aws::Structure
end