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

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/TimestreamQuery/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.

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

timestreamquery = Aws::TimestreamQuery::Client.new(
  region: region_name,
  credentials: credentials,
  )

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

You can configure a default region in the following locations:

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

Go here for a list of supported regions.

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:

• Credentials
• SharedCredentials
• InstanceProfileCredentials
• AssumeRoleCredentials

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

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

Aws::TimestreamQuery::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.

#config, #handlers

• #initialize(options = {}) ⇒ Aws::TimestreamQuery::Client constructor

  Constructs an API client.

• #cancel_query(options = {}) ⇒ Types::CancelQueryResponse

  Cancels a query that has been issued.

• #describe_endpoints(options = {}) ⇒ Types::DescribeEndpointsResponse

  DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.

• #query(options = {}) ⇒ Types::QueryResponse

  Query is a synchronous operation that enables you to execute a query.

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

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

#handle, #handle_request, #handle_response

Cancels a query that has been issued. Cancellation is guaranteed only if the query has not completed execution before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled.

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

• Your application uses a programming language that does not yet have SDK support

• You require better control over the client-side implementation

For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.

Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.

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

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)

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

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

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

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

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