class Aws::MediaTailor::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-mediatailor/client.rb, line 1956 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials 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. @option options [required, String] :region 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` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (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. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("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. @option options [Integer] :client_side_monitoring_port (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. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint 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. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (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. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (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. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (: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 @option options [Integer] :retry_limit (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. @option options [Integer] :retry_max_delay (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. @option options [String] :retry_mode ("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. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (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. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (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. @option options [Float] :http_continue_timeout (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. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle 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. @option options [String] :ssl_ca_directory 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.
# File lib/aws-sdk-mediatailor/client.rb, line 324 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-mediatailor/client.rb, line 1931 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-mediatailor' context[:gem_version] = '1.44.0' Seahorse::Client::Request.new(handlers, context) end
Creates a channel.
@option params [required, String] :channel_name
@option params [Types::SlateSource] :filler_slate
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses an LINEAR PlaybackMode.
@option params [required, Array<Types::RequestOutputItem>] :outputs
The channel's output properties.
@option params [required, String] :playback_mode
The type of playback mode to use for this channel. LINEAR - The programs in the schedule play once back-to-back in the schedule. LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
@option params [Hash<String,String>] :tags
The tags to assign to the channel.
@return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateChannelResponse#arn #arn} => String * {Types::CreateChannelResponse#channel_name #channel_name} => String * {Types::CreateChannelResponse#channel_state #channel_state} => String * {Types::CreateChannelResponse#creation_time #creation_time} => Time * {Types::CreateChannelResponse#filler_slate #filler_slate} => Types::SlateSource * {Types::CreateChannelResponse#last_modified_time #last_modified_time} => Time * {Types::CreateChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem> * {Types::CreateChannelResponse#playback_mode #playback_mode} => String * {Types::CreateChannelResponse#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.create_channel({ channel_name: "__string", # required filler_slate: { source_location_name: "__string", vod_source_name: "__string", }, 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, LINEAR tags: { "__string" => "__string", }, })
@example Response structure
resp.arn #=> String resp.channel_name #=> String resp.channel_state #=> String, one of "RUNNING", "STOPPED" resp.creation_time #=> Time resp.filler_slate.source_location_name #=> String resp.filler_slate.vod_source_name #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannel AWS API Documentation
@overload create_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 421 def create_channel(params = {}, options = {}) req = build_request(:create_channel, params) req.send_request(options) end
Creates a program.
@option params [Array<Types::AdBreak>] :ad_breaks
The ad break configuration settings.
@option params [required, String] :channel_name
@option params [required, String] :program_name
@option params [required, Types::ScheduleConfiguration] :schedule_configuration
The schedule configuration settings.
@option params [required, String] :source_location_name
The name of the source location.
@option params [required, String] :vod_source_name
The name that's used to refer to a VOD source.
@return [Types::CreateProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateProgramResponse#ad_breaks #ad_breaks} => Array<Types::AdBreak> * {Types::CreateProgramResponse#arn #arn} => String * {Types::CreateProgramResponse#channel_name #channel_name} => String * {Types::CreateProgramResponse#creation_time #creation_time} => Time * {Types::CreateProgramResponse#program_name #program_name} => String * {Types::CreateProgramResponse#scheduled_start_time #scheduled_start_time} => Time * {Types::CreateProgramResponse#source_location_name #source_location_name} => String * {Types::CreateProgramResponse#vod_source_name #vod_source_name} => String
@example 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", scheduled_start_time_millis: 1, type: "__string", # required }, }, source_location_name: "__string", # required vod_source_name: "__string", # required })
@example 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.scheduled_start_time #=> Time resp.source_location_name #=> String resp.vod_source_name #=> String
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgram AWS API Documentation
@overload create_program
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 511 def create_program(params = {}, options = {}) req = build_request(:create_program, params) req.send_request(options) end
Creates a source location on a specific channel.
@option params [Types::AccessConfiguration] :access_configuration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
@option params [Types::DefaultSegmentDeliveryConfiguration] :default_segment_delivery_configuration
The optional configuration for the server that serves segments.
@option params [required, Types::HttpConfiguration] :http_configuration
The source's HTTP package configurations.
@option params [required, String] :source_location_name
@option params [Hash<String,String>] :tags
The tags to assign to the source location.
@return [Types::CreateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateSourceLocationResponse#access_configuration #access_configuration} => Types::AccessConfiguration * {Types::CreateSourceLocationResponse#arn #arn} => String * {Types::CreateSourceLocationResponse#creation_time #creation_time} => Time * {Types::CreateSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration * {Types::CreateSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration * {Types::CreateSourceLocationResponse#last_modified_time #last_modified_time} => Time * {Types::CreateSourceLocationResponse#source_location_name #source_location_name} => String * {Types::CreateSourceLocationResponse#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.create_source_location({ access_configuration: { access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN secrets_manager_access_token_configuration: { header_name: "__string", secret_arn: "__string", secret_string_key: "__string", }, }, default_segment_delivery_configuration: { base_url: "__string", }, http_configuration: { # required base_url: "__string", # required }, source_location_name: "__string", # required tags: { "__string" => "__string", }, })
@example Response structure
resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN" resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocation AWS API Documentation
@overload create_source_location
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 586 def create_source_location(params = {}, options = {}) req = build_request(:create_source_location, params) req.send_request(options) end
Creates name for a specific VOD source in a source location.
@option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
An array of HTTP package configuration parameters for this VOD source.
@option params [required, String] :source_location_name
@option params [Hash<String,String>] :tags
The tags to assign to the VOD source.
@option params [required, String] :vod_source_name
@return [Types::CreateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateVodSourceResponse#arn #arn} => String * {Types::CreateVodSourceResponse#creation_time #creation_time} => Time * {Types::CreateVodSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration> * {Types::CreateVodSourceResponse#last_modified_time #last_modified_time} => Time * {Types::CreateVodSourceResponse#source_location_name #source_location_name} => String * {Types::CreateVodSourceResponse#tags #tags} => Hash<String,String> * {Types::CreateVodSourceResponse#vod_source_name #vod_source_name} => String
@example 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 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSource AWS API Documentation
@overload create_vod_source
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 648 def create_vod_source(params = {}, options = {}) req = build_request(:create_vod_source, params) req.send_request(options) end
Deletes a channel. You must stop the channel before it can be deleted.
@option params [required, String] :channel_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_channel({ channel_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannel AWS API Documentation
@overload delete_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 669 def delete_channel(params = {}, options = {}) req = build_request(:delete_channel, params) req.send_request(options) end
Deletes a channel's IAM policy.
@option params [required, String] :channel_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_channel_policy({ channel_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicy AWS API Documentation
@overload delete_channel_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 690 def delete_channel_policy(params = {}, options = {}) req = build_request(:delete_channel_policy, params) req.send_request(options) end
Deletes the playback configuration for the specified name.
@option params [required, String] :name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_playback_configuration({ name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfiguration AWS API Documentation
@overload delete_playback_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 711 def delete_playback_configuration(params = {}, options = {}) req = build_request(:delete_playback_configuration, params) req.send_request(options) end
Deletes a specific program on a specific channel.
@option params [required, String] :channel_name
@option params [required, String] :program_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_program({ channel_name: "__string", # required program_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgram AWS API Documentation
@overload delete_program
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 735 def delete_program(params = {}, options = {}) req = build_request(:delete_program, params) req.send_request(options) end
Deletes a source location on a specific channel.
@option params [required, String] :source_location_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_source_location({ source_location_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocation AWS API Documentation
@overload delete_source_location
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 756 def delete_source_location(params = {}, options = {}) req = build_request(:delete_source_location, params) req.send_request(options) end
Deletes a specific VOD source in a specific source location.
@option params [required, String] :source_location_name
@option params [required, String] :vod_source_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_vod_source({ source_location_name: "__string", # required vod_source_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSource AWS API Documentation
@overload delete_vod_source
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 780 def delete_vod_source(params = {}, options = {}) req = build_request(:delete_vod_source, params) req.send_request(options) end
Describes the properties of a specific channel.
@option params [required, String] :channel_name
@return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeChannelResponse#arn #arn} => String * {Types::DescribeChannelResponse#channel_name #channel_name} => String * {Types::DescribeChannelResponse#channel_state #channel_state} => String * {Types::DescribeChannelResponse#creation_time #creation_time} => Time * {Types::DescribeChannelResponse#filler_slate #filler_slate} => Types::SlateSource * {Types::DescribeChannelResponse#last_modified_time #last_modified_time} => Time * {Types::DescribeChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem> * {Types::DescribeChannelResponse#playback_mode #playback_mode} => String * {Types::DescribeChannelResponse#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.describe_channel({ channel_name: "__string", # required })
@example Response structure
resp.arn #=> String resp.channel_name #=> String resp.channel_state #=> String, one of "RUNNING", "STOPPED" resp.creation_time #=> Time resp.filler_slate.source_location_name #=> String resp.filler_slate.vod_source_name #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannel AWS API Documentation
@overload describe_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 833 def describe_channel(params = {}, options = {}) req = build_request(:describe_channel, params) req.send_request(options) end
Retrieves the properties of the requested program.
@option params [required, String] :channel_name
@option params [required, String] :program_name
@return [Types::DescribeProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeProgramResponse#ad_breaks #ad_breaks} => Array<Types::AdBreak> * {Types::DescribeProgramResponse#arn #arn} => String * {Types::DescribeProgramResponse#channel_name #channel_name} => String * {Types::DescribeProgramResponse#creation_time #creation_time} => Time * {Types::DescribeProgramResponse#program_name #program_name} => String * {Types::DescribeProgramResponse#scheduled_start_time #scheduled_start_time} => Time * {Types::DescribeProgramResponse#source_location_name #source_location_name} => String * {Types::DescribeProgramResponse#vod_source_name #vod_source_name} => String
@example Request syntax with placeholder values
resp = client.describe_program({ channel_name: "__string", # required program_name: "__string", # required })
@example 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.scheduled_start_time #=> Time resp.source_location_name #=> String resp.vod_source_name #=> String
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgram AWS API Documentation
@overload describe_program
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 885 def describe_program(params = {}, options = {}) req = build_request(:describe_program, params) req.send_request(options) end
Retrieves the properties of the requested source location.
@option params [required, String] :source_location_name
@return [Types::DescribeSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeSourceLocationResponse#access_configuration #access_configuration} => Types::AccessConfiguration * {Types::DescribeSourceLocationResponse#arn #arn} => String * {Types::DescribeSourceLocationResponse#creation_time #creation_time} => Time * {Types::DescribeSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration * {Types::DescribeSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration * {Types::DescribeSourceLocationResponse#last_modified_time #last_modified_time} => Time * {Types::DescribeSourceLocationResponse#source_location_name #source_location_name} => String * {Types::DescribeSourceLocationResponse#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.describe_source_location({ source_location_name: "__string", # required })
@example Response structure
resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN" resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocation AWS API Documentation
@overload describe_source_location
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 930 def describe_source_location(params = {}, options = {}) req = build_request(:describe_source_location, params) req.send_request(options) end
Provides details about a specific VOD source in a specific source location.
@option params [required, String] :source_location_name
@option params [required, String] :vod_source_name
@return [Types::DescribeVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeVodSourceResponse#arn #arn} => String * {Types::DescribeVodSourceResponse#creation_time #creation_time} => Time * {Types::DescribeVodSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration> * {Types::DescribeVodSourceResponse#last_modified_time #last_modified_time} => Time * {Types::DescribeVodSourceResponse#source_location_name #source_location_name} => String * {Types::DescribeVodSourceResponse#tags #tags} => Hash<String,String> * {Types::DescribeVodSourceResponse#vod_source_name #vod_source_name} => String
@example Request syntax with placeholder values
resp = client.describe_vod_source({ source_location_name: "__string", # required vod_source_name: "__string", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSource AWS API Documentation
@overload describe_vod_source
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 977 def describe_vod_source(params = {}, options = {}) req = build_request(:describe_vod_source, params) req.send_request(options) end
Retrieves information about a channel's IAM policy.
@option params [required, String] :channel_name
@return [Types::GetChannelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetChannelPolicyResponse#policy #policy} => String
@example Request syntax with placeholder values
resp = client.get_channel_policy({ channel_name: "__string", # required })
@example Response structure
resp.policy #=> String
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicy AWS API Documentation
@overload get_channel_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1004 def get_channel_policy(params = {}, options = {}) req = build_request(:get_channel_policy, params) req.send_request(options) end
Retrieves information about your channel's schedule.
@option params [required, String] :channel_name
@option params [String] :duration_minutes
@option params [Integer] :max_results
@option params [String] :next_token
@return [Types::GetChannelScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetChannelScheduleResponse#items #items} => Array<Types::ScheduleEntry> * {Types::GetChannelScheduleResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.get_channel_schedule({ channel_name: "__string", # required duration_minutes: "__string", max_results: 1, next_token: "__string", })
@example 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].schedule_ad_breaks #=> Array resp.items[0].schedule_ad_breaks[0].approximate_duration_seconds #=> Integer resp.items[0].schedule_ad_breaks[0].approximate_start_time #=> Time resp.items[0].schedule_ad_breaks[0].source_location_name #=> String resp.items[0].schedule_ad_breaks[0].vod_source_name #=> String resp.items[0].schedule_entry_type #=> String, one of "PROGRAM", "FILLER_SLATE" resp.items[0].source_location_name #=> String resp.items[0].vod_source_name #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelSchedule AWS API Documentation
@overload get_channel_schedule
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1057 def get_channel_schedule(params = {}, options = {}) req = build_request(:get_channel_schedule, params) req.send_request(options) end
Returns the playback configuration for the specified name.
@option params [required, String] :name
@return [Types::GetPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetPlaybackConfigurationResponse#ad_decision_server_url #ad_decision_server_url} => String * {Types::GetPlaybackConfigurationResponse#avail_suppression #avail_suppression} => Types::AvailSuppression * {Types::GetPlaybackConfigurationResponse#bumper #bumper} => Types::Bumper * {Types::GetPlaybackConfigurationResponse#cdn_configuration #cdn_configuration} => Types::CdnConfiguration * {Types::GetPlaybackConfigurationResponse#configuration_aliases #configuration_aliases} => Hash<String,Hash<String,String>> * {Types::GetPlaybackConfigurationResponse#dash_configuration #dash_configuration} => Types::DashConfiguration * {Types::GetPlaybackConfigurationResponse#hls_configuration #hls_configuration} => Types::HlsConfiguration * {Types::GetPlaybackConfigurationResponse#live_pre_roll_configuration #live_pre_roll_configuration} => Types::LivePreRollConfiguration * {Types::GetPlaybackConfigurationResponse#manifest_processing_rules #manifest_processing_rules} => Types::ManifestProcessingRules * {Types::GetPlaybackConfigurationResponse#name #name} => String * {Types::GetPlaybackConfigurationResponse#personalization_threshold_seconds #personalization_threshold_seconds} => Integer * {Types::GetPlaybackConfigurationResponse#playback_configuration_arn #playback_configuration_arn} => String * {Types::GetPlaybackConfigurationResponse#playback_endpoint_prefix #playback_endpoint_prefix} => String * {Types::GetPlaybackConfigurationResponse#session_initialization_endpoint_prefix #session_initialization_endpoint_prefix} => String * {Types::GetPlaybackConfigurationResponse#slate_ad_url #slate_ad_url} => String * {Types::GetPlaybackConfigurationResponse#tags #tags} => Hash<String,String> * {Types::GetPlaybackConfigurationResponse#transcode_profile_name #transcode_profile_name} => String * {Types::GetPlaybackConfigurationResponse#video_content_source_url #video_content_source_url} => String
@example Request syntax with placeholder values
resp = client.get_playback_configuration({ name: "__string", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfiguration AWS API Documentation
@overload get_playback_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1127 def get_playback_configuration(params = {}, options = {}) req = build_request(:get_playback_configuration, params) req.send_request(options) end
Returns a list of alerts for the given resource.
@option params [Integer] :max_results
@option params [String] :next_token
@option params [required, String] :resource_arn
@return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAlertsResponse#items #items} => Array<Types::Alert> * {Types::ListAlertsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_alerts({ max_results: 1, next_token: "__string", resource_arn: "__string", # required })
@example Response structure
resp.items #=> Array resp.items[0].alert_code #=> String resp.items[0].alert_message #=> String resp.items[0].last_modified_time #=> Time resp.items[0].related_resource_arns #=> Array resp.items[0].related_resource_arns[0] #=> String resp.items[0].resource_arn #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlerts AWS API Documentation
@overload list_alerts
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1170 def list_alerts(params = {}, options = {}) req = build_request(:list_alerts, params) req.send_request(options) end
Retrieves a list of channels that are associated with this account.
@option params [Integer] :max_results
@option params [String] :next_token
@return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListChannelsResponse#items #items} => Array<Types::Channel> * {Types::ListChannelsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_channels({ max_results: 1, next_token: "__string", })
@example 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].filler_slate.source_location_name #=> String resp.items[0].filler_slate.vod_source_name #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannels AWS API Documentation
@overload list_channels
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1223 def list_channels(params = {}, options = {}) req = build_request(:list_channels, params) req.send_request(options) end
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.
@option params [Integer] :max_results
@option params [String] :next_token
@return [Types::ListPlaybackConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPlaybackConfigurationsResponse#items #items} => Array<Types::PlaybackConfiguration> * {Types::ListPlaybackConfigurationsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_playback_configurations({ max_results: 1, next_token: "__string", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurations AWS API Documentation
@overload list_playback_configurations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1289 def list_playback_configurations(params = {}, options = {}) req = build_request(:list_playback_configurations, params) req.send_request(options) end
Retrieves a list of source locations.
@option params [Integer] :max_results
@option params [String] :next_token
@return [Types::ListSourceLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListSourceLocationsResponse#items #items} => Array<Types::SourceLocation> * {Types::ListSourceLocationsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_source_locations({ max_results: 1, next_token: "__string", })
@example Response structure
resp.items #=> Array resp.items[0].access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN" resp.items[0].access_configuration.secrets_manager_access_token_configuration.header_name #=> String resp.items[0].access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String resp.items[0].access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocations AWS API Documentation
@overload list_source_locations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1335 def list_source_locations(params = {}, options = {}) req = build_request(:list_source_locations, params) req.send_request(options) end
Lists all the VOD sources in a source location.
@option params [Integer] :max_results
@option params [String] :next_token
@option params [required, String] :source_location_name
@return [Types::ListVodSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListVodSourcesResponse#items #items} => Array<Types::VodSource> * {Types::ListVodSourcesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_vod_sources({ max_results: 1, next_token: "__string", source_location_name: "__string", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSources AWS API Documentation
@overload list_vod_sources
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1412 def list_vod_sources(params = {}, options = {}) req = build_request(:list_vod_sources, params) req.send_request(options) end
Creates an IAM policy for the channel.
@option params [required, String] :channel_name
@option params [required, String] :policy
Adds an IAM role that determines the permissions of your channel.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.put_channel_policy({ channel_name: "__string", # required policy: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicy AWS API Documentation
@overload put_channel_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1437 def put_channel_policy(params = {}, options = {}) req = build_request(:put_channel_policy, params) req.send_request(options) end
Adds a new playback configuration to AWS Elemental MediaTailor
.
@option params [String] :ad_decision_server_url
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.
@option params [Types::AvailSuppression] :avail_suppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression][1]. [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
@option params [Types::Bumper] :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][1]. [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
@option params [Types::CdnConfiguration] :cdn_configuration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
@option params [Hash<String,Hash>] :configuration_aliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables][1]. [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
@option params [Types::DashConfigurationForPut] :dash_configuration
The configuration for DASH content.
@option params [Types::LivePreRollConfiguration] :live_pre_roll_configuration
The configuration for pre-roll ad insertion.
@option params [Types::ManifestProcessingRules] :manifest_processing_rules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
@option params [String] :name
The identifier for the playback configuration.
@option params [Integer] :personalization_threshold_seconds
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][1]. [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
@option params [String] :slate_ad_url
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.
@option params [Hash<String,String>] :tags
The tags to assign to the playback configuration.
@option params [String] :transcode_profile_name
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.
@option params [String] :video_content_source_url
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
@return [Types::PutPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::PutPlaybackConfigurationResponse#ad_decision_server_url #ad_decision_server_url} => String * {Types::PutPlaybackConfigurationResponse#avail_suppression #avail_suppression} => Types::AvailSuppression * {Types::PutPlaybackConfigurationResponse#bumper #bumper} => Types::Bumper * {Types::PutPlaybackConfigurationResponse#cdn_configuration #cdn_configuration} => Types::CdnConfiguration * {Types::PutPlaybackConfigurationResponse#configuration_aliases #configuration_aliases} => Hash<String,Hash<String,String>> * {Types::PutPlaybackConfigurationResponse#dash_configuration #dash_configuration} => Types::DashConfiguration * {Types::PutPlaybackConfigurationResponse#hls_configuration #hls_configuration} => Types::HlsConfiguration * {Types::PutPlaybackConfigurationResponse#live_pre_roll_configuration #live_pre_roll_configuration} => Types::LivePreRollConfiguration * {Types::PutPlaybackConfigurationResponse#manifest_processing_rules #manifest_processing_rules} => Types::ManifestProcessingRules * {Types::PutPlaybackConfigurationResponse#name #name} => String * {Types::PutPlaybackConfigurationResponse#personalization_threshold_seconds #personalization_threshold_seconds} => Integer * {Types::PutPlaybackConfigurationResponse#playback_configuration_arn #playback_configuration_arn} => String * {Types::PutPlaybackConfigurationResponse#playback_endpoint_prefix #playback_endpoint_prefix} => String * {Types::PutPlaybackConfigurationResponse#session_initialization_endpoint_prefix #session_initialization_endpoint_prefix} => String * {Types::PutPlaybackConfigurationResponse#slate_ad_url #slate_ad_url} => String * {Types::PutPlaybackConfigurationResponse#tags #tags} => Hash<String,String> * {Types::PutPlaybackConfigurationResponse#transcode_profile_name #transcode_profile_name} => String * {Types::PutPlaybackConfigurationResponse#video_content_source_url #video_content_source_url} => String
@example 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", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfiguration AWS API Documentation
@overload put_playback_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1631 def put_playback_configuration(params = {}, options = {}) req = build_request(:put_playback_configuration, params) req.send_request(options) end
Starts a specific channel.
@option params [required, String] :channel_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.start_channel({ channel_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannel AWS API Documentation
@overload start_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1652 def start_channel(params = {}, options = {}) req = build_request(:start_channel, params) req.send_request(options) end
Stops a specific channel.
@option params [required, String] :channel_name
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.stop_channel({ channel_name: "__string", # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannel AWS API Documentation
@overload stop_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1673 def stop_channel(params = {}, options = {}) req = build_request(:stop_channel, params) req.send_request(options) end
Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
@option params [required, String] :resource_arn
@option params [required, Hash<String,String>] :tags
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "__string", # required tags: { # required "__string" => "__string", }, })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1700 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
@option params [required, String] :resource_arn
@option params [required, Array<String>] :tag_keys
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "__string", # required tag_keys: ["__string"], # required })
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1725 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
Updates an existing channel.
@option params [required, String] :channel_name
@option params [required, Array<Types::RequestOutputItem>] :outputs
The channel's output properties.
@return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateChannelResponse#arn #arn} => String * {Types::UpdateChannelResponse#channel_name #channel_name} => String * {Types::UpdateChannelResponse#channel_state #channel_state} => String * {Types::UpdateChannelResponse#creation_time #creation_time} => Time * {Types::UpdateChannelResponse#filler_slate #filler_slate} => Types::SlateSource * {Types::UpdateChannelResponse#last_modified_time #last_modified_time} => Time * {Types::UpdateChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem> * {Types::UpdateChannelResponse#playback_mode #playback_mode} => String * {Types::UpdateChannelResponse#tags #tags} => Hash<String,String>
@example 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 }, ], })
@example Response structure
resp.arn #=> String resp.channel_name #=> String resp.channel_state #=> String, one of "RUNNING", "STOPPED" resp.creation_time #=> Time resp.filler_slate.source_location_name #=> String resp.filler_slate.vod_source_name #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannel AWS API Documentation
@overload update_channel
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1796 def update_channel(params = {}, options = {}) req = build_request(:update_channel, params) req.send_request(options) end
Updates a source location on a specific channel.
@option params [Types::AccessConfiguration] :access_configuration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
@option params [Types::DefaultSegmentDeliveryConfiguration] :default_segment_delivery_configuration
The optional configuration for the host server that serves segments.
@option params [required, Types::HttpConfiguration] :http_configuration
The HTTP configuration for the source location.
@option params [required, String] :source_location_name
@return [Types::UpdateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateSourceLocationResponse#access_configuration #access_configuration} => Types::AccessConfiguration * {Types::UpdateSourceLocationResponse#arn #arn} => String * {Types::UpdateSourceLocationResponse#creation_time #creation_time} => Time * {Types::UpdateSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration * {Types::UpdateSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration * {Types::UpdateSourceLocationResponse#last_modified_time #last_modified_time} => Time * {Types::UpdateSourceLocationResponse#source_location_name #source_location_name} => String * {Types::UpdateSourceLocationResponse#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.update_source_location({ access_configuration: { access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN secrets_manager_access_token_configuration: { header_name: "__string", secret_arn: "__string", secret_string_key: "__string", }, }, default_segment_delivery_configuration: { base_url: "__string", }, http_configuration: { # required base_url: "__string", # required }, source_location_name: "__string", # required })
@example Response structure
resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN" resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocation AWS API Documentation
@overload update_source_location
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1865 def update_source_location(params = {}, options = {}) req = build_request(:update_source_location, params) req.send_request(options) end
Updates a specific VOD source in a specific source location.
@option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
An array of HTTP package configurations for the VOD source on this account.
@option params [required, String] :source_location_name
@option params [required, String] :vod_source_name
@return [Types::UpdateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateVodSourceResponse#arn #arn} => String * {Types::UpdateVodSourceResponse#creation_time #creation_time} => Time * {Types::UpdateVodSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration> * {Types::UpdateVodSourceResponse#last_modified_time #last_modified_time} => Time * {Types::UpdateVodSourceResponse#source_location_name #source_location_name} => String * {Types::UpdateVodSourceResponse#tags #tags} => Hash<String,String> * {Types::UpdateVodSourceResponse#vod_source_name #vod_source_name} => String
@example 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 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSource AWS API Documentation
@overload update_vod_source
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-mediatailor/client.rb, line 1922 def update_vod_source(params = {}, options = {}) req = build_request(:update_vod_source, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-mediatailor/client.rb, line 1946 def waiter_names [] end