aws-sdk-timestreamquery 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 36c1ff2850a1cf4c43c54b60eb7d67e831a9a28699027542e270aa40c8a14c68
4
+ data.tar.gz: ac5652ac2138778af3ec6230e864817925ba75051da47605624298273ebf9f73
5
+ SHA512:
6
+ metadata.gz: 8f01c7d73d945d8b48058f33f38921ec8183a3971f5786a49a42f2b54b1430da6af435881c3a1715b3e7406707c7bc06b0adf8be1d2c95b242f63c0a18bca625
7
+ data.tar.gz: 87719dcb4b750c3192bbcbc8ae1babf90ab12175ed7b44197ac5f90b3eb0de817eb8c08f8a6f09846d284ced921b52e77ba06f6593a596556f644f405e002d7d
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-timestreamquery/types'
15
+ require_relative 'aws-sdk-timestreamquery/client_api'
16
+ require_relative 'aws-sdk-timestreamquery/client'
17
+ require_relative 'aws-sdk-timestreamquery/errors'
18
+ require_relative 'aws-sdk-timestreamquery/resource'
19
+ require_relative 'aws-sdk-timestreamquery/customizations'
20
+
21
+ # This module provides support for Amazon Timestream Query. This module is available in the
22
+ # `aws-sdk-timestreamquery` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # timestream_query = Aws::TimestreamQuery::Client.new
31
+ # resp = timestream_query.cancel_query(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Timestream Query are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::TimestreamQuery::Errors::ServiceError
43
+ # # rescues all Amazon Timestream Query API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::TimestreamQuery
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,534 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:timestreamquery)
34
+
35
+ module Aws::TimestreamQuery
36
+ # An API client for TimestreamQuery. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::TimestreamQuery::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :timestreamquery
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (true)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :simple_json (false)
270
+ # Disables request parameter conversion, validation, and formatting.
271
+ # Also disable response data type conversions. This option is useful
272
+ # when you want to ensure the highest level of performance by
273
+ # avoiding overhead of walking request parameters and response data
274
+ # structures.
275
+ #
276
+ # When `:simple_json` is enabled, the request parameters hash must
277
+ # be formatted exactly as the DynamoDB API expects.
278
+ #
279
+ # @option options [Boolean] :stub_responses (false)
280
+ # Causes the client to return stubbed responses. By default
281
+ # fake responses are generated and returned. You can specify
282
+ # the response data to return or errors to raise by calling
283
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
284
+ #
285
+ # ** Please note ** When response stubbing is enabled, no HTTP
286
+ # requests are made, and retries are disabled.
287
+ #
288
+ # @option options [Boolean] :validate_params (true)
289
+ # When `true`, request parameters are validated before
290
+ # sending the request.
291
+ #
292
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
293
+ # requests through. Formatted like 'http://proxy.com:123'.
294
+ #
295
+ # @option options [Float] :http_open_timeout (15) The number of
296
+ # seconds to wait when opening a HTTP session before raising a
297
+ # `Timeout::Error`.
298
+ #
299
+ # @option options [Integer] :http_read_timeout (60) The default
300
+ # number of seconds to wait for response data. This value can
301
+ # safely be set per-request on the session.
302
+ #
303
+ # @option options [Float] :http_idle_timeout (5) The number of
304
+ # seconds a connection is allowed to sit idle before it is
305
+ # considered stale. Stale connections are closed and removed
306
+ # from the pool before making a request.
307
+ #
308
+ # @option options [Float] :http_continue_timeout (1) The number of
309
+ # seconds to wait for a 100-continue response before sending the
310
+ # request body. This option has no effect unless the request has
311
+ # "Expect" header set to "100-continue". Defaults to `nil` which
312
+ # disables this behaviour. This value can safely be set per
313
+ # request on the session.
314
+ #
315
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
316
+ # HTTP debug output will be sent to the `:logger`.
317
+ #
318
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
319
+ # SSL peer certificates are verified when establishing a
320
+ # connection.
321
+ #
322
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
323
+ # certificate authority bundle file that should be used when
324
+ # verifying peer certificates. If you do not pass
325
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
326
+ # will be used if available.
327
+ #
328
+ # @option options [String] :ssl_ca_directory Full path of the
329
+ # directory that contains the unbundled SSL certificate
330
+ # authority files for verifying peer certificates. If you do
331
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
332
+ # system default will be used if available.
333
+ #
334
+ def initialize(*args)
335
+ super
336
+ end
337
+
338
+ # @!group API Operations
339
+
340
+ # Cancels a query that has been issued. Cancellation is guaranteed only
341
+ # if the query has not completed execution before the cancellation
342
+ # request was issued. Because cancellation is an idempotent operation,
343
+ # subsequent cancellation requests will return a `CancellationMessage`,
344
+ # indicating that the query has already been canceled.
345
+ #
346
+ # @option params [required, String] :query_id
347
+ # The id of the query that needs to be cancelled. `QueryID` is returned
348
+ # as part of QueryResult.
349
+ #
350
+ # @return [Types::CancelQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
351
+ #
352
+ # * {Types::CancelQueryResponse#cancellation_message #cancellation_message} => String
353
+ #
354
+ # @example Request syntax with placeholder values
355
+ #
356
+ # resp = client.cancel_query({
357
+ # query_id: "QueryId", # required
358
+ # })
359
+ #
360
+ # @example Response structure
361
+ #
362
+ # resp.cancellation_message #=> String
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/CancelQuery AWS API Documentation
365
+ #
366
+ # @overload cancel_query(params = {})
367
+ # @param [Hash] params ({})
368
+ def cancel_query(params = {}, options = {})
369
+ req = build_request(:cancel_query, params)
370
+ req.send_request(options)
371
+ end
372
+
373
+ # DescribeEndpoints returns a list of available endpoints to make
374
+ # Timestream API calls against. This API is available through both Write
375
+ # and Query.
376
+ #
377
+ # Because Timestream’s SDKs are designed to transparently work with the
378
+ # service’s architecture, including the management and mapping of the
379
+ # service endpoints, *it is not recommended that you use this API
380
+ # unless*\:
381
+ #
382
+ # * Your application uses a programming language that does not yet have
383
+ # SDK support
384
+ #
385
+ # * You require better control over the client-side implementation
386
+ #
387
+ # For detailed information on how to use DescribeEndpoints, see [The
388
+ # Endpoint Discovery Pattern and REST APIs][1].
389
+ #
390
+ #
391
+ #
392
+ # [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery.html
393
+ #
394
+ # @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
395
+ #
396
+ # * {Types::DescribeEndpointsResponse#endpoints #endpoints} => Array&lt;Types::Endpoint&gt;
397
+ #
398
+ # @example Response structure
399
+ #
400
+ # resp.endpoints #=> Array
401
+ # resp.endpoints[0].address #=> String
402
+ # resp.endpoints[0].cache_period_in_minutes #=> Integer
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeEndpoints AWS API Documentation
405
+ #
406
+ # @overload describe_endpoints(params = {})
407
+ # @param [Hash] params ({})
408
+ def describe_endpoints(params = {}, options = {})
409
+ req = build_request(:describe_endpoints, params)
410
+ req.send_request(options)
411
+ end
412
+
413
+ # Query is a synchronous operation that enables you to execute a query.
414
+ # Query will timeout after 60 seconds. You must update the default
415
+ # timeout in the SDK to support a timeout of 60 seconds. The result set
416
+ # will be truncated to 1MB. Service quotas apply. For more information,
417
+ # see Quotas in the Timestream Developer Guide.
418
+ #
419
+ # @option params [required, String] :query_string
420
+ # The query to be executed by Timestream.
421
+ #
422
+ # @option params [String] :client_token
423
+ # Unique, case-sensitive string of up to 64 ASCII characters that you
424
+ # specify when you make a Query request. Providing a `ClientToken` makes
425
+ # the call to `Query` idempotent, meaning that multiple identical calls
426
+ # have the same effect as one single call.
427
+ #
428
+ # Your query request will fail in the following cases:
429
+ #
430
+ # * If you submit a request with the same client token outside the
431
+ # 5-minute idepotency window.
432
+ #
433
+ # * If you submit a request with the same client token but a change in
434
+ # other parameters within the 5-minute idempotency window.
435
+ #
436
+ # After 4 hours, any request with the same client token is treated as a
437
+ # new request.
438
+ #
439
+ # **A suitable default value is auto-generated.** You should normally
440
+ # not need to pass this option.**
441
+ #
442
+ # @option params [String] :next_token
443
+ # A pagination token passed to get a set of results.
444
+ #
445
+ # @option params [Integer] :max_rows
446
+ # The total number of rows to return in the output. If the total number
447
+ # of rows available is more than the value specified, a NextToken is
448
+ # provided in the command's output. To resume pagination, provide the
449
+ # NextToken value in the starting-token argument of a subsequent
450
+ # command.
451
+ #
452
+ # @return [Types::QueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
453
+ #
454
+ # * {Types::QueryResponse#query_id #query_id} => String
455
+ # * {Types::QueryResponse#next_token #next_token} => String
456
+ # * {Types::QueryResponse#rows #rows} => Array&lt;Types::Row&gt;
457
+ # * {Types::QueryResponse#column_info #column_info} => Array&lt;Types::ColumnInfo&gt;
458
+ #
459
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
460
+ #
461
+ # @example Request syntax with placeholder values
462
+ #
463
+ # resp = client.query({
464
+ # query_string: "QueryString", # required
465
+ # client_token: "ClientRequestToken",
466
+ # next_token: "String",
467
+ # max_rows: 1,
468
+ # })
469
+ #
470
+ # @example Response structure
471
+ #
472
+ # resp.query_id #=> String
473
+ # resp.next_token #=> String
474
+ # resp.rows #=> Array
475
+ # resp.rows[0].data #=> Array
476
+ # resp.rows[0].data[0].scalar_value #=> String
477
+ # resp.rows[0].data[0].time_series_value #=> Array
478
+ # resp.rows[0].data[0].time_series_value[0].time #=> String
479
+ # resp.rows[0].data[0].time_series_value[0].value #=> Types::Datum
480
+ # resp.rows[0].data[0].array_value #=> Types::DatumList
481
+ # resp.rows[0].data[0].row_value #=> Types::Row
482
+ # resp.rows[0].data[0].null_value #=> Boolean
483
+ # resp.column_info #=> Array
484
+ # resp.column_info[0].name #=> String
485
+ # resp.column_info[0].type.scalar_type #=> String, one of "VARCHAR", "BOOLEAN", "BIGINT", "DOUBLE", "TIMESTAMP", "DATE", "TIME", "INTERVAL_DAY_TO_SECOND", "INTERVAL_YEAR_TO_MONTH", "UNKNOWN", "INTEGER"
486
+ # resp.column_info[0].type.array_column_info #=> Types::ColumnInfo
487
+ # resp.column_info[0].type.time_series_measure_value_column_info #=> Types::ColumnInfo
488
+ # resp.column_info[0].type.row_column_info #=> Types::ColumnInfoList
489
+ #
490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Query AWS API Documentation
491
+ #
492
+ # @overload query(params = {})
493
+ # @param [Hash] params ({})
494
+ def query(params = {}, options = {})
495
+ req = build_request(:query, params)
496
+ req.send_request(options)
497
+ end
498
+
499
+ # @!endgroup
500
+
501
+ # @param params ({})
502
+ # @api private
503
+ def build_request(operation_name, params = {})
504
+ handlers = @handlers.for(operation_name)
505
+ context = Seahorse::Client::RequestContext.new(
506
+ operation_name: operation_name,
507
+ operation: config.api.operation(operation_name),
508
+ client: self,
509
+ params: params,
510
+ config: config)
511
+ context[:gem_name] = 'aws-sdk-timestreamquery'
512
+ context[:gem_version] = '1.0.0'
513
+ Seahorse::Client::Request.new(handlers, context)
514
+ end
515
+
516
+ # @api private
517
+ # @deprecated
518
+ def waiter_names
519
+ []
520
+ end
521
+
522
+ class << self
523
+
524
+ # @api private
525
+ attr_reader :identifier
526
+
527
+ # @api private
528
+ def errors_module
529
+ Errors
530
+ end
531
+
532
+ end
533
+ end
534
+ end