Class: Aws::TimestreamQuery::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TimestreamQuery::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb
Overview
An API client for TimestreamQuery. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::TimestreamQuery::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
-
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
Cancels a query that has been issued.
-
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
-
#query(params = {}) ⇒ Types::QueryResponse
Query is a synchronous operation that enables you to execute a query.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
334 335 336 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
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.
368 369 370 371 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 368 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
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.
408 409 410 411 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 408 def describe_endpoints(params = {}, = {}) req = build_request(:describe_endpoints, params) req.send_request() end |
#query(params = {}) ⇒ Types::QueryResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
498 499 500 501 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 498 def query(params = {}, = {}) req = build_request(:query, params) req.send_request() end |