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_available_module(params = {}) ⇒ Types::GetAvailableModuleResponse
Returns a module that you can attach.
-
#get_available_module_version(params = {}) ⇒ Types::GetAvailableModuleVersionResponse
Returns an ACTIVE or DEPRECATED version of a module that you can attach.
-
#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.
-
#get_update(params = {}) ⇒ Types::GetUpdateResponse
Returns ResourceNotFoundException for an updateId past the 90-day retention window, indistinguishable in the response from an id that never existed.
-
#list_available_module_versions(params = {}) ⇒ Types::ListAvailableModuleVersionsResponse
Lists the ACTIVE and DEPRECATED versions of a module that you can attach, highest version first (numerically by MAJOR, then MINOR, then PATCH).
-
#list_available_modules(params = {}) ⇒ Types::ListAvailableModulesResponse
Lists the modules that you can attach, newest first by
createdAt. -
#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.
-
#list_updates(params = {}) ⇒ Types::ListUpdatesResponse
Lists the updates on a gateway.
-
#put_link_flows(params = {}) ⇒ Types::PutLinkFlowsResponse
Replaces a link's flow configuration.
-
#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.
644 645 646 647 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 644 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.
721 722 723 724 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 721 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.
836 837 838 839 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 836 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.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1016 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.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1130 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.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1247 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1346 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.
1542 1543 1544 1545 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1542 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.
1592 1593 1594 1595 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1592 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.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1645 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.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1700 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.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1750 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.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1795 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.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1840 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.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1893 def disassociate_certificate(params = {}, = {}) req = build_request(:disassociate_certificate, params) req.send_request() end |
#get_available_module(params = {}) ⇒ Types::GetAvailableModuleResponse
Returns a module that you can attach. If you can't attach the module, the operation returns ResourceNotFoundException, the same as for a missing one.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 1958 def get_available_module(params = {}, = {}) req = build_request(:get_available_module, params) req.send_request() end |
#get_available_module_version(params = {}) ⇒ Types::GetAvailableModuleVersionResponse
Returns an ACTIVE or DEPRECATED version of a module that you can attach. If you can't attach the module, or the version is in another status, the operation returns ResourceNotFoundException, the same as for a missing one.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2042 def get_available_module_version(params = {}, = {}) req = build_request(:get_available_module_version, 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
2114 2115 2116 2117 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2114 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
2266 2267 2268 2269 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2266 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
2428 2429 2430 2431 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2428 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
2525 2526 2527 2528 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2525 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
2677 2678 2679 2680 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2677 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
2771 2772 2773 2774 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2771 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
2903 2904 2905 2906 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 2903 def get_responder_gateway(params = {}, = {}) req = build_request(:get_responder_gateway, params) req.send_request() end |
#get_update(params = {}) ⇒ Types::GetUpdateResponse
Returns ResourceNotFoundException for an updateId past the 90-day retention window, indistinguishable in the response from an id that never existed.
3057 3058 3059 3060 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3057 def get_update(params = {}, = {}) req = build_request(:get_update, params) req.send_request() end |
#list_available_module_versions(params = {}) ⇒ Types::ListAvailableModuleVersionsResponse
Lists the ACTIVE and DEPRECATED versions of a module that you can
attach, highest version first (numerically by MAJOR, then MINOR, then
PATCH). If you can't attach the module, the operation returns
ResourceNotFoundException, the same as for a missing one. If the
module has no ACTIVE or DEPRECATED versions, the operation returns an
empty list. The operation lists DEPRECATED versions so that you can
inspect one that you've attached, but you can't attach them. Results
are paginated. Use nextToken to get the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3148 3149 3150 3151 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3148 def list_available_module_versions(params = {}, = {}) req = build_request(:list_available_module_versions, params) req.send_request() end |
#list_available_modules(params = {}) ⇒ Types::ListAvailableModulesResponse
Lists the modules that you can attach, newest first by createdAt.
Results are paginated. Use nextToken to get the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3223 def list_available_modules(params = {}, = {}) req = build_request(:list_available_modules, 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.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3299 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.
3397 3398 3399 3400 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3397 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.
3536 3537 3538 3539 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3536 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.
3617 3618 3619 3620 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3617 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.
3698 3699 3700 3701 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3698 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.
3745 3746 3747 3748 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3745 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_updates(params = {}) ⇒ Types::ListUpdatesResponse
Lists the updates on a gateway. Results are paginated. Use nextToken
to get the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3834 3835 3836 3837 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 3834 def list_updates(params = {}, = {}) req = build_request(:list_updates, params) req.send_request() end |
#put_link_flows(params = {}) ⇒ Types::PutLinkFlowsResponse
Replaces a link's flow configuration. The change applies asynchronously. The call returns once the change is accepted, and the link serves its prior flows until the update commits atomically. RTB Fabric validates the request before accepting it, and a request that fails validation changes nothing. After the call, use GetLink. Once the change completes, the link's status is ACTIVE again and its flows show the change.
4051 4052 4053 4054 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4051 def put_link_flows(params = {}, = {}) req = build_request(:put_link_flows, 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.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4177 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.
4223 4224 4225 4226 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4223 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.
4267 4268 4269 4270 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4267 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.
4353 4354 4355 4356 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4353 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.
4491 4492 4493 4494 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4491 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.
4586 4587 4588 4589 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4586 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.
4660 4661 4662 4663 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4660 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.
4835 4836 4837 4838 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4835 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 |
4964 4965 4966 4967 4968 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/client.rb', line 4964 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |