Class: Aws::MediaTailor::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::MediaTailor::Client

Includes:

ClientStubs

Defined in:

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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary

• .identifier ⇒ Object readonly private

API Operations

• #configure_logs_for_channel(params = {}) ⇒ Types::ConfigureLogsForChannelResponse

  Configures Amazon CloudWatch log settings for a channel.

• #configure_logs_for_playback_configuration(params = {}) ⇒ Types::ConfigureLogsForPlaybackConfigurationResponse

  Amazon CloudWatch log settings for a playback configuration.

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

  Creates a channel.

• #create_live_source(params = {}) ⇒ Types::CreateLiveSourceResponse

  The live source configuration.

• #create_prefetch_schedule(params = {}) ⇒ Types::CreatePrefetchScheduleResponse

  Creates a prefetch schedule for a playback configuration.

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

  Creates a program within a channel.

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

  Creates a source location.

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

  The VOD source configuration parameters.

• #delete_channel(params = {}) ⇒ Struct

  Deletes a channel.

• #delete_channel_policy(params = {}) ⇒ Struct

  The channel policy to delete.

• #delete_live_source(params = {}) ⇒ Struct

  The live source to delete.

• #delete_playback_configuration(params = {}) ⇒ Struct

  Deletes a playback configuration.

• #delete_prefetch_schedule(params = {}) ⇒ Struct

  Deletes a prefetch schedule for a specific playback configuration.

• #delete_program(params = {}) ⇒ Struct

  Deletes a program within a channel.

• #delete_source_location(params = {}) ⇒ Struct

  Deletes a source location.

• #delete_vod_source(params = {}) ⇒ Struct

  The video on demand (VOD) source to delete.

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

  Describes a channel.

• #describe_live_source(params = {}) ⇒ Types::DescribeLiveSourceResponse

  The live source to describe.

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

  Describes a program within a channel.

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

  Describes a source location.

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

  Provides details about a specific video on demand (VOD) source in a specific source location.

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

  Returns the channel’s IAM policy.

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

  Retrieves information about your channel’s schedule.

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

  Retrieves a playback configuration.

• #get_prefetch_schedule(params = {}) ⇒ Types::GetPrefetchScheduleResponse

  Retrieves a prefetch schedule for a playback configuration.

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

  Lists the alerts that are associated with a MediaTailor channel assembly resource.

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

  Retrieves information about the channels that are associated with the current AWS account.

• #list_live_sources(params = {}) ⇒ Types::ListLiveSourcesResponse

  Lists the live sources contained in a source location.

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

  Retrieves existing playback configurations.

• #list_prefetch_schedules(params = {}) ⇒ Types::ListPrefetchSchedulesResponse

  Lists the prefetch schedules for a playback configuration.

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

  Lists the source locations for a channel.

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

  A list of tags that are associated with this resource.

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

  Lists the VOD sources contained in a source location.

• #put_channel_policy(params = {}) ⇒ Struct

  Creates an IAM policy for the channel.

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

  Creates a playback configuration.

• #start_channel(params = {}) ⇒ Struct

  Starts a channel.

• #stop_channel(params = {}) ⇒ Struct

  Stops a channel.

• #tag_resource(params = {}) ⇒ Struct

  The resource to tag.

• #untag_resource(params = {}) ⇒ Struct

  The resource to untag.

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

  Updates a channel.

• #update_live_source(params = {}) ⇒ Types::UpdateLiveSourceResponse

  Updates a live source’s configuration.

• #update_program(params = {}) ⇒ Types::UpdateProgramResponse

  Updates a program within a channel.

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

  Updates a source location.

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

  Updates a VOD source’s configuration.

Class Method Summary

• .errors_module ⇒ Object private

Instance Method Summary

• #build_request(operation_name, params = {}) ⇒ Object private
• #initialize(options) ⇒ Client constructor

  A new instance of Client.

• #waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

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

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

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

  Your AWS credentials. 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`

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

  • ENV, ENV, ENV, and ENV

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

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

• :region (required, String) —

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

  • ‘Aws.config`

  • ‘ENV`

  • ‘ENV`

  • ‘ENV`

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

• :access_key_id (String)
• :account_id (String)
• :active_endpoint_cache (Boolean) — default: false —

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

• :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

• :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

• :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

• :convert_params (Boolean) — default: true —

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

• :correct_clock_skew (Boolean) — default: true —

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

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

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

• :disable_host_prefix_injection (Boolean) — default: false —

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

• :disable_request_compression (Boolean) — default: false —

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

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

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

  'http://example.com'
  'https://example.com'
  'http://example.com:123'
  

• :endpoint_cache_max_entries (Integer) — default: 1000 —

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

• :endpoint_cache_max_threads (Integer) — default: 10 —

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

• :endpoint_cache_poll_interval (Integer) — default: 60 —

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

• :endpoint_discovery (Boolean) — default: false —

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

• :ignore_configured_endpoint_urls (Boolean) —

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

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

  The log formatter.

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

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

• :logger (Logger) —

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

• :max_attempts (Integer) — default: 3 —

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

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

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

• :request_min_compression_size_bytes (Integer) — default: 10240 —

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

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

• :sdk_ua_app_id (String) —

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

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

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

  • ‘Aws.config`

  • ‘ENV`

  • ‘~/.aws/config`

• :stub_responses (Boolean) — default: false —

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

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

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

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

  • OpenTelemetry (OTel) - To use the OTel provider, install and require the

  ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

• :token_provider (Aws::TokenProvider) —

  A Bearer Token Provider. This can be an instance of any one of the following classes:

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

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

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

• :use_dualstack_endpoint (Boolean) —

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

• :use_fips_endpoint (Boolean) —

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

• :validate_params (Boolean) — default: true —

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

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

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

• :http_continue_timeout (Float) — default: 1 —

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

• :http_idle_timeout (Float) — default: 5 —

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

• :http_open_timeout (Float) — default: 15 —

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

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

  A proxy to send requests through. Formatted like ‘proxy.com:123’.

• :http_read_timeout (Float) — default: 60 —

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

• :http_wire_trace (Boolean) — default: false —

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

• :on_chunk_received (Proc) —

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

• :on_chunk_sent (Proc) —

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

• :raise_response_errors (Boolean) — default: true —

  When ‘true`, response errors are raised.

• :ssl_ca_bundle (String) —

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

• :ssl_ca_directory (String) —

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

• :ssl_ca_store (String) —

  Sets the X509::Store to verify peer certificate.

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

  Sets a client certificate when creating http connections.

• :ssl_key (OpenSSL::PKey) —

  Sets a client key when creating http connections.

• :ssl_timeout (Float) —

  Sets the SSL timeout in seconds

• :ssl_verify_peer (Boolean) — default: true —

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

# File 'lib/aws-sdk-mediatailor/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-mediatailor/client.rb', line 3457

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-mediatailor/client.rb', line 3460

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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

# File 'lib/aws-sdk-mediatailor/client.rb', line 3430

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::MediaTailor')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-mediatailor'
  context[:gem_version] = '1.90.0'
  Seahorse::Client::Request.new(handlers, context)
end

#configure_logs_for_channel(params = {}) ⇒ Types::ConfigureLogsForChannelResponse

Configures Amazon CloudWatch log settings for a channel.

Examples:

Request syntax with placeholder values

resp = client.configure_logs_for_channel({
  channel_name: "__string", # required
  log_types: ["AS_RUN"], # required, accepts AS_RUN
})

Response structure

resp.channel_name #=> String
resp.log_types #=> Array
resp.log_types[0] #=> String, one of "AS_RUN"

Parameters:

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

  ({})

Options Hash (params):

• :channel_name (required, String) —

  The name of the channel.

• :log_types (required, Array<String>) —

  The types of logs to collect.

Returns:

• (Types::ConfigureLogsForChannelResponse) —

  Returns a response object which responds to the following methods:

  • #channel_name => String

  • #log_types => Array&lt;String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 480

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

#configure_logs_for_playback_configuration(params = {}) ⇒ Types::ConfigureLogsForPlaybackConfigurationResponse

Amazon CloudWatch log settings for a playback configuration.

Examples:

Request syntax with placeholder values

resp = client.configure_logs_for_playback_configuration({
  percent_enabled: 1, # required
  playback_configuration_name: "__string", # required
})

Response structure

resp.percent_enabled #=> Integer
resp.playback_configuration_name #=> String

Parameters:

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

  ({})

Options Hash (params):

• :percent_enabled (required, Integer) —

  The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to ‘60`, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the [debug log mode].

  Valid values: ‘0` - `100`

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html

• :playback_configuration_name (required, String) —

  The name of the playback configuration.

Returns:

• (Types::ConfigureLogsForPlaybackConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #percent_enabled => Integer

  • #playback_configuration_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 526

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

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

Creates a channel. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

Examples:

Request syntax with placeholder values

resp = client.create_channel({
  audiences: ["String"],
  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: {
        ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
        manifest_window_seconds: 1,
      },
      manifest_name: "__string", # required
      source_group: "__string", # required
    },
  ],
  playback_mode: "LOOP", # required, accepts LOOP, LINEAR
  tags: {
    "__string" => "__string",
  },
  tier: "BASIC", # accepts BASIC, STANDARD
  time_shift_configuration: {
    max_time_delay_seconds: 1, # required
  },
})

Response structure

resp.arn #=> String
resp.audiences #=> Array
resp.audiences[0] #=> 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.ad_markup_type #=> Array
resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
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
resp.tier #=> String
resp.time_shift_configuration.max_time_delay_seconds #=> Integer

Parameters:

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

  ({})

Options Hash (params):

• :audiences (Array<String>) —

  The list of audiences defined in channel.

• :channel_name (required, String) —

  The name of the channel.

• :filler_slate (Types::SlateSource) —

  The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the ‘LINEAR` `PlaybackMode`. MediaTailor doesn’t support filler slate for channels using the ‘LOOP` `PlaybackMode`.

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

  The channel’s output properties.

• :playback_mode (required, String) —

  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.

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

  The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

• :tier (String) —

  The tier of the channel.

• :time_shift_configuration (Types::TimeShiftConfiguration) —

  The time-shifted viewing configuration you want to associate to the channel.

Returns:

• (Types::CreateChannelResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #audiences => Array&lt;String&gt;

  • #channel_name => String

  • #channel_state => String

  • #creation_time => Time

  • #filler_slate => Types::SlateSource

  • #last_modified_time => Time

  • #outputs => Array&lt;Types::ResponseOutputItem&gt;

  • #playback_mode => String

  • #tags => Hash&lt;String,String&gt;

  • #tier => String

  • #time_shift_configuration => Types::TimeShiftConfiguration

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 662

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

#create_live_source(params = {}) ⇒ Types::CreateLiveSourceResponse

The live source configuration.

Examples:

Request syntax with placeholder values

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

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.live_source_name #=> String
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

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

  A list of HTTP package configuration parameters for this live source.

• :live_source_name (required, String) —

  The name of the live source.

• :source_location_name (required, String) —

  The name of the source location.

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

  The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

Returns:

• (Types::CreateLiveSourceResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #live_source_name => String

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 733

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

#create_prefetch_schedule(params = {}) ⇒ Types::CreatePrefetchScheduleResponse

Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html

Examples:

Request syntax with placeholder values

resp = client.create_prefetch_schedule({
  consumption: { # required
    avail_matching_criteria: [
      {
        dynamic_variable: "__string", # required
        operator: "EQUALS", # required, accepts EQUALS
      },
    ],
    end_time: Time.now, # required
    start_time: Time.now,
  },
  name: "__string", # required
  playback_configuration_name: "__string", # required
  retrieval: { # required
    dynamic_variables: {
      "__string" => "__string",
    },
    end_time: Time.now, # required
    start_time: Time.now,
  },
  stream_id: "__string",
})

Response structure

resp.arn #=> String
resp.consumption.avail_matching_criteria #=> Array
resp.consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.consumption.end_time #=> Time
resp.consumption.start_time #=> Time
resp.name #=> String
resp.playback_configuration_name #=> String
resp.retrieval.dynamic_variables #=> Hash
resp.retrieval.dynamic_variables["__string"] #=> String
resp.retrieval.end_time #=> Time
resp.retrieval.start_time #=> Time
resp.stream_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :consumption (required, Types::PrefetchConsumption) —

  The configuration settings for MediaTailor’s consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the *consumption window*. Prefetch schedules automatically expire no earlier than seven days after the end time.

• :name (required, String) —

  The name to assign to the schedule request.

• :playback_configuration_name (required, String) —

  The name to assign to the playback configuration.

• :retrieval (required, Types::PrefetchRetrieval) —

  The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

• :stream_id (String) —

  An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If ‘StreamId` is specified, MediaTailor returns all of the prefetch schedules with an exact match on `StreamId`. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of `StreamId`.

Returns:

• (Types::CreatePrefetchScheduleResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #consumption => Types::PrefetchConsumption

  • #name => String

  • #playback_configuration_name => String

  • #retrieval => Types::PrefetchRetrieval

  • #stream_id => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 828

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

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

Creates a program within a channel. For information about programs, see [Working with programs] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html

Examples:

Request syntax with placeholder values

resp = client.create_program({
  ad_breaks: [
    {
      ad_break_metadata: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
      message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
      offset_millis: 1, # required
      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,
      },
      time_signal_message: {
        segmentation_descriptors: [
          {
            segment_num: 1,
            segmentation_event_id: 1,
            segmentation_type_id: 1,
            segmentation_upid: "String",
            segmentation_upid_type: 1,
            segments_expected: 1,
            sub_segment_num: 1,
            sub_segments_expected: 1,
          },
        ],
      },
    },
  ],
  audience_media: [
    {
      alternate_media: [
        {
          ad_breaks: [
            {
              ad_break_metadata: [
                {
                  key: "String", # required
                  value: "String", # required
                },
              ],
              message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
              offset_millis: 1, # required
              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,
              },
              time_signal_message: {
                segmentation_descriptors: [
                  {
                    segment_num: 1,
                    segmentation_event_id: 1,
                    segmentation_type_id: 1,
                    segmentation_upid: "String",
                    segmentation_upid_type: 1,
                    segments_expected: 1,
                    sub_segment_num: 1,
                    sub_segments_expected: 1,
                  },
                ],
              },
            },
          ],
          clip_range: {
            end_offset_millis: 1,
            start_offset_millis: 1,
          },
          duration_millis: 1,
          live_source_name: "__string",
          scheduled_start_time_millis: 1,
          source_location_name: "__string",
          vod_source_name: "__string",
        },
      ],
      audience: "__string",
    },
  ],
  channel_name: "__string", # required
  live_source_name: "__string",
  program_name: "__string", # required
  schedule_configuration: { # required
    clip_range: {
      end_offset_millis: 1,
      start_offset_millis: 1,
    },
    transition: { # required
      duration_millis: 1,
      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",
})

Response structure

resp.ad_breaks #=> Array
resp.ad_breaks[0].ad_break_metadata #=> Array
resp.ad_breaks[0].ad_break_metadata[0].key #=> String
resp.ad_breaks[0].ad_break_metadata[0].value #=> String
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
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.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.arn #=> String
resp.audience_media #=> Array
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].key #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].value #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
resp.audience_media[0].alternate_media[0].ad_breaks[0].offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.source_location_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.vod_source_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avail_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avails_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.end_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.start_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].duration_millis #=> Integer
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
resp.audience_media[0].audience #=> String
resp.channel_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.creation_time #=> Time
resp.duration_millis #=> Integer
resp.live_source_name #=> String
resp.program_name #=> String
resp.scheduled_start_time #=> Time
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.

• :audience_media (Array<Types::AudienceMedia>) —

  The list of AudienceMedia defined in program.

• :channel_name (required, String) —

  The name of the channel for this Program.

• :live_source_name (String) —

  The name of the LiveSource for this Program.

• :program_name (required, String) —

  The name of the Program.

• :schedule_configuration (required, Types::ScheduleConfiguration) —

  The schedule configuration settings.

• :source_location_name (required, String) —

  The name of the source location.

• :vod_source_name (String) —

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

Returns:

• (Types::CreateProgramResponse) —

  Returns a response object which responds to the following methods:

  • #ad_breaks => Array&lt;Types::AdBreak&gt;

  • #arn => String

  • #audience_media => Array&lt;Types::AudienceMedia&gt;

  • #channel_name => String

  • #clip_range => Types::ClipRange

  • #creation_time => Time

  • #duration_millis => Integer

  • #live_source_name => String

  • #program_name => String

  • #scheduled_start_time => Time

  • #source_location_name => String

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1062

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. A source location is a container for sources. For more information about source locations, see [Working with source locations] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html

Examples:

Request syntax with placeholder values

resp = client.create_source_location({
  access_configuration: {
    access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN, AUTODETECT_SIGV4
    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
  },
  segment_delivery_configurations: [
    {
      base_url: "__string",
      name: "__string",
    },
  ],
  source_location_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure

resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
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.segment_delivery_configurations #=> Array
resp.segment_delivery_configurations[0].base_url #=> String
resp.segment_delivery_configurations[0].name #=> String
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.

• :segment_delivery_configurations (Array<Types::SegmentDeliveryConfiguration>) —

  A list of the segment delivery configurations associated with this resource.

• :source_location_name (required, String) —

  The name associated with the source location.

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

  The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

Returns:

• (Types::CreateSourceLocationResponse) —

  Returns a response object which responds to the following methods:

  • #access_configuration => Types::AccessConfiguration

  • #arn => String

  • #creation_time => Time

  • #default_segment_delivery_configuration => Types::DefaultSegmentDeliveryConfiguration

  • #http_configuration => Types::HttpConfiguration

  • #last_modified_time => Time

  • #segment_delivery_configurations => Array&lt;Types::SegmentDeliveryConfiguration&gt;

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1165

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

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

The VOD source configuration parameters.

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>) —

  A list of HTTP package configuration parameters for this VOD source.

• :source_location_name (required, String) —

  The name of the source location for this VOD source.

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

  The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

• :vod_source_name (required, String) —

  The name associated with the VOD source.&gt;

Returns:

• (Types::CreateVodSourceResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1236

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. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

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) —

  The name of the channel.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1263

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

#delete_channel_policy(params = {}) ⇒ Struct

The channel policy to delete.

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) —

  The name of the channel associated with this channel policy.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1285

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

#delete_live_source(params = {}) ⇒ Struct

The live source to delete.

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :live_source_name (required, String) —

  The name of the live source.

• :source_location_name (required, String) —

  The name of the source location associated with this Live Source.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1311

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

#delete_playback_configuration(params = {}) ⇒ Struct

Deletes a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/configurations.html

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) —

  The name of the playback configuration.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1339

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

#delete_prefetch_schedule(params = {}) ⇒ Struct

Deletes a prefetch schedule for a specific playback configuration. If you call ‘DeletePrefetchSchedule` on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see [Using ad prefetching] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html

Examples:

Request syntax with placeholder values

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

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

• :playback_configuration_name (required, String) —

  The name of the playback configuration for this prefetch schedule.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1374

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

#delete_program(params = {}) ⇒ Struct

Deletes a program within a channel. For information about programs, see [Working with programs] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html

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) —

  The name of the channel.

• :program_name (required, String) —

  The name of the program.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1405

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. A source location is a container for sources. For more information about source locations, see [Working with source locations] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html

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) —

  The name of the source location.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1433

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

#delete_vod_source(params = {}) ⇒ Struct

The video on demand (VOD) source to delete.

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) —

  The name of the source location associated with this VOD Source.

• :vod_source_name (required, String) —

  The name of the VOD source.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1459

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

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

Describes a channel. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

Examples:

Request syntax with placeholder values

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

Response structure

resp.arn #=> String
resp.audiences #=> Array
resp.audiences[0] #=> 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.log_configuration.log_types #=> Array
resp.log_configuration.log_types[0] #=> String, one of "AS_RUN"
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.ad_markup_type #=> Array
resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
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
resp.tier #=> String
resp.time_shift_configuration.max_time_delay_seconds #=> Integer

Parameters:

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

  ({})

Options Hash (params):

• :channel_name (required, String) —

  The name of the channel.

Returns:

• (Types::DescribeChannelResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #audiences => Array&lt;String&gt;

  • #channel_name => String

  • #channel_state => String

  • #creation_time => Time

  • #filler_slate => Types::SlateSource

  • #last_modified_time => Time

  • #log_configuration => Types::LogConfigurationForChannel

  • #outputs => Array&lt;Types::ResponseOutputItem&gt;

  • #playback_mode => String

  • #tags => Hash&lt;String,String&gt;

  • #tier => String

  • #time_shift_configuration => Types::TimeShiftConfiguration

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1530

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

#describe_live_source(params = {}) ⇒ Types::DescribeLiveSourceResponse

The live source to describe.

Examples:

Request syntax with placeholder values

resp = client.describe_live_source({
  live_source_name: "__string", # required
  source_location_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.live_source_name #=> String
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :live_source_name (required, String) —

  The name of the live source.

• :source_location_name (required, String) —

  The name of the source location associated with this Live Source.

Returns:

• (Types::DescribeLiveSourceResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #live_source_name => String

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1578

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

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

Describes a program within a channel. For information about programs, see [Working with programs] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html

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].ad_break_metadata #=> Array
resp.ad_breaks[0].ad_break_metadata[0].key #=> String
resp.ad_breaks[0].ad_break_metadata[0].value #=> String
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
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.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.arn #=> String
resp.audience_media #=> Array
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].key #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].value #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
resp.audience_media[0].alternate_media[0].ad_breaks[0].offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.source_location_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.vod_source_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avail_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avails_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.end_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.start_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].duration_millis #=> Integer
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
resp.audience_media[0].audience #=> String
resp.channel_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.creation_time #=> Time
resp.duration_millis #=> Integer
resp.live_source_name #=> String
resp.program_name #=> String
resp.scheduled_start_time #=> Time
resp.source_location_name #=> String
resp.vod_source_name #=> String

Parameters:

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

  ({})

Options Hash (params):

• :channel_name (required, String) —

  The name of the channel associated with this Program.

• :program_name (required, String) —

  The name of the program.

Returns:

• (Types::DescribeProgramResponse) —

  Returns a response object which responds to the following methods:

  • #ad_breaks => Array&lt;Types::AdBreak&gt;

  • #arn => String

  • #audience_media => Array&lt;Types::AudienceMedia&gt;

  • #channel_name => String

  • #clip_range => Types::ClipRange

  • #creation_time => Time

  • #duration_millis => Integer

  • #live_source_name => String

  • #program_name => String

  • #scheduled_start_time => Time

  • #source_location_name => String

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1688

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

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

Describes a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html

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", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
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.segment_delivery_configurations #=> Array
resp.segment_delivery_configurations[0].base_url #=> String
resp.segment_delivery_configurations[0].name #=> String
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) —

  The name of the source location.

Returns:

• (Types::DescribeSourceLocationResponse) —

  Returns a response object which responds to the following methods:

  • #access_configuration => Types::AccessConfiguration

  • #arn => String

  • #creation_time => Time

  • #default_segment_delivery_configuration => Types::DefaultSegmentDeliveryConfiguration

  • #http_configuration => Types::HttpConfiguration

  • #last_modified_time => Time

  • #segment_delivery_configurations => Array&lt;Types::SegmentDeliveryConfiguration&gt;

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1744

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 video on demand (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.ad_break_opportunities #=> Array
resp.ad_break_opportunities[0].offset_millis #=> Integer
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) —

  The name of the source location associated with this VOD Source.

• :vod_source_name (required, String) —

  The name of the VOD Source.

Returns:

• (Types::DescribeVodSourceResponse) —

  Returns a response object which responds to the following methods:

  • #ad_break_opportunities => Array&lt;Types::AdBreakOpportunity&gt;

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1796

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

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

Returns the channel’s IAM policy. IAM policies are used to control access to your channel.

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) —

  The name of the channel associated with this Channel Policy.

Returns:

• (Types::GetChannelPolicyResponse) —

  Returns a response object which responds to the following methods:

  • #policy => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1825

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({
  audience: "__string",
  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].audiences #=> Array
resp.items[0].audiences[0] #=> String
resp.items[0].channel_name #=> String
resp.items[0].live_source_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", "ALTERNATE_MEDIA"
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):

• :audience (String) —

  The single audience for GetChannelScheduleRequest.

• :channel_name (required, String) —

  The name of the channel associated with this Channel Schedule.

• :duration_minutes (String) —

  The duration in minutes of the channel schedule.

• :max_results (Integer) —

  The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` channel schedules, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) — default: Optional —

  If the playback configuration has more than ‘MaxResults` channel schedules, use `NextToken` to get the second and subsequent pages of results.

  For the first ‘GetChannelScheduleRequest` request, omit this value.

  For the second and subsequent requests, get the value of ‘NextToken` from the previous response and specify that value for `NextToken` in the request.

  If the previous response didn’t include a ‘NextToken` element, there are no more channel schedules to get.

Returns:

• (Types::GetChannelScheduleResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::ScheduleEntry&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1903

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

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

Retrieves a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/configurations.html

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.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_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.insertion_mode #=> String, one of "STITCHED_ONLY", "PLAYER_SELECT"
resp.live_pre_roll_configuration.ad_decision_server_url #=> String
resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
resp.log_configuration.percent_enabled #=> 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) —

  The identifier for the playback configuration.

Returns:

• (Types::GetPlaybackConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #ad_decision_server_url => String

  • #avail_suppression => Types::AvailSuppression

  • #bumper => Types::Bumper

  • #cdn_configuration => Types::CdnConfiguration

  • #configuration_aliases => Hash&lt;String,Hash&lt;String,String&gt;&gt;

  • #dash_configuration => Types::DashConfiguration

  • #hls_configuration => Types::HlsConfiguration

  • #insertion_mode => String

  • #live_pre_roll_configuration => Types::LivePreRollConfiguration

  • #log_configuration => Types::LogConfiguration

  • #manifest_processing_rules => Types::ManifestProcessingRules

  • #name => String

  • #personalization_threshold_seconds => Integer

  • #playback_configuration_arn => String

  • #playback_endpoint_prefix => String

  • #session_initialization_endpoint_prefix => String

  • #slate_ad_url => String

  • #tags => Hash&lt;String,String&gt;

  • #transcode_profile_name => String

  • #video_content_source_url => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 1985

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

#get_prefetch_schedule(params = {}) ⇒ Types::GetPrefetchScheduleResponse

Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html

Examples:

Request syntax with placeholder values

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

Response structure

resp.arn #=> String
resp.consumption.avail_matching_criteria #=> Array
resp.consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.consumption.end_time #=> Time
resp.consumption.start_time #=> Time
resp.name #=> String
resp.playback_configuration_name #=> String
resp.retrieval.dynamic_variables #=> Hash
resp.retrieval.dynamic_variables["__string"] #=> String
resp.retrieval.end_time #=> Time
resp.retrieval.start_time #=> Time
resp.stream_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

• :playback_configuration_name (required, String) —

  Returns information about the prefetch schedule for a specific playback configuration. If you call ‘GetPrefetchSchedule` on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Returns:

• (Types::GetPrefetchScheduleResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #consumption => Types::PrefetchConsumption

  • #name => String

  • #playback_configuration_name => String

  • #retrieval => Types::PrefetchRetrieval

  • #stream_id => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2047

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

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

Lists the alerts that are associated with a MediaTailor channel assembly resource.

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

Examples:

Request syntax with placeholder values

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

Response structure

resp.items #=> Array
resp.items[0].alert_code #=> String
resp.items[0].alert_message #=> String
resp.items[0].category #=> String, one of "SCHEDULING_ERROR", "PLAYBACK_WARNING", "INFO"
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

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` alerts, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the resource.

Returns:

• (Types::ListAlertsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::Alert&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2099

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

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

Retrieves information about the channels that are associated with the current AWS account.

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

Examples:

Request syntax with placeholder values

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

Response structure

resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].audiences #=> Array
resp.items[0].audiences[0] #=> 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].log_configuration.log_types #=> Array
resp.items[0].log_configuration.log_types[0] #=> String, one of "AS_RUN"
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.ad_markup_type #=> Array
resp.items[0].outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
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.items[0].tier #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` channels, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Returns:

• (Types::ListChannelsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::Channel&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2166

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

#list_live_sources(params = {}) ⇒ Types::ListLiveSourcesResponse

Lists the live sources contained in a source location. A source represents a piece of content.

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_live_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].live_source_name #=> String
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) —

  The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` live sources, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• :source_location_name (required, String) —

  The name of the source location associated with this Live Sources list.

Returns:

• (Types::ListLiveSourcesResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::LiveSource&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2223

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

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

Retrieves existing playback configurations. For information about MediaTailor configurations, see [Working with Configurations in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/configurations.html

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.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
resp.items[0].avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_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].insertion_mode #=> String, one of "STITCHED_ONLY", "PLAYER_SELECT"
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].log_configuration.percent_enabled #=> 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) —

  The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` playback configurations, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Returns:

• (Types::ListPlaybackConfigurationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::PlaybackConfiguration&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2299

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

#list_prefetch_schedules(params = {}) ⇒ Types::ListPrefetchSchedulesResponse

Lists the prefetch schedules for a playback configuration.

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

Response structure

resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].consumption.avail_matching_criteria #=> Array
resp.items[0].consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.items[0].consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.items[0].consumption.end_time #=> Time
resp.items[0].consumption.start_time #=> Time
resp.items[0].name #=> String
resp.items[0].playback_configuration_name #=> String
resp.items[0].retrieval.dynamic_variables #=> Hash
resp.items[0].retrieval.dynamic_variables["__string"] #=> String
resp.items[0].retrieval.end_time #=> Time
resp.items[0].retrieval.start_time #=> Time
resp.items[0].stream_id #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :max_results (Integer) —

  The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` prefetch schedules, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) — default: Optional —

  If the playback configuration has more than ‘MaxResults` prefetch schedules, use `NextToken` to get the second and subsequent pages of results.

  For the first ‘ListPrefetchSchedulesRequest` request, omit this value.

  For the second and subsequent requests, get the value of ‘NextToken` from the previous response and specify that value for `NextToken` in the request.

  If the previous response didn’t include a ‘NextToken` element, there are no more prefetch schedules to get.

• :playback_configuration_name (required, String) —

  Retrieves the prefetch schedule(s) for a specific playback configuration.

• :stream_id (String) —

  An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

Returns:

• (Types::ListPrefetchSchedulesResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::PrefetchSchedule&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2372

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

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

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

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", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
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].segment_delivery_configurations #=> Array
resp.items[0].segment_delivery_configurations[0].base_url #=> String
resp.items[0].segment_delivery_configurations[0].name #=> String
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) —

  The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` source locations, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Returns:

• (Types::ListSourceLocationsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::SourceLocation&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2428

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

A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

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) —

  The Amazon Resource Name (ARN) associated with this resource.

Returns:

• (Types::ListTagsForResourceResponse) —

  Returns a response object which responds to the following methods:

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2464

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 the VOD sources contained in a source location. A source represents a piece of content.

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) —

  The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than ‘MaxResults` VOD sources, use the value of `NextToken` in the response to get the next page of results.

• :next_token (String) —

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• :source_location_name (required, String) —

  The name of the source location associated with this VOD Source list.

Returns:

• (Types::ListVodSourcesResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array&lt;Types::VodSource&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2520

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. IAM policies are used to control access to your 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) —

  The channel name associated with this Channel Policy.

• :policy (required, String) —

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2547

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

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

Creates a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/configurations.html

Examples:

Request syntax with placeholder values

resp = client.put_playback_configuration({
  ad_decision_server_url: "__string",
  avail_suppression: {
    fill_policy: "FULL_AVAIL_ONLY", # accepts FULL_AVAIL_ONLY, PARTIAL_AVAIL
    mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE, AFTER_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
  },
  insertion_mode: "STITCHED_ONLY", # accepts STITCHED_ONLY, PLAYER_SELECT
  live_pre_roll_configuration: {
    ad_decision_server_url: "__string",
    max_duration_seconds: 1,
  },
  manifest_processing_rules: {
    ad_marker_passthrough: {
      enabled: false,
    },
  },
  name: "__string", # required
  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.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_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.insertion_mode #=> String, one of "STITCHED_ONLY", "PLAYER_SELECT"
resp.live_pre_roll_configuration.ad_decision_server_url #=> String
resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
resp.log_configuration.percent_enabled #=> 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].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html

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

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html

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

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html

• :dash_configuration (Types::DashConfigurationForPut) —

  The configuration for DASH content.

• :insertion_mode (String) —

  The setting that controls whether players can use stitched or guided ad insertion. The default, ‘STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

• :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 (required, 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].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html

• :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. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

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

• (Types::PutPlaybackConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #ad_decision_server_url => String

  • #avail_suppression => Types::AvailSuppression

  • #bumper => Types::Bumper

  • #cdn_configuration => Types::CdnConfiguration

  • #configuration_aliases => Hash&lt;String,Hash&lt;String,String&gt;&gt;

  • #dash_configuration => Types::DashConfiguration

  • #hls_configuration => Types::HlsConfiguration

  • #insertion_mode => String

  • #live_pre_roll_configuration => Types::LivePreRollConfiguration

  • #log_configuration => Types::LogConfiguration

  • #manifest_processing_rules => Types::ManifestProcessingRules

  • #name => String

  • #personalization_threshold_seconds => Integer

  • #playback_configuration_arn => String

  • #playback_endpoint_prefix => String

  • #session_initialization_endpoint_prefix => String

  • #slate_ad_url => String

  • #tags => Hash&lt;String,String&gt;

  • #transcode_profile_name => String

  • #video_content_source_url => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2769

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

#start_channel(params = {}) ⇒ Struct

Starts a channel. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

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) —

  The name of the channel.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2796

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

#stop_channel(params = {}) ⇒ Struct

Stops a channel. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

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) —

  The name of the channel.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2823

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

#tag_resource(params = {}) ⇒ Struct

The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

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) —

  The Amazon Resource Name (ARN) associated with the resource.

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

  The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

  [1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2865

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

#untag_resource(params = {}) ⇒ Struct

The resource to untag.

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) —

  The Amazon Resource Name (ARN) of the resource to untag.

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

  The tag keys associated with the resource.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2891

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

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

Updates a channel. For information about MediaTailor channels, see

Working with channels][1

in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html

Examples:

Request syntax with placeholder values

resp = client.update_channel({
  audiences: ["String"],
  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: {
        ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
        manifest_window_seconds: 1,
      },
      manifest_name: "__string", # required
      source_group: "__string", # required
    },
  ],
  time_shift_configuration: {
    max_time_delay_seconds: 1, # required
  },
})

Response structure

resp.arn #=> String
resp.audiences #=> Array
resp.audiences[0] #=> 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.ad_markup_type #=> Array
resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
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
resp.tier #=> String
resp.time_shift_configuration.max_time_delay_seconds #=> Integer

Parameters:

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

  ({})

Options Hash (params):

• :audiences (Array<String>) —

  The list of audiences defined in channel.

• :channel_name (required, String) —

  The name of the channel.

• :filler_slate (Types::SlateSource) —

  The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the ‘LINEAR` `PlaybackMode`. MediaTailor doesn’t support filler slate for channels using the ‘LOOP` `PlaybackMode`.

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

  The channel’s output properties.

• :time_shift_configuration (Types::TimeShiftConfiguration) —

  The time-shifted viewing configuration you want to associate to the channel.

Returns:

• (Types::UpdateChannelResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #audiences => Array&lt;String&gt;

  • #channel_name => String

  • #channel_state => String

  • #creation_time => Time

  • #filler_slate => Types::SlateSource

  • #last_modified_time => Time

  • #outputs => Array&lt;Types::ResponseOutputItem&gt;

  • #playback_mode => String

  • #tags => Hash&lt;String,String&gt;

  • #tier => String

  • #time_shift_configuration => Types::TimeShiftConfiguration

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 2999

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

#update_live_source(params = {}) ⇒ Types::UpdateLiveSourceResponse

Updates a live source’s configuration.

Examples:

Request syntax with placeholder values

resp = client.update_live_source({
  http_package_configurations: [ # required
    {
      path: "__string", # required
      source_group: "__string", # required
      type: "DASH", # required, accepts DASH, HLS
    },
  ],
  live_source_name: "__string", # required
  source_location_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.live_source_name #=> String
resp.source_location_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

  ({})

Options Hash (params):

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

  A list of HTTP package configurations for the live source on this account.

• :live_source_name (required, String) —

  The name of the live source.

• :source_location_name (required, String) —

  The name of the source location associated with this Live Source.

Returns:

• (Types::UpdateLiveSourceResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #live_source_name => String

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 3058

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

#update_program(params = {}) ⇒ Types::UpdateProgramResponse

Updates a program within a channel.

Examples:

Request syntax with placeholder values

resp = client.update_program({
  ad_breaks: [
    {
      ad_break_metadata: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
      message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
      offset_millis: 1, # required
      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,
      },
      time_signal_message: {
        segmentation_descriptors: [
          {
            segment_num: 1,
            segmentation_event_id: 1,
            segmentation_type_id: 1,
            segmentation_upid: "String",
            segmentation_upid_type: 1,
            segments_expected: 1,
            sub_segment_num: 1,
            sub_segments_expected: 1,
          },
        ],
      },
    },
  ],
  audience_media: [
    {
      alternate_media: [
        {
          ad_breaks: [
            {
              ad_break_metadata: [
                {
                  key: "String", # required
                  value: "String", # required
                },
              ],
              message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
              offset_millis: 1, # required
              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,
              },
              time_signal_message: {
                segmentation_descriptors: [
                  {
                    segment_num: 1,
                    segmentation_event_id: 1,
                    segmentation_type_id: 1,
                    segmentation_upid: "String",
                    segmentation_upid_type: 1,
                    segments_expected: 1,
                    sub_segment_num: 1,
                    sub_segments_expected: 1,
                  },
                ],
              },
            },
          ],
          clip_range: {
            end_offset_millis: 1,
            start_offset_millis: 1,
          },
          duration_millis: 1,
          live_source_name: "__string",
          scheduled_start_time_millis: 1,
          source_location_name: "__string",
          vod_source_name: "__string",
        },
      ],
      audience: "__string",
    },
  ],
  channel_name: "__string", # required
  program_name: "__string", # required
  schedule_configuration: { # required
    clip_range: {
      end_offset_millis: 1,
      start_offset_millis: 1,
    },
    transition: {
      duration_millis: 1,
      scheduled_start_time_millis: 1,
    },
  },
})

Response structure

resp.ad_breaks #=> Array
resp.ad_breaks[0].ad_break_metadata #=> Array
resp.ad_breaks[0].ad_break_metadata[0].key #=> String
resp.ad_breaks[0].ad_break_metadata[0].value #=> String
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
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.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.arn #=> String
resp.audience_media #=> Array
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].key #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].ad_break_metadata[0].value #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
resp.audience_media[0].alternate_media[0].ad_breaks[0].offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.source_location_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].slate.vod_source_name #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avail_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.avails_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.end_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].clip_range.start_offset_millis #=> Integer
resp.audience_media[0].alternate_media[0].duration_millis #=> Integer
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
resp.audience_media[0].audience #=> String
resp.channel_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.creation_time #=> Time
resp.duration_millis #=> Integer
resp.live_source_name #=> String
resp.program_name #=> String
resp.scheduled_start_time #=> Time
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.

• :audience_media (Array<Types::AudienceMedia>) —

  The list of AudienceMedia defined in program.

• :channel_name (required, String) —

  The name of the channel for this Program.

• :program_name (required, String) —

  The name of the Program.

• :schedule_configuration (required, Types::UpdateProgramScheduleConfiguration) —

  The schedule configuration settings.

Returns:

• (Types::UpdateProgramResponse) —

  Returns a response object which responds to the following methods:

  • #ad_breaks => Array&lt;Types::AdBreak&gt;

  • #arn => String

  • #audience_media => Array&lt;Types::AudienceMedia&gt;

  • #channel_name => String

  • #clip_range => Types::ClipRange

  • #creation_time => Time

  • #duration_millis => Integer

  • #live_source_name => String

  • #program_name => String

  • #scheduled_start_time => Time

  • #source_location_name => String

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 3272

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

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

Updates a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html

Examples:

Request syntax with placeholder values

resp = client.update_source_location({
  access_configuration: {
    access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN, AUTODETECT_SIGV4
    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
  },
  segment_delivery_configurations: [
    {
      base_url: "__string",
      name: "__string",
    },
  ],
  source_location_name: "__string", # required
})

Response structure

resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
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.segment_delivery_configurations #=> Array
resp.segment_delivery_configurations[0].base_url #=> String
resp.segment_delivery_configurations[0].name #=> String
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.

• :segment_delivery_configurations (Array<Types::SegmentDeliveryConfiguration>) —

  A list of the segment delivery configurations associated with this resource.

• :source_location_name (required, String) —

  The name of the source location.

Returns:

• (Types::UpdateSourceLocationResponse) —

  Returns a response object which responds to the following methods:

  • #access_configuration => Types::AccessConfiguration

  • #arn => String

  • #creation_time => Time

  • #default_segment_delivery_configuration => Types::DefaultSegmentDeliveryConfiguration

  • #http_configuration => Types::HttpConfiguration

  • #last_modified_time => Time

  • #segment_delivery_configurations => Array&lt;Types::SegmentDeliveryConfiguration&gt;

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 3362

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 VOD source’s configuration.

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>) —

  A list of HTTP package configurations for the VOD source on this account.

• :source_location_name (required, String) —

  The name of the source location associated with this VOD Source.

• :vod_source_name (required, String) —

  The name of the VOD source.

Returns:

• (Types::UpdateVodSourceResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #creation_time => Time

  • #http_package_configurations => Array&lt;Types::HttpPackageConfiguration&gt;

  • #last_modified_time => Time

  • #source_location_name => String

  • #tags => Hash&lt;String,String&gt;

  • #vod_source_name => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-mediatailor/client.rb', line 3421

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

# File 'lib/aws-sdk-mediatailor/client.rb', line 3450

def waiter_names
  []
end