Class: Aws::MediaLive::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb

Overview

An API client for MediaLive. To construct a client, you need to configure a :region and :credentials.

client = Aws::MediaLive::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MediaLive::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MediaLive::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#accept_input_device_transfer(params = {}) ⇒ Struct

Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.

Examples:

Request syntax with placeholder values


resp = client.accept_input_device_transfer({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



494
495
496
497
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 494

def accept_input_device_transfer(params = {}, options = {})
  req = build_request(:accept_input_device_transfer, params)
  req.send_request(options)
end

#batch_delete(params = {}) ⇒ Types::BatchDeleteResponse

Starts delete of resources.

Examples:

Request syntax with placeholder values


resp = client.batch_delete({
  channel_ids: ["__string"],
  input_ids: ["__string"],
  input_security_group_ids: ["__string"],
  multiplex_ids: ["__string"],
})

Response structure


resp.failed #=> Array
resp.failed[0].arn #=> String
resp.failed[0].code #=> String
resp.failed[0].id #=> String
resp.failed[0].message #=> String
resp.successful #=> Array
resp.successful[0].arn #=> String
resp.successful[0].id #=> String
resp.successful[0].state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_ids (Array<String>)
  • :input_ids (Array<String>)
  • :input_security_group_ids (Array<String>)
  • :multiplex_ids (Array<String>)

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 539

def batch_delete(params = {}, options = {})
  req = build_request(:batch_delete, params)
  req.send_request(options)
end

#batch_start(params = {}) ⇒ Types::BatchStartResponse

Starts existing resources

Examples:

Request syntax with placeholder values


resp = client.batch_start({
  channel_ids: ["__string"],
  multiplex_ids: ["__string"],
})

Response structure


resp.failed #=> Array
resp.failed[0].arn #=> String
resp.failed[0].code #=> String
resp.failed[0].id #=> String
resp.failed[0].message #=> String
resp.successful #=> Array
resp.successful[0].arn #=> String
resp.successful[0].id #=> String
resp.successful[0].state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_ids (Array<String>)
  • :multiplex_ids (Array<String>)

Returns:

See Also:



578
579
580
581
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 578

def batch_start(params = {}, options = {})
  req = build_request(:batch_start, params)
  req.send_request(options)
end

#batch_stop(params = {}) ⇒ Types::BatchStopResponse

Stops running resources

Examples:

Request syntax with placeholder values


resp = client.batch_stop({
  channel_ids: ["__string"],
  multiplex_ids: ["__string"],
})

Response structure


resp.failed #=> Array
resp.failed[0].arn #=> String
resp.failed[0].code #=> String
resp.failed[0].id #=> String
resp.failed[0].message #=> String
resp.successful #=> Array
resp.successful[0].arn #=> String
resp.successful[0].id #=> String
resp.successful[0].state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_ids (Array<String>)
  • :multiplex_ids (Array<String>)

Returns:

See Also:



617
618
619
620
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 617

def batch_stop(params = {}, options = {})
  req = build_request(:batch_stop, params)
  req.send_request(options)
end

#batch_update_schedule(params = {}) ⇒ Types::BatchUpdateScheduleResponse

Update a channel schedule

Examples:

Request syntax with placeholder values


resp = client.batch_update_schedule({
  channel_id: "__string", # required
  creates: {
    schedule_actions: [ # required
      {
        action_name: "__string", # required
        schedule_action_settings: { # required
          hls_id_3_segment_tagging_settings: {
            tag: "__string",
            id_3: "__string",
          },
          hls_timed_metadata_settings: {
            id_3: "__string", # required
          },
          input_prepare_settings: {
            input_attachment_name_reference: "__string",
            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"],
          },
          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"],
          },
          motion_graphics_image_activate_settings: {
            duration: 1,
            password_param: "__string",
            url: "__string",
            username: "__string",
          },
          motion_graphics_image_deactivate_settings: {
          },
          pause_state_settings: {
            pipelines: [
              {
                pipeline_id: "PIPELINE_0", # required, accepts PIPELINE_0, PIPELINE_1
              },
            ],
          },
          scte_35_input_settings: {
            input_attachment_name_reference: "__string",
            mode: "FIXED", # required, accepts FIXED, FOLLOW_ACTIVE
          },
          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: "__stringMax2048", # required
              username: "__string",
            },
            image_x: 1,
            image_y: 1,
            layer: 1,
            opacity: 1,
            width: 1,
          },
          static_image_deactivate_settings: {
            fade_out: 1,
            layer: 1,
          },
          static_image_output_activate_settings: {
            duration: 1,
            fade_in: 1,
            fade_out: 1,
            height: 1,
            image: { # required
              password_param: "__string",
              uri: "__stringMax2048", # required
              username: "__string",
            },
            image_x: 1,
            image_y: 1,
            layer: 1,
            opacity: 1,
            output_names: ["__string"], # required
            width: 1,
          },
          static_image_output_deactivate_settings: {
            fade_out: 1,
            layer: 1,
            output_names: ["__string"], # required
          },
          id_3_segment_tagging_settings: {
            id_3: "__string",
            tag: "__string",
          },
          timed_metadata_settings: {
            id_3: "__string", # required
          },
        },
        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: {
          },
        },
      },
    ],
  },
  deletes: {
    action_names: ["__string"], # required
  },
})

Response structure


resp.creates.schedule_actions #=> Array
resp.creates.schedule_actions[0].action_name #=> String
resp.creates.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.tag #=> String
resp.creates.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.id_3 #=> String
resp.creates.schedule_actions[0].schedule_action_settings.hls_timed_metadata_settings.id_3 #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_attachment_name_reference #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path[0] #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.input_attachment_name_reference #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path[0] #=> String
resp.creates.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.duration #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.password_param #=> String
resp.creates.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.url #=> String
resp.creates.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.username #=> String
resp.creates.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines[0].pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_input_settings.input_attachment_name_reference #=> String
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_input_settings.mode #=> String, one of "FIXED", "FOLLOW_ACTIVE"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_return_to_network_settings.splice_event_id #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.duration #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.splice_event_id #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.archive_allowed_flag #=> String, one of "ARCHIVE_NOT_ALLOWED", "ARCHIVE_ALLOWED"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.device_restrictions #=> String, one of "NONE", "RESTRICT_GROUP0", "RESTRICT_GROUP1", "RESTRICT_GROUP2"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.no_regional_blackout_flag #=> String, one of "REGIONAL_BLACKOUT", "NO_REGIONAL_BLACKOUT"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.web_delivery_allowed_flag #=> String, one of "WEB_DELIVERY_NOT_ALLOWED", "WEB_DELIVERY_ALLOWED"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segment_num #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_cancel_indicator #=> String, one of "SEGMENTATION_EVENT_NOT_CANCELED", "SEGMENTATION_EVENT_CANCELED"
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_duration #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_event_id #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_type_id #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid #=> String
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid_type #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segments_expected #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segment_num #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segments_expected #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.duration #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_in #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_out #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.height #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.password_param #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.uri #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.username #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_x #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_y #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.layer #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.opacity #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_activate_settings.width #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.fade_out #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.layer #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.duration #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_in #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_out #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.height #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.password_param #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.uri #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.username #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_x #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_y #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.layer #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.opacity #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names[0] #=> String
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.width #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.fade_out #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.layer #=> Integer
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names #=> Array
resp.creates.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names[0] #=> String
resp.creates.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.id_3 #=> String
resp.creates.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.tag #=> String
resp.creates.schedule_actions[0].schedule_action_settings.timed_metadata_settings.id_3 #=> String
resp.creates.schedule_actions[0].schedule_action_start_settings.fixed_mode_schedule_action_start_settings.time #=> String
resp.creates.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.follow_point #=> String, one of "END", "START"
resp.creates.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.reference_action_name #=> String
resp.deletes.schedule_actions #=> Array
resp.deletes.schedule_actions[0].action_name #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.tag #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.id_3 #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.hls_timed_metadata_settings.id_3 #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_attachment_name_reference #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path[0] #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.input_attachment_name_reference #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path[0] #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.duration #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.password_param #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.url #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.username #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines[0].pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_input_settings.input_attachment_name_reference #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_input_settings.mode #=> String, one of "FIXED", "FOLLOW_ACTIVE"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_return_to_network_settings.splice_event_id #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.duration #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.splice_event_id #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.archive_allowed_flag #=> String, one of "ARCHIVE_NOT_ALLOWED", "ARCHIVE_ALLOWED"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.device_restrictions #=> String, one of "NONE", "RESTRICT_GROUP0", "RESTRICT_GROUP1", "RESTRICT_GROUP2"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.no_regional_blackout_flag #=> String, one of "REGIONAL_BLACKOUT", "NO_REGIONAL_BLACKOUT"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.web_delivery_allowed_flag #=> String, one of "WEB_DELIVERY_NOT_ALLOWED", "WEB_DELIVERY_ALLOWED"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segment_num #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_cancel_indicator #=> String, one of "SEGMENTATION_EVENT_NOT_CANCELED", "SEGMENTATION_EVENT_CANCELED"
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_duration #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_event_id #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_type_id #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid_type #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segments_expected #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segment_num #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segments_expected #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.duration #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_in #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_out #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.height #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.password_param #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.uri #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.username #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_x #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_y #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.layer #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.opacity #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_activate_settings.width #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.fade_out #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.layer #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.duration #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_in #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_out #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.height #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.password_param #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.uri #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.username #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_x #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_y #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.layer #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.opacity #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names[0] #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.width #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.fade_out #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.layer #=> Integer
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names #=> Array
resp.deletes.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names[0] #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.id_3 #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.tag #=> String
resp.deletes.schedule_actions[0].schedule_action_settings.timed_metadata_settings.id_3 #=> String
resp.deletes.schedule_actions[0].schedule_action_start_settings.fixed_mode_schedule_action_start_settings.time #=> String
resp.deletes.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.follow_point #=> String, one of "END", "START"
resp.deletes.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.reference_action_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



975
976
977
978
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 975

def batch_update_schedule(params = {}, options = {})
  req = build_request(:batch_update_schedule, params)
  req.send_request(options)
end

#cancel_input_device_transfer(params = {}) ⇒ Struct

Cancel an input device transfer that you have requested.

Examples:

Request syntax with placeholder values


resp = client.cancel_input_device_transfer({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



996
997
998
999
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 996

def cancel_input_device_transfer(params = {}, options = {})
  req = build_request(:cancel_input_device_transfer, params)
  req.send_request(options)
end

#claim_device(params = {}) ⇒ Struct

Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor. After the request succeeds, you will own the device.

Examples:

Request syntax with placeholder values


resp = client.claim_device({
  id: "__string",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (String) —

    The id of the device you want to claim.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1020
1021
1022
1023
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1020

def claim_device(params = {}, options = {})
  req = build_request(:claim_device, params)
  req.send_request(options)
end

#create_channel(params = {}) ⇒ Types::CreateChannelResponse

Creates a new channel

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1087
1088
1089
1090
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1087

def create_channel(params = {}, options = {})
  req = build_request(:create_channel, params)
  req.send_request(options)
end

#create_channel_placement_group(params = {}) ⇒ Types::CreateChannelPlacementGroupResponse

Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.

Examples:

Request syntax with placeholder values


resp = client.create_channel_placement_group({
  cluster_id: "__string", # required
  name: "__string",
  nodes: ["__string"],
  request_id: "__string",
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.channels #=> Array
resp.channels[0] #=> String
resp.cluster_id #=> String
resp.id #=> String
resp.name #=> String
resp.nodes #=> Array
resp.nodes[0] #=> String
resp.state #=> String, one of "UNASSIGNED", "ASSIGNING", "ASSIGNED", "DELETING", "DELETE_FAILED", "DELETED", "UNASSIGNING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :name (String) —

    Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.

  • :nodes (Array<String>) —

    An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can't associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster.

  • :request_id (String) —

    An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A collection of key-value pairs.

Returns:

See Also:



6423
6424
6425
6426
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6423

def create_channel_placement_group(params = {}, options = {})
  req = build_request(:create_channel_placement_group, params)
  req.send_request(options)
end

#create_cloud_watch_alarm_template(params = {}) ⇒ Types::CreateCloudWatchAlarmTemplateResponse

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_watch_alarm_template({
  comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
  datapoints_to_alarm: 1,
  description: "__stringMin0Max1024",
  evaluation_periods: 1, # required
  group_identifier: "__stringPatternS", # required
  metric_name: "__stringMax64", # required
  name: "__stringMin1Max255PatternS", # required
  period: 1, # required
  statistic: "SampleCount", # required, accepts SampleCount, Average, Sum, Minimum, Maximum
  tags: {
    "__string" => "__string",
  },
  target_resource_type: "CLOUDFRONT_DISTRIBUTION", # required, accepts CLOUDFRONT_DISTRIBUTION, MEDIALIVE_MULTIPLEX, MEDIALIVE_CHANNEL, MEDIALIVE_INPUT_DEVICE, MEDIAPACKAGE_CHANNEL, MEDIAPACKAGE_ORIGIN_ENDPOINT, MEDIACONNECT_FLOW, S3_BUCKET, MEDIATAILOR_PLAYBACK_CONFIGURATION
  threshold: 1.0, # required
  treat_missing_data: "notBreaching", # required, accepts notBreaching, breaching, ignore, missing
  request_id: "__stringMin1Max256PatternS",
})

Response structure


resp.arn #=> String
resp.comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
resp.created_at #=> Time
resp.datapoints_to_alarm #=> Integer
resp.description #=> String
resp.evaluation_periods #=> Integer
resp.group_id #=> String
resp.id #=> String
resp.metric_name #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.period #=> Integer
resp.statistic #=> String, one of "SampleCount", "Average", "Sum", "Minimum", "Maximum"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.target_resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "MEDIALIVE_MULTIPLEX", "MEDIALIVE_CHANNEL", "MEDIALIVE_INPUT_DEVICE", "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", "S3_BUCKET", "MEDIATAILOR_PLAYBACK_CONFIGURATION"
resp.threshold #=> Float
resp.treat_missing_data #=> String, one of "notBreaching", "breaching", "ignore", "missing"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :comparison_operator (required, String) —

    The comparison operator used to compare the specified statistic and the threshold.

  • :datapoints_to_alarm (Integer)
  • :description (String)
  • :evaluation_periods (required, Integer)
  • :group_identifier (required, String)
  • :metric_name (required, String)
  • :name (required, String)
  • :period (required, Integer)
  • :statistic (required, String) —

    The statistic to apply to the alarm's metric data.

  • :tags (Hash<String,String>) —

    Represents the tags associated with a resource.

  • :target_resource_type (required, String) —

    The resource type this template should dynamically generate cloudwatch metric alarms for.

  • :threshold (required, Float)
  • :treat_missing_data (required, String) —

    Specifies how missing data points are treated when evaluating the alarm's condition.

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4894
4895
4896
4897
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4894

def create_cloud_watch_alarm_template(params = {}, options = {})
  req = build_request(:create_cloud_watch_alarm_template, params)
  req.send_request(options)
end

#create_cloud_watch_alarm_template_group(params = {}) ⇒ Types::CreateCloudWatchAlarmTemplateGroupResponse

Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_watch_alarm_template_group({
  description: "__stringMin0Max1024",
  name: "__stringMin1Max255PatternS", # required
  tags: {
    "__string" => "__string",
  },
  request_id: "__stringMin1Max256PatternS",
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :name (required, String)
  • :tags (Hash<String,String>) —

    Represents the tags associated with a resource.

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4950
4951
4952
4953
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4950

def create_cloud_watch_alarm_template_group(params = {}, options = {})
  req = build_request(:create_cloud_watch_alarm_template_group, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Create a new Cluster.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  cluster_type: "ON_PREMISES", # accepts ON_PREMISES
  instance_role_arn: "__string",
  name: "__string",
  network_settings: {
    default_route: "__string",
    interface_mappings: [
      {
        logical_interface_name: "__string",
        network_id: "__string",
      },
    ],
  },
  request_id: "__string",
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.channel_ids #=> Array
resp.channel_ids[0] #=> String
resp.cluster_type #=> String, one of "ON_PREMISES"
resp.id #=> String
resp.instance_role_arn #=> String
resp.name #=> String
resp.network_settings.default_route #=> String
resp.network_settings.interface_mappings #=> Array
resp.network_settings.interface_mappings[0].logical_interface_name #=> String
resp.network_settings.interface_mappings[0].network_id #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_type (String) —

    Specify a type. All the Nodes that you later add to this Cluster must be this type of hardware. One Cluster instance can't contain different hardware types. You won't be able to change this parameter after you create the Cluster.

  • :instance_role_arn (String) —

    The ARN of the IAM role for the Node in this Cluster. The role must include all the operations that you expect these Node to perform. If necessary, create a role in IAM, then attach it here.

  • :name (String) —

    Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the types of Nodes in the Cluster. Names are case-sensitive.

  • :network_settings (Types::ClusterNetworkSettingsCreateRequest) —

    Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.

  • :request_id (String) —

    The unique ID of the request.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A collection of key-value pairs.

Returns:

See Also:



6508
6509
6510
6511
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6508

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_event_bridge_rule_template(params = {}) ⇒ Types::CreateEventBridgeRuleTemplateResponse

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

Examples:

Request syntax with placeholder values


resp = client.create_event_bridge_rule_template({
  description: "__stringMin0Max1024",
  event_targets: [
    {
      arn: "__stringMin1Max2048PatternArn", # required
    },
  ],
  event_type: "MEDIALIVE_MULTIPLEX_ALERT", # required, accepts MEDIALIVE_MULTIPLEX_ALERT, MEDIALIVE_MULTIPLEX_STATE_CHANGE, MEDIALIVE_CHANNEL_ALERT, MEDIALIVE_CHANNEL_INPUT_CHANGE, MEDIALIVE_CHANNEL_STATE_CHANGE, MEDIAPACKAGE_INPUT_NOTIFICATION, MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION, MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION, SIGNAL_MAP_ACTIVE_ALARM, MEDIACONNECT_ALERT, MEDIACONNECT_SOURCE_HEALTH, MEDIACONNECT_OUTPUT_HEALTH, MEDIACONNECT_FLOW_STATUS_CHANGE
  group_identifier: "__stringPatternS", # required
  name: "__stringMin1Max255PatternS", # required
  tags: {
    "__string" => "__string",
  },
  request_id: "__stringMin1Max256PatternS",
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.event_targets #=> Array
resp.event_targets[0].arn #=> String
resp.event_type #=> String, one of "MEDIALIVE_MULTIPLEX_ALERT", "MEDIALIVE_MULTIPLEX_STATE_CHANGE", "MEDIALIVE_CHANNEL_ALERT", "MEDIALIVE_CHANNEL_INPUT_CHANGE", "MEDIALIVE_CHANNEL_STATE_CHANGE", "MEDIAPACKAGE_INPUT_NOTIFICATION", "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", "SIGNAL_MAP_ACTIVE_ALARM", "MEDIACONNECT_ALERT", "MEDIACONNECT_SOURCE_HEALTH", "MEDIACONNECT_OUTPUT_HEALTH", "MEDIACONNECT_FLOW_STATUS_CHANGE"
resp.group_id #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :event_targets (Array<Types::EventBridgeRuleTemplateTarget>)
  • :event_type (required, String) —

    The type of event to match with the rule.

  • :group_identifier (required, String)
  • :name (required, String)
  • :tags (Hash<String,String>) —

    Represents the tags associated with a resource.

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



5026
5027
5028
5029
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5026

def create_event_bridge_rule_template(params = {}, options = {})
  req = build_request(:create_event_bridge_rule_template, params)
  req.send_request(options)
end

#create_event_bridge_rule_template_group(params = {}) ⇒ Types::CreateEventBridgeRuleTemplateGroupResponse

Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.

Examples:

Request syntax with placeholder values


resp = client.create_event_bridge_rule_template_group({
  description: "__stringMin0Max1024",
  name: "__stringMin1Max255PatternS", # required
  tags: {
    "__string" => "__string",
  },
  request_id: "__stringMin1Max256PatternS",
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :name (required, String)
  • :tags (Hash<String,String>) —

    Represents the tags associated with a resource.

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



5082
5083
5084
5085
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5082

def create_event_bridge_rule_template_group(params = {}, options = {})
  req = build_request(:create_event_bridge_rule_template_group, params)
  req.send_request(options)
end

#create_input(params = {}) ⇒ Types::CreateInputResponse

Create an input

Examples:

Request syntax with placeholder values


resp = client.create_input({
  destinations: [
    {
      stream_name: "__string",
      network: "__string",
      network_routes: [
        {
          cidr: "__string",
          gateway: "__string",
        },
      ],
      static_ip_address: "__string",
    },
  ],
  input_devices: [
    {
      id: "__string",
    },
  ],
  input_security_groups: ["__string"],
  media_connect_flows: [
    {
      flow_arn: "__string",
    },
  ],
  name: "__string",
  request_id: "__string",
  role_arn: "__string",
  sources: [
    {
      password_param: "__string",
      url: "__string",
      username: "__string",
    },
  ],
  tags: {
    "__string" => "__string",
  },
  type: "UDP_PUSH", # accepts UDP_PUSH, RTP_PUSH, RTMP_PUSH, RTMP_PULL, URL_PULL, MP4_FILE, MEDIACONNECT, INPUT_DEVICE, AWS_CDI, TS_FILE, SRT_CALLER, MULTICAST, SMPTE_2110_RECEIVER_GROUP, SDI, MEDIACONNECT_ROUTER, SRT_LISTENER
  vpc: {
    security_group_ids: ["__string"],
    subnet_ids: ["__string"], # required
  },
  srt_settings: {
    srt_caller_sources: [
      {
        decryption: {
          algorithm: "AES128", # accepts AES128, AES192, AES256
          passphrase_secret_arn: "__string",
        },
        minimum_latency: 1,
        srt_listener_address: "__string",
        srt_listener_port: "__string",
        stream_id: "__string",
      },
    ],
    srt_listener_settings: {
      decryption: { # required
        algorithm: "AES128", # required, accepts AES128, AES192, AES256
        passphrase_secret_arn: "__string", # required
      },
      minimum_latency: 1, # required
      stream_id: "__string",
    },
  },
  input_network_location: "AWS", # accepts AWS, ON_PREMISES
  multicast_settings: {
    sources: [
      {
        source_ip: "__string",
        url: "__string", # required
      },
    ],
  },
  smpte_2110_receiver_group_settings: {
    smpte_2110_receiver_groups: [
      {
        sdp_settings: {
          ancillary_sdps: [
            {
              media_index: 1,
              sdp_url: "__string",
            },
          ],
          audio_sdps: [
            {
              media_index: 1,
              sdp_url: "__string",
            },
          ],
          video_sdp: {
            media_index: 1,
            sdp_url: "__string",
          },
        },
      },
    ],
  },
  sdi_sources: ["__string"],
  router_settings: {
    destinations: [
      {
        availability_zone_name: "__string", # required
      },
    ],
    encryption_type: "AUTOMATIC", # accepts AUTOMATIC, SECRETS_MANAGER
    secret_arn: "__string",
  },
})

Response structure


resp.input.arn #=> String
resp.input.attached_channels #=> Array
resp.input.attached_channels[0] #=> String
resp.input.destinations #=> Array
resp.input.destinations[0].ip #=> String
resp.input.destinations[0].port #=> String
resp.input.destinations[0].url #=> String
resp.input.destinations[0].vpc.availability_zone #=> String
resp.input.destinations[0].vpc.network_interface_id #=> String
resp.input.destinations[0].network #=> String
resp.input.destinations[0].network_routes #=> Array
resp.input.destinations[0].network_routes[0].cidr #=> String
resp.input.destinations[0].network_routes[0].gateway #=> String
resp.input.id #=> String
resp.input.input_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.input.input_devices #=> Array
resp.input.input_devices[0].id #=> String
resp.input.input_partner_ids #=> Array
resp.input.input_partner_ids[0] #=> String
resp.input.input_source_type #=> String, one of "STATIC", "DYNAMIC"
resp.input.media_connect_flows #=> Array
resp.input.media_connect_flows[0].flow_arn #=> String
resp.input.name #=> String
resp.input.role_arn #=> String
resp.input.security_groups #=> Array
resp.input.security_groups[0] #=> String
resp.input.sources #=> Array
resp.input.sources[0].password_param #=> String
resp.input.sources[0].url #=> String
resp.input.sources[0].username #=> String
resp.input.state #=> String, one of "CREATING", "DETACHED", "ATTACHED", "DELETING", "DELETED"
resp.input.tags #=> Hash
resp.input.tags["__string"] #=> String
resp.input.type #=> String, one of "UDP_PUSH", "RTP_PUSH", "RTMP_PUSH", "RTMP_PULL", "URL_PULL", "MP4_FILE", "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", "TS_FILE", "SRT_CALLER", "MULTICAST", "SMPTE_2110_RECEIVER_GROUP", "SDI", "MEDIACONNECT_ROUTER", "SRT_LISTENER"
resp.input.srt_settings.srt_caller_sources #=> Array
resp.input.srt_settings.srt_caller_sources[0].decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_caller_sources[0].decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_caller_sources[0].minimum_latency #=> Integer
resp.input.srt_settings.srt_caller_sources[0].srt_listener_address #=> String
resp.input.srt_settings.srt_caller_sources[0].srt_listener_port #=> String
resp.input.srt_settings.srt_caller_sources[0].stream_id #=> String
resp.input.srt_settings.srt_listener_settings.decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_listener_settings.decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_listener_settings.minimum_latency #=> Integer
resp.input.srt_settings.srt_listener_settings.stream_id #=> String
resp.input.input_network_location #=> String, one of "AWS", "ON_PREMISES"
resp.input.multicast_settings.sources #=> Array
resp.input.multicast_settings.sources[0].source_ip #=> String
resp.input.multicast_settings.sources[0].url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.sdp_url #=> String
resp.input.sdi_sources #=> Array
resp.input.sdi_sources[0] #=> String
resp.input.router_settings.destinations #=> Array
resp.input.router_settings.destinations[0].availability_zone_name #=> String
resp.input.router_settings.destinations[0].router_output_arn #=> String
resp.input.router_settings.encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.input.router_settings.secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destinations (Array<Types::InputDestinationRequest>)
  • :input_devices (Array<Types::InputDeviceSettings>)
  • :input_security_groups (Array<String>)
  • :media_connect_flows (Array<Types::MediaConnectFlowRequest>)
  • :name (String)
  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :role_arn (String)
  • :sources (Array<Types::InputSourceRequest>)
  • :tags (Hash<String,String>)
  • :type (String) —

    The different types of inputs that AWS Elemental MediaLive supports.

  • :vpc (Types::InputVpcRequest) —

    Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property.

  • :srt_settings (Types::SrtSettingsRequest) —

    Configures the settings for SRT inputs. Provide either srtCallerSources (for SRT_CALLER type) OR srtListenerSettings (for SRT_LISTENER type), not both.

  • :input_network_location (String) —

    With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS or inside an on-premises datacenter. By default all inputs will continue to be AWS inputs.

  • :multicast_settings (Types::MulticastSettingsCreateRequest) —

    Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.

  • :smpte_2110_receiver_group_settings (Types::Smpte2110ReceiverGroupSettings) —

    Configures the sources for the SMPTE 2110 Receiver Group input.

  • :sdi_sources (Array<String>) —

    SDI Sources for this Input.

  • :router_settings (Types::RouterSettings) —

    This is the collection of settings that are used during the creation of a MediaConnect router input.

Returns:

See Also:



1336
1337
1338
1339
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1336

def create_input(params = {}, options = {})
  req = build_request(:create_input, params)
  req.send_request(options)
end

#create_input_security_group(params = {}) ⇒ Types::CreateInputSecurityGroupResponse

Creates a Input Security Group

Examples:

Request syntax with placeholder values


resp = client.create_input_security_group({
  tags: {
    "__string" => "__string",
  },
  whitelist_rules: [
    {
      cidr: "__string",
    },
  ],
})

Response structure


resp.security_group.arn #=> String
resp.security_group.id #=> String
resp.security_group.inputs #=> Array
resp.security_group.inputs[0] #=> String
resp.security_group.state #=> String, one of "IDLE", "IN_USE", "UPDATING", "DELETED"
resp.security_group.tags #=> Hash
resp.security_group.tags["__string"] #=> String
resp.security_group.whitelist_rules #=> Array
resp.security_group.whitelist_rules[0].cidr #=> String
resp.security_group.channels #=> Array
resp.security_group.channels[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1382
1383
1384
1385
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1382

def create_input_security_group(params = {}, options = {})
  req = build_request(:create_input_security_group, params)
  req.send_request(options)
end

#create_multiplex(params = {}) ⇒ Types::CreateMultiplexResponse

Create a new multiplex.

Examples:

Request syntax with placeholder values


resp = client.create_multiplex({
  availability_zones: ["__string"], # required
  multiplex_settings: { # required
    maximum_video_buffer_delay_milliseconds: 1,
    transport_stream_bitrate: 1, # required
    transport_stream_id: 1, # required
    transport_stream_reserved_bitrate: 1,
  },
  name: "__string", # required
  request_id: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.multiplex.arn #=> String
resp.multiplex.availability_zones #=> Array
resp.multiplex.availability_zones[0] #=> String
resp.multiplex.destinations #=> Array
resp.multiplex.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.multiplex.id #=> String
resp.multiplex.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.multiplex.name #=> String
resp.multiplex.pipelines_running_count #=> Integer
resp.multiplex.program_count #=> Integer
resp.multiplex.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.multiplex.tags #=> Hash
resp.multiplex.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zones (required, Array<String>)
  • :multiplex_settings (required, Types::MultiplexSettings) —

    Contains configuration for a Multiplex event

  • :name (required, String)
  • :request_id (required, String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>)

Returns:

See Also:



1446
1447
1448
1449
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1446

def create_multiplex(params = {}, options = {})
  req = build_request(:create_multiplex, params)
  req.send_request(options)
end

#create_multiplex_program(params = {}) ⇒ Types::CreateMultiplexProgramResponse

Create a new program in the multiplex.

Examples:

Request syntax with placeholder values


resp = client.create_multiplex_program({
  multiplex_id: "__string", # required
  multiplex_program_settings: { # required
    preferred_channel_pipeline: "CURRENTLY_ACTIVE", # accepts CURRENTLY_ACTIVE, PIPELINE_0, PIPELINE_1
    program_number: 1, # required
    service_descriptor: {
      provider_name: "__stringMax256", # required
      service_name: "__stringMax256", # required
    },
    video_settings: {
      constant_bitrate: 1,
      statmux_settings: {
        maximum_bitrate: 1,
        minimum_bitrate: 1,
        priority: 1,
      },
    },
  },
  program_name: "__string", # required
  request_id: "__string", # required
})

Response structure


resp.multiplex_program.channel_id #=> String
resp.multiplex_program.multiplex_program_settings.preferred_channel_pipeline #=> String, one of "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1"
resp.multiplex_program.multiplex_program_settings.program_number #=> Integer
resp.multiplex_program.multiplex_program_settings.service_descriptor.provider_name #=> String
resp.multiplex_program.multiplex_program_settings.service_descriptor.service_name #=> String
resp.multiplex_program.multiplex_program_settings.video_settings.constant_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.maximum_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.minimum_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.priority #=> Integer
resp.multiplex_program.packet_identifiers_map.audio_pids #=> Array
resp.multiplex_program.packet_identifiers_map.audio_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_sub_pids #=> Array
resp.multiplex_program.packet_identifiers_map.dvb_sub_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.etv_platform_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.etv_signal_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.klv_data_pids #=> Array
resp.multiplex_program.packet_identifiers_map.klv_data_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.pcr_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.pmt_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.private_metadata_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.scte_27_pids #=> Array
resp.multiplex_program.packet_identifiers_map.scte_27_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.scte_35_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.timed_metadata_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.video_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.arib_captions_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pids #=> Array
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.ecm_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.smpte_2038_pid #=> Integer
resp.multiplex_program.pipeline_details #=> Array
resp.multiplex_program.pipeline_details[0].active_channel_pipeline #=> String
resp.multiplex_program.pipeline_details[0].pipeline_id #=> String
resp.multiplex_program.program_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)
  • :multiplex_program_settings (required, Types::MultiplexProgramSettings) —

    Multiplex Program settings configuration.

  • :program_name (required, String)
  • :request_id (required, String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1534
1535
1536
1537
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1534

def create_multiplex_program(params = {}, options = {})
  req = build_request(:create_multiplex_program, params)
  req.send_request(options)
end

#create_network(params = {}) ⇒ Types::CreateNetworkResponse

Create as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.

Examples:

Request syntax with placeholder values


resp = client.create_network({
  ip_pools: [
    {
      cidr: "__string",
    },
  ],
  name: "__string",
  request_id: "__string",
  routes: [
    {
      cidr: "__string",
      gateway: "__string",
    },
  ],
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.associated_cluster_ids #=> Array
resp.associated_cluster_ids[0] #=> String
resp.id #=> String
resp.ip_pools #=> Array
resp.ip_pools[0].cidr #=> String
resp.name #=> String
resp.routes #=> Array
resp.routes[0].cidr #=> String
resp.routes[0].gateway #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "IDLE", "IN_USE", "UPDATING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ip_pools (Array<Types::IpPoolCreateRequest>) —

    An array of IpPoolCreateRequests that identify a collection of IP addresses in your network that you want to reserve for use in MediaLive Anywhere. MediaLiveAnywhere uses these IP addresses for Push inputs (in both Bridge and NATnetworks) and for output destinations (only in Bridge networks). EachIpPoolUpdateRequest specifies one CIDR block.

  • :name (String) —

    Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the type of traffic on the network. Names are case-sensitive.

  • :request_id (String) —

    An ID that you assign to a create request. This ID ensures idempotency when creating resources.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :routes (Array<Types::RouteCreateRequest>) —

    An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.

  • :tags (Hash<String,String>) —

    A collection of key-value pairs.

Returns:

See Also:



6591
6592
6593
6594
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6591

def create_network(params = {}, options = {})
  req = build_request(:create_network, params)
  req.send_request(options)
end

#create_node(params = {}) ⇒ Types::CreateNodeResponse

Create a Node in the specified Cluster. You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster.

Examples:

Request syntax with placeholder values


resp = client.create_node({
  cluster_id: "__string", # required
  name: "__string",
  node_interface_mappings: [
    {
      logical_interface_name: "__string",
      network_interface_mode: "NAT", # accepts NAT, BRIDGE
      physical_interface_name: "__string",
    },
  ],
  request_id: "__string",
  role: "BACKUP", # accepts BACKUP, ACTIVE
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0] #=> String
resp.cluster_id #=> String
resp.connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.id #=> String
resp.instance_arn #=> String
resp.name #=> String
resp.node_interface_mappings #=> Array
resp.node_interface_mappings[0].logical_interface_name #=> String
resp.node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.node_interface_mappings[0].physical_interface_name #=> String
resp.node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.role #=> String, one of "BACKUP", "ACTIVE"
resp.state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.sdi_source_mappings #=> Array
resp.sdi_source_mappings[0].card_number #=> Integer
resp.sdi_source_mappings[0].channel_number #=> Integer
resp.sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :name (String) —

    The user-specified name of the Node to be created.

  • :node_interface_mappings (Array<Types::NodeInterfaceMappingCreateRequest>) —

    An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name. You created the logical names in the logicalInterfaceName parameter when you created the Cluster. Create one mapping for each physical interface on the node, but only for node interfaces that you plan to use for encoding content traffic (and not for any management-only interface). In each mapping pair, we recommend that you specify the logical name first, then assign the physical name that applies.The physicalInterfaceName is the final piece of data that associates a node interface with a network. The association works as follows: Node physicalInterfaceName > Node logicalInterfaceName = Cluster logicalInterfaceName > networkId.

  • :request_id (String) —

    An ID that you assign to a create request. This ID ensures idempotency when creating resources.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :role (String) —

    The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

  • :tags (Hash<String,String>) —

    A collection of key-value pairs.

Returns:

See Also:



6691
6692
6693
6694
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6691

def create_node(params = {}, options = {})
  req = build_request(:create_node, params)
  req.send_request(options)
end

#create_node_registration_script(params = {}) ⇒ Types::CreateNodeRegistrationScriptResponse

Create the Register Node script for all the nodes intended for a specific Cluster. You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere.

Examples:

Request syntax with placeholder values


resp = client.create_node_registration_script({
  cluster_id: "__string", # required
  id: "__string",
  name: "__string",
  node_interface_mappings: [
    {
      logical_interface_name: "__string",
      network_interface_mode: "NAT", # accepts NAT, BRIDGE
      physical_interface_name: "__string",
      physical_interface_ip_addresses: ["__string"],
    },
  ],
  request_id: "__string",
  role: "BACKUP", # accepts BACKUP, ACTIVE
})

Response structure


resp.node_registration_script #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :id (String) —

    If you're generating a re-registration script for an already existing node, this is where you provide the id.

  • :name (String) —

    Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z).

  • :node_interface_mappings (Array<Types::NodeInterfaceMapping>) —

    An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name. This mapping associates a node interface with a network. The association works as follows: Node physicalInterfaceName

    Node logicalInterfaceName = Cluster logicalInterfaceName > networkId.

  • :request_id (String) —

    An ID that you assign to a create request. This ID ensures idempotency when creating resources.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :role (String) —

    The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

Returns:

See Also:



6761
6762
6763
6764
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6761

def create_node_registration_script(params = {}, options = {})
  req = build_request(:create_node_registration_script, params)
  req.send_request(options)
end

#create_partner_input(params = {}) ⇒ Types::CreatePartnerInputResponse

Create a partner input

Examples:

Request syntax with placeholder values


resp = client.create_partner_input({
  input_id: "__string", # required
  request_id: "__string",
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.input.arn #=> String
resp.input.attached_channels #=> Array
resp.input.attached_channels[0] #=> String
resp.input.destinations #=> Array
resp.input.destinations[0].ip #=> String
resp.input.destinations[0].port #=> String
resp.input.destinations[0].url #=> String
resp.input.destinations[0].vpc.availability_zone #=> String
resp.input.destinations[0].vpc.network_interface_id #=> String
resp.input.destinations[0].network #=> String
resp.input.destinations[0].network_routes #=> Array
resp.input.destinations[0].network_routes[0].cidr #=> String
resp.input.destinations[0].network_routes[0].gateway #=> String
resp.input.id #=> String
resp.input.input_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.input.input_devices #=> Array
resp.input.input_devices[0].id #=> String
resp.input.input_partner_ids #=> Array
resp.input.input_partner_ids[0] #=> String
resp.input.input_source_type #=> String, one of "STATIC", "DYNAMIC"
resp.input.media_connect_flows #=> Array
resp.input.media_connect_flows[0].flow_arn #=> String
resp.input.name #=> String
resp.input.role_arn #=> String
resp.input.security_groups #=> Array
resp.input.security_groups[0] #=> String
resp.input.sources #=> Array
resp.input.sources[0].password_param #=> String
resp.input.sources[0].url #=> String
resp.input.sources[0].username #=> String
resp.input.state #=> String, one of "CREATING", "DETACHED", "ATTACHED", "DELETING", "DELETED"
resp.input.tags #=> Hash
resp.input.tags["__string"] #=> String
resp.input.type #=> String, one of "UDP_PUSH", "RTP_PUSH", "RTMP_PUSH", "RTMP_PULL", "URL_PULL", "MP4_FILE", "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", "TS_FILE", "SRT_CALLER", "MULTICAST", "SMPTE_2110_RECEIVER_GROUP", "SDI", "MEDIACONNECT_ROUTER", "SRT_LISTENER"
resp.input.srt_settings.srt_caller_sources #=> Array
resp.input.srt_settings.srt_caller_sources[0].decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_caller_sources[0].decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_caller_sources[0].minimum_latency #=> Integer
resp.input.srt_settings.srt_caller_sources[0].srt_listener_address #=> String
resp.input.srt_settings.srt_caller_sources[0].srt_listener_port #=> String
resp.input.srt_settings.srt_caller_sources[0].stream_id #=> String
resp.input.srt_settings.srt_listener_settings.decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_listener_settings.decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_listener_settings.minimum_latency #=> Integer
resp.input.srt_settings.srt_listener_settings.stream_id #=> String
resp.input.input_network_location #=> String, one of "AWS", "ON_PREMISES"
resp.input.multicast_settings.sources #=> Array
resp.input.multicast_settings.sources[0].source_ip #=> String
resp.input.multicast_settings.sources[0].url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.sdp_url #=> String
resp.input.sdi_sources #=> Array
resp.input.sdi_sources[0] #=> String
resp.input.router_settings.destinations #=> Array
resp.input.router_settings.destinations[0].availability_zone_name #=> String
resp.input.router_settings.destinations[0].router_output_arn #=> String
resp.input.router_settings.encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.input.router_settings.secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_id (required, String)
  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>)

Returns:

See Also:



1635
1636
1637
1638
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1635

def create_partner_input(params = {}, options = {})
  req = build_request(:create_partner_input, params)
  req.send_request(options)
end

#create_sdi_source(params = {}) ⇒ Types::CreateSdiSourceResponse

Create an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.

Examples:

Request syntax with placeholder values


resp = client.create_sdi_source({
  mode: "QUADRANT", # accepts QUADRANT, INTERLEAVE
  name: "__string",
  request_id: "__string",
  tags: {
    "__string" => "__string",
  },
  type: "SINGLE", # accepts SINGLE, QUAD
})

Response structure


resp.sdi_source.arn #=> String
resp.sdi_source.id #=> String
resp.sdi_source.inputs #=> Array
resp.sdi_source.inputs[0] #=> String
resp.sdi_source.mode #=> String, one of "QUADRANT", "INTERLEAVE"
resp.sdi_source.name #=> String
resp.sdi_source.state #=> String, one of "IDLE", "IN_USE", "DELETED"
resp.sdi_source.type #=> String, one of "SINGLE", "QUAD"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mode (String) —

    Applies only if the type is QUAD. Specify the mode for handling the quad-link signal: QUADRANT or INTERLEAVE.

  • :name (String) —

    Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.

  • :request_id (String) —

    An ID that you assign to a create request. This ID ensures idempotency when creating resources.A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A collection of key-value pairs.

  • :type (String) —

    Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.

Returns:

See Also:



7784
7785
7786
7787
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7784

def create_sdi_source(params = {}, options = {})
  req = build_request(:create_sdi_source, params)
  req.send_request(options)
end

#create_signal_map(params = {}) ⇒ Types::CreateSignalMapResponse

Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.

Examples:

Request syntax with placeholder values


resp = client.create_signal_map({
  cloud_watch_alarm_template_group_identifiers: ["__stringPatternS"],
  description: "__stringMin0Max1024",
  discovery_entry_point_arn: "__stringMin1Max2048", # required
  event_bridge_rule_template_group_identifiers: ["__stringPatternS"],
  name: "__stringMin1Max255PatternS", # required
  tags: {
    "__string" => "__string",
  },
  request_id: "__stringMin1Max256PatternS",
})

Response structure


resp.arn #=> String
resp.cloud_watch_alarm_template_group_ids #=> Array
resp.cloud_watch_alarm_template_group_ids[0] #=> String
resp.created_at #=> Time
resp.description #=> String
resp.discovery_entry_point_arn #=> String
resp.error_message #=> String
resp.event_bridge_rule_template_group_ids #=> Array
resp.event_bridge_rule_template_group_ids[0] #=> String
resp.failed_media_resource_map #=> Hash
resp.failed_media_resource_map["__string"].destinations #=> Array
resp.failed_media_resource_map["__string"].destinations[0].arn #=> String
resp.failed_media_resource_map["__string"].destinations[0].name #=> String
resp.failed_media_resource_map["__string"].name #=> String
resp.failed_media_resource_map["__string"].sources #=> Array
resp.failed_media_resource_map["__string"].sources[0].arn #=> String
resp.failed_media_resource_map["__string"].sources[0].name #=> String
resp.id #=> String
resp.last_discovered_at #=> Time
resp.last_successful_monitor_deployment.details_uri #=> String
resp.last_successful_monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.media_resource_map #=> Hash
resp.media_resource_map["__string"].destinations #=> Array
resp.media_resource_map["__string"].destinations[0].arn #=> String
resp.media_resource_map["__string"].destinations[0].name #=> String
resp.media_resource_map["__string"].name #=> String
resp.media_resource_map["__string"].sources #=> Array
resp.media_resource_map["__string"].sources[0].arn #=> String
resp.media_resource_map["__string"].sources[0].name #=> String
resp.modified_at #=> Time
resp.monitor_changes_pending_deployment #=> Boolean
resp.monitor_deployment.details_uri #=> String
resp.monitor_deployment.error_message #=> String
resp.monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.name #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cloud_watch_alarm_template_group_identifiers (Array<String>)
  • :description (String)
  • :discovery_entry_point_arn (required, String)
  • :event_bridge_rule_template_group_identifiers (Array<String>)
  • :name (required, String)
  • :tags (Hash<String,String>) —

    Represents the tags associated with a resource.

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



5187
5188
5189
5190
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5187

def create_signal_map(params = {}, options = {})
  req = build_request(:create_signal_map, params)
  req.send_request(options)
end

#create_tags(params = {}) ⇒ Struct

Create tags for a resource

Examples:

Request syntax with placeholder values


resp = client.create_tags({
  resource_arn: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags (Hash<String,String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1661
1662
1663
1664
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1661

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end

#delete_channel(params = {}) ⇒ Types::DeleteChannelResponse

Starts deletion of channel. The associated outputs are also deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_channel({
  channel_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)

Returns:

See Also:



1706
1707
1708
1709
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1706

def delete_channel(params = {}, options = {})
  req = build_request(:delete_channel, params)
  req.send_request(options)
end

#delete_channel_placement_group(params = {}) ⇒ Types::DeleteChannelPlacementGroupResponse

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_placement_group({
  channel_placement_group_id: "__string", # required
  cluster_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channels #=> Array
resp.channels[0] #=> String
resp.cluster_id #=> String
resp.id #=> String
resp.name #=> String
resp.nodes #=> Array
resp.nodes[0] #=> String
resp.state #=> String, one of "UNASSIGNED", "ASSIGNING", "ASSIGNED", "DELETING", "DELETE_FAILED", "DELETED", "UNASSIGNING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_placement_group_id (required, String)
  • :cluster_id (required, String)

Returns:

See Also:



6806
6807
6808
6809
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6806

def delete_channel_placement_group(params = {}, options = {})
  req = build_request(:delete_channel_placement_group, params)
  req.send_request(options)
end

#delete_cloud_watch_alarm_template(params = {}) ⇒ Struct

Deletes a cloudwatch alarm template.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_watch_alarm_template({
  identifier: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5208
5209
5210
5211
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5208

def delete_cloud_watch_alarm_template(params = {}, options = {})
  req = build_request(:delete_cloud_watch_alarm_template, params)
  req.send_request(options)
end

#delete_cloud_watch_alarm_template_group(params = {}) ⇒ Struct

Deletes a cloudwatch alarm template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_watch_alarm_template_group({
  identifier: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5231
5232
5233
5234
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5231

def delete_cloud_watch_alarm_template_group(params = {}, options = {})
  req = build_request(:delete_cloud_watch_alarm_template_group, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse

Delete a Cluster. The Cluster must be idle.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channel_ids #=> Array
resp.channel_ids[0] #=> String
resp.cluster_type #=> String, one of "ON_PREMISES"
resp.id #=> String
resp.instance_role_arn #=> String
resp.name #=> String
resp.network_settings.default_route #=> String
resp.network_settings.interface_mappings #=> Array
resp.network_settings.interface_mappings[0].logical_interface_name #=> String
resp.network_settings.interface_mappings[0].network_id #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)

Returns:

See Also:



6851
6852
6853
6854
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6851

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_event_bridge_rule_template(params = {}) ⇒ Struct

Deletes an eventbridge rule template.

Examples:

Request syntax with placeholder values


resp = client.delete_event_bridge_rule_template({
  identifier: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5252
5253
5254
5255
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5252

def delete_event_bridge_rule_template(params = {}, options = {})
  req = build_request(:delete_event_bridge_rule_template, params)
  req.send_request(options)
end

#delete_event_bridge_rule_template_group(params = {}) ⇒ Struct

Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_event_bridge_rule_template_group({
  identifier: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5275
5276
5277
5278
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5275

def delete_event_bridge_rule_template_group(params = {}, options = {})
  req = build_request(:delete_event_bridge_rule_template_group, params)
  req.send_request(options)
end

#delete_input(params = {}) ⇒ Struct

Deletes the input end point

Examples:

Request syntax with placeholder values


resp = client.delete_input({
  input_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1727
1728
1729
1730
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1727

def delete_input(params = {}, options = {})
  req = build_request(:delete_input, params)
  req.send_request(options)
end

#delete_input_security_group(params = {}) ⇒ Struct

Deletes an Input Security Group

Examples:

Request syntax with placeholder values


resp = client.delete_input_security_group({
  input_security_group_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_security_group_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1748
1749
1750
1751
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1748

def delete_input_security_group(params = {}, options = {})
  req = build_request(:delete_input_security_group, params)
  req.send_request(options)
end

#delete_multiplex(params = {}) ⇒ Types::DeleteMultiplexResponse

Delete a multiplex. The multiplex must be idle.

Examples:

Request syntax with placeholder values


resp = client.delete_multiplex({
  multiplex_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.availability_zones #=> Array
resp.availability_zones[0] #=> String
resp.destinations #=> Array
resp.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.id #=> String
resp.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.name #=> String
resp.pipelines_running_count #=> Integer
resp.program_count #=> Integer
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)

Returns:

See Also:



1799
1800
1801
1802
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1799

def delete_multiplex(params = {}, options = {})
  req = build_request(:delete_multiplex, params)
  req.send_request(options)
end

#delete_multiplex_program(params = {}) ⇒ Types::DeleteMultiplexProgramResponse

Delete a program from a multiplex.

Examples:

Request syntax with placeholder values


resp = client.delete_multiplex_program({
  multiplex_id: "__string", # required
  program_name: "__string", # required
})

Response structure


resp.channel_id #=> String
resp.multiplex_program_settings.preferred_channel_pipeline #=> String, one of "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1"
resp.multiplex_program_settings.program_number #=> Integer
resp.multiplex_program_settings.service_descriptor.provider_name #=> String
resp.multiplex_program_settings.service_descriptor.service_name #=> String
resp.multiplex_program_settings.video_settings.constant_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.maximum_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.minimum_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.priority #=> Integer
resp.packet_identifiers_map.audio_pids #=> Array
resp.packet_identifiers_map.audio_pids[0] #=> Integer
resp.packet_identifiers_map.dvb_sub_pids #=> Array
resp.packet_identifiers_map.dvb_sub_pids[0] #=> Integer
resp.packet_identifiers_map.dvb_teletext_pid #=> Integer
resp.packet_identifiers_map.etv_platform_pid #=> Integer
resp.packet_identifiers_map.etv_signal_pid #=> Integer
resp.packet_identifiers_map.klv_data_pids #=> Array
resp.packet_identifiers_map.klv_data_pids[0] #=> Integer
resp.packet_identifiers_map.pcr_pid #=> Integer
resp.packet_identifiers_map.pmt_pid #=> Integer
resp.packet_identifiers_map.private_metadata_pid #=> Integer
resp.packet_identifiers_map.scte_27_pids #=> Array
resp.packet_identifiers_map.scte_27_pids[0] #=> Integer
resp.packet_identifiers_map.scte_35_pid #=> Integer
resp.packet_identifiers_map.timed_metadata_pid #=> Integer
resp.packet_identifiers_map.video_pid #=> Integer
resp.packet_identifiers_map.arib_captions_pid #=> Integer
resp.packet_identifiers_map.dvb_teletext_pids #=> Array
resp.packet_identifiers_map.dvb_teletext_pids[0] #=> Integer
resp.packet_identifiers_map.ecm_pid #=> Integer
resp.packet_identifiers_map.smpte_2038_pid #=> Integer
resp.pipeline_details #=> Array
resp.pipeline_details[0].active_channel_pipeline #=> String
resp.pipeline_details[0].pipeline_id #=> String
resp.program_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)
  • :program_name (required, String)

Returns:

See Also:



1867
1868
1869
1870
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1867

def delete_multiplex_program(params = {}, options = {})
  req = build_request(:delete_multiplex_program, params)
  req.send_request(options)
end

#delete_network(params = {}) ⇒ Types::DeleteNetworkResponse

Delete a Network. The Network must have no resources associated with it.

Examples:

Request syntax with placeholder values


resp = client.delete_network({
  network_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.associated_cluster_ids #=> Array
resp.associated_cluster_ids[0] #=> String
resp.id #=> String
resp.ip_pools #=> Array
resp.ip_pools[0].cidr #=> String
resp.name #=> String
resp.routes #=> Array
resp.routes[0].cidr #=> String
resp.routes[0].gateway #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "IDLE", "IN_USE", "UPDATING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_id (required, String)

Returns:

See Also:



6895
6896
6897
6898
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6895

def delete_network(params = {}, options = {})
  req = build_request(:delete_network, params)
  req.send_request(options)
end

#delete_node(params = {}) ⇒ Types::DeleteNodeResponse

Delete a Node. The Node must be IDLE.

Examples:

Request syntax with placeholder values


resp = client.delete_node({
  cluster_id: "__string", # required
  node_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0] #=> String
resp.cluster_id #=> String
resp.connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.id #=> String
resp.instance_arn #=> String
resp.name #=> String
resp.node_interface_mappings #=> Array
resp.node_interface_mappings[0].logical_interface_name #=> String
resp.node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.node_interface_mappings[0].physical_interface_name #=> String
resp.node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.role #=> String, one of "BACKUP", "ACTIVE"
resp.state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.sdi_source_mappings #=> Array
resp.sdi_source_mappings[0].card_number #=> Integer
resp.sdi_source_mappings[0].channel_number #=> Integer
resp.sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :node_id (required, String)

Returns:

See Also:



6954
6955
6956
6957
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6954

def delete_node(params = {}, options = {})
  req = build_request(:delete_node, params)
  req.send_request(options)
end

#delete_reservation(params = {}) ⇒ Types::DeleteReservationResponse

Delete an expired reservation.

Examples:

Request syntax with placeholder values


resp = client.delete_reservation({
  reservation_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.count #=> Integer
resp.currency_code #=> String
resp.duration #=> Integer
resp.duration_units #=> String, one of "MONTHS"
resp.end #=> String
resp.fixed_price #=> Float
resp.name #=> String
resp.offering_description #=> String
resp.offering_id #=> String
resp.offering_type #=> String, one of "NO_UPFRONT"
resp.region #=> String
resp.renewal_settings.automatic_renewal #=> String, one of "DISABLED", "ENABLED", "UNAVAILABLE"
resp.renewal_settings.renewal_count #=> Integer
resp.reservation_id #=> String
resp.resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.start #=> String
resp.state #=> String, one of "ACTIVE", "EXPIRED", "CANCELED", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reservation_id (required, String)

Returns:

See Also:



1939
1940
1941
1942
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1939

def delete_reservation(params = {}, options = {})
  req = build_request(:delete_reservation, params)
  req.send_request(options)
end

#delete_schedule(params = {}) ⇒ Struct

Delete all schedule actions on a channel.

Examples:

Request syntax with placeholder values


resp = client.delete_schedule({
  channel_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1960
1961
1962
1963
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1960

def delete_schedule(params = {}, options = {})
  req = build_request(:delete_schedule, params)
  req.send_request(options)
end

#delete_sdi_source(params = {}) ⇒ Types::DeleteSdiSourceResponse

Delete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.

Examples:

Request syntax with placeholder values


resp = client.delete_sdi_source({
  sdi_source_id: "__string", # required
})

Response structure


resp.sdi_source.arn #=> String
resp.sdi_source.id #=> String
resp.sdi_source.inputs #=> Array
resp.sdi_source.inputs[0] #=> String
resp.sdi_source.mode #=> String, one of "QUADRANT", "INTERLEAVE"
resp.sdi_source.name #=> String
resp.sdi_source.state #=> String, one of "IDLE", "IN_USE", "DELETED"
resp.sdi_source.type #=> String, one of "SINGLE", "QUAD"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sdi_source_id (required, String)

Returns:

See Also:



7819
7820
7821
7822
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7819

def delete_sdi_source(params = {}, options = {})
  req = build_request(:delete_sdi_source, params)
  req.send_request(options)
end

#delete_signal_map(params = {}) ⇒ Struct

Deletes the specified signal map.

Examples:

Request syntax with placeholder values


resp = client.delete_signal_map({
  identifier: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5296
5297
5298
5299
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5296

def delete_signal_map(params = {}, options = {})
  req = build_request(:delete_signal_map, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ Struct

Removes tags for a resource

Examples:

Request syntax with placeholder values


resp = client.delete_tags({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1984
1985
1986
1987
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 1984

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#describe_account_configuration(params = {}) ⇒ Types::DescribeAccountConfigurationResponse

Describe account configuration

Examples:

Response structure


resp..kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2003
2004
2005
2006
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2003

def (params = {}, options = {})
  req = build_request(:describe_account_configuration, params)
  req.send_request(options)
end

#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse

Gets details about a channel

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • channel_created
  • channel_deleted
  • channel_running
  • channel_stopped

Examples:

Request syntax with placeholder values


resp = client.describe_channel({
  channel_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)

Returns:

See Also:



2056
2057
2058
2059
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2056

def describe_channel(params = {}, options = {})
  req = build_request(:describe_channel, params)
  req.send_request(options)
end

#describe_channel_placement_group(params = {}) ⇒ Types::DescribeChannelPlacementGroupResponse

Get details about a ChannelPlacementGroup.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • channel_placement_group_assigned
  • channel_placement_group_deleted
  • channel_placement_group_unassigned

Examples:

Request syntax with placeholder values


resp = client.describe_channel_placement_group({
  channel_placement_group_id: "__string", # required
  cluster_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channels #=> Array
resp.channels[0] #=> String
resp.cluster_id #=> String
resp.id #=> String
resp.name #=> String
resp.nodes #=> Array
resp.nodes[0] #=> String
resp.state #=> String, one of "UNASSIGNED", "ASSIGNING", "ASSIGNED", "DELETING", "DELETE_FAILED", "DELETED", "UNASSIGNING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_placement_group_id (required, String)
  • :cluster_id (required, String)

Returns:

See Also:



7005
7006
7007
7008
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7005

def describe_channel_placement_group(params = {}, options = {})
  req = build_request(:describe_channel_placement_group, params)
  req.send_request(options)
end

#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse

Get details about a Cluster.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • cluster_created
  • cluster_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_cluster({
  cluster_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channel_ids #=> Array
resp.channel_ids[0] #=> String
resp.cluster_type #=> String, one of "ON_PREMISES"
resp.id #=> String
resp.instance_role_arn #=> String
resp.name #=> String
resp.network_settings.default_route #=> String
resp.network_settings.interface_mappings #=> Array
resp.network_settings.interface_mappings[0].logical_interface_name #=> String
resp.network_settings.interface_mappings[0].network_id #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)

Returns:

See Also:



7056
7057
7058
7059
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7056

def describe_cluster(params = {}, options = {})
  req = build_request(:describe_cluster, params)
  req.send_request(options)
end

#describe_input(params = {}) ⇒ Types::DescribeInputResponse

Produces details about an input

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • input_attached
  • input_deleted
  • input_detached

Examples:

Request syntax with placeholder values


resp = client.describe_input({
  input_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.attached_channels #=> Array
resp.attached_channels[0] #=> String
resp.destinations #=> Array
resp.destinations[0].ip #=> String
resp.destinations[0].port #=> String
resp.destinations[0].url #=> String
resp.destinations[0].vpc.availability_zone #=> String
resp.destinations[0].vpc.network_interface_id #=> String
resp.destinations[0].network #=> String
resp.destinations[0].network_routes #=> Array
resp.destinations[0].network_routes[0].cidr #=> String
resp.destinations[0].network_routes[0].gateway #=> String
resp.id #=> String
resp.input_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.input_devices #=> Array
resp.input_devices[0].id #=> String
resp.input_partner_ids #=> Array
resp.input_partner_ids[0] #=> String
resp.input_source_type #=> String, one of "STATIC", "DYNAMIC"
resp.media_connect_flows #=> Array
resp.media_connect_flows[0].flow_arn #=> String
resp.name #=> String
resp.role_arn #=> String
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.sources #=> Array
resp.sources[0].password_param #=> String
resp.sources[0].url #=> String
resp.sources[0].username #=> String
resp.state #=> String, one of "CREATING", "DETACHED", "ATTACHED", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.type #=> String, one of "UDP_PUSH", "RTP_PUSH", "RTMP_PUSH", "RTMP_PULL", "URL_PULL", "MP4_FILE", "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", "TS_FILE", "SRT_CALLER", "MULTICAST", "SMPTE_2110_RECEIVER_GROUP", "SDI", "MEDIACONNECT_ROUTER", "SRT_LISTENER"
resp.srt_settings.srt_caller_sources #=> Array
resp.srt_settings.srt_caller_sources[0].decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.srt_settings.srt_caller_sources[0].decryption.passphrase_secret_arn #=> String
resp.srt_settings.srt_caller_sources[0].minimum_latency #=> Integer
resp.srt_settings.srt_caller_sources[0].srt_listener_address #=> String
resp.srt_settings.srt_caller_sources[0].srt_listener_port #=> String
resp.srt_settings.srt_caller_sources[0].stream_id #=> String
resp.srt_settings.srt_listener_settings.decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.srt_settings.srt_listener_settings.decryption.passphrase_secret_arn #=> String
resp.srt_settings.srt_listener_settings.minimum_latency #=> Integer
resp.srt_settings.srt_listener_settings.stream_id #=> String
resp.input_network_location #=> String, one of "AWS", "ON_PREMISES"
resp.multicast_settings.sources #=> Array
resp.multicast_settings.sources[0].source_ip #=> String
resp.multicast_settings.sources[0].url #=> String
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups #=> Array
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps #=> Array
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].media_index #=> Integer
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].sdp_url #=> String
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps #=> Array
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].media_index #=> Integer
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].sdp_url #=> String
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.media_index #=> Integer
resp.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.sdp_url #=> String
resp.sdi_sources #=> Array
resp.sdi_sources[0] #=> String
resp.router_settings.destinations #=> Array
resp.router_settings.destinations[0].availability_zone_name #=> String
resp.router_settings.destinations[0].router_output_arn #=> String
resp.router_settings.encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.router_settings.secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_id (required, String)

Returns:

See Also:



2175
2176
2177
2178
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2175

def describe_input(params = {}, options = {})
  req = build_request(:describe_input, params)
  req.send_request(options)
end

#describe_input_device(params = {}) ⇒ Types::DescribeInputDeviceResponse

Gets the details for the input device

Examples:

Request syntax with placeholder values


resp = client.describe_input_device({
  input_device_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.connection_state #=> String, one of "DISCONNECTED", "CONNECTED"
resp.device_settings_sync_state #=> String, one of "SYNCED", "SYNCING"
resp.device_update_status #=> String, one of "UP_TO_DATE", "NOT_UP_TO_DATE", "UPDATING"
resp.hd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.hd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.hd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.hd_device_settings.framerate #=> Float
resp.hd_device_settings.height #=> Integer
resp.hd_device_settings.max_bitrate #=> Integer
resp.hd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.hd_device_settings.width #=> Integer
resp.hd_device_settings.latency_ms #=> Integer
resp.id #=> String
resp.mac_address #=> String
resp.name #=> String
resp.network_settings.dns_addresses #=> Array
resp.network_settings.dns_addresses[0] #=> String
resp.network_settings.gateway #=> String
resp.network_settings.ip_address #=> String
resp.network_settings.ip_scheme #=> String, one of "STATIC", "DHCP"
resp.network_settings.subnet_mask #=> String
resp.serial_number #=> String
resp.type #=> String, one of "HD", "UHD"
resp.uhd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.uhd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.uhd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.uhd_device_settings.framerate #=> Float
resp.uhd_device_settings.height #=> Integer
resp.uhd_device_settings.max_bitrate #=> Integer
resp.uhd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.uhd_device_settings.width #=> Integer
resp.uhd_device_settings.latency_ms #=> Integer
resp.uhd_device_settings.codec #=> String, one of "HEVC", "AVC"
resp.uhd_device_settings.mediaconnect_settings.flow_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.role_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.secret_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.source_name #=> String
resp.uhd_device_settings.audio_channel_pairs #=> Array
resp.uhd_device_settings.audio_channel_pairs[0].id #=> Integer
resp.uhd_device_settings.audio_channel_pairs[0].profile #=> String, one of "DISABLED", "VBR-AAC_HHE-16000", "VBR-AAC_HE-64000", "VBR-AAC_LC-128000", "CBR-AAC_HQ-192000", "CBR-AAC_HQ-256000", "CBR-AAC_HQ-384000", "CBR-AAC_HQ-512000"
resp.uhd_device_settings.input_resolution #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.availability_zone #=> String
resp.medialive_input_arns #=> Array
resp.medialive_input_arns[0] #=> String
resp.output_type #=> String, one of "NONE", "MEDIALIVE_INPUT", "MEDIACONNECT_FLOW"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

See Also:



2264
2265
2266
2267
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2264

def describe_input_device(params = {}, options = {})
  req = build_request(:describe_input_device, params)
  req.send_request(options)
end

#describe_input_device_thumbnail(params = {}) ⇒ Types::DescribeInputDeviceThumbnailResponse

Get the latest thumbnail data for the input device.

Examples:

Request syntax with placeholder values


resp = client.describe_input_device_thumbnail({
  input_device_id: "__string", # required
  accept: "image/jpeg", # required, accepts image/jpeg
})

Response structure


resp.body #=> IO
resp.content_type #=> String, one of "image/jpeg"
resp.content_length #=> Integer
resp.etag #=> String
resp.last_modified #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)
  • :accept (required, String) —

    The HTTP Accept header. Indicates the requested type fothe thumbnail.

Returns:

See Also:



2303
2304
2305
2306
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2303

def describe_input_device_thumbnail(params = {}, options = {}, &block)
  req = build_request(:describe_input_device_thumbnail, params)
  req.send_request(options, &block)
end

#describe_input_security_group(params = {}) ⇒ Types::DescribeInputSecurityGroupResponse

Produces a summary of an Input Security Group

Examples:

Request syntax with placeholder values


resp = client.describe_input_security_group({
  input_security_group_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.inputs #=> Array
resp.inputs[0] #=> String
resp.state #=> String, one of "IDLE", "IN_USE", "UPDATING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.whitelist_rules #=> Array
resp.whitelist_rules[0].cidr #=> String
resp.channels #=> Array
resp.channels[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_security_group_id (required, String)

Returns:

See Also:



2346
2347
2348
2349
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2346

def describe_input_security_group(params = {}, options = {})
  req = build_request(:describe_input_security_group, params)
  req.send_request(options)
end

#describe_multiplex(params = {}) ⇒ Types::DescribeMultiplexResponse

Gets details about a multiplex.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • multiplex_created
  • multiplex_deleted
  • multiplex_running
  • multiplex_stopped

Examples:

Request syntax with placeholder values


resp = client.describe_multiplex({
  multiplex_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.availability_zones #=> Array
resp.availability_zones[0] #=> String
resp.destinations #=> Array
resp.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.id #=> String
resp.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.name #=> String
resp.pipelines_running_count #=> Integer
resp.program_count #=> Integer
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)

Returns:

See Also:



2405
2406
2407
2408
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2405

def describe_multiplex(params = {}, options = {})
  req = build_request(:describe_multiplex, params)
  req.send_request(options)
end

#describe_multiplex_program(params = {}) ⇒ Types::DescribeMultiplexProgramResponse

Get the details for a program in a multiplex.

Examples:

Request syntax with placeholder values


resp = client.describe_multiplex_program({
  multiplex_id: "__string", # required
  program_name: "__string", # required
})

Response structure


resp.channel_id #=> String
resp.multiplex_program_settings.preferred_channel_pipeline #=> String, one of "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1"
resp.multiplex_program_settings.program_number #=> Integer
resp.multiplex_program_settings.service_descriptor.provider_name #=> String
resp.multiplex_program_settings.service_descriptor.service_name #=> String
resp.multiplex_program_settings.video_settings.constant_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.maximum_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.minimum_bitrate #=> Integer
resp.multiplex_program_settings.video_settings.statmux_settings.priority #=> Integer
resp.packet_identifiers_map.audio_pids #=> Array
resp.packet_identifiers_map.audio_pids[0] #=> Integer
resp.packet_identifiers_map.dvb_sub_pids #=> Array
resp.packet_identifiers_map.dvb_sub_pids[0] #=> Integer
resp.packet_identifiers_map.dvb_teletext_pid #=> Integer
resp.packet_identifiers_map.etv_platform_pid #=> Integer
resp.packet_identifiers_map.etv_signal_pid #=> Integer
resp.packet_identifiers_map.klv_data_pids #=> Array
resp.packet_identifiers_map.klv_data_pids[0] #=> Integer
resp.packet_identifiers_map.pcr_pid #=> Integer
resp.packet_identifiers_map.pmt_pid #=> Integer
resp.packet_identifiers_map.private_metadata_pid #=> Integer
resp.packet_identifiers_map.scte_27_pids #=> Array
resp.packet_identifiers_map.scte_27_pids[0] #=> Integer
resp.packet_identifiers_map.scte_35_pid #=> Integer
resp.packet_identifiers_map.timed_metadata_pid #=> Integer
resp.packet_identifiers_map.video_pid #=> Integer
resp.packet_identifiers_map.arib_captions_pid #=> Integer
resp.packet_identifiers_map.dvb_teletext_pids #=> Array
resp.packet_identifiers_map.dvb_teletext_pids[0] #=> Integer
resp.packet_identifiers_map.ecm_pid #=> Integer
resp.packet_identifiers_map.smpte_2038_pid #=> Integer
resp.pipeline_details #=> Array
resp.pipeline_details[0].active_channel_pipeline #=> String
resp.pipeline_details[0].pipeline_id #=> String
resp.program_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)
  • :program_name (required, String)

Returns:

See Also:



2473
2474
2475
2476
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2473

def describe_multiplex_program(params = {}, options = {})
  req = build_request(:describe_multiplex_program, params)
  req.send_request(options)
end

#describe_network(params = {}) ⇒ Types::DescribeNetworkResponse

Get details about a Network.

Examples:

Request syntax with placeholder values


resp = client.describe_network({
  network_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.associated_cluster_ids #=> Array
resp.associated_cluster_ids[0] #=> String
resp.id #=> String
resp.ip_pools #=> Array
resp.ip_pools[0].cidr #=> String
resp.name #=> String
resp.routes #=> Array
resp.routes[0].cidr #=> String
resp.routes[0].gateway #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "IDLE", "IN_USE", "UPDATING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_id (required, String)

Returns:

See Also:



7099
7100
7101
7102
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7099

def describe_network(params = {}, options = {})
  req = build_request(:describe_network, params)
  req.send_request(options)
end

#describe_node(params = {}) ⇒ Types::DescribeNodeResponse

Get details about a Node in the specified Cluster.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • node_deregistered
  • node_registered

Examples:

Request syntax with placeholder values


resp = client.describe_node({
  cluster_id: "__string", # required
  node_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0] #=> String
resp.cluster_id #=> String
resp.connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.id #=> String
resp.instance_arn #=> String
resp.name #=> String
resp.node_interface_mappings #=> Array
resp.node_interface_mappings[0].logical_interface_name #=> String
resp.node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.node_interface_mappings[0].physical_interface_name #=> String
resp.node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.role #=> String, one of "BACKUP", "ACTIVE"
resp.state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.sdi_source_mappings #=> Array
resp.sdi_source_mappings[0].card_number #=> Integer
resp.sdi_source_mappings[0].channel_number #=> Integer
resp.sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :node_id (required, String)

Returns:

See Also:



7164
7165
7166
7167
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7164

def describe_node(params = {}, options = {})
  req = build_request(:describe_node, params)
  req.send_request(options)
end

#describe_offering(params = {}) ⇒ Types::DescribeOfferingResponse

Get details for an offering.

Examples:

Request syntax with placeholder values


resp = client.describe_offering({
  offering_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.currency_code #=> String
resp.duration #=> Integer
resp.duration_units #=> String, one of "MONTHS"
resp.fixed_price #=> Float
resp.offering_description #=> String
resp.offering_id #=> String
resp.offering_type #=> String, one of "NO_UPFRONT"
resp.region #=> String
resp.resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :offering_id (required, String)

Returns:

See Also:



2527
2528
2529
2530
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2527

def describe_offering(params = {}, options = {})
  req = build_request(:describe_offering, params)
  req.send_request(options)
end

#describe_reservation(params = {}) ⇒ Types::DescribeReservationResponse

Get details for a reservation.

Examples:

Request syntax with placeholder values


resp = client.describe_reservation({
  reservation_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.count #=> Integer
resp.currency_code #=> String
resp.duration #=> Integer
resp.duration_units #=> String, one of "MONTHS"
resp.end #=> String
resp.fixed_price #=> Float
resp.name #=> String
resp.offering_description #=> String
resp.offering_id #=> String
resp.offering_type #=> String, one of "NO_UPFRONT"
resp.region #=> String
resp.renewal_settings.automatic_renewal #=> String, one of "DISABLED", "ENABLED", "UNAVAILABLE"
resp.renewal_settings.renewal_count #=> Integer
resp.reservation_id #=> String
resp.resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.start #=> String
resp.state #=> String, one of "ACTIVE", "EXPIRED", "CANCELED", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reservation_id (required, String)

Returns:

See Also:



2599
2600
2601
2602
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2599

def describe_reservation(params = {}, options = {})
  req = build_request(:describe_reservation, params)
  req.send_request(options)
end

#describe_schedule(params = {}) ⇒ Types::DescribeScheduleResponse

Get a channel schedule

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_schedule({
  channel_id: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.schedule_actions #=> Array
resp.schedule_actions[0].action_name #=> String
resp.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.tag #=> String
resp.schedule_actions[0].schedule_action_settings.hls_id_3_segment_tagging_settings.id_3 #=> String
resp.schedule_actions[0].schedule_action_settings.hls_timed_metadata_settings.id_3 #=> String
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_attachment_name_reference #=> String
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path #=> Array
resp.schedule_actions[0].schedule_action_settings.input_prepare_settings.url_path[0] #=> String
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.input_attachment_name_reference #=> String
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.input_timecode_source #=> String, one of "ZEROBASED", "EMBEDDED"
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.start_timecode.timecode #=> String
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.last_frame_clipping_behavior #=> String, one of "EXCLUDE_LAST_FRAME", "INCLUDE_LAST_FRAME"
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.input_clipping_settings.stop_timecode.timecode #=> String
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path #=> Array
resp.schedule_actions[0].schedule_action_settings.input_switch_settings.url_path[0] #=> String
resp.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.duration #=> Integer
resp.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.password_param #=> String
resp.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.url #=> String
resp.schedule_actions[0].schedule_action_settings.motion_graphics_image_activate_settings.username #=> String
resp.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines #=> Array
resp.schedule_actions[0].schedule_action_settings.pause_state_settings.pipelines[0].pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.schedule_actions[0].schedule_action_settings.scte_35_input_settings.input_attachment_name_reference #=> String
resp.schedule_actions[0].schedule_action_settings.scte_35_input_settings.mode #=> String, one of "FIXED", "FOLLOW_ACTIVE"
resp.schedule_actions[0].schedule_action_settings.scte_35_return_to_network_settings.splice_event_id #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.duration #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_splice_insert_settings.splice_event_id #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors #=> Array
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.archive_allowed_flag #=> String, one of "ARCHIVE_NOT_ALLOWED", "ARCHIVE_ALLOWED"
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.device_restrictions #=> String, one of "NONE", "RESTRICT_GROUP0", "RESTRICT_GROUP1", "RESTRICT_GROUP2"
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.no_regional_blackout_flag #=> String, one of "REGIONAL_BLACKOUT", "NO_REGIONAL_BLACKOUT"
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.delivery_restrictions.web_delivery_allowed_flag #=> String, one of "WEB_DELIVERY_NOT_ALLOWED", "WEB_DELIVERY_ALLOWED"
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segment_num #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_cancel_indicator #=> String, one of "SEGMENTATION_EVENT_NOT_CANCELED", "SEGMENTATION_EVENT_CANCELED"
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_duration #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_event_id #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_type_id #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid #=> String
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segmentation_upid_type #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.segments_expected #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segment_num #=> Integer
resp.schedule_actions[0].schedule_action_settings.scte_35_time_signal_settings.scte_35_descriptors[0].scte_35_descriptor_settings.segmentation_descriptor_scte_35_descriptor_settings.sub_segments_expected #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.duration #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_in #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.fade_out #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.height #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.password_param #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.uri #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image.username #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_x #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.image_y #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.layer #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.opacity #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_activate_settings.width #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.fade_out #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_deactivate_settings.layer #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.duration #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_in #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.fade_out #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.height #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.password_param #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.uri #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image.username #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_x #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.image_y #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.layer #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.opacity #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names #=> Array
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.output_names[0] #=> String
resp.schedule_actions[0].schedule_action_settings.static_image_output_activate_settings.width #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.fade_out #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.layer #=> Integer
resp.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names #=> Array
resp.schedule_actions[0].schedule_action_settings.static_image_output_deactivate_settings.output_names[0] #=> String
resp.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.id_3 #=> String
resp.schedule_actions[0].schedule_action_settings.id_3_segment_tagging_settings.tag #=> String
resp.schedule_actions[0].schedule_action_settings.timed_metadata_settings.id_3 #=> String
resp.schedule_actions[0].schedule_action_start_settings.fixed_mode_schedule_action_start_settings.time #=> String
resp.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.follow_point #=> String, one of "END", "START"
resp.schedule_actions[0].schedule_action_start_settings.follow_mode_schedule_action_start_settings.reference_action_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



2718
2719
2720
2721
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2718

def describe_schedule(params = {}, options = {})
  req = build_request(:describe_schedule, params)
  req.send_request(options)
end

#describe_sdi_source(params = {}) ⇒ Types::DescribeSdiSourceResponse

Gets details about a SdiSource.

Examples:

Request syntax with placeholder values


resp = client.describe_sdi_source({
  sdi_source_id: "__string", # required
})

Response structure


resp.sdi_source.arn #=> String
resp.sdi_source.id #=> String
resp.sdi_source.inputs #=> Array
resp.sdi_source.inputs[0] #=> String
resp.sdi_source.mode #=> String, one of "QUADRANT", "INTERLEAVE"
resp.sdi_source.name #=> String
resp.sdi_source.state #=> String, one of "IDLE", "IN_USE", "DELETED"
resp.sdi_source.type #=> String, one of "SINGLE", "QUAD"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sdi_source_id (required, String)

Returns:

See Also:



7853
7854
7855
7856
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7853

def describe_sdi_source(params = {}, options = {})
  req = build_request(:describe_sdi_source, params)
  req.send_request(options)
end

#describe_thumbnails(params = {}) ⇒ Types::DescribeThumbnailsResponse

Describe the latest thumbnails data.

Examples:

Request syntax with placeholder values


resp = client.describe_thumbnails({
  channel_id: "__string", # required
  pipeline_id: "__string", # required
  thumbnail_type: "__string", # required
})

Response structure


resp.thumbnail_details #=> Array
resp.thumbnail_details[0].pipeline_id #=> String
resp.thumbnail_details[0].thumbnails #=> Array
resp.thumbnail_details[0].thumbnails[0].body #=> String
resp.thumbnail_details[0].thumbnails[0].content_type #=> String
resp.thumbnail_details[0].thumbnails[0].thumbnail_type #=> String, one of "UNSPECIFIED", "CURRENT_ACTIVE"
resp.thumbnail_details[0].thumbnails[0].time_stamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)
  • :pipeline_id (required, String)
  • :thumbnail_type (required, String)

Returns:

See Also:



2757
2758
2759
2760
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2757

def describe_thumbnails(params = {}, options = {})
  req = build_request(:describe_thumbnails, params)
  req.send_request(options)
end

#get_cloud_watch_alarm_template(params = {}) ⇒ Types::GetCloudWatchAlarmTemplateResponse

Retrieves the specified cloudwatch alarm template.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_watch_alarm_template({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
resp.created_at #=> Time
resp.datapoints_to_alarm #=> Integer
resp.description #=> String
resp.evaluation_periods #=> Integer
resp.group_id #=> String
resp.id #=> String
resp.metric_name #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.period #=> Integer
resp.statistic #=> String, one of "SampleCount", "Average", "Sum", "Minimum", "Maximum"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.target_resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "MEDIALIVE_MULTIPLEX", "MEDIALIVE_CHANNEL", "MEDIALIVE_INPUT_DEVICE", "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", "S3_BUCKET", "MEDIATAILOR_PLAYBACK_CONFIGURATION"
resp.threshold #=> Float
resp.treat_missing_data #=> String, one of "notBreaching", "breaching", "ignore", "missing"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5356
5357
5358
5359
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5356

def get_cloud_watch_alarm_template(params = {}, options = {})
  req = build_request(:get_cloud_watch_alarm_template, params)
  req.send_request(options)
end

#get_cloud_watch_alarm_template_group(params = {}) ⇒ Types::GetCloudWatchAlarmTemplateGroupResponse

Retrieves the specified cloudwatch alarm template group.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_watch_alarm_template_group({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5396
5397
5398
5399
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5396

def get_cloud_watch_alarm_template_group(params = {}, options = {})
  req = build_request(:get_cloud_watch_alarm_template_group, params)
  req.send_request(options)
end

#get_event_bridge_rule_template(params = {}) ⇒ Types::GetEventBridgeRuleTemplateResponse

Retrieves the specified eventbridge rule template.

Examples:

Request syntax with placeholder values


resp = client.get_event_bridge_rule_template({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.event_targets #=> Array
resp.event_targets[0].arn #=> String
resp.event_type #=> String, one of "MEDIALIVE_MULTIPLEX_ALERT", "MEDIALIVE_MULTIPLEX_STATE_CHANGE", "MEDIALIVE_CHANNEL_ALERT", "MEDIALIVE_CHANNEL_INPUT_CHANGE", "MEDIALIVE_CHANNEL_STATE_CHANGE", "MEDIAPACKAGE_INPUT_NOTIFICATION", "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", "SIGNAL_MAP_ACTIVE_ALARM", "MEDIACONNECT_ALERT", "MEDIACONNECT_SOURCE_HEALTH", "MEDIACONNECT_OUTPUT_HEALTH", "MEDIACONNECT_FLOW_STATUS_CHANGE"
resp.group_id #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5443
5444
5445
5446
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5443

def get_event_bridge_rule_template(params = {}, options = {})
  req = build_request(:get_event_bridge_rule_template, params)
  req.send_request(options)
end

#get_event_bridge_rule_template_group(params = {}) ⇒ Types::GetEventBridgeRuleTemplateGroupResponse

Retrieves the specified eventbridge rule template group.

Examples:

Request syntax with placeholder values


resp = client.get_event_bridge_rule_template_group({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5483
5484
5485
5486
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5483

def get_event_bridge_rule_template_group(params = {}, options = {})
  req = build_request(:get_event_bridge_rule_template_group, params)
  req.send_request(options)
end

#get_signal_map(params = {}) ⇒ Types::GetSignalMapResponse

Retrieves the specified signal map.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • signal_map_created
  • signal_map_monitor_deleted
  • signal_map_monitor_deployed
  • signal_map_updated

Examples:

Request syntax with placeholder values


resp = client.get_signal_map({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.cloud_watch_alarm_template_group_ids #=> Array
resp.cloud_watch_alarm_template_group_ids[0] #=> String
resp.created_at #=> Time
resp.description #=> String
resp.discovery_entry_point_arn #=> String
resp.error_message #=> String
resp.event_bridge_rule_template_group_ids #=> Array
resp.event_bridge_rule_template_group_ids[0] #=> String
resp.failed_media_resource_map #=> Hash
resp.failed_media_resource_map["__string"].destinations #=> Array
resp.failed_media_resource_map["__string"].destinations[0].arn #=> String
resp.failed_media_resource_map["__string"].destinations[0].name #=> String
resp.failed_media_resource_map["__string"].name #=> String
resp.failed_media_resource_map["__string"].sources #=> Array
resp.failed_media_resource_map["__string"].sources[0].arn #=> String
resp.failed_media_resource_map["__string"].sources[0].name #=> String
resp.id #=> String
resp.last_discovered_at #=> Time
resp.last_successful_monitor_deployment.details_uri #=> String
resp.last_successful_monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.media_resource_map #=> Hash
resp.media_resource_map["__string"].destinations #=> Array
resp.media_resource_map["__string"].destinations[0].arn #=> String
resp.media_resource_map["__string"].destinations[0].name #=> String
resp.media_resource_map["__string"].name #=> String
resp.media_resource_map["__string"].sources #=> Array
resp.media_resource_map["__string"].sources[0].arn #=> String
resp.media_resource_map["__string"].sources[0].name #=> String
resp.modified_at #=> Time
resp.monitor_changes_pending_deployment #=> Boolean
resp.monitor_deployment.details_uri #=> String
resp.monitor_deployment.error_message #=> String
resp.monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.name #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5572
5573
5574
5575
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5572

def get_signal_map(params = {}, options = {})
  req = build_request(:get_signal_map, params)
  req.send_request(options)
end

#list_alerts(params = {}) ⇒ Types::ListAlertsResponse

List the alerts for a channel with optional filtering based on alert state.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_alerts({
  channel_id: "__string", # required
  max_results: 1,
  next_token: "__string",
  state_filter: "__string",
})

Response structure


resp.alerts #=> Array
resp.alerts[0].alert_type #=> String
resp.alerts[0].cleared_timestamp #=> Time
resp.alerts[0].id #=> String
resp.alerts[0].message #=> String
resp.alerts[0].pipeline_id #=> String
resp.alerts[0].set_timestamp #=> Time
resp.alerts[0].state #=> String, one of "SET", "CLEARED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)
  • :max_results (Integer)
  • :next_token (String)
  • :state_filter (String)

Returns:

See Also:



7997
7998
7999
8000
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7997

def list_alerts(params = {}, options = {})
  req = build_request(:list_alerts, params)
  req.send_request(options)
end

#list_channel_placement_groups(params = {}) ⇒ Types::ListChannelPlacementGroupsResponse

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_channel_placement_groups({
  cluster_id: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0].arn #=> String
resp.channel_placement_groups[0].channels #=> Array
resp.channel_placement_groups[0].channels[0] #=> String
resp.channel_placement_groups[0].cluster_id #=> String
resp.channel_placement_groups[0].id #=> String
resp.channel_placement_groups[0].name #=> String
resp.channel_placement_groups[0].nodes #=> Array
resp.channel_placement_groups[0].nodes[0] #=> String
resp.channel_placement_groups[0].state #=> String, one of "UNASSIGNED", "ASSIGNING", "ASSIGNED", "DELETING", "DELETE_FAILED", "DELETED", "UNASSIGNING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



7210
7211
7212
7213
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7210

def list_channel_placement_groups(params = {}, options = {})
  req = build_request(:list_channel_placement_groups, params)
  req.send_request(options)
end

#list_channels(params = {}) ⇒ Types::ListChannelsResponse

Produces list of channels that have been created

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_channels({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.channels #=> Array
resp.channels[0].arn #=> String
resp.channels[0].cdi_input_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.channels[0].channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.channels[0].destinations #=> Array
resp.channels[0].destinations[0].id #=> String
resp.channels[0].destinations[0].media_package_settings #=> Array
resp.channels[0].destinations[0].media_package_settings[0].channel_id #=> String
resp.channels[0].destinations[0].media_package_settings[0].channel_group #=> String
resp.channels[0].destinations[0].media_package_settings[0].channel_name #=> String
resp.channels[0].destinations[0].media_package_settings[0].channel_endpoint_id #=> String
resp.channels[0].destinations[0].media_package_settings[0].media_package_region_name #=> String
resp.channels[0].destinations[0].multiplex_settings.multiplex_id #=> String
resp.channels[0].destinations[0].multiplex_settings.program_name #=> String
resp.channels[0].destinations[0].settings #=> Array
resp.channels[0].destinations[0].settings[0].password_param #=> String
resp.channels[0].destinations[0].settings[0].stream_name #=> String
resp.channels[0].destinations[0].settings[0].url #=> String
resp.channels[0].destinations[0].settings[0].username #=> String
resp.channels[0].destinations[0].settings[0].virtual_source_address #=> String
resp.channels[0].destinations[0].srt_settings #=> Array
resp.channels[0].destinations[0].srt_settings[0].encryption_passphrase_secret_arn #=> String
resp.channels[0].destinations[0].srt_settings[0].stream_id #=> String
resp.channels[0].destinations[0].srt_settings[0].url #=> String
resp.channels[0].destinations[0].srt_settings[0].connection_mode #=> String, one of "CALLER", "LISTENER"
resp.channels[0].destinations[0].srt_settings[0].listener_port #=> Integer
resp.channels[0].destinations[0].logical_interface_names #=> Array
resp.channels[0].destinations[0].logical_interface_names[0] #=> String
resp.channels[0].destinations[0].media_connect_router_settings #=> Array
resp.channels[0].destinations[0].media_connect_router_settings[0].encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.channels[0].destinations[0].media_connect_router_settings[0].secret_arn #=> String
resp.channels[0].egress_endpoints #=> Array
resp.channels[0].egress_endpoints[0].source_ip #=> String
resp.channels[0].id #=> String
resp.channels[0].input_attachments #=> Array
resp.channels[0].input_attachments[0].automatic_input_failover_settings.error_clear_time_msec #=> Integer
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions #=> Array
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions[0].failover_condition_settings.audio_silence_settings.audio_selector_name #=> String
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions[0].failover_condition_settings.audio_silence_settings.audio_silence_threshold_msec #=> Integer
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions[0].failover_condition_settings.input_loss_settings.input_loss_threshold_msec #=> Integer
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions[0].failover_condition_settings.video_black_settings.black_detect_threshold #=> Float
resp.channels[0].input_attachments[0].automatic_input_failover_settings.failover_conditions[0].failover_condition_settings.video_black_settings.video_black_threshold_msec #=> Integer
resp.channels[0].input_attachments[0].automatic_input_failover_settings.input_preference #=> String, one of "EQUAL_INPUT_PREFERENCE", "PRIMARY_INPUT_PREFERRED"
resp.channels[0].input_attachments[0].automatic_input_failover_settings.secondary_input_id #=> String
resp.channels[0].input_attachments[0].input_attachment_name #=> String
resp.channels[0].input_attachments[0].input_id #=> String
resp.channels[0].input_attachments[0].input_settings.audio_selectors #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].name #=> String
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_hls_rendition_selection.group_id #=> String
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_hls_rendition_selection.name #=> String
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_language_selection.language_code #=> String
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_language_selection.language_selection_policy #=> String, one of "LOOSE", "STRICT"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].dolby_e_decode.program_selection #=> String, one of "ALL_CHANNELS", "PROGRAM_1", "PROGRAM_2", "PROGRAM_3", "PROGRAM_4", "PROGRAM_5", "PROGRAM_6", "PROGRAM_7", "PROGRAM_8"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.audio_normalization_settings.algorithm #=> String, one of "ITU_1770_1", "ITU_1770_2", "ITU_1770_3", "ITU_1770_4"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.audio_normalization_settings.algorithm_control #=> String, one of "CORRECT_AUDIO"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.audio_normalization_settings.target_lkfs #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.audio_normalization_settings.peak_calculation #=> String, one of "NONE", "TRUE_PEAK"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.audio_normalization_settings.peak_limiter_threshold #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.channels #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.gain_db #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channel_mappings #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels[0].gain #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels[0].input_channel #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channel_mappings[0].output_channel #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channels_in #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_pid_selection.pids[0].premix_settings.remix_settings.channels_out #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].track #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.audio_normalization_settings.algorithm #=> String, one of "ITU_1770_1", "ITU_1770_2", "ITU_1770_3", "ITU_1770_4"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.audio_normalization_settings.algorithm_control #=> String, one of "CORRECT_AUDIO"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.audio_normalization_settings.target_lkfs #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.audio_normalization_settings.peak_calculation #=> String, one of "NONE", "TRUE_PEAK"
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.audio_normalization_settings.peak_limiter_threshold #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.channels #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.gain_db #=> Float
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channel_mappings #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels #=> Array
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels[0].gain #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channel_mappings[0].input_channel_levels[0].input_channel #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channel_mappings[0].output_channel #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channels_in #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.tracks[0].premix_settings.remix_settings.channels_out #=> Integer
resp.channels[0].input_attachments[0].input_settings.audio_selectors[0].selector_settings.audio_track_selection.dolby_e_decode.program_selection #=> String, one of "ALL_CHANNELS", "PROGRAM_1", "PROGRAM_2", "PROGRAM_3", "PROGRAM_4", "PROGRAM_5", "PROGRAM_6", "PROGRAM_7", "PROGRAM_8"
resp.channels[0].input_attachments[0].input_settings.caption_selectors #=> Array
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].language_code #=> String
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].name #=> String
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.ancillary_source_settings.source_ancillary_channel_number #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.dvb_sub_source_settings.ocr_language #=> String, one of "DEU", "ENG", "FRA", "NLD", "POR", "SPA"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.dvb_sub_source_settings.pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.embedded_source_settings.convert_608_to_708 #=> String, one of "DISABLED", "UPCONVERT"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.embedded_source_settings.scte_20_detection #=> String, one of "AUTO", "OFF"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.embedded_source_settings.source_608_channel_number #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.embedded_source_settings.source_608_track_number #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.scte_20_source_settings.convert_608_to_708 #=> String, one of "DISABLED", "UPCONVERT"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.scte_20_source_settings.source_608_channel_number #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.scte_27_source_settings.ocr_language #=> String, one of "DEU", "ENG", "FRA", "NLD", "POR", "SPA"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.scte_27_source_settings.pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.teletext_source_settings.output_rectangle.height #=> Float
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.teletext_source_settings.output_rectangle.left_offset #=> Float
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.teletext_source_settings.output_rectangle.top_offset #=> Float
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.teletext_source_settings.output_rectangle.width #=> Float
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.teletext_source_settings.page_number #=> String
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.smart_subtitle_source_settings.caption_synchronization_mode #=> String, one of "NO_VIDEO_DELAY", "VIDEO_ALIGNED_CAPTIONS"
resp.channels[0].input_attachments[0].input_settings.caption_selectors[0].selector_settings.smart_subtitle_source_settings.inference_feed_output #=> String
resp.channels[0].input_attachments[0].input_settings.deblock_filter #=> String, one of "DISABLED", "ENABLED"
resp.channels[0].input_attachments[0].input_settings.denoise_filter #=> String, one of "DISABLED", "ENABLED"
resp.channels[0].input_attachments[0].input_settings.filter_strength #=> Integer
resp.channels[0].input_attachments[0].input_settings.input_filter #=> String, one of "AUTO", "DISABLED", "FORCED"
resp.channels[0].input_attachments[0].input_settings.network_input_settings.hls_input_settings.bandwidth #=> Integer
resp.channels[0].input_attachments[0].input_settings.network_input_settings.hls_input_settings.buffer_segments #=> Integer
resp.channels[0].input_attachments[0].input_settings.network_input_settings.hls_input_settings.retries #=> Integer
resp.channels[0].input_attachments[0].input_settings.network_input_settings.hls_input_settings.retry_interval #=> Integer
resp.channels[0].input_attachments[0].input_settings.network_input_settings.hls_input_settings.scte_35_source #=> String, one of "MANIFEST", "SEGMENTS"
resp.channels[0].input_attachments[0].input_settings.network_input_settings.server_validation #=> String, one of "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME", "CHECK_CRYPTOGRAPHY_ONLY"
resp.channels[0].input_attachments[0].input_settings.network_input_settings.multicast_input_settings.source_ip_address #=> String
resp.channels[0].input_attachments[0].input_settings.scte_35_pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.smpte_2038_data_preference #=> String, one of "IGNORE", "PREFER"
resp.channels[0].input_attachments[0].input_settings.source_end_behavior #=> String, one of "CONTINUE", "LOOP"
resp.channels[0].input_attachments[0].input_settings.video_selector.color_space #=> String, one of "FOLLOW", "HDR10", "HLG_2020", "REC_601", "REC_709"
resp.channels[0].input_attachments[0].input_settings.video_selector.color_space_settings.hdr_10_settings.max_cll #=> Integer
resp.channels[0].input_attachments[0].input_settings.video_selector.color_space_settings.hdr_10_settings.max_fall #=> Integer
resp.channels[0].input_attachments[0].input_settings.video_selector.color_space_usage #=> String, one of "FALLBACK", "FORCE"
resp.channels[0].input_attachments[0].input_settings.video_selector.selector_settings.video_selector_pid.pid #=> Integer
resp.channels[0].input_attachments[0].input_settings.video_selector.selector_settings.video_selector_program_id.program_id #=> Integer
resp.channels[0].input_attachments[0].logical_interface_names #=> Array
resp.channels[0].input_attachments[0].logical_interface_names[0] #=> String
resp.channels[0].input_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC"
resp.channels[0].input_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.channels[0].input_specification.resolution #=> String, one of "SD", "HD", "UHD"
resp.channels[0].log_level #=> String, one of "ERROR", "WARNING", "INFO", "DEBUG", "DISABLED"
resp.channels[0].maintenance.maintenance_day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.channels[0].maintenance.maintenance_deadline #=> String
resp.channels[0].maintenance.maintenance_scheduled_date #=> String
resp.channels[0].maintenance.maintenance_start_time #=> String
resp.channels[0].name #=> String
resp.channels[0].pipelines_running_count #=> Integer
resp.channels[0].role_arn #=> String
resp.channels[0].state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED", "UPDATING", "UPDATE_FAILED"
resp.channels[0].tags #=> Hash
resp.channels[0].tags["__string"] #=> String
resp.channels[0].vpc.availability_zones #=> Array
resp.channels[0].vpc.availability_zones[0] #=> String
resp.channels[0].vpc.network_interface_ids #=> Array
resp.channels[0].vpc.network_interface_ids[0] #=> String
resp.channels[0].vpc.security_group_ids #=> Array
resp.channels[0].vpc.security_group_ids[0] #=> String
resp.channels[0].vpc.subnet_ids #=> Array
resp.channels[0].vpc.subnet_ids[0] #=> String
resp.channels[0].anywhere_settings.channel_placement_group_id #=> String
resp.channels[0].anywhere_settings.cluster_id #=> String
resp.channels[0].channel_engine_version.expiration_date #=> Time
resp.channels[0].channel_engine_version.version #=> String
resp.channels[0].used_channel_engine_versions #=> Array
resp.channels[0].used_channel_engine_versions[0].expiration_date #=> Time
resp.channels[0].used_channel_engine_versions[0].version #=> String
resp.channels[0].linked_channel_settings.follower_channel_settings.linked_channel_type #=> String, one of "FOLLOWING_CHANNEL", "PRIMARY_CHANNEL"
resp.channels[0].linked_channel_settings.follower_channel_settings.primary_channel_arn #=> String
resp.channels[0].linked_channel_settings.primary_channel_settings.following_channel_arns #=> Array
resp.channels[0].linked_channel_settings.primary_channel_settings.following_channel_arns[0] #=> String
resp.channels[0].linked_channel_settings.primary_channel_settings.linked_channel_type #=> String, one of "FOLLOWING_CHANNEL", "PRIMARY_CHANNEL"
resp.channels[0].channel_security_groups #=> Array
resp.channels[0].channel_security_groups[0] #=> String
resp.channels[0].inference_settings.feed_arn #=> String
resp.channels[0].inference_settings.audio_feed_inputs #=> Array
resp.channels[0].inference_settings.audio_feed_inputs[0].audio_selector_name #=> String
resp.channels[0].inference_settings.audio_feed_inputs[0].feed_input #=> String
resp.channels[0].inference_settings.enrichment_methods #=> Array
resp.channels[0].inference_settings.enrichment_methods[0] #=> String, one of "SCTE35_ELEMENTAL_INFERENCE_QUERY_PARAMS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



2962
2963
2964
2965
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 2962

def list_channels(params = {}, options = {})
  req = build_request(:list_channels, params)
  req.send_request(options)
end

#list_cloud_watch_alarm_template_groups(params = {}) ⇒ Types::ListCloudWatchAlarmTemplateGroupsResponse

Lists cloudwatch alarm template groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_watch_alarm_template_groups({
  max_results: 1,
  next_token: "__string",
  scope: "__string",
  signal_map_identifier: "__string",
})

Response structure


resp.cloud_watch_alarm_template_groups #=> Array
resp.cloud_watch_alarm_template_groups[0].arn #=> String
resp.cloud_watch_alarm_template_groups[0].created_at #=> Time
resp.cloud_watch_alarm_template_groups[0].description #=> String
resp.cloud_watch_alarm_template_groups[0].id #=> String
resp.cloud_watch_alarm_template_groups[0].modified_at #=> Time
resp.cloud_watch_alarm_template_groups[0].name #=> String
resp.cloud_watch_alarm_template_groups[0].tags #=> Hash
resp.cloud_watch_alarm_template_groups[0].tags["__string"] #=> String
resp.cloud_watch_alarm_template_groups[0].template_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :scope (String)
  • :signal_map_identifier (String)

Returns:

See Also:



5621
5622
5623
5624
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5621

def list_cloud_watch_alarm_template_groups(params = {}, options = {})
  req = build_request(:list_cloud_watch_alarm_template_groups, params)
  req.send_request(options)
end

#list_cloud_watch_alarm_templates(params = {}) ⇒ Types::ListCloudWatchAlarmTemplatesResponse

Lists cloudwatch alarm templates.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_watch_alarm_templates({
  group_identifier: "__string",
  max_results: 1,
  next_token: "__string",
  scope: "__string",
  signal_map_identifier: "__string",
})

Response structure


resp.cloud_watch_alarm_templates #=> Array
resp.cloud_watch_alarm_templates[0].arn #=> String
resp.cloud_watch_alarm_templates[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
resp.cloud_watch_alarm_templates[0].created_at #=> Time
resp.cloud_watch_alarm_templates[0].datapoints_to_alarm #=> Integer
resp.cloud_watch_alarm_templates[0].description #=> String
resp.cloud_watch_alarm_templates[0].evaluation_periods #=> Integer
resp.cloud_watch_alarm_templates[0].group_id #=> String
resp.cloud_watch_alarm_templates[0].id #=> String
resp.cloud_watch_alarm_templates[0].metric_name #=> String
resp.cloud_watch_alarm_templates[0].modified_at #=> Time
resp.cloud_watch_alarm_templates[0].name #=> String
resp.cloud_watch_alarm_templates[0].period #=> Integer
resp.cloud_watch_alarm_templates[0].statistic #=> String, one of "SampleCount", "Average", "Sum", "Minimum", "Maximum"
resp.cloud_watch_alarm_templates[0].tags #=> Hash
resp.cloud_watch_alarm_templates[0].tags["__string"] #=> String
resp.cloud_watch_alarm_templates[0].target_resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "MEDIALIVE_MULTIPLEX", "MEDIALIVE_CHANNEL", "MEDIALIVE_INPUT_DEVICE", "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", "S3_BUCKET", "MEDIATAILOR_PLAYBACK_CONFIGURATION"
resp.cloud_watch_alarm_templates[0].threshold #=> Float
resp.cloud_watch_alarm_templates[0].treat_missing_data #=> String, one of "notBreaching", "breaching", "ignore", "missing"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (String)
  • :max_results (Integer)
  • :next_token (String)
  • :scope (String)
  • :signal_map_identifier (String)

Returns:

See Also:



5682
5683
5684
5685
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5682

def list_cloud_watch_alarm_templates(params = {}, options = {})
  req = build_request(:list_cloud_watch_alarm_templates, params)
  req.send_request(options)
end

#list_cluster_alerts(params = {}) ⇒ Types::ListClusterAlertsResponse

List the alerts for a cluster with optional filtering based on alert state.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cluster_alerts({
  cluster_id: "__string", # required
  max_results: 1,
  next_token: "__string",
  state_filter: "__string",
})

Response structure


resp.alerts #=> Array
resp.alerts[0].alert_type #=> String
resp.alerts[0].channel_id #=> String
resp.alerts[0].cleared_timestamp #=> Time
resp.alerts[0].id #=> String
resp.alerts[0].message #=> String
resp.alerts[0].node_id #=> String
resp.alerts[0].set_timestamp #=> Time
resp.alerts[0].state #=> String, one of "SET", "CLEARED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :max_results (Integer)
  • :next_token (String)
  • :state_filter (String)

Returns:

See Also:



8046
8047
8048
8049
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 8046

def list_cluster_alerts(params = {}, options = {})
  req = build_request(:list_cluster_alerts, params)
  req.send_request(options)
end

#list_clusters(params = {}) ⇒ Types::ListClustersResponse

Retrieve the list of Clusters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_clusters({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.clusters #=> Array
resp.clusters[0].arn #=> String
resp.clusters[0].channel_ids #=> Array
resp.clusters[0].channel_ids[0] #=> String
resp.clusters[0].cluster_type #=> String, one of "ON_PREMISES"
resp.clusters[0].id #=> String
resp.clusters[0].instance_role_arn #=> String
resp.clusters[0].name #=> String
resp.clusters[0].network_settings.default_route #=> String
resp.clusters[0].network_settings.interface_mappings #=> Array
resp.clusters[0].network_settings.interface_mappings[0].logical_interface_name #=> String
resp.clusters[0].network_settings.interface_mappings[0].network_id #=> String
resp.clusters[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "DELETED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



7256
7257
7258
7259
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7256

def list_clusters(params = {}, options = {})
  req = build_request(:list_clusters, params)
  req.send_request(options)
end

#list_event_bridge_rule_template_groups(params = {}) ⇒ Types::ListEventBridgeRuleTemplateGroupsResponse

Lists eventbridge rule template groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_bridge_rule_template_groups({
  max_results: 1,
  next_token: "__string",
  signal_map_identifier: "__string",
})

Response structure


resp.event_bridge_rule_template_groups #=> Array
resp.event_bridge_rule_template_groups[0].arn #=> String
resp.event_bridge_rule_template_groups[0].created_at #=> Time
resp.event_bridge_rule_template_groups[0].description #=> String
resp.event_bridge_rule_template_groups[0].id #=> String
resp.event_bridge_rule_template_groups[0].modified_at #=> Time
resp.event_bridge_rule_template_groups[0].name #=> String
resp.event_bridge_rule_template_groups[0].tags #=> Hash
resp.event_bridge_rule_template_groups[0].tags["__string"] #=> String
resp.event_bridge_rule_template_groups[0].template_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :signal_map_identifier (String)

Returns:

See Also:



5728
5729
5730
5731
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5728

def list_event_bridge_rule_template_groups(params = {}, options = {})
  req = build_request(:list_event_bridge_rule_template_groups, params)
  req.send_request(options)
end

#list_event_bridge_rule_templates(params = {}) ⇒ Types::ListEventBridgeRuleTemplatesResponse

Lists eventbridge rule templates.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_bridge_rule_templates({
  group_identifier: "__string",
  max_results: 1,
  next_token: "__string",
  signal_map_identifier: "__string",
})

Response structure


resp.event_bridge_rule_templates #=> Array
resp.event_bridge_rule_templates[0].arn #=> String
resp.event_bridge_rule_templates[0].created_at #=> Time
resp.event_bridge_rule_templates[0].description #=> String
resp.event_bridge_rule_templates[0].event_target_count #=> Integer
resp.event_bridge_rule_templates[0].event_type #=> String, one of "MEDIALIVE_MULTIPLEX_ALERT", "MEDIALIVE_MULTIPLEX_STATE_CHANGE", "MEDIALIVE_CHANNEL_ALERT", "MEDIALIVE_CHANNEL_INPUT_CHANGE", "MEDIALIVE_CHANNEL_STATE_CHANGE", "MEDIAPACKAGE_INPUT_NOTIFICATION", "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", "SIGNAL_MAP_ACTIVE_ALARM", "MEDIACONNECT_ALERT", "MEDIACONNECT_SOURCE_HEALTH", "MEDIACONNECT_OUTPUT_HEALTH", "MEDIACONNECT_FLOW_STATUS_CHANGE"
resp.event_bridge_rule_templates[0].group_id #=> String
resp.event_bridge_rule_templates[0].id #=> String
resp.event_bridge_rule_templates[0].modified_at #=> Time
resp.event_bridge_rule_templates[0].name #=> String
resp.event_bridge_rule_templates[0].tags #=> Hash
resp.event_bridge_rule_templates[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (String)
  • :max_results (Integer)
  • :next_token (String)
  • :signal_map_identifier (String)

Returns:

See Also:



5779
5780
5781
5782
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5779

def list_event_bridge_rule_templates(params = {}, options = {})
  req = build_request(:list_event_bridge_rule_templates, params)
  req.send_request(options)
end

#list_input_device_transfers(params = {}) ⇒ Types::ListInputDeviceTransfersResponse

List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_input_device_transfers({
  max_results: 1,
  next_token: "__string",
  transfer_type: "__string", # required
})

Response structure


resp.input_device_transfers #=> Array
resp.input_device_transfers[0].id #=> String
resp.input_device_transfers[0].message #=> String
resp.input_device_transfers[0].target_customer_id #=> String
resp.input_device_transfers[0].transfer_type #=> String, one of "OUTGOING", "INCOMING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :transfer_type (required, String)

Returns:

See Also:



3005
3006
3007
3008
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3005

def list_input_device_transfers(params = {}, options = {})
  req = build_request(:list_input_device_transfers, params)
  req.send_request(options)
end

#list_input_devices(params = {}) ⇒ Types::ListInputDevicesResponse

List input devices

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_input_devices({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.input_devices #=> Array
resp.input_devices[0].arn #=> String
resp.input_devices[0].connection_state #=> String, one of "DISCONNECTED", "CONNECTED"
resp.input_devices[0].device_settings_sync_state #=> String, one of "SYNCED", "SYNCING"
resp.input_devices[0].device_update_status #=> String, one of "UP_TO_DATE", "NOT_UP_TO_DATE", "UPDATING"
resp.input_devices[0].hd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.input_devices[0].hd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.input_devices[0].hd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.input_devices[0].hd_device_settings.framerate #=> Float
resp.input_devices[0].hd_device_settings.height #=> Integer
resp.input_devices[0].hd_device_settings.max_bitrate #=> Integer
resp.input_devices[0].hd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.input_devices[0].hd_device_settings.width #=> Integer
resp.input_devices[0].hd_device_settings.latency_ms #=> Integer
resp.input_devices[0].id #=> String
resp.input_devices[0].mac_address #=> String
resp.input_devices[0].name #=> String
resp.input_devices[0].network_settings.dns_addresses #=> Array
resp.input_devices[0].network_settings.dns_addresses[0] #=> String
resp.input_devices[0].network_settings.gateway #=> String
resp.input_devices[0].network_settings.ip_address #=> String
resp.input_devices[0].network_settings.ip_scheme #=> String, one of "STATIC", "DHCP"
resp.input_devices[0].network_settings.subnet_mask #=> String
resp.input_devices[0].serial_number #=> String
resp.input_devices[0].type #=> String, one of "HD", "UHD"
resp.input_devices[0].uhd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.input_devices[0].uhd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.input_devices[0].uhd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.input_devices[0].uhd_device_settings.framerate #=> Float
resp.input_devices[0].uhd_device_settings.height #=> Integer
resp.input_devices[0].uhd_device_settings.max_bitrate #=> Integer
resp.input_devices[0].uhd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.input_devices[0].uhd_device_settings.width #=> Integer
resp.input_devices[0].uhd_device_settings.latency_ms #=> Integer
resp.input_devices[0].uhd_device_settings.codec #=> String, one of "HEVC", "AVC"
resp.input_devices[0].uhd_device_settings.mediaconnect_settings.flow_arn #=> String
resp.input_devices[0].uhd_device_settings.mediaconnect_settings.role_arn #=> String
resp.input_devices[0].uhd_device_settings.mediaconnect_settings.secret_arn #=> String
resp.input_devices[0].uhd_device_settings.mediaconnect_settings.source_name #=> String
resp.input_devices[0].uhd_device_settings.audio_channel_pairs #=> Array
resp.input_devices[0].uhd_device_settings.audio_channel_pairs[0].id #=> Integer
resp.input_devices[0].uhd_device_settings.audio_channel_pairs[0].profile #=> String, one of "DISABLED", "VBR-AAC_HHE-16000", "VBR-AAC_HE-64000", "VBR-AAC_LC-128000", "CBR-AAC_HQ-192000", "CBR-AAC_HQ-256000", "CBR-AAC_HQ-384000", "CBR-AAC_HQ-512000"
resp.input_devices[0].uhd_device_settings.input_resolution #=> String
resp.input_devices[0].tags #=> Hash
resp.input_devices[0].tags["__string"] #=> String
resp.input_devices[0].availability_zone #=> String
resp.input_devices[0].medialive_input_arns #=> Array
resp.input_devices[0].medialive_input_arns[0] #=> String
resp.input_devices[0].output_type #=> String, one of "NONE", "MEDIALIVE_INPUT", "MEDIACONNECT_FLOW"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



3087
3088
3089
3090
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3087

def list_input_devices(params = {}, options = {})
  req = build_request(:list_input_devices, params)
  req.send_request(options)
end

#list_input_security_groups(params = {}) ⇒ Types::ListInputSecurityGroupsResponse

Produces a list of Input Security Groups for an account

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_input_security_groups({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.input_security_groups #=> Array
resp.input_security_groups[0].arn #=> String
resp.input_security_groups[0].id #=> String
resp.input_security_groups[0].inputs #=> Array
resp.input_security_groups[0].inputs[0] #=> String
resp.input_security_groups[0].state #=> String, one of "IDLE", "IN_USE", "UPDATING", "DELETED"
resp.input_security_groups[0].tags #=> Hash
resp.input_security_groups[0].tags["__string"] #=> String
resp.input_security_groups[0].whitelist_rules #=> Array
resp.input_security_groups[0].whitelist_rules[0].cidr #=> String
resp.input_security_groups[0].channels #=> Array
resp.input_security_groups[0].channels[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



3132
3133
3134
3135
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3132

def list_input_security_groups(params = {}, options = {})
  req = build_request(:list_input_security_groups, params)
  req.send_request(options)
end

#list_inputs(params = {}) ⇒ Types::ListInputsResponse

Produces list of inputs that have been created

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_inputs({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.inputs #=> Array
resp.inputs[0].arn #=> String
resp.inputs[0].attached_channels #=> Array
resp.inputs[0].attached_channels[0] #=> String
resp.inputs[0].destinations #=> Array
resp.inputs[0].destinations[0].ip #=> String
resp.inputs[0].destinations[0].port #=> String
resp.inputs[0].destinations[0].url #=> String
resp.inputs[0].destinations[0].vpc.availability_zone #=> String
resp.inputs[0].destinations[0].vpc.network_interface_id #=> String
resp.inputs[0].destinations[0].network #=> String
resp.inputs[0].destinations[0].network_routes #=> Array
resp.inputs[0].destinations[0].network_routes[0].cidr #=> String
resp.inputs[0].destinations[0].network_routes[0].gateway #=> String
resp.inputs[0].id #=> String
resp.inputs[0].input_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.inputs[0].input_devices #=> Array
resp.inputs[0].input_devices[0].id #=> String
resp.inputs[0].input_partner_ids #=> Array
resp.inputs[0].input_partner_ids[0] #=> String
resp.inputs[0].input_source_type #=> String, one of "STATIC", "DYNAMIC"
resp.inputs[0].media_connect_flows #=> Array
resp.inputs[0].media_connect_flows[0].flow_arn #=> String
resp.inputs[0].name #=> String
resp.inputs[0].role_arn #=> String
resp.inputs[0].security_groups #=> Array
resp.inputs[0].security_groups[0] #=> String
resp.inputs[0].sources #=> Array
resp.inputs[0].sources[0].password_param #=> String
resp.inputs[0].sources[0].url #=> String
resp.inputs[0].sources[0].username #=> String
resp.inputs[0].state #=> String, one of "CREATING", "DETACHED", "ATTACHED", "DELETING", "DELETED"
resp.inputs[0].tags #=> Hash
resp.inputs[0].tags["__string"] #=> String
resp.inputs[0].type #=> String, one of "UDP_PUSH", "RTP_PUSH", "RTMP_PUSH", "RTMP_PULL", "URL_PULL", "MP4_FILE", "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", "TS_FILE", "SRT_CALLER", "MULTICAST", "SMPTE_2110_RECEIVER_GROUP", "SDI", "MEDIACONNECT_ROUTER", "SRT_LISTENER"
resp.inputs[0].srt_settings.srt_caller_sources #=> Array
resp.inputs[0].srt_settings.srt_caller_sources[0].decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.inputs[0].srt_settings.srt_caller_sources[0].decryption.passphrase_secret_arn #=> String
resp.inputs[0].srt_settings.srt_caller_sources[0].minimum_latency #=> Integer
resp.inputs[0].srt_settings.srt_caller_sources[0].srt_listener_address #=> String
resp.inputs[0].srt_settings.srt_caller_sources[0].srt_listener_port #=> String
resp.inputs[0].srt_settings.srt_caller_sources[0].stream_id #=> String
resp.inputs[0].srt_settings.srt_listener_settings.decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.inputs[0].srt_settings.srt_listener_settings.decryption.passphrase_secret_arn #=> String
resp.inputs[0].srt_settings.srt_listener_settings.minimum_latency #=> Integer
resp.inputs[0].srt_settings.srt_listener_settings.stream_id #=> String
resp.inputs[0].input_network_location #=> String, one of "AWS", "ON_PREMISES"
resp.inputs[0].multicast_settings.sources #=> Array
resp.inputs[0].multicast_settings.sources[0].source_ip #=> String
resp.inputs[0].multicast_settings.sources[0].url #=> String
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups #=> Array
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps #=> Array
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].media_index #=> Integer
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].sdp_url #=> String
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps #=> Array
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].media_index #=> Integer
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].sdp_url #=> String
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.media_index #=> Integer
resp.inputs[0].smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.sdp_url #=> String
resp.inputs[0].sdi_sources #=> Array
resp.inputs[0].sdi_sources[0] #=> String
resp.inputs[0].router_settings.destinations #=> Array
resp.inputs[0].router_settings.destinations[0].availability_zone_name #=> String
resp.inputs[0].router_settings.destinations[0].router_output_arn #=> String
resp.inputs[0].router_settings.encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.inputs[0].router_settings.secret_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



3231
3232
3233
3234
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3231

def list_inputs(params = {}, options = {})
  req = build_request(:list_inputs, params)
  req.send_request(options)
end

#list_multiplex_alerts(params = {}) ⇒ Types::ListMultiplexAlertsResponse

List the alerts for a multiplex with optional filtering based on alert state.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_multiplex_alerts({
  max_results: 1,
  multiplex_id: "__string", # required
  next_token: "__string",
  state_filter: "__string",
})

Response structure


resp.alerts #=> Array
resp.alerts[0].alert_type #=> String
resp.alerts[0].cleared_timestamp #=> Time
resp.alerts[0].id #=> String
resp.alerts[0].message #=> String
resp.alerts[0].pipeline_id #=> String
resp.alerts[0].set_timestamp #=> Time
resp.alerts[0].state #=> String, one of "SET", "CLEARED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :multiplex_id (required, String)
  • :next_token (String)
  • :state_filter (String)

Returns:

See Also:



8094
8095
8096
8097
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 8094

def list_multiplex_alerts(params = {}, options = {})
  req = build_request(:list_multiplex_alerts, params)
  req.send_request(options)
end

#list_multiplex_programs(params = {}) ⇒ Types::ListMultiplexProgramsResponse

List the programs that currently exist for a specific multiplex.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_multiplex_programs({
  max_results: 1,
  multiplex_id: "__string", # required
  next_token: "__string",
})

Response structure


resp.multiplex_programs #=> Array
resp.multiplex_programs[0].channel_id #=> String
resp.multiplex_programs[0].program_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :multiplex_id (required, String)
  • :next_token (String)

Returns:

See Also:



3270
3271
3272
3273
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3270

def list_multiplex_programs(params = {}, options = {})
  req = build_request(:list_multiplex_programs, params)
  req.send_request(options)
end

#list_multiplexes(params = {}) ⇒ Types::ListMultiplexesResponse

Retrieve a list of the existing multiplexes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_multiplexes({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.multiplexes #=> Array
resp.multiplexes[0].arn #=> String
resp.multiplexes[0].availability_zones #=> Array
resp.multiplexes[0].availability_zones[0] #=> String
resp.multiplexes[0].id #=> String
resp.multiplexes[0].multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplexes[0].name #=> String
resp.multiplexes[0].pipelines_running_count #=> Integer
resp.multiplexes[0].program_count #=> Integer
resp.multiplexes[0].state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.multiplexes[0].tags #=> Hash
resp.multiplexes[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



3315
3316
3317
3318
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3315

def list_multiplexes(params = {}, options = {})
  req = build_request(:list_multiplexes, params)
  req.send_request(options)
end

#list_networks(params = {}) ⇒ Types::ListNetworksResponse

Retrieve the list of Networks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_networks({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.networks #=> Array
resp.networks[0].arn #=> String
resp.networks[0].associated_cluster_ids #=> Array
resp.networks[0].associated_cluster_ids[0] #=> String
resp.networks[0].id #=> String
resp.networks[0].ip_pools #=> Array
resp.networks[0].ip_pools[0].cidr #=> String
resp.networks[0].name #=> String
resp.networks[0].routes #=> Array
resp.networks[0].routes[0].cidr #=> String
resp.networks[0].routes[0].gateway #=> String
resp.networks[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "IDLE", "IN_USE", "UPDATING", "DELETE_FAILED", "DELETED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



7301
7302
7303
7304
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7301

def list_networks(params = {}, options = {})
  req = build_request(:list_networks, params)
  req.send_request(options)
end

#list_nodes(params = {}) ⇒ Types::ListNodesResponse

Retrieve the list of Nodes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_nodes({
  cluster_id: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.nodes #=> Array
resp.nodes[0].arn #=> String
resp.nodes[0].channel_placement_groups #=> Array
resp.nodes[0].channel_placement_groups[0] #=> String
resp.nodes[0].cluster_id #=> String
resp.nodes[0].connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.nodes[0].id #=> String
resp.nodes[0].instance_arn #=> String
resp.nodes[0].managed_instance_id #=> String
resp.nodes[0].name #=> String
resp.nodes[0].node_interface_mappings #=> Array
resp.nodes[0].node_interface_mappings[0].logical_interface_name #=> String
resp.nodes[0].node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.nodes[0].node_interface_mappings[0].physical_interface_name #=> String
resp.nodes[0].node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.nodes[0].node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.nodes[0].role #=> String, one of "BACKUP", "ACTIVE"
resp.nodes[0].state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.nodes[0].sdi_source_mappings #=> Array
resp.nodes[0].sdi_source_mappings[0].card_number #=> Integer
resp.nodes[0].sdi_source_mappings[0].channel_number #=> Integer
resp.nodes[0].sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



7359
7360
7361
7362
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7359

def list_nodes(params = {}, options = {})
  req = build_request(:list_nodes, params)
  req.send_request(options)
end

#list_offerings(params = {}) ⇒ Types::ListOfferingsResponse

List offerings available for purchase.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_offerings({
  channel_class: "__string",
  channel_configuration: "__string",
  codec: "__string",
  duration: "__string",
  max_results: 1,
  maximum_bitrate: "__string",
  maximum_framerate: "__string",
  next_token: "__string",
  resolution: "__string",
  resource_type: "__string",
  special_feature: "__string",
  video_quality: "__string",
})

Response structure


resp.next_token #=> String
resp.offerings #=> Array
resp.offerings[0].arn #=> String
resp.offerings[0].currency_code #=> String
resp.offerings[0].duration #=> Integer
resp.offerings[0].duration_units #=> String, one of "MONTHS"
resp.offerings[0].fixed_price #=> Float
resp.offerings[0].offering_description #=> String
resp.offerings[0].offering_id #=> String
resp.offerings[0].offering_type #=> String, one of "NO_UPFRONT"
resp.offerings[0].region #=> String
resp.offerings[0].resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.offerings[0].resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.offerings[0].resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.offerings[0].resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.offerings[0].resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.offerings[0].resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.offerings[0].resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.offerings[0].resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.offerings[0].usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_class (String)
  • :channel_configuration (String)
  • :codec (String)
  • :duration (String)
  • :max_results (Integer)
  • :maximum_bitrate (String)
  • :maximum_framerate (String)
  • :next_token (String)
  • :resolution (String)
  • :resource_type (String)
  • :special_feature (String)
  • :video_quality (String)

Returns:

See Also:



3397
3398
3399
3400
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3397

def list_offerings(params = {}, options = {})
  req = build_request(:list_offerings, params)
  req.send_request(options)
end

#list_reservations(params = {}) ⇒ Types::ListReservationsResponse

List purchased reservations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_reservations({
  channel_class: "__string",
  codec: "__string",
  max_results: 1,
  maximum_bitrate: "__string",
  maximum_framerate: "__string",
  next_token: "__string",
  resolution: "__string",
  resource_type: "__string",
  special_feature: "__string",
  video_quality: "__string",
})

Response structure


resp.next_token #=> String
resp.reservations #=> Array
resp.reservations[0].arn #=> String
resp.reservations[0].count #=> Integer
resp.reservations[0].currency_code #=> String
resp.reservations[0].duration #=> Integer
resp.reservations[0].duration_units #=> String, one of "MONTHS"
resp.reservations[0].end #=> String
resp.reservations[0].fixed_price #=> Float
resp.reservations[0].name #=> String
resp.reservations[0].offering_description #=> String
resp.reservations[0].offering_id #=> String
resp.reservations[0].offering_type #=> String, one of "NO_UPFRONT"
resp.reservations[0].region #=> String
resp.reservations[0].renewal_settings.automatic_renewal #=> String, one of "DISABLED", "ENABLED", "UNAVAILABLE"
resp.reservations[0].renewal_settings.renewal_count #=> Integer
resp.reservations[0].reservation_id #=> String
resp.reservations[0].resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.reservations[0].resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.reservations[0].resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.reservations[0].resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.reservations[0].resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.reservations[0].resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.reservations[0].resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.reservations[0].resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.reservations[0].start #=> String
resp.reservations[0].state #=> String, one of "ACTIVE", "EXPIRED", "CANCELED", "DELETED"
resp.reservations[0].tags #=> Hash
resp.reservations[0].tags["__string"] #=> String
resp.reservations[0].usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_class (String)
  • :codec (String)
  • :max_results (Integer)
  • :maximum_bitrate (String)
  • :maximum_framerate (String)
  • :next_token (String)
  • :resolution (String)
  • :resource_type (String)
  • :special_feature (String)
  • :video_quality (String)

Returns:

See Also:



3483
3484
3485
3486
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3483

def list_reservations(params = {}, options = {})
  req = build_request(:list_reservations, params)
  req.send_request(options)
end

#list_sdi_sources(params = {}) ⇒ Types::ListSdiSourcesResponse

List all the SdiSources in the AWS account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sdi_sources({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.sdi_sources #=> Array
resp.sdi_sources[0].arn #=> String
resp.sdi_sources[0].id #=> String
resp.sdi_sources[0].inputs #=> Array
resp.sdi_sources[0].inputs[0] #=> String
resp.sdi_sources[0].mode #=> String, one of "QUADRANT", "INTERLEAVE"
resp.sdi_sources[0].name #=> String
resp.sdi_sources[0].state #=> String, one of "IDLE", "IN_USE", "DELETED"
resp.sdi_sources[0].type #=> String, one of "SINGLE", "QUAD"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



7895
7896
7897
7898
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7895

def list_sdi_sources(params = {}, options = {})
  req = build_request(:list_sdi_sources, params)
  req.send_request(options)
end

#list_signal_maps(params = {}) ⇒ Types::ListSignalMapsResponse

Lists signal maps.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_signal_maps({
  cloud_watch_alarm_template_group_identifier: "__string",
  event_bridge_rule_template_group_identifier: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.signal_maps #=> Array
resp.signal_maps[0].arn #=> String
resp.signal_maps[0].created_at #=> Time
resp.signal_maps[0].description #=> String
resp.signal_maps[0].id #=> String
resp.signal_maps[0].modified_at #=> Time
resp.signal_maps[0].monitor_deployment_status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.signal_maps[0].name #=> String
resp.signal_maps[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.signal_maps[0].tags #=> Hash
resp.signal_maps[0].tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cloud_watch_alarm_template_group_identifier (String)
  • :event_bridge_rule_template_group_identifier (String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



5829
5830
5831
5832
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5829

def list_signal_maps(params = {}, options = {})
  req = build_request(:list_signal_maps, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Produces list of tags that have been created for a resource

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



3511
3512
3513
3514
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3511

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_versions(params = {}) ⇒ Types::ListVersionsResponse

Retrieves an array of all the encoder engine versions that are available in this AWS account.

Examples:

Response structure


resp.versions #=> Array
resp.versions[0].expiration_date #=> Time
resp.versions[0].version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



7721
7722
7723
7724
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7721

def list_versions(params = {}, options = {})
  req = build_request(:list_versions, params)
  req.send_request(options)
end

#purchase_offering(params = {}) ⇒ Types::PurchaseOfferingResponse

Purchase an offering and create a reservation.

Examples:

Request syntax with placeholder values


resp = client.purchase_offering({
  count: 1, # required
  name: "__string",
  offering_id: "__string", # required
  renewal_settings: {
    automatic_renewal: "DISABLED", # accepts DISABLED, ENABLED, UNAVAILABLE
    renewal_count: 1,
  },
  request_id: "__string",
  start: "__string",
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.reservation.arn #=> String
resp.reservation.count #=> Integer
resp.reservation.currency_code #=> String
resp.reservation.duration #=> Integer
resp.reservation.duration_units #=> String, one of "MONTHS"
resp.reservation.end #=> String
resp.reservation.fixed_price #=> Float
resp.reservation.name #=> String
resp.reservation.offering_description #=> String
resp.reservation.offering_id #=> String
resp.reservation.offering_type #=> String, one of "NO_UPFRONT"
resp.reservation.region #=> String
resp.reservation.renewal_settings.automatic_renewal #=> String, one of "DISABLED", "ENABLED", "UNAVAILABLE"
resp.reservation.renewal_settings.renewal_count #=> Integer
resp.reservation.reservation_id #=> String
resp.reservation.resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.reservation.resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.reservation.resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.reservation.resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.reservation.resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.reservation.resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.reservation.resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.reservation.resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.reservation.start #=> String
resp.reservation.state #=> String, one of "ACTIVE", "EXPIRED", "CANCELED", "DELETED"
resp.reservation.tags #=> Hash
resp.reservation.tags["__string"] #=> String
resp.reservation.usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :count (required, Integer)
  • :name (String)
  • :offering_id (required, String)
  • :renewal_settings (Types::RenewalSettings) —

    The Renewal settings for Reservations

  • :request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :start (String)
  • :tags (Hash<String,String>)

Returns:

See Also:



3591
3592
3593
3594
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3591

def purchase_offering(params = {}, options = {})
  req = build_request(:purchase_offering, params)
  req.send_request(options)
end

#reboot_input_device(params = {}) ⇒ Struct

Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.

Examples:

Request syntax with placeholder values


resp = client.reboot_input_device({
  force: "NO", # accepts NO, YES
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :force (String) —

    Whether or not to force reboot the input device.

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3619
3620
3621
3622
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3619

def reboot_input_device(params = {}, options = {})
  req = build_request(:reboot_input_device, params)
  req.send_request(options)
end

#reject_input_device_transfer(params = {}) ⇒ Struct

Reject the transfer of the specified input device to your AWS account.

Examples:

Request syntax with placeholder values


resp = client.reject_input_device_transfer({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3640
3641
3642
3643
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3640

def reject_input_device_transfer(params = {}, options = {})
  req = build_request(:reject_input_device_transfer, params)
  req.send_request(options)
end

#restart_channel_pipelines(params = {}) ⇒ Types::RestartChannelPipelinesResponse

Restart pipelines in one channel that is currently running.

Examples:

Request syntax with placeholder values


resp = client.restart_channel_pipelines({
  channel_id: "__string", # required
  pipeline_ids: ["PIPELINE_0"], # accepts PIPELINE_0, PIPELINE_1
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)
  • :pipeline_ids (Array<String>) —

    An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1.

Returns:

See Also:



4782
4783
4784
4785
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4782

def restart_channel_pipelines(params = {}, options = {})
  req = build_request(:restart_channel_pipelines, params)
  req.send_request(options)
end

#start_channel(params = {}) ⇒ Types::StartChannelResponse

Starts an existing channel

Examples:

Request syntax with placeholder values


resp = client.start_channel({
  channel_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)

Returns:

See Also:



3685
3686
3687
3688
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3685

def start_channel(params = {}, options = {})
  req = build_request(:start_channel, params)
  req.send_request(options)
end

#start_delete_monitor_deployment(params = {}) ⇒ Types::StartDeleteMonitorDeploymentResponse

Initiates a deployment to delete the monitor of the specified signal map.

Examples:

Request syntax with placeholder values


resp = client.start_delete_monitor_deployment({
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.cloud_watch_alarm_template_group_ids #=> Array
resp.cloud_watch_alarm_template_group_ids[0] #=> String
resp.created_at #=> Time
resp.description #=> String
resp.discovery_entry_point_arn #=> String
resp.error_message #=> String
resp.event_bridge_rule_template_group_ids #=> Array
resp.event_bridge_rule_template_group_ids[0] #=> String
resp.failed_media_resource_map #=> Hash
resp.failed_media_resource_map["__string"].destinations #=> Array
resp.failed_media_resource_map["__string"].destinations[0].arn #=> String
resp.failed_media_resource_map["__string"].destinations[0].name #=> String
resp.failed_media_resource_map["__string"].name #=> String
resp.failed_media_resource_map["__string"].sources #=> Array
resp.failed_media_resource_map["__string"].sources[0].arn #=> String
resp.failed_media_resource_map["__string"].sources[0].name #=> String
resp.id #=> String
resp.last_discovered_at #=> Time
resp.last_successful_monitor_deployment.details_uri #=> String
resp.last_successful_monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.media_resource_map #=> Hash
resp.media_resource_map["__string"].destinations #=> Array
resp.media_resource_map["__string"].destinations[0].arn #=> String
resp.media_resource_map["__string"].destinations[0].name #=> String
resp.media_resource_map["__string"].name #=> String
resp.media_resource_map["__string"].sources #=> Array
resp.media_resource_map["__string"].sources[0].arn #=> String
resp.media_resource_map["__string"].sources[0].name #=> String
resp.modified_at #=> Time
resp.monitor_changes_pending_deployment #=> Boolean
resp.monitor_deployment.details_uri #=> String
resp.monitor_deployment.error_message #=> String
resp.monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.name #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String)

Returns:

See Also:



5911
5912
5913
5914
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5911

def start_delete_monitor_deployment(params = {}, options = {})
  req = build_request(:start_delete_monitor_deployment, params)
  req.send_request(options)
end

#start_input_device(params = {}) ⇒ Struct

Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)

Examples:

Request syntax with placeholder values


resp = client.start_input_device({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3708
3709
3710
3711
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3708

def start_input_device(params = {}, options = {})
  req = build_request(:start_input_device, params)
  req.send_request(options)
end

#start_input_device_maintenance_window(params = {}) ⇒ Struct

Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.

Examples:

Request syntax with placeholder values


resp = client.start_input_device_maintenance_window({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3737
3738
3739
3740
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3737

def start_input_device_maintenance_window(params = {}, options = {})
  req = build_request(:start_input_device_maintenance_window, params)
  req.send_request(options)
end

#start_monitor_deployment(params = {}) ⇒ Types::StartMonitorDeploymentResponse

Initiates a deployment to deploy the latest monitor of the specified signal map.

Examples:

Request syntax with placeholder values


resp = client.start_monitor_deployment({
  dry_run: false,
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.cloud_watch_alarm_template_group_ids #=> Array
resp.cloud_watch_alarm_template_group_ids[0] #=> String
resp.created_at #=> Time
resp.description #=> String
resp.discovery_entry_point_arn #=> String
resp.error_message #=> String
resp.event_bridge_rule_template_group_ids #=> Array
resp.event_bridge_rule_template_group_ids[0] #=> String
resp.failed_media_resource_map #=> Hash
resp.failed_media_resource_map["__string"].destinations #=> Array
resp.failed_media_resource_map["__string"].destinations[0].arn #=> String
resp.failed_media_resource_map["__string"].destinations[0].name #=> String
resp.failed_media_resource_map["__string"].name #=> String
resp.failed_media_resource_map["__string"].sources #=> Array
resp.failed_media_resource_map["__string"].sources[0].arn #=> String
resp.failed_media_resource_map["__string"].sources[0].name #=> String
resp.id #=> String
resp.last_discovered_at #=> Time
resp.last_successful_monitor_deployment.details_uri #=> String
resp.last_successful_monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.media_resource_map #=> Hash
resp.media_resource_map["__string"].destinations #=> Array
resp.media_resource_map["__string"].destinations[0].arn #=> String
resp.media_resource_map["__string"].destinations[0].name #=> String
resp.media_resource_map["__string"].name #=> String
resp.media_resource_map["__string"].sources #=> Array
resp.media_resource_map["__string"].sources[0].arn #=> String
resp.media_resource_map["__string"].sources[0].name #=> String
resp.modified_at #=> Time
resp.monitor_changes_pending_deployment #=> Boolean
resp.monitor_deployment.details_uri #=> String
resp.monitor_deployment.error_message #=> String
resp.monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.name #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dry_run (Boolean)
  • :identifier (required, String)

Returns:

See Also:



5996
5997
5998
5999
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 5996

def start_monitor_deployment(params = {}, options = {})
  req = build_request(:start_monitor_deployment, params)
  req.send_request(options)
end

#start_multiplex(params = {}) ⇒ Types::StartMultiplexResponse

Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.

Examples:

Request syntax with placeholder values


resp = client.start_multiplex({
  multiplex_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.availability_zones #=> Array
resp.availability_zones[0] #=> String
resp.destinations #=> Array
resp.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.id #=> String
resp.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.name #=> String
resp.pipelines_running_count #=> Integer
resp.program_count #=> Integer
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)

Returns:

See Also:



3789
3790
3791
3792
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3789

def start_multiplex(params = {}, options = {})
  req = build_request(:start_multiplex, params)
  req.send_request(options)
end

#start_update_signal_map(params = {}) ⇒ Types::StartUpdateSignalMapResponse

Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.

Examples:

Request syntax with placeholder values


resp = client.start_update_signal_map({
  cloud_watch_alarm_template_group_identifiers: ["__stringPatternS"],
  description: "__stringMin0Max1024",
  discovery_entry_point_arn: "__stringMin1Max2048",
  event_bridge_rule_template_group_identifiers: ["__stringPatternS"],
  force_rediscovery: false,
  identifier: "__string", # required
  name: "__stringMin1Max255PatternS",
})

Response structure


resp.arn #=> String
resp.cloud_watch_alarm_template_group_ids #=> Array
resp.cloud_watch_alarm_template_group_ids[0] #=> String
resp.created_at #=> Time
resp.description #=> String
resp.discovery_entry_point_arn #=> String
resp.error_message #=> String
resp.event_bridge_rule_template_group_ids #=> Array
resp.event_bridge_rule_template_group_ids[0] #=> String
resp.failed_media_resource_map #=> Hash
resp.failed_media_resource_map["__string"].destinations #=> Array
resp.failed_media_resource_map["__string"].destinations[0].arn #=> String
resp.failed_media_resource_map["__string"].destinations[0].name #=> String
resp.failed_media_resource_map["__string"].name #=> String
resp.failed_media_resource_map["__string"].sources #=> Array
resp.failed_media_resource_map["__string"].sources[0].arn #=> String
resp.failed_media_resource_map["__string"].sources[0].name #=> String
resp.id #=> String
resp.last_discovered_at #=> Time
resp.last_successful_monitor_deployment.details_uri #=> String
resp.last_successful_monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.media_resource_map #=> Hash
resp.media_resource_map["__string"].destinations #=> Array
resp.media_resource_map["__string"].destinations[0].arn #=> String
resp.media_resource_map["__string"].destinations[0].name #=> String
resp.media_resource_map["__string"].name #=> String
resp.media_resource_map["__string"].sources #=> Array
resp.media_resource_map["__string"].sources[0].arn #=> String
resp.media_resource_map["__string"].sources[0].name #=> String
resp.modified_at #=> Time
resp.monitor_changes_pending_deployment #=> Boolean
resp.monitor_deployment.details_uri #=> String
resp.monitor_deployment.error_message #=> String
resp.monitor_deployment.status #=> String, one of "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS"
resp.name #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_REVERTED", "UPDATE_FAILED", "READY", "NOT_READY"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cloud_watch_alarm_template_group_identifiers (Array<String>)
  • :description (String)
  • :discovery_entry_point_arn (String)
  • :event_bridge_rule_template_group_identifiers (Array<String>)
  • :force_rediscovery (Boolean)
  • :identifier (required, String)
  • :name (String)

Returns:

See Also:



6096
6097
6098
6099
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6096

def start_update_signal_map(params = {}, options = {})
  req = build_request(:start_update_signal_map, params)
  req.send_request(options)
end

#stop_channel(params = {}) ⇒ Types::StopChannelResponse

Stops a running channel

Examples:

Request syntax with placeholder values


resp = client.stop_channel({
  channel_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String)

Returns:

See Also:



3834
3835
3836
3837
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3834

def stop_channel(params = {}, options = {})
  req = build_request(:stop_channel, params)
  req.send_request(options)
end

#stop_input_device(params = {}) ⇒ Struct

Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)

Examples:

Request syntax with placeholder values


resp = client.stop_input_device({
  input_device_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3857
3858
3859
3860
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3857

def stop_input_device(params = {}, options = {})
  req = build_request(:stop_input_device, params)
  req.send_request(options)
end

#stop_multiplex(params = {}) ⇒ Types::StopMultiplexResponse

Stops a running multiplex. If the multiplex isn't running, this action has no effect.

Examples:

Request syntax with placeholder values


resp = client.stop_multiplex({
  multiplex_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.availability_zones #=> Array
resp.availability_zones[0] #=> String
resp.destinations #=> Array
resp.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.id #=> String
resp.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.name #=> String
resp.pipelines_running_count #=> Integer
resp.program_count #=> Integer
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)

Returns:

See Also:



3909
3910
3911
3912
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3909

def stop_multiplex(params = {}, options = {})
  req = build_request(:stop_multiplex, params)
  req.send_request(options)
end

#transfer_input_device(params = {}) ⇒ Struct

Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

Examples:

Request syntax with placeholder values


resp = client.transfer_input_device({
  input_device_id: "__string", # required
  target_customer_id: "__string",
  target_region: "__string",
  transfer_message: "__string",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :input_device_id (required, String)
  • :target_customer_id (String)
  • :target_region (String)
  • :transfer_message (String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3940
3941
3942
3943
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3940

def transfer_input_device(params = {}, options = {})
  req = build_request(:transfer_input_device, params)
  req.send_request(options)
end

#update_account_configuration(params = {}) ⇒ Types::UpdateAccountConfigurationResponse

Update account configuration

Examples:

Request syntax with placeholder values


resp = client.({
  account_configuration: {
    kms_key_id: "__string",
  },
})

Response structure


resp..kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3969
3970
3971
3972
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 3969

def (params = {}, options = {})
  req = build_request(:update_account_configuration, params)
  req.send_request(options)
end

#update_channel(params = {}) ⇒ Types::UpdateChannelResponse

Updates a channel.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4028
4029
4030
4031
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4028

def update_channel(params = {}, options = {})
  req = build_request(:update_channel, params)
  req.send_request(options)
end

#update_channel_class(params = {}) ⇒ Types::UpdateChannelClassResponse

Changes the class of the channel.

Examples:

Request syntax with placeholder values


resp = client.update_channel_class({
  channel_class: "STANDARD", # required, accepts STANDARD, SINGLE_PIPELINE
  channel_id: "__string", # required
  destinations: [
    {
      id: "__string",
      media_package_settings: [
        {
          channel_id: "__stringMin1",
          channel_group: "__stringMin1",
          channel_name: "__stringMin1",
          channel_endpoint_id: "__stringMin1",
          media_package_region_name: "__stringMin1",
        },
      ],
      multiplex_settings: {
        multiplex_id: "__stringMin1",
        program_name: "__stringMin1",
      },
      settings: [
        {
          password_param: "__string",
          stream_name: "__string",
          url: "__string",
          username: "__string",
          virtual_source_address: "__string",
        },
      ],
      srt_settings: [
        {
          encryption_passphrase_secret_arn: "__string",
          stream_id: "__string",
          url: "__string",
          connection_mode: "CALLER", # accepts CALLER, LISTENER
          listener_port: 1,
        },
      ],
      logical_interface_names: ["__string"],
      media_connect_router_settings: [
        {
          encryption_type: "AUTOMATIC", # accepts AUTOMATIC, SECRETS_MANAGER
          secret_arn: "__string",
        },
      ],
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_class (required, String) —

    A standard channel has two encoding pipelines and a single pipeline channel only has one.

  • :channel_id (required, String)
  • :destinations (Array<Types::OutputDestination>)

Returns:

See Also:



4101
4102
4103
4104
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4101

def update_channel_class(params = {}, options = {})
  req = build_request(:update_channel_class, params)
  req.send_request(options)
end

#update_channel_placement_group(params = {}) ⇒ Types::UpdateChannelPlacementGroupResponse

Change the settings for a ChannelPlacementGroup.

Examples:

Request syntax with placeholder values


resp = client.update_channel_placement_group({
  channel_placement_group_id: "__string", # required
  cluster_id: "__string", # required
  name: "__string",
  nodes: ["__string"],
})

Response structure


resp.arn #=> String
resp.channels #=> Array
resp.channels[0] #=> String
resp.cluster_id #=> String
resp.id #=> String
resp.name #=> String
resp.nodes #=> Array
resp.nodes[0] #=> String
resp.state #=> String, one of "UNASSIGNED", "ASSIGNING", "ASSIGNED", "DELETING", "DELETE_FAILED", "DELETED", "UNASSIGNING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_placement_group_id (required, String)
  • :cluster_id (required, String)
  • :name (String) —

    Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.

  • :nodes (Array<String>) —

    Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.

Returns:

See Also:



7414
7415
7416
7417
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7414

def update_channel_placement_group(params = {}, options = {})
  req = build_request(:update_channel_placement_group, params)
  req.send_request(options)
end

#update_cloud_watch_alarm_template(params = {}) ⇒ Types::UpdateCloudWatchAlarmTemplateResponse

Updates the specified cloudwatch alarm template.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_watch_alarm_template({
  comparison_operator: "GreaterThanOrEqualToThreshold", # accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
  datapoints_to_alarm: 1,
  description: "__stringMin0Max1024",
  evaluation_periods: 1,
  group_identifier: "__stringPatternS",
  identifier: "__string", # required
  metric_name: "__stringMax64",
  name: "__stringMin1Max255PatternS",
  period: 1,
  statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
  target_resource_type: "CLOUDFRONT_DISTRIBUTION", # accepts CLOUDFRONT_DISTRIBUTION, MEDIALIVE_MULTIPLEX, MEDIALIVE_CHANNEL, MEDIALIVE_INPUT_DEVICE, MEDIAPACKAGE_CHANNEL, MEDIAPACKAGE_ORIGIN_ENDPOINT, MEDIACONNECT_FLOW, S3_BUCKET, MEDIATAILOR_PLAYBACK_CONFIGURATION
  threshold: 1.0,
  treat_missing_data: "notBreaching", # accepts notBreaching, breaching, ignore, missing
})

Response structure


resp.arn #=> String
resp.comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
resp.created_at #=> Time
resp.datapoints_to_alarm #=> Integer
resp.description #=> String
resp.evaluation_periods #=> Integer
resp.group_id #=> String
resp.id #=> String
resp.metric_name #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.period #=> Integer
resp.statistic #=> String, one of "SampleCount", "Average", "Sum", "Minimum", "Maximum"
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.target_resource_type #=> String, one of "CLOUDFRONT_DISTRIBUTION", "MEDIALIVE_MULTIPLEX", "MEDIALIVE_CHANNEL", "MEDIALIVE_INPUT_DEVICE", "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", "S3_BUCKET", "MEDIATAILOR_PLAYBACK_CONFIGURATION"
resp.threshold #=> Float
resp.treat_missing_data #=> String, one of "notBreaching", "breaching", "ignore", "missing"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :comparison_operator (String) —

    The comparison operator used to compare the specified statistic and the threshold.

  • :datapoints_to_alarm (Integer)
  • :description (String)
  • :evaluation_periods (Integer)
  • :group_identifier (String)
  • :identifier (required, String)
  • :metric_name (String)
  • :name (String)
  • :period (Integer)
  • :statistic (String) —

    The statistic to apply to the alarm's metric data.

  • :target_resource_type (String) —

    The resource type this template should dynamically generate cloudwatch metric alarms for.

  • :threshold (Float)
  • :treat_missing_data (String) —

    Specifies how missing data points are treated when evaluating the alarm's condition.

Returns:

See Also:



6199
6200
6201
6202
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6199

def update_cloud_watch_alarm_template(params = {}, options = {})
  req = build_request(:update_cloud_watch_alarm_template, params)
  req.send_request(options)
end

#update_cloud_watch_alarm_template_group(params = {}) ⇒ Types::UpdateCloudWatchAlarmTemplateGroupResponse

Updates the specified cloudwatch alarm template group.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_watch_alarm_template_group({
  description: "__stringMin0Max1024",
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :identifier (required, String)

Returns:

See Also:



6242
6243
6244
6245
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6242

def update_cloud_watch_alarm_template_group(params = {}, options = {})
  req = build_request(:update_cloud_watch_alarm_template_group, params)
  req.send_request(options)
end

#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse

Change the settings for a Cluster.

Examples:

Request syntax with placeholder values


resp = client.update_cluster({
  cluster_id: "__string", # required
  name: "__string",
  network_settings: {
    default_route: "__string",
    interface_mappings: [
      {
        logical_interface_name: "__string",
        network_id: "__string",
      },
    ],
  },
})

Response structure


resp.arn #=> String
resp.channel_ids #=> Array
resp.channel_ids[0] #=> String
resp.cluster_type #=> String, one of "ON_PREMISES"
resp.id #=> String
resp.name #=> String
resp.network_settings.default_route #=> String
resp.network_settings.interface_mappings #=> Array
resp.network_settings.interface_mappings[0].logical_interface_name #=> String
resp.network_settings.interface_mappings[0].network_id #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :name (String) —

    Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can't change the name. Names are case-sensitive.

  • :network_settings (Types::ClusterNetworkSettingsUpdateRequest) —

    Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with.

Returns:

See Also:



7477
7478
7479
7480
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7477

def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

#update_event_bridge_rule_template(params = {}) ⇒ Types::UpdateEventBridgeRuleTemplateResponse

Updates the specified eventbridge rule template.

Examples:

Request syntax with placeholder values


resp = client.update_event_bridge_rule_template({
  description: "__stringMin0Max1024",
  event_targets: [
    {
      arn: "__stringMin1Max2048PatternArn", # required
    },
  ],
  event_type: "MEDIALIVE_MULTIPLEX_ALERT", # accepts MEDIALIVE_MULTIPLEX_ALERT, MEDIALIVE_MULTIPLEX_STATE_CHANGE, MEDIALIVE_CHANNEL_ALERT, MEDIALIVE_CHANNEL_INPUT_CHANGE, MEDIALIVE_CHANNEL_STATE_CHANGE, MEDIAPACKAGE_INPUT_NOTIFICATION, MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION, MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION, SIGNAL_MAP_ACTIVE_ALARM, MEDIACONNECT_ALERT, MEDIACONNECT_SOURCE_HEALTH, MEDIACONNECT_OUTPUT_HEALTH, MEDIACONNECT_FLOW_STATUS_CHANGE
  group_identifier: "__stringPatternS",
  identifier: "__string", # required
  name: "__stringMin1Max255PatternS",
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.event_targets #=> Array
resp.event_targets[0].arn #=> String
resp.event_type #=> String, one of "MEDIALIVE_MULTIPLEX_ALERT", "MEDIALIVE_MULTIPLEX_STATE_CHANGE", "MEDIALIVE_CHANNEL_ALERT", "MEDIALIVE_CHANNEL_INPUT_CHANGE", "MEDIALIVE_CHANNEL_STATE_CHANGE", "MEDIAPACKAGE_INPUT_NOTIFICATION", "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", "SIGNAL_MAP_ACTIVE_ALARM", "MEDIACONNECT_ALERT", "MEDIACONNECT_SOURCE_HEALTH", "MEDIACONNECT_OUTPUT_HEALTH", "MEDIACONNECT_FLOW_STATUS_CHANGE"
resp.group_id #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :event_targets (Array<Types::EventBridgeRuleTemplateTarget>)
  • :event_type (String) —

    The type of event to match with the rule.

  • :group_identifier (String)
  • :identifier (required, String)
  • :name (String)

Returns:

See Also:



6309
6310
6311
6312
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6309

def update_event_bridge_rule_template(params = {}, options = {})
  req = build_request(:update_event_bridge_rule_template, params)
  req.send_request(options)
end

#update_event_bridge_rule_template_group(params = {}) ⇒ Types::UpdateEventBridgeRuleTemplateGroupResponse

Updates the specified eventbridge rule template group.

Examples:

Request syntax with placeholder values


resp = client.update_event_bridge_rule_template_group({
  description: "__stringMin0Max1024",
  identifier: "__string", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.id #=> String
resp.modified_at #=> Time
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String)
  • :identifier (required, String)

Returns:

See Also:



6352
6353
6354
6355
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 6352

def update_event_bridge_rule_template_group(params = {}, options = {})
  req = build_request(:update_event_bridge_rule_template_group, params)
  req.send_request(options)
end

#update_input(params = {}) ⇒ Types::UpdateInputResponse

Updates an input.

Examples:

Request syntax with placeholder values


resp = client.update_input({
  destinations: [
    {
      stream_name: "__string",
      network: "__string",
      network_routes: [
        {
          cidr: "__string",
          gateway: "__string",
        },
      ],
      static_ip_address: "__string",
    },
  ],
  input_devices: [
    {
      id: "__string",
    },
  ],
  input_id: "__string", # required
  input_security_groups: ["__string"],
  media_connect_flows: [
    {
      flow_arn: "__string",
    },
  ],
  name: "__string",
  role_arn: "__string",
  sources: [
    {
      password_param: "__string",
      url: "__string",
      username: "__string",
    },
  ],
  srt_settings: {
    srt_caller_sources: [
      {
        decryption: {
          algorithm: "AES128", # accepts AES128, AES192, AES256
          passphrase_secret_arn: "__string",
        },
        minimum_latency: 1,
        srt_listener_address: "__string",
        srt_listener_port: "__string",
        stream_id: "__string",
      },
    ],
    srt_listener_settings: {
      decryption: { # required
        algorithm: "AES128", # required, accepts AES128, AES192, AES256
        passphrase_secret_arn: "__string", # required
      },
      minimum_latency: 1, # required
      stream_id: "__string",
    },
  },
  multicast_settings: {
    sources: [
      {
        source_ip: "__string",
        url: "__string", # required
      },
    ],
  },
  smpte_2110_receiver_group_settings: {
    smpte_2110_receiver_groups: [
      {
        sdp_settings: {
          ancillary_sdps: [
            {
              media_index: 1,
              sdp_url: "__string",
            },
          ],
          audio_sdps: [
            {
              media_index: 1,
              sdp_url: "__string",
            },
          ],
          video_sdp: {
            media_index: 1,
            sdp_url: "__string",
          },
        },
      },
    ],
  },
  sdi_sources: ["__string"],
  special_router_settings: {
    router_arn: "__string",
  },
})

Response structure


resp.input.arn #=> String
resp.input.attached_channels #=> Array
resp.input.attached_channels[0] #=> String
resp.input.destinations #=> Array
resp.input.destinations[0].ip #=> String
resp.input.destinations[0].port #=> String
resp.input.destinations[0].url #=> String
resp.input.destinations[0].vpc.availability_zone #=> String
resp.input.destinations[0].vpc.network_interface_id #=> String
resp.input.destinations[0].network #=> String
resp.input.destinations[0].network_routes #=> Array
resp.input.destinations[0].network_routes[0].cidr #=> String
resp.input.destinations[0].network_routes[0].gateway #=> String
resp.input.id #=> String
resp.input.input_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.input.input_devices #=> Array
resp.input.input_devices[0].id #=> String
resp.input.input_partner_ids #=> Array
resp.input.input_partner_ids[0] #=> String
resp.input.input_source_type #=> String, one of "STATIC", "DYNAMIC"
resp.input.media_connect_flows #=> Array
resp.input.media_connect_flows[0].flow_arn #=> String
resp.input.name #=> String
resp.input.role_arn #=> String
resp.input.security_groups #=> Array
resp.input.security_groups[0] #=> String
resp.input.sources #=> Array
resp.input.sources[0].password_param #=> String
resp.input.sources[0].url #=> String
resp.input.sources[0].username #=> String
resp.input.state #=> String, one of "CREATING", "DETACHED", "ATTACHED", "DELETING", "DELETED"
resp.input.tags #=> Hash
resp.input.tags["__string"] #=> String
resp.input.type #=> String, one of "UDP_PUSH", "RTP_PUSH", "RTMP_PUSH", "RTMP_PULL", "URL_PULL", "MP4_FILE", "MEDIACONNECT", "INPUT_DEVICE", "AWS_CDI", "TS_FILE", "SRT_CALLER", "MULTICAST", "SMPTE_2110_RECEIVER_GROUP", "SDI", "MEDIACONNECT_ROUTER", "SRT_LISTENER"
resp.input.srt_settings.srt_caller_sources #=> Array
resp.input.srt_settings.srt_caller_sources[0].decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_caller_sources[0].decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_caller_sources[0].minimum_latency #=> Integer
resp.input.srt_settings.srt_caller_sources[0].srt_listener_address #=> String
resp.input.srt_settings.srt_caller_sources[0].srt_listener_port #=> String
resp.input.srt_settings.srt_caller_sources[0].stream_id #=> String
resp.input.srt_settings.srt_listener_settings.decryption.algorithm #=> String, one of "AES128", "AES192", "AES256"
resp.input.srt_settings.srt_listener_settings.decryption.passphrase_secret_arn #=> String
resp.input.srt_settings.srt_listener_settings.minimum_latency #=> Integer
resp.input.srt_settings.srt_listener_settings.stream_id #=> String
resp.input.input_network_location #=> String, one of "AWS", "ON_PREMISES"
resp.input.multicast_settings.sources #=> Array
resp.input.multicast_settings.sources[0].source_ip #=> String
resp.input.multicast_settings.sources[0].url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.ancillary_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps #=> Array
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.audio_sdps[0].sdp_url #=> String
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.media_index #=> Integer
resp.input.smpte_2110_receiver_group_settings.smpte_2110_receiver_groups[0].sdp_settings.video_sdp.sdp_url #=> String
resp.input.sdi_sources #=> Array
resp.input.sdi_sources[0] #=> String
resp.input.router_settings.destinations #=> Array
resp.input.router_settings.destinations[0].availability_zone_name #=> String
resp.input.router_settings.destinations[0].router_output_arn #=> String
resp.input.router_settings.encryption_type #=> String, one of "AUTOMATIC", "SECRETS_MANAGER"
resp.input.router_settings.secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destinations (Array<Types::InputDestinationRequest>)
  • :input_devices (Array<Types::InputDeviceRequest>)
  • :input_id (required, String)
  • :input_security_groups (Array<String>)
  • :media_connect_flows (Array<Types::MediaConnectFlowRequest>)
  • :name (String)
  • :role_arn (String)
  • :sources (Array<Types::InputSourceRequest>)
  • :srt_settings (Types::SrtSettingsRequest) —

    Configures the settings for SRT inputs. Provide either srtCallerSources (for SRT_CALLER type) OR srtListenerSettings (for SRT_LISTENER type), not both.

  • :multicast_settings (Types::MulticastSettingsUpdateRequest) —

    Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.

  • :smpte_2110_receiver_group_settings (Types::Smpte2110ReceiverGroupSettings) —

    Configures the sources for the SMPTE 2110 Receiver Group input.

  • :sdi_sources (Array<String>) —

    SDI Sources for this Input.

  • :special_router_settings (Types::SpecialRouterSettings) —

    When using MediaConnect Router as the source of a MediaLive input there's a special handoff that occurs when a router output is created. This group of settings is set on your behalf by the MediaConnect Router service using this set of settings. This setting object can only by used by that service.

Returns:

See Also:



4319
4320
4321
4322
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4319

def update_input(params = {}, options = {})
  req = build_request(:update_input, params)
  req.send_request(options)
end

#update_input_device(params = {}) ⇒ Types::UpdateInputDeviceResponse

Updates the parameters for the input device.

Examples:

Request syntax with placeholder values


resp = client.update_input_device({
  hd_device_settings: {
    configured_input: "AUTO", # accepts AUTO, HDMI, SDI
    max_bitrate: 1,
    latency_ms: 1,
    codec: "HEVC", # accepts HEVC, AVC
    mediaconnect_settings: {
      flow_arn: "__string",
      role_arn: "__string",
      secret_arn: "__string",
      source_name: "__string",
    },
    audio_channel_pairs: [
      {
        id: 1,
        profile: "DISABLED", # accepts DISABLED, VBR-AAC_HHE-16000, VBR-AAC_HE-64000, VBR-AAC_LC-128000, CBR-AAC_HQ-192000, CBR-AAC_HQ-256000, CBR-AAC_HQ-384000, CBR-AAC_HQ-512000
      },
    ],
    input_resolution: "__string",
  },
  input_device_id: "__string", # required
  name: "__string",
  uhd_device_settings: {
    configured_input: "AUTO", # accepts AUTO, HDMI, SDI
    max_bitrate: 1,
    latency_ms: 1,
    codec: "HEVC", # accepts HEVC, AVC
    mediaconnect_settings: {
      flow_arn: "__string",
      role_arn: "__string",
      secret_arn: "__string",
      source_name: "__string",
    },
    audio_channel_pairs: [
      {
        id: 1,
        profile: "DISABLED", # accepts DISABLED, VBR-AAC_HHE-16000, VBR-AAC_HE-64000, VBR-AAC_LC-128000, CBR-AAC_HQ-192000, CBR-AAC_HQ-256000, CBR-AAC_HQ-384000, CBR-AAC_HQ-512000
      },
    ],
    input_resolution: "__string",
  },
  availability_zone: "__string",
})

Response structure


resp.arn #=> String
resp.connection_state #=> String, one of "DISCONNECTED", "CONNECTED"
resp.device_settings_sync_state #=> String, one of "SYNCED", "SYNCING"
resp.device_update_status #=> String, one of "UP_TO_DATE", "NOT_UP_TO_DATE", "UPDATING"
resp.hd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.hd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.hd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.hd_device_settings.framerate #=> Float
resp.hd_device_settings.height #=> Integer
resp.hd_device_settings.max_bitrate #=> Integer
resp.hd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.hd_device_settings.width #=> Integer
resp.hd_device_settings.latency_ms #=> Integer
resp.id #=> String
resp.mac_address #=> String
resp.name #=> String
resp.network_settings.dns_addresses #=> Array
resp.network_settings.dns_addresses[0] #=> String
resp.network_settings.gateway #=> String
resp.network_settings.ip_address #=> String
resp.network_settings.ip_scheme #=> String, one of "STATIC", "DHCP"
resp.network_settings.subnet_mask #=> String
resp.serial_number #=> String
resp.type #=> String, one of "HD", "UHD"
resp.uhd_device_settings.active_input #=> String, one of "HDMI", "SDI"
resp.uhd_device_settings.configured_input #=> String, one of "AUTO", "HDMI", "SDI"
resp.uhd_device_settings.device_state #=> String, one of "IDLE", "STREAMING"
resp.uhd_device_settings.framerate #=> Float
resp.uhd_device_settings.height #=> Integer
resp.uhd_device_settings.max_bitrate #=> Integer
resp.uhd_device_settings.scan_type #=> String, one of "INTERLACED", "PROGRESSIVE"
resp.uhd_device_settings.width #=> Integer
resp.uhd_device_settings.latency_ms #=> Integer
resp.uhd_device_settings.codec #=> String, one of "HEVC", "AVC"
resp.uhd_device_settings.mediaconnect_settings.flow_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.role_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.secret_arn #=> String
resp.uhd_device_settings.mediaconnect_settings.source_name #=> String
resp.uhd_device_settings.audio_channel_pairs #=> Array
resp.uhd_device_settings.audio_channel_pairs[0].id #=> Integer
resp.uhd_device_settings.audio_channel_pairs[0].profile #=> String, one of "DISABLED", "VBR-AAC_HHE-16000", "VBR-AAC_HE-64000", "VBR-AAC_LC-128000", "CBR-AAC_HQ-192000", "CBR-AAC_HQ-256000", "CBR-AAC_HQ-384000", "CBR-AAC_HQ-512000"
resp.uhd_device_settings.input_resolution #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.availability_zone #=> String
resp.medialive_input_arns #=> Array
resp.medialive_input_arns[0] #=> String
resp.output_type #=> String, one of "NONE", "MEDIALIVE_INPUT", "MEDIACONNECT_FLOW"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4458
4459
4460
4461
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4458

def update_input_device(params = {}, options = {})
  req = build_request(:update_input_device, params)
  req.send_request(options)
end

#update_input_security_group(params = {}) ⇒ Types::UpdateInputSecurityGroupResponse

Update an Input Security Group's Whilelists.

Examples:

Request syntax with placeholder values


resp = client.update_input_security_group({
  input_security_group_id: "__string", # required
  tags: {
    "__string" => "__string",
  },
  whitelist_rules: [
    {
      cidr: "__string",
    },
  ],
})

Response structure


resp.security_group.arn #=> String
resp.security_group.id #=> String
resp.security_group.inputs #=> Array
resp.security_group.inputs[0] #=> String
resp.security_group.state #=> String, one of "IDLE", "IN_USE", "UPDATING", "DELETED"
resp.security_group.tags #=> Hash
resp.security_group.tags["__string"] #=> String
resp.security_group.whitelist_rules #=> Array
resp.security_group.whitelist_rules[0].cidr #=> String
resp.security_group.channels #=> Array
resp.security_group.channels[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4507
4508
4509
4510
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4507

def update_input_security_group(params = {}, options = {})
  req = build_request(:update_input_security_group, params)
  req.send_request(options)
end

#update_multiplex(params = {}) ⇒ Types::UpdateMultiplexResponse

Updates a multiplex.

Examples:

Request syntax with placeholder values


resp = client.update_multiplex({
  multiplex_id: "__string", # required
  multiplex_settings: {
    maximum_video_buffer_delay_milliseconds: 1,
    transport_stream_bitrate: 1, # required
    transport_stream_id: 1, # required
    transport_stream_reserved_bitrate: 1,
  },
  name: "__string",
  packet_identifiers_mapping: {
    "__string" => {
      audio_pids: [1],
      dvb_sub_pids: [1],
      dvb_teletext_pid: 1,
      etv_platform_pid: 1,
      etv_signal_pid: 1,
      klv_data_pids: [1],
      pcr_pid: 1,
      pmt_pid: 1,
      private_metadata_pid: 1,
      scte_27_pids: [1],
      scte_35_pid: 1,
      timed_metadata_pid: 1,
      video_pid: 1,
      arib_captions_pid: 1,
      dvb_teletext_pids: [1],
      ecm_pid: 1,
      smpte_2038_pid: 1,
    },
  },
})

Response structure


resp.multiplex.arn #=> String
resp.multiplex.availability_zones #=> Array
resp.multiplex.availability_zones[0] #=> String
resp.multiplex.destinations #=> Array
resp.multiplex.destinations[0].media_connect_settings.entitlement_arn #=> String
resp.multiplex.id #=> String
resp.multiplex.multiplex_settings.maximum_video_buffer_delay_milliseconds #=> Integer
resp.multiplex.multiplex_settings.transport_stream_bitrate #=> Integer
resp.multiplex.multiplex_settings.transport_stream_id #=> Integer
resp.multiplex.multiplex_settings.transport_stream_reserved_bitrate #=> Integer
resp.multiplex.name #=> String
resp.multiplex.pipelines_running_count #=> Integer
resp.multiplex.program_count #=> Integer
resp.multiplex.state #=> String, one of "CREATING", "CREATE_FAILED", "IDLE", "STARTING", "RUNNING", "RECOVERING", "STOPPING", "DELETING", "DELETED"
resp.multiplex.tags #=> Hash
resp.multiplex.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4584
4585
4586
4587
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4584

def update_multiplex(params = {}, options = {})
  req = build_request(:update_multiplex, params)
  req.send_request(options)
end

#update_multiplex_program(params = {}) ⇒ Types::UpdateMultiplexProgramResponse

Update a program in a multiplex.

Examples:

Request syntax with placeholder values


resp = client.update_multiplex_program({
  multiplex_id: "__string", # required
  multiplex_program_settings: {
    preferred_channel_pipeline: "CURRENTLY_ACTIVE", # accepts CURRENTLY_ACTIVE, PIPELINE_0, PIPELINE_1
    program_number: 1, # required
    service_descriptor: {
      provider_name: "__stringMax256", # required
      service_name: "__stringMax256", # required
    },
    video_settings: {
      constant_bitrate: 1,
      statmux_settings: {
        maximum_bitrate: 1,
        minimum_bitrate: 1,
        priority: 1,
      },
    },
  },
  program_name: "__string", # required
})

Response structure


resp.multiplex_program.channel_id #=> String
resp.multiplex_program.multiplex_program_settings.preferred_channel_pipeline #=> String, one of "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1"
resp.multiplex_program.multiplex_program_settings.program_number #=> Integer
resp.multiplex_program.multiplex_program_settings.service_descriptor.provider_name #=> String
resp.multiplex_program.multiplex_program_settings.service_descriptor.service_name #=> String
resp.multiplex_program.multiplex_program_settings.video_settings.constant_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.maximum_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.minimum_bitrate #=> Integer
resp.multiplex_program.multiplex_program_settings.video_settings.statmux_settings.priority #=> Integer
resp.multiplex_program.packet_identifiers_map.audio_pids #=> Array
resp.multiplex_program.packet_identifiers_map.audio_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_sub_pids #=> Array
resp.multiplex_program.packet_identifiers_map.dvb_sub_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.etv_platform_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.etv_signal_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.klv_data_pids #=> Array
resp.multiplex_program.packet_identifiers_map.klv_data_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.pcr_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.pmt_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.private_metadata_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.scte_27_pids #=> Array
resp.multiplex_program.packet_identifiers_map.scte_27_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.scte_35_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.timed_metadata_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.video_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.arib_captions_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pids #=> Array
resp.multiplex_program.packet_identifiers_map.dvb_teletext_pids[0] #=> Integer
resp.multiplex_program.packet_identifiers_map.ecm_pid #=> Integer
resp.multiplex_program.packet_identifiers_map.smpte_2038_pid #=> Integer
resp.multiplex_program.pipeline_details #=> Array
resp.multiplex_program.pipeline_details[0].active_channel_pipeline #=> String
resp.multiplex_program.pipeline_details[0].pipeline_id #=> String
resp.multiplex_program.program_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :multiplex_id (required, String)
  • :multiplex_program_settings (Types::MultiplexProgramSettings) —

    Multiplex Program settings configuration.

  • :program_name (required, String)

Returns:

See Also:



4667
4668
4669
4670
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4667

def update_multiplex_program(params = {}, options = {})
  req = build_request(:update_multiplex_program, params)
  req.send_request(options)
end

#update_network(params = {}) ⇒ Types::UpdateNetworkResponse

Change the settings for a Network.

Examples:

Request syntax with placeholder values


resp = client.update_network({
  ip_pools: [
    {
      cidr: "__string",
    },
  ],
  name: "__string",
  network_id: "__string", # required
  routes: [
    {
      cidr: "__string",
      gateway: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.associated_cluster_ids #=> Array
resp.associated_cluster_ids[0] #=> String
resp.id #=> String
resp.ip_pools #=> Array
resp.ip_pools[0].cidr #=> String
resp.name #=> String
resp.routes #=> Array
resp.routes[0].cidr #=> String
resp.routes[0].gateway #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "IDLE", "IN_USE", "UPDATING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ip_pools (Array<Types::IpPoolUpdateRequest>) —

    Include this parameter only if you want to change the pool of IP addresses in the network. An array of IpPoolCreateRequests that identify a collection of IP addresses in this network that you want to reserve for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPoolUpdateRequest specifies one CIDR block.

  • :name (String) —

    Include this parameter only if you want to change the name of the Network. Specify a name that is unique in the AWS account. Names are case-sensitive.

  • :network_id (required, String)
  • :routes (Array<Types::RouteUpdateRequest>) —

    Include this parameter only if you want to change or add routes in the Network. An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic.

Returns:

See Also:



7551
7552
7553
7554
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7551

def update_network(params = {}, options = {})
  req = build_request(:update_network, params)
  req.send_request(options)
end

#update_node(params = {}) ⇒ Types::UpdateNodeResponse

Change the settings for a Node.

Examples:

Request syntax with placeholder values


resp = client.update_node({
  cluster_id: "__string", # required
  name: "__string",
  node_id: "__string", # required
  role: "BACKUP", # accepts BACKUP, ACTIVE
  sdi_source_mappings: [
    {
      card_number: 1,
      channel_number: 1,
      sdi_source: "__string",
    },
  ],
})

Response structure


resp.arn #=> String
resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0] #=> String
resp.cluster_id #=> String
resp.connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.id #=> String
resp.instance_arn #=> String
resp.name #=> String
resp.node_interface_mappings #=> Array
resp.node_interface_mappings[0].logical_interface_name #=> String
resp.node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.node_interface_mappings[0].physical_interface_name #=> String
resp.node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.role #=> String, one of "BACKUP", "ACTIVE"
resp.state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.sdi_source_mappings #=> Array
resp.sdi_source_mappings[0].card_number #=> Integer
resp.sdi_source_mappings[0].channel_number #=> Integer
resp.sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :name (String) —

    Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.

  • :node_id (required, String)
  • :role (String) —

    The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

  • :sdi_source_mappings (Array<Types::SdiSourceMappingUpdateRequest>) —

    The mappings of a SDI capture card port to a logical SDI data stream

Returns:

See Also:



7632
7633
7634
7635
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7632

def update_node(params = {}, options = {})
  req = build_request(:update_node, params)
  req.send_request(options)
end

#update_node_state(params = {}) ⇒ Types::UpdateNodeStateResponse

Update the state of a node.

Examples:

Request syntax with placeholder values


resp = client.update_node_state({
  cluster_id: "__string", # required
  node_id: "__string", # required
  state: "ACTIVE", # accepts ACTIVE, DRAINING
})

Response structure


resp.arn #=> String
resp.channel_placement_groups #=> Array
resp.channel_placement_groups[0] #=> String
resp.cluster_id #=> String
resp.connection_state #=> String, one of "CONNECTED", "DISCONNECTED"
resp.id #=> String
resp.instance_arn #=> String
resp.name #=> String
resp.node_interface_mappings #=> Array
resp.node_interface_mappings[0].logical_interface_name #=> String
resp.node_interface_mappings[0].network_interface_mode #=> String, one of "NAT", "BRIDGE"
resp.node_interface_mappings[0].physical_interface_name #=> String
resp.node_interface_mappings[0].physical_interface_ip_addresses #=> Array
resp.node_interface_mappings[0].physical_interface_ip_addresses[0] #=> String
resp.role #=> String, one of "BACKUP", "ACTIVE"
resp.state #=> String, one of "CREATED", "REGISTERING", "READY_TO_ACTIVATE", "REGISTRATION_FAILED", "ACTIVATION_FAILED", "ACTIVE", "READY", "IN_USE", "DEREGISTERING", "DRAINING", "DEREGISTRATION_FAILED", "DEREGISTERED"
resp.sdi_source_mappings #=> Array
resp.sdi_source_mappings[0].card_number #=> Integer
resp.sdi_source_mappings[0].channel_number #=> Integer
resp.sdi_source_mappings[0].sdi_source #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_id (required, String)
  • :node_id (required, String)
  • :state (String) —

    The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.

Returns:

See Also:



7699
7700
7701
7702
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7699

def update_node_state(params = {}, options = {})
  req = build_request(:update_node_state, params)
  req.send_request(options)
end

#update_reservation(params = {}) ⇒ Types::UpdateReservationResponse

Update reservation.

Examples:

Request syntax with placeholder values


resp = client.update_reservation({
  name: "__string",
  renewal_settings: {
    automatic_renewal: "DISABLED", # accepts DISABLED, ENABLED, UNAVAILABLE
    renewal_count: 1,
  },
  reservation_id: "__string", # required
})

Response structure


resp.reservation.arn #=> String
resp.reservation.count #=> Integer
resp.reservation.currency_code #=> String
resp.reservation.duration #=> Integer
resp.reservation.duration_units #=> String, one of "MONTHS"
resp.reservation.end #=> String
resp.reservation.fixed_price #=> Float
resp.reservation.name #=> String
resp.reservation.offering_description #=> String
resp.reservation.offering_id #=> String
resp.reservation.offering_type #=> String, one of "NO_UPFRONT"
resp.reservation.region #=> String
resp.reservation.renewal_settings.automatic_renewal #=> String, one of "DISABLED", "ENABLED", "UNAVAILABLE"
resp.reservation.renewal_settings.renewal_count #=> Integer
resp.reservation.reservation_id #=> String
resp.reservation.resource_specification.channel_class #=> String, one of "STANDARD", "SINGLE_PIPELINE"
resp.reservation.resource_specification.codec #=> String, one of "MPEG2", "AVC", "HEVC", "AUDIO", "LINK", "AV1"
resp.reservation.resource_specification.maximum_bitrate #=> String, one of "MAX_10_MBPS", "MAX_20_MBPS", "MAX_50_MBPS"
resp.reservation.resource_specification.maximum_framerate #=> String, one of "MAX_30_FPS", "MAX_60_FPS"
resp.reservation.resource_specification.resolution #=> String, one of "SD", "HD", "FHD", "UHD"
resp.reservation.resource_specification.resource_type #=> String, one of "INPUT", "OUTPUT", "MULTIPLEX", "CHANNEL"
resp.reservation.resource_specification.special_feature #=> String, one of "ADVANCED_AUDIO", "AUDIO_NORMALIZATION", "MGHD", "MGUHD"
resp.reservation.resource_specification.video_quality #=> String, one of "STANDARD", "ENHANCED", "PREMIUM"
resp.reservation.start #=> String
resp.reservation.state #=> String, one of "ACTIVE", "EXPIRED", "CANCELED", "DELETED"
resp.reservation.tags #=> Hash
resp.reservation.tags["__string"] #=> String
resp.reservation.usage_price #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String)
  • :renewal_settings (Types::RenewalSettings) —

    The Renewal settings for Reservations

  • :reservation_id (required, String)

Returns:

See Also:



4731
4732
4733
4734
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 4731

def update_reservation(params = {}, options = {})
  req = build_request(:update_reservation, params)
  req.send_request(options)
end

#update_sdi_source(params = {}) ⇒ Types::UpdateSdiSourceResponse

Change some of the settings in an SdiSource.

Examples:

Request syntax with placeholder values


resp = client.update_sdi_source({
  mode: "QUADRANT", # accepts QUADRANT, INTERLEAVE
  name: "__string",
  sdi_source_id: "__string", # required
  type: "SINGLE", # accepts SINGLE, QUAD
})

Response structure


resp.sdi_source.arn #=> String
resp.sdi_source.id #=> String
resp.sdi_source.inputs #=> Array
resp.sdi_source.inputs[0] #=> String
resp.sdi_source.mode #=> String, one of "QUADRANT", "INTERLEAVE"
resp.sdi_source.name #=> String
resp.sdi_source.state #=> String, one of "IDLE", "IN_USE", "DELETED"
resp.sdi_source.type #=> String, one of "SINGLE", "QUAD"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mode (String) —

    Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.

  • :name (String) —

    Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.

  • :sdi_source_id (required, String)
  • :type (String) —

    Include this parameter only if you want to change the mode. Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.

Returns:

See Also:



7949
7950
7951
7952
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 7949

def update_sdi_source(params = {}, options = {})
  req = build_request(:update_sdi_source, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
channel_created #describe_channel 3 5
channel_deleted #describe_channel 5 84
channel_placement_group_assigned #describe_channel_placement_group 3 5
channel_placement_group_deleted #describe_channel_placement_group 5 20
channel_placement_group_unassigned #describe_channel_placement_group 5 20
channel_running #describe_channel 5 120
channel_stopped #describe_channel 5 60
cluster_created #describe_cluster 3 5
cluster_deleted #describe_cluster 5 20
input_attached #describe_input 5 20
input_deleted #describe_input 5 20
input_detached #describe_input 5 84
multiplex_created #describe_multiplex 3 5
multiplex_deleted #describe_multiplex 5 20
multiplex_running #describe_multiplex 5 120
multiplex_stopped #describe_multiplex 5 28
node_deregistered #describe_node 5 20
node_registered #describe_node 3 5
signal_map_created #get_signal_map 5 60
signal_map_monitor_deleted #get_signal_map 5 120
signal_map_monitor_deployed #get_signal_map 5 120
signal_map_updated #get_signal_map 5 60

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



8230
8231
8232
8233
8234
 
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/client.rb', line 8230

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end