Class: Aws::MediaTailor::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-mediatailor/client.rb,
sig/client.rbs

Overview

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

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

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

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

Defined Under Namespace

Modules: _ConfigureLogsForChannelResponseSuccess, _ConfigureLogsForPlaybackConfigurationResponseSuccess, _CreateChannelResponseSuccess, _CreateLiveSourceResponseSuccess, _CreatePrefetchScheduleResponseSuccess, _CreateProgramResponseSuccess, _CreateSourceLocationResponseSuccess, _CreateVodSourceResponseSuccess, _DeleteChannelPolicyResponseSuccess, _DeleteChannelResponseSuccess, _DeleteFunctionResponseSuccess, _DeleteLiveSourceResponseSuccess, _DeletePlaybackConfigurationResponseSuccess, _DeletePrefetchScheduleResponseSuccess, _DeleteProgramResponseSuccess, _DeleteSourceLocationResponseSuccess, _DeleteVodSourceResponseSuccess, _DescribeChannelResponseSuccess, _DescribeLiveSourceResponseSuccess, _DescribeProgramResponseSuccess, _DescribeSourceLocationResponseSuccess, _DescribeVodSourceResponseSuccess, _GetChannelPolicyResponseSuccess, _GetChannelScheduleResponseSuccess, _GetFunctionResponseSuccess, _GetPlaybackConfigurationResponseSuccess, _GetPrefetchScheduleResponseSuccess, _ListAlertsResponseSuccess, _ListChannelsResponseSuccess, _ListFunctionsResponseSuccess, _ListLiveSourcesResponseSuccess, _ListPlaybackConfigurationsResponseSuccess, _ListPrefetchSchedulesResponseSuccess, _ListSourceLocationsResponseSuccess, _ListTagsForResourceResponseSuccess, _ListVodSourcesResponseSuccess, _PutChannelPolicyResponseSuccess, _PutFunctionResponseSuccess, _PutPlaybackConfigurationResponseSuccess, _StartChannelResponseSuccess, _StopChannelResponseSuccess, _UpdateChannelResponseSuccess, _UpdateLiveSourceResponseSuccess, _UpdateProgramResponseSuccess, _UpdateSourceLocationResponseSuccess, _UpdateVodSourceResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:request_output_item) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  


  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or instance of any one of the following classes:
    

      

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    

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

      

    • 

      Aws.config[:credentials]
      

      • 

    • 

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

      • 

    • 

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

      • 

    • 

      ~/.aws/credentials
      

      • 

    • 

      ~/.aws/config
      

      • 

    • 

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

      • 

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

      

    • Aws.config[:region]
      • 

    • ENV['AWS_REGION']
      • 

    • ENV['AMAZON_REGION']
      • 

    • ENV['AWS_DEFAULT_REGION']
      • 

    • ~/.aws/credentials
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :access_key_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :account_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :active_endpoint_cache
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, a thread polling for endpoints will be running in
the background every 60 secs (default). Defaults to false.
    
          
        
    • 
      
        
  • 
          :adaptive_retry_wait_to_fill
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in adaptive retry mode.  When true, the request will sleep
until there is sufficent client side capacity to retry the request.
When false, the request will raise a RetryCapacityNotAvailableError and will
not retry instead of sleeping.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, client-side metrics will be collected for all API requests from
this client.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_client_id
          (String)
          
            
              — default:
              ""
            
          
          
            — 
    Allows you to provide an identifier for this client which will be attached to
all generated client side metrics. Defaults to an empty string.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_host
          (String)
          
            
              — default:
              "127.0.0.1"
            
          
          
            — 
    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
side monitoring agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_port
          (Integer)
          
            
              — default:
              31000
            
          
          
            — 
    Required for publishing client metrics. The port that the client side monitoring
agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_publisher
          (Aws::ClientSideMonitoring::Publisher)
          
            
              — default:
              Aws::ClientSideMonitoring::Publisher
            
          
          
            — 
    Allows you to provide a custom client-side monitoring publisher class. By default,
will use the Client Side Monitoring Agent Publisher.
    
          
        
    • 
      
        
  • 
          :convert_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, an attempt is made to coerce request parameters into
the required types.
    
          
        
    • 
      
        
  • 
          :correct_clock_skew
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in standard and adaptive retry modes. Specifies whether to apply
a clock skew correction and retry requests with skewed client clocks.
    
          
        
    • 
      
        
  • 
          :defaults_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    See DefaultsModeConfiguration for a list of the
accepted modes and the configuration defaults that are included.
    
          
        
    • 
      
        
  • 
          :disable_host_prefix_injection
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_entries
          (Integer)
          
            
              — default:
              1000
            
          
          
            — 
    Used for the maximum size limit of the LRU cache storing endpoints data
for endpoint discovery enabled operations. Defaults to 1000.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_threads
          (Integer)
          
            
              — default:
              10
            
          
          
            — 
    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_poll_interval
          (Integer)
          
            
              — default:
              60
            
          
          
            — 
    When :endpoint_discovery and :active_endpoint_cache is enabled,
Use this option to config the time interval in seconds for making
requests fetching endpoints information. Defaults to 60 sec.
    
          
        
    • 
      
        
  • 
          :endpoint_discovery
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, endpoint discovery will be enabled for operations when available.
    
          
        
    • 
      
        
  • 
          :ignore_configured_endpoint_urls
          (Boolean)
          
            
          
          
            — 
    Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
    
          
        
    • 
      
        
  • 
          :log_formatter
          (Aws::Log::Formatter)
          
            
              — default:
              Aws::Log::Formatter.default
            
          
          
            — 
    The log formatter.
    
          
        
    • 
      
        
  • 
          :log_level
          (Symbol)
          
            
              — default:
              :info
            
          
          
            — 
    The log level to send messages to the :logger at.
    
          
        
    • 
      
        
  • 
          :logger
          (Logger)
          
            
          
          
            — 
    The Logger instance to send log messages to.  If this option
is not set, logging will be disabled.
    
          
        
    • 
      
        
  • 
          :max_attempts
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    An integer representing the maximum number attempts that will be made for
a single request, including the initial attempt.  For example,
setting this value to 5 will result in a request being retried up to
4 times. Used in standard and adaptive retry modes.
    
          
        
    • 
      
        
  • 
          :profile
          (String)
          
            
              — default:
              "default"
            
          
          
            — 
    Used when loading credentials from the shared credentials file at HOME/.aws/credentials.
When not specified, 'default' is used.
    
          
        
    • 
      
        
  • 
          :request_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

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

    • when_required - When set, a checksum will only be calculated for
request payloads of operations modeled with the  httpChecksum trait where
requestChecksumRequired is true or where a requestAlgorithmMember
is modeled and supplied.
      • 

    
          
        
    • 
      
        
  • 
          :request_min_compression_size_bytes
          (Integer)
          
            
              — default:
              10240
            
          
          
            — 
    The minimum size in bytes that triggers compression for request
bodies. The value must be non-negative integer value between 0
and 10485780 bytes inclusive.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

    • when_supported - (default) When set, checksum validation is performed on all
response payloads of operations modeled with the httpChecksum trait where
responseAlgorithms is modeled, except when no modeled checksum algorithms
are supported.
      • 

    • when_required - When set, checksum validation is not performed on
response payloads of operations unless the checksum algorithm is supported and
the requestValidationModeMember member is set to ENABLED.
      • 

    
          
        
    • 
      
        
  • 
          :retry_backoff
          (Proc)
          
            
          
          
            — 
    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_base_delay
          (Float)
          
            
              — default:
              0.3
            
          
          
            — 
    The base delay in seconds used by the default backoff function. This option
is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_jitter
          (Symbol)
          
            
              — default:
              :none
            
          
          
            — 
    A delay randomiser function used by the default backoff function.
Some predefined functions can be referenced by name - :none, :equal, :full,
otherwise a Proc that takes and returns a number. This option is only used
in the legacy retry mode.
    

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html
    
          
        
    • 
      
        
  • 
          :retry_limit
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    The maximum number of times to retry failed requests.  Only
~ 500 level server errors and certain ~ 400 level client errors
are retried.  Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors, auth errors,
endpoint discovery, and errors from expired credentials.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_max_delay
          (Integer)
          
            
              — default:
              0
            
          
          
            — 
    The maximum number of seconds to delay between retries (0 for no limit)
used by the default backoff function. This option is only used in the
legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    Specifies which retry algorithm to use. Values are:
    

      

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    
          
        
    • 
      
        
  • 
          :sdk_ua_app_id
          (String)
          
            
          
          
            — 
    A unique and opaque application ID that is appended to the
User-Agent header as app/sdk_ua_app_id. It should have a
maximum length of 50. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

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

    ** Please note ** When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

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

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

      

    • 

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

      • 

    • 

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

      • 

    

    When :token_provider is not configured directly, the Aws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files.
    
          
        
    • 
      
        
  • 
          :use_dualstack_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, dualstack enabled endpoints (with .aws TLD)
will be used if available.
    
          
        
    • 
      
        
  • 
          :use_fips_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, fips compatible endpoints will be used if available.
When a fips region is used, the region is normalized and this config
is set to true.
    
          
        
    • 
      
        
  • 
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, request parameters are validated before
sending the request.
    
          
        
    • 
      
        
  • 
          :endpoint_provider
          (Aws::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 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :http_read_timeout
          (Float)
          
            
              — default:
              60
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true,  HTTP debug output will be sent to the :logger.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :ssl_ca_bundle
          (String)
          
            
          
          
            — 
    Full path to the SSL certificate authority bundle file that should be used when
verifying peer certificates.  If you do not pass :ssl_ca_bundle or
:ssl_ca_directory the the system default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_directory
          (String)
          
            
          
          
            — 
    Full path of the directory that contains the unbundled SSL certificate
authority files for verifying peer certificates.  If you do
not pass :ssl_ca_bundle or :ssl_ca_directory the the system
default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


471
472
473

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

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.




  





  



  

    
      


4339
4340
4341

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

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.




  





  



  

    
      


4342
4343
4344

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

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  


  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

    
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: {})
      
      
    
    • 
  






  

    
      


4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328

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

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



  
See Also:

  



  

    
      


87

    		
    
      
# File 'sig/client.rbs', line 87

def configure_logs_for_channel: (

    		
  





    
      

  

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

  

  


  

    
Defines where AWS Elemental MediaTailor sends logs for the playback
configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.configure_logs_for_playback_configuration({
  percent_enabled: 1, # required
  playback_configuration_name: "__string", # required
  enabled_logging_strategies: ["VENDED_LOGS"], # accepts VENDED_LOGS, LEGACY_CLOUDWATCH
  ads_interaction_log: {
    publish_opt_in_event_types: ["RAW_ADS_RESPONSE"], # accepts RAW_ADS_RESPONSE, RAW_ADS_REQUEST, PRE_ADS_REQUEST_HOOK_SUMMARY, PRE_ADS_REQUEST_FUNCTION_COMPLETED
    exclude_event_types: ["AD_MARKER_FOUND"], # accepts AD_MARKER_FOUND, NON_AD_MARKER_FOUND, MAKING_ADS_REQUEST, MODIFIED_TARGET_URL, VAST_REDIRECT, EMPTY_VAST_RESPONSE, EMPTY_VMAP_RESPONSE, VAST_RESPONSE, REDIRECTED_VAST_RESPONSE, FILLED_AVAIL, FILLED_OVERLAY_AVAIL, BEACON_FIRED, WARNING_NO_ADVERTISEMENTS, WARNING_VPAID_AD_DROPPED, WARNING_URL_VARIABLE_SUBSTITUTION_FAILED, ERROR_UNKNOWN, ERROR_UNKNOWN_HOST, ERROR_DISALLOWED_HOST, ERROR_ADS_IO, ERROR_ADS_TIMEOUT, ERROR_ADS_RESPONSE_PARSE, ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT, ERROR_ADS_INVALID_RESPONSE, ERROR_VAST_REDIRECT_EMPTY_RESPONSE, ERROR_VAST_REDIRECT_MULTIPLE_VAST, ERROR_VAST_REDIRECT_FAILED, ERROR_VAST_MISSING_MEDIAFILES, ERROR_VAST_MISSING_CREATIVES, ERROR_VAST_MISSING_OVERLAYS, ERROR_VAST_MISSING_IMPRESSION, ERROR_VAST_INVALID_VAST_AD_TAG_URI, ERROR_VAST_MULTIPLE_TRACKING_EVENTS, ERROR_VAST_MULTIPLE_LINEAR, ERROR_VAST_INVALID_MEDIA_FILE, ERROR_FIRING_BEACON_FAILED, ERROR_PERSONALIZATION_DISABLED, VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET, VOD_TIME_BASED_AVAIL_PLAN_SUCCESS, VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS, INTERSTITIAL_VOD_SUCCESS, INTERSTITIAL_VOD_FAILURE, PRE_ADS_REQUEST_HOOK_ERROR, PRE_ADS_REQUEST_FUNCTION_ERROR
  },
  manifest_service_interaction_log: {
    publish_opt_in_event_types: ["PRE_SESSION_INIT_HOOK_SUMMARY"], # accepts PRE_SESSION_INIT_HOOK_SUMMARY, PRE_SESSION_INIT_FUNCTION_COMPLETED
    exclude_event_types: ["GENERATED_MANIFEST"], # accepts GENERATED_MANIFEST, ORIGIN_MANIFEST, SESSION_INITIALIZED, TRACKING_RESPONSE, CONFIG_SYNTAX_ERROR, CONFIG_SECURITY_ERROR, UNKNOWN_HOST, TIMEOUT_ERROR, CONNECTION_ERROR, IO_ERROR, UNKNOWN_ERROR, HOST_DISALLOWED, PARSING_ERROR, MANIFEST_ERROR, NO_MASTER_OR_MEDIA_PLAYLIST, NO_MASTER_PLAYLIST, NO_MEDIA_PLAYLIST, INCOMPATIBLE_HLS_VERSION, SCTE35_PARSING_ERROR, INVALID_SINGLE_PERIOD_DASH_MANIFEST, UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST, LAST_PERIOD_MISSING_AUDIO, LAST_PERIOD_MISSING_AUDIO_WARNING, ERROR_ORIGIN_PREFIX_INTERPOLATION, ERROR_ADS_INTERPOLATION, ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION, ERROR_CDN_AD_SEGMENT_INTERPOLATION, ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION, ERROR_SLATE_AD_URL_INTERPOLATION, ERROR_PROFILE_NAME_INTERPOLATION, ERROR_BUMPER_START_INTERPOLATION, ERROR_BUMPER_END_INTERPOLATION, PRE_SESSION_INIT_HOOK_ERROR, PRE_SESSION_INIT_FUNCTION_ERROR
  },
})

    
      
        
Response structure

      
      

resp.percent_enabled #=> Integer
resp.playback_configuration_name #=> String
resp.enabled_logging_strategies #=> Array
resp.enabled_logging_strategies[0] #=> String, one of "VENDED_LOGS", "LEGACY_CLOUDWATCH"
resp.ads_interaction_log.publish_opt_in_event_types #=> Array
resp.ads_interaction_log.publish_opt_in_event_types[0] #=> String, one of "RAW_ADS_RESPONSE", "RAW_ADS_REQUEST", "PRE_ADS_REQUEST_HOOK_SUMMARY", "PRE_ADS_REQUEST_FUNCTION_COMPLETED"
resp.ads_interaction_log.exclude_event_types #=> Array
resp.ads_interaction_log.exclude_event_types[0] #=> String, one of "AD_MARKER_FOUND", "NON_AD_MARKER_FOUND", "MAKING_ADS_REQUEST", "MODIFIED_TARGET_URL", "VAST_REDIRECT", "EMPTY_VAST_RESPONSE", "EMPTY_VMAP_RESPONSE", "VAST_RESPONSE", "REDIRECTED_VAST_RESPONSE", "FILLED_AVAIL", "FILLED_OVERLAY_AVAIL", "BEACON_FIRED", "WARNING_NO_ADVERTISEMENTS", "WARNING_VPAID_AD_DROPPED", "WARNING_URL_VARIABLE_SUBSTITUTION_FAILED", "ERROR_UNKNOWN", "ERROR_UNKNOWN_HOST", "ERROR_DISALLOWED_HOST", "ERROR_ADS_IO", "ERROR_ADS_TIMEOUT", "ERROR_ADS_RESPONSE_PARSE", "ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT", "ERROR_ADS_INVALID_RESPONSE", "ERROR_VAST_REDIRECT_EMPTY_RESPONSE", "ERROR_VAST_REDIRECT_MULTIPLE_VAST", "ERROR_VAST_REDIRECT_FAILED", "ERROR_VAST_MISSING_MEDIAFILES", "ERROR_VAST_MISSING_CREATIVES", "ERROR_VAST_MISSING_OVERLAYS", "ERROR_VAST_MISSING_IMPRESSION", "ERROR_VAST_INVALID_VAST_AD_TAG_URI", "ERROR_VAST_MULTIPLE_TRACKING_EVENTS", "ERROR_VAST_MULTIPLE_LINEAR", "ERROR_VAST_INVALID_MEDIA_FILE", "ERROR_FIRING_BEACON_FAILED", "ERROR_PERSONALIZATION_DISABLED", "VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET", "VOD_TIME_BASED_AVAIL_PLAN_SUCCESS", "VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS", "INTERSTITIAL_VOD_SUCCESS", "INTERSTITIAL_VOD_FAILURE", "PRE_ADS_REQUEST_HOOK_ERROR", "PRE_ADS_REQUEST_FUNCTION_ERROR"
resp.manifest_service_interaction_log.publish_opt_in_event_types #=> Array
resp.manifest_service_interaction_log.publish_opt_in_event_types[0] #=> String, one of "PRE_SESSION_INIT_HOOK_SUMMARY", "PRE_SESSION_INIT_FUNCTION_COMPLETED"
resp.manifest_service_interaction_log.exclude_event_types #=> Array
resp.manifest_service_interaction_log.exclude_event_types[0] #=> String, one of "GENERATED_MANIFEST", "ORIGIN_MANIFEST", "SESSION_INITIALIZED", "TRACKING_RESPONSE", "CONFIG_SYNTAX_ERROR", "CONFIG_SECURITY_ERROR", "UNKNOWN_HOST", "TIMEOUT_ERROR", "CONNECTION_ERROR", "IO_ERROR", "UNKNOWN_ERROR", "HOST_DISALLOWED", "PARSING_ERROR", "MANIFEST_ERROR", "NO_MASTER_OR_MEDIA_PLAYLIST", "NO_MASTER_PLAYLIST", "NO_MEDIA_PLAYLIST", "INCOMPATIBLE_HLS_VERSION", "SCTE35_PARSING_ERROR", "INVALID_SINGLE_PERIOD_DASH_MANIFEST", "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST", "LAST_PERIOD_MISSING_AUDIO", "LAST_PERIOD_MISSING_AUDIO_WARNING", "ERROR_ORIGIN_PREFIX_INTERPOLATION", "ERROR_ADS_INTERPOLATION", "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION", "ERROR_CDN_AD_SEGMENT_INTERPOLATION", "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION", "ERROR_SLATE_AD_URL_INTERPOLATION", "ERROR_PROFILE_NAME_INTERPOLATION", "ERROR_BUMPER_START_INTERPOLATION", "ERROR_BUMPER_END_INTERPOLATION", "PRE_SESSION_INIT_HOOK_ERROR", "PRE_SESSION_INIT_FUNCTION_ERROR"

    
  


  

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
    
          
        
    • 
      
        
  • 
          :playback_configuration_name
          (required, String)
          
            
          
          
            — 
    The name of the playback configuration.
    
          
        
    • 
      
        
  • 
          :enabled_logging_strategies
          (Array<String>)
          
            
          
          
            — 
    The method used for collecting logs from AWS Elemental MediaTailor. To
configure MediaTailor to send logs directly to Amazon CloudWatch Logs,
choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to
CloudWatch, which then vends the logs to your destination of choice,
choose VENDED_LOGS. Supported destinations are CloudWatch Logs log
group, Amazon S3 bucket, and Amazon Data Firehose stream.
    

    To use vended logs, you must configure the delivery destination in
Amazon CloudWatch, as described in Enable logging from AWS services,
Logging that requires additional permissions [V2].
    
          
        
    • 
      
        
  • 
          :ads_interaction_log
          (Types::AdsInteractionLog)
          
            
          
          
            — 
    The event types that MediaTailor emits in logs for interactions with
the ADS.
    
          
        
    • 
      
        
  • 
          :manifest_service_interaction_log
          (Types::ManifestServiceInteractionLog)
          
            
          
          
            — 
    The event types that MediaTailor emits in logs for interactions with
the origin server.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


102

    		
    
      
# File 'sig/client.rbs', line 102

def configure_logs_for_playback_configuration: (

    		
  





    
      

  

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

  

  


  

    
Creates a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_channel({
  channel_name: "__string", # required
  filler_slate: {
    source_location_name: "__string",
    vod_source_name: "__string",
  },
  outputs: [ # required
    {
      dash_playlist_settings: {
        manifest_window_seconds: 1,
        min_buffer_time_seconds: 1,
        min_update_period_seconds: 1,
        suggested_presentation_delay_seconds: 1,
      },
      hls_playlist_settings: {
        manifest_window_seconds: 1,
        ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
      },
      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
  },
  audiences: ["String"],
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.filler_slate.source_location_name #=> String
resp.filler_slate.vod_source_name #=> String
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].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].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].dual_stack_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
resp.audiences #=> Array
resp.audiences[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :tier
          (String)
          
            
          
          
            — 
    The tier of the channel.
    
          
        
    • 
      
        
  • 
          :time_shift_configuration
          (Types::TimeShiftConfiguration)
          
            
          
          
            — 
    The time-shifted viewing configuration you want to associate to the
channel.
    
          
        
    • 
      
        
  • 
          :audiences
          (Array<String>)
          
            
          
          
            — 
    The list of audiences defined in channel.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


133

    		
    
      
# File 'sig/client.rbs', line 133

def create_channel: (

    		
  





    
      

  

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

  
    
    


Returns:



  
See Also:

  



  

    
      


163

    		
    
      
# File 'sig/client.rbs', line 163

def create_live_source: (

    		
  





    
      

  

  
    #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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_prefetch_schedule({
  consumption: {
    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: {
    dynamic_variables: {
      "__string" => "__string",
    },
    end_time: Time.now, # required
    start_time: Time.now,
    traffic_shaping_type: "RETRIEVAL_WINDOW", # accepts RETRIEVAL_WINDOW, TPS
    traffic_shaping_retrieval_window: {
      retrieval_window_duration_seconds: 1,
    },
    traffic_shaping_tps_configuration: {
      peak_tps: 1,
      peak_concurrent_users: 1,
    },
  },
  recurring_prefetch_configuration: {
    start_time: Time.now,
    end_time: Time.now, # required
    recurring_consumption: { # required
      retrieved_ad_expiration_seconds: 1,
      avail_matching_criteria: [
        {
          dynamic_variable: "__string", # required
          operator: "EQUALS", # required, accepts EQUALS
        },
      ],
    },
    recurring_retrieval: { # required
      dynamic_variables: {
        "__string" => "__string",
      },
      delay_after_avail_end_seconds: 1,
      traffic_shaping_type: "RETRIEVAL_WINDOW", # accepts RETRIEVAL_WINDOW, TPS
      traffic_shaping_retrieval_window: {
        retrieval_window_duration_seconds: 1,
      },
      traffic_shaping_tps_configuration: {
        peak_tps: 1,
        peak_concurrent_users: 1,
      },
    },
  },
  schedule_type: "SINGLE", # accepts SINGLE, RECURRING
  stream_id: "__string",
  tags: {
    "__string" => "__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.retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.recurring_prefetch_configuration.start_time #=> Time
resp.recurring_prefetch_configuration.end_time #=> Time
resp.recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
resp.recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.schedule_type #=> String, one of "SINGLE", "RECURRING"
resp.stream_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :consumption
          (Types::PrefetchConsumption)
          
            
          
          
            — 
    The configuration settings for how and when MediaTailor consumes
prefetched ads from the ad decision server for single prefetch
schedules. 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
          (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.
    
          
        
    • 
      
        
  • 
          :recurring_prefetch_configuration
          (Types::RecurringPrefetchConfiguration)
          
            
          
          
            — 
    The configuration that defines how and when MediaTailor performs ad
prefetching in a live event.
    
          
        
    • 
      
        
  • 
          :schedule_type
          (String)
          
            
          
          
            — 
    The frequency that MediaTailor creates prefetch schedules. SINGLE
indicates that this schedule applies to one ad break. RECURRING
indicates that MediaTailor automatically creates a schedule for each
ad avail in a live event.
    

    For more information about the prefetch types and when you might use
each, see Prefetching ads in Elemental MediaTailor.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    The tags to assign to the prefetch schedule. 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


190

    		
    
      
# File 'sig/client.rbs', line 190

def create_prefetch_schedule: (

    		
  





    
      

  

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

  

  


  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.ad_breaks #=> Array
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].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> 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_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> 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.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.arn #=> String
resp.channel_name #=> String
resp.creation_time #=> Time
resp.live_source_name #=> String
resp.program_name #=> String
resp.scheduled_start_time #=> Time
resp.source_location_name #=> String
resp.vod_source_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.duration_millis #=> Integer
resp.audience_media #=> Array
resp.audience_media[0].audience #=> String
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
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].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
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].segmentation_event_id #=> Integer
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].segmentation_upid #=> String
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].segment_num #=> 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].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].duration_millis #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :ad_breaks
          (Array<Types::AdBreak>)
          
            
          
          
            — 
    The ad break configuration settings.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :audience_media
          (Array<Types::AudienceMedia>)
          
            
          
          
            — 
    The list of AudienceMedia defined in program.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    The tags to assign to the program. 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


264

    		
    
      
# File 'sig/client.rbs', line 264

def create_program: (

    		
  





    
      

  

  
    #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.


  





  
  

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

  
    
    


Returns:



  
See Also:

  



  

    
      


306

    		
    
      
# File 'sig/client.rbs', line 306

def create_source_location: (

    		
  





    
      

  

  
    #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.
    
          
        
    • 
      
        
  • 
          :vod_source_name
          (required, String)
          
            
          
          
            — 
    The name associated with the VOD source.>
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


336

    		
    
      
# File 'sig/client.rbs', line 336

def create_vod_source: (

    		
  





    
      

  

  
    #delete_channel(params = {})  ⇒ Struct 
  

  

  


  

    
Deletes a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
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:

  



  

    
      


354

    		
    
      
# File 'sig/client.rbs', line 354

def delete_channel: (

    		
  





    
      

  

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

  



  

    
      


363

    		
    
      
# File 'sig/client.rbs', line 363

def delete_channel_policy: (

    		
  





    
      

  

  
    #delete_function(params = {})  ⇒ Struct 
  

  

  


  

    
Deletes a function. MediaTailor prevents deletion of a function that
is still referenced by a playback configuration or by another
function. Remove all references before deleting. For more information
about functions, see Working with functions in the MediaTailor
User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_function({
  function_id: "__string", # required
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :function_id
          (required, String)
          
            
          
          
            — 
    The identifier of the function to delete.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


372

    		
    
      
# File 'sig/client.rbs', line 372

def delete_function: (

    		
  





    
      

  

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

  



  

    
      


381

    		
    
      
# File 'sig/client.rbs', line 381

def delete_live_source: (

    		
  





    
      

  

  
    #delete_playback_configuration(params = {})  ⇒ Struct 
  

  

  


  

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


  





  
  

    
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:

  



  

    
      


391

    		
    
      
# File 'sig/client.rbs', line 391

def delete_playback_configuration: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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:

  



  

    
      


400

    		
    
      
# File 'sig/client.rbs', line 400

def delete_prefetch_schedule: (

    		
  





    
      

  

  
    #delete_program(params = {})  ⇒ Struct 
  

  

  


  

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


  





  
  

    
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:

  



  

    
      


410

    		
    
      
# File 'sig/client.rbs', line 410

def delete_program: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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:

  



  

    
      


420

    		
    
      
# File 'sig/client.rbs', line 420

def delete_source_location: (

    		
  





    
      

  

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

  



  

    
      


429

    		
    
      
# File 'sig/client.rbs', line 429

def delete_vod_source: (

    		
  





    
      

  

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

  

  


  

    
Describes a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.filler_slate.source_location_name #=> String
resp.filler_slate.vod_source_name #=> String
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].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].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].dual_stack_playback_url #=> String
resp.outputs[0].source_group #=> String
resp.playback_mode #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.tier #=> String
resp.log_configuration.log_types #=> Array
resp.log_configuration.log_types[0] #=> String, one of "AS_RUN"
resp.time_shift_configuration.max_time_delay_seconds #=> Integer
resp.audiences #=> Array
resp.audiences[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :channel_name
          (required, String)
          
            
          
          
            — 
    The name of the channel.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


452

    		
    
      
# File 'sig/client.rbs', line 452

def describe_channel: (

    		
  





    
      

  

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



  
See Also:

  



  

    
      


468

    		
    
      
# File 'sig/client.rbs', line 468

def describe_live_source: (

    		
  





    
      

  

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

  

  


  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.ad_breaks #=> Array
resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "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].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> 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_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> 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.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.arn #=> String
resp.channel_name #=> String
resp.creation_time #=> Time
resp.live_source_name #=> String
resp.program_name #=> String
resp.scheduled_start_time #=> Time
resp.source_location_name #=> String
resp.vod_source_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.duration_millis #=> Integer
resp.audience_media #=> Array
resp.audience_media[0].audience #=> String
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
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].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
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].segmentation_event_id #=> Integer
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].segmentation_upid #=> String
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].segment_num #=> 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].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].duration_millis #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> 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:



  
See Also:

  



  

    
      


491

    		
    
      
# File 'sig/client.rbs', line 491

def describe_program: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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:



  
See Also:

  



  

    
      


510

    		
    
      
# File 'sig/client.rbs', line 510

def describe_source_location: (

    		
  





    
      

  

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



  
See Also:

  



  

    
      


527

    		
    
      
# File 'sig/client.rbs', line 527

def describe_vod_source: (

    		
  





    
      

  

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



  
See Also:

  



  

    
      


538

    		
    
      
# File 'sig/client.rbs', line 538

def get_channel_policy: (

    		
  





    
      

  

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

  

  


  

    
Retrieves information about your channel's schedule.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_channel_schedule({
  channel_name: "__string", # required
  duration_minutes: "__string",
  max_results: 1,
  next_token: "__string",
  audience: "__string",
})

    
      
        
Response structure

      
      

resp.items #=> Array
resp.items[0].approximate_duration_seconds #=> Integer
resp.items[0].approximate_start_time #=> Time
resp.items[0].arn #=> String
resp.items[0].channel_name #=> String
resp.items[0].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.items[0].audiences #=> Array
resp.items[0].audiences[0] #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :audience
          (String)
          
            
          
          
            — 
    The single audience for GetChannelScheduleRequest.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


549

    		
    
      
# File 'sig/client.rbs', line 549

def get_channel_schedule: (

    		
  





    
      

  

  
    #get_function(params = {})  ⇒ Types::GetFunctionResponse 
  

  

  


  

    
Retrieves the configuration and metadata for a function. For more
information about functions, see Working with functions in the
MediaTailor User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_function({
  function_id: "__string", # required
})

    
      
        
Response structure

      
      

resp.function_id #=> String
resp.function_type #=> String, one of "HTTP_REQUEST", "CUSTOM_OUTPUT", "CONCURRENT_EXECUTOR", "SEQUENTIAL_EXECUTOR"
resp.description #=> String
resp.http_request_configuration.runtime #=> String, one of "JSONATA"
resp.http_request_configuration.output #=> Hash
resp.http_request_configuration.output["__string"] #=> String
resp.http_request_configuration.method_type #=> String, one of "GET", "POST"
resp.http_request_configuration.request_timeout_milliseconds #=> Integer
resp.http_request_configuration.url #=> String
resp.http_request_configuration.body #=> String
resp.http_request_configuration.headers #=> Hash
resp.http_request_configuration.headers["__string"] #=> String
resp.custom_output_configuration.runtime #=> String, one of "JSONATA"
resp.custom_output_configuration.output #=> Hash
resp.custom_output_configuration.output["__string"] #=> String
resp.concurrent_executor_configuration.runtime #=> String, one of "JSONATA"
resp.concurrent_executor_configuration.output #=> Hash
resp.concurrent_executor_configuration.output["__string"] #=> String
resp.concurrent_executor_configuration.function_list #=> Array
resp.concurrent_executor_configuration.function_list[0].run_condition #=> String
resp.concurrent_executor_configuration.function_list[0].function_id #=> String
resp.concurrent_executor_configuration.function_list[0].alias #=> String
resp.concurrent_executor_configuration.timeout_milliseconds #=> Integer
resp.concurrent_executor_configuration.max_concurrency #=> Integer
resp.sequential_executor_configuration.runtime #=> String, one of "JSONATA"
resp.sequential_executor_configuration.output #=> Hash
resp.sequential_executor_configuration.output["__string"] #=> String
resp.sequential_executor_configuration.function_list #=> Array
resp.sequential_executor_configuration.function_list[0].run_condition #=> String
resp.sequential_executor_configuration.function_list[0].function_id #=> String
resp.sequential_executor_configuration.function_list[0].alias #=> String
resp.sequential_executor_configuration.timeout_milliseconds #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :function_id
          (required, String)
          
            
          
          
            — 
    The identifier of the function.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


571

    		
    
      
# File 'sig/client.rbs', line 571

def get_function: (

    		
  





    
      

  

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

  

  


  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.ad_decision_server_url #=> String
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
resp.avail_suppression.value #=> String
resp.avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
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.dual_stack_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.hls_configuration.dual_stack_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.live_pre_roll_configuration.ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE"
resp.log_configuration.percent_enabled #=> Integer
resp.log_configuration.enabled_logging_strategies #=> Array
resp.log_configuration.enabled_logging_strategies[0] #=> String, one of "VENDED_LOGS", "LEGACY_CLOUDWATCH"
resp.log_configuration.ads_interaction_log.publish_opt_in_event_types #=> Array
resp.log_configuration.ads_interaction_log.publish_opt_in_event_types[0] #=> String, one of "RAW_ADS_RESPONSE", "RAW_ADS_REQUEST", "PRE_ADS_REQUEST_HOOK_SUMMARY", "PRE_ADS_REQUEST_FUNCTION_COMPLETED"
resp.log_configuration.ads_interaction_log.exclude_event_types #=> Array
resp.log_configuration.ads_interaction_log.exclude_event_types[0] #=> String, one of "AD_MARKER_FOUND", "NON_AD_MARKER_FOUND", "MAKING_ADS_REQUEST", "MODIFIED_TARGET_URL", "VAST_REDIRECT", "EMPTY_VAST_RESPONSE", "EMPTY_VMAP_RESPONSE", "VAST_RESPONSE", "REDIRECTED_VAST_RESPONSE", "FILLED_AVAIL", "FILLED_OVERLAY_AVAIL", "BEACON_FIRED", "WARNING_NO_ADVERTISEMENTS", "WARNING_VPAID_AD_DROPPED", "WARNING_URL_VARIABLE_SUBSTITUTION_FAILED", "ERROR_UNKNOWN", "ERROR_UNKNOWN_HOST", "ERROR_DISALLOWED_HOST", "ERROR_ADS_IO", "ERROR_ADS_TIMEOUT", "ERROR_ADS_RESPONSE_PARSE", "ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT", "ERROR_ADS_INVALID_RESPONSE", "ERROR_VAST_REDIRECT_EMPTY_RESPONSE", "ERROR_VAST_REDIRECT_MULTIPLE_VAST", "ERROR_VAST_REDIRECT_FAILED", "ERROR_VAST_MISSING_MEDIAFILES", "ERROR_VAST_MISSING_CREATIVES", "ERROR_VAST_MISSING_OVERLAYS", "ERROR_VAST_MISSING_IMPRESSION", "ERROR_VAST_INVALID_VAST_AD_TAG_URI", "ERROR_VAST_MULTIPLE_TRACKING_EVENTS", "ERROR_VAST_MULTIPLE_LINEAR", "ERROR_VAST_INVALID_MEDIA_FILE", "ERROR_FIRING_BEACON_FAILED", "ERROR_PERSONALIZATION_DISABLED", "VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET", "VOD_TIME_BASED_AVAIL_PLAN_SUCCESS", "VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS", "INTERSTITIAL_VOD_SUCCESS", "INTERSTITIAL_VOD_FAILURE", "PRE_ADS_REQUEST_HOOK_ERROR", "PRE_ADS_REQUEST_FUNCTION_ERROR"
resp.log_configuration.manifest_service_interaction_log.publish_opt_in_event_types #=> Array
resp.log_configuration.manifest_service_interaction_log.publish_opt_in_event_types[0] #=> String, one of "PRE_SESSION_INIT_HOOK_SUMMARY", "PRE_SESSION_INIT_FUNCTION_COMPLETED"
resp.log_configuration.manifest_service_interaction_log.exclude_event_types #=> Array
resp.log_configuration.manifest_service_interaction_log.exclude_event_types[0] #=> String, one of "GENERATED_MANIFEST", "ORIGIN_MANIFEST", "SESSION_INITIALIZED", "TRACKING_RESPONSE", "CONFIG_SYNTAX_ERROR", "CONFIG_SECURITY_ERROR", "UNKNOWN_HOST", "TIMEOUT_ERROR", "CONNECTION_ERROR", "IO_ERROR", "UNKNOWN_ERROR", "HOST_DISALLOWED", "PARSING_ERROR", "MANIFEST_ERROR", "NO_MASTER_OR_MEDIA_PLAYLIST", "NO_MASTER_PLAYLIST", "NO_MEDIA_PLAYLIST", "INCOMPATIBLE_HLS_VERSION", "SCTE35_PARSING_ERROR", "INVALID_SINGLE_PERIOD_DASH_MANIFEST", "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST", "LAST_PERIOD_MISSING_AUDIO", "LAST_PERIOD_MISSING_AUDIO_WARNING", "ERROR_ORIGIN_PREFIX_INTERPOLATION", "ERROR_ADS_INTERPOLATION", "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION", "ERROR_CDN_AD_SEGMENT_INTERPOLATION", "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION", "ERROR_SLATE_AD_URL_INTERPOLATION", "ERROR_PROFILE_NAME_INTERPOLATION", "ERROR_BUMPER_START_INTERPOLATION", "ERROR_BUMPER_END_INTERPOLATION", "PRE_SESSION_INIT_HOOK_ERROR", "PRE_SESSION_INIT_FUNCTION_ERROR"
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.dual_stack_playback_endpoint_prefix #=> String
resp.session_initialization_endpoint_prefix #=> String
resp.dual_stack_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
resp.ad_conditioning_configuration.streaming_media_file_conditioning #=> String, one of "TRANSCODE", "NONE"
resp.ad_decision_server_configuration.http_request.method #=> String, one of "GET", "POST"
resp.ad_decision_server_configuration.http_request.body #=> String
resp.ad_decision_server_configuration.http_request.headers #=> Hash
resp.ad_decision_server_configuration.http_request.headers["__string"] #=> String
resp.ad_decision_server_configuration.http_request.compress_request #=> String, one of "NONE", "GZIP"
resp.ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE", "FOLLOW_AD_SEQUENCE_ONLY_LIVE", "FOLLOW_AD_SEQUENCE_ONLY_VOD"
resp.function_mapping #=> Hash
resp.function_mapping["EventName"] #=> String
resp.ads_personalization_timeouts.ads_request_timeout_milliseconds #=> Integer
resp.ads_personalization_timeouts.live_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_timeouts.vod_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_timeouts.prefetch_ads_request_timeout_milliseconds #=> Integer
resp.ads_personalization_timeouts.prefetch_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_concurrency.max_concurrent_ads_requests #=> Integer
resp.ads_personalization_concurrency.enable_vod_vast_parallelization #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The identifier for the playback configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


607

    		
    
      
# File 'sig/client.rbs', line 607

def get_playback_configuration: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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.retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.schedule_type #=> String, one of "SINGLE", "RECURRING"
resp.recurring_prefetch_configuration.start_time #=> Time
resp.recurring_prefetch_configuration.end_time #=> Time
resp.recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
resp.recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.stream_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> 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:



  
See Also:

  



  

    
      


625

    		
    
      
# File 'sig/client.rbs', line 625

def get_prefetch_schedule: (

    		
  





    
      

  

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

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListAlerts request, omit this value. For subsequent
requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request. Continue making
requests until the response no longer includes a NextToken value,
which indicates that all results have been retrieved.
    
          
        
    • 
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


637

    		
    
      
# File 'sig/client.rbs', line 637

def list_alerts: (

    		
  





    
      

  

  
    #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].channel_name #=> String
resp.items[0].channel_state #=> String
resp.items[0].creation_time #=> Time
resp.items[0].filler_slate.source_location_name #=> String
resp.items[0].filler_slate.vod_source_name #=> String
resp.items[0].last_modified_time #=> Time
resp.items[0].outputs #=> Array
resp.items[0].outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.items[0].outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.items[0].outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.items[0].outputs[0].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].manifest_name #=> String
resp.items[0].outputs[0].playback_url #=> String
resp.items[0].outputs[0].dual_stack_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.items[0].log_configuration.log_types #=> Array
resp.items[0].log_configuration.log_types[0] #=> String, one of "AS_RUN"
resp.items[0].audiences #=> Array
resp.items[0].audiences[0] #=> 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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListChannels request, omit this value. For subsequent
requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request. Continue making
requests until the response no longer includes a NextToken value,
which indicates that all results have been retrieved.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


650

    		
    
      
# File 'sig/client.rbs', line 650

def list_channels: (

    		
  





    
      

  

  
    #list_functions(params = {})  ⇒ Types::ListFunctionsResponse 
  

  

  


  

    
Retrieves all functions associated with your AWS account in the
current Region. For more information about functions, see Working
with functions in the MediaTailor User Guide.


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

    
      
        
Response structure

      
      

resp.items #=> Array
resp.items[0].function_id #=> String
resp.items[0].function_type #=> String, one of "HTTP_REQUEST", "CUSTOM_OUTPUT", "CONCURRENT_EXECUTOR", "SEQUENTIAL_EXECUTOR"
resp.items[0].description #=> String
resp.items[0].http_request_configuration.runtime #=> String, one of "JSONATA"
resp.items[0].http_request_configuration.output #=> Hash
resp.items[0].http_request_configuration.output["__string"] #=> String
resp.items[0].http_request_configuration.method_type #=> String, one of "GET", "POST"
resp.items[0].http_request_configuration.request_timeout_milliseconds #=> Integer
resp.items[0].http_request_configuration.url #=> String
resp.items[0].http_request_configuration.body #=> String
resp.items[0].http_request_configuration.headers #=> Hash
resp.items[0].http_request_configuration.headers["__string"] #=> String
resp.items[0].custom_output_configuration.runtime #=> String, one of "JSONATA"
resp.items[0].custom_output_configuration.output #=> Hash
resp.items[0].custom_output_configuration.output["__string"] #=> String
resp.items[0].concurrent_executor_configuration.runtime #=> String, one of "JSONATA"
resp.items[0].concurrent_executor_configuration.output #=> Hash
resp.items[0].concurrent_executor_configuration.output["__string"] #=> String
resp.items[0].concurrent_executor_configuration.function_list #=> Array
resp.items[0].concurrent_executor_configuration.function_list[0].run_condition #=> String
resp.items[0].concurrent_executor_configuration.function_list[0].function_id #=> String
resp.items[0].concurrent_executor_configuration.function_list[0].alias #=> String
resp.items[0].concurrent_executor_configuration.timeout_milliseconds #=> Integer
resp.items[0].concurrent_executor_configuration.max_concurrency #=> Integer
resp.items[0].sequential_executor_configuration.runtime #=> String, one of "JSONATA"
resp.items[0].sequential_executor_configuration.output #=> Hash
resp.items[0].sequential_executor_configuration.output["__string"] #=> String
resp.items[0].sequential_executor_configuration.function_list #=> Array
resp.items[0].sequential_executor_configuration.function_list[0].run_condition #=> String
resp.items[0].sequential_executor_configuration.function_list[0].function_id #=> String
resp.items[0].sequential_executor_configuration.function_list[0].alias #=> String
resp.items[0].sequential_executor_configuration.timeout_milliseconds #=> Integer
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.items[0].arn #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of functions that you want MediaTailor to return in
response to the current request. If there are more than MaxResults
functions, use the value of NextToken in the response to get the
next page of results.
    

    The default value is 100. MediaTailor uses token-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListFunctions request, omit this value. For subsequent
requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request. Continue making
requests until the response no longer includes a NextToken value,
which indicates that all results have been retrieved.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


662

    		
    
      
# File 'sig/client.rbs', line 662

def list_functions: (

    		
  





    
      

  

  
    #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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListLiveSources request, omit this value. For
subsequent requests, get the value of NextToken from the previous
response and specify that value for NextToken in the request.
Continue making requests until the response no longer includes a
NextToken value, which indicates that all results have been
retrieved.
    
          
        
    • 
      
        
  • 
          :source_location_name
          (required, String)
          
            
          
          
            — 
    The name of the source location associated with this Live Sources
list.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


674

    		
    
      
# File 'sig/client.rbs', line 674

def list_live_sources: (

    		
  





    
      

  

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

  

  


  

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


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.items #=> Array
resp.items[0].ad_decision_server_url #=> String
resp.items[0].avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
resp.items[0].avail_suppression.value #=> String
resp.items[0].avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
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.dual_stack_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].hls_configuration.dual_stack_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].live_pre_roll_configuration.ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE"
resp.items[0].log_configuration.percent_enabled #=> Integer
resp.items[0].log_configuration.enabled_logging_strategies #=> Array
resp.items[0].log_configuration.enabled_logging_strategies[0] #=> String, one of "VENDED_LOGS", "LEGACY_CLOUDWATCH"
resp.items[0].log_configuration.ads_interaction_log.publish_opt_in_event_types #=> Array
resp.items[0].log_configuration.ads_interaction_log.publish_opt_in_event_types[0] #=> String, one of "RAW_ADS_RESPONSE", "RAW_ADS_REQUEST", "PRE_ADS_REQUEST_HOOK_SUMMARY", "PRE_ADS_REQUEST_FUNCTION_COMPLETED"
resp.items[0].log_configuration.ads_interaction_log.exclude_event_types #=> Array
resp.items[0].log_configuration.ads_interaction_log.exclude_event_types[0] #=> String, one of "AD_MARKER_FOUND", "NON_AD_MARKER_FOUND", "MAKING_ADS_REQUEST", "MODIFIED_TARGET_URL", "VAST_REDIRECT", "EMPTY_VAST_RESPONSE", "EMPTY_VMAP_RESPONSE", "VAST_RESPONSE", "REDIRECTED_VAST_RESPONSE", "FILLED_AVAIL", "FILLED_OVERLAY_AVAIL", "BEACON_FIRED", "WARNING_NO_ADVERTISEMENTS", "WARNING_VPAID_AD_DROPPED", "WARNING_URL_VARIABLE_SUBSTITUTION_FAILED", "ERROR_UNKNOWN", "ERROR_UNKNOWN_HOST", "ERROR_DISALLOWED_HOST", "ERROR_ADS_IO", "ERROR_ADS_TIMEOUT", "ERROR_ADS_RESPONSE_PARSE", "ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT", "ERROR_ADS_INVALID_RESPONSE", "ERROR_VAST_REDIRECT_EMPTY_RESPONSE", "ERROR_VAST_REDIRECT_MULTIPLE_VAST", "ERROR_VAST_REDIRECT_FAILED", "ERROR_VAST_MISSING_MEDIAFILES", "ERROR_VAST_MISSING_CREATIVES", "ERROR_VAST_MISSING_OVERLAYS", "ERROR_VAST_MISSING_IMPRESSION", "ERROR_VAST_INVALID_VAST_AD_TAG_URI", "ERROR_VAST_MULTIPLE_TRACKING_EVENTS", "ERROR_VAST_MULTIPLE_LINEAR", "ERROR_VAST_INVALID_MEDIA_FILE", "ERROR_FIRING_BEACON_FAILED", "ERROR_PERSONALIZATION_DISABLED", "VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET", "VOD_TIME_BASED_AVAIL_PLAN_SUCCESS", "VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS", "INTERSTITIAL_VOD_SUCCESS", "INTERSTITIAL_VOD_FAILURE", "PRE_ADS_REQUEST_HOOK_ERROR", "PRE_ADS_REQUEST_FUNCTION_ERROR"
resp.items[0].log_configuration.manifest_service_interaction_log.publish_opt_in_event_types #=> Array
resp.items[0].log_configuration.manifest_service_interaction_log.publish_opt_in_event_types[0] #=> String, one of "PRE_SESSION_INIT_HOOK_SUMMARY", "PRE_SESSION_INIT_FUNCTION_COMPLETED"
resp.items[0].log_configuration.manifest_service_interaction_log.exclude_event_types #=> Array
resp.items[0].log_configuration.manifest_service_interaction_log.exclude_event_types[0] #=> String, one of "GENERATED_MANIFEST", "ORIGIN_MANIFEST", "SESSION_INITIALIZED", "TRACKING_RESPONSE", "CONFIG_SYNTAX_ERROR", "CONFIG_SECURITY_ERROR", "UNKNOWN_HOST", "TIMEOUT_ERROR", "CONNECTION_ERROR", "IO_ERROR", "UNKNOWN_ERROR", "HOST_DISALLOWED", "PARSING_ERROR", "MANIFEST_ERROR", "NO_MASTER_OR_MEDIA_PLAYLIST", "NO_MASTER_PLAYLIST", "NO_MEDIA_PLAYLIST", "INCOMPATIBLE_HLS_VERSION", "SCTE35_PARSING_ERROR", "INVALID_SINGLE_PERIOD_DASH_MANIFEST", "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST", "LAST_PERIOD_MISSING_AUDIO", "LAST_PERIOD_MISSING_AUDIO_WARNING", "ERROR_ORIGIN_PREFIX_INTERPOLATION", "ERROR_ADS_INTERPOLATION", "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION", "ERROR_CDN_AD_SEGMENT_INTERPOLATION", "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION", "ERROR_SLATE_AD_URL_INTERPOLATION", "ERROR_PROFILE_NAME_INTERPOLATION", "ERROR_BUMPER_START_INTERPOLATION", "ERROR_BUMPER_END_INTERPOLATION", "PRE_SESSION_INIT_HOOK_ERROR", "PRE_SESSION_INIT_FUNCTION_ERROR"
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].dual_stack_playback_endpoint_prefix #=> String
resp.items[0].session_initialization_endpoint_prefix #=> String
resp.items[0].dual_stack_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.items[0].ad_conditioning_configuration.streaming_media_file_conditioning #=> String, one of "TRANSCODE", "NONE"
resp.items[0].ad_decision_server_configuration.http_request.method #=> String, one of "GET", "POST"
resp.items[0].ad_decision_server_configuration.http_request.body #=> String
resp.items[0].ad_decision_server_configuration.http_request.headers #=> Hash
resp.items[0].ad_decision_server_configuration.http_request.headers["__string"] #=> String
resp.items[0].ad_decision_server_configuration.http_request.compress_request #=> String, one of "NONE", "GZIP"
resp.items[0].ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE", "FOLLOW_AD_SEQUENCE_ONLY_LIVE", "FOLLOW_AD_SEQUENCE_ONLY_VOD"
resp.items[0].function_mapping #=> Hash
resp.items[0].function_mapping["EventName"] #=> String
resp.items[0].ads_personalization_timeouts.ads_request_timeout_milliseconds #=> Integer
resp.items[0].ads_personalization_timeouts.live_maximum_ads_personalization_time_milliseconds #=> Integer
resp.items[0].ads_personalization_timeouts.vod_maximum_ads_personalization_time_milliseconds #=> Integer
resp.items[0].ads_personalization_timeouts.prefetch_ads_request_timeout_milliseconds #=> Integer
resp.items[0].ads_personalization_timeouts.prefetch_maximum_ads_personalization_time_milliseconds #=> Integer
resp.items[0].ads_personalization_concurrency.max_concurrent_ads_requests #=> Integer
resp.items[0].ads_personalization_concurrency.enable_vod_vast_parallelization #=> Boolean
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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListPlaybackConfigurations request, omit this value.
For subsequent requests, get the value of NextToken from the
previous response and specify that value for NextToken in the
request. Continue making requests until the response no longer
includes a NextToken value, which indicates that all results have
been retrieved.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


687

    		
    
      
# File 'sig/client.rbs', line 687

def list_playback_configurations: (

    		
  





    
      

  

  
    #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
  schedule_type: "SINGLE", # accepts SINGLE, RECURRING, ALL
  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].retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.items[0].retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.items[0].retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.items[0].retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.items[0].schedule_type #=> String, one of "SINGLE", "RECURRING"
resp.items[0].recurring_prefetch_configuration.start_time #=> Time
resp.items[0].recurring_prefetch_configuration.end_time #=> Time
resp.items[0].recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW", "TPS"
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_tps #=> Integer
resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_tps_configuration.peak_concurrent_users #=> Integer
resp.items[0].stream_id #=> 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 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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListPrefetchSchedules request, omit this value. For
subsequent requests, get the value of NextToken from the previous
response and specify that value for NextToken in the request.
Continue making requests until the response no longer includes a
NextToken value, which indicates that all results have been
retrieved.
    
          
        
    • 
      
        
  • 
          :playback_configuration_name
          (required, String)
          
            
          
          
            — 
    Retrieves the prefetch schedule(s) for a specific playback
configuration.
    
          
        
    • 
      
        
  • 
          :schedule_type
          (String)
          
            
          
          
            — 
    The type of prefetch schedules that you want to list. SINGLE
indicates that you want to list the configured single prefetch
schedules. RECURRING indicates that you want to list the configured
recurring prefetch schedules. ALL indicates that you want to list
all configured prefetch schedules.
    
          
        
    • 
      
        
  • 
          :stream_id
          (String)
          
            
          
          
            — 
    An optional filtering parameter whereby MediaTailor filters the
prefetch schedules to include only specific streams.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


699

    		
    
      
# File 'sig/client.rbs', line 699

def list_prefetch_schedules: (

    		
  





    
      

  

  
    #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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListSourceLocations request, omit this value. For
subsequent requests, get the value of NextToken from the previous
response and specify that value for NextToken in the request.
Continue making requests until the response no longer includes a
NextToken value, which indicates that all results have been
retrieved.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


714

    		
    
      
# File 'sig/client.rbs', line 714

def list_source_locations: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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:



  
See Also:

  



  

    
      


725

    		
    
      
# File 'sig/client.rbs', line 725

def list_tags_for_resource: (

    		
  





    
      

  

  
    #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.
    

    The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than MaxResults
items, including 0 items, even when more results are available. To
retrieve all results, you must continue making requests using the
NextToken value from each response until the response no longer
includes a NextToken value.
    
          
        
    • 
      
        
  • 
          :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.
    

    For the first ListVodSources request, omit this value. For
subsequent requests, get the value of NextToken from the previous
response and specify that value for NextToken in the request.
Continue making requests until the response no longer includes a
NextToken value, which indicates that all results have been
retrieved.
    
          
        
    • 
      
        
  • 
          :source_location_name
          (required, String)
          
            
          
          
            — 
    The name of the source location associated with this VOD Source list.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


736

    		
    
      
# File 'sig/client.rbs', line 736

def list_vod_sources: (

    		
  





    
      

  

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

  



  

    
      


747

    		
    
      
# File 'sig/client.rbs', line 747

def put_channel_policy: (

    		
  





    
      

  

  
    #put_function(params = {})  ⇒ Types::PutFunctionResponse 
  

  

  


  

    
Creates or updates a function. A function defines reusable logic that
MediaTailor executes at lifecycle hooks during ad insertion. For more
information about functions, see Working with functions in the
MediaTailor User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_function({
  function_id: "__string", # required
  function_type: "HTTP_REQUEST", # required, accepts HTTP_REQUEST, CUSTOM_OUTPUT, CONCURRENT_EXECUTOR, SEQUENTIAL_EXECUTOR
  description: "__string",
  http_request_configuration: {
    runtime: "JSONATA", # required, accepts JSONATA
    output: {
      "__string" => "__string",
    },
    method_type: "GET", # required, accepts GET, POST
    request_timeout_milliseconds: 1, # required
    url: "__string", # required
    body: "__string",
    headers: {
      "__string" => "__string",
    },
  },
  custom_output_configuration: {
    runtime: "JSONATA", # required, accepts JSONATA
    output: {
      "__string" => "__string",
    },
  },
  concurrent_executor_configuration: {
    runtime: "JSONATA", # required, accepts JSONATA
    output: { # required
      "__string" => "__string",
    },
    function_list: [ # required
      {
        run_condition: "__string",
        function_id: "__string",
        alias: "__string",
      },
    ],
    timeout_milliseconds: 1, # required
    max_concurrency: 1, # required
  },
  sequential_executor_configuration: {
    runtime: "JSONATA", # required, accepts JSONATA
    output: {
      "__string" => "__string",
    },
    function_list: [ # required
      {
        run_condition: "__string",
        function_id: "__string",
        alias: "__string",
      },
    ],
    timeout_milliseconds: 1, # required
  },
  tags: {
    "__string" => "__string",
  },
})

    
      
        
Response structure

      
      

resp.function_id #=> String
resp.function_type #=> String, one of "HTTP_REQUEST", "CUSTOM_OUTPUT", "CONCURRENT_EXECUTOR", "SEQUENTIAL_EXECUTOR"
resp.description #=> String
resp.http_request_configuration.runtime #=> String, one of "JSONATA"
resp.http_request_configuration.output #=> Hash
resp.http_request_configuration.output["__string"] #=> String
resp.http_request_configuration.method_type #=> String, one of "GET", "POST"
resp.http_request_configuration.request_timeout_milliseconds #=> Integer
resp.http_request_configuration.url #=> String
resp.http_request_configuration.body #=> String
resp.http_request_configuration.headers #=> Hash
resp.http_request_configuration.headers["__string"] #=> String
resp.custom_output_configuration.runtime #=> String, one of "JSONATA"
resp.custom_output_configuration.output #=> Hash
resp.custom_output_configuration.output["__string"] #=> String
resp.concurrent_executor_configuration.runtime #=> String, one of "JSONATA"
resp.concurrent_executor_configuration.output #=> Hash
resp.concurrent_executor_configuration.output["__string"] #=> String
resp.concurrent_executor_configuration.function_list #=> Array
resp.concurrent_executor_configuration.function_list[0].run_condition #=> String
resp.concurrent_executor_configuration.function_list[0].function_id #=> String
resp.concurrent_executor_configuration.function_list[0].alias #=> String
resp.concurrent_executor_configuration.timeout_milliseconds #=> Integer
resp.concurrent_executor_configuration.max_concurrency #=> Integer
resp.sequential_executor_configuration.runtime #=> String, one of "JSONATA"
resp.sequential_executor_configuration.output #=> Hash
resp.sequential_executor_configuration.output["__string"] #=> String
resp.sequential_executor_configuration.function_list #=> Array
resp.sequential_executor_configuration.function_list[0].run_condition #=> String
resp.sequential_executor_configuration.function_list[0].function_id #=> String
resp.sequential_executor_configuration.function_list[0].alias #=> String
resp.sequential_executor_configuration.timeout_milliseconds #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :function_id
          (required, String)
          
            
          
          
            — 
    The identifier of the function. The identifier must be unique within
your account.
    
          
        
    • 
      
        
  • 
          :function_type
          (required, String)
          
            
          
          
            — 
    The type of the function. The function type determines what the
function can do at runtime. Valid values: CUSTOM_OUTPUT evaluates
expressions and produces output bindings with no external calls.
HTTP_REQUEST makes an HTTP call to an external service and evaluates
output expressions that can reference the response.
SEQUENTIAL_EXECUTOR runs a sequence of child functions in order,
passing data between steps through temporary data. For more
information, see Function types and composition in the
MediaTailor User Guide.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the function.
    
          
        
    • 
      
        
  • 
          :http_request_configuration
          (Types::HttpRequestConfiguration)
          
            
          
          
            — 
    The configuration for an HTTP_REQUEST function. Specifies the HTTP
method, URL, headers, body, timeout, and output expressions. Required
when FunctionType is HTTP_REQUEST.
    
          
        
    • 
      
        
  • 
          :custom_output_configuration
          (Types::CustomOutputConfiguration)
          
            
          
          
            — 
    The configuration for a CUSTOM_OUTPUT function. Specifies the
runtime and output expressions. Required when FunctionType is
CUSTOM_OUTPUT.
    
          
        
    • 
      
        
  • 
          :concurrent_executor_configuration
          (Types::ConcurrentExecutorConfiguration)
          
            
          
          
            — 
    The configuration for a CONCURRENT_EXECUTOR function. Specifies the
list of child functions to run in parallel, the maximum concurrency,
an optional output block, and a timeout. Required when FunctionType
is CONCURRENT_EXECUTOR.
    
          
        
    • 
      
        
  • 
          :sequential_executor_configuration
          (Types::SequentialExecutorConfiguration)
          
            
          
          
            — 
    The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the
ordered list of child functions to execute, an optional output block,
and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    The tags to assign to the function. 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


766

    		
    
      
# File 'sig/client.rbs', line 766

def put_function: (

    		
  





    
      

  

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

  

  


  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_playback_configuration({
  ad_decision_server_url: "__string",
  avail_suppression: {
    mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE, AFTER_LIVE_EDGE
    value: "__string",
    fill_policy: "FULL_AVAIL_ONLY", # accepts FULL_AVAIL_ONLY, PARTIAL_AVAIL
  },
  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,
    ad_decision_server_configuration: {
      vast_response: {
        ad_sequencing_mode: "FOLLOW_AD_SEQUENCE", # accepts FOLLOW_AD_SEQUENCE, IGNORE_AD_SEQUENCE
      },
    },
  },
  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",
  ad_conditioning_configuration: {
    streaming_media_file_conditioning: "TRANSCODE", # required, accepts TRANSCODE, NONE
  },
  ad_decision_server_configuration: {
    http_request: {
      method: "GET", # accepts GET, POST
      body: "__string",
      headers: {
        "__string" => "__string",
      },
      compress_request: "NONE", # accepts NONE, GZIP
    },
    vast_response: {
      ad_sequencing_mode: "FOLLOW_AD_SEQUENCE", # accepts FOLLOW_AD_SEQUENCE, IGNORE_AD_SEQUENCE, FOLLOW_AD_SEQUENCE_ONLY_LIVE, FOLLOW_AD_SEQUENCE_ONLY_VOD
    },
  },
  function_mapping: {
    "PRE_SESSION_INITIALIZATION" => "__string",
  },
  ads_personalization_timeouts: {
    ads_request_timeout_milliseconds: 1,
    live_maximum_ads_personalization_time_milliseconds: 1,
    vod_maximum_ads_personalization_time_milliseconds: 1,
    prefetch_ads_request_timeout_milliseconds: 1,
    prefetch_maximum_ads_personalization_time_milliseconds: 1,
  },
  ads_personalization_concurrency: {
    max_concurrent_ads_requests: 1,
    enable_vod_vast_parallelization: false,
  },
})

    
      
        
Response structure

      
      

resp.ad_decision_server_url #=> String
resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
resp.avail_suppression.value #=> String
resp.avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
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.dual_stack_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.hls_configuration.dual_stack_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.live_pre_roll_configuration.ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE"
resp.log_configuration.percent_enabled #=> Integer
resp.log_configuration.enabled_logging_strategies #=> Array
resp.log_configuration.enabled_logging_strategies[0] #=> String, one of "VENDED_LOGS", "LEGACY_CLOUDWATCH"
resp.log_configuration.ads_interaction_log.publish_opt_in_event_types #=> Array
resp.log_configuration.ads_interaction_log.publish_opt_in_event_types[0] #=> String, one of "RAW_ADS_RESPONSE", "RAW_ADS_REQUEST", "PRE_ADS_REQUEST_HOOK_SUMMARY", "PRE_ADS_REQUEST_FUNCTION_COMPLETED"
resp.log_configuration.ads_interaction_log.exclude_event_types #=> Array
resp.log_configuration.ads_interaction_log.exclude_event_types[0] #=> String, one of "AD_MARKER_FOUND", "NON_AD_MARKER_FOUND", "MAKING_ADS_REQUEST", "MODIFIED_TARGET_URL", "VAST_REDIRECT", "EMPTY_VAST_RESPONSE", "EMPTY_VMAP_RESPONSE", "VAST_RESPONSE", "REDIRECTED_VAST_RESPONSE", "FILLED_AVAIL", "FILLED_OVERLAY_AVAIL", "BEACON_FIRED", "WARNING_NO_ADVERTISEMENTS", "WARNING_VPAID_AD_DROPPED", "WARNING_URL_VARIABLE_SUBSTITUTION_FAILED", "ERROR_UNKNOWN", "ERROR_UNKNOWN_HOST", "ERROR_DISALLOWED_HOST", "ERROR_ADS_IO", "ERROR_ADS_TIMEOUT", "ERROR_ADS_RESPONSE_PARSE", "ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT", "ERROR_ADS_INVALID_RESPONSE", "ERROR_VAST_REDIRECT_EMPTY_RESPONSE", "ERROR_VAST_REDIRECT_MULTIPLE_VAST", "ERROR_VAST_REDIRECT_FAILED", "ERROR_VAST_MISSING_MEDIAFILES", "ERROR_VAST_MISSING_CREATIVES", "ERROR_VAST_MISSING_OVERLAYS", "ERROR_VAST_MISSING_IMPRESSION", "ERROR_VAST_INVALID_VAST_AD_TAG_URI", "ERROR_VAST_MULTIPLE_TRACKING_EVENTS", "ERROR_VAST_MULTIPLE_LINEAR", "ERROR_VAST_INVALID_MEDIA_FILE", "ERROR_FIRING_BEACON_FAILED", "ERROR_PERSONALIZATION_DISABLED", "VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET", "VOD_TIME_BASED_AVAIL_PLAN_SUCCESS", "VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS", "INTERSTITIAL_VOD_SUCCESS", "INTERSTITIAL_VOD_FAILURE", "PRE_ADS_REQUEST_HOOK_ERROR", "PRE_ADS_REQUEST_FUNCTION_ERROR"
resp.log_configuration.manifest_service_interaction_log.publish_opt_in_event_types #=> Array
resp.log_configuration.manifest_service_interaction_log.publish_opt_in_event_types[0] #=> String, one of "PRE_SESSION_INIT_HOOK_SUMMARY", "PRE_SESSION_INIT_FUNCTION_COMPLETED"
resp.log_configuration.manifest_service_interaction_log.exclude_event_types #=> Array
resp.log_configuration.manifest_service_interaction_log.exclude_event_types[0] #=> String, one of "GENERATED_MANIFEST", "ORIGIN_MANIFEST", "SESSION_INITIALIZED", "TRACKING_RESPONSE", "CONFIG_SYNTAX_ERROR", "CONFIG_SECURITY_ERROR", "UNKNOWN_HOST", "TIMEOUT_ERROR", "CONNECTION_ERROR", "IO_ERROR", "UNKNOWN_ERROR", "HOST_DISALLOWED", "PARSING_ERROR", "MANIFEST_ERROR", "NO_MASTER_OR_MEDIA_PLAYLIST", "NO_MASTER_PLAYLIST", "NO_MEDIA_PLAYLIST", "INCOMPATIBLE_HLS_VERSION", "SCTE35_PARSING_ERROR", "INVALID_SINGLE_PERIOD_DASH_MANIFEST", "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST", "LAST_PERIOD_MISSING_AUDIO", "LAST_PERIOD_MISSING_AUDIO_WARNING", "ERROR_ORIGIN_PREFIX_INTERPOLATION", "ERROR_ADS_INTERPOLATION", "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION", "ERROR_CDN_AD_SEGMENT_INTERPOLATION", "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION", "ERROR_SLATE_AD_URL_INTERPOLATION", "ERROR_PROFILE_NAME_INTERPOLATION", "ERROR_BUMPER_START_INTERPOLATION", "ERROR_BUMPER_END_INTERPOLATION", "PRE_SESSION_INIT_HOOK_ERROR", "PRE_SESSION_INIT_FUNCTION_ERROR"
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.dual_stack_playback_endpoint_prefix #=> String
resp.session_initialization_endpoint_prefix #=> String
resp.dual_stack_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
resp.ad_conditioning_configuration.streaming_media_file_conditioning #=> String, one of "TRANSCODE", "NONE"
resp.ad_decision_server_configuration.http_request.method #=> String, one of "GET", "POST"
resp.ad_decision_server_configuration.http_request.body #=> String
resp.ad_decision_server_configuration.http_request.headers #=> Hash
resp.ad_decision_server_configuration.http_request.headers["__string"] #=> String
resp.ad_decision_server_configuration.http_request.compress_request #=> String, one of "NONE", "GZIP"
resp.ad_decision_server_configuration.vast_response.ad_sequencing_mode #=> String, one of "FOLLOW_AD_SEQUENCE", "IGNORE_AD_SEQUENCE", "FOLLOW_AD_SEQUENCE_ONLY_LIVE", "FOLLOW_AD_SEQUENCE_ONLY_VOD"
resp.function_mapping #=> Hash
resp.function_mapping["EventName"] #=> String
resp.ads_personalization_timeouts.ads_request_timeout_milliseconds #=> Integer
resp.ads_personalization_timeouts.live_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_timeouts.vod_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_timeouts.prefetch_ads_request_timeout_milliseconds #=> Integer
resp.ads_personalization_timeouts.prefetch_maximum_ads_personalization_time_milliseconds #=> Integer
resp.ads_personalization_concurrency.max_concurrent_ads_requests #=> Integer
resp.ads_personalization_concurrency.enable_vod_vast_parallelization #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :ad_decision_server_url
          (String)
          
            
          
          
            — 
    The URL for the ad decision server (ADS). This includes the
specification of static parameters and placeholders for dynamic
parameters. AWS Elemental MediaTailor substitutes player-specific and
session-specific parameters as needed when calling the ADS.
Alternately, for testing you can provide a static VAST URL. The
maximum length is 25,000 characters.
    
          
        
    • 
      
        
  • 
          :avail_suppression
          (Types::AvailSuppression)
          
            
          
          
            — 
    The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see Ad Suppression.
    
          
        
    • 
      
        
  • 
          :bumper
          (Types::Bumper)
          
            
          
          
            — 
    The configuration for bumpers. Bumpers are short audio or video clips
that play at the start or before the end of an ad break. To learn more
about bumpers, see Bumpers.
    
          
        
    • 
      
        
  • 
          :cdn_configuration
          (Types::CdnConfiguration)
          
            
          
          
            — 
    The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
    
          
        
    • 
      
        
  • 
          :configuration_aliases
          (Hash<String,Hash>)
          
            
          
          
            — 
    The player parameters and aliases used as dynamic variables during
session initialization. For more information, see Domain
Variables.
    
          
        
    • 
      
        
  • 
          :dash_configuration
          (Types::DashConfigurationForPut)
          
            
          
          
            — 
    The configuration for DASH content.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ad_conditioning_configuration
          (Types::AdConditioningConfiguration)
          
            
          
          
            — 
    The setting that indicates what conditioning MediaTailor will perform
on ads that the ad decision server (ADS) returns, and what priority
MediaTailor uses when inserting ads.
    
          
        
    • 
      
        
  • 
          :ad_decision_server_configuration
          (Types::AdDecisionServerConfiguration)
          
            
          
          
            — 
    The configuration for customizing HTTP requests to the ad decision
server (ADS). This includes settings for request method, headers, body
content, and compression options.
    
          
        
    • 
      
        
  • 
          :function_mapping
          (Hash<String,String>)
          
            
          
          
            — 
    A map of lifecycle hook event names to function identifiers. The
function mapping specifies which function MediaTailor executes at each
lifecycle hook during ad insertion. Valid keys are
PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more
information, see Functions lifecycle hooks in the MediaTailor
User Guide.
    
          
        
    • 
      
        
  • 
          :ads_personalization_timeouts
          (Types::AdsPersonalizationTimeouts)
          
            
          
          
            — 
    The timeout settings for ad decision server interactions. These
settings control how long MediaTailor waits for ADS responses and the
total time budget for ad personalization across live, VOD, and
prefetch workflows.
    
          
        
    • 
      
        
  • 
          :ads_personalization_concurrency
          (Types::AdsPersonalizationConcurrency)
          
            
          
          
            — 
    The concurrency settings for ad decision server interactions. These
settings control how many simultaneous ADS requests MediaTailor makes
per manifest request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


843

    		
    
      
# File 'sig/client.rbs', line 843

def put_playback_configuration: (

    		
  





    
      

  

  
    #start_channel(params = {})  ⇒ Struct 
  

  

  


  

    
Starts a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
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:

  



  

    
      


917

    		
    
      
# File 'sig/client.rbs', line 917

def start_channel: (

    		
  





    
      

  

  
    #stop_channel(params = {})  ⇒ Struct 
  

  

  


  

    
Stops a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
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:

  



  

    
      


926

    		
    
      
# File 'sig/client.rbs', line 926

def stop_channel: (

    		
  





    
      

  

  
    #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.


  





  
  

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

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


932

    		
    
      
# File 'sig/client.rbs', line 932

def tag_resource: (

    		
  





    
      

  

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

  



  

    
      


939

    		
    
      
# File 'sig/client.rbs', line 939

def untag_resource: (

    		
  





    
      

  

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

  

  


  

    
Updates a channel. For information about MediaTailor channels, see
Working with channels in the MediaTailor User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_channel({
  channel_name: "__string", # required
  filler_slate: {
    source_location_name: "__string",
    vod_source_name: "__string",
  },
  outputs: [ # required
    {
      dash_playlist_settings: {
        manifest_window_seconds: 1,
        min_buffer_time_seconds: 1,
        min_update_period_seconds: 1,
        suggested_presentation_delay_seconds: 1,
      },
      hls_playlist_settings: {
        manifest_window_seconds: 1,
        ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
      },
      manifest_name: "__string", # required
      source_group: "__string", # required
    },
  ],
  time_shift_configuration: {
    max_time_delay_seconds: 1, # required
  },
  audiences: ["String"],
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.channel_name #=> String
resp.channel_state #=> String, one of "RUNNING", "STOPPED"
resp.creation_time #=> Time
resp.filler_slate.source_location_name #=> String
resp.filler_slate.vod_source_name #=> String
resp.last_modified_time #=> Time
resp.outputs #=> Array
resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
resp.outputs[0].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].manifest_name #=> String
resp.outputs[0].playback_url #=> String
resp.outputs[0].dual_stack_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
resp.audiences #=> Array
resp.audiences[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :audiences
          (Array<String>)
          
            
          
          
            — 
    The list of audiences defined in channel.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


961

    		
    
      
# File 'sig/client.rbs', line 961

def update_channel: (

    		
  





    
      

  

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



  
See Also:

  



  

    
      


988

    		
    
      
# File 'sig/client.rbs', line 988

def update_live_source: (

    		
  





    
      

  

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

  

  


  

    
Updates a program within a channel.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.ad_breaks #=> Array
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].segmentation_event_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> 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_type_id #=> Integer
resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> 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.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.arn #=> String
resp.channel_name #=> String
resp.creation_time #=> Time
resp.program_name #=> String
resp.source_location_name #=> String
resp.vod_source_name #=> String
resp.live_source_name #=> String
resp.clip_range.end_offset_millis #=> Integer
resp.clip_range.start_offset_millis #=> Integer
resp.duration_millis #=> Integer
resp.scheduled_start_time #=> Time
resp.audience_media #=> Array
resp.audience_media[0].audience #=> String
resp.audience_media[0].alternate_media #=> Array
resp.audience_media[0].alternate_media[0].source_location_name #=> String
resp.audience_media[0].alternate_media[0].live_source_name #=> String
resp.audience_media[0].alternate_media[0].vod_source_name #=> String
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].scheduled_start_time_millis #=> Integer
resp.audience_media[0].alternate_media[0].ad_breaks #=> Array
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].segmentation_event_id #=> Integer
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].segmentation_upid #=> String
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].segment_num #=> 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].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].duration_millis #=> Integer
resp.tags #=> Hash
resp.tags["__string"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :ad_breaks
          (Array<Types::AdBreak>)
          
            
          
          
            — 
    The ad break configuration settings.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :audience_media
          (Array<Types::AudienceMedia>)
          
            
          
          
            — 
    The list of AudienceMedia defined in program.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1018

    		
    
      
# File 'sig/client.rbs', line 1018

def update_program: (

    		
  





    
      

  

  
    #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.


  





  
  

    
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:



  
See Also:

  



  

    
      


1053

    		
    
      
# File 'sig/client.rbs', line 1053

def update_source_location: (

    		
  





    
      

  

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



  
See Also:

  



  

    
      


1082

    		
    
      
# File 'sig/client.rbs', line 1082

def update_vod_source: (

    		
  





    
      

  

  
    #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. 



  





  



  

    
      


4332
4333
4334

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

def waiter_names
  []
end