RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/IoTSecureTunneling/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSecureTunneling::Client Overview

An API client for AWS IoT Secure Tunneling. To construct a client, you need to configure a :region and :credentials.

iotsecuretunneling = Aws::IoTSecureTunneling::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::IoTSecureTunneling::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::IoTSecureTunneling::Client constructor Constructs an API client.

API Operations collapse

#close_tunnel(options = {}) ⇒ Struct Closes a tunnel identified by the unique tunnel id.
#describe_tunnel(options = {}) ⇒ Types::DescribeTunnelResponse Gets information about a tunnel identified by the unique tunnel id. .
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse Lists the tags for the specified resource. .
#list_tunnels(options = {}) ⇒ Types::ListTunnelsResponse List all tunnels for an AWS account.
#open_tunnel(options = {}) ⇒ Types::OpenTunnelResponse Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. .
#tag_resource(options = {}) ⇒ Struct
#untag_resource(options = {}) ⇒ Struct Removes a tag from a resource. .

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol> Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Instance Method Details #close_tunnel(options = {}) ⇒ Struct

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

#list_tunnels(options = {}) ⇒ Types::ListTunnelsResponse

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

#open_tunnel(options = {}) ⇒ Types::OpenTunnelResponse

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.

#tag_resource(options = {}) ⇒ Struct #untag_resource(options = {}) ⇒ Struct

Removes a tag from a resource.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

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(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4