Class: Aws::RTBFabric::Client

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

Overview

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

client = Aws::RTBFabric::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::RTBFabric::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::RTBFabric::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-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

Accepts a link request between gateways.

When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.

Examples:

Example: Accept a link request


# Accepts a link request from requester gateway

resp = client.accept_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  log_settings: {
    application_logs: {
      sampling: {
        error_log: 100.0, 
        filter_log: 0.0, 
      }, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  peer_gateway_id: "rtb-gw-87654321", 
  status: "ACCEPTED", 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
}

Request syntax with placeholder values


resp = client.accept_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  attributes: {
    responder_error_masking: [
      {
        http_code: "ResponderErrorMaskingForHttpCodeHttpCodeString", # required
        action: "NO_BID", # required, accepts NO_BID, PASSTHROUGH
        logging_types: ["NONE"], # required, accepts NONE, METRIC, RESPONSE
        response_logging_percentage: 1.0,
      },
    ],
    customer_provided_id: "CustomerProvidedId",
  },
  log_settings: { # required
    application_logs: { # required
      sampling: { # required
        error_log: 1.0, # required
        filter_log: 1.0, # required
      },
    },
  },
  timeout_in_millis: 1,
})

Response structure


resp.gateway_id #=> String
resp.peer_gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.direction #=> String, one of "RESPONSE", "REQUEST"
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"
resp.link_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :attributes (Types::LinkAttributes) —

    Attributes of the link.

  • :log_settings (required, Types::LinkLogSettings) —

    Settings for the application logs.

  • :timeout_in_millis (Integer) —

    The timeout value in milliseconds.

Returns:

See Also:



632
633
634
635
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 632

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

#associate_certificate(params = {}) ⇒ Types::AssociateCertificateResponse

Associates an ACM certificate with a responder gateway.

Examples:

Example: Associate a certificate with a responder gateway


# Associate an ACM certificate with a responder gateway

resp = client.associate_certificate({
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  client_token: "550e8400-e29b-41d4-a716-446655440000", 
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_ASSOCIATION", 
}

Request syntax with placeholder values


resp = client.associate_certificate({
  gateway_id: "GatewayId", # required
  acm_certificate_arn: "AcmCertificateArn", # required
  client_token: "String", # required
})

Response structure


resp.gateway_id #=> String
resp.acm_certificate_arn #=> String
resp.status #=> String, one of "PENDING_ASSOCIATION", "ASSOCIATED", "PENDING_DISASSOCIATION", "DISASSOCIATED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :acm_certificate_arn (required, String) —

    The Amazon Resource Name (ARN) of the ACM certificate to associate.

  • :client_token (required, String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

Returns:

See Also:



709
710
711
712
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 709

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

#create_inbound_external_link(params = {}) ⇒ Types::CreateInboundExternalLinkResponse

Creates an inbound external link.

Examples:

Example: Create an inbound external link


# Create an inbound external link for a responder gateway

resp = client.create_inbound_external_link({
  client_token: "randomClientToken", 
  gateway_id: "rtb-gw-12345678", 
  log_settings: {
    application_logs: {
      sampling: {
        error_log: 100.0, 
        filter_log: 0.0, 
      }, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  domain_name: "rtb-gw-12345678.example.com", 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.create_inbound_external_link({
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  attributes: {
    responder_error_masking: [
      {
        http_code: "ResponderErrorMaskingForHttpCodeHttpCodeString", # required
        action: "NO_BID", # required, accepts NO_BID, PASSTHROUGH
        logging_types: ["NONE"], # required, accepts NONE, METRIC, RESPONSE
        response_logging_percentage: 1.0,
      },
    ],
    customer_provided_id: "CustomerProvidedId",
  },
  log_settings: { # required
    application_logs: { # required
      sampling: { # required
        error_log: 1.0, # required
        filter_log: 1.0, # required
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.domain_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The unique client token.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :attributes (Types::LinkAttributes) —

    Attributes of the link.

  • :log_settings (required, Types::LinkLogSettings) —

    Settings for the application logs.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



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

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

#create_link(params = {}) ⇒ Types::CreateLinkResponse

Creates a new link between gateways.

Establishes a connection that allows gateways to communicate and exchange bid requests and responses.

Examples:

Example: Create a standard link between gateways


# Creates a new link between two RTB applications. Requires peerGatewayId to specify the target gateway.

resp = client.create_link({
  gateway_id: "rtb-gw-12345678", 
  log_settings: {
    application_logs: {
      sampling: {
        error_log: 100.0, 
        filter_log: 0.0, 
      }, 
    }, 
  }, 
  peer_gateway_id: "rtb-gw-87654321", 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  peer_gateway_id: "rtb-gw-87654321", 
  status: "PENDING_REQUEST", 
  updated_at: Time.parse("2024-01-15T10:30:00Z"), 
}

Request syntax with placeholder values


resp = client.create_link({
  gateway_id: "GatewayId", # required
  peer_gateway_id: "GatewayId", # required
  attributes: {
    responder_error_masking: [
      {
        http_code: "ResponderErrorMaskingForHttpCodeHttpCodeString", # required
        action: "NO_BID", # required, accepts NO_BID, PASSTHROUGH
        logging_types: ["NONE"], # required, accepts NONE, METRIC, RESPONSE
        response_logging_percentage: 1.0,
      },
    ],
    customer_provided_id: "CustomerProvidedId",
  },
  http_responder_allowed: false,
  tags: {
    "TagKey" => "TagValue",
  },
  log_settings: { # required
    application_logs: { # required
      sampling: { # required
        error_log: 1.0, # required
        filter_log: 1.0, # required
      },
    },
  },
  timeout_in_millis: 1,
})

Response structure


resp.gateway_id #=> String
resp.peer_gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.direction #=> String, one of "RESPONSE", "REQUEST"
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"
resp.link_id #=> String
resp.customer_provided_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :peer_gateway_id (required, String) —

    The unique identifier of the peer gateway.

  • :attributes (Types::LinkAttributes) —

    Attributes of the link.

  • :http_responder_allowed (Boolean) —

    Boolean to specify if an HTTP responder is allowed.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

  • :log_settings (required, Types::LinkLogSettings) —

    Settings for the application logs.

  • :timeout_in_millis (Integer) —

    The timeout value in milliseconds.

Returns:

See Also:



978
979
980
981
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 978

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

#create_link_routing_rule(params = {}) ⇒ Types::CreateLinkRoutingRuleResponse

Creates a routing rule for a link.

Routing rules use priority-based evaluation where lower priority numbers are evaluated first. Each rule specifies conditions that must all match for the rule to apply.

Examples:

Example: Create a link routing rule


# Create a routing rule with host header and path prefix conditions

resp = client.create_link_routing_rule({
  client_token: "550e8400-e29b-41d4-a716-446655440000", 
  conditions: {
    host_header: "api.customer.com", 
    path_prefix: "/openrtb/", 
  }, 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  priority: 10, 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-01T12:00:00Z"), 
  rule_id: "rule-abc123def456", 
  status: "CREATION_IN_PROGRESS", 
}

Request syntax with placeholder values


resp = client.create_link_routing_rule({
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  priority: 1, # required
  conditions: { # required
    host_header: "RuleConditionHostHeaderString",
    host_header_wildcard: "RuleConditionHostHeaderWildcardString",
    path_prefix: "RuleConditionPathPrefixString",
    path_exact: "RuleConditionPathExactString",
    query_string_equals: {
      key: "QueryStringKeyValuePairKeyString", # required
      value: "QueryStringKeyValuePairValueString", # required
    },
    query_string_exists: "RuleConditionQueryStringExistsString",
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.rule_id #=> String
resp.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETION_IN_PROGRESS", "DELETED", "FAILED"
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :priority (required, Integer) —

    The priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.

  • :conditions (required, Types::RuleCondition) —

    The conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



1092
1093
1094
1095
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1092

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

#create_outbound_external_link(params = {}) ⇒ Types::CreateOutboundExternalLinkResponse

Creates an outbound external link.

Examples:

Example: Create an outbound external link


# Create an outbound external link for a requester gateway to connect to external public responder endpoints

resp = client.create_outbound_external_link({
  client_token: "12345678-1234-1234-1234-123456789012", 
  gateway_id: "rtb-gw-12345678", 
  log_settings: {
    application_logs: {
      sampling: {
        error_log: 100.0, 
        filter_log: 0.0, 
      }, 
    }, 
  }, 
  public_endpoint: "https://external-responder.example.com", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.create_outbound_external_link({
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  attributes: {
    responder_error_masking: [
      {
        http_code: "ResponderErrorMaskingForHttpCodeHttpCodeString", # required
        action: "NO_BID", # required, accepts NO_BID, PASSTHROUGH
        logging_types: ["NONE"], # required, accepts NONE, METRIC, RESPONSE
        response_logging_percentage: 1.0,
      },
    ],
    customer_provided_id: "CustomerProvidedId",
  },
  public_endpoint: "URL", # required
  log_settings: { # required
    application_logs: { # required
      sampling: { # required
        error_log: 1.0, # required
        filter_log: 1.0, # required
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The unique client token.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :attributes (Types::LinkAttributes) —

    Attributes of the link.

  • :public_endpoint (required, String) —

    The public endpoint of the link.

  • :log_settings (required, Types::LinkLogSettings) —

    Settings for the application logs.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



1193
1194
1195
1196
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1193

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

#create_requester_gateway(params = {}) ⇒ Types::CreateRequesterGatewayResponse

Creates a requester gateway.

Examples:

Example: Create a requester gateway


# Create requester gateway

resp = client.create_requester_gateway({
  client_token: "12345678-1234-1234-1234-123456789012", 
  description: "My requester gateway", 
  security_group_ids: [
    "sg-12345678", 
  ], 
  subnet_ids: [
    "subnet-12345678", 
    "subnet-87654321", 
  ], 
  vpc_id: "vpc-12345678", 
})

resp.to_h outputs the following:
{
  domain_name: "rtb-gw-12345678.example.com", 
  gateway_id: "rtb-gw-12345678", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.create_requester_gateway({
  vpc_id: "VpcId", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  client_token: "String", # required
  description: "CreateRequesterGatewayRequestDescriptionString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.gateway_id #=> String
resp.domain_name #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The unique identifier of the Virtual Private Cloud (VPC).

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

    The unique identifiers of the subnets.

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

    The unique identifiers of the security groups.

  • :client_token (required, String) —

    The unique client token.

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

  • :description (String) —

    An optional description for the requester gateway.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

See Also:



1276
1277
1278
1279
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1276

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

#create_responder_gateway(params = {}) ⇒ Types::CreateResponderGatewayResponse

Creates a responder gateway.

A domain name or managed endpoint is required.

Examples:

Example: Create a responder gateway


# Create responder gateway

resp = client.create_responder_gateway({
  client_token: "12345678-1234-1234-1234-123456789012", 
  description: "My responder gateway", 
  port: 443, 
  protocol: "HTTPS", 
  security_group_ids: [
    "sg-12345678", 
  ], 
  subnet_ids: [
    "subnet-12345678", 
    "subnet-87654321", 
  ], 
  vpc_id: "vpc-12345678", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.create_responder_gateway({
  vpc_id: "VpcId", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  domain_name: "DomainName",
  port: 1, # required
  protocol: "HTTP", # required, accepts HTTP, HTTPS
  listener_config: {
    protocols: ["HTTP"], # required, accepts HTTP, HTTPS
  },
  trust_store_configuration: {
    certificate_authority_certificates: ["Base64EncodedCertificateChain"], # required
  },
  managed_endpoint_configuration: {
    auto_scaling_groups: {
      auto_scaling_group_names: ["AutoScalingGroupName"], # required
      role_arn: "AutoScalingGroupsConfigurationRoleArnString", # required
      health_check_config: {
        port: 1, # required
        path: "HealthCheckConfigPathString", # required
        protocol: "HTTP", # accepts HTTP, HTTPS
        timeout_ms: 1,
        interval_seconds: 1,
        status_code_matcher: "StatusCodeMatcher",
        healthy_threshold_count: 1,
        unhealthy_threshold_count: 1,
      },
    },
    eks_endpoints: {
      endpoints_resource_name: "KubernetesEndpointsResourceName", # required
      endpoints_resource_namespace: "KubernetesNamespace", # required
      cluster_api_server_endpoint_uri: "URI", # required
      cluster_api_server_ca_certificate_chain: "Base64EncodedCertificateChain", # required
      cluster_name: "KubernetesClusterName", # required
      role_arn: "EksEndpointsConfigurationRoleArnString", # required
    },
  },
  client_token: "String", # required
  description: "CreateResponderGatewayRequestDescriptionString",
  tags: {
    "TagKey" => "TagValue",
  },
  gateway_type: "EXTERNAL", # accepts EXTERNAL, INTERNAL
})

Response structure


resp.gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"
resp.listener_config.protocols #=> Array
resp.listener_config.protocols[0] #=> String, one of "HTTP", "HTTPS"
resp.external_inbound_endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The unique identifier of the Virtual Private Cloud (VPC).

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

    The unique identifiers of the subnets.

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

    The unique identifiers of the security groups.

  • :domain_name (String) —

    The domain name for the responder gateway.

  • :port (required, Integer) —

    The networking port to use.

  • :protocol (required, String) —

    The networking protocol to use.

  • :listener_config (Types::ListenerConfig) —

    Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.

  • :trust_store_configuration (Types::TrustStoreConfiguration) —

    The configuration of the trust store.

  • :managed_endpoint_configuration (Types::ManagedEndpointConfiguration) —

    The configuration for the managed endpoint.

  • :client_token (required, String) —

    The unique client token.

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

  • :description (String) —

    An optional description for the responder gateway.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

  • :gateway_type (String) —

    The type of gateway. Valid values are EXTERNAL or INTERNAL.

Returns:

See Also:



1421
1422
1423
1424
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1421

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

#delete_inbound_external_link(params = {}) ⇒ Types::DeleteInboundExternalLinkResponse

Deletes an inbound external link.

Examples:

Example: Delete an inbound external link


# Delete an inbound external link

resp = client.delete_inbound_external_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  link_id: "link-87654321", 
  status: "DELETED", 
}

Request syntax with placeholder values


resp = client.delete_inbound_external_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



1471
1472
1473
1474
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1471

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

#delete_link(params = {}) ⇒ Types::DeleteLinkResponse

Deletes a link between gateways.

Permanently removes the connection between gateways. This action cannot be undone.

Examples:

Example: Delete a link


# Deletes an existing link

resp = client.delete_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  link_id: "link-87654321", 
  status: "PENDING_DELETION", 
}

Request syntax with placeholder values


resp = client.delete_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



1524
1525
1526
1527
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1524

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

#delete_link_routing_rule(params = {}) ⇒ Types::DeleteLinkRoutingRuleResponse

Deletes a routing rule from a link.

Examples:

Example: Delete a link routing rule


# Delete a link routing rule

resp = client.delete_link_routing_rule({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  rule_id: "rule-abc123def456", 
})

resp.to_h outputs the following:
{
  rule_id: "rule-abc123def456", 
  status: "DELETION_IN_PROGRESS", 
}

Request syntax with placeholder values


resp = client.delete_link_routing_rule({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  rule_id: "RuleId", # required
})

Response structure


resp.rule_id #=> String
resp.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETION_IN_PROGRESS", "DELETED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :rule_id (required, String) —

    The unique identifier of the routing rule.

Returns:

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1579

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

#delete_outbound_external_link(params = {}) ⇒ Types::DeleteOutboundExternalLinkResponse

Deletes an outbound external link.

Examples:

Example: Delete an outbound external link


# Delete an outbound external link

resp = client.delete_outbound_external_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  link_id: "link-87654321", 
  status: "DELETED", 
}

Request syntax with placeholder values


resp = client.delete_outbound_external_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



1629
1630
1631
1632
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1629

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

#delete_requester_gateway(params = {}) ⇒ Types::DeleteRequesterGatewayResponse

Deletes a requester gateway.

Examples:

Example: Delete a requester gateway


# Delete requester gateway

resp = client.delete_requester_gateway({
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_DELETION", 
}

Request syntax with placeholder values


resp = client.delete_requester_gateway({
  gateway_id: "GatewayId", # required
})

Response structure


resp.gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

Returns:

See Also:



1674
1675
1676
1677
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1674

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

#delete_responder_gateway(params = {}) ⇒ Types::DeleteResponderGatewayResponse

Deletes a responder gateway.

Examples:

Example: Delete a responder gateway


# Delete responder gateway

resp = client.delete_responder_gateway({
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_DELETION", 
}

Request syntax with placeholder values


resp = client.delete_responder_gateway({
  gateway_id: "GatewayId", # required
})

Response structure


resp.gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

Returns:

See Also:



1719
1720
1721
1722
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1719

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

#disassociate_certificate(params = {}) ⇒ Types::DisassociateCertificateResponse

Removes a certificate association from a responder gateway.

Examples:

Example: Disassociate a certificate from a responder gateway


# Remove an ACM certificate association from a responder gateway

resp = client.disassociate_certificate({
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_DISASSOCIATION", 
}

Request syntax with placeholder values


resp = client.disassociate_certificate({
  gateway_id: "GatewayId", # required
  acm_certificate_arn: "AcmCertificateArn", # required
})

Response structure


resp.gateway_id #=> String
resp.acm_certificate_arn #=> String
resp.status #=> String, one of "PENDING_ASSOCIATION", "ASSOCIATED", "PENDING_DISASSOCIATION", "DISASSOCIATED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :acm_certificate_arn (required, String) —

    The Amazon Resource Name (ARN) of the ACM certificate to disassociate.

Returns:

See Also:



1772
1773
1774
1775
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1772

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

#get_certificate_association(params = {}) ⇒ Types::GetCertificateAssociationResponse

Retrieves the details of a certificate association with a responder gateway.

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

  • certificate_associated
  • certificate_disassociated

Examples:

Example: Get certificate association details from a responder gateway


# Retrieve details of an ACM certificate association with a responder gateway

resp = client.get_certificate_association({
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
  associated_at: Time.parse(1704067200), 
  gateway_id: "rtb-gw-12345678", 
  status: "ASSOCIATED", 
  updated_at: Time.parse(1704067200), 
}

Request syntax with placeholder values


resp = client.get_certificate_association({
  gateway_id: "GatewayId", # required
  acm_certificate_arn: "AcmCertificateArn", # required
})

Response structure


resp.gateway_id #=> String
resp.acm_certificate_arn #=> String
resp.status #=> String, one of "PENDING_ASSOCIATION", "ASSOCIATED", "PENDING_DISASSOCIATION", "DISASSOCIATED", "FAILED"
resp.associated_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :acm_certificate_arn (required, String) —

    The Amazon Resource Name (ARN) of the ACM certificate.

Returns:

See Also:



1838
1839
1840
1841
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1838

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

#get_inbound_external_link(params = {}) ⇒ Types::GetInboundExternalLinkResponse

Retrieves information about an inbound external link.

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

  • inbound_external_link_active
  • inbound_external_link_deleted

Examples:

Example: Get inbound external link details


# Get details of an inbound external link

resp = client.get_inbound_external_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  domain_name: "rtb-gw-12345678.123456789012.gateway.rtbfabric.us-east-1.amazonaws.com", 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  status: "ACTIVE", 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
}

Request syntax with placeholder values


resp = client.get_inbound_external_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.domain_name #=> String
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



1962
1963
1964
1965
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1962

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

#get_link(params = {}) ⇒ Types::GetLinkResponse

Retrieves information about a link between gateways.

Returns detailed information about the link configuration, status, and associated gateways.

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

  • link_accepted
  • link_active
  • link_deleted

Examples:

Example: Get link details


# Retrieves details of a specific link

resp = client.get_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  peer_gateway_id: "rtb-gw-87654321", 
  status: "ACTIVE", 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
}

Request syntax with placeholder values


resp = client.get_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.gateway_id #=> String
resp.peer_gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.direction #=> String, one of "RESPONSE", "REQUEST"
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"
resp.link_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.http_responder_allowed #=> Boolean
resp.timeout_in_millis #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



2096
2097
2098
2099
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2096

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

#get_link_routing_rule(params = {}) ⇒ Types::GetLinkRoutingRuleResponse

Retrieves the details of a routing rule for a link.

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

  • link_routing_rule_active
  • link_routing_rule_deleted

Examples:

Example: Get link routing rule details


# Get details of a link routing rule

resp = client.get_link_routing_rule({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  rule_id: "rule-abc123def456", 
})

resp.to_h outputs the following:
{
  conditions: {
    host_header: "api.customer.com", 
    path_prefix: "/openrtb/", 
  }, 
  created_at: Time.parse("2024-01-01T12:00:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  priority: 10, 
  rule_id: "rule-abc123def456", 
  status: "ACTIVE", 
  updated_at: Time.parse("2024-01-01T12:00:00Z"), 
}

Request syntax with placeholder values


resp = client.get_link_routing_rule({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  rule_id: "RuleId", # required
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.rule_id #=> String
resp.priority #=> Integer
resp.conditions.host_header #=> String
resp.conditions.host_header_wildcard #=> String
resp.conditions.path_prefix #=> String
resp.conditions.path_exact #=> String
resp.conditions.query_string_equals.key #=> String
resp.conditions.query_string_equals.value #=> String
resp.conditions.query_string_exists #=> String
resp.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETION_IN_PROGRESS", "DELETED", "FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :rule_id (required, String) —

    The unique identifier of the routing rule.

Returns:

See Also:



2187
2188
2189
2190
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2187

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

#get_outbound_external_link(params = {}) ⇒ Types::GetOutboundExternalLinkResponse

Retrieves information about an outbound external link.

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

  • outbound_external_link_active
  • outbound_external_link_deleted

Examples:

Example: Get outbound external link details


# Get details of a specific outbound external link

resp = client.get_outbound_external_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  public_endpoint: "https://external-responder.example.com", 
  status: "ACTIVE", 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
}

Request syntax with placeholder values


resp = client.get_outbound_external_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.public_endpoint #=> String
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



2311
2312
2313
2314
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2311

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

#get_requester_gateway(params = {}) ⇒ Types::GetRequesterGatewayResponse

Retrieves information about a requester gateway.

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

  • requester_gateway_active
  • requester_gateway_deleted

Examples:

Example: Get requester gateway details


# Get requester gateway

resp = client.get_requester_gateway({
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  active_links_count: 2, 
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  description: "My requester gateway", 
  domain_name: "rtb-gw-12345678.example.com", 
  gateway_id: "rtb-gw-12345678", 
  security_group_ids: [
    "sg-12345678", 
  ], 
  status: "ACTIVE", 
  subnet_ids: [
    "subnet-12345678", 
    "subnet-87654321", 
  ], 
  total_links_count: 5, 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
  vpc_id: "vpc-12345678", 
}

Request syntax with placeholder values


resp = client.get_requester_gateway({
  gateway_id: "GatewayId", # required
})

Response structure


resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"
resp.domain_name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.vpc_id #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.gateway_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.active_links_count #=> Integer
resp.total_links_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

Returns:

See Also:



2399
2400
2401
2402
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2399

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

#get_responder_gateway(params = {}) ⇒ Types::GetResponderGatewayResponse

Retrieves information about a responder gateway.

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

  • responder_gateway_active
  • responder_gateway_deleted

Examples:

Example: Get responder gateway details


# Get responder gateway

resp = client.get_responder_gateway({
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  active_links_count: 2, 
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  description: "My responder gateway", 
  gateway_id: "rtb-gw-12345678", 
  inbound_links_count: 3, 
  port: 443, 
  protocol: "HTTPS", 
  security_group_ids: [
    "sg-12345678", 
  ], 
  status: "ACTIVE", 
  subnet_ids: [
    "subnet-12345678", 
    "subnet-87654321", 
  ], 
  total_links_count: 5, 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
  vpc_id: "vpc-12345678", 
}

Request syntax with placeholder values


resp = client.get_responder_gateway({
  gateway_id: "GatewayId", # required
})

Response structure


resp.vpc_id #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"
resp.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.domain_name #=> String
resp.port #=> Integer
resp.protocol #=> String, one of "HTTP", "HTTPS"
resp.listener_config.protocols #=> Array
resp.listener_config.protocols[0] #=> String, one of "HTTP", "HTTPS"
resp.trust_store_configuration.certificate_authority_certificates #=> Array
resp.trust_store_configuration.certificate_authority_certificates[0] #=> String
resp.managed_endpoint_configuration.auto_scaling_groups.auto_scaling_group_names #=> Array
resp.managed_endpoint_configuration.auto_scaling_groups.auto_scaling_group_names[0] #=> String
resp.managed_endpoint_configuration.auto_scaling_groups.role_arn #=> String
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.port #=> Integer
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.path #=> String
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.protocol #=> String, one of "HTTP", "HTTPS"
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.timeout_ms #=> Integer
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.interval_seconds #=> Integer
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.status_code_matcher #=> String
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.healthy_threshold_count #=> Integer
resp.managed_endpoint_configuration.auto_scaling_groups.health_check_config.unhealthy_threshold_count #=> Integer
resp.managed_endpoint_configuration.eks_endpoints.endpoints_resource_name #=> String
resp.managed_endpoint_configuration.eks_endpoints.endpoints_resource_namespace #=> String
resp.managed_endpoint_configuration.eks_endpoints.cluster_api_server_endpoint_uri #=> String
resp.managed_endpoint_configuration.eks_endpoints.cluster_api_server_ca_certificate_chain #=> String
resp.managed_endpoint_configuration.eks_endpoints.cluster_name #=> String
resp.managed_endpoint_configuration.eks_endpoints.role_arn #=> String
resp.gateway_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.active_links_count #=> Integer
resp.total_links_count #=> Integer
resp.inbound_links_count #=> Integer
resp.gateway_type #=> String, one of "EXTERNAL", "INTERNAL"
resp.external_inbound_endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

Returns:

See Also:



2523
2524
2525
2526
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2523

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

#list_certificate_associations(params = {}) ⇒ Types::ListCertificateAssociationsResponse

Lists the certificate associations for a responder gateway.

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

Examples:

Example: List certificate associations for a responder gateway


# Retrieve all certificate associations for a responder gateway

resp = client.list_certificate_associations({
  gateway_id: "rtb-gw-12345678", 
  max_results: 5, 
})

resp.to_h outputs the following:
{
  certificate_associations: [
    {
      acm_certificate_arn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", 
      associated_at: Time.parse(1704067200), 
      status: "ASSOCIATED", 
      updated_at: Time.parse(1704067200), 
    }, 
  ], 
  next_token: "token123", 
}

Request syntax with placeholder values


resp = client.list_certificate_associations({
  gateway_id: "GatewayId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.certificate_associations #=> Array
resp.certificate_associations[0].acm_certificate_arn #=> String
resp.certificate_associations[0].status #=> String, one of "PENDING_ASSOCIATION", "ASSOCIATED", "PENDING_DISASSOCIATION", "DISASSOCIATED", "FAILED"
resp.certificate_associations[0].associated_at #=> Time
resp.certificate_associations[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



2599
2600
2601
2602
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2599

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

#list_link_routing_rules(params = {}) ⇒ Types::ListLinkRoutingRulesResponse

Lists the routing rules for a link.

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

Examples:

Example: List link routing rules


# List all routing rules for a link

resp = client.list_link_routing_rules({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  next_token: "token123", 
  rules: [
    {
      conditions: {
        host_header: "api.customer.com", 
      }, 
      created_at: Time.parse("2024-01-01T12:00:00Z"), 
      priority: 10, 
      rule_id: "rule-abc123def456", 
      status: "ACTIVE", 
      updated_at: Time.parse("2024-01-01T12:00:00Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_link_routing_rules({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.rules #=> Array
resp.rules[0].rule_id #=> String
resp.rules[0].priority #=> Integer
resp.rules[0].conditions.host_header #=> String
resp.rules[0].conditions.host_header_wildcard #=> String
resp.rules[0].conditions.path_prefix #=> String
resp.rules[0].conditions.path_exact #=> String
resp.rules[0].conditions.query_string_equals.key #=> String
resp.rules[0].conditions.query_string_equals.value #=> String
resp.rules[0].conditions.query_string_exists #=> String
resp.rules[0].status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETION_IN_PROGRESS", "DELETED", "FAILED"
resp.rules[0].created_at #=> Time
resp.rules[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



2692
2693
2694
2695
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2692

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

#list_links(params = {}) ⇒ Types::ListLinksResponse

Lists links associated with gateways.

Returns a list of all links for the specified gateways, including their status and configuration details.

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

Examples:

Example: List links for a gateway


# Lists all links for the specified gateway

resp = client.list_links({
  gateway_id: "rtb-gw-12345678", 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  links: [
    {
      created_at: Time.parse("2024-01-15T10:30:00Z"), 
      gateway_id: "rtb-gw-12345678", 
      link_id: "link-87654321", 
      peer_gateway_id: "rtb-gw-87654321", 
      status: "ACTIVE", 
      updated_at: Time.parse("2024-01-15T10:35:00Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_links({
  gateway_id: "GatewayId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.links #=> Array
resp.links[0].gateway_id #=> String
resp.links[0].peer_gateway_id #=> String
resp.links[0].status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.links[0].created_at #=> Time
resp.links[0].updated_at #=> Time
resp.links[0].direction #=> String, one of "RESPONSE", "REQUEST"
resp.links[0].flow_modules #=> Array
resp.links[0].flow_modules[0].version #=> String
resp.links[0].flow_modules[0].name #=> String
resp.links[0].flow_modules[0].depends_on #=> Array
resp.links[0].flow_modules[0].depends_on[0] #=> String
resp.links[0].flow_modules[0].module_parameters.no_bid.reason #=> String
resp.links[0].flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.links[0].flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.links[0].flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.links[0].flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.links[0].pending_flow_modules #=> Array
resp.links[0].pending_flow_modules[0].version #=> String
resp.links[0].pending_flow_modules[0].name #=> String
resp.links[0].pending_flow_modules[0].depends_on #=> Array
resp.links[0].pending_flow_modules[0].depends_on[0] #=> String
resp.links[0].pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.links[0].pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.links[0].pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.links[0].pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.links[0].pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.links[0].attributes.responder_error_masking #=> Array
resp.links[0].attributes.responder_error_masking[0].http_code #=> String
resp.links[0].attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.links[0].attributes.responder_error_masking[0].logging_types #=> Array
resp.links[0].attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.links[0].attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.links[0].attributes.customer_provided_id #=> String
resp.links[0].log_settings.application_logs.sampling.error_log #=> Float
resp.links[0].log_settings.application_logs.sampling.filter_log #=> Float
resp.links[0].connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"
resp.links[0].link_id #=> String
resp.links[0].tags #=> Hash
resp.links[0].tags["TagKey"] #=> String
resp.links[0].public_endpoint #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



2826
2827
2828
2829
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2826

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

#list_requester_gateways(params = {}) ⇒ Types::ListRequesterGatewaysResponse

Lists requester gateways.

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

Examples:

Example: List requester gateways with default pagination


# Lists requester gateways using default pagination settings

resp = client.list_requester_gateways({
  max_results: 10, 
})

resp.to_h outputs the following:
{
  gateway_ids: [
    "rtb-gw-12345", 
    "rtb-gw-67890", 
  ], 
}

Example: List requester gateways with pagination token


# Lists requester gateways using a pagination token to get the next page

resp = client.list_requester_gateways({
  max_results: 5, 
  next_token: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLTEyMzQ1In19fQ==", 
})

resp.to_h outputs the following:
{
  gateway_ids: [
    "rtb-gw-12345", 
    "rtb-gw-09876", 
  ], 
  next_token: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLWZnaGlqIn19fQ==", 
}

Request syntax with placeholder values


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

Response structure


resp.gateway_ids #=> Array
resp.gateway_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



2907
2908
2909
2910
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2907

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

#list_responder_gateways(params = {}) ⇒ Types::ListResponderGatewaysResponse

Lists reponder gateways.

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

Examples:

Example: List responder gateways with default pagination


# Lists responder gateways using default pagination settings

resp = client.list_responder_gateways({
  max_results: 10, 
})

resp.to_h outputs the following:
{
  gateway_ids: [
    "rtb-gw-54321", 
    "rtb-gw-09876", 
  ], 
}

Example: List responder gateways with pagination token


# Lists responder gateways using a pagination token to get the next page

resp = client.list_responder_gateways({
  max_results: 3, 
  next_token: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=", 
})

resp.to_h outputs the following:
{
  gateway_ids: [
    "rtb-gw-12345", 
    "rtb-gw-09876", 
  ], 
  next_token: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC1hYmMzNCJ9fX0=", 
}

Request syntax with placeholder values


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

Response structure


resp.gateway_ids #=> Array
resp.gateway_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

See Also:



2988
2989
2990
2991
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2988

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

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

Lists tags for a resource.

Examples:

Example: List tags for a resource


# Lists tags for a resource

resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  tags: {
    "Environment" => "Production", 
    "Team" => "RTB", 
  }, 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Returns:

See Also:



3035
3036
3037
3038
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3035

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

#reject_link(params = {}) ⇒ Types::RejectLinkResponse

Rejects a link request between gateways.

When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.

Examples:

Example: Reject a link request


# Rejects a requested link request

resp = client.reject_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
})

resp.to_h outputs the following:
{
  created_at: Time.parse("2024-01-15T10:30:00Z"), 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  peer_gateway_id: "rtb-gw-87654321", 
  status: "REJECTED", 
  updated_at: Time.parse("2024-01-15T10:35:00Z"), 
}

Request syntax with placeholder values


resp = client.reject_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
})

Response structure


resp.gateway_id #=> String
resp.peer_gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.direction #=> String, one of "RESPONSE", "REQUEST"
resp.flow_modules #=> Array
resp.flow_modules[0].version #=> String
resp.flow_modules[0].name #=> String
resp.flow_modules[0].depends_on #=> Array
resp.flow_modules[0].depends_on[0] #=> String
resp.flow_modules[0].module_parameters.no_bid.reason #=> String
resp.flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.pending_flow_modules #=> Array
resp.pending_flow_modules[0].version #=> String
resp.pending_flow_modules[0].name #=> String
resp.pending_flow_modules[0].depends_on #=> Array
resp.pending_flow_modules[0].depends_on[0] #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason #=> String
resp.pending_flow_modules[0].module_parameters.no_bid.reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.no_bid.pass_through_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_type #=> String, one of "INCLUDE", "EXCLUDE"
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].path #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values #=> Array
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.filter_configuration[0].criteria[0].values[0] #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.no_bid.no_bid_reason_code #=> Integer
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.name #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.action.header_tag.value #=> String
resp.pending_flow_modules[0].module_parameters.open_rtb_attribute.holdback_percentage #=> Float
resp.pending_flow_modules[0].module_parameters.rate_limiter.tps #=> Float
resp.attributes.responder_error_masking #=> Array
resp.attributes.responder_error_masking[0].http_code #=> String
resp.attributes.responder_error_masking[0].action #=> String, one of "NO_BID", "PASSTHROUGH"
resp.attributes.responder_error_masking[0].logging_types #=> Array
resp.attributes.responder_error_masking[0].logging_types[0] #=> String, one of "NONE", "METRIC", "RESPONSE"
resp.attributes.responder_error_masking[0].response_logging_percentage #=> Float
resp.attributes.customer_provided_id #=> String
resp.log_settings.application_logs.sampling.error_log #=> Float
resp.log_settings.application_logs.sampling.filter_log #=> Float
resp.connectivity_type #=> String, one of "DEFAULT", "PUBLIC_INGRESS", "PUBLIC_EGRESS", "EXTERNAL_INBOUND"
resp.link_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

Returns:

See Also:



3155
3156
3157
3158
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3155

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

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified resource.

Examples:

Example: Add tags to a resource


# Adds tags to a resource

resp = client.tag_resource({
  resource_arn: "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678", 
  tags: {
    "Environment" => "Production", 
    "Team" => "RTB", 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "RtbTaggableResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to tag.

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

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3201
3202
3203
3204
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3201

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag or tags from a resource.

Examples:

Example: Remove tags from a resource


# Removes tags from a resource

resp = client.untag_resource({
  resource_arn: "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678", 
  tag_keys: [
    "Environment", 
    "Team", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "RtbTaggableResourceArn", # required
  tag_keys: ["TagKey"], # 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 key-value pairs for the tag or tags you want to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3245
3246
3247
3248
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3245

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

#update_link(params = {}) ⇒ Types::UpdateLinkResponse

Updates the configuration of a link between gateways.

Allows you to modify settings and parameters for an existing link.

Examples:

Example: Update link settings


# Updates configuration settings for an existing link

resp = client.update_link({
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  log_settings: {
    application_logs: {
      sampling: {
        error_log: 100.0, 
        filter_log: 10.0, 
      }, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  link_id: "link-87654321", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.update_link({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  log_settings: {
    application_logs: { # required
      sampling: { # required
        error_log: 1.0, # required
        filter_log: 1.0, # required
      },
    },
  },
  timeout_in_millis: 1,
})

Response structure


resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :log_settings (Types::LinkLogSettings) —

    Settings for the application logs.

  • :timeout_in_millis (Integer) —

    The timeout value in milliseconds.

Returns:

See Also:



3320
3321
3322
3323
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3320

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

#update_link_module_flow(params = {}) ⇒ Types::UpdateLinkModuleFlowResponse

Updates a link module flow.

Examples:

Example: Update link module flow


# Update link module flow for link

resp = client.update_link_module_flow({
  client_token: "randomClientToken", 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  modules: [
    {
      version: "1dot0dot0", 
      name: "noBidModule", 
      depends_on: [
      ], 
      module_parameters: {
        no_bid: {
          pass_through_percentage: 50.0, 
          reason: "test", 
          reason_code: 1, 
        }, 
      }, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.update_link_module_flow({
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  modules: [ # required
    {
      version: "Version",
      name: "FlowModuleName", # required
      depends_on: ["FlowModuleName"],
      module_parameters: {
        no_bid: {
          reason: "NoBidModuleParametersReasonString",
          reason_code: 1,
          pass_through_percentage: 1.0,
        },
        open_rtb_attribute: {
          filter_type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
          filter_configuration: [ # required
            {
              criteria: [ # required
                {
                  path: "String", # required
                  values: ["String"], # required
                },
              ],
            },
          ],
          action: { # required
            no_bid: {
              no_bid_reason_code: 1,
            },
            header_tag: {
              name: "String", # required
              value: "String", # required
            },
          },
          holdback_percentage: 1.0, # required
        },
        rate_limiter: {
          tps: 1.0,
        },
      },
    },
  ],
})

Response structure


resp.gateway_id #=> String
resp.link_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "PENDING_REQUEST", "REQUESTED", "ACCEPTED", "ACTIVE", "REJECTED", "FAILED", "PENDING_DELETION", "DELETED", "PENDING_UPDATE", "PENDING_ISOLATION", "ISOLATED", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The unique client token.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :modules (required, Array<Types::ModuleConfiguration>) —

    The configuration of a module.

Returns:

See Also:



3439
3440
3441
3442
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3439

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

#update_link_routing_rule(params = {}) ⇒ Types::UpdateLinkRoutingRuleResponse

Updates a routing rule for a link.

Examples:

Example: Update a link routing rule


# Update the conditions of a routing rule

resp = client.update_link_routing_rule({
  conditions: {
    host_header: "api.customer.com", 
    path_prefix: "/openrtb/", 
  }, 
  gateway_id: "rtb-gw-12345678", 
  link_id: "link-87654321", 
  priority: 20, 
  rule_id: "rule-abc123def456", 
})

resp.to_h outputs the following:
{
  rule_id: "rule-abc123def456", 
  status: "UPDATE_IN_PROGRESS", 
  updated_at: Time.parse("2024-01-01T12:30:00Z"), 
}

Request syntax with placeholder values


resp = client.update_link_routing_rule({
  gateway_id: "GatewayId", # required
  link_id: "LinkId", # required
  rule_id: "RuleId", # required
  priority: 1, # required
  conditions: { # required
    host_header: "RuleConditionHostHeaderString",
    host_header_wildcard: "RuleConditionHostHeaderWildcardString",
    path_prefix: "RuleConditionPathPrefixString",
    path_exact: "RuleConditionPathExactString",
    query_string_equals: {
      key: "QueryStringKeyValuePairKeyString", # required
      value: "QueryStringKeyValuePairValueString", # required
    },
    query_string_exists: "RuleConditionQueryStringExistsString",
  },
})

Response structure


resp.rule_id #=> String
resp.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "UPDATE_IN_PROGRESS", "DELETION_IN_PROGRESS", "DELETED", "FAILED"
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :link_id (required, String) —

    The unique identifier of the link.

  • :rule_id (required, String) —

    The unique identifier of the routing rule.

  • :priority (required, Integer) —

    The updated priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.

  • :conditions (required, Types::RuleCondition) —

    The updated conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.

Returns:

See Also:



3523
3524
3525
3526
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3523

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

#update_requester_gateway(params = {}) ⇒ Types::UpdateRequesterGatewayResponse

Updates a requester gateway.

Examples:

Example: Update requester gateway


# Update requester gateway

resp = client.update_requester_gateway({
  client_token: "12345678-1234-1234-1234-123456789012", 
  description: "Updated requester gateway description", 
  gateway_id: "rtb-gw-12345678", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_UPDATE", 
}

Request syntax with placeholder values


resp = client.update_requester_gateway({
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  description: "UpdateRequesterGatewayRequestDescriptionString",
})

Response structure


resp.gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The unique client token.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :description (String) —

    An optional description for the requester gateway.

Returns:

See Also:



3581
3582
3583
3584
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3581

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

#update_responder_gateway(params = {}) ⇒ Types::UpdateResponderGatewayResponse

Updates a responder gateway.

Examples:

Example: Update responder gateway


# Update responder gateway

resp = client.update_responder_gateway({
  client_token: "12345678-1234-1234-1234-123456789012", 
  description: "Updated responder gateway description", 
  gateway_id: "rtb-gw-12345678", 
  port: 8080, 
  protocol: "HTTP", 
})

resp.to_h outputs the following:
{
  gateway_id: "rtb-gw-12345678", 
  status: "PENDING_UPDATE", 
}

Request syntax with placeholder values


resp = client.update_responder_gateway({
  domain_name: "DomainName",
  port: 1, # required
  protocol: "HTTP", # required, accepts HTTP, HTTPS
  listener_config: {
    protocols: ["HTTP"], # required, accepts HTTP, HTTPS
  },
  trust_store_configuration: {
    certificate_authority_certificates: ["Base64EncodedCertificateChain"], # required
  },
  managed_endpoint_configuration: {
    auto_scaling_groups: {
      auto_scaling_group_names: ["AutoScalingGroupName"], # required
      role_arn: "AutoScalingGroupsConfigurationRoleArnString", # required
      health_check_config: {
        port: 1, # required
        path: "HealthCheckConfigPathString", # required
        protocol: "HTTP", # accepts HTTP, HTTPS
        timeout_ms: 1,
        interval_seconds: 1,
        status_code_matcher: "StatusCodeMatcher",
        healthy_threshold_count: 1,
        unhealthy_threshold_count: 1,
      },
    },
    eks_endpoints: {
      endpoints_resource_name: "KubernetesEndpointsResourceName", # required
      endpoints_resource_namespace: "KubernetesNamespace", # required
      cluster_api_server_endpoint_uri: "URI", # required
      cluster_api_server_ca_certificate_chain: "Base64EncodedCertificateChain", # required
      cluster_name: "KubernetesClusterName", # required
      role_arn: "EksEndpointsConfigurationRoleArnString", # required
    },
  },
  client_token: "String", # required
  gateway_id: "GatewayId", # required
  description: "UpdateResponderGatewayRequestDescriptionString",
})

Response structure


resp.gateway_id #=> String
resp.status #=> String, one of "PENDING_CREATION", "ACTIVE", "PENDING_DELETION", "DELETED", "ERROR", "PENDING_UPDATE", "ISOLATED", "PENDING_ISOLATION", "PENDING_RESTORATION"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (String) —

    The domain name for the responder gateway.

  • :port (required, Integer) —

    The networking port to use.

  • :protocol (required, String) —

    The networking protocol to use.

  • :listener_config (Types::ListenerConfig) —

    The listener configuration for the responder gateway.

  • :trust_store_configuration (Types::TrustStoreConfiguration) —

    The configuration of the trust store.

  • :managed_endpoint_configuration (Types::ManagedEndpointConfiguration) —

    The configuration for the managed endpoint.

  • :client_token (required, String) —

    The unique client token.

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

  • :gateway_id (required, String) —

    The unique identifier of the gateway.

  • :description (String) —

    An optional description for the responder gateway.

Returns:

See Also:



3692
3693
3694
3695
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3692

def update_responder_gateway(params = {}, options = {})
  req = build_request(:update_responder_gateway, 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
certificate_associated #get_certificate_association 15 8
certificate_disassociated #get_certificate_association 15 8
inbound_external_link_active #get_inbound_external_link 30 5
inbound_external_link_deleted #get_inbound_external_link 30 5
link_accepted #get_link 30 5
link_active #get_link 30 5
link_deleted #get_link 30 5
link_routing_rule_active #get_link_routing_rule 5 24
link_routing_rule_deleted #get_link_routing_rule 5 24
outbound_external_link_active #get_outbound_external_link 30 5
outbound_external_link_deleted #get_outbound_external_link 30 5
requester_gateway_active #get_requester_gateway 30 5
requester_gateway_deleted #get_requester_gateway 30 5
responder_gateway_active #get_responder_gateway 30 5
responder_gateway_deleted #get_responder_gateway 30 5

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.



3821
3822
3823
3824
3825
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3821

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