aws-sdk-athena 1.21.0 → 1.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-athena.rb +7 -4
- data/lib/aws-sdk-athena/client.rb +95 -19
- data/lib/aws-sdk-athena/client_api.rb +4 -0
- data/lib/aws-sdk-athena/errors.rb +26 -4
- data/lib/aws-sdk-athena/resource.rb +1 -0
- data/lib/aws-sdk-athena/types.rb +54 -24
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 153434d1a7bd6aa063aa1a4b4af05c6c3ecf6ea32b3246e5fcb7fdb0c3081b55
|
4
|
+
data.tar.gz: fb707b1f72a69b9c02b8d9bbab1b62d4df9e60616cc41c6799733bdcafb8c016
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 553322ade016623483639392c26ff9003e6189b76063f298c9096e4bbe4597d9ac60be8c29a9f3f066cb9e3b0b5a39af48718e309fd7e9d09a684e42e0562a87
|
7
|
+
data.tar.gz: 255eb3599d4c3e8f3062a73d24f3d6472cd5e87531fc949b2121facb9973dee373b60ee80ee73a53e4e1283f8b5870889c0a8616944f472b3f0e122179ff309a
|
data/lib/aws-sdk-athena.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-athena/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# athena = Aws::Athena::Client.new
|
28
|
+
# resp = athena.batch_get_named_query(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Athena
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Athena are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Athena::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Athena API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-athena/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Athena
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.26.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:athena)
|
31
31
|
|
32
32
|
module Aws::Athena
|
33
|
+
# An API client for Athena. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Athena::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Athena
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Athena
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Athena
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Athena
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Athena
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Athena
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Athena
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::Athena
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::Athena
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -351,6 +405,10 @@ module Aws::Athena
|
|
351
405
|
# resp.query_executions[0].statistics.engine_execution_time_in_millis #=> Integer
|
352
406
|
# resp.query_executions[0].statistics.data_scanned_in_bytes #=> Integer
|
353
407
|
# resp.query_executions[0].statistics.data_manifest_location #=> String
|
408
|
+
# resp.query_executions[0].statistics.total_execution_time_in_millis #=> Integer
|
409
|
+
# resp.query_executions[0].statistics.query_queue_time_in_millis #=> Integer
|
410
|
+
# resp.query_executions[0].statistics.query_planning_time_in_millis #=> Integer
|
411
|
+
# resp.query_executions[0].statistics.service_processing_time_in_millis #=> Integer
|
354
412
|
# resp.query_executions[0].work_group #=> String
|
355
413
|
# resp.unprocessed_query_execution_ids #=> Array
|
356
414
|
# resp.unprocessed_query_execution_ids[0].query_execution_id #=> String
|
@@ -623,6 +681,10 @@ module Aws::Athena
|
|
623
681
|
# resp.query_execution.statistics.engine_execution_time_in_millis #=> Integer
|
624
682
|
# resp.query_execution.statistics.data_scanned_in_bytes #=> Integer
|
625
683
|
# resp.query_execution.statistics.data_manifest_location #=> String
|
684
|
+
# resp.query_execution.statistics.total_execution_time_in_millis #=> Integer
|
685
|
+
# resp.query_execution.statistics.query_queue_time_in_millis #=> Integer
|
686
|
+
# resp.query_execution.statistics.query_planning_time_in_millis #=> Integer
|
687
|
+
# resp.query_execution.statistics.service_processing_time_in_millis #=> Integer
|
626
688
|
# resp.query_execution.work_group #=> String
|
627
689
|
#
|
628
690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution AWS API Documentation
|
@@ -670,6 +732,8 @@ module Aws::Athena
|
|
670
732
|
# * {Types::GetQueryResultsOutput#result_set #result_set} => Types::ResultSet
|
671
733
|
# * {Types::GetQueryResultsOutput#next_token #next_token} => String
|
672
734
|
#
|
735
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
736
|
+
#
|
673
737
|
# @example Request syntax with placeholder values
|
674
738
|
#
|
675
739
|
# resp = client.get_query_results({
|
@@ -746,6 +810,8 @@ module Aws::Athena
|
|
746
810
|
|
747
811
|
# Provides a list of available query IDs only for queries saved in the
|
748
812
|
# specified workgroup. Requires that you have access to the workgroup.
|
813
|
+
# If a workgroup is not specified, lists the saved queries for the
|
814
|
+
# primary workgroup.
|
749
815
|
#
|
750
816
|
# For code samples using the AWS SDK for Java, see [Examples and Code
|
751
817
|
# Samples][1] in the *Amazon Athena User Guide*.
|
@@ -762,14 +828,17 @@ module Aws::Athena
|
|
762
828
|
# The maximum number of queries to return in this request.
|
763
829
|
#
|
764
830
|
# @option params [String] :work_group
|
765
|
-
# The name of the workgroup from which the named queries are
|
766
|
-
#
|
831
|
+
# The name of the workgroup from which the named queries are returned.
|
832
|
+
# If a workgroup is not specified, the saved queries for the primary
|
833
|
+
# workgroup are returned.
|
767
834
|
#
|
768
835
|
# @return [Types::ListNamedQueriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
769
836
|
#
|
770
837
|
# * {Types::ListNamedQueriesOutput#named_query_ids #named_query_ids} => Array<String>
|
771
838
|
# * {Types::ListNamedQueriesOutput#next_token #next_token} => String
|
772
839
|
#
|
840
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
841
|
+
#
|
773
842
|
# @example Request syntax with placeholder values
|
774
843
|
#
|
775
844
|
# resp = client.list_named_queries({
|
@@ -794,8 +863,9 @@ module Aws::Athena
|
|
794
863
|
end
|
795
864
|
|
796
865
|
# Provides a list of available query execution IDs for the queries in
|
797
|
-
# the specified workgroup.
|
798
|
-
#
|
866
|
+
# the specified workgroup. If a workgroup is not specified, returns a
|
867
|
+
# list of query execution IDs for the primary workgroup. Requires you to
|
868
|
+
# have access to the workgroup in which the queries ran.
|
799
869
|
#
|
800
870
|
# For code samples using the AWS SDK for Java, see [Examples and Code
|
801
871
|
# Samples][1] in the *Amazon Athena User Guide*.
|
@@ -812,13 +882,17 @@ module Aws::Athena
|
|
812
882
|
# The maximum number of query executions to return in this request.
|
813
883
|
#
|
814
884
|
# @option params [String] :work_group
|
815
|
-
# The name of the workgroup from which queries are
|
885
|
+
# The name of the workgroup from which queries are returned. If a
|
886
|
+
# workgroup is not specified, a list of available query execution IDs
|
887
|
+
# for the queries in the primary workgroup is returned.
|
816
888
|
#
|
817
889
|
# @return [Types::ListQueryExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
890
|
#
|
819
891
|
# * {Types::ListQueryExecutionsOutput#query_execution_ids #query_execution_ids} => Array<String>
|
820
892
|
# * {Types::ListQueryExecutionsOutput#next_token #next_token} => String
|
821
893
|
#
|
894
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
895
|
+
#
|
822
896
|
# @example Request syntax with placeholder values
|
823
897
|
#
|
824
898
|
# resp = client.list_query_executions({
|
@@ -898,6 +972,8 @@ module Aws::Athena
|
|
898
972
|
# * {Types::ListWorkGroupsOutput#work_groups #work_groups} => Array<Types::WorkGroupSummary>
|
899
973
|
# * {Types::ListWorkGroupsOutput#next_token #next_token} => String
|
900
974
|
#
|
975
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
976
|
+
#
|
901
977
|
# @example Request syntax with placeholder values
|
902
978
|
#
|
903
979
|
# resp = client.list_work_groups({
|
@@ -1177,7 +1253,7 @@ module Aws::Athena
|
|
1177
1253
|
params: params,
|
1178
1254
|
config: config)
|
1179
1255
|
context[:gem_name] = 'aws-sdk-athena'
|
1180
|
-
context[:gem_version] = '1.
|
1256
|
+
context[:gem_version] = '1.26.0'
|
1181
1257
|
Seahorse::Client::Request.new(handlers, context)
|
1182
1258
|
end
|
1183
1259
|
|
@@ -287,6 +287,10 @@ module Aws::Athena
|
|
287
287
|
QueryExecutionStatistics.add_member(:engine_execution_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "EngineExecutionTimeInMillis"))
|
288
288
|
QueryExecutionStatistics.add_member(:data_scanned_in_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "DataScannedInBytes"))
|
289
289
|
QueryExecutionStatistics.add_member(:data_manifest_location, Shapes::ShapeRef.new(shape: String, location_name: "DataManifestLocation"))
|
290
|
+
QueryExecutionStatistics.add_member(:total_execution_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "TotalExecutionTimeInMillis"))
|
291
|
+
QueryExecutionStatistics.add_member(:query_queue_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "QueryQueueTimeInMillis"))
|
292
|
+
QueryExecutionStatistics.add_member(:query_planning_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "QueryPlanningTimeInMillis"))
|
293
|
+
QueryExecutionStatistics.add_member(:service_processing_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "ServiceProcessingTimeInMillis"))
|
290
294
|
QueryExecutionStatistics.struct_class = Types::QueryExecutionStatistics
|
291
295
|
|
292
296
|
QueryExecutionStatus.add_member(:state, Shapes::ShapeRef.new(shape: QueryExecutionState, location_name: "State"))
|
@@ -6,6 +6,32 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::Athena
|
9
|
+
|
10
|
+
# When Athena returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::Athena::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all Athena errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::Athena::Errors::ServiceError
|
18
|
+
# # rescues all Athena API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {InternalServerException}
|
29
|
+
# * {InvalidRequestException}
|
30
|
+
# * {ResourceNotFoundException}
|
31
|
+
# * {TooManyRequestsException}
|
32
|
+
#
|
33
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
34
|
+
# if they are not defined above.
|
9
35
|
module Errors
|
10
36
|
|
11
37
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +49,6 @@ module Aws::Athena
|
|
23
49
|
def message
|
24
50
|
@message || @data[:message]
|
25
51
|
end
|
26
|
-
|
27
52
|
end
|
28
53
|
|
29
54
|
class InvalidRequestException < ServiceError
|
@@ -44,7 +69,6 @@ module Aws::Athena
|
|
44
69
|
def message
|
45
70
|
@message || @data[:message]
|
46
71
|
end
|
47
|
-
|
48
72
|
end
|
49
73
|
|
50
74
|
class ResourceNotFoundException < ServiceError
|
@@ -65,7 +89,6 @@ module Aws::Athena
|
|
65
89
|
def resource_name
|
66
90
|
@data[:resource_name]
|
67
91
|
end
|
68
|
-
|
69
92
|
end
|
70
93
|
|
71
94
|
class TooManyRequestsException < ServiceError
|
@@ -86,7 +109,6 @@ module Aws::Athena
|
|
86
109
|
def reason
|
87
110
|
@data[:reason]
|
88
111
|
end
|
89
|
-
|
90
112
|
end
|
91
113
|
|
92
114
|
end
|
data/lib/aws-sdk-athena/types.rb
CHANGED
@@ -565,8 +565,9 @@ module Aws::Athena
|
|
565
565
|
# @return [Integer]
|
566
566
|
#
|
567
567
|
# @!attribute [rw] work_group
|
568
|
-
# The name of the workgroup from which the named queries are
|
569
|
-
#
|
568
|
+
# The name of the workgroup from which the named queries are returned.
|
569
|
+
# If a workgroup is not specified, the saved queries for the primary
|
570
|
+
# workgroup are returned.
|
570
571
|
# @return [String]
|
571
572
|
#
|
572
573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesInput AWS API Documentation
|
@@ -613,7 +614,9 @@ module Aws::Athena
|
|
613
614
|
# @return [Integer]
|
614
615
|
#
|
615
616
|
# @!attribute [rw] work_group
|
616
|
-
# The name of the workgroup from which queries are
|
617
|
+
# The name of the workgroup from which queries are returned. If a
|
618
|
+
# workgroup is not specified, a list of available query execution IDs
|
619
|
+
# for the queries in the primary workgroup is returned.
|
617
620
|
# @return [String]
|
618
621
|
#
|
619
622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutionsInput AWS API Documentation
|
@@ -807,9 +810,9 @@ module Aws::Athena
|
|
807
810
|
# @return [Types::QueryExecutionStatus]
|
808
811
|
#
|
809
812
|
# @!attribute [rw] statistics
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
+
# Query execution statistics, such as the amount of data scanned, the
|
814
|
+
# amount of time that the query took to process, and the type of
|
815
|
+
# statement that was run.
|
813
816
|
# @return [Types::QueryExecutionStatistics]
|
814
817
|
#
|
815
818
|
# @!attribute [rw] work_group
|
@@ -850,9 +853,9 @@ module Aws::Athena
|
|
850
853
|
include Aws::Structure
|
851
854
|
end
|
852
855
|
|
853
|
-
# The
|
854
|
-
#
|
855
|
-
#
|
856
|
+
# The amount of data scanned during the query execution and the amount
|
857
|
+
# of time that it took to execute, and the type of statement that was
|
858
|
+
# run.
|
856
859
|
#
|
857
860
|
# @!attribute [rw] engine_execution_time_in_millis
|
858
861
|
# The number of milliseconds that the query took to execute.
|
@@ -864,24 +867,52 @@ module Aws::Athena
|
|
864
867
|
#
|
865
868
|
# @!attribute [rw] data_manifest_location
|
866
869
|
# The location and file name of a data manifest file. The manifest
|
867
|
-
# file is saved to the Athena query results location in Amazon S3.
|
868
|
-
# tracks files that the query wrote to Amazon S3. If the
|
869
|
-
# the manifest file also tracks files that the query
|
870
|
-
# write. The manifest is useful for identifying orphaned
|
871
|
-
# resulting from a failed query. For more information, see
|
872
|
-
# with Query Output Files][1] in
|
870
|
+
# file is saved to the Athena query results location in Amazon S3. The
|
871
|
+
# manifest file tracks files that the query wrote to Amazon S3. If the
|
872
|
+
# query fails, the manifest file also tracks files that the query
|
873
|
+
# intended to write. The manifest is useful for identifying orphaned
|
874
|
+
# files resulting from a failed query. For more information, see
|
875
|
+
# [Working with Query Results, Output Files, and Query History][1] in
|
876
|
+
# the *Amazon Athena User Guide*.
|
873
877
|
#
|
874
878
|
#
|
875
879
|
#
|
876
880
|
# [1]: https://docs.aws.amazon.com/athena/latest/ug/querying.html
|
877
881
|
# @return [String]
|
878
882
|
#
|
883
|
+
# @!attribute [rw] total_execution_time_in_millis
|
884
|
+
# The number of milliseconds that Athena took to run the query.
|
885
|
+
# @return [Integer]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] query_queue_time_in_millis
|
888
|
+
# The number of milliseconds that the query was in your query queue
|
889
|
+
# waiting for resources. Note that if transient errors occur, Athena
|
890
|
+
# might automatically add the query back to the queue.
|
891
|
+
# @return [Integer]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] query_planning_time_in_millis
|
894
|
+
# The number of milliseconds that Athena took to plan the query
|
895
|
+
# processing flow. This includes the time spent retrieving table
|
896
|
+
# partitions from the data source. Note that because the query engine
|
897
|
+
# performs the query planning, query planning time is a subset of
|
898
|
+
# engine processing time.
|
899
|
+
# @return [Integer]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] service_processing_time_in_millis
|
902
|
+
# The number of milliseconds that Athena took to finalize and publish
|
903
|
+
# the query results after the query engine finished running the query.
|
904
|
+
# @return [Integer]
|
905
|
+
#
|
879
906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecutionStatistics AWS API Documentation
|
880
907
|
#
|
881
908
|
class QueryExecutionStatistics < Struct.new(
|
882
909
|
:engine_execution_time_in_millis,
|
883
910
|
:data_scanned_in_bytes,
|
884
|
-
:data_manifest_location
|
911
|
+
:data_manifest_location,
|
912
|
+
:total_execution_time_in_millis,
|
913
|
+
:query_queue_time_in_millis,
|
914
|
+
:query_planning_time_in_millis,
|
915
|
+
:service_processing_time_in_millis)
|
885
916
|
include Aws::Structure
|
886
917
|
end
|
887
918
|
|
@@ -889,14 +920,13 @@ module Aws::Athena
|
|
889
920
|
# reason (if applicable) for the query execution.
|
890
921
|
#
|
891
922
|
# @!attribute [rw] state
|
892
|
-
# The state of query execution. `QUEUED`
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
897
|
-
#
|
898
|
-
#
|
899
|
-
# query execution.
|
923
|
+
# The state of query execution. `QUEUED` indicates that the query has
|
924
|
+
# been submitted to the service, and Athena will execute the query as
|
925
|
+
# soon as resources are available. `RUNNING` indicates that the query
|
926
|
+
# is in execution phase. `SUCCEEDED` indicates that the query
|
927
|
+
# completed without errors. `FAILED` indicates that the query
|
928
|
+
# experienced an error and did not complete processing. `CANCELLED`
|
929
|
+
# indicates that a user input interrupted query execution.
|
900
930
|
# @return [String]
|
901
931
|
#
|
902
932
|
# @!attribute [rw] state_change_reason
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-athena
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.26.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - Amazon Athena
|