Class: Aws::MediaConnect::Client

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

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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :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 default value if no retry mode is provided.

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

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

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

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

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

    • Aws.config[: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.



473
474
475
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 473

def initialize(*args)
  super
end

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:



528
529
530
531
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 528

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

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



592
593
594
595
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 592

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

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



667
668
669
670
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 667

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

#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",
      },
    },
  ],
})

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

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:



807
808
809
810
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 807

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

#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",
        },
      },
      source_tags: {
        "String" => "String",
      },
    },
  ],
})

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

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:



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

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

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



993
994
995
996
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 993

def add_flow_vpc_interfaces(params = {}, options = {})
  req = build_request(:add_flow_vpc_interfaces, params)
  req.send_request(options)
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:



1128
1129
1130
1131
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1128

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

#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",
      },
    },
  ],
  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",
      },
    },
    source_tags: {
      "String" => "String",
    },
  },
  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",
        },
      },
      source_tags: {
        "String" => "String",
      },
    },
  ],
  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
  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_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].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.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.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_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].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.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"
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

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 outputs on the flow.

  • :ndi_config (Types::NdiConfig) —

    Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.

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

    The key-value pairs that can be used to tag and organize the flow.

Returns:

See Also:



1691
1692
1693
1694
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1691

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

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



1748
1749
1750
1751
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1748

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

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



1777
1778
1779
1780
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1777

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

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



1807
1808
1809
1810
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1807

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

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



1836
1837
1838
1839
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1836

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

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



1875
1876
1877
1878
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1875

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

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



1941
1942
1943
1944
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1941

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

#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].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.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.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_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].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.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"
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.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:



2197
2198
2199
2200
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2197

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

#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

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String) —

    The Amazon Resource Name (ARN) of the flow.

Returns:

See Also:



2251
2252
2253
2254
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2251

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

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



2286
2287
2288
2289
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2286

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

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



2327
2328
2329
2330
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2327

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

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



2366
2367
2368
2369
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2366

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

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



2404
2405
2406
2407
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2404

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

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



2448
2449
2450
2451
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2448

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

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



2521
2522
2523
2524
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2521

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

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



2584
2585
2586
2587
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2584

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

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



2639
2640
2641
2642
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2639

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

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



2701
2702
2703
2704
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2701

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

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



2764
2765
2766
2767
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2764

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

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



2819
2820
2821
2822
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2819

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

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



2883
2884
2885
2886
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2883

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

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



2950
2951
2952
2953
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2950

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

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

List all tags on a MediaConnect resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the MediaConnect resource for which to list the tags.

Returns:

See Also:



2980
2981
2982
2983
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2980

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

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



3038
3039
3040
3041
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3038

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

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



3072
3073
3074
3075
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3072

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

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



3106
3107
3108
3109
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3106

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

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



3141
3142
3143
3144
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3141

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

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



3180
3181
3182
3183
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3180

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

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



3216
3217
3218
3219
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3216

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

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



3258
3259
3260
3261
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3258

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

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



3295
3296
3297
3298
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3295

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

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



3325
3326
3327
3328
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3325

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

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



3355
3356
3357
3358
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3355

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

#tag_resource(params = {}) ⇒ Struct

Associates the specified tags to a resource with the specified resourceArn. 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:



3389
3390
3391
3392
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3389

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

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

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:



3415
3416
3417
3418
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3415

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

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



3506
3507
3508
3509
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3506

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

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



3558
3559
3560
3561
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3558

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

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



3622
3623
3624
3625
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3622

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

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



3657
3658
3659
3660
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3657

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

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

Updates an existing flow.

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

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].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.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.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_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].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.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"
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

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 NDI outputs. Required when the flow includes NDI outputs.

  • :flow_size (String) —

    Determines the processing capacity and feature set of the flow.

Returns:

See Also:



3966
3967
3968
3969
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3966

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

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



4054
4055
4056
4057
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4054

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

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



4135
4136
4137
4138
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4135

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

#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,
})

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

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 names of the NDI sources 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.

Returns:

See Also:



4345
4346
4347
4348
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4345

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

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

Updates the source of a flow.

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",
    },
  },
})

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

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.

Returns:

See Also:



4550
4551
4552
4553
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4550

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

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



4585
4586
4587
4588
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4585

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

#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

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.



4702
4703
4704
4705
4706
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4702

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end