AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::MediaTailor::Client

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

Overview

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

client = Aws::MediaTailor::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):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an 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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :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)
  • :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.

  • :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.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :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.

  • :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.

  • :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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :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.



324
325
326
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

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

Creates a channel.

Examples:

Request syntax with placeholder values


resp = client.create_channel({
  channel_name: "__string", # required
  outputs: [ # required
    {
      dash_playlist_settings: {
        manifest_window_seconds: 1,
        min_buffer_time_seconds: 1,
        min_update_period_seconds: 1,
        suggested_presentation_delay_seconds: 1,
      },
      hls_playlist_settings: {
        manifest_window_seconds: 1,
      },
      manifest_name: "__string", # required
      source_group: "__string", # required
    },
  ],
  playback_mode: "LOOP", # required, accepts LOOP
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].source_group #=> String
resp.playback_mode #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)
  • :outputs (required, Array<Types::RequestOutputItem>)

    The channel's output properties.

  • :playback_mode (required, String)

    The type of playback mode for this channel. The only supported value is LOOP.

  • :tags (Hash<String,String>)

    The tags to assign to the channel.

Returns:

See Also:



404
405
406
407
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 404

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

#create_program(params = {}) ⇒ Types::CreateProgramResponse

Creates a program.

Examples:

Request syntax with placeholder values


resp = client.create_program({
  ad_breaks: [
    {
      message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
      offset_millis: 1,
      slate: {
        source_location_name: "__string",
        vod_source_name: "__string",
      },
      splice_insert_message: {
        avail_num: 1,
        avails_expected: 1,
        splice_event_id: 1,
        unique_program_id: 1,
      },
    },
  ],
  channel_name: "__string", # required
  program_name: "__string", # required
  schedule_configuration: { # required
    transition: { # required
      relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
      relative_program: "__string",
      type: "__string", # required
    },
  },
  source_location_name: "__string", # required
  vod_source_name: "__string", # required
})

Response structure


resp.ad_breaks #=> Array
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
resp.ad_breaks[0].offset_millis #=> Integer
resp.ad_breaks[0].slate.source_location_name #=> String
resp.ad_breaks[0].slate.vod_source_name #=> String
resp.ad_breaks[0].splice_insert_message.avail_num #=> Integer
resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
resp.arn #=> String
resp.channel_name #=> String
resp.creation_time #=> Time
resp.program_name #=> String
resp.source_location_name #=> String
resp.vod_source_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ad_breaks (Array<Types::AdBreak>)

    The ad break configuration settings.

  • :channel_name (required, String)
  • :program_name (required, String)
  • :schedule_configuration (required, Types::ScheduleConfiguration)

    The schedule configuration settings.

  • :source_location_name (required, String)

    The name of the source location.

  • :vod_source_name (required, String)

    The name that's used to refer to a VOD source.

Returns:

See Also:



491
492
493
494
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 491

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

#create_source_location(params = {}) ⇒ Types::CreateSourceLocationResponse

Creates a source location on a specific channel.

Examples:

Request syntax with placeholder values


resp = client.create_source_location({
  access_configuration: {
    access_type: "S3_SIGV4", # accepts S3_SIGV4
  },
  default_segment_delivery_configuration: {
    base_url: "__string",
  },
  http_configuration: { # required
    base_url: "__string", # required
  },
  source_location_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.access_configuration.access_type #=> String, one of "S3_SIGV4"
resp.arn #=> String
resp.creation_time #=> Time
resp.default_segment_delivery_configuration.base_url #=> String
resp.http_configuration.base_url #=> String
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :access_configuration (Types::AccessConfiguration)

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

  • :default_segment_delivery_configuration (Types::DefaultSegmentDeliveryConfiguration)

    The optional configuration for the server that serves segments.

  • :http_configuration (required, Types::HttpConfiguration)

    The source's HTTP package configurations.

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

    The tags to assign to the source location.

Returns:

See Also:



558
559
560
561
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 558

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

#create_vod_source(params = {}) ⇒ Types::CreateVodSourceResponse

Creates name for a specific VOD source in a source location.

Examples:

Request syntax with placeholder values


resp = client.create_vod_source({
  http_package_configurations: [ # required
    {
      path: "__string", # required
      source_group: "__string", # required
      type: "DASH", # required, accepts DASH, HLS
    },
  ],
  source_location_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
  vod_source_name: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.http_package_configurations #=> Array
resp.http_package_configurations[0].path #=> String
resp.http_package_configurations[0].source_group #=> String
resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vod_source_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :http_package_configurations (required, Array<Types::HttpPackageConfiguration>)

    An array of HTTP package configuration parameters for this VOD source.

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

    The tags to assign to the VOD source.

  • :vod_source_name (required, String)

Returns:

See Also:



620
621
622
623
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 620

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

#delete_channel(params = {}) ⇒ Struct

Deletes a channel. You must stop the channel before it can be deleted.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



641
642
643
644
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 641

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

#delete_channel_policy(params = {}) ⇒ Struct

Deletes a channel's IAM policy.

Examples:

Request syntax with placeholder values


resp = client.delete_channel_policy({
  channel_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



662
663
664
665
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 662

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

#delete_playback_configuration(params = {}) ⇒ Struct

Deletes the playback configuration for the specified name.

Examples:

Request syntax with placeholder values


resp = client.delete_playback_configuration({
  name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



683
684
685
686
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 683

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

#delete_program(params = {}) ⇒ Struct

Deletes a specific program on a specific channel.

Examples:

Request syntax with placeholder values


resp = client.delete_program({
  channel_name: "__string", # required
  program_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



707
708
709
710
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 707

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

#delete_source_location(params = {}) ⇒ Struct

Deletes a source location on a specific channel.

Examples:

Request syntax with placeholder values


resp = client.delete_source_location({
  source_location_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :source_location_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



728
729
730
731
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 728

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

#delete_vod_source(params = {}) ⇒ Struct

Deletes a specific VOD source in a specific source location.

Examples:

Request syntax with placeholder values


resp = client.delete_vod_source({
  source_location_name: "__string", # required
  vod_source_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :source_location_name (required, String)
  • :vod_source_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



752
753
754
755
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 752

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

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

Describes the properties of a specific channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].source_group #=> String
resp.playback_mode #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

See Also:



802
803
804
805
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 802

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

#describe_program(params = {}) ⇒ Types::DescribeProgramResponse

Retrieves the properties of the requested program.

Examples:

Request syntax with placeholder values


resp = client.describe_program({
  channel_name: "__string", # required
  program_name: "__string", # required
})

Response structure


resp.ad_breaks #=> Array
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
resp.ad_breaks[0].offset_millis #=> Integer
resp.ad_breaks[0].slate.source_location_name #=> String
resp.ad_breaks[0].slate.vod_source_name #=> String
resp.ad_breaks[0].splice_insert_message.avail_num #=> Integer
resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
resp.arn #=> String
resp.channel_name #=> String
resp.creation_time #=> Time
resp.program_name #=> String
resp.source_location_name #=> String
resp.vod_source_name #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



852
853
854
855
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 852

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

#describe_source_location(params = {}) ⇒ Types::DescribeSourceLocationResponse

Retrieves the properties of the requested source location.

Examples:

Request syntax with placeholder values


resp = client.describe_source_location({
  source_location_name: "__string", # required
})

Response structure


resp.access_configuration.access_type #=> String, one of "S3_SIGV4"
resp.arn #=> String
resp.creation_time #=> Time
resp.default_segment_delivery_configuration.base_url #=> String
resp.http_configuration.base_url #=> String
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_location_name (required, String)

Returns:

See Also:



894
895
896
897
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 894

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

#describe_vod_source(params = {}) ⇒ Types::DescribeVodSourceResponse

Provides details about a specific VOD source in a specific source location.

Examples:

Request syntax with placeholder values


resp = client.describe_vod_source({
  source_location_name: "__string", # required
  vod_source_name: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.http_package_configurations #=> Array
resp.http_package_configurations[0].path #=> String
resp.http_package_configurations[0].source_group #=> String
resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vod_source_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_location_name (required, String)
  • :vod_source_name (required, String)

Returns:

See Also:



941
942
943
944
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 941

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

#get_channel_policy(params = {}) ⇒ Types::GetChannelPolicyResponse

Retrieves information about a channel's IAM policy.

Examples:

Request syntax with placeholder values


resp = client.get_channel_policy({
  channel_name: "__string", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

See Also:



968
969
970
971
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 968

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

#get_channel_schedule(params = {}) ⇒ Types::GetChannelScheduleResponse

Retrieves information about your channel's 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.get_channel_schedule({
  channel_name: "__string", # required
  duration_minutes: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].approximate_duration_seconds #=> Integer
resp.items[0].approximate_start_time #=> Time
resp.items[0].arn #=> String
resp.items[0].channel_name #=> String
resp.items[0].program_name #=> String
resp.items[0].source_location_name #=> String
resp.items[0].vod_source_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)
  • :duration_minutes (String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1015
1016
1017
1018
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1015

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

#get_playback_configuration(params = {}) ⇒ Types::GetPlaybackConfigurationResponse

Returns the playback configuration for the specified name.

Examples:

Request syntax with placeholder values


resp = client.get_playback_configuration({
  name: "__string", # required
})

Response structure


resp.ad_decision_server_url #=> String
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE"
resp.avail_suppression.value #=> String
resp.bumper.end_url #=> String
resp.bumper.start_url #=> String
resp.cdn_configuration.ad_segment_url_prefix #=> String
resp.cdn_configuration.content_segment_url_prefix #=> String
resp.configuration_aliases #=> Hash
resp.configuration_aliases["__string"] #=> Hash
resp.configuration_aliases["__string"]["__string"] #=> String
resp.dash_configuration.manifest_endpoint_prefix #=> String
resp.dash_configuration.mpd_location #=> String
resp.dash_configuration.origin_manifest_type #=> String, one of "SINGLE_PERIOD", "MULTI_PERIOD"
resp.hls_configuration.manifest_endpoint_prefix #=> String
resp.live_pre_roll_configuration.ad_decision_server_url #=> String
resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
resp.manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
resp.name #=> String
resp.personalization_threshold_seconds #=> Integer
resp.playback_configuration_arn #=> String
resp.playback_endpoint_prefix #=> String
resp.session_initialization_endpoint_prefix #=> String
resp.slate_ad_url #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.transcode_profile_name #=> String
resp.video_content_source_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

Returns:

See Also:



1085
1086
1087
1088
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1085

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

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

Retrieves a list of channels that are associated with this 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_channels({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].channel_name #=> String
resp.items[0].channel_state #=> String
resp.items[0].creation_time #=> Time
resp.items[0].last_modified_time #=> Time
resp.items[0].outputs #=> Array
resp.items[0].outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.items[0].outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.items[0].outputs[0].manifest_name #=> String
resp.items[0].outputs[0].playback_url #=> String
resp.items[0].outputs[0].source_group #=> String
resp.items[0].playback_mode #=> String
resp.items[0].tags #=> Hash
resp.items[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:



1136
1137
1138
1139
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1136

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

#list_playback_configurations(params = {}) ⇒ Types::ListPlaybackConfigurationsResponse

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

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_playback_configurations({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].ad_decision_server_url #=> String
resp.items[0].avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE"
resp.items[0].avail_suppression.value #=> String
resp.items[0].bumper.end_url #=> String
resp.items[0].bumper.start_url #=> String
resp.items[0].cdn_configuration.ad_segment_url_prefix #=> String
resp.items[0].cdn_configuration.content_segment_url_prefix #=> String
resp.items[0].configuration_aliases #=> Hash
resp.items[0].configuration_aliases["__string"] #=> Hash
resp.items[0].configuration_aliases["__string"]["__string"] #=> String
resp.items[0].dash_configuration.manifest_endpoint_prefix #=> String
resp.items[0].dash_configuration.mpd_location #=> String
resp.items[0].dash_configuration.origin_manifest_type #=> String, one of "SINGLE_PERIOD", "MULTI_PERIOD"
resp.items[0].hls_configuration.manifest_endpoint_prefix #=> String
resp.items[0].live_pre_roll_configuration.ad_decision_server_url #=> String
resp.items[0].live_pre_roll_configuration.max_duration_seconds #=> Integer
resp.items[0].manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
resp.items[0].name #=> String
resp.items[0].personalization_threshold_seconds #=> Integer
resp.items[0].playback_configuration_arn #=> String
resp.items[0].playback_endpoint_prefix #=> String
resp.items[0].session_initialization_endpoint_prefix #=> String
resp.items[0].slate_ad_url #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.items[0].transcode_profile_name #=> String
resp.items[0].video_content_source_url #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1202
1203
1204
1205
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1202

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

#list_source_locations(params = {}) ⇒ Types::ListSourceLocationsResponse

Retrieves a list of source locations.

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_source_locations({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].access_configuration.access_type #=> String, one of "S3_SIGV4"
resp.items[0].arn #=> String
resp.items[0].creation_time #=> Time
resp.items[0].default_segment_delivery_configuration.base_url #=> String
resp.items[0].http_configuration.base_url #=> String
resp.items[0].last_modified_time #=> Time
resp.items[0].source_location_name #=> String
resp.items[0].tags #=> Hash
resp.items[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:



1245
1246
1247
1248
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1245

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

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

Returns a list of the tags assigned to the specified playback configuration 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:



1274
1275
1276
1277
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1274

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

#list_vod_sources(params = {}) ⇒ Types::ListVodSourcesResponse

Lists all the VOD sources in a source location.

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_vod_sources({
  max_results: 1,
  next_token: "__string",
  source_location_name: "__string", # required
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_time #=> Time
resp.items[0].http_package_configurations #=> Array
resp.items[0].http_package_configurations[0].path #=> String
resp.items[0].http_package_configurations[0].source_group #=> String
resp.items[0].http_package_configurations[0].type #=> String, one of "DASH", "HLS"
resp.items[0].last_modified_time #=> Time
resp.items[0].source_location_name #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.items[0].vod_source_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1322
1323
1324
1325
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1322

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

#put_channel_policy(params = {}) ⇒ Struct

Creates an IAM policy for the channel.

Examples:

Request syntax with placeholder values


resp = client.put_channel_policy({
  channel_name: "__string", # required
  policy: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)
  • :policy (required, String)

    Adds an IAM role that determines the permissions of your channel.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1347
1348
1349
1350
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1347

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

#put_playback_configuration(params = {}) ⇒ Types::PutPlaybackConfigurationResponse

Adds a new playback configuration to AWS Elemental MediaTailor.

Examples:

Request syntax with placeholder values


resp = client.put_playback_configuration({
  ad_decision_server_url: "__string",
  avail_suppression: {
    mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE
    value: "__string",
  },
  bumper: {
    end_url: "__string",
    start_url: "__string",
  },
  cdn_configuration: {
    ad_segment_url_prefix: "__string",
    content_segment_url_prefix: "__string",
  },
  configuration_aliases: {
    "__string" => {
      "__string" => "__string",
    },
  },
  dash_configuration: {
    mpd_location: "__string",
    origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
  },
  live_pre_roll_configuration: {
    ad_decision_server_url: "__string",
    max_duration_seconds: 1,
  },
  manifest_processing_rules: {
    ad_marker_passthrough: {
      enabled: false,
    },
  },
  name: "__string",
  personalization_threshold_seconds: 1,
  slate_ad_url: "__string",
  tags: {
    "__string" => "__string",
  },
  transcode_profile_name: "__string",
  video_content_source_url: "__string",
})

Response structure


resp.ad_decision_server_url #=> String
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE"
resp.avail_suppression.value #=> String
resp.bumper.end_url #=> String
resp.bumper.start_url #=> String
resp.cdn_configuration.ad_segment_url_prefix #=> String
resp.cdn_configuration.content_segment_url_prefix #=> String
resp.configuration_aliases #=> Hash
resp.configuration_aliases["__string"] #=> Hash
resp.configuration_aliases["__string"]["__string"] #=> String
resp.dash_configuration.manifest_endpoint_prefix #=> String
resp.dash_configuration.mpd_location #=> String
resp.dash_configuration.origin_manifest_type #=> String, one of "SINGLE_PERIOD", "MULTI_PERIOD"
resp.hls_configuration.manifest_endpoint_prefix #=> String
resp.live_pre_roll_configuration.ad_decision_server_url #=> String
resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
resp.manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
resp.name #=> String
resp.personalization_threshold_seconds #=> Integer
resp.playback_configuration_arn #=> String
resp.playback_endpoint_prefix #=> String
resp.session_initialization_endpoint_prefix #=> String
resp.slate_ad_url #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.transcode_profile_name #=> String
resp.video_content_source_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ad_decision_server_url (String)

    The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

  • :avail_suppression (Types::AvailSuppression)

    The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

  • :bumper (Types::Bumper)

    The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

  • :cdn_configuration (Types::CdnConfiguration)

    The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

  • :configuration_aliases (Hash<String,Hash>)

    The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

  • :dash_configuration (Types::DashConfigurationForPut)

    The configuration for DASH content.

  • :live_pre_roll_configuration (Types::LivePreRollConfiguration)

    The configuration for pre-roll ad insertion.

  • :manifest_processing_rules (Types::ManifestProcessingRules)

    The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

  • :name (String)

    The identifier for the playback configuration.

  • :personalization_threshold_seconds (Integer)

    Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

  • :slate_ad_url (String)

    The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

  • :tags (Hash<String,String>)

    The tags to assign to the playback configuration.

  • :transcode_profile_name (String)

    The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

  • :video_content_source_url (String)

    The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

See Also:



1541
1542
1543
1544
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1541

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

#start_channel(params = {}) ⇒ Struct

Starts a specific channel.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1562
1563
1564
1565
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1562

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

#stop_channel(params = {}) ⇒ Struct

Stops a specific channel.

Examples:

Request syntax with placeholder values


resp = client.stop_channel({
  channel_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1583
1584
1585
1586
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1583

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1610
1611
1612
1613
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1610

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  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:



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

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

#update_channel(params = {}) ⇒ Types::UpdateChannelResponse

Updates an existing channel.

Examples:

Request syntax with placeholder values


resp = client.update_channel({
  channel_name: "__string", # required
  outputs: [ # required
    {
      dash_playlist_settings: {
        manifest_window_seconds: 1,
        min_buffer_time_seconds: 1,
        min_update_period_seconds: 1,
        suggested_presentation_delay_seconds: 1,
      },
      hls_playlist_settings: {
        manifest_window_seconds: 1,
      },
      manifest_name: "__string", # required
      source_group: "__string", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].source_group #=> String
resp.playback_mode #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :channel_name (required, String)
  • :outputs (required, Array<Types::RequestOutputItem>)

    The channel's output properties.

Returns:

See Also:



1703
1704
1705
1706
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1703

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

#update_source_location(params = {}) ⇒ Types::UpdateSourceLocationResponse

Updates a source location on a specific channel.

Examples:

Request syntax with placeholder values


resp = client.update_source_location({
  access_configuration: {
    access_type: "S3_SIGV4", # accepts S3_SIGV4
  },
  default_segment_delivery_configuration: {
    base_url: "__string",
  },
  http_configuration: { # required
    base_url: "__string", # required
  },
  source_location_name: "__string", # required
})

Response structure


resp.access_configuration.access_type #=> String, one of "S3_SIGV4"
resp.arn #=> String
resp.creation_time #=> Time
resp.default_segment_delivery_configuration.base_url #=> String
resp.http_configuration.base_url #=> String
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :access_configuration (Types::AccessConfiguration)

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

  • :default_segment_delivery_configuration (Types::DefaultSegmentDeliveryConfiguration)

    The optional configuration for the host server that serves segments.

  • :http_configuration (required, Types::HttpConfiguration)

    The HTTP configuration for the source location.

  • :source_location_name (required, String)

Returns:

See Also:



1764
1765
1766
1767
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1764

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

#update_vod_source(params = {}) ⇒ Types::UpdateVodSourceResponse

Updates a specific VOD source in a specific source location.

Examples:

Request syntax with placeholder values


resp = client.update_vod_source({
  http_package_configurations: [ # required
    {
      path: "__string", # required
      source_group: "__string", # required
      type: "DASH", # required, accepts DASH, HLS
    },
  ],
  source_location_name: "__string", # required
  vod_source_name: "__string", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.http_package_configurations #=> Array
resp.http_package_configurations[0].path #=> String
resp.http_package_configurations[0].source_group #=> String
resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
resp.last_modified_time #=> Time
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vod_source_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :http_package_configurations (required, Array<Types::HttpPackageConfiguration>)

    An array of HTTP package configurations for the VOD source on this account.

  • :source_location_name (required, String)
  • :vod_source_name (required, String)

Returns:

See Also:



1821
1822
1823
1824
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/client.rb', line 1821

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