Class: Aws::MediaConnect::Client

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

Overview

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

client = Aws::MediaConnect::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: _AddBridgeOutputsResponseSuccess, _AddBridgeSourcesResponseSuccess, _AddFlowMediaStreamsResponseSuccess, _AddFlowOutputsResponseSuccess, _AddFlowSourcesResponseSuccess, _AddFlowVpcInterfacesResponseSuccess, _BatchGetRouterInputResponseSuccess, _BatchGetRouterNetworkInterfaceResponseSuccess, _BatchGetRouterOutputResponseSuccess, _CreateBridgeResponseSuccess, _CreateFlowResponseSuccess, _CreateGatewayResponseSuccess, _CreateRouterInputResponseSuccess, _CreateRouterNetworkInterfaceResponseSuccess, _CreateRouterOutputResponseSuccess, _DeleteBridgeResponseSuccess, _DeleteFlowResponseSuccess, _DeleteGatewayResponseSuccess, _DeleteRouterInputResponseSuccess, _DeleteRouterNetworkInterfaceResponseSuccess, _DeleteRouterOutputResponseSuccess, _DeregisterGatewayInstanceResponseSuccess, _DescribeBridgeResponseSuccess, _DescribeFlowResponseSuccess, _DescribeFlowSourceMetadataResponseSuccess, _DescribeFlowSourceThumbnailResponseSuccess, _DescribeGatewayInstanceResponseSuccess, _DescribeGatewayResponseSuccess, _DescribeOfferingResponseSuccess, _DescribeReservationResponseSuccess, _GetRouterInputResponseSuccess, _GetRouterInputSourceMetadataResponseSuccess, _GetRouterInputThumbnailResponseSuccess, _GetRouterNetworkInterfaceResponseSuccess, _GetRouterOutputResponseSuccess, _GrantFlowEntitlementsResponseSuccess, _ListBridgesResponseSuccess, _ListEntitlementsResponseSuccess, _ListFlowsResponseSuccess, _ListGatewayInstancesResponseSuccess, _ListGatewaysResponseSuccess, _ListOfferingsResponseSuccess, _ListReservationsResponseSuccess, _ListRouterInputsResponseSuccess, _ListRouterNetworkInterfacesResponseSuccess, _ListRouterOutputsResponseSuccess, _ListTagsForGlobalResourceResponseSuccess, _ListTagsForResourceResponseSuccess, _PurchaseOfferingResponseSuccess, _RemoveBridgeOutputResponseSuccess, _RemoveBridgeSourceResponseSuccess, _RemoveFlowMediaStreamResponseSuccess, _RemoveFlowOutputResponseSuccess, _RemoveFlowSourceResponseSuccess, _RemoveFlowVpcInterfaceResponseSuccess, _RestartRouterInputResponseSuccess, _RestartRouterOutputResponseSuccess, _RevokeFlowEntitlementResponseSuccess, _StartFlowResponseSuccess, _StartRouterInputResponseSuccess, _StartRouterOutputResponseSuccess, _StopFlowResponseSuccess, _StopRouterInputResponseSuccess, _StopRouterOutputResponseSuccess, _TakeRouterInputResponseSuccess, _UpdateBridgeOutputResponseSuccess, _UpdateBridgeResponseSuccess, _UpdateBridgeSourceResponseSuccess, _UpdateBridgeStateResponseSuccess, _UpdateFlowEntitlementResponseSuccess, _UpdateFlowMediaStreamResponseSuccess, _UpdateFlowOutputResponseSuccess, _UpdateFlowResponseSuccess, _UpdateFlowSourceResponseSuccess, _UpdateGatewayInstanceResponseSuccess, _UpdateRouterInputResponseSuccess, _UpdateRouterNetworkInterfaceResponseSuccess, _UpdateRouterOutputResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:add_bridge_output_request) 

      
    

  




  
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::MediaConnect::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::MediaConnect::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-mediaconnect/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.




  





  



  

    
      


7555
7556
7557

    		
    
      
# File 'lib/aws-sdk-mediaconnect/client.rb', line 7555

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.




  





  



  

    
      


7558
7559
7560

    		
    
      
# File 'lib/aws-sdk-mediaconnect/client.rb', line 7558

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  


  

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


  





  



  

    
      


14

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

def self.new: (

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #add_bridge_outputs(params = {})  ⇒ Types::AddBridgeOutputsResponse 
  

  

  


  

    
Adds outputs to an existing bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_bridge_outputs({
  bridge_arn: "AddBridgeOutputsRequestBridgeArnString", # required
  outputs: [ # required
    {
      network_output: {
        ip_address: "String", # required
        name: "String", # required
        network_name: "String", # required
        port: 1, # required
        protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
        ttl: 1, # required
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.outputs #=> Array
resp.outputs[0].flow_output.flow_arn #=> String
resp.outputs[0].flow_output.flow_source_arn #=> String
resp.outputs[0].flow_output.name #=> String
resp.outputs[0].network_output.ip_address #=> String
resp.outputs[0].network_output.name #=> String
resp.outputs[0].network_output.network_name #=> String
resp.outputs[0].network_output.port #=> Integer
resp.outputs[0].network_output.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.outputs[0].network_output.ttl #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :outputs
          (required, Array<Types::AddBridgeOutputRequest>)
          
            
          
          
            — 
    The outputs that you want to add to this bridge.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


87

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

def add_bridge_outputs: (

    		
  





    
      

  

  
    #add_bridge_sources(params = {})  ⇒ Types::AddBridgeSourcesResponse 
  

  

  


  

    
Adds sources to an existing bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_bridge_sources({
  bridge_arn: "BridgeArn", # required
  sources: [ # required
    {
      flow_source: {
        flow_arn: "AddBridgeFlowSourceRequestFlowArnString", # required
        flow_vpc_interface_attachment: {
          vpc_interface_name: "String",
        },
        name: "String", # required
      },
      network_source: {
        multicast_ip: "String", # required
        multicast_source_settings: {
          multicast_source_ip: "String",
        },
        name: "String", # required
        network_name: "String", # required
        port: 1, # required
        protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.sources #=> Array
resp.sources[0].flow_source.flow_arn #=> String
resp.sources[0].flow_source.flow_vpc_interface_attachment.vpc_interface_name #=> String
resp.sources[0].flow_source.name #=> String
resp.sources[0].flow_source.output_arn #=> String
resp.sources[0].network_source.multicast_ip #=> String
resp.sources[0].network_source.multicast_source_settings.multicast_source_ip #=> String
resp.sources[0].network_source.name #=> String
resp.sources[0].network_source.network_name #=> String
resp.sources[0].network_source.port #=> Integer
resp.sources[0].network_source.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :sources
          (required, Array<Types::AddBridgeSourceRequest>)
          
            
          
          
            — 
    The sources that you want to add to this bridge.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


101

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

def add_bridge_sources: (

    		
  





    
      

  

  
    #add_flow_media_streams(params = {})  ⇒ Types::AddFlowMediaStreamsResponse 
  

  

  


  

    
Adds media streams to an existing flow. After you add a media stream
to a flow, you can associate it with a source and/or an output that
uses the ST 2110 JPEG XS or CDI protocol.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_flow_media_streams({
  flow_arn: "AddFlowMediaStreamsRequestFlowArnString", # required
  media_streams: [ # required
    {
      attributes: {
        fmtp: {
          channel_order: "String",
          colorimetry: "BT601", # accepts BT601, BT709, BT2020, BT2100, ST2065-1, ST2065-3, XYZ
          exact_framerate: "String",
          par: "String",
          range: "NARROW", # accepts NARROW, FULL, FULLPROTECT
          scan_mode: "progressive", # accepts progressive, interlace, progressive-segmented-frame
          tcs: "SDR", # accepts SDR, PQ, HLG, LINEAR, BT2100LINPQ, BT2100LINHLG, ST2065-1, ST428-1, DENSITY
        },
        lang: "String",
      },
      clock_rate: 1,
      description: "String",
      media_stream_id: 1, # required
      media_stream_name: "String", # required
      media_stream_type: "video", # required, accepts video, audio, ancillary-data
      video_format: "String",
      media_stream_tags: {
        "String" => "String",
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.media_streams #=> Array
resp.media_streams[0].attributes.fmtp.channel_order #=> String
resp.media_streams[0].attributes.fmtp.colorimetry #=> String, one of "BT601", "BT709", "BT2020", "BT2100", "ST2065-1", "ST2065-3", "XYZ"
resp.media_streams[0].attributes.fmtp.exact_framerate #=> String
resp.media_streams[0].attributes.fmtp.par #=> String
resp.media_streams[0].attributes.fmtp.range #=> String, one of "NARROW", "FULL", "FULLPROTECT"
resp.media_streams[0].attributes.fmtp.scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.media_streams[0].attributes.fmtp.tcs #=> String, one of "SDR", "PQ", "HLG", "LINEAR", "BT2100LINPQ", "BT2100LINHLG", "ST2065-1", "ST428-1", "DENSITY"
resp.media_streams[0].attributes.lang #=> String
resp.media_streams[0].clock_rate #=> Integer
resp.media_streams[0].description #=> String
resp.media_streams[0].fmt #=> Integer
resp.media_streams[0].media_stream_id #=> Integer
resp.media_streams[0].media_stream_name #=> String
resp.media_streams[0].media_stream_type #=> String, one of "video", "audio", "ancillary-data"
resp.media_streams[0].video_format #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow.
    
          
        
    • 
      
        
  • 
          :media_streams
          (required, Array<Types::AddMediaStreamRequest>)
          
            
          
          
            — 
    The media streams that you want to add to the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


115

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

def add_flow_media_streams: (

    		
  





    
      

  

  
    #add_flow_outputs(params = {})  ⇒ Types::AddFlowOutputsResponse 
  

  

  


  

    
Adds outputs to an existing flow. You can create up to 50 outputs per
flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_flow_outputs({
  flow_arn: "AddFlowOutputsRequestFlowArnString", # required
  outputs: [ # required
    {
      cidr_allow_list: ["String"],
      description: "String",
      destination: "String",
      encryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      max_latency: 1,
      media_stream_output_configurations: [
        {
          destination_configurations: [
            {
              destination_ip: "String", # required
              destination_port: 1, # required
              interface: { # required
                name: "String", # required
              },
            },
          ],
          encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
          encoding_parameters: {
            compression_factor: 1.0, # required
            encoder_profile: "main", # required, accepts main, high
          },
          media_stream_name: "String", # required
        },
      ],
      min_latency: 1,
      name: "String",
      port: 1,
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      remote_id: "String",
      sender_control_port: 1,
      smoothing_latency: 1,
      stream_id: "String",
      vpc_interface_attachment: {
        vpc_interface_name: "String",
      },
      output_status: "ENABLED", # accepts ENABLED, DISABLED
      ndi_speed_hq_quality: 1,
      ndi_program_name: "String",
      output_tags: {
        "String" => "String",
      },
      router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
      router_integration_transit_encryption: {
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
      ndi_output_timecode_source: "EMBEDDED_TIMECODE", # accepts EMBEDDED_TIMECODE, UTC_SYSTEM_TIME
    },
  ],
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.outputs #=> Array
resp.outputs[0].data_transfer_subscriber_fee_percent #=> Integer
resp.outputs[0].description #=> String
resp.outputs[0].destination #=> String
resp.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.outputs[0].encryption.constant_initialization_vector #=> String
resp.outputs[0].encryption.device_id #=> String
resp.outputs[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.outputs[0].encryption.region #=> String
resp.outputs[0].encryption.resource_id #=> String
resp.outputs[0].encryption.role_arn #=> String
resp.outputs[0].encryption.secret_arn #=> String
resp.outputs[0].encryption.url #=> String
resp.outputs[0].entitlement_arn #=> String
resp.outputs[0].listener_address #=> String
resp.outputs[0].media_live_input_arn #=> String
resp.outputs[0].media_stream_output_configurations #=> Array
resp.outputs[0].media_stream_output_configurations[0].destination_configurations #=> Array
resp.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_ip #=> String
resp.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_port #=> Integer
resp.outputs[0].media_stream_output_configurations[0].destination_configurations[0].interface.name #=> String
resp.outputs[0].media_stream_output_configurations[0].destination_configurations[0].outbound_ip #=> String
resp.outputs[0].media_stream_output_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.outputs[0].media_stream_output_configurations[0].encoding_parameters.compression_factor #=> Float
resp.outputs[0].media_stream_output_configurations[0].encoding_parameters.encoder_profile #=> String, one of "main", "high"
resp.outputs[0].media_stream_output_configurations[0].media_stream_name #=> String
resp.outputs[0].name #=> String
resp.outputs[0].output_arn #=> String
resp.outputs[0].port #=> Integer
resp.outputs[0].transport.cidr_allow_list #=> Array
resp.outputs[0].transport.cidr_allow_list[0] #=> String
resp.outputs[0].transport.max_bitrate #=> Integer
resp.outputs[0].transport.max_latency #=> Integer
resp.outputs[0].transport.max_sync_buffer #=> Integer
resp.outputs[0].transport.min_latency #=> Integer
resp.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.outputs[0].transport.remote_id #=> String
resp.outputs[0].transport.sender_control_port #=> Integer
resp.outputs[0].transport.sender_ip_address #=> String
resp.outputs[0].transport.smoothing_latency #=> Integer
resp.outputs[0].transport.source_listener_address #=> String
resp.outputs[0].transport.source_listener_port #=> Integer
resp.outputs[0].transport.stream_id #=> String
resp.outputs[0].transport.ndi_speed_hq_quality #=> Integer
resp.outputs[0].transport.ndi_program_name #=> String
resp.outputs[0].transport.ndi_source_settings.source_name #=> String
resp.outputs[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.outputs[0].vpc_interface_attachment.vpc_interface_name #=> String
resp.outputs[0].bridge_arn #=> String
resp.outputs[0].bridge_ports #=> Array
resp.outputs[0].bridge_ports[0] #=> Integer
resp.outputs[0].output_status #=> String, one of "ENABLED", "DISABLED"
resp.outputs[0].peer_ip_address #=> String
resp.outputs[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.outputs[0].router_integration_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.outputs[0].connected_router_input_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to add
outputs to.
    
          
        
    • 
      
        
  • 
          :outputs
          (required, Array<Types::AddOutputRequest>)
          
            
          
          
            — 
    A list of outputs that you want to add to the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


129

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

def add_flow_outputs: (

    		
  





    
      

  

  
    #add_flow_sources(params = {})  ⇒ Types::AddFlowSourcesResponse 
  

  

  


  

    
Adds sources to a flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_flow_sources({
  flow_arn: "AddFlowSourcesRequestFlowArnString", # required
  sources: [ # required
    {
      decryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      description: "String",
      entitlement_arn: "SetSourceRequestEntitlementArnString",
      ingest_port: 1,
      max_bitrate: 1,
      max_latency: 1,
      max_sync_buffer: 1,
      media_stream_source_configurations: [
        {
          encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
          input_configurations: [
            {
              input_port: 1, # required
              interface: { # required
                name: "String", # required
              },
            },
          ],
          media_stream_name: "String", # required
        },
      ],
      min_latency: 1,
      name: "String",
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      sender_control_port: 1,
      sender_ip_address: "String",
      source_listener_address: "String",
      source_listener_port: 1,
      stream_id: "String",
      vpc_interface_name: "String",
      whitelist_cidr: "String",
      gateway_bridge_source: {
        bridge_arn: "SetGatewayBridgeSourceRequestBridgeArnString", # required
        vpc_interface_attachment: {
          vpc_interface_name: "String",
        },
      },
      ndi_source_settings: {
        source_name: "String",
      },
      source_tags: {
        "String" => "String",
      },
      router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
      router_integration_transit_decryption: {
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.sources #=> Array
resp.sources[0].data_transfer_subscriber_fee_percent #=> Integer
resp.sources[0].decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.sources[0].decryption.constant_initialization_vector #=> String
resp.sources[0].decryption.device_id #=> String
resp.sources[0].decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.sources[0].decryption.region #=> String
resp.sources[0].decryption.resource_id #=> String
resp.sources[0].decryption.role_arn #=> String
resp.sources[0].decryption.secret_arn #=> String
resp.sources[0].decryption.url #=> String
resp.sources[0].description #=> String
resp.sources[0].entitlement_arn #=> String
resp.sources[0].ingest_ip #=> String
resp.sources[0].ingest_port #=> Integer
resp.sources[0].media_stream_source_configurations #=> Array
resp.sources[0].media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.sources[0].media_stream_source_configurations[0].input_configurations #=> Array
resp.sources[0].media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.sources[0].media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.sources[0].media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.sources[0].media_stream_source_configurations[0].media_stream_name #=> String
resp.sources[0].name #=> String
resp.sources[0].sender_control_port #=> Integer
resp.sources[0].sender_ip_address #=> String
resp.sources[0].source_arn #=> String
resp.sources[0].transport.cidr_allow_list #=> Array
resp.sources[0].transport.cidr_allow_list[0] #=> String
resp.sources[0].transport.max_bitrate #=> Integer
resp.sources[0].transport.max_latency #=> Integer
resp.sources[0].transport.max_sync_buffer #=> Integer
resp.sources[0].transport.min_latency #=> Integer
resp.sources[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.sources[0].transport.remote_id #=> String
resp.sources[0].transport.sender_control_port #=> Integer
resp.sources[0].transport.sender_ip_address #=> String
resp.sources[0].transport.smoothing_latency #=> Integer
resp.sources[0].transport.source_listener_address #=> String
resp.sources[0].transport.source_listener_port #=> Integer
resp.sources[0].transport.stream_id #=> String
resp.sources[0].transport.ndi_speed_hq_quality #=> Integer
resp.sources[0].transport.ndi_program_name #=> String
resp.sources[0].transport.ndi_source_settings.source_name #=> String
resp.sources[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.sources[0].vpc_interface_name #=> String
resp.sources[0].whitelist_cidr #=> String
resp.sources[0].gateway_bridge_source.bridge_arn #=> String
resp.sources[0].gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.sources[0].peer_ip_address #=> String
resp.sources[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.sources[0].router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.sources[0].connected_router_output_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :sources
          (required, Array<Types::SetSourceRequest>)
          
            
          
          
            — 
    A list of sources that you want to add to the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


143

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

def add_flow_sources: (

    		
  





    
      

  

  
    #add_flow_vpc_interfaces(params = {})  ⇒ Types::AddFlowVpcInterfacesResponse 
  

  

  


  

    
Adds VPC interfaces to a flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_flow_vpc_interfaces({
  flow_arn: "AddFlowVpcInterfacesRequestFlowArnString", # required
  vpc_interfaces: [ # required
    {
      name: "String", # required
      network_interface_type: "ena", # accepts ena, efa
      role_arn: "String", # required
      security_group_ids: ["String"], # required
      subnet_id: "String", # required
      vpc_interface_tags: {
        "String" => "String",
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.vpc_interfaces #=> Array
resp.vpc_interfaces[0].name #=> String
resp.vpc_interfaces[0].network_interface_ids #=> Array
resp.vpc_interfaces[0].network_interface_ids[0] #=> String
resp.vpc_interfaces[0].network_interface_type #=> String, one of "ena", "efa"
resp.vpc_interfaces[0].role_arn #=> String
resp.vpc_interfaces[0].security_group_ids #=> Array
resp.vpc_interfaces[0].security_group_ids[0] #=> String
resp.vpc_interfaces[0].subnet_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :vpc_interfaces
          (required, Array<Types::VpcInterfaceRequest>)
          
            
          
          
            — 
    A list of VPC interfaces that you want to add to the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


157

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

def add_flow_vpc_interfaces: (

    		
  





    
      

  

  
    #batch_get_router_input(params = {})  ⇒ Types::BatchGetRouterInputResponse 
  

  

  


  

    
Retrieves information about multiple router inputs in AWS Elemental
MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.batch_get_router_input({
  arns: ["RouterInputArn"], # required
})

    
      
        
Response structure

      
      

resp.router_inputs #=> Array
resp.router_inputs[0].name #=> String
resp.router_inputs[0].arn #=> String
resp.router_inputs[0].id #=> String
resp.router_inputs[0].state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_inputs[0].input_type #=> String, one of "STANDARD", "FAILOVER", "MERGE", "MEDIACONNECT_FLOW", "MEDIALIVE_CHANNEL"
resp.router_inputs[0].configuration.standard.network_interface_arn #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.rist.port #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.rist.recovery_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.source_address #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.source_port #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_inputs[0].configuration.standard.protocol_configuration.rtp.port #=> Integer
resp.router_inputs[0].configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_inputs[0].configuration.media_live_channel.media_live_channel_arn #=> String
resp.router_inputs[0].configuration.media_live_channel.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_inputs[0].configuration.media_live_channel.media_live_channel_output_name #=> String
resp.router_inputs[0].configuration.media_live_channel.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_inputs[0].configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_inputs[0].configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_inputs[0].configuration.failover.network_interface_arn #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations #=> Array
resp.router_inputs[0].configuration.failover.protocol_configurations[0].rist.port #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_listener.port #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.source_address #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.source_port #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.stream_id #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_inputs[0].configuration.failover.protocol_configurations[0].rtp.port #=> Integer
resp.router_inputs[0].configuration.failover.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].configuration.failover.source_priority_mode #=> String, one of "NO_PRIORITY", "PRIMARY_SECONDARY"
resp.router_inputs[0].configuration.failover.primary_source_index #=> Integer
resp.router_inputs[0].configuration.media_connect_flow.flow_arn #=> String
resp.router_inputs[0].configuration.media_connect_flow.flow_output_arn #=> String
resp.router_inputs[0].configuration.media_connect_flow.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_inputs[0].configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_inputs[0].configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_inputs[0].configuration.merge.network_interface_arn #=> String
resp.router_inputs[0].configuration.merge.protocol_configurations #=> Array
resp.router_inputs[0].configuration.merge.protocol_configurations[0].rtp.port #=> Integer
resp.router_inputs[0].configuration.merge.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].configuration.merge.protocol_configurations[0].rist.port #=> Integer
resp.router_inputs[0].configuration.merge.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_inputs[0].configuration.merge.merge_recovery_window_milliseconds #=> Integer
resp.router_inputs[0].routed_outputs #=> Integer
resp.router_inputs[0].maximum_routed_outputs #=> Integer
resp.router_inputs[0].region_name #=> String
resp.router_inputs[0].availability_zone #=> String
resp.router_inputs[0].maximum_bitrate #=> Integer
resp.router_inputs[0].tier #=> String, one of "INPUT_100", "INPUT_50", "INPUT_20"
resp.router_inputs[0].routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_inputs[0].created_at #=> Time
resp.router_inputs[0].updated_at #=> Time
resp.router_inputs[0].messages #=> Array
resp.router_inputs[0].messages[0].code #=> String
resp.router_inputs[0].messages[0].message #=> String
resp.router_inputs[0].transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_inputs[0].transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_inputs[0].transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_inputs[0].tags #=> Hash
resp.router_inputs[0].tags["String"] #=> String
resp.router_inputs[0].stream_details.standard.source_ip_address #=> String
resp.router_inputs[0].stream_details.failover.source_index_zero_stream_details.source_index #=> Integer
resp.router_inputs[0].stream_details.failover.source_index_zero_stream_details.source_ip_address #=> String
resp.router_inputs[0].stream_details.failover.source_index_one_stream_details.source_index #=> Integer
resp.router_inputs[0].stream_details.failover.source_index_one_stream_details.source_ip_address #=> String
resp.router_inputs[0].stream_details.merge.source_index_zero_stream_details.source_index #=> Integer
resp.router_inputs[0].stream_details.merge.source_index_zero_stream_details.source_ip_address #=> String
resp.router_inputs[0].stream_details.merge.source_index_one_stream_details.source_index #=> Integer
resp.router_inputs[0].stream_details.merge.source_index_one_stream_details.source_ip_address #=> String
resp.router_inputs[0].ip_address #=> String
resp.router_inputs[0].maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_inputs[0].maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_inputs[0].maintenance_configuration.preferred_day_time.time #=> String
resp.router_inputs[0].maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_inputs[0].maintenance_schedule.window.start #=> Time
resp.router_inputs[0].maintenance_schedule.window.end #=> Time
resp.router_inputs[0].maintenance_schedule.window.scheduled_time #=> Time
resp.router_inputs[0].content_quality_analysis_type #=> String, one of "CONTENT_LEVEL"
resp.router_inputs[0].content_quality_analysis_configuration.content_level.black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].content_quality_analysis_configuration.content_level.black_frames.threshold_seconds #=> Integer
resp.router_inputs[0].content_quality_analysis_configuration.content_level.frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].content_quality_analysis_configuration.content_level.frozen_frames.threshold_seconds #=> Integer
resp.router_inputs[0].content_quality_analysis_configuration.content_level.silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.router_inputs[0].content_quality_analysis_configuration.content_level.silent_audio.threshold_seconds #=> Integer
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arns
          (required, Array<String>)
          
            
          
          
            — 
    The Amazon Resource Names (ARNs) of the router inputs you want to
retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


171

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

def batch_get_router_input: (

    		
  





    
      

  

  
    #batch_get_router_network_interface(params = {})  ⇒ Types::BatchGetRouterNetworkInterfaceResponse 
  

  

  


  

    
Retrieves information about multiple router network interfaces in AWS
Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.batch_get_router_network_interface({
  arns: ["RouterNetworkInterfaceArn"], # required
})

    
      
        
Response structure

      
      

resp.router_network_interfaces #=> Array
resp.router_network_interfaces[0].name #=> String
resp.router_network_interfaces[0].arn #=> String
resp.router_network_interfaces[0].id #=> String
resp.router_network_interfaces[0].state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"
resp.router_network_interfaces[0].network_interface_type #=> String, one of "PUBLIC", "VPC"
resp.router_network_interfaces[0].configuration.public.allow_rules #=> Array
resp.router_network_interfaces[0].configuration.public.allow_rules[0].cidr #=> String
resp.router_network_interfaces[0].configuration.vpc.security_group_ids #=> Array
resp.router_network_interfaces[0].configuration.vpc.security_group_ids[0] #=> String
resp.router_network_interfaces[0].configuration.vpc.subnet_id #=> String
resp.router_network_interfaces[0].associated_output_count #=> Integer
resp.router_network_interfaces[0].associated_input_count #=> Integer
resp.router_network_interfaces[0].region_name #=> String
resp.router_network_interfaces[0].created_at #=> Time
resp.router_network_interfaces[0].updated_at #=> Time
resp.router_network_interfaces[0].tags #=> Hash
resp.router_network_interfaces[0].tags["String"] #=> String
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arns
          (required, Array<String>)
          
            
          
          
            — 
    The Amazon Resource Names (ARNs) of the router network interfaces you
want to retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


182

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

def batch_get_router_network_interface: (

    		
  





    
      

  

  
    #batch_get_router_output(params = {})  ⇒ Types::BatchGetRouterOutputResponse 
  

  

  


  

    
Retrieves information about multiple router outputs in AWS Elemental
MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.batch_get_router_output({
  arns: ["RouterOutputArn"], # required
})

    
      
        
Response structure

      
      

resp.router_outputs #=> Array
resp.router_outputs[0].name #=> String
resp.router_outputs[0].arn #=> String
resp.router_outputs[0].id #=> String
resp.router_outputs[0].state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_outputs[0].output_type #=> String, one of "STANDARD", "MEDIACONNECT_FLOW", "MEDIALIVE_INPUT"
resp.router_outputs[0].configuration.standard.network_interface_arn #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.rist.destination_address #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.rist.destination_port #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.role_arn #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.destination_address #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.destination_port #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.role_arn #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.rtp.destination_address #=> String
resp.router_outputs[0].configuration.standard.protocol_configuration.rtp.destination_port #=> Integer
resp.router_outputs[0].configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_outputs[0].configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_outputs[0].configuration.media_connect_flow.flow_arn #=> String
resp.router_outputs[0].configuration.media_connect_flow.flow_source_arn #=> String
resp.router_outputs[0].configuration.media_connect_flow.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_outputs[0].configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_outputs[0].configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_outputs[0].configuration.media_live_input.media_live_input_arn #=> String
resp.router_outputs[0].configuration.media_live_input.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_outputs[0].configuration.media_live_input.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_outputs[0].configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_outputs[0].configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_outputs[0].routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_outputs[0].region_name #=> String
resp.router_outputs[0].availability_zone #=> String
resp.router_outputs[0].maximum_bitrate #=> Integer
resp.router_outputs[0].routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_outputs[0].tier #=> String, one of "OUTPUT_100", "OUTPUT_50", "OUTPUT_20"
resp.router_outputs[0].created_at #=> Time
resp.router_outputs[0].updated_at #=> Time
resp.router_outputs[0].messages #=> Array
resp.router_outputs[0].messages[0].code #=> String
resp.router_outputs[0].messages[0].message #=> String
resp.router_outputs[0].tags #=> Hash
resp.router_outputs[0].tags["String"] #=> String
resp.router_outputs[0].stream_details.standard.destination_ip_address #=> String
resp.router_outputs[0].ip_address #=> String
resp.router_outputs[0].routed_input_arn #=> String
resp.router_outputs[0].maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_outputs[0].maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_outputs[0].maintenance_configuration.preferred_day_time.time #=> String
resp.router_outputs[0].maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_outputs[0].maintenance_schedule.window.start #=> Time
resp.router_outputs[0].maintenance_schedule.window.end #=> Time
resp.router_outputs[0].maintenance_schedule.window.scheduled_time #=> Time
resp.router_outputs[0].fabric_configuration.recovery_latency_mode #=> String, one of "BALANCED", "LOW_LATENCY"
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arns
          (required, Array<String>)
          
            
          
          
            — 
    The Amazon Resource Names (ARNs) of the router outputs you want to
retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


193

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

def batch_get_router_output: (

    		
  





    
      

  

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






  

    
      


7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411

    		
    
      
# File 'lib/aws-sdk-mediaconnect/client.rb', line 7395

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::MediaConnect')
  )
  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-mediaconnect'
  context[:gem_version] = '1.105.0'
  Seahorse::Client::Request.new(handlers, context)
end

    		
  





    
      

  

  
    #create_bridge(params = {})  ⇒ Types::CreateBridgeResponse 
  

  

  


  

    
Creates a new bridge. The request must include one source.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_bridge({
  egress_gateway_bridge: {
    max_bitrate: 1, # required
  },
  ingress_gateway_bridge: {
    max_bitrate: 1, # required
    max_outputs: 1, # required
  },
  name: "String", # required
  outputs: [
    {
      network_output: {
        ip_address: "String", # required
        name: "String", # required
        network_name: "String", # required
        port: 1, # required
        protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
        ttl: 1, # required
      },
    },
  ],
  placement_arn: "String", # required
  source_failover_config: {
    failover_mode: "MERGE", # accepts MERGE, FAILOVER
    recovery_window: 1,
    source_priority: {
      primary_source: "String",
    },
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  sources: [ # required
    {
      flow_source: {
        flow_arn: "AddBridgeFlowSourceRequestFlowArnString", # required
        flow_vpc_interface_attachment: {
          vpc_interface_name: "String",
        },
        name: "String", # required
      },
      network_source: {
        multicast_ip: "String", # required
        multicast_source_settings: {
          multicast_source_ip: "String",
        },
        name: "String", # required
        network_name: "String", # required
        port: 1, # required
        protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      },
    },
  ],
})

    
      
        
Response structure

      
      

resp.bridge.bridge_arn #=> String
resp.bridge.bridge_messages #=> Array
resp.bridge.bridge_messages[0].code #=> String
resp.bridge.bridge_messages[0].message #=> String
resp.bridge.bridge_messages[0].resource_name #=> String
resp.bridge.bridge_state #=> String, one of "CREATING", "STANDBY", "STARTING", "DEPLOYING", "ACTIVE", "STOPPING", "DELETING", "DELETED", "START_FAILED", "START_PENDING", "STOP_FAILED", "UPDATING"
resp.bridge.egress_gateway_bridge.instance_id #=> String
resp.bridge.egress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.instance_id #=> String
resp.bridge.ingress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.max_outputs #=> Integer
resp.bridge.name #=> String
resp.bridge.outputs #=> Array
resp.bridge.outputs[0].flow_output.flow_arn #=> String
resp.bridge.outputs[0].flow_output.flow_source_arn #=> String
resp.bridge.outputs[0].flow_output.name #=> String
resp.bridge.outputs[0].network_output.ip_address #=> String
resp.bridge.outputs[0].network_output.name #=> String
resp.bridge.outputs[0].network_output.network_name #=> String
resp.bridge.outputs[0].network_output.port #=> Integer
resp.bridge.outputs[0].network_output.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.bridge.outputs[0].network_output.ttl #=> Integer
resp.bridge.placement_arn #=> String
resp.bridge.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.bridge.source_failover_config.recovery_window #=> Integer
resp.bridge.source_failover_config.source_priority.primary_source #=> String
resp.bridge.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.bridge.sources #=> Array
resp.bridge.sources[0].flow_source.flow_arn #=> String
resp.bridge.sources[0].flow_source.flow_vpc_interface_attachment.vpc_interface_name #=> String
resp.bridge.sources[0].flow_source.name #=> String
resp.bridge.sources[0].flow_source.output_arn #=> String
resp.bridge.sources[0].network_source.multicast_ip #=> String
resp.bridge.sources[0].network_source.multicast_source_settings.multicast_source_ip #=> String
resp.bridge.sources[0].network_source.name #=> String
resp.bridge.sources[0].network_source.network_name #=> String
resp.bridge.sources[0].network_source.port #=> Integer
resp.bridge.sources[0].network_source.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :egress_gateway_bridge
          (Types::AddEgressGatewayBridgeRequest)
          
            
          
          
            — 
    An egress bridge is a cloud-to-ground bridge. The content comes from
an existing MediaConnect flow and is delivered to your premises.
    
          
        
    • 
      
        
  • 
          :ingress_gateway_bridge
          (Types::AddIngressGatewayBridgeRequest)
          
            
          
          
            — 
    An ingress bridge is a ground-to-cloud bridge. The content originates
at your premises and is delivered to the cloud.
    
          
        
    • 
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the bridge. This name can not be modified after the bridge
is created.
    
          
        
    • 
      
        
  • 
          :outputs
          (Array<Types::AddBridgeOutputRequest>)
          
            
          
          
            — 
    The outputs that you want to add to this bridge.
    
          
        
    • 
      
        
  • 
          :placement_arn
          (required, String)
          
            
          
          
            — 
    The bridge placement Amazon Resource Number (ARN).
    
          
        
    • 
      
        
  • 
          :source_failover_config
          (Types::FailoverConfig)
          
            
          
          
            — 
    The settings for source failover.
    
          
        
    • 
      
        
  • 
          :sources
          (required, Array<Types::AddBridgeSourceRequest>)
          
            
          
          
            — 
    The sources that you want to add to this bridge.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


203

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

def create_bridge: (

    		
  





    
      

  

  
    #create_flow(params = {})  ⇒ Types::CreateFlowResponse 
  

  

  


  

    
Creates a new flow. The request must include one source. The request
optionally can include outputs (up to 50) and entitlements (up to 50).


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_flow({
  availability_zone: "String",
  entitlements: [
    {
      data_transfer_subscriber_fee_percent: 1,
      description: "String",
      encryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      entitlement_status: "ENABLED", # accepts ENABLED, DISABLED
      name: "String",
      subscribers: ["String"], # required
      entitlement_tags: {
        "String" => "String",
      },
    },
  ],
  media_streams: [
    {
      attributes: {
        fmtp: {
          channel_order: "String",
          colorimetry: "BT601", # accepts BT601, BT709, BT2020, BT2100, ST2065-1, ST2065-3, XYZ
          exact_framerate: "String",
          par: "String",
          range: "NARROW", # accepts NARROW, FULL, FULLPROTECT
          scan_mode: "progressive", # accepts progressive, interlace, progressive-segmented-frame
          tcs: "SDR", # accepts SDR, PQ, HLG, LINEAR, BT2100LINPQ, BT2100LINHLG, ST2065-1, ST428-1, DENSITY
        },
        lang: "String",
      },
      clock_rate: 1,
      description: "String",
      media_stream_id: 1, # required
      media_stream_name: "String", # required
      media_stream_type: "video", # required, accepts video, audio, ancillary-data
      video_format: "String",
      media_stream_tags: {
        "String" => "String",
      },
    },
  ],
  name: "String", # required
  outputs: [
    {
      cidr_allow_list: ["String"],
      description: "String",
      destination: "String",
      encryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      max_latency: 1,
      media_stream_output_configurations: [
        {
          destination_configurations: [
            {
              destination_ip: "String", # required
              destination_port: 1, # required
              interface: { # required
                name: "String", # required
              },
            },
          ],
          encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
          encoding_parameters: {
            compression_factor: 1.0, # required
            encoder_profile: "main", # required, accepts main, high
          },
          media_stream_name: "String", # required
        },
      ],
      min_latency: 1,
      name: "String",
      port: 1,
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      remote_id: "String",
      sender_control_port: 1,
      smoothing_latency: 1,
      stream_id: "String",
      vpc_interface_attachment: {
        vpc_interface_name: "String",
      },
      output_status: "ENABLED", # accepts ENABLED, DISABLED
      ndi_speed_hq_quality: 1,
      ndi_program_name: "String",
      output_tags: {
        "String" => "String",
      },
      router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
      router_integration_transit_encryption: {
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
      ndi_output_timecode_source: "EMBEDDED_TIMECODE", # accepts EMBEDDED_TIMECODE, UTC_SYSTEM_TIME
    },
  ],
  source: {
    decryption: {
      algorithm: "aes128", # accepts aes128, aes192, aes256
      constant_initialization_vector: "String",
      device_id: "String",
      key_type: "speke", # accepts speke, static-key, srt-password
      region: "String",
      resource_id: "String",
      role_arn: "String", # required
      secret_arn: "String",
      url: "String",
    },
    description: "String",
    entitlement_arn: "SetSourceRequestEntitlementArnString",
    ingest_port: 1,
    max_bitrate: 1,
    max_latency: 1,
    max_sync_buffer: 1,
    media_stream_source_configurations: [
      {
        encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
        input_configurations: [
          {
            input_port: 1, # required
            interface: { # required
              name: "String", # required
            },
          },
        ],
        media_stream_name: "String", # required
      },
    ],
    min_latency: 1,
    name: "String",
    protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
    sender_control_port: 1,
    sender_ip_address: "String",
    source_listener_address: "String",
    source_listener_port: 1,
    stream_id: "String",
    vpc_interface_name: "String",
    whitelist_cidr: "String",
    gateway_bridge_source: {
      bridge_arn: "SetGatewayBridgeSourceRequestBridgeArnString", # required
      vpc_interface_attachment: {
        vpc_interface_name: "String",
      },
    },
    ndi_source_settings: {
      source_name: "String",
    },
    source_tags: {
      "String" => "String",
    },
    router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
    router_integration_transit_decryption: {
      encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
      encryption_key_configuration: { # required
        secrets_manager: {
          secret_arn: "SecretArn", # required
          role_arn: "RoleArn", # required
        },
        automatic: {
        },
      },
    },
  },
  source_failover_config: {
    failover_mode: "MERGE", # accepts MERGE, FAILOVER
    recovery_window: 1,
    source_priority: {
      primary_source: "String",
    },
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  sources: [
    {
      decryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      description: "String",
      entitlement_arn: "SetSourceRequestEntitlementArnString",
      ingest_port: 1,
      max_bitrate: 1,
      max_latency: 1,
      max_sync_buffer: 1,
      media_stream_source_configurations: [
        {
          encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
          input_configurations: [
            {
              input_port: 1, # required
              interface: { # required
                name: "String", # required
              },
            },
          ],
          media_stream_name: "String", # required
        },
      ],
      min_latency: 1,
      name: "String",
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
      sender_control_port: 1,
      sender_ip_address: "String",
      source_listener_address: "String",
      source_listener_port: 1,
      stream_id: "String",
      vpc_interface_name: "String",
      whitelist_cidr: "String",
      gateway_bridge_source: {
        bridge_arn: "SetGatewayBridgeSourceRequestBridgeArnString", # required
        vpc_interface_attachment: {
          vpc_interface_name: "String",
        },
      },
      ndi_source_settings: {
        source_name: "String",
      },
      source_tags: {
        "String" => "String",
      },
      router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
      router_integration_transit_decryption: {
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
  ],
  vpc_interfaces: [
    {
      name: "String", # required
      network_interface_type: "ena", # accepts ena, efa
      role_arn: "String", # required
      security_group_ids: ["String"], # required
      subnet_id: "String", # required
      vpc_interface_tags: {
        "String" => "String",
      },
    },
  ],
  maintenance: {
    maintenance_day: "Monday", # required, accepts Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
    maintenance_start_hour: "String", # required
  },
  source_monitoring_config: {
    thumbnail_state: "ENABLED", # accepts ENABLED, DISABLED
    audio_monitoring_settings: [
      {
        silent_audio: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
      },
    ],
    content_quality_analysis_state: "ENABLED", # accepts ENABLED, DISABLED
    video_monitoring_settings: [
      {
        black_frames: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
        frozen_frames: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
      },
    ],
  },
  flow_size: "MEDIUM", # accepts MEDIUM, LARGE, LARGE_4X
  ndi_config: {
    ndi_state: "ENABLED", # accepts ENABLED, DISABLED
    machine_name: "String",
    ndi_discovery_servers: [
      {
        discovery_server_address: "String", # required
        discovery_server_port: 1,
        vpc_interface_adapter: "String", # required
      },
    ],
  },
  encoding_config: {
    encoding_profile: "DISTRIBUTION_H264_DEFAULT", # accepts DISTRIBUTION_H264_DEFAULT, CONTRIBUTION_H264_DEFAULT
    video_max_bitrate: 1,
  },
  flow_tags: {
    "String" => "String",
  },
})

    
      
        
Response structure

      
      

resp.flow.availability_zone #=> String
resp.flow.description #=> String
resp.flow.egress_ip #=> String
resp.flow.entitlements #=> Array
resp.flow.entitlements[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.entitlements[0].description #=> String
resp.flow.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.entitlements[0].encryption.constant_initialization_vector #=> String
resp.flow.entitlements[0].encryption.device_id #=> String
resp.flow.entitlements[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.entitlements[0].encryption.region #=> String
resp.flow.entitlements[0].encryption.resource_id #=> String
resp.flow.entitlements[0].encryption.role_arn #=> String
resp.flow.entitlements[0].encryption.secret_arn #=> String
resp.flow.entitlements[0].encryption.url #=> String
resp.flow.entitlements[0].entitlement_arn #=> String
resp.flow.entitlements[0].entitlement_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.entitlements[0].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> String
resp.flow.media_streams #=> Array
resp.flow.media_streams[0].attributes.fmtp.channel_order #=> String
resp.flow.media_streams[0].attributes.fmtp.colorimetry #=> String, one of "BT601", "BT709", "BT2020", "BT2100", "ST2065-1", "ST2065-3", "XYZ"
resp.flow.media_streams[0].attributes.fmtp.exact_framerate #=> String
resp.flow.media_streams[0].attributes.fmtp.par #=> String
resp.flow.media_streams[0].attributes.fmtp.range #=> String, one of "NARROW", "FULL", "FULLPROTECT"
resp.flow.media_streams[0].attributes.fmtp.scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.flow.media_streams[0].attributes.fmtp.tcs #=> String, one of "SDR", "PQ", "HLG", "LINEAR", "BT2100LINPQ", "BT2100LINHLG", "ST2065-1", "ST428-1", "DENSITY"
resp.flow.media_streams[0].attributes.lang #=> String
resp.flow.media_streams[0].clock_rate #=> Integer
resp.flow.media_streams[0].description #=> String
resp.flow.media_streams[0].fmt #=> Integer
resp.flow.media_streams[0].media_stream_id #=> Integer
resp.flow.media_streams[0].media_stream_name #=> String
resp.flow.media_streams[0].media_stream_type #=> String, one of "video", "audio", "ancillary-data"
resp.flow.media_streams[0].video_format #=> String
resp.flow.name #=> String
resp.flow.outputs #=> Array
resp.flow.outputs[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.outputs[0].description #=> String
resp.flow.outputs[0].destination #=> String
resp.flow.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.outputs[0].encryption.constant_initialization_vector #=> String
resp.flow.outputs[0].encryption.device_id #=> String
resp.flow.outputs[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.outputs[0].encryption.region #=> String
resp.flow.outputs[0].encryption.resource_id #=> String
resp.flow.outputs[0].encryption.role_arn #=> String
resp.flow.outputs[0].encryption.secret_arn #=> String
resp.flow.outputs[0].encryption.url #=> String
resp.flow.outputs[0].entitlement_arn #=> String
resp.flow.outputs[0].listener_address #=> String
resp.flow.outputs[0].media_live_input_arn #=> String
resp.flow.outputs[0].media_stream_output_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_port #=> Integer
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].interface.name #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].outbound_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.compression_factor #=> Float
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.encoder_profile #=> String, one of "main", "high"
resp.flow.outputs[0].media_stream_output_configurations[0].media_stream_name #=> String
resp.flow.outputs[0].name #=> String
resp.flow.outputs[0].output_arn #=> String
resp.flow.outputs[0].port #=> Integer
resp.flow.outputs[0].transport.cidr_allow_list #=> Array
resp.flow.outputs[0].transport.cidr_allow_list[0] #=> String
resp.flow.outputs[0].transport.max_bitrate #=> Integer
resp.flow.outputs[0].transport.max_latency #=> Integer
resp.flow.outputs[0].transport.max_sync_buffer #=> Integer
resp.flow.outputs[0].transport.min_latency #=> Integer
resp.flow.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.sender_control_port #=> Integer
resp.flow.outputs[0].transport.sender_ip_address #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.source_listener_address #=> String
resp.flow.outputs[0].transport.source_listener_port #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.outputs[0].transport.ndi_program_name #=> String
resp.flow.outputs[0].transport.ndi_source_settings.source_name #=> String
resp.flow.outputs[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.outputs[0].bridge_arn #=> String
resp.flow.outputs[0].bridge_ports #=> Array
resp.flow.outputs[0].bridge_ports[0] #=> Integer
resp.flow.outputs[0].output_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].peer_ip_address #=> String
resp.flow.outputs[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.outputs[0].connected_router_input_arn #=> String
resp.flow.source.data_transfer_subscriber_fee_percent #=> Integer
resp.flow.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.source.decryption.constant_initialization_vector #=> String
resp.flow.source.decryption.device_id #=> String
resp.flow.source.decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.source.decryption.region #=> String
resp.flow.source.decryption.resource_id #=> String
resp.flow.source.decryption.role_arn #=> String
resp.flow.source.decryption.secret_arn #=> String
resp.flow.source.decryption.url #=> String
resp.flow.source.description #=> String
resp.flow.source.entitlement_arn #=> String
resp.flow.source.ingest_ip #=> String
resp.flow.source.ingest_port #=> Integer
resp.flow.source.media_stream_source_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.source.media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.source.media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.source.name #=> String
resp.flow.source.sender_control_port #=> Integer
resp.flow.source.sender_ip_address #=> String
resp.flow.source.source_arn #=> String
resp.flow.source.transport.cidr_allow_list #=> Array
resp.flow.source.transport.cidr_allow_list[0] #=> String
resp.flow.source.transport.max_bitrate #=> Integer
resp.flow.source.transport.max_latency #=> Integer
resp.flow.source.transport.max_sync_buffer #=> Integer
resp.flow.source.transport.min_latency #=> Integer
resp.flow.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.sender_control_port #=> Integer
resp.flow.source.transport.sender_ip_address #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.source_listener_address #=> String
resp.flow.source.transport.source_listener_port #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.transport.ndi_speed_hq_quality #=> Integer
resp.flow.source.transport.ndi_program_name #=> String
resp.flow.source.transport.ndi_source_settings.source_name #=> String
resp.flow.source.transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source.gateway_bridge_source.bridge_arn #=> String
resp.flow.source.gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.source.peer_ip_address #=> String
resp.flow.source.router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source.router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.source.connected_router_output_arn #=> String
resp.flow.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.flow.source_failover_config.recovery_window #=> Integer
resp.flow.source_failover_config.source_priority.primary_source #=> String
resp.flow.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources #=> Array
resp.flow.sources[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.sources[0].decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.sources[0].decryption.constant_initialization_vector #=> String
resp.flow.sources[0].decryption.device_id #=> String
resp.flow.sources[0].decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.sources[0].decryption.region #=> String
resp.flow.sources[0].decryption.resource_id #=> String
resp.flow.sources[0].decryption.role_arn #=> String
resp.flow.sources[0].decryption.secret_arn #=> String
resp.flow.sources[0].decryption.url #=> String
resp.flow.sources[0].description #=> String
resp.flow.sources[0].entitlement_arn #=> String
resp.flow.sources[0].ingest_ip #=> String
resp.flow.sources[0].ingest_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.sources[0].media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.sources[0].name #=> String
resp.flow.sources[0].sender_control_port #=> Integer
resp.flow.sources[0].sender_ip_address #=> String
resp.flow.sources[0].source_arn #=> String
resp.flow.sources[0].transport.cidr_allow_list #=> Array
resp.flow.sources[0].transport.cidr_allow_list[0] #=> String
resp.flow.sources[0].transport.max_bitrate #=> Integer
resp.flow.sources[0].transport.max_latency #=> Integer
resp.flow.sources[0].transport.max_sync_buffer #=> Integer
resp.flow.sources[0].transport.min_latency #=> Integer
resp.flow.sources[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.sender_control_port #=> Integer
resp.flow.sources[0].transport.sender_ip_address #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.source_listener_address #=> String
resp.flow.sources[0].transport.source_listener_port #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.sources[0].transport.ndi_program_name #=> String
resp.flow.sources[0].transport.ndi_source_settings.source_name #=> String
resp.flow.sources[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> String
resp.flow.sources[0].gateway_bridge_source.bridge_arn #=> String
resp.flow.sources[0].gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.sources[0].peer_ip_address #=> String
resp.flow.sources[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.sources[0].connected_router_output_arn #=> String
resp.flow.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
resp.flow.vpc_interfaces #=> Array
resp.flow.vpc_interfaces[0].name #=> String
resp.flow.vpc_interfaces[0].network_interface_ids #=> Array
resp.flow.vpc_interfaces[0].network_interface_ids[0] #=> String
resp.flow.vpc_interfaces[0].network_interface_type #=> String, one of "ena", "efa"
resp.flow.vpc_interfaces[0].role_arn #=> String
resp.flow.vpc_interfaces[0].security_group_ids #=> Array
resp.flow.vpc_interfaces[0].security_group_ids[0] #=> String
resp.flow.vpc_interfaces[0].subnet_id #=> String
resp.flow.maintenance.maintenance_day #=> String, one of "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"
resp.flow.maintenance.maintenance_deadline #=> String
resp.flow.maintenance.maintenance_scheduled_date #=> String
resp.flow.maintenance.maintenance_start_hour #=> String
resp.flow.source_monitoring_config.thumbnail_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings #=> Array
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.content_quality_analysis_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings #=> Array
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.threshold_seconds #=> Integer
resp.flow.flow_size #=> String, one of "MEDIUM", "LARGE", "LARGE_4X"
resp.flow.ndi_config.ndi_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.ndi_config.machine_name #=> String
resp.flow.ndi_config.ndi_discovery_servers #=> Array
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_address #=> String
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_port #=> Integer
resp.flow.ndi_config.ndi_discovery_servers[0].vpc_interface_adapter #=> String
resp.flow.encoding_config.encoding_profile #=> String, one of "DISTRIBUTION_H264_DEFAULT", "CONTRIBUTION_H264_DEFAULT"
resp.flow.encoding_config.video_max_bitrate #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :availability_zone
          (String)
          
            
          
          
            — 
    The Availability Zone that you want to create the flow in. These
options are limited to the Availability Zones within the current
Amazon Web Services Region.
    
          
        
    • 
      
        
  • 
          :entitlements
          (Array<Types::GrantEntitlementRequest>)
          
            
          
          
            — 
    The entitlements that you want to grant on a flow.
    
          
        
    • 
      
        
  • 
          :media_streams
          (Array<Types::AddMediaStreamRequest>)
          
            
          
          
            — 
    The media streams that you want to add to the flow. You can associate
these media streams with sources and outputs on the flow.
    
          
        
    • 
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the flow.
    
          
        
    • 
      
        
  • 
          :outputs
          (Array<Types::AddOutputRequest>)
          
            
          
          
            — 
    The outputs that you want to add to this flow.
    
          
        
    • 
      
        
  • 
          :source
          (Types::SetSourceRequest)
          
            
          
          
            — 
    The settings for the source that you want to use for the new flow.
    
          
        
    • 
      
        
  • 
          :source_failover_config
          (Types::FailoverConfig)
          
            
          
          
            — 
    The settings for source failover.
    
          
        
    • 
      
        
  • 
          :sources
          (Array<Types::SetSourceRequest>)
          
            
          
          
            — 
    The sources that are assigned to the flow.
    
          
        
    • 
      
        
  • 
          :vpc_interfaces
          (Array<Types::VpcInterfaceRequest>)
          
            
          
          
            — 
    The VPC interfaces you want on the flow.
    
          
        
    • 
      
        
  • 
          :maintenance
          (Types::AddMaintenance)
          
            
          
          
            — 
    The maintenance settings you want to use for the flow.
    
          
        
    • 
      
        
  • 
          :source_monitoring_config
          (Types::MonitoringConfig)
          
            
          
          
            — 
    The settings for source monitoring.
    
          
        
    • 
      
        
  • 
          :flow_size
          (String)
          
            
          
          
            — 
    Determines the processing capacity and feature set of the flow. Set
this optional parameter to LARGE if you want to enable NDI sources
or outputs on the flow.
    
          
        
    • 
      
        
  • 
          :ndi_config
          (Types::NdiConfig)
          
            
          
          
            — 
    Specifies the configuration settings for a flow's NDI source or
output. Required when the flow includes an NDI source or output.
    
          
        
    • 
      
        
  • 
          :encoding_config
          (Types::EncodingConfig)
          
            
          
          
            — 
    The encoding configuration to apply to the NDI® source when
transcoding it to a transport stream for downstream distribution. You
can choose between several predefined encoding profiles based on
common use cases.
    
          
        
    • 
      
        
  • 
          :flow_tags
          (Hash<String,String>)
          
            
          
          
            — 
    The key-value pairs that can be used to tag and organize the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


228

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

def create_flow: (

    		
  





    
      

  

  
    #create_gateway(params = {})  ⇒ Types::CreateGatewayResponse 
  

  

  


  

    
Creates a new gateway. The request must include at least one network
(up to four).


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_gateway({
  egress_cidr_blocks: ["String"], # required
  name: "String", # required
  networks: [ # required
    {
      cidr_block: "String", # required
      name: "String", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.gateway.egress_cidr_blocks #=> Array
resp.gateway.egress_cidr_blocks[0] #=> String
resp.gateway.gateway_arn #=> String
resp.gateway.gateway_messages #=> Array
resp.gateway.gateway_messages[0].code #=> String
resp.gateway.gateway_messages[0].message #=> String
resp.gateway.gateway_messages[0].resource_name #=> String
resp.gateway.gateway_state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "ERROR", "DELETING", "DELETED"
resp.gateway.name #=> String
resp.gateway.networks #=> Array
resp.gateway.networks[0].cidr_block #=> String
resp.gateway.networks[0].name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :egress_cidr_blocks
          (required, Array<String>)
          
            
          
          
            — 
    The range of IP addresses that are allowed to contribute content or
initiate output requests for flows communicating with this gateway.
These IP addresses should be in the form of a Classless Inter-Domain
Routing (CIDR) block; for example, 10.0.0.0/16.
    
          
        
    • 
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the gateway. This name can not be modified after the
gateway is created.
    
          
        
    • 
      
        
  • 
          :networks
          (required, Array<Types::GatewayNetwork>)
          
            
          
          
            — 
    The list of networks that you want to add to the gateway.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


268

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

def create_gateway: (

    		
  





    
      

  

  
    #create_router_input(params = {})  ⇒ Types::CreateRouterInputResponse 
  

  

  


  

    
Creates a new router input in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_router_input({
  name: "CreateRouterInputRequestNameString", # required
  configuration: { # required
    standard: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configuration: { # required
        rist: {
          port: 1, # required
          recovery_latency_milliseconds: 1, # required
        },
        srt_listener: {
          port: 1, # required
          minimum_latency_milliseconds: 1, # required
          decryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        srt_caller: {
          source_address: "String", # required
          source_port: 1, # required
          minimum_latency_milliseconds: 1, # required
          stream_id: "String",
          decryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        rtp: {
          port: 1, # required
          forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      protocol: "RTP", # accepts RTP, RIST, SRT_CALLER, SRT_LISTENER
    },
    media_live_channel: {
      media_live_channel_arn: "MediaLiveChannelArn",
      media_live_pipeline_id: "PIPELINE_0", # accepts PIPELINE_0, PIPELINE_1
      media_live_channel_output_name: "String",
      source_transit_decryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    failover: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configurations: [ # required
        {
          rist: {
            port: 1, # required
            recovery_latency_milliseconds: 1, # required
          },
          srt_listener: {
            port: 1, # required
            minimum_latency_milliseconds: 1, # required
            decryption_configuration: {
              encryption_key: { # required
                secret_arn: "SecretArn", # required
                role_arn: "RoleArn", # required
              },
            },
          },
          srt_caller: {
            source_address: "String", # required
            source_port: 1, # required
            minimum_latency_milliseconds: 1, # required
            stream_id: "String",
            decryption_configuration: {
              encryption_key: { # required
                secret_arn: "SecretArn", # required
                role_arn: "RoleArn", # required
              },
            },
          },
          rtp: {
            port: 1, # required
            forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
      ],
      source_priority_mode: "NO_PRIORITY", # required, accepts NO_PRIORITY, PRIMARY_SECONDARY
      primary_source_index: 1,
    },
    media_connect_flow: {
      flow_arn: "FlowArn",
      flow_output_arn: "FlowOutputArn",
      source_transit_decryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    merge: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configurations: [ # required
        {
          rtp: {
            port: 1, # required
            forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
          },
          rist: {
            port: 1, # required
            recovery_latency_milliseconds: 1, # required
          },
        },
      ],
      merge_recovery_window_milliseconds: 1, # required
    },
  },
  maximum_bitrate: 1, # required
  routing_scope: "REGIONAL", # required, accepts REGIONAL, GLOBAL
  tier: "INPUT_100", # required, accepts INPUT_100, INPUT_50, INPUT_20
  region_name: "String",
  availability_zone: "String",
  transit_encryption: {
    encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
    encryption_key_configuration: { # required
      secrets_manager: {
        secret_arn: "SecretArn", # required
        role_arn: "RoleArn", # required
      },
      automatic: {
      },
    },
  },
  maintenance_configuration: {
    preferred_day_time: {
      day: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      time: "String", # required
    },
    default: {
    },
  },
  tags: {
    "String" => "String",
  },
  client_token: "ClientToken",
  content_quality_analysis_configuration: {
    content_level: {
      black_frames: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
      frozen_frames: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
      silent_audio: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
    },
  },
})

    
      
        
Response structure

      
      

resp.router_input.name #=> String
resp.router_input.arn #=> String
resp.router_input.id #=> String
resp.router_input.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_input.input_type #=> String, one of "STANDARD", "FAILOVER", "MERGE", "MEDIACONNECT_FLOW", "MEDIALIVE_CHANNEL"
resp.router_input.configuration.standard.network_interface_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rist.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_address #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rtp.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_input.configuration.media_live_channel.media_live_channel_arn #=> String
resp.router_input.configuration.media_live_channel.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_input.configuration.media_live_channel.media_live_channel_output_name #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.failover.network_interface_arn #=> String
resp.router_input.configuration.failover.protocol_configurations #=> Array
resp.router_input.configuration.failover.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_address #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.stream_id #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.failover.source_priority_mode #=> String, one of "NO_PRIORITY", "PRIMARY_SECONDARY"
resp.router_input.configuration.failover.primary_source_index #=> Integer
resp.router_input.configuration.media_connect_flow.flow_arn #=> String
resp.router_input.configuration.media_connect_flow.flow_output_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.merge.network_interface_arn #=> String
resp.router_input.configuration.merge.protocol_configurations #=> Array
resp.router_input.configuration.merge.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.merge.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.merge.merge_recovery_window_milliseconds #=> Integer
resp.router_input.routed_outputs #=> Integer
resp.router_input.maximum_routed_outputs #=> Integer
resp.router_input.region_name #=> String
resp.router_input.availability_zone #=> String
resp.router_input.maximum_bitrate #=> Integer
resp.router_input.tier #=> String, one of "INPUT_100", "INPUT_50", "INPUT_20"
resp.router_input.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_input.created_at #=> Time
resp.router_input.updated_at #=> Time
resp.router_input.messages #=> Array
resp.router_input.messages[0].code #=> String
resp.router_input.messages[0].message #=> String
resp.router_input.transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.tags #=> Hash
resp.router_input.tags["String"] #=> String
resp.router_input.stream_details.standard.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.ip_address #=> String
resp.router_input.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_input.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_input.maintenance_configuration.preferred_day_time.time #=> String
resp.router_input.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_input.maintenance_schedule.window.start #=> Time
resp.router_input.maintenance_schedule.window.end #=> Time
resp.router_input.maintenance_schedule.window.scheduled_time #=> Time
resp.router_input.content_quality_analysis_type #=> String, one of "CONTENT_LEVEL"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.threshold_seconds #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the router input.
    
          
        
    • 
      
        
  • 
          :configuration
          (required, Types::RouterInputConfiguration)
          
            
          
          
            — 
    The configuration settings for the router input, which can include the
protocol, network interface, and other details.
    
          
        
    • 
      
        
  • 
          :maximum_bitrate
          (required, Integer)
          
            
          
          
            — 
    The maximum bitrate for the router input.
    
          
        
    • 
      
        
  • 
          :routing_scope
          (required, String)
          
            
          
          
            — 
    Specifies whether the router input can be assigned to outputs in
different Regions. REGIONAL (default) - connects only to outputs in
same Region. GLOBAL - connects to outputs in any Region.
    
          
        
    • 
      
        
  • 
          :tier
          (required, String)
          
            
          
          
            — 
    The tier level for the router input.
    
          
        
    • 
      
        
  • 
          :region_name
          (String)
          
            
          
          
            — 
    The Amazon Web Services Region for the router input. Defaults to the
current region if not specified.
    
          
        
    • 
      
        
  • 
          :availability_zone
          (String)
          
            
          
          
            — 
    The Availability Zone where you want to create the router input. This
must be a valid Availability Zone for the region specified by
regionName, or the current region if no regionName is provided.
    
          
        
    • 
      
        
  • 
          :transit_encryption
          (Types::RouterInputTransitEncryption)
          
            
          
          
            — 
    The transit encryption settings for the router input.
    
          
        
    • 
      
        
  • 
          :maintenance_configuration
          (Types::MaintenanceConfiguration)
          
            
          
          
            — 
    The maintenance configuration settings for the router input, including
preferred maintenance windows and schedules.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    Key-value pairs that can be used to tag and organize this router
input.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A unique identifier for the request to ensure idempotency.
    

    A suitable default value is auto-generated. You should normally
not need to pass this option.**
    
          
        
    • 
      
        
  • 
          :content_quality_analysis_configuration
          (Types::RouterContentQualityAnalysisConfiguration)
          
            
          
          
            — 
    The content quality analysis configuration for the router input.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


285

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

def create_router_input: (

    		
  





    
      

  

  
    #create_router_network_interface(params = {})  ⇒ Types::CreateRouterNetworkInterfaceResponse 
  

  

  


  

    
Creates a new router network interface in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_router_network_interface({
  name: "CreateRouterNetworkInterfaceRequestNameString", # required
  configuration: { # required
    public: {
      allow_rules: [ # required
        {
          cidr: "PublicRouterNetworkInterfaceRuleCidrString", # required
        },
      ],
    },
    vpc: {
      security_group_ids: ["String"], # required
      subnet_id: "String", # required
    },
  },
  region_name: "String",
  tags: {
    "String" => "String",
  },
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.router_network_interface.name #=> String
resp.router_network_interface.arn #=> String
resp.router_network_interface.id #=> String
resp.router_network_interface.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"
resp.router_network_interface.network_interface_type #=> String, one of "PUBLIC", "VPC"
resp.router_network_interface.configuration.public.allow_rules #=> Array
resp.router_network_interface.configuration.public.allow_rules[0].cidr #=> String
resp.router_network_interface.configuration.vpc.security_group_ids #=> Array
resp.router_network_interface.configuration.vpc.security_group_ids[0] #=> String
resp.router_network_interface.configuration.vpc.subnet_id #=> String
resp.router_network_interface.associated_output_count #=> Integer
resp.router_network_interface.associated_input_count #=> Integer
resp.router_network_interface.region_name #=> String
resp.router_network_interface.created_at #=> Time
resp.router_network_interface.updated_at #=> Time
resp.router_network_interface.tags #=> Hash
resp.router_network_interface.tags["String"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the router network interface.
    
          
        
    • 
      
        
  • 
          :configuration
          (required, Types::RouterNetworkInterfaceConfiguration)
          
            
          
          
            — 
    The configuration settings for the router network interface.
    
          
        
    • 
      
        
  • 
          :region_name
          (String)
          
            
          
          
            — 
    The Amazon Web Services Region for the router network interface.
Defaults to the current region if not specified.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    Key-value pairs that can be used to tag and organize this router
network interface.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A unique identifier for the request to ensure idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


306

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

def create_router_network_interface: (

    		
  





    
      

  

  
    #create_router_output(params = {})  ⇒ Types::CreateRouterOutputResponse 
  

  

  


  

    
Creates a new router output in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_router_output({
  name: "CreateRouterOutputRequestNameString", # required
  configuration: { # required
    standard: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configuration: { # required
        rist: {
          destination_address: "String", # required
          destination_port: 1, # required
        },
        srt_listener: {
          port: 1, # required
          minimum_latency_milliseconds: 1, # required
          encryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        srt_caller: {
          destination_address: "String", # required
          destination_port: 1, # required
          minimum_latency_milliseconds: 1, # required
          stream_id: "String",
          encryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        rtp: {
          destination_address: "String", # required
          destination_port: 1, # required
          forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      protocol: "RTP", # accepts RTP, RIST, SRT_CALLER, SRT_LISTENER
    },
    media_connect_flow: {
      flow_arn: "FlowArn",
      flow_source_arn: "FlowSourceArn",
      destination_transit_encryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    media_live_input: {
      media_live_input_arn: "MediaLiveInputArn",
      media_live_pipeline_id: "PIPELINE_0", # accepts PIPELINE_0, PIPELINE_1
      destination_transit_encryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
  },
  maximum_bitrate: 1, # required
  routing_scope: "REGIONAL", # required, accepts REGIONAL, GLOBAL
  tier: "OUTPUT_100", # required, accepts OUTPUT_100, OUTPUT_50, OUTPUT_20
  region_name: "String",
  availability_zone: "String",
  maintenance_configuration: {
    preferred_day_time: {
      day: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      time: "String", # required
    },
    default: {
    },
  },
  tags: {
    "String" => "String",
  },
  fabric_configuration: {
    recovery_latency_mode: "BALANCED", # required, accepts BALANCED, LOW_LATENCY
  },
  client_token: "ClientToken",
})

    
      
        
Response structure

      
      

resp.router_output.name #=> String
resp.router_output.arn #=> String
resp.router_output.id #=> String
resp.router_output.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_output.output_type #=> String, one of "STANDARD", "MEDIACONNECT_FLOW", "MEDIALIVE_INPUT"
resp.router_output.configuration.standard.network_interface_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_output.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_output.configuration.media_connect_flow.flow_arn #=> String
resp.router_output.configuration.media_connect_flow.flow_source_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.configuration.media_live_input.media_live_input_arn #=> String
resp.router_output.configuration.media_live_input.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_output.region_name #=> String
resp.router_output.availability_zone #=> String
resp.router_output.maximum_bitrate #=> Integer
resp.router_output.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_output.tier #=> String, one of "OUTPUT_100", "OUTPUT_50", "OUTPUT_20"
resp.router_output.created_at #=> Time
resp.router_output.updated_at #=> Time
resp.router_output.messages #=> Array
resp.router_output.messages[0].code #=> String
resp.router_output.messages[0].message #=> String
resp.router_output.tags #=> Hash
resp.router_output.tags["String"] #=> String
resp.router_output.stream_details.standard.destination_ip_address #=> String
resp.router_output.ip_address #=> String
resp.router_output.routed_input_arn #=> String
resp.router_output.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_output.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_output.maintenance_configuration.preferred_day_time.time #=> String
resp.router_output.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_output.maintenance_schedule.window.start #=> Time
resp.router_output.maintenance_schedule.window.end #=> Time
resp.router_output.maintenance_schedule.window.scheduled_time #=> Time
resp.router_output.fabric_configuration.recovery_latency_mode #=> String, one of "BALANCED", "LOW_LATENCY"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the router output.
    
          
        
    • 
      
        
  • 
          :configuration
          (required, Types::RouterOutputConfiguration)
          
            
          
          
            — 
    The configuration settings for the router output.
    
          
        
    • 
      
        
  • 
          :maximum_bitrate
          (required, Integer)
          
            
          
          
            — 
    The maximum bitrate for the router output.
    
          
        
    • 
      
        
  • 
          :routing_scope
          (required, String)
          
            
          
          
            — 
    Specifies whether the router output can take inputs that are in
different Regions. REGIONAL (default) - can only take inputs from same
Region. GLOBAL - can take inputs from any Region.
    
          
        
    • 
      
        
  • 
          :tier
          (required, String)
          
            
          
          
            — 
    The tier level for the router output.
    
          
        
    • 
      
        
  • 
          :region_name
          (String)
          
            
          
          
            — 
    The Amazon Web Services Region for the router output. Defaults to the
current region if not specified.
    
          
        
    • 
      
        
  • 
          :availability_zone
          (String)
          
            
          
          
            — 
    The Availability Zone where you want to create the router output. This
must be a valid Availability Zone for the region specified by
regionName, or the current region if no regionName is provided.
    
          
        
    • 
      
        
  • 
          :maintenance_configuration
          (Types::MaintenanceConfiguration)
          
            
          
          
            — 
    The maintenance configuration settings for the router output,
including preferred maintenance windows and schedules.
    
          
        
    • 
      
        
  • 
          :tags
          (Hash<String,String>)
          
            
          
          
            — 
    Key-value pairs that can be used to tag this router output.
    
          
        
    • 
      
        
  • 
          :fabric_configuration
          (Types::FabricConfiguration)
          
            
          
          
            — 
    The fabric configuration settings for the router output.
    
          
        
    • 
      
        
  • 
          :client_token
          (String)
          
            
          
          
            — 
    A unique identifier for the request to ensure idempotency.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


320

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

def create_router_output: (

    		
  





    
      

  

  
    #delete_bridge(params = {})  ⇒ Types::DeleteBridgeResponse 
  

  

  


  

    
Deletes a bridge. Before you can delete a bridge, you must stop the
bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_bridge({
  bridge_arn: "DeleteBridgeRequestBridgeArnString", # required
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


342

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

def delete_bridge: (

    		
  





    
      

  

  
    #delete_flow(params = {})  ⇒ Types::DeleteFlowResponse 
  

  

  


  

    
Deletes a flow. Before you can delete a flow, you must stop the flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_flow({
  flow_arn: "DeleteFlowRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


353

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

def delete_flow: (

    		
  





    
      

  

  
    #delete_gateway(params = {})  ⇒ Types::DeleteGatewayResponse 
  

  

  


  

    
Deletes a gateway. Before you can delete a gateway, you must
deregister its instances and delete its bridges.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_gateway({
  gateway_arn: "DeleteGatewayRequestGatewayArnString", # required
})

    
      
        
Response structure

      
      

resp.gateway_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :gateway_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the gateway that you want to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


363

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

def delete_gateway: (

    		
  





    
      

  

  
    #delete_router_input(params = {})  ⇒ Types::DeleteRouterInputResponse 
  

  

  


  

    
Deletes a router input from AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_router_input({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


375

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

def delete_router_input: (

    		
  





    
      

  

  
    #delete_router_network_interface(params = {})  ⇒ Types::DeleteRouterNetworkInterfaceResponse 
  

  

  


  

    
Deletes a router network interface from AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_router_network_interface({
  arn: "RouterNetworkInterfaceArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router network interface that
you want to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


387

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

def delete_router_network_interface: (

    		
  





    
      

  

  
    #delete_router_output(params = {})  ⇒ Types::DeleteRouterOutputResponse 
  

  

  


  

    
Deletes a router output from AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_router_output({
  arn: "RouterOutputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


399

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

def delete_router_output: (

    		
  





    
      

  

  
    #deregister_gateway_instance(params = {})  ⇒ Types::DeregisterGatewayInstanceResponse 
  

  

  


  

    
Deregisters an instance. Before you deregister an instance, all
bridges running on the instance must be stopped. If you want to
deregister an instance without stopping the bridges, you must use the
--force option.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.deregister_gateway_instance({
  force: false,
  gateway_instance_arn: "DeregisterGatewayInstanceRequestGatewayInstanceArnString", # required
})

    
      
        
Response structure

      
      

resp.gateway_instance_arn #=> String
resp.instance_state #=> String, one of "REGISTERING", "ACTIVE", "DEREGISTERING", "DEREGISTERED", "REGISTRATION_ERROR", "DEREGISTRATION_ERROR"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :force
          (Boolean)
          
            
          
          
            — 
    Force the deregistration of an instance. Force will deregister an
instance, even if there are bridges running on it.
    
          
        
    • 
      
        
  • 
          :gateway_instance_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the gateway that contains the
instance that you want to deregister.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


410

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

def deregister_gateway_instance: (

    		
  





    
      

  

  
    #describe_bridge(params = {})  ⇒ Types::DescribeBridgeResponse 
  

  

  


  

    
Displays the details of a bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_bridge({
  bridge_arn: "DescribeBridgeRequestBridgeArnString", # required
})

    
      
        
Response structure

      
      

resp.bridge.bridge_arn #=> String
resp.bridge.bridge_messages #=> Array
resp.bridge.bridge_messages[0].code #=> String
resp.bridge.bridge_messages[0].message #=> String
resp.bridge.bridge_messages[0].resource_name #=> String
resp.bridge.bridge_state #=> String, one of "CREATING", "STANDBY", "STARTING", "DEPLOYING", "ACTIVE", "STOPPING", "DELETING", "DELETED", "START_FAILED", "START_PENDING", "STOP_FAILED", "UPDATING"
resp.bridge.egress_gateway_bridge.instance_id #=> String
resp.bridge.egress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.instance_id #=> String
resp.bridge.ingress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.max_outputs #=> Integer
resp.bridge.name #=> String
resp.bridge.outputs #=> Array
resp.bridge.outputs[0].flow_output.flow_arn #=> String
resp.bridge.outputs[0].flow_output.flow_source_arn #=> String
resp.bridge.outputs[0].flow_output.name #=> String
resp.bridge.outputs[0].network_output.ip_address #=> String
resp.bridge.outputs[0].network_output.name #=> String
resp.bridge.outputs[0].network_output.network_name #=> String
resp.bridge.outputs[0].network_output.port #=> Integer
resp.bridge.outputs[0].network_output.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.bridge.outputs[0].network_output.ttl #=> Integer
resp.bridge.placement_arn #=> String
resp.bridge.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.bridge.source_failover_config.recovery_window #=> Integer
resp.bridge.source_failover_config.source_priority.primary_source #=> String
resp.bridge.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.bridge.sources #=> Array
resp.bridge.sources[0].flow_source.flow_arn #=> String
resp.bridge.sources[0].flow_source.flow_vpc_interface_attachment.vpc_interface_name #=> String
resp.bridge.sources[0].flow_source.name #=> String
resp.bridge.sources[0].flow_source.output_arn #=> String
resp.bridge.sources[0].network_source.multicast_ip #=> String
resp.bridge.sources[0].network_source.multicast_source_settings.multicast_source_ip #=> String
resp.bridge.sources[0].network_source.name #=> String
resp.bridge.sources[0].network_source.network_name #=> String
resp.bridge.sources[0].network_source.port #=> Integer
resp.bridge.sources[0].network_source.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to
describe.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


421

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

def describe_bridge: (

    		
  





    
      

  

  
    #describe_flow(params = {})  ⇒ Types::DescribeFlowResponse 
  

  

  


  

    
Displays the details of a flow. The response includes the flow Amazon
Resource Name (ARN), name, and Availability Zone, as well as details
about the source, outputs, and entitlements.


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


* flow_active
* flow_deleted
* flow_standby


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_flow({
  flow_arn: "DescribeFlowRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.flow.availability_zone #=> String
resp.flow.description #=> String
resp.flow.egress_ip #=> String
resp.flow.entitlements #=> Array
resp.flow.entitlements[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.entitlements[0].description #=> String
resp.flow.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.entitlements[0].encryption.constant_initialization_vector #=> String
resp.flow.entitlements[0].encryption.device_id #=> String
resp.flow.entitlements[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.entitlements[0].encryption.region #=> String
resp.flow.entitlements[0].encryption.resource_id #=> String
resp.flow.entitlements[0].encryption.role_arn #=> String
resp.flow.entitlements[0].encryption.secret_arn #=> String
resp.flow.entitlements[0].encryption.url #=> String
resp.flow.entitlements[0].entitlement_arn #=> String
resp.flow.entitlements[0].entitlement_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.entitlements[0].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> String
resp.flow.media_streams #=> Array
resp.flow.media_streams[0].attributes.fmtp.channel_order #=> String
resp.flow.media_streams[0].attributes.fmtp.colorimetry #=> String, one of "BT601", "BT709", "BT2020", "BT2100", "ST2065-1", "ST2065-3", "XYZ"
resp.flow.media_streams[0].attributes.fmtp.exact_framerate #=> String
resp.flow.media_streams[0].attributes.fmtp.par #=> String
resp.flow.media_streams[0].attributes.fmtp.range #=> String, one of "NARROW", "FULL", "FULLPROTECT"
resp.flow.media_streams[0].attributes.fmtp.scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.flow.media_streams[0].attributes.fmtp.tcs #=> String, one of "SDR", "PQ", "HLG", "LINEAR", "BT2100LINPQ", "BT2100LINHLG", "ST2065-1", "ST428-1", "DENSITY"
resp.flow.media_streams[0].attributes.lang #=> String
resp.flow.media_streams[0].clock_rate #=> Integer
resp.flow.media_streams[0].description #=> String
resp.flow.media_streams[0].fmt #=> Integer
resp.flow.media_streams[0].media_stream_id #=> Integer
resp.flow.media_streams[0].media_stream_name #=> String
resp.flow.media_streams[0].media_stream_type #=> String, one of "video", "audio", "ancillary-data"
resp.flow.media_streams[0].video_format #=> String
resp.flow.name #=> String
resp.flow.outputs #=> Array
resp.flow.outputs[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.outputs[0].description #=> String
resp.flow.outputs[0].destination #=> String
resp.flow.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.outputs[0].encryption.constant_initialization_vector #=> String
resp.flow.outputs[0].encryption.device_id #=> String
resp.flow.outputs[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.outputs[0].encryption.region #=> String
resp.flow.outputs[0].encryption.resource_id #=> String
resp.flow.outputs[0].encryption.role_arn #=> String
resp.flow.outputs[0].encryption.secret_arn #=> String
resp.flow.outputs[0].encryption.url #=> String
resp.flow.outputs[0].entitlement_arn #=> String
resp.flow.outputs[0].listener_address #=> String
resp.flow.outputs[0].media_live_input_arn #=> String
resp.flow.outputs[0].media_stream_output_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_port #=> Integer
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].interface.name #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].outbound_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.compression_factor #=> Float
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.encoder_profile #=> String, one of "main", "high"
resp.flow.outputs[0].media_stream_output_configurations[0].media_stream_name #=> String
resp.flow.outputs[0].name #=> String
resp.flow.outputs[0].output_arn #=> String
resp.flow.outputs[0].port #=> Integer
resp.flow.outputs[0].transport.cidr_allow_list #=> Array
resp.flow.outputs[0].transport.cidr_allow_list[0] #=> String
resp.flow.outputs[0].transport.max_bitrate #=> Integer
resp.flow.outputs[0].transport.max_latency #=> Integer
resp.flow.outputs[0].transport.max_sync_buffer #=> Integer
resp.flow.outputs[0].transport.min_latency #=> Integer
resp.flow.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.sender_control_port #=> Integer
resp.flow.outputs[0].transport.sender_ip_address #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.source_listener_address #=> String
resp.flow.outputs[0].transport.source_listener_port #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.outputs[0].transport.ndi_program_name #=> String
resp.flow.outputs[0].transport.ndi_source_settings.source_name #=> String
resp.flow.outputs[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.outputs[0].bridge_arn #=> String
resp.flow.outputs[0].bridge_ports #=> Array
resp.flow.outputs[0].bridge_ports[0] #=> Integer
resp.flow.outputs[0].output_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].peer_ip_address #=> String
resp.flow.outputs[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.outputs[0].connected_router_input_arn #=> String
resp.flow.source.data_transfer_subscriber_fee_percent #=> Integer
resp.flow.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.source.decryption.constant_initialization_vector #=> String
resp.flow.source.decryption.device_id #=> String
resp.flow.source.decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.source.decryption.region #=> String
resp.flow.source.decryption.resource_id #=> String
resp.flow.source.decryption.role_arn #=> String
resp.flow.source.decryption.secret_arn #=> String
resp.flow.source.decryption.url #=> String
resp.flow.source.description #=> String
resp.flow.source.entitlement_arn #=> String
resp.flow.source.ingest_ip #=> String
resp.flow.source.ingest_port #=> Integer
resp.flow.source.media_stream_source_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.source.media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.source.media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.source.name #=> String
resp.flow.source.sender_control_port #=> Integer
resp.flow.source.sender_ip_address #=> String
resp.flow.source.source_arn #=> String
resp.flow.source.transport.cidr_allow_list #=> Array
resp.flow.source.transport.cidr_allow_list[0] #=> String
resp.flow.source.transport.max_bitrate #=> Integer
resp.flow.source.transport.max_latency #=> Integer
resp.flow.source.transport.max_sync_buffer #=> Integer
resp.flow.source.transport.min_latency #=> Integer
resp.flow.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.sender_control_port #=> Integer
resp.flow.source.transport.sender_ip_address #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.source_listener_address #=> String
resp.flow.source.transport.source_listener_port #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.transport.ndi_speed_hq_quality #=> Integer
resp.flow.source.transport.ndi_program_name #=> String
resp.flow.source.transport.ndi_source_settings.source_name #=> String
resp.flow.source.transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source.gateway_bridge_source.bridge_arn #=> String
resp.flow.source.gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.source.peer_ip_address #=> String
resp.flow.source.router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source.router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.source.connected_router_output_arn #=> String
resp.flow.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.flow.source_failover_config.recovery_window #=> Integer
resp.flow.source_failover_config.source_priority.primary_source #=> String
resp.flow.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources #=> Array
resp.flow.sources[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.sources[0].decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.sources[0].decryption.constant_initialization_vector #=> String
resp.flow.sources[0].decryption.device_id #=> String
resp.flow.sources[0].decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.sources[0].decryption.region #=> String
resp.flow.sources[0].decryption.resource_id #=> String
resp.flow.sources[0].decryption.role_arn #=> String
resp.flow.sources[0].decryption.secret_arn #=> String
resp.flow.sources[0].decryption.url #=> String
resp.flow.sources[0].description #=> String
resp.flow.sources[0].entitlement_arn #=> String
resp.flow.sources[0].ingest_ip #=> String
resp.flow.sources[0].ingest_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.sources[0].media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.sources[0].name #=> String
resp.flow.sources[0].sender_control_port #=> Integer
resp.flow.sources[0].sender_ip_address #=> String
resp.flow.sources[0].source_arn #=> String
resp.flow.sources[0].transport.cidr_allow_list #=> Array
resp.flow.sources[0].transport.cidr_allow_list[0] #=> String
resp.flow.sources[0].transport.max_bitrate #=> Integer
resp.flow.sources[0].transport.max_latency #=> Integer
resp.flow.sources[0].transport.max_sync_buffer #=> Integer
resp.flow.sources[0].transport.min_latency #=> Integer
resp.flow.sources[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.sender_control_port #=> Integer
resp.flow.sources[0].transport.sender_ip_address #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.source_listener_address #=> String
resp.flow.sources[0].transport.source_listener_port #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.sources[0].transport.ndi_program_name #=> String
resp.flow.sources[0].transport.ndi_source_settings.source_name #=> String
resp.flow.sources[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> String
resp.flow.sources[0].gateway_bridge_source.bridge_arn #=> String
resp.flow.sources[0].gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.sources[0].peer_ip_address #=> String
resp.flow.sources[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.sources[0].connected_router_output_arn #=> String
resp.flow.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
resp.flow.vpc_interfaces #=> Array
resp.flow.vpc_interfaces[0].name #=> String
resp.flow.vpc_interfaces[0].network_interface_ids #=> Array
resp.flow.vpc_interfaces[0].network_interface_ids[0] #=> String
resp.flow.vpc_interfaces[0].network_interface_type #=> String, one of "ena", "efa"
resp.flow.vpc_interfaces[0].role_arn #=> String
resp.flow.vpc_interfaces[0].security_group_ids #=> Array
resp.flow.vpc_interfaces[0].security_group_ids[0] #=> String
resp.flow.vpc_interfaces[0].subnet_id #=> String
resp.flow.maintenance.maintenance_day #=> String, one of "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"
resp.flow.maintenance.maintenance_deadline #=> String
resp.flow.maintenance.maintenance_scheduled_date #=> String
resp.flow.maintenance.maintenance_start_hour #=> String
resp.flow.source_monitoring_config.thumbnail_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings #=> Array
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.content_quality_analysis_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings #=> Array
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.threshold_seconds #=> Integer
resp.flow.flow_size #=> String, one of "MEDIUM", "LARGE", "LARGE_4X"
resp.flow.ndi_config.ndi_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.ndi_config.machine_name #=> String
resp.flow.ndi_config.ndi_discovery_servers #=> Array
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_address #=> String
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_port #=> Integer
resp.flow.ndi_config.ndi_discovery_servers[0].vpc_interface_adapter #=> String
resp.flow.encoding_config.encoding_profile #=> String, one of "DISTRIBUTION_H264_DEFAULT", "CONTRIBUTION_H264_DEFAULT"
resp.flow.encoding_config.video_max_bitrate #=> Integer
resp.messages.errors #=> Array
resp.messages.errors[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the flow that you want to describe.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


432

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

def describe_flow: (

    		
  





    
      

  

  
    #describe_flow_source_metadata(params = {})  ⇒ Types::DescribeFlowSourceMetadataResponse 
  

  

  


  

    
The DescribeFlowSourceMetadata API is used to view information about
the flow's source transport stream and programs. This API displays
status messages about the flow's source as well as details about the
program's video, audio, and other data.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_flow_source_metadata({
  flow_arn: "FlowArn", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.messages #=> Array
resp.messages[0].code #=> String
resp.messages[0].message #=> String
resp.messages[0].resource_name #=> String
resp.timestamp #=> Time
resp.transport_media_info.programs #=> Array
resp.transport_media_info.programs[0].pcr_pid #=> Integer
resp.transport_media_info.programs[0].program_name #=> String
resp.transport_media_info.programs[0].program_number #=> Integer
resp.transport_media_info.programs[0].program_pid #=> Integer
resp.transport_media_info.programs[0].streams #=> Array
resp.transport_media_info.programs[0].streams[0].channels #=> Integer
resp.transport_media_info.programs[0].streams[0].codec #=> String
resp.transport_media_info.programs[0].streams[0].frame_rate #=> String
resp.transport_media_info.programs[0].streams[0].frame_resolution.frame_height #=> Integer
resp.transport_media_info.programs[0].streams[0].frame_resolution.frame_width #=> Integer
resp.transport_media_info.programs[0].streams[0].pid #=> Integer
resp.transport_media_info.programs[0].streams[0].sample_rate #=> Integer
resp.transport_media_info.programs[0].streams[0].sample_size #=> Integer
resp.transport_media_info.programs[0].streams[0].stream_type #=> String
resp.ndi_info.active_source.source_name #=> String
resp.ndi_info.discovered_sources #=> Array
resp.ndi_info.discovered_sources[0].source_name #=> String
resp.ndi_info.media_info.streams #=> Array
resp.ndi_info.media_info.streams[0].stream_type #=> String
resp.ndi_info.media_info.streams[0].codec #=> String
resp.ndi_info.media_info.streams[0].stream_id #=> Integer
resp.ndi_info.media_info.streams[0].scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.ndi_info.media_info.streams[0].frame_resolution.frame_height #=> Integer
resp.ndi_info.media_info.streams[0].frame_resolution.frame_width #=> Integer
resp.ndi_info.media_info.streams[0].frame_rate #=> String
resp.ndi_info.media_info.streams[0].channels #=> Integer
resp.ndi_info.media_info.streams[0].sample_rate #=> Integer
resp.ndi_info.messages #=> Array
resp.ndi_info.messages[0].code #=> String
resp.ndi_info.messages[0].message #=> String
resp.ndi_info.messages[0].resource_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


446

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

def describe_flow_source_metadata: (

    		
  





    
      

  

  
    #describe_flow_source_thumbnail(params = {})  ⇒ Types::DescribeFlowSourceThumbnailResponse 
  

  

  


  

    
Describes the thumbnail for the flow source.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_flow_source_thumbnail({
  flow_arn: "FlowArn", # required
})

    
      
        
Response structure

      
      

resp.thumbnail_details.flow_arn #=> String
resp.thumbnail_details.thumbnail #=> String
resp.thumbnail_details.thumbnail_messages #=> Array
resp.thumbnail_details.thumbnail_messages[0].code #=> String
resp.thumbnail_details.thumbnail_messages[0].message #=> String
resp.thumbnail_details.thumbnail_messages[0].resource_name #=> String
resp.thumbnail_details.timecode #=> String
resp.thumbnail_details.timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


456

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

def describe_flow_source_thumbnail: (

    		
  





    
      

  

  
    #describe_gateway(params = {})  ⇒ Types::DescribeGatewayResponse 
  

  

  


  

    
Displays the details of a gateway. The response includes the gateway
Amazon Resource Name (ARN), name, and CIDR blocks, as well as details
about the networks.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_gateway({
  gateway_arn: "DescribeGatewayRequestGatewayArnString", # required
})

    
      
        
Response structure

      
      

resp.gateway.egress_cidr_blocks #=> Array
resp.gateway.egress_cidr_blocks[0] #=> String
resp.gateway.gateway_arn #=> String
resp.gateway.gateway_messages #=> Array
resp.gateway.gateway_messages[0].code #=> String
resp.gateway.gateway_messages[0].message #=> String
resp.gateway.gateway_messages[0].resource_name #=> String
resp.gateway.gateway_state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "ERROR", "DELETING", "DELETED"
resp.gateway.name #=> String
resp.gateway.networks #=> Array
resp.gateway.networks[0].cidr_block #=> String
resp.gateway.networks[0].name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :gateway_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the gateway that you want to describe.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


466

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

def describe_gateway: (

    		
  





    
      

  

  
    #describe_gateway_instance(params = {})  ⇒ Types::DescribeGatewayInstanceResponse 
  

  

  


  

    
Displays the details of an instance.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_gateway_instance({
  gateway_instance_arn: "DescribeGatewayInstanceRequestGatewayInstanceArnString", # required
})

    
      
        
Response structure

      
      

resp.gateway_instance.bridge_placement #=> String, one of "AVAILABLE", "LOCKED"
resp.gateway_instance.connection_status #=> String, one of "CONNECTED", "DISCONNECTED"
resp.gateway_instance.gateway_arn #=> String
resp.gateway_instance.gateway_instance_arn #=> String
resp.gateway_instance.instance_id #=> String
resp.gateway_instance.instance_messages #=> Array
resp.gateway_instance.instance_messages[0].code #=> String
resp.gateway_instance.instance_messages[0].message #=> String
resp.gateway_instance.instance_messages[0].resource_name #=> String
resp.gateway_instance.instance_state #=> String, one of "REGISTERING", "ACTIVE", "DEREGISTERING", "DEREGISTERED", "REGISTRATION_ERROR", "DEREGISTRATION_ERROR"
resp.gateway_instance.running_bridge_count #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :gateway_instance_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the gateway instance that you want
to describe.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


476

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

def describe_gateway_instance: (

    		
  





    
      

  

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

  

  


  

    
Displays the details of an offering. The response includes the
offering description, duration, outbound bandwidth, price, and Amazon
Resource Name (ARN).


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_offering({
  offering_arn: "OfferingArn", # required
})

    
      
        
Response structure

      
      

resp.offering.currency_code #=> String
resp.offering.duration #=> Integer
resp.offering.duration_units #=> String, one of "MONTHS"
resp.offering.offering_arn #=> String
resp.offering.offering_description #=> String
resp.offering.price_per_unit #=> String
resp.offering.price_units #=> String, one of "HOURLY"
resp.offering.resource_specification.reserved_bitrate #=> Integer
resp.offering.resource_specification.resource_type #=> String, one of "Mbps_Outbound_Bandwidth"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :offering_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the offering.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


486

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

def describe_offering: (

    		
  





    
      

  

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

  

  


  

    
Displays the details of a reservation. The response includes the
reservation name, state, start date and time, and the details of the
offering that make up the rest of the reservation (such as price,
duration, and outbound bandwidth).


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_reservation({
  reservation_arn: "ReservationArn", # required
})

    
      
        
Response structure

      
      

resp.reservation.currency_code #=> String
resp.reservation.duration #=> Integer
resp.reservation.duration_units #=> String, one of "MONTHS"
resp.reservation.end #=> String
resp.reservation.offering_arn #=> String
resp.reservation.offering_description #=> String
resp.reservation.price_per_unit #=> String
resp.reservation.price_units #=> String, one of "HOURLY"
resp.reservation.reservation_arn #=> String
resp.reservation.reservation_name #=> String
resp.reservation.reservation_state #=> String, one of "ACTIVE", "EXPIRED", "PROCESSING", "CANCELED"
resp.reservation.resource_specification.reserved_bitrate #=> Integer
resp.reservation.resource_specification.resource_type #=> String, one of "Mbps_Outbound_Bandwidth"
resp.reservation.start #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :reservation_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the offering.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


496

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

def describe_reservation: (

    		
  





    
      

  

  
    #get_router_input(params = {})  ⇒ Types::GetRouterInputResponse 
  

  

  


  

    
Retrieves information about a specific router input in AWS Elemental
MediaConnect.


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


* input_active
* input_deleted
* input_standby


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_router_input({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.router_input.name #=> String
resp.router_input.arn #=> String
resp.router_input.id #=> String
resp.router_input.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_input.input_type #=> String, one of "STANDARD", "FAILOVER", "MERGE", "MEDIACONNECT_FLOW", "MEDIALIVE_CHANNEL"
resp.router_input.configuration.standard.network_interface_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rist.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_address #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rtp.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_input.configuration.media_live_channel.media_live_channel_arn #=> String
resp.router_input.configuration.media_live_channel.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_input.configuration.media_live_channel.media_live_channel_output_name #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.failover.network_interface_arn #=> String
resp.router_input.configuration.failover.protocol_configurations #=> Array
resp.router_input.configuration.failover.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_address #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.stream_id #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.failover.source_priority_mode #=> String, one of "NO_PRIORITY", "PRIMARY_SECONDARY"
resp.router_input.configuration.failover.primary_source_index #=> Integer
resp.router_input.configuration.media_connect_flow.flow_arn #=> String
resp.router_input.configuration.media_connect_flow.flow_output_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.merge.network_interface_arn #=> String
resp.router_input.configuration.merge.protocol_configurations #=> Array
resp.router_input.configuration.merge.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.merge.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.merge.merge_recovery_window_milliseconds #=> Integer
resp.router_input.routed_outputs #=> Integer
resp.router_input.maximum_routed_outputs #=> Integer
resp.router_input.region_name #=> String
resp.router_input.availability_zone #=> String
resp.router_input.maximum_bitrate #=> Integer
resp.router_input.tier #=> String, one of "INPUT_100", "INPUT_50", "INPUT_20"
resp.router_input.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_input.created_at #=> Time
resp.router_input.updated_at #=> Time
resp.router_input.messages #=> Array
resp.router_input.messages[0].code #=> String
resp.router_input.messages[0].message #=> String
resp.router_input.transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.tags #=> Hash
resp.router_input.tags["String"] #=> String
resp.router_input.stream_details.standard.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.ip_address #=> String
resp.router_input.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_input.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_input.maintenance_configuration.preferred_day_time.time #=> String
resp.router_input.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_input.maintenance_schedule.window.start #=> Time
resp.router_input.maintenance_schedule.window.end #=> Time
resp.router_input.maintenance_schedule.window.scheduled_time #=> Time
resp.router_input.content_quality_analysis_type #=> String, one of "CONTENT_LEVEL"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.threshold_seconds #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input to retrieve
information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


506

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

def get_router_input: (

    		
  





    
      

  

  
    #get_router_input_source_metadata(params = {})  ⇒ Types::GetRouterInputSourceMetadataResponse 
  

  

  


  

    
Retrieves detailed metadata information about a specific router input
source, including stream details and connection state.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_router_input_source_metadata({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.source_metadata_details.source_metadata_messages #=> Array
resp.source_metadata_details.source_metadata_messages[0].code #=> String
resp.source_metadata_details.source_metadata_messages[0].message #=> String
resp.source_metadata_details.timestamp #=> Time
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs #=> Array
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].pcr_pid #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].program_name #=> String
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].program_number #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].program_pid #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams #=> Array
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].channels #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].codec #=> String
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].frame_rate #=> String
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].frame_resolution.frame_height #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].frame_resolution.frame_width #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].pid #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].sample_rate #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].sample_size #=> Integer
resp.source_metadata_details.router_input_metadata.transport_stream_media_info.programs[0].streams[0].stream_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input to retrieve
metadata for.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


518

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

def get_router_input_source_metadata: (

    		
  





    
      

  

  
    #get_router_input_thumbnail(params = {})  ⇒ Types::GetRouterInputThumbnailResponse 
  

  

  


  

    
Retrieves the thumbnail for a router input in AWS Elemental
MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_router_input_thumbnail({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.thumbnail_details.thumbnail_messages #=> Array
resp.thumbnail_details.thumbnail_messages[0].code #=> String
resp.thumbnail_details.thumbnail_messages[0].message #=> String
resp.thumbnail_details.thumbnail #=> String
resp.thumbnail_details.timecode #=> String
resp.thumbnail_details.timestamp #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
see a thumbnail of.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


530

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

def get_router_input_thumbnail: (

    		
  





    
      

  

  
    #get_router_network_interface(params = {})  ⇒ Types::GetRouterNetworkInterfaceResponse 
  

  

  


  

    
Retrieves information about a specific router network interface in AWS
Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_router_network_interface({
  arn: "RouterNetworkInterfaceArn", # required
})

    
      
        
Response structure

      
      

resp.router_network_interface.name #=> String
resp.router_network_interface.arn #=> String
resp.router_network_interface.id #=> String
resp.router_network_interface.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"
resp.router_network_interface.network_interface_type #=> String, one of "PUBLIC", "VPC"
resp.router_network_interface.configuration.public.allow_rules #=> Array
resp.router_network_interface.configuration.public.allow_rules[0].cidr #=> String
resp.router_network_interface.configuration.vpc.security_group_ids #=> Array
resp.router_network_interface.configuration.vpc.security_group_ids[0] #=> String
resp.router_network_interface.configuration.vpc.subnet_id #=> String
resp.router_network_interface.associated_output_count #=> Integer
resp.router_network_interface.associated_input_count #=> Integer
resp.router_network_interface.region_name #=> String
resp.router_network_interface.created_at #=> Time
resp.router_network_interface.updated_at #=> Time
resp.router_network_interface.tags #=> Hash
resp.router_network_interface.tags["String"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router network interface that
you want to retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


540

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

def get_router_network_interface: (

    		
  





    
      

  

  
    #get_router_output(params = {})  ⇒ Types::GetRouterOutputResponse 
  

  

  


  

    
Retrieves information about a specific router output in AWS Elemental
MediaConnect.


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


* output_active
* output_deleted
* output_routed
* output_standby
* output_unrouted


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_router_output({
  arn: "RouterOutputArn", # required
})

    
      
        
Response structure

      
      

resp.router_output.name #=> String
resp.router_output.arn #=> String
resp.router_output.id #=> String
resp.router_output.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_output.output_type #=> String, one of "STANDARD", "MEDIACONNECT_FLOW", "MEDIALIVE_INPUT"
resp.router_output.configuration.standard.network_interface_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_output.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_output.configuration.media_connect_flow.flow_arn #=> String
resp.router_output.configuration.media_connect_flow.flow_source_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.configuration.media_live_input.media_live_input_arn #=> String
resp.router_output.configuration.media_live_input.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_output.region_name #=> String
resp.router_output.availability_zone #=> String
resp.router_output.maximum_bitrate #=> Integer
resp.router_output.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_output.tier #=> String, one of "OUTPUT_100", "OUTPUT_50", "OUTPUT_20"
resp.router_output.created_at #=> Time
resp.router_output.updated_at #=> Time
resp.router_output.messages #=> Array
resp.router_output.messages[0].code #=> String
resp.router_output.messages[0].message #=> String
resp.router_output.tags #=> Hash
resp.router_output.tags["String"] #=> String
resp.router_output.stream_details.standard.destination_ip_address #=> String
resp.router_output.ip_address #=> String
resp.router_output.routed_input_arn #=> String
resp.router_output.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_output.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_output.maintenance_configuration.preferred_day_time.time #=> String
resp.router_output.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_output.maintenance_schedule.window.start #=> Time
resp.router_output.maintenance_schedule.window.end #=> Time
resp.router_output.maintenance_schedule.window.scheduled_time #=> Time
resp.router_output.fabric_configuration.recovery_latency_mode #=> String, one of "BALANCED", "LOW_LATENCY"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


550

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

def get_router_output: (

    		
  





    
      

  

  
    #grant_flow_entitlements(params = {})  ⇒ Types::GrantFlowEntitlementsResponse 
  

  

  


  

    
Grants entitlements to an existing flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.grant_flow_entitlements({
  entitlements: [ # required
    {
      data_transfer_subscriber_fee_percent: 1,
      description: "String",
      encryption: {
        algorithm: "aes128", # accepts aes128, aes192, aes256
        constant_initialization_vector: "String",
        device_id: "String",
        key_type: "speke", # accepts speke, static-key, srt-password
        region: "String",
        resource_id: "String",
        role_arn: "String", # required
        secret_arn: "String",
        url: "String",
      },
      entitlement_status: "ENABLED", # accepts ENABLED, DISABLED
      name: "String",
      subscribers: ["String"], # required
      entitlement_tags: {
        "String" => "String",
      },
    },
  ],
  flow_arn: "GrantFlowEntitlementsRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.entitlements #=> Array
resp.entitlements[0].data_transfer_subscriber_fee_percent #=> Integer
resp.entitlements[0].description #=> String
resp.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.entitlements[0].encryption.constant_initialization_vector #=> String
resp.entitlements[0].encryption.device_id #=> String
resp.entitlements[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.entitlements[0].encryption.region #=> String
resp.entitlements[0].encryption.resource_id #=> String
resp.entitlements[0].encryption.role_arn #=> String
resp.entitlements[0].encryption.secret_arn #=> String
resp.entitlements[0].encryption.url #=> String
resp.entitlements[0].entitlement_arn #=> String
resp.entitlements[0].entitlement_status #=> String, one of "ENABLED", "DISABLED"
resp.entitlements[0].name #=> String
resp.entitlements[0].subscribers #=> Array
resp.entitlements[0].subscribers[0] #=> String
resp.flow_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :entitlements
          (required, Array<Types::GrantEntitlementRequest>)
          
            
          
          
            — 
    The list of entitlements that you want to grant.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to grant
entitlements on.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


561

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

def grant_flow_entitlements: (

    		
  





    
      

  

  
    #list_bridges(params = {})  ⇒ Types::ListBridgesResponse 
  

  

  


  

    
Displays a list of bridges that are associated with this account and
an optionally specified Amazon Resource Name (ARN). This request
returns a paginated result.


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_bridges({
  filter_arn: "String",
  max_results: 1,
  next_token: "String",
})

    
      
        
Response structure

      
      

resp.bridges #=> Array
resp.bridges[0].bridge_arn #=> String
resp.bridges[0].bridge_state #=> String, one of "CREATING", "STANDBY", "STARTING", "DEPLOYING", "ACTIVE", "STOPPING", "DELETING", "DELETED", "START_FAILED", "START_PENDING", "STOP_FAILED", "UPDATING"
resp.bridges[0].bridge_type #=> String
resp.bridges[0].name #=> String
resp.bridges[0].placement_arn #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filter_arn
          (String)
          
            
          
          
            — 
    Filter the list results to display only the bridges associated with
the selected ARN.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListBridges request with MaxResults set
at 5. Although 20 items match your request, the service returns no
more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListBridges request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit
the ListBridges request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


575

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

def list_bridges: (

    		
  





    
      

  

  
    #list_entitlements(params = {})  ⇒ Types::ListEntitlementsResponse 
  

  

  


  

    
Displays a list of all entitlements that have been granted to this
account. This request returns 20 results per page.


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

    
      
        
Response structure

      
      

resp.entitlements #=> Array
resp.entitlements[0].data_transfer_subscriber_fee_percent #=> Integer
resp.entitlements[0].entitlement_arn #=> String
resp.entitlements[0].entitlement_name #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListEntitlements request with set at 5.
Although 20 items match your request, the service returns no more than
the first 5 items. (The service also returns a NextToken value that
you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 20 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListEntitlements request with MaxResults
set at 5. The service returns the first batch of results (up to 5) and
a NextToken value. To see the next batch of results, you can submit
the ListEntitlements request a second time and specify the
NextToken value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


588

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

def list_entitlements: (

    		
  





    
      

  

  
    #list_flows(params = {})  ⇒ Types::ListFlowsResponse 
  

  

  


  

    
Displays a list of flows that are associated with this account. This
request returns a paginated result.


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

    
      
        
Response structure

      
      

resp.flows #=> Array
resp.flows[0].availability_zone #=> String
resp.flows[0].description #=> String
resp.flows[0].flow_arn #=> String
resp.flows[0].name #=> String
resp.flows[0].source_type #=> String, one of "OWNED", "ENTITLED"
resp.flows[0].status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
resp.flows[0].maintenance.maintenance_day #=> String, one of "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"
resp.flows[0].maintenance.maintenance_deadline #=> String
resp.flows[0].maintenance.maintenance_scheduled_date #=> String
resp.flows[0].maintenance.maintenance_start_hour #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListFlows request with MaxResults set at
5. Although 20 items match your request, the service returns no more
than the first 5 items. (The service also returns a NextToken value
that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListFlows request with MaxResults set at
5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit
the ListFlows request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


600

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

def list_flows: (

    		
  





    
      

  

  
    #list_gateway_instances(params = {})  ⇒ Types::ListGatewayInstancesResponse 
  

  

  


  

    
Displays a list of instances associated with the Amazon Web Services
account. This request returns a paginated result. You can use the
filterArn property to display only the instances associated with the
selected Gateway Amazon Resource Name (ARN).


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_gateway_instances({
  filter_arn: "String",
  max_results: 1,
  next_token: "String",
})

    
      
        
Response structure

      
      

resp.instances #=> Array
resp.instances[0].gateway_arn #=> String
resp.instances[0].gateway_instance_arn #=> String
resp.instances[0].instance_id #=> String
resp.instances[0].instance_state #=> String, one of "REGISTERING", "ACTIVE", "DEREGISTERING", "DEREGISTERED", "REGISTRATION_ERROR", "DEREGISTRATION_ERROR"
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filter_arn
          (String)
          
            
          
          
            — 
    Filter the list results to display only the instances associated with
the selected Gateway ARN.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListInstances request with MaxResults set
at 5. Although 20 items match your request, the service returns no
more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListInstances request with MaxResults
set at 5. The service returns the first batch of results (up to 5) and
a NextToken value. To see the next batch of results, you can submit
the ListInstances request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


612

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

def list_gateway_instances: (

    		
  





    
      

  

  
    #list_gateways(params = {})  ⇒ Types::ListGatewaysResponse 
  

  

  


  

    
Displays a list of gateways that are associated with this account.
This request returns a paginated result.


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

    
      
        
Response structure

      
      

resp.gateways #=> Array
resp.gateways[0].gateway_arn #=> String
resp.gateways[0].gateway_state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "ERROR", "DELETING", "DELETED"
resp.gateways[0].name #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListGateways request with MaxResults set
at 5. Although 20 items match your request, the service returns no
more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListGateways request with MaxResults set
at 5. The service returns the first batch of results (up to 5) and a
NextToken value. To see the next batch of results, you can submit
the ListGateways request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


625

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

def list_gateways: (

    		
  





    
      

  

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

  

  


  

    
Displays a list of all offerings that are available to this account in
the current Amazon Web Services Region. If you have an active
reservation (which means you've purchased an offering that has
already started and hasn't expired yet), your account isn't eligible
for other offerings.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_offerings({
  max_results: 1,
  next_token: "String",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.offerings #=> Array
resp.offerings[0].currency_code #=> String
resp.offerings[0].duration #=> Integer
resp.offerings[0].duration_units #=> String, one of "MONTHS"
resp.offerings[0].offering_arn #=> String
resp.offerings[0].offering_description #=> String
resp.offerings[0].price_per_unit #=> String
resp.offerings[0].price_units #=> String, one of "HOURLY"
resp.offerings[0].resource_specification.reserved_bitrate #=> Integer
resp.offerings[0].resource_specification.resource_type #=> String, one of "Mbps_Outbound_Bandwidth"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListOfferings request with MaxResults
set at 5. Although 20 items match your request, the service returns no
more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListOfferings request with MaxResults
set at 5. The service returns the first batch of results (up to 5) and
a NextToken value. To see the next batch of results, you can submit
the ListOfferings request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


637

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

def list_offerings: (

    		
  





    
      

  

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

  

  


  

    
Displays a list of all reservations that have been purchased by this
account in the current Amazon Web Services Region. This list includes
all reservations in all states (such as active and expired).


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_reservations({
  max_results: 1,
  next_token: "String",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.reservations #=> Array
resp.reservations[0].currency_code #=> String
resp.reservations[0].duration #=> Integer
resp.reservations[0].duration_units #=> String, one of "MONTHS"
resp.reservations[0].end #=> String
resp.reservations[0].offering_arn #=> String
resp.reservations[0].offering_description #=> String
resp.reservations[0].price_per_unit #=> String
resp.reservations[0].price_units #=> String, one of "HOURLY"
resp.reservations[0].reservation_arn #=> String
resp.reservations[0].reservation_name #=> String
resp.reservations[0].reservation_state #=> String, one of "ACTIVE", "EXPIRED", "PROCESSING", "CANCELED"
resp.reservations[0].resource_specification.reserved_bitrate #=> Integer
resp.reservations[0].resource_specification.resource_type #=> String, one of "Mbps_Outbound_Bandwidth"
resp.reservations[0].start #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of results to return per API request.
    

    For example, you submit a ListReservations request with MaxResults
set at 5. Although 20 items match your request, the service returns no
more than the first 5 items. (The service also returns a NextToken
value that you can use to fetch the next batch of results.)
    

    The service might return fewer results than the MaxResults value. If
MaxResults is not included in the request, the service defaults to
pagination with a maximum of 10 results per page.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token that identifies the batch of results that you want to see.
    

    For example, you submit a ListReservations request with MaxResults
set at 5. The service returns the first batch of results (up to 5) and
a NextToken value. To see the next batch of results, you can submit
the ListOfferings request a second time and specify the NextToken
value.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


649

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

def list_reservations: (

    		
  





    
      

  

  
    #list_router_inputs(params = {})  ⇒ Types::ListRouterInputsResponse 
  

  

  


  

    
Retrieves a list of router inputs in AWS Elemental MediaConnect.


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_router_inputs({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name_contains: ["String"],
      region_names: ["String"],
      network_interface_arns: ["RouterNetworkInterfaceArn"],
      routing_scopes: ["REGIONAL"], # accepts REGIONAL, GLOBAL
      input_types: ["STANDARD"], # accepts STANDARD, FAILOVER, MERGE, MEDIACONNECT_FLOW, MEDIALIVE_CHANNEL
    },
  ],
})

    
      
        
Response structure

      
      

resp.router_inputs #=> Array
resp.router_inputs[0].name #=> String
resp.router_inputs[0].arn #=> String
resp.router_inputs[0].id #=> String
resp.router_inputs[0].input_type #=> String, one of "STANDARD", "FAILOVER", "MERGE", "MEDIACONNECT_FLOW", "MEDIALIVE_CHANNEL"
resp.router_inputs[0].state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_inputs[0].routed_outputs #=> Integer
resp.router_inputs[0].region_name #=> String
resp.router_inputs[0].availability_zone #=> String
resp.router_inputs[0].maximum_bitrate #=> Integer
resp.router_inputs[0].routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_inputs[0].created_at #=> Time
resp.router_inputs[0].updated_at #=> Time
resp.router_inputs[0].message_count #=> Integer
resp.router_inputs[0].network_interface_arn #=> String
resp.router_inputs[0].maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_inputs[0].maintenance_schedule.window.start #=> Time
resp.router_inputs[0].maintenance_schedule.window.end #=> Time
resp.router_inputs[0].maintenance_schedule.window.scheduled_time #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of router inputs to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used to retrieve the next page of results.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RouterInputFilter>)
          
            
          
          
            — 
    The filters to apply when retrieving the list of router inputs.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


661

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

def list_router_inputs: (

    		
  





    
      

  

  
    #list_router_network_interfaces(params = {})  ⇒ Types::ListRouterNetworkInterfacesResponse 
  

  

  


  

    
Retrieves a list of router network interfaces in AWS Elemental
MediaConnect.


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_router_network_interfaces({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      region_names: ["String"],
      network_interface_types: ["PUBLIC"], # accepts PUBLIC, VPC
      name_contains: ["String"],
    },
  ],
})

    
      
        
Response structure

      
      

resp.router_network_interfaces #=> Array
resp.router_network_interfaces[0].name #=> String
resp.router_network_interfaces[0].arn #=> String
resp.router_network_interfaces[0].id #=> String
resp.router_network_interfaces[0].network_interface_type #=> String, one of "PUBLIC", "VPC"
resp.router_network_interfaces[0].associated_output_count #=> Integer
resp.router_network_interfaces[0].associated_input_count #=> Integer
resp.router_network_interfaces[0].state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"
resp.router_network_interfaces[0].region_name #=> String
resp.router_network_interfaces[0].created_at #=> Time
resp.router_network_interfaces[0].updated_at #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of router network interfaces to return in the
response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used to retrieve the next page of results.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RouterNetworkInterfaceFilter>)
          
            
          
          
            — 
    The filters to apply when retrieving the list of router network
interfaces.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


682

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

def list_router_network_interfaces: (

    		
  





    
      

  

  
    #list_router_outputs(params = {})  ⇒ Types::ListRouterOutputsResponse 
  

  

  


  

    
Retrieves a list of router outputs in AWS Elemental MediaConnect.


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_router_outputs({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      region_names: ["String"],
      network_interface_arns: ["RouterNetworkInterfaceArn"],
      routing_scopes: ["REGIONAL"], # accepts REGIONAL, GLOBAL
      output_types: ["STANDARD"], # accepts STANDARD, MEDIACONNECT_FLOW, MEDIALIVE_INPUT
      routed_input_arns: ["RouterInputArn"],
      name_contains: ["String"],
    },
  ],
})

    
      
        
Response structure

      
      

resp.router_outputs #=> Array
resp.router_outputs[0].name #=> String
resp.router_outputs[0].arn #=> String
resp.router_outputs[0].id #=> String
resp.router_outputs[0].output_type #=> String, one of "STANDARD", "MEDIACONNECT_FLOW", "MEDIALIVE_INPUT"
resp.router_outputs[0].state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_outputs[0].routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_outputs[0].region_name #=> String
resp.router_outputs[0].availability_zone #=> String
resp.router_outputs[0].maximum_bitrate #=> Integer
resp.router_outputs[0].routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_outputs[0].created_at #=> Time
resp.router_outputs[0].updated_at #=> Time
resp.router_outputs[0].message_count #=> Integer
resp.router_outputs[0].routed_input_arn #=> String
resp.router_outputs[0].network_interface_arn #=> String
resp.router_outputs[0].maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_outputs[0].maintenance_schedule.window.start #=> Time
resp.router_outputs[0].maintenance_schedule.window.end #=> Time
resp.router_outputs[0].maintenance_schedule.window.scheduled_time #=> Time
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of router outputs to return in the response.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    A token used to retrieve the next page of results.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::RouterOutputFilter>)
          
            
          
          
            — 
    The filters to apply when retrieving the list of router outputs.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


701

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

def list_router_outputs: (

    		
  





    
      

  

  
    #list_tags_for_global_resource(params = {})  ⇒ Types::ListTagsForGlobalResourceResponse 
  

  

  


  

    
Lists the tags associated with a global resource in AWS Elemental
MediaConnect. The API supports the following global resources: router
inputs, router outputs and router network interfaces.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_tags_for_global_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) of the global resource whose tags you
want to list.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


722

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

def list_tags_for_global_resource: (

    		
  





    
      

  

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

  

  


  

    
List all tags on a MediaConnect resource in the current region.


  





  
  

    
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) that identifies the MediaConnect
resource for which to list the tags.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


732

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

def list_tags_for_resource: (

    		
  





    
      

  

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

  

  


  

    
Submits a request to purchase an offering. If you already have an
active reservation, you can't purchase another offering.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.purchase_offering({
  offering_arn: "String", # required
  reservation_name: "String", # required
  start: "String", # required
})

    
      
        
Response structure

      
      

resp.reservation.currency_code #=> String
resp.reservation.duration #=> Integer
resp.reservation.duration_units #=> String, one of "MONTHS"
resp.reservation.end #=> String
resp.reservation.offering_arn #=> String
resp.reservation.offering_description #=> String
resp.reservation.price_per_unit #=> String
resp.reservation.price_units #=> String, one of "HOURLY"
resp.reservation.reservation_arn #=> String
resp.reservation.reservation_name #=> String
resp.reservation.reservation_state #=> String, one of "ACTIVE", "EXPIRED", "PROCESSING", "CANCELED"
resp.reservation.resource_specification.reserved_bitrate #=> Integer
resp.reservation.resource_specification.resource_type #=> String, one of "Mbps_Outbound_Bandwidth"
resp.reservation.start #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :offering_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the offering.
    
          
        
    • 
      
        
  • 
          :reservation_name
          (required, String)
          
            
          
          
            — 
    The name that you want to use for the reservation.
    
          
        
    • 
      
        
  • 
          :start
          (required, String)
          
            
          
          
            — 
    The date and time that you want the reservation to begin, in
Coordinated Universal Time (UTC).
    

    You can specify any date and time between 12:00am on the first day of
the current month to the current time on today's date, inclusive.
Specify the start in a 24-hour notation. Use the following format:
YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For
example, to specify 11:30pm on March 5, 2020, enter
2020-03-05T23:30:00Z.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


742

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

def purchase_offering: (

    		
  





    
      

  

  
    #remove_bridge_output(params = {})  ⇒ Types::RemoveBridgeOutputResponse 
  

  

  


  

    
Removes an output from a bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_bridge_output({
  bridge_arn: "RemoveBridgeOutputRequestBridgeArnString", # required
  output_name: "String", # required
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.output_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :output_name
          (required, String)
          
            
          
          
            — 
    The name of the bridge output that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


755

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

def remove_bridge_output: (

    		
  





    
      

  

  
    #remove_bridge_source(params = {})  ⇒ Types::RemoveBridgeSourceResponse 
  

  

  


  

    
Removes a source from a bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_bridge_source({
  bridge_arn: "RemoveBridgeSourceRequestBridgeArnString", # required
  source_name: "String", # required
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.source_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :source_name
          (required, String)
          
            
          
          
            — 
    The name of the bridge source that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


767

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

def remove_bridge_source: (

    		
  





    
      

  

  
    #remove_flow_media_stream(params = {})  ⇒ Types::RemoveFlowMediaStreamResponse 
  

  

  


  

    
Removes a media stream from a flow. This action is only available if
the media stream is not associated with a source or output.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_flow_media_stream({
  flow_arn: "RemoveFlowMediaStreamRequestFlowArnString", # required
  media_stream_name: "String", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.media_stream_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :media_stream_name
          (required, String)
          
            
          
          
            — 
    The name of the media stream that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


779

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

def remove_flow_media_stream: (

    		
  





    
      

  

  
    #remove_flow_output(params = {})  ⇒ Types::RemoveFlowOutputResponse 
  

  

  


  

    
Removes an output from an existing flow. This request can be made only
on an output that does not have an entitlement associated with it. If
the output has an entitlement, you must revoke the entitlement
instead. When an entitlement is revoked from a flow, the service
automatically removes the associated output.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_flow_output({
  flow_arn: "RemoveFlowOutputRequestFlowArnString", # required
  output_arn: "RemoveFlowOutputRequestOutputArnString", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.output_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to remove an
output from.
    
          
        
    • 
      
        
  • 
          :output_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the output that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


791

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

def remove_flow_output: (

    		
  





    
      

  

  
    #remove_flow_source(params = {})  ⇒ Types::RemoveFlowSourceResponse 
  

  

  


  

    
Removes a source from an existing flow. This request can be made only
if there is more than one source on the flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_flow_source({
  flow_arn: "RemoveFlowSourceRequestFlowArnString", # required
  source_arn: "RemoveFlowSourceRequestSourceArnString", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.source_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to remove a
source from.
    
          
        
    • 
      
        
  • 
          :source_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the source that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


803

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

def remove_flow_source: (

    		
  





    
      

  

  
    #remove_flow_vpc_interface(params = {})  ⇒ Types::RemoveFlowVpcInterfaceResponse 
  

  

  


  

    
Removes a VPC Interface from an existing flow. This request can be
made only on a VPC interface that does not have a Source or Output
associated with it. If the VPC interface is referenced by a Source or
Output, you must first delete or update the Source or Output to no
longer reference the VPC interface.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_flow_vpc_interface({
  flow_arn: "RemoveFlowVpcInterfaceRequestFlowArnString", # required
  vpc_interface_name: "String", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.non_deleted_network_interface_ids #=> Array
resp.non_deleted_network_interface_ids[0] #=> String
resp.vpc_interface_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to remove a
VPC interface from.
    
          
        
    • 
      
        
  • 
          :vpc_interface_name
          (required, String)
          
            
          
          
            — 
    The name of the VPC interface that you want to remove.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


816

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

def remove_flow_vpc_interface: (

    		
  





    
      

  

  
    #restart_router_input(params = {})  ⇒ Types::RestartRouterInputResponse 
  

  

  


  

    
Restarts a router input. This operation can be used to recover from
errors or refresh the input state.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.restart_router_input({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
restart.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


829

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

def restart_router_input: (

    		
  





    
      

  

  
    #restart_router_output(params = {})  ⇒ Types::RestartRouterOutputResponse 
  

  

  


  

    
Restarts a router output. This operation can be used to recover from
errors or refresh the output state.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.restart_router_output({
  arn: "RouterOutputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
restart.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


841

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

def restart_router_output: (

    		
  





    
      

  

  
    #revoke_flow_entitlement(params = {})  ⇒ Types::RevokeFlowEntitlementResponse 
  

  

  


  

    
Revokes an entitlement from a flow. Once an entitlement is revoked,
the content becomes unavailable to the subscriber and the associated
output is removed.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.revoke_flow_entitlement({
  entitlement_arn: "RevokeFlowEntitlementRequestEntitlementArnString", # required
  flow_arn: "RevokeFlowEntitlementRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.entitlement_arn #=> String
resp.flow_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :entitlement_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the entitlement that you want to
revoke.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The flow that you want to revoke an entitlement from.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


852

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

def revoke_flow_entitlement: (

    		
  





    
      

  

  
    #start_flow(params = {})  ⇒ Types::StartFlowResponse 
  

  

  


  

    
Starts a flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_flow({
  flow_arn: "StartFlowRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to start.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


864

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

def start_flow: (

    		
  





    
      

  

  
    #start_router_input(params = {})  ⇒ Types::StartRouterInputResponse 
  

  

  


  

    
Starts a router input in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_router_input({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.maintenance_schedule_type #=> String, one of "WINDOW"
resp.maintenance_schedule.window.start #=> Time
resp.maintenance_schedule.window.end #=> Time
resp.maintenance_schedule.window.scheduled_time #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
start.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


878

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

def start_router_input: (

    		
  





    
      

  

  
    #start_router_output(params = {})  ⇒ Types::StartRouterOutputResponse 
  

  

  


  

    
Starts a router output in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_router_output({
  arn: "RouterOutputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.maintenance_schedule_type #=> String, one of "WINDOW"
resp.maintenance_schedule.window.start #=> Time
resp.maintenance_schedule.window.end #=> Time
resp.maintenance_schedule.window.scheduled_time #=> Time

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
start.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


892

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

def start_router_output: (

    		
  





    
      

  

  
    #stop_flow(params = {})  ⇒ Types::StopFlowResponse 
  

  

  


  

    
Stops a flow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.stop_flow({
  flow_arn: "StopFlowRequestFlowArnString", # required
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to stop.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


903

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

def stop_flow: (

    		
  





    
      

  

  
    #stop_router_input(params = {})  ⇒ Types::StopRouterInputResponse 
  

  

  


  

    
Stops a router input in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.stop_router_input({
  arn: "RouterInputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
stop.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


915

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

def stop_router_input: (

    		
  





    
      

  

  
    #stop_router_output(params = {})  ⇒ Types::StopRouterOutputResponse 
  

  

  


  

    
Stops a router output in AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.stop_router_output({
  arn: "RouterOutputArn", # required
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
stop.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


927

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

def stop_router_output: (

    		
  





    
      

  

  
    #tag_global_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Adds tags to a global resource in AWS Elemental MediaConnect. The API
supports the following global resources: router inputs, router outputs
and router network interfaces.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.tag_global_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) of the global resource to tag.
    
          
        
    • 
      
        
  • 
          :tags
          (required, Hash<String,String>)
          
            
          
          
            — 
    A map of tag keys and values to add to the global resource.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


933

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

def tag_global_resource: (

    		
  





    
      

  

  
    #tag_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Associates the specified tags to a resource with the specified
resourceArn in the current region. If existing tags on a resource
are not specified in the request parameters, they are not changed.
When a resource is deleted, the tags associated with that resource are
deleted as well.


  





  
  

    
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) that identifies the MediaConnect
resource to which to add tags.
    
          
        
    • 
      
        
  • 
          :tags
          (required, Hash<String,String>)
          
            
          
          
            — 
    A map from tag keys to values. Tag keys can have a maximum character
length of 128 characters, and tag values can have a maximum length of
256 characters.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


940

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

def tag_resource: (

    		
  





    
      

  

  
    #take_router_input(params = {})  ⇒ Types::TakeRouterInputResponse 
  

  

  


  

    
Associates a router input with a router output in AWS Elemental
MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.take_router_input({
  router_output_arn: "RouterOutputArn", # required
  router_input_arn: "RouterInputArn",
})

    
      
        
Response structure

      
      

resp.routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_output_arn #=> String
resp.router_output_name #=> String
resp.router_input_arn #=> String
resp.router_input_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :router_output_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
associate with a router input.
    
          
        
    • 
      
        
  • 
          :router_input_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
associate with a router output.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


955

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

def take_router_input: (

    		
  





    
      

  

  
    #untag_global_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Removes tags from a global resource in AWS Elemental MediaConnect. The
API supports the following global resources: router inputs, router
outputs and router network interfaces.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.untag_global_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 global resource to remove tags
from.
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    The keys of the tags to remove from the global resource.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


962

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

def untag_global_resource: (

    		
  





    
      

  

  
    #untag_resource(params = {})  ⇒ Struct 
  

  

  


  

    
Deletes specified tags from a resource in the current region.


  





  
  

    
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 that you want to untag.
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    The keys of the tags to be removed.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


969

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

def untag_resource: (

    		
  





    
      

  

  
    #update_bridge(params = {})  ⇒ Types::UpdateBridgeResponse 
  

  

  


  

    
Updates the bridge.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_bridge({
  bridge_arn: "UpdateBridgeRequestBridgeArnString", # required
  egress_gateway_bridge: {
    max_bitrate: 1,
  },
  ingress_gateway_bridge: {
    max_bitrate: 1,
    max_outputs: 1,
  },
  source_failover_config: {
    failover_mode: "MERGE", # accepts MERGE, FAILOVER
    recovery_window: 1,
    source_priority: {
      primary_source: "String",
    },
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
})

    
      
        
Response structure

      
      

resp.bridge.bridge_arn #=> String
resp.bridge.bridge_messages #=> Array
resp.bridge.bridge_messages[0].code #=> String
resp.bridge.bridge_messages[0].message #=> String
resp.bridge.bridge_messages[0].resource_name #=> String
resp.bridge.bridge_state #=> String, one of "CREATING", "STANDBY", "STARTING", "DEPLOYING", "ACTIVE", "STOPPING", "DELETING", "DELETED", "START_FAILED", "START_PENDING", "STOP_FAILED", "UPDATING"
resp.bridge.egress_gateway_bridge.instance_id #=> String
resp.bridge.egress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.instance_id #=> String
resp.bridge.ingress_gateway_bridge.max_bitrate #=> Integer
resp.bridge.ingress_gateway_bridge.max_outputs #=> Integer
resp.bridge.name #=> String
resp.bridge.outputs #=> Array
resp.bridge.outputs[0].flow_output.flow_arn #=> String
resp.bridge.outputs[0].flow_output.flow_source_arn #=> String
resp.bridge.outputs[0].flow_output.name #=> String
resp.bridge.outputs[0].network_output.ip_address #=> String
resp.bridge.outputs[0].network_output.name #=> String
resp.bridge.outputs[0].network_output.network_name #=> String
resp.bridge.outputs[0].network_output.port #=> Integer
resp.bridge.outputs[0].network_output.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.bridge.outputs[0].network_output.ttl #=> Integer
resp.bridge.placement_arn #=> String
resp.bridge.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.bridge.source_failover_config.recovery_window #=> Integer
resp.bridge.source_failover_config.source_priority.primary_source #=> String
resp.bridge.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.bridge.sources #=> Array
resp.bridge.sources[0].flow_source.flow_arn #=> String
resp.bridge.sources[0].flow_source.flow_vpc_interface_attachment.vpc_interface_name #=> String
resp.bridge.sources[0].flow_source.name #=> String
resp.bridge.sources[0].flow_source.output_arn #=> String
resp.bridge.sources[0].network_source.multicast_ip #=> String
resp.bridge.sources[0].network_source.multicast_source_settings.multicast_source_ip #=> String
resp.bridge.sources[0].network_source.name #=> String
resp.bridge.sources[0].network_source.network_name #=> String
resp.bridge.sources[0].network_source.port #=> Integer
resp.bridge.sources[0].network_source.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    TheAmazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :egress_gateway_bridge
          (Types::UpdateEgressGatewayBridgeRequest)
          
            
          
          
            — 
    A cloud-to-ground bridge. The content comes from an existing
MediaConnect flow and is delivered to your premises.
    
          
        
    • 
      
        
  • 
          :ingress_gateway_bridge
          (Types::UpdateIngressGatewayBridgeRequest)
          
            
          
          
            — 
    A ground-to-cloud bridge. The content originates at your premises and
is delivered to the cloud.
    
          
        
    • 
      
        
  • 
          :source_failover_config
          (Types::UpdateFailoverConfig)
          
            
          
          
            — 
    The settings for source failover.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


980

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

def update_bridge: (

    		
  





    
      

  

  
    #update_bridge_output(params = {})  ⇒ Types::UpdateBridgeOutputResponse 
  

  

  


  

    
Updates an existing bridge output.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_bridge_output({
  bridge_arn: "UpdateBridgeOutputRequestBridgeArnString", # required
  network_output: {
    ip_address: "String",
    network_name: "String",
    port: 1,
    protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
    ttl: 1,
  },
  output_name: "String", # required
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.output.flow_output.flow_arn #=> String
resp.output.flow_output.flow_source_arn #=> String
resp.output.flow_output.name #=> String
resp.output.network_output.ip_address #=> String
resp.output.network_output.name #=> String
resp.output.network_output.network_name #=> String
resp.output.network_output.port #=> Integer
resp.output.network_output.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.output.network_output.ttl #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :network_output
          (Types::UpdateBridgeNetworkOutputRequest)
          
            
          
          
            — 
    The network of the bridge output.
    
          
        
    • 
      
        
  • 
          :output_name
          (required, String)
          
            
          
          
            — 
    Tname of the output that you want to update.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


999

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

def update_bridge_output: (

    		
  





    
      

  

  
    #update_bridge_source(params = {})  ⇒ Types::UpdateBridgeSourceResponse 
  

  

  


  

    
Updates an existing bridge source.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_bridge_source({
  bridge_arn: "UpdateBridgeSourceRequestBridgeArnString", # required
  flow_source: {
    flow_arn: "UpdateBridgeFlowSourceRequestFlowArnString",
    flow_vpc_interface_attachment: {
      vpc_interface_name: "String",
    },
  },
  network_source: {
    multicast_ip: "String",
    multicast_source_settings: {
      multicast_source_ip: "String",
    },
    network_name: "String",
    port: 1,
    protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
  },
  source_name: "String", # required
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.source.flow_source.flow_arn #=> String
resp.source.flow_source.flow_vpc_interface_attachment.vpc_interface_name #=> String
resp.source.flow_source.name #=> String
resp.source.flow_source.output_arn #=> String
resp.source.network_source.multicast_ip #=> String
resp.source.network_source.multicast_source_settings.multicast_source_ip #=> String
resp.source.network_source.name #=> String
resp.source.network_source.network_name #=> String
resp.source.network_source.port #=> Integer
resp.source.network_source.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update.
    
          
        
    • 
      
        
  • 
          :flow_source
          (Types::UpdateBridgeFlowSourceRequest)
          
            
          
          
            — 
    The name of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :network_source
          (Types::UpdateBridgeNetworkSourceRequest)
          
            
          
          
            — 
    The network for the bridge source.
    
          
        
    • 
      
        
  • 
          :source_name
          (required, String)
          
            
          
          
            — 
    The name of the source that you want to update.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1018

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

def update_bridge_source: (

    		
  





    
      

  

  
    #update_bridge_state(params = {})  ⇒ Types::UpdateBridgeStateResponse 
  

  

  


  

    
Updates the bridge state.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_bridge_state({
  bridge_arn: "UpdateBridgeStateRequestBridgeArnString", # required
  desired_state: "ACTIVE", # required, accepts ACTIVE, STANDBY, DELETED
})

    
      
        
Response structure

      
      

resp.bridge_arn #=> String
resp.desired_state #=> String, one of "ACTIVE", "STANDBY", "DELETED"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the bridge that you want to update
the state of.
    
          
        
    • 
      
        
  • 
          :desired_state
          (required, String)
          
            
          
          
            — 
    The desired state for the bridge.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1045

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

def update_bridge_state: (

    		
  





    
      

  

  
    #update_flow(params = {})  ⇒ Types::UpdateFlowResponse 
  

  

  


  

    
Updates an existing flow.


 Because UpdateFlowSources and UpdateFlow are separate operations,
you can't change both the source type AND the flow size in a single
request.


    

  • 

    If you have a MEDIUM flow and you want to change the flow source
to NDI®:
    

    • 

  • 

    First, use the UpdateFlow operation to upgrade the flow size to
LARGE.
    

    • 

  • 

    After that, you can then use the UpdateFlowSource operation to
configure the NDI source.
    

    • 

  • 

    If you're switching from an NDI source to a transport stream (TS)
source and want to downgrade the flow size:
    

    • 

  • 

    First, use the UpdateFlowSource operation to change the flow
source type.
    

    • 

  • 

    After that, you can then use the UpdateFlow operation to
downgrade the flow size to MEDIUM.
    

    • 


 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_flow({
  flow_arn: "UpdateFlowRequestFlowArnString", # required
  source_failover_config: {
    failover_mode: "MERGE", # accepts MERGE, FAILOVER
    recovery_window: 1,
    source_priority: {
      primary_source: "String",
    },
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  maintenance: {
    maintenance_day: "Monday", # accepts Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
    maintenance_scheduled_date: "String",
    maintenance_start_hour: "String",
  },
  source_monitoring_config: {
    thumbnail_state: "ENABLED", # accepts ENABLED, DISABLED
    audio_monitoring_settings: [
      {
        silent_audio: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
      },
    ],
    content_quality_analysis_state: "ENABLED", # accepts ENABLED, DISABLED
    video_monitoring_settings: [
      {
        black_frames: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
        frozen_frames: {
          state: "ENABLED", # accepts ENABLED, DISABLED
          threshold_seconds: 1,
        },
      },
    ],
  },
  ndi_config: {
    ndi_state: "ENABLED", # accepts ENABLED, DISABLED
    machine_name: "String",
    ndi_discovery_servers: [
      {
        discovery_server_address: "String", # required
        discovery_server_port: 1,
        vpc_interface_adapter: "String", # required
      },
    ],
  },
  flow_size: "MEDIUM", # accepts MEDIUM, LARGE, LARGE_4X
  encoding_config: {
    encoding_profile: "DISTRIBUTION_H264_DEFAULT", # accepts DISTRIBUTION_H264_DEFAULT, CONTRIBUTION_H264_DEFAULT
    video_max_bitrate: 1,
  },
})

    
      
        
Response structure

      
      

resp.flow.availability_zone #=> String
resp.flow.description #=> String
resp.flow.egress_ip #=> String
resp.flow.entitlements #=> Array
resp.flow.entitlements[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.entitlements[0].description #=> String
resp.flow.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.entitlements[0].encryption.constant_initialization_vector #=> String
resp.flow.entitlements[0].encryption.device_id #=> String
resp.flow.entitlements[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.entitlements[0].encryption.region #=> String
resp.flow.entitlements[0].encryption.resource_id #=> String
resp.flow.entitlements[0].encryption.role_arn #=> String
resp.flow.entitlements[0].encryption.secret_arn #=> String
resp.flow.entitlements[0].encryption.url #=> String
resp.flow.entitlements[0].entitlement_arn #=> String
resp.flow.entitlements[0].entitlement_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.entitlements[0].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> String
resp.flow.media_streams #=> Array
resp.flow.media_streams[0].attributes.fmtp.channel_order #=> String
resp.flow.media_streams[0].attributes.fmtp.colorimetry #=> String, one of "BT601", "BT709", "BT2020", "BT2100", "ST2065-1", "ST2065-3", "XYZ"
resp.flow.media_streams[0].attributes.fmtp.exact_framerate #=> String
resp.flow.media_streams[0].attributes.fmtp.par #=> String
resp.flow.media_streams[0].attributes.fmtp.range #=> String, one of "NARROW", "FULL", "FULLPROTECT"
resp.flow.media_streams[0].attributes.fmtp.scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.flow.media_streams[0].attributes.fmtp.tcs #=> String, one of "SDR", "PQ", "HLG", "LINEAR", "BT2100LINPQ", "BT2100LINHLG", "ST2065-1", "ST428-1", "DENSITY"
resp.flow.media_streams[0].attributes.lang #=> String
resp.flow.media_streams[0].clock_rate #=> Integer
resp.flow.media_streams[0].description #=> String
resp.flow.media_streams[0].fmt #=> Integer
resp.flow.media_streams[0].media_stream_id #=> Integer
resp.flow.media_streams[0].media_stream_name #=> String
resp.flow.media_streams[0].media_stream_type #=> String, one of "video", "audio", "ancillary-data"
resp.flow.media_streams[0].video_format #=> String
resp.flow.name #=> String
resp.flow.outputs #=> Array
resp.flow.outputs[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.outputs[0].description #=> String
resp.flow.outputs[0].destination #=> String
resp.flow.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.outputs[0].encryption.constant_initialization_vector #=> String
resp.flow.outputs[0].encryption.device_id #=> String
resp.flow.outputs[0].encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.outputs[0].encryption.region #=> String
resp.flow.outputs[0].encryption.resource_id #=> String
resp.flow.outputs[0].encryption.role_arn #=> String
resp.flow.outputs[0].encryption.secret_arn #=> String
resp.flow.outputs[0].encryption.url #=> String
resp.flow.outputs[0].entitlement_arn #=> String
resp.flow.outputs[0].listener_address #=> String
resp.flow.outputs[0].media_live_input_arn #=> String
resp.flow.outputs[0].media_stream_output_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations #=> Array
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].destination_port #=> Integer
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].interface.name #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].destination_configurations[0].outbound_ip #=> String
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.compression_factor #=> Float
resp.flow.outputs[0].media_stream_output_configurations[0].encoding_parameters.encoder_profile #=> String, one of "main", "high"
resp.flow.outputs[0].media_stream_output_configurations[0].media_stream_name #=> String
resp.flow.outputs[0].name #=> String
resp.flow.outputs[0].output_arn #=> String
resp.flow.outputs[0].port #=> Integer
resp.flow.outputs[0].transport.cidr_allow_list #=> Array
resp.flow.outputs[0].transport.cidr_allow_list[0] #=> String
resp.flow.outputs[0].transport.max_bitrate #=> Integer
resp.flow.outputs[0].transport.max_latency #=> Integer
resp.flow.outputs[0].transport.max_sync_buffer #=> Integer
resp.flow.outputs[0].transport.min_latency #=> Integer
resp.flow.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.sender_control_port #=> Integer
resp.flow.outputs[0].transport.sender_ip_address #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.source_listener_address #=> String
resp.flow.outputs[0].transport.source_listener_port #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.outputs[0].transport.ndi_program_name #=> String
resp.flow.outputs[0].transport.ndi_source_settings.source_name #=> String
resp.flow.outputs[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.outputs[0].bridge_arn #=> String
resp.flow.outputs[0].bridge_ports #=> Array
resp.flow.outputs[0].bridge_ports[0] #=> Integer
resp.flow.outputs[0].output_status #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].peer_ip_address #=> String
resp.flow.outputs[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.outputs[0].router_integration_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.outputs[0].connected_router_input_arn #=> String
resp.flow.source.data_transfer_subscriber_fee_percent #=> Integer
resp.flow.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.source.decryption.constant_initialization_vector #=> String
resp.flow.source.decryption.device_id #=> String
resp.flow.source.decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.source.decryption.region #=> String
resp.flow.source.decryption.resource_id #=> String
resp.flow.source.decryption.role_arn #=> String
resp.flow.source.decryption.secret_arn #=> String
resp.flow.source.decryption.url #=> String
resp.flow.source.description #=> String
resp.flow.source.entitlement_arn #=> String
resp.flow.source.ingest_ip #=> String
resp.flow.source.ingest_port #=> Integer
resp.flow.source.media_stream_source_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.source.media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.source.media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.source.media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.source.name #=> String
resp.flow.source.sender_control_port #=> Integer
resp.flow.source.sender_ip_address #=> String
resp.flow.source.source_arn #=> String
resp.flow.source.transport.cidr_allow_list #=> Array
resp.flow.source.transport.cidr_allow_list[0] #=> String
resp.flow.source.transport.max_bitrate #=> Integer
resp.flow.source.transport.max_latency #=> Integer
resp.flow.source.transport.max_sync_buffer #=> Integer
resp.flow.source.transport.min_latency #=> Integer
resp.flow.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.sender_control_port #=> Integer
resp.flow.source.transport.sender_ip_address #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.source_listener_address #=> String
resp.flow.source.transport.source_listener_port #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.transport.ndi_speed_hq_quality #=> Integer
resp.flow.source.transport.ndi_program_name #=> String
resp.flow.source.transport.ndi_source_settings.source_name #=> String
resp.flow.source.transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source.gateway_bridge_source.bridge_arn #=> String
resp.flow.source.gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.source.peer_ip_address #=> String
resp.flow.source.router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source.router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.source.connected_router_output_arn #=> String
resp.flow.source_failover_config.failover_mode #=> String, one of "MERGE", "FAILOVER"
resp.flow.source_failover_config.recovery_window #=> Integer
resp.flow.source_failover_config.source_priority.primary_source #=> String
resp.flow.source_failover_config.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources #=> Array
resp.flow.sources[0].data_transfer_subscriber_fee_percent #=> Integer
resp.flow.sources[0].decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.flow.sources[0].decryption.constant_initialization_vector #=> String
resp.flow.sources[0].decryption.device_id #=> String
resp.flow.sources[0].decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.flow.sources[0].decryption.region #=> String
resp.flow.sources[0].decryption.resource_id #=> String
resp.flow.sources[0].decryption.role_arn #=> String
resp.flow.sources[0].decryption.secret_arn #=> String
resp.flow.sources[0].decryption.url #=> String
resp.flow.sources[0].description #=> String
resp.flow.sources[0].entitlement_arn #=> String
resp.flow.sources[0].ingest_ip #=> String
resp.flow.sources[0].ingest_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations #=> Array
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.flow.sources[0].media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.flow.sources[0].media_stream_source_configurations[0].media_stream_name #=> String
resp.flow.sources[0].name #=> String
resp.flow.sources[0].sender_control_port #=> Integer
resp.flow.sources[0].sender_ip_address #=> String
resp.flow.sources[0].source_arn #=> String
resp.flow.sources[0].transport.cidr_allow_list #=> Array
resp.flow.sources[0].transport.cidr_allow_list[0] #=> String
resp.flow.sources[0].transport.max_bitrate #=> Integer
resp.flow.sources[0].transport.max_latency #=> Integer
resp.flow.sources[0].transport.max_sync_buffer #=> Integer
resp.flow.sources[0].transport.min_latency #=> Integer
resp.flow.sources[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.sender_control_port #=> Integer
resp.flow.sources[0].transport.sender_ip_address #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.source_listener_address #=> String
resp.flow.sources[0].transport.source_listener_port #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].transport.ndi_speed_hq_quality #=> Integer
resp.flow.sources[0].transport.ndi_program_name #=> String
resp.flow.sources[0].transport.ndi_source_settings.source_name #=> String
resp.flow.sources[0].transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> String
resp.flow.sources[0].gateway_bridge_source.bridge_arn #=> String
resp.flow.sources[0].gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.flow.sources[0].peer_ip_address #=> String
resp.flow.sources[0].router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.flow.sources[0].router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.flow.sources[0].connected_router_output_arn #=> String
resp.flow.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
resp.flow.vpc_interfaces #=> Array
resp.flow.vpc_interfaces[0].name #=> String
resp.flow.vpc_interfaces[0].network_interface_ids #=> Array
resp.flow.vpc_interfaces[0].network_interface_ids[0] #=> String
resp.flow.vpc_interfaces[0].network_interface_type #=> String, one of "ena", "efa"
resp.flow.vpc_interfaces[0].role_arn #=> String
resp.flow.vpc_interfaces[0].security_group_ids #=> Array
resp.flow.vpc_interfaces[0].security_group_ids[0] #=> String
resp.flow.vpc_interfaces[0].subnet_id #=> String
resp.flow.maintenance.maintenance_day #=> String, one of "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"
resp.flow.maintenance.maintenance_deadline #=> String
resp.flow.maintenance.maintenance_scheduled_date #=> String
resp.flow.maintenance.maintenance_start_hour #=> String
resp.flow.source_monitoring_config.thumbnail_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings #=> Array
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.audio_monitoring_settings[0].silent_audio.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.content_quality_analysis_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings #=> Array
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].black_frames.threshold_seconds #=> Integer
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.flow.source_monitoring_config.video_monitoring_settings[0].frozen_frames.threshold_seconds #=> Integer
resp.flow.flow_size #=> String, one of "MEDIUM", "LARGE", "LARGE_4X"
resp.flow.ndi_config.ndi_state #=> String, one of "ENABLED", "DISABLED"
resp.flow.ndi_config.machine_name #=> String
resp.flow.ndi_config.ndi_discovery_servers #=> Array
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_address #=> String
resp.flow.ndi_config.ndi_discovery_servers[0].discovery_server_port #=> Integer
resp.flow.ndi_config.ndi_discovery_servers[0].vpc_interface_adapter #=> String
resp.flow.encoding_config.encoding_profile #=> String, one of "DISTRIBUTION_H264_DEFAULT", "CONTRIBUTION_H264_DEFAULT"
resp.flow.encoding_config.video_max_bitrate #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :source_failover_config
          (Types::UpdateFailoverConfig)
          
            
          
          
            — 
    The settings for source failover.
    
          
        
    • 
      
        
  • 
          :maintenance
          (Types::UpdateMaintenance)
          
            
          
          
            — 
    The maintenance setting of the flow.
    
          
        
    • 
      
        
  • 
          :source_monitoring_config
          (Types::MonitoringConfig)
          
            
          
          
            — 
    The settings for source monitoring.
    
          
        
    • 
      
        
  • 
          :ndi_config
          (Types::NdiConfig)
          
            
          
          
            — 
    Specifies the configuration settings for a flow's NDI source or
output. Required when the flow includes an NDI source or output.
    
          
        
    • 
      
        
  • 
          :flow_size
          (String)
          
            
          
          
            — 
    Determines the processing capacity and feature set of the flow.
    
          
        
    • 
      
        
  • 
          :encoding_config
          (Types::EncodingConfig)
          
            
          
          
            — 
    The encoding configuration to apply to the NDI® source when
transcoding it to a transport stream for downstream distribution. You
can choose between several predefined encoding profiles based on
common use cases.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1056

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

def update_flow: (

    		
  





    
      

  

  
    #update_flow_entitlement(params = {})  ⇒ Types::UpdateFlowEntitlementResponse 
  

  

  


  

    
Updates an entitlement. You can change an entitlement's description,
subscribers, and encryption. If you change the subscribers, the
service will remove the outputs that are are used by the subscribers
that are removed.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_flow_entitlement({
  description: "String",
  encryption: {
    algorithm: "aes128", # accepts aes128, aes192, aes256
    constant_initialization_vector: "String",
    device_id: "String",
    key_type: "speke", # accepts speke, static-key, srt-password
    region: "String",
    resource_id: "String",
    role_arn: "String",
    secret_arn: "String",
    url: "String",
  },
  entitlement_arn: "UpdateFlowEntitlementRequestEntitlementArnString", # required
  entitlement_status: "ENABLED", # accepts ENABLED, DISABLED
  flow_arn: "UpdateFlowEntitlementRequestFlowArnString", # required
  subscribers: ["String"],
})

    
      
        
Response structure

      
      

resp.entitlement.data_transfer_subscriber_fee_percent #=> Integer
resp.entitlement.description #=> String
resp.entitlement.encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.entitlement.encryption.constant_initialization_vector #=> String
resp.entitlement.encryption.device_id #=> String
resp.entitlement.encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.entitlement.encryption.region #=> String
resp.entitlement.encryption.resource_id #=> String
resp.entitlement.encryption.role_arn #=> String
resp.entitlement.encryption.secret_arn #=> String
resp.entitlement.encryption.url #=> String
resp.entitlement.entitlement_arn #=> String
resp.entitlement.entitlement_status #=> String, one of "ENABLED", "DISABLED"
resp.entitlement.name #=> String
resp.entitlement.subscribers #=> Array
resp.entitlement.subscribers[0] #=> String
resp.flow_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the entitlement. This description appears only on the
MediaConnect console and will not be seen by the subscriber or end
user.
    
          
        
    • 
      
        
  • 
          :encryption
          (Types::UpdateEncryption)
          
            
          
          
            — 
    The type of encryption that will be used on the output associated with
this entitlement. Allowable encryption types: static-key, speke.
    
          
        
    • 
      
        
  • 
          :entitlement_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the entitlement that you want to
update.
    
          
        
    • 
      
        
  • 
          :entitlement_status
          (String)
          
            
          
          
            — 
    An indication of whether you want to enable the entitlement to allow
access, or disable it to stop streaming content to the subscriber’s
flow temporarily. If you don’t specify the entitlementStatus field
in your request, MediaConnect leaves the value unchanged.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the flow that is associated with the entitlement that you
want to update.
    
          
        
    • 
      
        
  • 
          :subscribers
          (Array<String>)
          
            
          
          
            — 
    The Amazon Web Services account IDs that you want to share your
content with. The receiving accounts (subscribers) will be allowed to
create their own flow using your content as the source.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1080

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

def update_flow_entitlement: (

    		
  





    
      

  

  
    #update_flow_media_stream(params = {})  ⇒ Types::UpdateFlowMediaStreamResponse 
  

  

  


  

    
Updates an existing media stream.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_flow_media_stream({
  attributes: {
    fmtp: {
      channel_order: "String",
      colorimetry: "BT601", # accepts BT601, BT709, BT2020, BT2100, ST2065-1, ST2065-3, XYZ
      exact_framerate: "String",
      par: "String",
      range: "NARROW", # accepts NARROW, FULL, FULLPROTECT
      scan_mode: "progressive", # accepts progressive, interlace, progressive-segmented-frame
      tcs: "SDR", # accepts SDR, PQ, HLG, LINEAR, BT2100LINPQ, BT2100LINHLG, ST2065-1, ST428-1, DENSITY
    },
    lang: "String",
  },
  clock_rate: 1,
  description: "String",
  flow_arn: "UpdateFlowMediaStreamRequestFlowArnString", # required
  media_stream_name: "String", # required
  media_stream_type: "video", # accepts video, audio, ancillary-data
  video_format: "String",
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.media_stream.attributes.fmtp.channel_order #=> String
resp.media_stream.attributes.fmtp.colorimetry #=> String, one of "BT601", "BT709", "BT2020", "BT2100", "ST2065-1", "ST2065-3", "XYZ"
resp.media_stream.attributes.fmtp.exact_framerate #=> String
resp.media_stream.attributes.fmtp.par #=> String
resp.media_stream.attributes.fmtp.range #=> String, one of "NARROW", "FULL", "FULLPROTECT"
resp.media_stream.attributes.fmtp.scan_mode #=> String, one of "progressive", "interlace", "progressive-segmented-frame"
resp.media_stream.attributes.fmtp.tcs #=> String, one of "SDR", "PQ", "HLG", "LINEAR", "BT2100LINPQ", "BT2100LINHLG", "ST2065-1", "ST428-1", "DENSITY"
resp.media_stream.attributes.lang #=> String
resp.media_stream.clock_rate #=> Integer
resp.media_stream.description #=> String
resp.media_stream.fmt #=> Integer
resp.media_stream.media_stream_id #=> Integer
resp.media_stream.media_stream_name #=> String
resp.media_stream.media_stream_type #=> String, one of "video", "audio", "ancillary-data"
resp.media_stream.video_format #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :attributes
          (Types::MediaStreamAttributesRequest)
          
            
          
          
            — 
    The attributes that you want to assign to the media stream.
    
          
        
    • 
      
        
  • 
          :clock_rate
          (Integer)
          
            
          
          
            — 
    The sample rate for the stream. This value in measured in kHz.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description that can help you quickly identify what your media
stream is used for.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that is associated with the
media stream that you updated.
    
          
        
    • 
      
        
  • 
          :media_stream_name
          (required, String)
          
            
          
          
            — 
    The media stream that you updated.
    
          
        
    • 
      
        
  • 
          :media_stream_type
          (String)
          
            
          
          
            — 
    The type of media stream.
    
          
        
    • 
      
        
  • 
          :video_format
          (String)
          
            
          
          
            — 
    The resolution of the video.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1096

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

def update_flow_media_stream: (

    		
  





    
      

  

  
    #update_flow_output(params = {})  ⇒ Types::UpdateFlowOutputResponse 
  

  

  


  

    
Updates an existing flow output.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_flow_output({
  cidr_allow_list: ["String"],
  description: "String",
  destination: "String",
  encryption: {
    algorithm: "aes128", # accepts aes128, aes192, aes256
    constant_initialization_vector: "String",
    device_id: "String",
    key_type: "speke", # accepts speke, static-key, srt-password
    region: "String",
    resource_id: "String",
    role_arn: "String",
    secret_arn: "String",
    url: "String",
  },
  flow_arn: "UpdateFlowOutputRequestFlowArnString", # required
  max_latency: 1,
  media_stream_output_configurations: [
    {
      destination_configurations: [
        {
          destination_ip: "String", # required
          destination_port: 1, # required
          interface: { # required
            name: "String", # required
          },
        },
      ],
      encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
      encoding_parameters: {
        compression_factor: 1.0, # required
        encoder_profile: "main", # required, accepts main, high
      },
      media_stream_name: "String", # required
    },
  ],
  min_latency: 1,
  output_arn: "UpdateFlowOutputRequestOutputArnString", # required
  port: 1,
  protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
  remote_id: "String",
  sender_control_port: 1,
  sender_ip_address: "String",
  smoothing_latency: 1,
  stream_id: "String",
  vpc_interface_attachment: {
    vpc_interface_name: "String",
  },
  output_status: "ENABLED", # accepts ENABLED, DISABLED
  ndi_program_name: "String",
  ndi_speed_hq_quality: 1,
  router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
  router_integration_transit_encryption: {
    encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
    encryption_key_configuration: { # required
      secrets_manager: {
        secret_arn: "SecretArn", # required
        role_arn: "RoleArn", # required
      },
      automatic: {
      },
    },
  },
  ndi_output_timecode_source: "EMBEDDED_TIMECODE", # accepts EMBEDDED_TIMECODE, UTC_SYSTEM_TIME
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.output.data_transfer_subscriber_fee_percent #=> Integer
resp.output.description #=> String
resp.output.destination #=> String
resp.output.encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.output.encryption.constant_initialization_vector #=> String
resp.output.encryption.device_id #=> String
resp.output.encryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.output.encryption.region #=> String
resp.output.encryption.resource_id #=> String
resp.output.encryption.role_arn #=> String
resp.output.encryption.secret_arn #=> String
resp.output.encryption.url #=> String
resp.output.entitlement_arn #=> String
resp.output.listener_address #=> String
resp.output.media_live_input_arn #=> String
resp.output.media_stream_output_configurations #=> Array
resp.output.media_stream_output_configurations[0].destination_configurations #=> Array
resp.output.media_stream_output_configurations[0].destination_configurations[0].destination_ip #=> String
resp.output.media_stream_output_configurations[0].destination_configurations[0].destination_port #=> Integer
resp.output.media_stream_output_configurations[0].destination_configurations[0].interface.name #=> String
resp.output.media_stream_output_configurations[0].destination_configurations[0].outbound_ip #=> String
resp.output.media_stream_output_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.output.media_stream_output_configurations[0].encoding_parameters.compression_factor #=> Float
resp.output.media_stream_output_configurations[0].encoding_parameters.encoder_profile #=> String, one of "main", "high"
resp.output.media_stream_output_configurations[0].media_stream_name #=> String
resp.output.name #=> String
resp.output.output_arn #=> String
resp.output.port #=> Integer
resp.output.transport.cidr_allow_list #=> Array
resp.output.transport.cidr_allow_list[0] #=> String
resp.output.transport.max_bitrate #=> Integer
resp.output.transport.max_latency #=> Integer
resp.output.transport.max_sync_buffer #=> Integer
resp.output.transport.min_latency #=> Integer
resp.output.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.output.transport.remote_id #=> String
resp.output.transport.sender_control_port #=> Integer
resp.output.transport.sender_ip_address #=> String
resp.output.transport.smoothing_latency #=> Integer
resp.output.transport.source_listener_address #=> String
resp.output.transport.source_listener_port #=> Integer
resp.output.transport.stream_id #=> String
resp.output.transport.ndi_speed_hq_quality #=> Integer
resp.output.transport.ndi_program_name #=> String
resp.output.transport.ndi_source_settings.source_name #=> String
resp.output.transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.output.vpc_interface_attachment.vpc_interface_name #=> String
resp.output.bridge_arn #=> String
resp.output.bridge_ports #=> Array
resp.output.bridge_ports[0] #=> Integer
resp.output.output_status #=> String, one of "ENABLED", "DISABLED"
resp.output.peer_ip_address #=> String
resp.output.router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.output.router_integration_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.output.router_integration_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.output.router_integration_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.output.connected_router_input_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :cidr_allow_list
          (Array<String>)
          
            
          
          
            — 
    The range of IP addresses that should be allowed to initiate output
requests to this flow. These IP addresses should be in the form of a
Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the output. This description appears only on the
MediaConnect console and will not be seen by the end user.
    
          
        
    • 
      
        
  • 
          :destination
          (String)
          
            
          
          
            — 
    The IP address where you want to send the output.
    
          
        
    • 
      
        
  • 
          :encryption
          (Types::UpdateEncryption)
          
            
          
          
            — 
    The type of key used for the encryption. If no keyType is provided,
the service will use the default setting (static-key). Allowable
encryption types: static-key.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the flow that is associated with the
output that you want to update.
    
          
        
    • 
      
        
  • 
          :max_latency
          (Integer)
          
            
          
          
            — 
    The maximum latency in milliseconds. This parameter applies only to
RIST-based and Zixi-based streams.
    
          
        
    • 
      
        
  • 
          :media_stream_output_configurations
          (Array<Types::MediaStreamOutputConfigurationRequest>)
          
            
          
          
            — 
    The media streams that are associated with the output, and the
parameters for those associations.
    
          
        
    • 
      
        
  • 
          :min_latency
          (Integer)
          
            
          
          
            — 
    The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your
MediaConnect source or output represents the minimal potential latency
of that connection. The latency of the stream is set to the highest
number between the sender’s minimum latency and the receiver’s minimum
latency.
    
          
        
    • 
      
        
  • 
          :output_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the output that you want to update.
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port to use when content is distributed to this output.
    
          
        
    • 
      
        
  • 
          :protocol
          (String)
          
            
          
          
            — 
    The protocol to use for the output.
    

     Elemental MediaConnect no longer supports the Fujitsu QoS protocol.
This reference is maintained for legacy purposes only.
    
 
    
          
        
    • 
      
        
  • 
          :remote_id
          (String)
          
            
          
          
            — 
    The remote ID for the Zixi-pull stream.
    
          
        
    • 
      
        
  • 
          :sender_control_port
          (Integer)
          
            
          
          
            — 
    The port that the flow uses to send outbound requests to initiate
connection with the sender.
    
          
        
    • 
      
        
  • 
          :sender_ip_address
          (String)
          
            
          
          
            — 
    The IP address that the flow communicates with to initiate connection
with the sender.
    
          
        
    • 
      
        
  • 
          :smoothing_latency
          (Integer)
          
            
          
          
            — 
    The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC
streams.
    
          
        
    • 
      
        
  • 
          :stream_id
          (String)
          
            
          
          
            — 
    The stream ID that you want to use for this transport. This parameter
applies only to Zixi and SRT caller-based streams.
    
          
        
    • 
      
        
  • 
          :vpc_interface_attachment
          (Types::VpcInterfaceAttachment)
          
            
          
          
            — 
    The name of the VPC interface attachment to use for this output.
    
          
        
    • 
      
        
  • 
          :output_status
          (String)
          
            
          
          
            — 
    An indication of whether the output should transmit data or not. If
you don't specify the outputStatus field in your request,
MediaConnect leaves the value unchanged.
    
          
        
    • 
      
        
  • 
          :ndi_program_name
          (String)
          
            
          
          
            — 
    A suffix for the name of the NDI® sender that the flow creates. If a
custom name isn't specified, MediaConnect uses the output name.
    
          
        
    • 
      
        
  • 
          :ndi_speed_hq_quality
          (Integer)
          
            
          
          
            — 
    A quality setting for the NDI Speed HQ encoder.
    
          
        
    • 
      
        
  • 
          :router_integration_state
          (String)
          
            
          
          
            — 
    Indicates whether to enable or disable router integration for this
flow output.
    
          
        
    • 
      
        
  • 
          :router_integration_transit_encryption
          (Types::FlowTransitEncryption)
          
            
          
          
            — 
    The configuration that defines how content is encrypted during transit
between the MediaConnect router and a MediaConnect flow.
    
          
        
    • 
      
        
  • 
          :ndi_output_timecode_source
          (String)
          
            
          
          
            — 
    Controls how MediaConnect generates timecodes for NDI output frames.
If you don't specify this field, MediaConnect leaves the value
unchanged.
    

      

    • 

      EMBEDDED_TIMECODE - Preserves timecodes from the input transport
stream. The timecodes must be embedded in the video stream as SEI
timing messages. If no embedded timecode is detected, MediaConnect
uses the UTC system time instead.
      

      • 

    • 

      UTC_SYSTEM_TIME - Generates timecodes based on the system clock
time when each frame is sent.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1113

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

def update_flow_output: (

    		
  





    
      

  

  
    #update_flow_source(params = {})  ⇒ Types::UpdateFlowSourceResponse 
  

  

  


  

    
Updates the source of a flow.


 Because UpdateFlowSources and UpdateFlow are separate operations,
you can't change both the source type AND the flow size in a single
request.


    

  • 

    If you have a MEDIUM flow and you want to change the flow source
to NDI®:
    

    • 

  • 

    First, use the UpdateFlow operation to upgrade the flow size to
LARGE.
    

    • 

  • 

    After that, you can then use the UpdateFlowSource operation to
configure the NDI source.
    

    • 

  • 

    If you're switching from an NDI source to a transport stream (TS)
source and want to downgrade the flow size:
    

    • 

  • 

    First, use the UpdateFlowSource operation to change the flow
source type.
    

    • 

  • 

    After that, you can then use the UpdateFlow operation to
downgrade the flow size to MEDIUM.
    

    • 


 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_flow_source({
  decryption: {
    algorithm: "aes128", # accepts aes128, aes192, aes256
    constant_initialization_vector: "String",
    device_id: "String",
    key_type: "speke", # accepts speke, static-key, srt-password
    region: "String",
    resource_id: "String",
    role_arn: "String",
    secret_arn: "String",
    url: "String",
  },
  description: "String",
  entitlement_arn: "UpdateFlowSourceRequestEntitlementArnString",
  flow_arn: "UpdateFlowSourceRequestFlowArnString", # required
  ingest_port: 1,
  max_bitrate: 1,
  max_latency: 1,
  max_sync_buffer: 1,
  media_stream_source_configurations: [
    {
      encoding_name: "jxsv", # required, accepts jxsv, raw, smpte291, pcm
      input_configurations: [
        {
          input_port: 1, # required
          interface: { # required
            name: "String", # required
          },
        },
      ],
      media_stream_name: "String", # required
    },
  ],
  min_latency: 1,
  protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener, srt-caller, fujitsu-qos, udp, ndi-speed-hq
  sender_control_port: 1,
  sender_ip_address: "String",
  source_arn: "UpdateFlowSourceRequestSourceArnString", # required
  source_listener_address: "String",
  source_listener_port: 1,
  stream_id: "String",
  vpc_interface_name: "String",
  whitelist_cidr: "String",
  gateway_bridge_source: {
    bridge_arn: "UpdateGatewayBridgeSourceRequestBridgeArnString",
    vpc_interface_attachment: {
      vpc_interface_name: "String",
    },
  },
  ndi_source_settings: {
    source_name: "String",
  },
  router_integration_state: "ENABLED", # accepts ENABLED, DISABLED
  router_integration_transit_decryption: {
    encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
    encryption_key_configuration: { # required
      secrets_manager: {
        secret_arn: "SecretArn", # required
        role_arn: "RoleArn", # required
      },
      automatic: {
      },
    },
  },
})

    
      
        
Response structure

      
      

resp.flow_arn #=> String
resp.source.data_transfer_subscriber_fee_percent #=> Integer
resp.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
resp.source.decryption.constant_initialization_vector #=> String
resp.source.decryption.device_id #=> String
resp.source.decryption.key_type #=> String, one of "speke", "static-key", "srt-password"
resp.source.decryption.region #=> String
resp.source.decryption.resource_id #=> String
resp.source.decryption.role_arn #=> String
resp.source.decryption.secret_arn #=> String
resp.source.decryption.url #=> String
resp.source.description #=> String
resp.source.entitlement_arn #=> String
resp.source.ingest_ip #=> String
resp.source.ingest_port #=> Integer
resp.source.media_stream_source_configurations #=> Array
resp.source.media_stream_source_configurations[0].encoding_name #=> String, one of "jxsv", "raw", "smpte291", "pcm"
resp.source.media_stream_source_configurations[0].input_configurations #=> Array
resp.source.media_stream_source_configurations[0].input_configurations[0].input_ip #=> String
resp.source.media_stream_source_configurations[0].input_configurations[0].input_port #=> Integer
resp.source.media_stream_source_configurations[0].input_configurations[0].interface.name #=> String
resp.source.media_stream_source_configurations[0].media_stream_name #=> String
resp.source.name #=> String
resp.source.sender_control_port #=> Integer
resp.source.sender_ip_address #=> String
resp.source.source_arn #=> String
resp.source.transport.cidr_allow_list #=> Array
resp.source.transport.cidr_allow_list[0] #=> String
resp.source.transport.max_bitrate #=> Integer
resp.source.transport.max_latency #=> Integer
resp.source.transport.max_sync_buffer #=> Integer
resp.source.transport.min_latency #=> Integer
resp.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "st2110-jpegxs", "cdi", "srt-listener", "srt-caller", "fujitsu-qos", "udp", "ndi-speed-hq"
resp.source.transport.remote_id #=> String
resp.source.transport.sender_control_port #=> Integer
resp.source.transport.sender_ip_address #=> String
resp.source.transport.smoothing_latency #=> Integer
resp.source.transport.source_listener_address #=> String
resp.source.transport.source_listener_port #=> Integer
resp.source.transport.stream_id #=> String
resp.source.transport.ndi_speed_hq_quality #=> Integer
resp.source.transport.ndi_program_name #=> String
resp.source.transport.ndi_source_settings.source_name #=> String
resp.source.transport.ndi_output_timecode_source #=> String, one of "EMBEDDED_TIMECODE", "UTC_SYSTEM_TIME"
resp.source.vpc_interface_name #=> String
resp.source.whitelist_cidr #=> String
resp.source.gateway_bridge_source.bridge_arn #=> String
resp.source.gateway_bridge_source.vpc_interface_attachment.vpc_interface_name #=> String
resp.source.peer_ip_address #=> String
resp.source.router_integration_state #=> String, one of "ENABLED", "DISABLED"
resp.source.router_integration_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.source.router_integration_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.source.connected_router_output_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :decryption
          (Types::UpdateEncryption)
          
            
          
          
            — 
    The type of encryption that is used on the content ingested from the
source.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the source. This description is not visible outside
of the current Amazon Web Services account.
    
          
        
    • 
      
        
  • 
          :entitlement_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the entitlement that allows you to
subscribe to the flow. The entitlement is set by the content
originator, and the ARN is generated as part of the originator's
flow.
    
          
        
    • 
      
        
  • 
          :flow_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the flow that you want to update.
    
          
        
    • 
      
        
  • 
          :ingest_port
          (Integer)
          
            
          
          
            — 
    The port that the flow listens on for incoming content. If the
protocol of the source is Zixi, the port must be set to 2088.
    
          
        
    • 
      
        
  • 
          :max_bitrate
          (Integer)
          
            
          
          
            — 
    The maximum bitrate for RIST, RTP, and RTP-FEC streams.
    
          
        
    • 
      
        
  • 
          :max_latency
          (Integer)
          
            
          
          
            — 
    The maximum latency in milliseconds. This parameter applies only to
RIST-based and Zixi-based streams.
    
          
        
    • 
      
        
  • 
          :max_sync_buffer
          (Integer)
          
            
          
          
            — 
    The size of the buffer (in milliseconds) to use to sync incoming
source data.
    
          
        
    • 
      
        
  • 
          :media_stream_source_configurations
          (Array<Types::MediaStreamSourceConfigurationRequest>)
          
            
          
          
            — 
    The media stream that is associated with the source, and the
parameters for that association.
    
          
        
    • 
      
        
  • 
          :min_latency
          (Integer)
          
            
          
          
            — 
    The minimum latency in milliseconds for SRT-based streams. In streams
that use the SRT protocol, this value that you set on your
MediaConnect source or output represents the minimal potential latency
of that connection. The latency of the stream is set to the highest
number between the sender’s minimum latency and the receiver’s minimum
latency.
    
          
        
    • 
      
        
  • 
          :protocol
          (String)
          
            
          
          
            — 
    The protocol that the source uses to deliver the content to
MediaConnect.
    

     Elemental MediaConnect no longer supports the Fujitsu QoS protocol.
This reference is maintained for legacy purposes only.
    
 
    
          
        
    • 
      
        
  • 
          :sender_control_port
          (Integer)
          
            
          
          
            — 
    The port that the flow uses to send outbound requests to initiate
connection with the sender.
    
          
        
    • 
      
        
  • 
          :sender_ip_address
          (String)
          
            
          
          
            — 
    The IP address that the flow communicates with to initiate connection
with the sender.
    
          
        
    • 
      
        
  • 
          :source_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the source that you want to update.
    
          
        
    • 
      
        
  • 
          :source_listener_address
          (String)
          
            
          
          
            — 
    The source IP or domain name for SRT-caller protocol.
    
          
        
    • 
      
        
  • 
          :source_listener_port
          (Integer)
          
            
          
          
            — 
    Source port for SRT-caller protocol.
    
          
        
    • 
      
        
  • 
          :stream_id
          (String)
          
            
          
          
            — 
    The stream ID that you want to use for this transport. This parameter
applies only to Zixi and SRT caller-based streams.
    
          
        
    • 
      
        
  • 
          :vpc_interface_name
          (String)
          
            
          
          
            — 
    The name of the VPC interface that you want to send your output to.
    
          
        
    • 
      
        
  • 
          :whitelist_cidr
          (String)
          
            
          
          
            — 
    The range of IP addresses that are allowed to contribute content to
your source. Format the IP addresses as a Classless Inter-Domain
Routing (CIDR) block; for example, 10.0.0.0/16.
    
          
        
    • 
      
        
  • 
          :gateway_bridge_source
          (Types::UpdateGatewayBridgeSourceRequest)
          
            
          
          
            — 
    The source configuration for cloud flows receiving a stream from a
bridge.
    
          
        
    • 
      
        
  • 
          :ndi_source_settings
          (Types::NdiSourceSettings)
          
            
          
          
            — 
    The settings for the NDI source. This includes the exact name of the
upstream NDI sender that you want to connect to your source.
    
          
        
    • 
      
        
  • 
          :router_integration_state
          (String)
          
            
          
          
            — 
    Indicates whether to enable or disable router integration for this
flow source.
    
          
        
    • 
      
        
  • 
          :router_integration_transit_decryption
          (Types::FlowTransitEncryption)
          
            
          
          
            — 
    The encryption configuration for the flow source when router
integration is enabled.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1150

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

def update_flow_source: (

    		
  





    
      

  

  
    #update_gateway_instance(params = {})  ⇒ Types::UpdateGatewayInstanceResponse 
  

  

  


  

    
Updates an existing gateway instance.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_gateway_instance({
  bridge_placement: "AVAILABLE", # accepts AVAILABLE, LOCKED
  gateway_instance_arn: "UpdateGatewayInstanceRequestGatewayInstanceArnString", # required
})

    
      
        
Response structure

      
      

resp.bridge_placement #=> String, one of "AVAILABLE", "LOCKED"
resp.gateway_instance_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :bridge_placement
          (String)
          
            
          
          
            — 
    The state of the instance. ACTIVE or INACTIVE.
    
          
        
    • 
      
        
  • 
          :gateway_instance_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the gateway instance that you want
to update.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1192

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

def update_gateway_instance: (

    		
  





    
      

  

  
    #update_router_input(params = {})  ⇒ Types::UpdateRouterInputResponse 
  

  

  


  

    
Updates the configuration of an existing router input in AWS Elemental
MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_router_input({
  arn: "RouterInputArn", # required
  name: "UpdateRouterInputRequestNameString",
  configuration: {
    standard: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configuration: { # required
        rist: {
          port: 1, # required
          recovery_latency_milliseconds: 1, # required
        },
        srt_listener: {
          port: 1, # required
          minimum_latency_milliseconds: 1, # required
          decryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        srt_caller: {
          source_address: "String", # required
          source_port: 1, # required
          minimum_latency_milliseconds: 1, # required
          stream_id: "String",
          decryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        rtp: {
          port: 1, # required
          forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      protocol: "RTP", # accepts RTP, RIST, SRT_CALLER, SRT_LISTENER
    },
    media_live_channel: {
      media_live_channel_arn: "MediaLiveChannelArn",
      media_live_pipeline_id: "PIPELINE_0", # accepts PIPELINE_0, PIPELINE_1
      media_live_channel_output_name: "String",
      source_transit_decryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    failover: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configurations: [ # required
        {
          rist: {
            port: 1, # required
            recovery_latency_milliseconds: 1, # required
          },
          srt_listener: {
            port: 1, # required
            minimum_latency_milliseconds: 1, # required
            decryption_configuration: {
              encryption_key: { # required
                secret_arn: "SecretArn", # required
                role_arn: "RoleArn", # required
              },
            },
          },
          srt_caller: {
            source_address: "String", # required
            source_port: 1, # required
            minimum_latency_milliseconds: 1, # required
            stream_id: "String",
            decryption_configuration: {
              encryption_key: { # required
                secret_arn: "SecretArn", # required
                role_arn: "RoleArn", # required
              },
            },
          },
          rtp: {
            port: 1, # required
            forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
      ],
      source_priority_mode: "NO_PRIORITY", # required, accepts NO_PRIORITY, PRIMARY_SECONDARY
      primary_source_index: 1,
    },
    media_connect_flow: {
      flow_arn: "FlowArn",
      flow_output_arn: "FlowOutputArn",
      source_transit_decryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    merge: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configurations: [ # required
        {
          rtp: {
            port: 1, # required
            forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
          },
          rist: {
            port: 1, # required
            recovery_latency_milliseconds: 1, # required
          },
        },
      ],
      merge_recovery_window_milliseconds: 1, # required
    },
  },
  maximum_bitrate: 1,
  routing_scope: "REGIONAL", # accepts REGIONAL, GLOBAL
  tier: "INPUT_100", # accepts INPUT_100, INPUT_50, INPUT_20
  transit_encryption: {
    encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
    encryption_key_configuration: { # required
      secrets_manager: {
        secret_arn: "SecretArn", # required
        role_arn: "RoleArn", # required
      },
      automatic: {
      },
    },
  },
  maintenance_configuration: {
    preferred_day_time: {
      day: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      time: "String", # required
    },
    default: {
    },
  },
  content_quality_analysis_configuration: {
    content_level: {
      black_frames: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
      frozen_frames: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
      silent_audio: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        threshold_seconds: 1, # required
      },
    },
  },
})

    
      
        
Response structure

      
      

resp.router_input.name #=> String
resp.router_input.arn #=> String
resp.router_input.id #=> String
resp.router_input.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_input.input_type #=> String, one of "STANDARD", "FAILOVER", "MERGE", "MEDIACONNECT_FLOW", "MEDIALIVE_CHANNEL"
resp.router_input.configuration.standard.network_interface_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rist.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_address #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.source_port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.standard.protocol_configuration.rtp.port #=> Integer
resp.router_input.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_input.configuration.media_live_channel.media_live_channel_arn #=> String
resp.router_input.configuration.media_live_channel.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_input.configuration.media_live_channel.media_live_channel_output_name #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_live_channel.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.failover.network_interface_arn #=> String
resp.router_input.configuration.failover.protocol_configurations #=> Array
resp.router_input.configuration.failover.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_listener.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_address #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.source_port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.stream_id #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.secret_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].srt_caller.decryption_configuration.encryption_key.role_arn #=> String
resp.router_input.configuration.failover.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.failover.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.failover.source_priority_mode #=> String, one of "NO_PRIORITY", "PRIMARY_SECONDARY"
resp.router_input.configuration.failover.primary_source_index #=> Integer
resp.router_input.configuration.media_connect_flow.flow_arn #=> String
resp.router_input.configuration.media_connect_flow.flow_output_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.configuration.media_connect_flow.source_transit_decryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.configuration.merge.network_interface_arn #=> String
resp.router_input.configuration.merge.protocol_configurations #=> Array
resp.router_input.configuration.merge.protocol_configurations[0].rtp.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_input.configuration.merge.protocol_configurations[0].rist.port #=> Integer
resp.router_input.configuration.merge.protocol_configurations[0].rist.recovery_latency_milliseconds #=> Integer
resp.router_input.configuration.merge.merge_recovery_window_milliseconds #=> Integer
resp.router_input.routed_outputs #=> Integer
resp.router_input.maximum_routed_outputs #=> Integer
resp.router_input.region_name #=> String
resp.router_input.availability_zone #=> String
resp.router_input.maximum_bitrate #=> Integer
resp.router_input.tier #=> String, one of "INPUT_100", "INPUT_50", "INPUT_20"
resp.router_input.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_input.created_at #=> Time
resp.router_input.updated_at #=> Time
resp.router_input.messages #=> Array
resp.router_input.messages[0].code #=> String
resp.router_input.messages[0].message #=> String
resp.router_input.transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_input.transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_input.tags #=> Hash
resp.router_input.tags["String"] #=> String
resp.router_input.stream_details.standard.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.failover.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.failover.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_zero_stream_details.source_ip_address #=> String
resp.router_input.stream_details.merge.source_index_one_stream_details.source_index #=> Integer
resp.router_input.stream_details.merge.source_index_one_stream_details.source_ip_address #=> String
resp.router_input.ip_address #=> String
resp.router_input.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_input.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_input.maintenance_configuration.preferred_day_time.time #=> String
resp.router_input.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_input.maintenance_schedule.window.start #=> Time
resp.router_input.maintenance_schedule.window.end #=> Time
resp.router_input.maintenance_schedule.window.scheduled_time #=> Time
resp.router_input.content_quality_analysis_type #=> String, one of "CONTENT_LEVEL"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.black_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.frozen_frames.threshold_seconds #=> Integer
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.state #=> String, one of "ENABLED", "DISABLED"
resp.router_input.content_quality_analysis_configuration.content_level.silent_audio.threshold_seconds #=> Integer

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router input that you want to
update.
    
          
        
    • 
      
        
  • 
          :name
          (String)
          
            
          
          
            — 
    The updated name for the router input.
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::RouterInputConfiguration)
          
            
          
          
            — 
    The updated configuration settings for the router input. Changing the
type of the configuration is not supported.
    
          
        
    • 
      
        
  • 
          :maximum_bitrate
          (Integer)
          
            
          
          
            — 
    The updated maximum bitrate for the router input.
    
          
        
    • 
      
        
  • 
          :routing_scope
          (String)
          
            
          
          
            — 
    Specifies whether the router input can be assigned to outputs in
different Regions. REGIONAL (default) - can be assigned only to
outputs in the same Region. GLOBAL - can be assigned to outputs in any
Region.
    
          
        
    • 
      
        
  • 
          :tier
          (String)
          
            
          
          
            — 
    The updated tier level for the router input.
    
          
        
    • 
      
        
  • 
          :transit_encryption
          (Types::RouterInputTransitEncryption)
          
            
          
          
            — 
    The updated transit encryption settings for the router input.
    
          
        
    • 
      
        
  • 
          :maintenance_configuration
          (Types::MaintenanceConfiguration)
          
            
          
          
            — 
    The updated maintenance configuration settings for the router input,
including any changes to preferred maintenance windows and schedules.
    
          
        
    • 
      
        
  • 
          :content_quality_analysis_configuration
          (Types::RouterContentQualityAnalysisConfiguration)
          
            
          
          
            — 
    The content quality analysis configuration for the router input.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1203

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

def update_router_input: (

    		
  





    
      

  

  
    #update_router_network_interface(params = {})  ⇒ Types::UpdateRouterNetworkInterfaceResponse 
  

  

  


  

    
Updates the configuration of an existing router network interface in
AWS Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_router_network_interface({
  arn: "RouterNetworkInterfaceArn", # required
  name: "UpdateRouterNetworkInterfaceRequestNameString",
  configuration: {
    public: {
      allow_rules: [ # required
        {
          cidr: "PublicRouterNetworkInterfaceRuleCidrString", # required
        },
      ],
    },
    vpc: {
      security_group_ids: ["String"], # required
      subnet_id: "String", # required
    },
  },
})

    
      
        
Response structure

      
      

resp.router_network_interface.name #=> String
resp.router_network_interface.arn #=> String
resp.router_network_interface.id #=> String
resp.router_network_interface.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR", "RECOVERING"
resp.router_network_interface.network_interface_type #=> String, one of "PUBLIC", "VPC"
resp.router_network_interface.configuration.public.allow_rules #=> Array
resp.router_network_interface.configuration.public.allow_rules[0].cidr #=> String
resp.router_network_interface.configuration.vpc.security_group_ids #=> Array
resp.router_network_interface.configuration.vpc.security_group_ids[0] #=> String
resp.router_network_interface.configuration.vpc.subnet_id #=> String
resp.router_network_interface.associated_output_count #=> Integer
resp.router_network_interface.associated_input_count #=> Integer
resp.router_network_interface.region_name #=> String
resp.router_network_interface.created_at #=> Time
resp.router_network_interface.updated_at #=> Time
resp.router_network_interface.tags #=> Hash
resp.router_network_interface.tags["String"] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router network interface that
you want to update.
    
          
        
    • 
      
        
  • 
          :name
          (String)
          
            
          
          
            — 
    The updated name for the router network interface.
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::RouterNetworkInterfaceConfiguration)
          
            
          
          
            — 
    The updated configuration settings for the router network interface.
Changing the type of the configuration is not supported.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1221

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

def update_router_network_interface: (

    		
  





    
      

  

  
    #update_router_output(params = {})  ⇒ Types::UpdateRouterOutputResponse 
  

  

  


  

    
Updates the configuration of an existing router output in AWS
Elemental MediaConnect.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_router_output({
  arn: "RouterOutputArn", # required
  name: "UpdateRouterOutputRequestNameString",
  configuration: {
    standard: {
      network_interface_arn: "RouterNetworkInterfaceArn", # required
      protocol_configuration: { # required
        rist: {
          destination_address: "String", # required
          destination_port: 1, # required
        },
        srt_listener: {
          port: 1, # required
          minimum_latency_milliseconds: 1, # required
          encryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        srt_caller: {
          destination_address: "String", # required
          destination_port: 1, # required
          minimum_latency_milliseconds: 1, # required
          stream_id: "String",
          encryption_configuration: {
            encryption_key: { # required
              secret_arn: "SecretArn", # required
              role_arn: "RoleArn", # required
            },
          },
        },
        rtp: {
          destination_address: "String", # required
          destination_port: 1, # required
          forward_error_correction: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      protocol: "RTP", # accepts RTP, RIST, SRT_CALLER, SRT_LISTENER
    },
    media_connect_flow: {
      flow_arn: "FlowArn",
      flow_source_arn: "FlowSourceArn",
      destination_transit_encryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
    media_live_input: {
      media_live_input_arn: "MediaLiveInputArn",
      media_live_pipeline_id: "PIPELINE_0", # accepts PIPELINE_0, PIPELINE_1
      destination_transit_encryption: { # required
        encryption_key_type: "SECRETS_MANAGER", # accepts SECRETS_MANAGER, AUTOMATIC
        encryption_key_configuration: { # required
          secrets_manager: {
            secret_arn: "SecretArn", # required
            role_arn: "RoleArn", # required
          },
          automatic: {
          },
        },
      },
    },
  },
  maximum_bitrate: 1,
  routing_scope: "REGIONAL", # accepts REGIONAL, GLOBAL
  tier: "OUTPUT_100", # accepts OUTPUT_100, OUTPUT_50, OUTPUT_20
  maintenance_configuration: {
    preferred_day_time: {
      day: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      time: "String", # required
    },
    default: {
    },
  },
  fabric_configuration: {
    recovery_latency_mode: "BALANCED", # required, accepts BALANCED, LOW_LATENCY
  },
})

    
      
        
Response structure

      
      

resp.router_output.name #=> String
resp.router_output.arn #=> String
resp.router_output.id #=> String
resp.router_output.state #=> String, one of "CREATING", "STANDBY", "STARTING", "ACTIVE", "STOPPING", "DELETING", "UPDATING", "ERROR", "RECOVERING", "MIGRATING"
resp.router_output.output_type #=> String, one of "STANDARD", "MEDIACONNECT_FLOW", "MEDIALIVE_INPUT"
resp.router_output.configuration.standard.network_interface_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rist.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_listener.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.minimum_latency_milliseconds #=> Integer
resp.router_output.configuration.standard.protocol_configuration.srt_caller.stream_id #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.secret_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.srt_caller.encryption_configuration.encryption_key.role_arn #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_address #=> String
resp.router_output.configuration.standard.protocol_configuration.rtp.destination_port #=> Integer
resp.router_output.configuration.standard.protocol_configuration.rtp.forward_error_correction #=> String, one of "ENABLED", "DISABLED"
resp.router_output.configuration.standard.protocol #=> String, one of "RTP", "RIST", "SRT_CALLER", "SRT_LISTENER"
resp.router_output.configuration.media_connect_flow.flow_arn #=> String
resp.router_output.configuration.media_connect_flow.flow_source_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_connect_flow.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.configuration.media_live_input.media_live_input_arn #=> String
resp.router_output.configuration.media_live_input.media_live_pipeline_id #=> String, one of "PIPELINE_0", "PIPELINE_1"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_type #=> String, one of "SECRETS_MANAGER", "AUTOMATIC"
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.secret_arn #=> String
resp.router_output.configuration.media_live_input.destination_transit_encryption.encryption_key_configuration.secrets_manager.role_arn #=> String
resp.router_output.routed_state #=> String, one of "ROUTED", "ROUTING", "UNROUTED"
resp.router_output.region_name #=> String
resp.router_output.availability_zone #=> String
resp.router_output.maximum_bitrate #=> Integer
resp.router_output.routing_scope #=> String, one of "REGIONAL", "GLOBAL"
resp.router_output.tier #=> String, one of "OUTPUT_100", "OUTPUT_50", "OUTPUT_20"
resp.router_output.created_at #=> Time
resp.router_output.updated_at #=> Time
resp.router_output.messages #=> Array
resp.router_output.messages[0].code #=> String
resp.router_output.messages[0].message #=> String
resp.router_output.tags #=> Hash
resp.router_output.tags["String"] #=> String
resp.router_output.stream_details.standard.destination_ip_address #=> String
resp.router_output.ip_address #=> String
resp.router_output.routed_input_arn #=> String
resp.router_output.maintenance_type #=> String, one of "PREFERRED_DAY_TIME", "DEFAULT"
resp.router_output.maintenance_configuration.preferred_day_time.day #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.router_output.maintenance_configuration.preferred_day_time.time #=> String
resp.router_output.maintenance_schedule_type #=> String, one of "WINDOW"
resp.router_output.maintenance_schedule.window.start #=> Time
resp.router_output.maintenance_schedule.window.end #=> Time
resp.router_output.maintenance_schedule.window.scheduled_time #=> Time
resp.router_output.fabric_configuration.recovery_latency_mode #=> String, one of "BALANCED", "LOW_LATENCY"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the router output that you want to
update.
    
          
        
    • 
      
        
  • 
          :name
          (String)
          
            
          
          
            — 
    The updated name for the router output.
    
          
        
    • 
      
        
  • 
          :configuration
          (Types::RouterOutputConfiguration)
          
            
          
          
            — 
    The updated configuration settings for the router output. Changing the
type of the configuration is not supported.
    
          
        
    • 
      
        
  • 
          :maximum_bitrate
          (Integer)
          
            
          
          
            — 
    The updated maximum bitrate for the router output.
    
          
        
    • 
      
        
  • 
          :routing_scope
          (String)
          
            
          
          
            — 
    Specifies whether the router output can take inputs that are in
different Regions. REGIONAL (default) - can only take inputs from same
Region. GLOBAL - can take inputs from any Region.
    
          
        
    • 
      
        
  • 
          :tier
          (String)
          
            
          
          
            — 
    The updated tier level for the router output.
    
          
        
    • 
      
        
  • 
          :maintenance_configuration
          (Types::MaintenanceConfiguration)
          
            
          
          
            — 
    The updated maintenance configuration settings for the router output,
including any changes to preferred maintenance windows and schedules.
    
          
        
    • 
      
        
  • 
          :fabric_configuration
          (Types::FabricConfiguration)
          
            
          
          
            — 
    The updated fabric configuration settings for the router output. You
cannot update the fabric configuration while the output has an active
route. You must unroute the output before updating the fabric
configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1233

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

def update_router_output: (

    		
  





    
      

  

  
    #wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean 
  

  

  


  

    
Polls an API operation until a resource enters a desired state.


Basic Usage


A waiter will call an API operation until:


    

  • It is successful
    • 

  • It enters a terminal state
    • 

  • It makes the maximum number of attempts
    • 



In between attempts, the waiter will sleep.


# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)



Configuration


You can configure the maximum number of polling attempts, and the
delay (in seconds) between each polling attempt. You can pass
configuration as the final arguments hash.


# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})



Callbacks


You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.


started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})



Handling Errors


When a waiter is unsuccessful, it will raise an error.
All of the failure errors extend from
Waiters::Errors::WaiterFailed.


begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end



Valid Waiters


The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.






waiter_name
params
:delay
:max_attempts






flow_active
#describe_flow
3
40




flow_deleted
#describe_flow
3
40




flow_standby
#describe_flow
3
40




input_active
#get_router_input
3
40




input_deleted
#get_router_input
3
40




input_standby
#get_router_input
3
40




output_active
#get_router_output
3
40




output_deleted
#get_router_output
3
40




output_routed
#get_router_output
3
40




output_standby
#get_router_output
3
40




output_unrouted
#get_router_output
3
40






  





  
Parameters:


    
  
    
  • 
      
        waiter_name
      
      
        (Symbol)
      
      
      
    
    • 
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  
    
  • 
      
        options
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
    
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :max_attempts
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :delay
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :before_attempt
          (Proc)
          
            
          
          
        
    • 
      
        
  • 
          :before_wait
          (Proc)
          
            
          
          
        
    • 
      
    

  


Yields:


    
  
    
  • 
      
      
        (w.waiter)
      
      
      
    
    • 
  



Returns:


    
  
    
  • 
      
      
        (Boolean)
      
      
      
        —
        
    Returns true if the waiter was successful.
    
      
    
    • 
  



Raises:


    
  
    
  • 
      
      
        (Errors::FailureStateError)
      
      
      
        —
        
    Raised when the waiter terminates
because the waiter has entered a state that it will not transition
out of, preventing success.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::TooManyAttemptsError)
      
      
      
        —
        
    Raised when the configured
maximum number of attempts have been made, and the waiter is not
yet successful.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::UnexpectedError)
      
      
      
        —
        
    Raised when an error is encounted
while polling for a resource that is not expected.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::NoSuchWaiterError)
      
      
      
        —
        
    Raised when you request to wait
for an unknown state.
    
      
    
    • 
  





  

    
      


1248

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

def wait_until: (:flow_active waiter_name,

    		
  





    
      

  

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



  





  



  

    
      


7519
7520
7521

    		
    
      
# File 'lib/aws-sdk-mediaconnect/client.rb', line 7519

def waiter_names
  waiters.keys
end