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

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

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



309
310
311
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 309

def initialize(*args)
  super
end

Instance Method Details

#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: "__string", # required
  outputs: [ # required
    {
      cidr_allow_list: ["__string"],
      description: "__string",
      destination: "__string",
      encryption: {
        algorithm: "aes128", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      max_latency: 1,
      name: "__string",
      port: 1,
      protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
      remote_id: "__string",
      smoothing_latency: 1,
      stream_id: "__string",
      vpc_interface_attachment: {
        vpc_interface_name: "__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"
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].media_live_input_arn #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.outputs[0].transport.remote_id #=> String
resp.outputs[0].transport.smoothing_latency #=> Integer
resp.outputs[0].transport.stream_id #=> String
resp.outputs[0].vpc_interface_attachment.vpc_interface_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String)
  • :outputs (required, Array<Types::AddOutputRequest>) —

    A list of outputs that you want to add.

Returns:

See Also:



397
398
399
400
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 397

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 flow

Examples:

Request syntax with placeholder values


resp = client.add_flow_sources({
  flow_arn: "__string", # required
  sources: [ # required
    {
      decryption: {
        algorithm: "aes128", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      description: "__string",
      entitlement_arn: "__string",
      ingest_port: 1,
      max_bitrate: 1,
      max_latency: 1,
      name: "__string",
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
      stream_id: "__string",
      vpc_interface_name: "__string",
      whitelist_cidr: "__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"
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].name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.sources[0].transport.remote_id #=> String
resp.sources[0].transport.smoothing_latency #=> Integer
resp.sources[0].transport.stream_id #=> String
resp.sources[0].vpc_interface_name #=> String
resp.sources[0].whitelist_cidr #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String)
  • :sources (required, Array<Types::SetSourceRequest>) —

    A list of sources that you want to add.

Returns:

See Also:



480
481
482
483
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 480

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 flow

Examples:

Request syntax with placeholder values


resp = client.add_flow_vpc_interfaces({
  flow_arn: "__string", # required
  vpc_interfaces: [ # required
    {
      name: "__string", # required
      role_arn: "__string", # required
      security_group_ids: ["__string"], # required
      subnet_id: "__string", # required
    },
  ],
})

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].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)
  • :vpc_interfaces (required, Array<Types::VpcInterfaceRequest>) —

    A list of VPC interfaces that you want to add.

Returns:

See Also:



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

def add_flow_vpc_interfaces(params = {}, options = {})
  req = build_request(:add_flow_vpc_interfaces, 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", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      name: "__string",
      subscribers: ["__string"], # required
    },
  ],
  name: "__string", # required
  outputs: [
    {
      cidr_allow_list: ["__string"],
      description: "__string",
      destination: "__string",
      encryption: {
        algorithm: "aes128", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      max_latency: 1,
      name: "__string",
      port: 1,
      protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
      remote_id: "__string",
      smoothing_latency: 1,
      stream_id: "__string",
      vpc_interface_attachment: {
        vpc_interface_name: "__string",
      },
    },
  ],
  source: {
    decryption: {
      algorithm: "aes128", # required, accepts aes128, aes192, aes256
      constant_initialization_vector: "__string",
      device_id: "__string",
      key_type: "speke", # accepts speke, static-key
      region: "__string",
      resource_id: "__string",
      role_arn: "__string", # required
      secret_arn: "__string",
      url: "__string",
    },
    description: "__string",
    entitlement_arn: "__string",
    ingest_port: 1,
    max_bitrate: 1,
    max_latency: 1,
    name: "__string",
    protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
    stream_id: "__string",
    vpc_interface_name: "__string",
    whitelist_cidr: "__string",
  },
  source_failover_config: {
    recovery_window: 1,
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  sources: [
    {
      decryption: {
        algorithm: "aes128", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      description: "__string",
      entitlement_arn: "__string",
      ingest_port: 1,
      max_bitrate: 1,
      max_latency: 1,
      name: "__string",
      protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
      stream_id: "__string",
      vpc_interface_name: "__string",
      whitelist_cidr: "__string",
    },
  ],
  vpc_interfaces: [
    {
      name: "__string", # required
      role_arn: "__string", # required
      security_group_ids: ["__string"], # required
      subnet_id: "__string", # 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"
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].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> 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"
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].media_live_input_arn #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> 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"
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.name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source_failover_config.recovery_window #=> Integer
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"
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].name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> 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].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

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

  • :entitlements (Array<Types::GrantEntitlementRequest>) —

    The entitlements that you want to grant on a 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 of the flow.

  • :source_failover_config (Types::FailoverConfig) —

    The settings for source failover

  • :sources (Array<Types::SetSourceRequest>)
  • :vpc_interfaces (Array<Types::VpcInterfaceRequest>) —

    The VPC interfaces you want on the flow.

Returns:

See Also:



797
798
799
800
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 797

def create_flow(params = {}, options = {})
  req = build_request(:create_flow, 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: "__string", # 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)

Returns:

See Also:



826
827
828
829
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 826

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

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

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

Examples:

Request syntax with placeholder values


resp = client.describe_flow({
  flow_arn: "__string", # 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"
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].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> 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"
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].media_live_input_arn #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> 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"
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.name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source_failover_config.recovery_window #=> Integer
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"
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].name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> 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].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.messages.errors #=> Array
resp.messages.errors[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String)

Returns:

See Also:



969
970
971
972
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 969

def describe_flow(params = {}, options = {})
  req = build_request(:describe_flow, 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", # required, accepts aes128, aes192, aes256
        constant_initialization_vector: "__string",
        device_id: "__string",
        key_type: "speke", # accepts speke, static-key
        region: "__string",
        resource_id: "__string",
        role_arn: "__string", # required
        secret_arn: "__string",
        url: "__string",
      },
      name: "__string",
      subscribers: ["__string"], # required
    },
  ],
  flow_arn: "__string", # 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"
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].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):

Returns:

See Also:



1035
1036
1037
1038
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1035

def grant_flow_entitlements(params = {}, options = {})
  req = build_request(:grant_flow_entitlements, 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)
  • :next_token (String)

Returns:

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1073

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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1114
1115
1116
1117
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1114

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

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

List all tags on an AWS Elemental 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)

Returns:

See Also:



1142
1143
1144
1145
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1142

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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: "__string", # required
  output_arn: "__string", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String)
  • :output_arn (required, String)

Returns:

See Also:



1178
1179
1180
1181
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1178

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: "__string", # required
  source_arn: "__string", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :flow_arn (required, String)
  • :source_arn (required, String)

Returns:

See Also:



1211
1212
1213
1214
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1211

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: "__string", # 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)
  • :vpc_interface_name (required, String)

Returns:

See Also:



1250
1251
1252
1253
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1250

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: "__string", # required
  flow_arn: "__string", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :entitlement_arn (required, String)
  • :flow_arn (required, String)

Returns:

See Also:



1284
1285
1286
1287
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1284

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: "__string", # 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)

Returns:

See Also:



1313
1314
1315
1316
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1313

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: "__string", # 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)

Returns:

See Also:



1342
1343
1344
1345
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1342

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



1374
1375
1376
1377
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1374

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)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1398
1399
1400
1401
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1398

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

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

Updates flow

Examples:

Request syntax with placeholder values


resp = client.update_flow({
  flow_arn: "__string", # required
  source_failover_config: {
    recovery_window: 1,
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
})

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"
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].name #=> String
resp.flow.entitlements[0].subscribers #=> Array
resp.flow.entitlements[0].subscribers[0] #=> String
resp.flow.flow_arn #=> 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"
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].media_live_input_arn #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.outputs[0].transport.remote_id #=> String
resp.flow.outputs[0].transport.smoothing_latency #=> Integer
resp.flow.outputs[0].transport.stream_id #=> String
resp.flow.outputs[0].vpc_interface_attachment.vpc_interface_name #=> 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"
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.name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.source.transport.remote_id #=> String
resp.flow.source.transport.smoothing_latency #=> Integer
resp.flow.source.transport.stream_id #=> String
resp.flow.source.vpc_interface_name #=> String
resp.flow.source.whitelist_cidr #=> String
resp.flow.source_failover_config.recovery_window #=> Integer
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"
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].name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.flow.sources[0].transport.remote_id #=> String
resp.flow.sources[0].transport.smoothing_latency #=> Integer
resp.flow.sources[0].transport.stream_id #=> String
resp.flow.sources[0].vpc_interface_name #=> String
resp.flow.sources[0].whitelist_cidr #=> 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].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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1543
1544
1545
1546
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1543

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

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

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
    region: "__string",
    resource_id: "__string",
    role_arn: "__string",
    secret_arn: "__string",
    url: "__string",
  },
  entitlement_arn: "__string", # required
  flow_arn: "__string", # 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"
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.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 AWS Elemental 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.

  • :entitlement_arn (required, String)
  • :flow_arn (required, String)
  • :subscribers (Array<String>) —

    The AWS 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:



1618
1619
1620
1621
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1618

def update_flow_entitlement(params = {}, options = {})
  req = build_request(:update_flow_entitlement, 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
    region: "__string",
    resource_id: "__string",
    role_arn: "__string",
    secret_arn: "__string",
    url: "__string",
  },
  flow_arn: "__string", # required
  max_latency: 1,
  output_arn: "__string", # required
  port: 1,
  protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
  remote_id: "__string",
  smoothing_latency: 1,
  stream_id: "__string",
  vpc_interface_attachment: {
    vpc_interface_name: "__string",
  },
})

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"
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.media_live_input_arn #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.output.transport.remote_id #=> String
resp.output.transport.smoothing_latency #=> Integer
resp.output.transport.stream_id #=> String
resp.output.vpc_interface_attachment.vpc_interface_name #=> 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 AWS Elemental 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).

  • :flow_arn (required, String)
  • :max_latency (Integer) —

    The maximum latency in milliseconds for Zixi-based streams.

  • :output_arn (required, String)
  • :port (Integer) —

    The port to use when content is distributed to this output.

  • :protocol (String) —

    The protocol to use for the output.

  • :remote_id (String) —

    The remote ID for the Zixi-pull stream.

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

  • :vpc_interface_attachment (Types::VpcInterfaceAttachment) —

    The name of the VPC interface attachment to use for this output.

Returns:

See Also:



1737
1738
1739
1740
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1737

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
    region: "__string",
    resource_id: "__string",
    role_arn: "__string",
    secret_arn: "__string",
    url: "__string",
  },
  description: "__string",
  entitlement_arn: "__string",
  flow_arn: "__string", # required
  ingest_port: 1,
  max_bitrate: 1,
  max_latency: 1,
  protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp, zixi-pull, rist
  source_arn: "__string", # required
  stream_id: "__string",
  vpc_interface_name: "__string",
  whitelist_cidr: "__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"
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.name #=> 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.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist"
resp.source.transport.remote_id #=> String
resp.source.transport.smoothing_latency #=> Integer
resp.source.transport.stream_id #=> String
resp.source.vpc_interface_name #=> String
resp.source.whitelist_cidr #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :decryption (Types::UpdateEncryption) —

    The type of encryption used on the content ingested from this source.

  • :description (String) —

    A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

  • :entitlement_arn (String) —

    The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

  • :flow_arn (required, String)
  • :ingest_port (Integer) —

    The port that the flow will be listening on for incoming content.

  • :max_bitrate (Integer) —

    The smoothing max 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.

  • :protocol (String) —

    The protocol that is used by the source.

  • :source_arn (required, String)
  • :stream_id (String) —

    The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

  • :vpc_interface_name (String) —

    The name of the VPC Interface to configure this Source with.

  • :whitelist_cidr (String) —

    The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Returns:

See Also:



1851
1852
1853
1854
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1851

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