Class: Aws::RTBFabric::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RTBFabric::Client
- 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
API Operations collapse
-
#accept_link(params = {}) ⇒ Types::AcceptLinkResponse
Accepts a link request between gateways.
-
#associate_certificate(params = {}) ⇒ Types::AssociateCertificateResponse
Associates an ACM certificate with a responder gateway.
-
#create_inbound_external_link(params = {}) ⇒ Types::CreateInboundExternalLinkResponse
Creates an inbound external link.
-
#create_link(params = {}) ⇒ Types::CreateLinkResponse
Creates a new link between gateways.
-
#create_link_routing_rule(params = {}) ⇒ Types::CreateLinkRoutingRuleResponse
Creates a routing rule for a link.
-
#create_outbound_external_link(params = {}) ⇒ Types::CreateOutboundExternalLinkResponse
Creates an outbound external link.
-
#create_requester_gateway(params = {}) ⇒ Types::CreateRequesterGatewayResponse
Creates a requester gateway.
-
#create_responder_gateway(params = {}) ⇒ Types::CreateResponderGatewayResponse
Creates a responder gateway.
-
#delete_inbound_external_link(params = {}) ⇒ Types::DeleteInboundExternalLinkResponse
Deletes an inbound external link.
-
#delete_link(params = {}) ⇒ Types::DeleteLinkResponse
Deletes a link between gateways.
-
#delete_link_routing_rule(params = {}) ⇒ Types::DeleteLinkRoutingRuleResponse
Deletes a routing rule from a link.
-
#delete_outbound_external_link(params = {}) ⇒ Types::DeleteOutboundExternalLinkResponse
Deletes an outbound external link.
-
#delete_requester_gateway(params = {}) ⇒ Types::DeleteRequesterGatewayResponse
Deletes a requester gateway.
-
#delete_responder_gateway(params = {}) ⇒ Types::DeleteResponderGatewayResponse
Deletes a responder gateway.
-
#disassociate_certificate(params = {}) ⇒ Types::DisassociateCertificateResponse
Removes a certificate association from a responder gateway.
-
#get_certificate_association(params = {}) ⇒ Types::GetCertificateAssociationResponse
Retrieves the details of a certificate association with a responder gateway.
-
#get_inbound_external_link(params = {}) ⇒ Types::GetInboundExternalLinkResponse
Retrieves information about an inbound external link.
-
#get_link(params = {}) ⇒ Types::GetLinkResponse
Retrieves information about a link between gateways.
-
#get_link_routing_rule(params = {}) ⇒ Types::GetLinkRoutingRuleResponse
Retrieves the details of a routing rule for a link.
-
#get_outbound_external_link(params = {}) ⇒ Types::GetOutboundExternalLinkResponse
Retrieves information about an outbound external link.
-
#get_requester_gateway(params = {}) ⇒ Types::GetRequesterGatewayResponse
Retrieves information about a requester gateway.
-
#get_responder_gateway(params = {}) ⇒ Types::GetResponderGatewayResponse
Retrieves information about a responder gateway.
-
#list_certificate_associations(params = {}) ⇒ Types::ListCertificateAssociationsResponse
Lists the certificate associations for a responder gateway.
-
#list_link_routing_rules(params = {}) ⇒ Types::ListLinkRoutingRulesResponse
Lists the routing rules for a link.
-
#list_links(params = {}) ⇒ Types::ListLinksResponse
Lists links associated with gateways.
-
#list_requester_gateways(params = {}) ⇒ Types::ListRequesterGatewaysResponse
Lists requester gateways.
-
#list_responder_gateways(params = {}) ⇒ Types::ListResponderGatewaysResponse
Lists reponder gateways.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
-
#reject_link(params = {}) ⇒ Types::RejectLinkResponse
Rejects a link request between gateways.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag or tags from a resource.
-
#update_link(params = {}) ⇒ Types::UpdateLinkResponse
Updates the configuration of a link between gateways.
-
#update_link_module_flow(params = {}) ⇒ Types::UpdateLinkModuleFlowResponse
Updates a link module flow.
-
#update_link_routing_rule(params = {}) ⇒ Types::UpdateLinkRoutingRuleResponse
Updates a routing rule for a link.
-
#update_requester_gateway(params = {}) ⇒ Types::UpdateRequesterGatewayResponse
Updates a requester gateway.
-
#update_responder_gateway(params = {}) ⇒ Types::UpdateResponderGatewayResponse
Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
479 480 481 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#accept_link(params = {}) ⇒ Types::AcceptLinkResponse
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.
638 639 640 641 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 638 def accept_link(params = {}, = {}) req = build_request(:accept_link, params) req.send_request() end |
#associate_certificate(params = {}) ⇒ Types::AssociateCertificateResponse
Associates an ACM certificate with a responder gateway.
715 716 717 718 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 715 def associate_certificate(params = {}, = {}) req = build_request(:associate_certificate, params) req.send_request() end |
#create_inbound_external_link(params = {}) ⇒ Types::CreateInboundExternalLinkResponse
Creates an inbound external link.
830 831 832 833 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 830 def create_inbound_external_link(params = {}, = {}) req = build_request(:create_inbound_external_link, params) req.send_request() 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1004 def create_link(params = {}, = {}) req = build_request(:create_link, params) req.send_request() 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.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1118 def create_link_routing_rule(params = {}, = {}) req = build_request(:create_link_routing_rule, params) req.send_request() end |
#create_outbound_external_link(params = {}) ⇒ Types::CreateOutboundExternalLinkResponse
Creates an outbound external link.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1235 def create_outbound_external_link(params = {}, = {}) req = build_request(:create_outbound_external_link, params) req.send_request() end |
#create_requester_gateway(params = {}) ⇒ Types::CreateRequesterGatewayResponse
Creates a requester gateway.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1334 def create_requester_gateway(params = {}, = {}) req = build_request(:create_requester_gateway, params) req.send_request() end |
#create_responder_gateway(params = {}) ⇒ Types::CreateResponderGatewayResponse
Creates a responder gateway.
A domain name or managed endpoint is required.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1530 def create_responder_gateway(params = {}, = {}) req = build_request(:create_responder_gateway, params) req.send_request() end |
#delete_inbound_external_link(params = {}) ⇒ Types::DeleteInboundExternalLinkResponse
Deletes an inbound external link.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1580 def delete_inbound_external_link(params = {}, = {}) req = build_request(:delete_inbound_external_link, params) req.send_request() end |
#delete_link(params = {}) ⇒ Types::DeleteLinkResponse
Deletes a link between gateways.
Permanently removes the connection between gateways. This action cannot be undone.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1633 def delete_link(params = {}, = {}) req = build_request(:delete_link, params) req.send_request() end |
#delete_link_routing_rule(params = {}) ⇒ Types::DeleteLinkRoutingRuleResponse
Deletes a routing rule from a link.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1688 def delete_link_routing_rule(params = {}, = {}) req = build_request(:delete_link_routing_rule, params) req.send_request() end |
#delete_outbound_external_link(params = {}) ⇒ Types::DeleteOutboundExternalLinkResponse
Deletes an outbound external link.
1738 1739 1740 1741 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1738 def delete_outbound_external_link(params = {}, = {}) req = build_request(:delete_outbound_external_link, params) req.send_request() end |
#delete_requester_gateway(params = {}) ⇒ Types::DeleteRequesterGatewayResponse
Deletes a requester gateway.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1783 def delete_requester_gateway(params = {}, = {}) req = build_request(:delete_requester_gateway, params) req.send_request() end |
#delete_responder_gateway(params = {}) ⇒ Types::DeleteResponderGatewayResponse
Deletes a responder gateway.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1828 def delete_responder_gateway(params = {}, = {}) req = build_request(:delete_responder_gateway, params) req.send_request() end |
#disassociate_certificate(params = {}) ⇒ Types::DisassociateCertificateResponse
Removes a certificate association from a responder gateway.
1881 1882 1883 1884 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1881 def disassociate_certificate(params = {}, = {}) req = build_request(:disassociate_certificate, params) req.send_request() 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
1947 1948 1949 1950 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1947 def get_certificate_association(params = {}, = {}) req = build_request(:get_certificate_association, params) req.send_request() 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
2071 2072 2073 2074 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2071 def get_inbound_external_link(params = {}, = {}) req = build_request(:get_inbound_external_link, params) req.send_request() 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
2205 2206 2207 2208 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2205 def get_link(params = {}, = {}) req = build_request(:get_link, params) req.send_request() 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
2296 2297 2298 2299 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2296 def get_link_routing_rule(params = {}, = {}) req = build_request(:get_link_routing_rule, params) req.send_request() 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
2420 2421 2422 2423 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2420 def get_outbound_external_link(params = {}, = {}) req = build_request(:get_outbound_external_link, params) req.send_request() 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
2508 2509 2510 2511 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2508 def get_requester_gateway(params = {}, = {}) req = build_request(:get_requester_gateway, params) req.send_request() 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
2634 2635 2636 2637 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2634 def get_responder_gateway(params = {}, = {}) req = build_request(:get_responder_gateway, params) req.send_request() 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.
2710 2711 2712 2713 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2710 def list_certificate_associations(params = {}, = {}) req = build_request(:list_certificate_associations, params) req.send_request() 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.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2803 def list_link_routing_rules(params = {}, = {}) req = build_request(:list_link_routing_rules, params) req.send_request() 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.
2937 2938 2939 2940 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2937 def list_links(params = {}, = {}) req = build_request(:list_links, params) req.send_request() 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.
3018 3019 3020 3021 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3018 def list_requester_gateways(params = {}, = {}) req = build_request(:list_requester_gateways, params) req.send_request() 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.
3099 3100 3101 3102 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3099 def list_responder_gateways(params = {}, = {}) req = build_request(:list_responder_gateways, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for a resource.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3146 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
3266 3267 3268 3269 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3266 def reject_link(params = {}, = {}) req = build_request(:reject_link, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
3312 3313 3314 3315 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3312 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag or tags from a resource.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3356 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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.
3431 3432 3433 3434 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3431 def update_link(params = {}, = {}) req = build_request(:update_link, params) req.send_request() end |
#update_link_module_flow(params = {}) ⇒ Types::UpdateLinkModuleFlowResponse
Updates a link module flow.
3566 3567 3568 3569 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3566 def update_link_module_flow(params = {}, = {}) req = build_request(:update_link_module_flow, params) req.send_request() end |
#update_link_routing_rule(params = {}) ⇒ Types::UpdateLinkRoutingRuleResponse
Updates a routing rule for a link.
3650 3651 3652 3653 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3650 def update_link_routing_rule(params = {}, = {}) req = build_request(:update_link_routing_rule, params) req.send_request() end |
#update_requester_gateway(params = {}) ⇒ Types::UpdateRequesterGatewayResponse
Updates a requester gateway.
3724 3725 3726 3727 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3724 def update_requester_gateway(params = {}, = {}) req = build_request(:update_requester_gateway, params) req.send_request() end |
#update_responder_gateway(params = {}) ⇒ Types::UpdateResponderGatewayResponse
Updates the description, Auto Scaling group managed endpoint
configuration, trust store configuration, and client routing policy of
a responder gateway. This operation also updates the protocols list
in the listener configuration.
You cannot change the domainName, port, and protocol values that
you set when you create a responder gateway. To change any of them,
delete the gateway and create a new one.
3896 3897 3898 3899 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3896 def update_responder_gateway(params = {}, = {}) req = build_request(:update_responder_gateway, params) req.send_request() 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 |
4025 4026 4027 4028 4029 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4025 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |