aws-sdk-athena 1.24.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-athena.rb +3 -1
- data/lib/aws-sdk-athena/client.rb +508 -55
- data/lib/aws-sdk-athena/client_api.rb +276 -0
- data/lib/aws-sdk-athena/errors.rb +18 -0
- data/lib/aws-sdk-athena/resource.rb +2 -0
- data/lib/aws-sdk-athena/types.rb +791 -45
- metadata +5 -5
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -27,6 +29,7 @@ module Aws::Athena
|
|
27
29
|
# ## Error Classes
|
28
30
|
# * {InternalServerException}
|
29
31
|
# * {InvalidRequestException}
|
32
|
+
# * {MetadataException}
|
30
33
|
# * {ResourceNotFoundException}
|
31
34
|
# * {TooManyRequestsException}
|
32
35
|
#
|
@@ -71,6 +74,21 @@ module Aws::Athena
|
|
71
74
|
end
|
72
75
|
end
|
73
76
|
|
77
|
+
class MetadataException < ServiceError
|
78
|
+
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
80
|
+
# @param [String] message
|
81
|
+
# @param [Aws::Athena::Types::MetadataException] data
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
83
|
+
super(context, message, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @return [String]
|
87
|
+
def message
|
88
|
+
@message || @data[:message]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
74
92
|
class ResourceNotFoundException < ServiceError
|
75
93
|
|
76
94
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-athena/types.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -23,6 +25,7 @@ module Aws::Athena
|
|
23
25
|
#
|
24
26
|
class BatchGetNamedQueryInput < Struct.new(
|
25
27
|
:named_query_ids)
|
28
|
+
SENSITIVE = []
|
26
29
|
include Aws::Structure
|
27
30
|
end
|
28
31
|
|
@@ -39,6 +42,7 @@ module Aws::Athena
|
|
39
42
|
class BatchGetNamedQueryOutput < Struct.new(
|
40
43
|
:named_queries,
|
41
44
|
:unprocessed_named_query_ids)
|
45
|
+
SENSITIVE = []
|
42
46
|
include Aws::Structure
|
43
47
|
end
|
44
48
|
|
@@ -57,6 +61,7 @@ module Aws::Athena
|
|
57
61
|
#
|
58
62
|
class BatchGetQueryExecutionInput < Struct.new(
|
59
63
|
:query_execution_ids)
|
64
|
+
SENSITIVE = []
|
60
65
|
include Aws::Structure
|
61
66
|
end
|
62
67
|
|
@@ -73,6 +78,31 @@ module Aws::Athena
|
|
73
78
|
class BatchGetQueryExecutionOutput < Struct.new(
|
74
79
|
:query_executions,
|
75
80
|
:unprocessed_query_execution_ids)
|
81
|
+
SENSITIVE = []
|
82
|
+
include Aws::Structure
|
83
|
+
end
|
84
|
+
|
85
|
+
# Contains metadata for a column in a table.
|
86
|
+
#
|
87
|
+
# @!attribute [rw] name
|
88
|
+
# The name of the column.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] type
|
92
|
+
# The data type of the column.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] comment
|
96
|
+
# Optional information about the column.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Column AWS API Documentation
|
100
|
+
#
|
101
|
+
class Column < Struct.new(
|
102
|
+
:name,
|
103
|
+
:type,
|
104
|
+
:comment)
|
105
|
+
SENSITIVE = []
|
76
106
|
include Aws::Structure
|
77
107
|
end
|
78
108
|
|
@@ -133,9 +163,95 @@ module Aws::Athena
|
|
133
163
|
:scale,
|
134
164
|
:nullable,
|
135
165
|
:case_sensitive)
|
166
|
+
SENSITIVE = []
|
136
167
|
include Aws::Structure
|
137
168
|
end
|
138
169
|
|
170
|
+
# @note When making an API call, you may pass CreateDataCatalogInput
|
171
|
+
# data as a hash:
|
172
|
+
#
|
173
|
+
# {
|
174
|
+
# name: "CatalogNameString", # required
|
175
|
+
# type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE
|
176
|
+
# description: "DescriptionString",
|
177
|
+
# parameters: {
|
178
|
+
# "KeyString" => "ParametersMapValue",
|
179
|
+
# },
|
180
|
+
# tags: [
|
181
|
+
# {
|
182
|
+
# key: "TagKey",
|
183
|
+
# value: "TagValue",
|
184
|
+
# },
|
185
|
+
# ],
|
186
|
+
# }
|
187
|
+
#
|
188
|
+
# @!attribute [rw] name
|
189
|
+
# The name of the data catalog to create. The catalog name must be
|
190
|
+
# unique for the AWS account and can use a maximum of 128
|
191
|
+
# alphanumeric, underscore, at sign, or hyphen characters.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] type
|
195
|
+
# The type of data catalog to create: `LAMBDA` for a federated
|
196
|
+
# catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive
|
197
|
+
# metastore.
|
198
|
+
# @return [String]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] description
|
201
|
+
# A description of the data catalog to be created.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] parameters
|
205
|
+
# Specifies the Lambda function or functions to use for creating the
|
206
|
+
# data catalog. This is a mapping whose values depend on the catalog
|
207
|
+
# type.
|
208
|
+
#
|
209
|
+
# * For the `HIVE` data catalog type, use the following syntax. The
|
210
|
+
# `metadata-function` parameter is required. `The sdk-version`
|
211
|
+
# parameter is optional and defaults to the currently supported
|
212
|
+
# version.
|
213
|
+
#
|
214
|
+
# `metadata-function=lambda_arn, sdk-version=version_number `
|
215
|
+
#
|
216
|
+
# * For the `LAMBDA` data catalog type, use one of the following sets
|
217
|
+
# of required parameters, but not both.
|
218
|
+
#
|
219
|
+
# * If you have one Lambda function that processes metadata and
|
220
|
+
# another for reading the actual data, use the following syntax.
|
221
|
+
# Both parameters are required.
|
222
|
+
#
|
223
|
+
# `metadata-function=lambda_arn, record-function=lambda_arn `
|
224
|
+
#
|
225
|
+
# * If you have a composite Lambda function that processes both
|
226
|
+
# metadata and data, use the following syntax to specify your
|
227
|
+
# Lambda function.
|
228
|
+
#
|
229
|
+
# `function=lambda_arn `
|
230
|
+
#
|
231
|
+
# * The `GLUE` type has no parameters.
|
232
|
+
# @return [Hash<String,String>]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] tags
|
235
|
+
# A list of comma separated tags to add to the data catalog that is
|
236
|
+
# created.
|
237
|
+
# @return [Array<Types::Tag>]
|
238
|
+
#
|
239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateDataCatalogInput AWS API Documentation
|
240
|
+
#
|
241
|
+
class CreateDataCatalogInput < Struct.new(
|
242
|
+
:name,
|
243
|
+
:type,
|
244
|
+
:description,
|
245
|
+
:parameters,
|
246
|
+
:tags)
|
247
|
+
SENSITIVE = []
|
248
|
+
include Aws::Structure
|
249
|
+
end
|
250
|
+
|
251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateDataCatalogOutput AWS API Documentation
|
252
|
+
#
|
253
|
+
class CreateDataCatalogOutput < Aws::EmptyStructure; end
|
254
|
+
|
139
255
|
# @note When making an API call, you may pass CreateNamedQueryInput
|
140
256
|
# data as a hash:
|
141
257
|
#
|
@@ -193,6 +309,7 @@ module Aws::Athena
|
|
193
309
|
:query_string,
|
194
310
|
:client_request_token,
|
195
311
|
:work_group)
|
312
|
+
SENSITIVE = []
|
196
313
|
include Aws::Structure
|
197
314
|
end
|
198
315
|
|
@@ -204,6 +321,7 @@ module Aws::Athena
|
|
204
321
|
#
|
205
322
|
class CreateNamedQueryOutput < Struct.new(
|
206
323
|
:named_query_id)
|
324
|
+
SENSITIVE = []
|
207
325
|
include Aws::Structure
|
208
326
|
end
|
209
327
|
|
@@ -255,8 +373,8 @@ module Aws::Athena
|
|
255
373
|
# @return [String]
|
256
374
|
#
|
257
375
|
# @!attribute [rw] tags
|
258
|
-
#
|
259
|
-
#
|
376
|
+
# A list of comma separated tags to add to the workgroup that is
|
377
|
+
# created.
|
260
378
|
# @return [Array<Types::Tag>]
|
261
379
|
#
|
262
380
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroupInput AWS API Documentation
|
@@ -266,6 +384,7 @@ module Aws::Athena
|
|
266
384
|
:configuration,
|
267
385
|
:description,
|
268
386
|
:tags)
|
387
|
+
SENSITIVE = []
|
269
388
|
include Aws::Structure
|
270
389
|
end
|
271
390
|
|
@@ -273,6 +392,107 @@ module Aws::Athena
|
|
273
392
|
#
|
274
393
|
class CreateWorkGroupOutput < Aws::EmptyStructure; end
|
275
394
|
|
395
|
+
# Contains information about a data catalog in an AWS account.
|
396
|
+
#
|
397
|
+
# @!attribute [rw] name
|
398
|
+
# The name of the data catalog. The catalog name must be unique for
|
399
|
+
# the AWS account and can use a maximum of 128 alphanumeric,
|
400
|
+
# underscore, at sign, or hyphen characters.
|
401
|
+
# @return [String]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] description
|
404
|
+
# An optional description of the data catalog.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] type
|
408
|
+
# The type of data catalog: `LAMBDA` for a federated catalog, `GLUE`
|
409
|
+
# for AWS Glue Catalog, or `HIVE` for an external hive metastore.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] parameters
|
413
|
+
# Specifies the Lambda function or functions to use for the data
|
414
|
+
# catalog. This is a mapping whose values depend on the catalog type.
|
415
|
+
#
|
416
|
+
# * For the `HIVE` data catalog type, use the following syntax. The
|
417
|
+
# `metadata-function` parameter is required. `The sdk-version`
|
418
|
+
# parameter is optional and defaults to the currently supported
|
419
|
+
# version.
|
420
|
+
#
|
421
|
+
# `metadata-function=lambda_arn, sdk-version=version_number `
|
422
|
+
#
|
423
|
+
# * For the `LAMBDA` data catalog type, use one of the following sets
|
424
|
+
# of required parameters, but not both.
|
425
|
+
#
|
426
|
+
# * If you have one Lambda function that processes metadata and
|
427
|
+
# another for reading the actual data, use the following syntax.
|
428
|
+
# Both parameters are required.
|
429
|
+
#
|
430
|
+
# `metadata-function=lambda_arn, record-function=lambda_arn `
|
431
|
+
#
|
432
|
+
# * If you have a composite Lambda function that processes both
|
433
|
+
# metadata and data, use the following syntax to specify your
|
434
|
+
# Lambda function.
|
435
|
+
#
|
436
|
+
# `function=lambda_arn `
|
437
|
+
#
|
438
|
+
# * The `GLUE` type has no parameters.
|
439
|
+
# @return [Hash<String,String>]
|
440
|
+
#
|
441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DataCatalog AWS API Documentation
|
442
|
+
#
|
443
|
+
class DataCatalog < Struct.new(
|
444
|
+
:name,
|
445
|
+
:description,
|
446
|
+
:type,
|
447
|
+
:parameters)
|
448
|
+
SENSITIVE = []
|
449
|
+
include Aws::Structure
|
450
|
+
end
|
451
|
+
|
452
|
+
# The summary information for the data catalog, which includes its name
|
453
|
+
# and type.
|
454
|
+
#
|
455
|
+
# @!attribute [rw] catalog_name
|
456
|
+
# The name of the data catalog.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] type
|
460
|
+
# The data catalog type.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DataCatalogSummary AWS API Documentation
|
464
|
+
#
|
465
|
+
class DataCatalogSummary < Struct.new(
|
466
|
+
:catalog_name,
|
467
|
+
:type)
|
468
|
+
SENSITIVE = []
|
469
|
+
include Aws::Structure
|
470
|
+
end
|
471
|
+
|
472
|
+
# Contains metadata information for a database in a data catalog.
|
473
|
+
#
|
474
|
+
# @!attribute [rw] name
|
475
|
+
# The name of the database.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] description
|
479
|
+
# An optional description of the database.
|
480
|
+
# @return [String]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] parameters
|
483
|
+
# A set of custom key/value pairs.
|
484
|
+
# @return [Hash<String,String>]
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Database AWS API Documentation
|
487
|
+
#
|
488
|
+
class Database < Struct.new(
|
489
|
+
:name,
|
490
|
+
:description,
|
491
|
+
:parameters)
|
492
|
+
SENSITIVE = []
|
493
|
+
include Aws::Structure
|
494
|
+
end
|
495
|
+
|
276
496
|
# A piece of data (a field in the table).
|
277
497
|
#
|
278
498
|
# @!attribute [rw] var_char_value
|
@@ -283,9 +503,33 @@ module Aws::Athena
|
|
283
503
|
#
|
284
504
|
class Datum < Struct.new(
|
285
505
|
:var_char_value)
|
506
|
+
SENSITIVE = []
|
507
|
+
include Aws::Structure
|
508
|
+
end
|
509
|
+
|
510
|
+
# @note When making an API call, you may pass DeleteDataCatalogInput
|
511
|
+
# data as a hash:
|
512
|
+
#
|
513
|
+
# {
|
514
|
+
# name: "CatalogNameString", # required
|
515
|
+
# }
|
516
|
+
#
|
517
|
+
# @!attribute [rw] name
|
518
|
+
# The name of the data catalog to delete.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteDataCatalogInput AWS API Documentation
|
522
|
+
#
|
523
|
+
class DeleteDataCatalogInput < Struct.new(
|
524
|
+
:name)
|
525
|
+
SENSITIVE = []
|
286
526
|
include Aws::Structure
|
287
527
|
end
|
288
528
|
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteDataCatalogOutput AWS API Documentation
|
530
|
+
#
|
531
|
+
class DeleteDataCatalogOutput < Aws::EmptyStructure; end
|
532
|
+
|
289
533
|
# @note When making an API call, you may pass DeleteNamedQueryInput
|
290
534
|
# data as a hash:
|
291
535
|
#
|
@@ -304,6 +548,7 @@ module Aws::Athena
|
|
304
548
|
#
|
305
549
|
class DeleteNamedQueryInput < Struct.new(
|
306
550
|
:named_query_id)
|
551
|
+
SENSITIVE = []
|
307
552
|
include Aws::Structure
|
308
553
|
end
|
309
554
|
|
@@ -333,6 +578,7 @@ module Aws::Athena
|
|
333
578
|
class DeleteWorkGroupInput < Struct.new(
|
334
579
|
:work_group,
|
335
580
|
:recursive_delete_option)
|
581
|
+
SENSITIVE = []
|
336
582
|
include Aws::Structure
|
337
583
|
end
|
338
584
|
|
@@ -372,6 +618,75 @@ module Aws::Athena
|
|
372
618
|
class EncryptionConfiguration < Struct.new(
|
373
619
|
:encryption_option,
|
374
620
|
:kms_key)
|
621
|
+
SENSITIVE = []
|
622
|
+
include Aws::Structure
|
623
|
+
end
|
624
|
+
|
625
|
+
# @note When making an API call, you may pass GetDataCatalogInput
|
626
|
+
# data as a hash:
|
627
|
+
#
|
628
|
+
# {
|
629
|
+
# name: "CatalogNameString", # required
|
630
|
+
# }
|
631
|
+
#
|
632
|
+
# @!attribute [rw] name
|
633
|
+
# The name of the data catalog to return.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogInput AWS API Documentation
|
637
|
+
#
|
638
|
+
class GetDataCatalogInput < Struct.new(
|
639
|
+
:name)
|
640
|
+
SENSITIVE = []
|
641
|
+
include Aws::Structure
|
642
|
+
end
|
643
|
+
|
644
|
+
# @!attribute [rw] data_catalog
|
645
|
+
# The data catalog returned.
|
646
|
+
# @return [Types::DataCatalog]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogOutput AWS API Documentation
|
649
|
+
#
|
650
|
+
class GetDataCatalogOutput < Struct.new(
|
651
|
+
:data_catalog)
|
652
|
+
SENSITIVE = []
|
653
|
+
include Aws::Structure
|
654
|
+
end
|
655
|
+
|
656
|
+
# @note When making an API call, you may pass GetDatabaseInput
|
657
|
+
# data as a hash:
|
658
|
+
#
|
659
|
+
# {
|
660
|
+
# catalog_name: "CatalogNameString", # required
|
661
|
+
# database_name: "NameString", # required
|
662
|
+
# }
|
663
|
+
#
|
664
|
+
# @!attribute [rw] catalog_name
|
665
|
+
# The name of the data catalog that contains the database to return.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] database_name
|
669
|
+
# The name of the database to return.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseInput AWS API Documentation
|
673
|
+
#
|
674
|
+
class GetDatabaseInput < Struct.new(
|
675
|
+
:catalog_name,
|
676
|
+
:database_name)
|
677
|
+
SENSITIVE = []
|
678
|
+
include Aws::Structure
|
679
|
+
end
|
680
|
+
|
681
|
+
# @!attribute [rw] database
|
682
|
+
# The database returned.
|
683
|
+
# @return [Types::Database]
|
684
|
+
#
|
685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseOutput AWS API Documentation
|
686
|
+
#
|
687
|
+
class GetDatabaseOutput < Struct.new(
|
688
|
+
:database)
|
689
|
+
SENSITIVE = []
|
375
690
|
include Aws::Structure
|
376
691
|
end
|
377
692
|
|
@@ -390,6 +705,7 @@ module Aws::Athena
|
|
390
705
|
#
|
391
706
|
class GetNamedQueryInput < Struct.new(
|
392
707
|
:named_query_id)
|
708
|
+
SENSITIVE = []
|
393
709
|
include Aws::Structure
|
394
710
|
end
|
395
711
|
|
@@ -401,6 +717,7 @@ module Aws::Athena
|
|
401
717
|
#
|
402
718
|
class GetNamedQueryOutput < Struct.new(
|
403
719
|
:named_query)
|
720
|
+
SENSITIVE = []
|
404
721
|
include Aws::Structure
|
405
722
|
end
|
406
723
|
|
@@ -419,6 +736,7 @@ module Aws::Athena
|
|
419
736
|
#
|
420
737
|
class GetQueryExecutionInput < Struct.new(
|
421
738
|
:query_execution_id)
|
739
|
+
SENSITIVE = []
|
422
740
|
include Aws::Structure
|
423
741
|
end
|
424
742
|
|
@@ -430,6 +748,7 @@ module Aws::Athena
|
|
430
748
|
#
|
431
749
|
class GetQueryExecutionOutput < Struct.new(
|
432
750
|
:query_execution)
|
751
|
+
SENSITIVE = []
|
433
752
|
include Aws::Structure
|
434
753
|
end
|
435
754
|
|
@@ -447,8 +766,10 @@ module Aws::Athena
|
|
447
766
|
# @return [String]
|
448
767
|
#
|
449
768
|
# @!attribute [rw] next_token
|
450
|
-
#
|
451
|
-
# request was truncated.
|
769
|
+
# A token generated by the Athena service that specifies where to
|
770
|
+
# continue pagination if a previous request was truncated. To obtain
|
771
|
+
# the next set of pages, pass in the `NextToken` from the response
|
772
|
+
# object of the previous page call.
|
452
773
|
# @return [String]
|
453
774
|
#
|
454
775
|
# @!attribute [rw] max_results
|
@@ -461,6 +782,7 @@ module Aws::Athena
|
|
461
782
|
:query_execution_id,
|
462
783
|
:next_token,
|
463
784
|
:max_results)
|
785
|
+
SENSITIVE = []
|
464
786
|
include Aws::Structure
|
465
787
|
end
|
466
788
|
|
@@ -473,7 +795,10 @@ module Aws::Athena
|
|
473
795
|
# @return [Types::ResultSet]
|
474
796
|
#
|
475
797
|
# @!attribute [rw] next_token
|
476
|
-
# A token
|
798
|
+
# A token generated by the Athena service that specifies where to
|
799
|
+
# continue pagination if a previous request was truncated. To obtain
|
800
|
+
# the next set of pages, pass in the `NextToken` from the response
|
801
|
+
# object of the previous page call.
|
477
802
|
# @return [String]
|
478
803
|
#
|
479
804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResultsOutput AWS API Documentation
|
@@ -482,6 +807,51 @@ module Aws::Athena
|
|
482
807
|
:update_count,
|
483
808
|
:result_set,
|
484
809
|
:next_token)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# @note When making an API call, you may pass GetTableMetadataInput
|
815
|
+
# data as a hash:
|
816
|
+
#
|
817
|
+
# {
|
818
|
+
# catalog_name: "CatalogNameString", # required
|
819
|
+
# database_name: "NameString", # required
|
820
|
+
# table_name: "NameString", # required
|
821
|
+
# }
|
822
|
+
#
|
823
|
+
# @!attribute [rw] catalog_name
|
824
|
+
# The name of the data catalog that contains the database and table
|
825
|
+
# metadata to return.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] database_name
|
829
|
+
# The name of the database that contains the table metadata to return.
|
830
|
+
# @return [String]
|
831
|
+
#
|
832
|
+
# @!attribute [rw] table_name
|
833
|
+
# The name of the table for which metadata is returned.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetTableMetadataInput AWS API Documentation
|
837
|
+
#
|
838
|
+
class GetTableMetadataInput < Struct.new(
|
839
|
+
:catalog_name,
|
840
|
+
:database_name,
|
841
|
+
:table_name)
|
842
|
+
SENSITIVE = []
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @!attribute [rw] table_metadata
|
847
|
+
# An object that contains table metadata.
|
848
|
+
# @return [Types::TableMetadata]
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetTableMetadataOutput AWS API Documentation
|
851
|
+
#
|
852
|
+
class GetTableMetadataOutput < Struct.new(
|
853
|
+
:table_metadata)
|
854
|
+
SENSITIVE = []
|
485
855
|
include Aws::Structure
|
486
856
|
end
|
487
857
|
|
@@ -500,6 +870,7 @@ module Aws::Athena
|
|
500
870
|
#
|
501
871
|
class GetWorkGroupInput < Struct.new(
|
502
872
|
:work_group)
|
873
|
+
SENSITIVE = []
|
503
874
|
include Aws::Structure
|
504
875
|
end
|
505
876
|
|
@@ -511,6 +882,7 @@ module Aws::Athena
|
|
511
882
|
#
|
512
883
|
class GetWorkGroupOutput < Struct.new(
|
513
884
|
:work_group)
|
885
|
+
SENSITIVE = []
|
514
886
|
include Aws::Structure
|
515
887
|
end
|
516
888
|
|
@@ -524,6 +896,7 @@ module Aws::Athena
|
|
524
896
|
#
|
525
897
|
class InternalServerException < Struct.new(
|
526
898
|
:message)
|
899
|
+
SENSITIVE = []
|
527
900
|
include Aws::Structure
|
528
901
|
end
|
529
902
|
|
@@ -543,6 +916,109 @@ module Aws::Athena
|
|
543
916
|
class InvalidRequestException < Struct.new(
|
544
917
|
:athena_error_code,
|
545
918
|
:message)
|
919
|
+
SENSITIVE = []
|
920
|
+
include Aws::Structure
|
921
|
+
end
|
922
|
+
|
923
|
+
# @note When making an API call, you may pass ListDataCatalogsInput
|
924
|
+
# data as a hash:
|
925
|
+
#
|
926
|
+
# {
|
927
|
+
# next_token: "Token",
|
928
|
+
# max_results: 1,
|
929
|
+
# }
|
930
|
+
#
|
931
|
+
# @!attribute [rw] next_token
|
932
|
+
# A token generated by the Athena service that specifies where to
|
933
|
+
# continue pagination if a previous request was truncated. To obtain
|
934
|
+
# the next set of pages, pass in the NextToken from the response
|
935
|
+
# object of the previous page call.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] max_results
|
939
|
+
# Specifies the maximum number of data catalogs to return.
|
940
|
+
# @return [Integer]
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDataCatalogsInput AWS API Documentation
|
943
|
+
#
|
944
|
+
class ListDataCatalogsInput < Struct.new(
|
945
|
+
:next_token,
|
946
|
+
:max_results)
|
947
|
+
SENSITIVE = []
|
948
|
+
include Aws::Structure
|
949
|
+
end
|
950
|
+
|
951
|
+
# @!attribute [rw] data_catalogs_summary
|
952
|
+
# A summary list of data catalogs.
|
953
|
+
# @return [Array<Types::DataCatalogSummary>]
|
954
|
+
#
|
955
|
+
# @!attribute [rw] next_token
|
956
|
+
# A token generated by the Athena service that specifies where to
|
957
|
+
# continue pagination if a previous request was truncated. To obtain
|
958
|
+
# the next set of pages, pass in the NextToken from the response
|
959
|
+
# object of the previous page call.
|
960
|
+
# @return [String]
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDataCatalogsOutput AWS API Documentation
|
963
|
+
#
|
964
|
+
class ListDataCatalogsOutput < Struct.new(
|
965
|
+
:data_catalogs_summary,
|
966
|
+
:next_token)
|
967
|
+
SENSITIVE = []
|
968
|
+
include Aws::Structure
|
969
|
+
end
|
970
|
+
|
971
|
+
# @note When making an API call, you may pass ListDatabasesInput
|
972
|
+
# data as a hash:
|
973
|
+
#
|
974
|
+
# {
|
975
|
+
# catalog_name: "CatalogNameString", # required
|
976
|
+
# next_token: "Token",
|
977
|
+
# max_results: 1,
|
978
|
+
# }
|
979
|
+
#
|
980
|
+
# @!attribute [rw] catalog_name
|
981
|
+
# The name of the data catalog that contains the databases to return.
|
982
|
+
# @return [String]
|
983
|
+
#
|
984
|
+
# @!attribute [rw] next_token
|
985
|
+
# A token generated by the Athena service that specifies where to
|
986
|
+
# continue pagination if a previous request was truncated. To obtain
|
987
|
+
# the next set of pages, pass in the `NextToken` from the response
|
988
|
+
# object of the previous page call.
|
989
|
+
# @return [String]
|
990
|
+
#
|
991
|
+
# @!attribute [rw] max_results
|
992
|
+
# Specifies the maximum number of results to return.
|
993
|
+
# @return [Integer]
|
994
|
+
#
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDatabasesInput AWS API Documentation
|
996
|
+
#
|
997
|
+
class ListDatabasesInput < Struct.new(
|
998
|
+
:catalog_name,
|
999
|
+
:next_token,
|
1000
|
+
:max_results)
|
1001
|
+
SENSITIVE = []
|
1002
|
+
include Aws::Structure
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# @!attribute [rw] database_list
|
1006
|
+
# A list of databases from a data catalog.
|
1007
|
+
# @return [Array<Types::Database>]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] next_token
|
1010
|
+
# A token generated by the Athena service that specifies where to
|
1011
|
+
# continue pagination if a previous request was truncated. To obtain
|
1012
|
+
# the next set of pages, pass in the NextToken from the response
|
1013
|
+
# object of the previous page call.
|
1014
|
+
# @return [String]
|
1015
|
+
#
|
1016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDatabasesOutput AWS API Documentation
|
1017
|
+
#
|
1018
|
+
class ListDatabasesOutput < Struct.new(
|
1019
|
+
:database_list,
|
1020
|
+
:next_token)
|
1021
|
+
SENSITIVE = []
|
546
1022
|
include Aws::Structure
|
547
1023
|
end
|
548
1024
|
|
@@ -556,8 +1032,10 @@ module Aws::Athena
|
|
556
1032
|
# }
|
557
1033
|
#
|
558
1034
|
# @!attribute [rw] next_token
|
559
|
-
#
|
560
|
-
# request was truncated.
|
1035
|
+
# A token generated by the Athena service that specifies where to
|
1036
|
+
# continue pagination if a previous request was truncated. To obtain
|
1037
|
+
# the next set of pages, pass in the `NextToken` from the response
|
1038
|
+
# object of the previous page call.
|
561
1039
|
# @return [String]
|
562
1040
|
#
|
563
1041
|
# @!attribute [rw] max_results
|
@@ -565,9 +1043,9 @@ module Aws::Athena
|
|
565
1043
|
# @return [Integer]
|
566
1044
|
#
|
567
1045
|
# @!attribute [rw] work_group
|
568
|
-
# The name of the workgroup from which the named queries are
|
569
|
-
# If a workgroup is not specified, the saved queries for the
|
570
|
-
# workgroup are returned.
|
1046
|
+
# The name of the workgroup from which the named queries are being
|
1047
|
+
# returned. If a workgroup is not specified, the saved queries for the
|
1048
|
+
# primary workgroup are returned.
|
571
1049
|
# @return [String]
|
572
1050
|
#
|
573
1051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesInput AWS API Documentation
|
@@ -576,6 +1054,7 @@ module Aws::Athena
|
|
576
1054
|
:next_token,
|
577
1055
|
:max_results,
|
578
1056
|
:work_group)
|
1057
|
+
SENSITIVE = []
|
579
1058
|
include Aws::Structure
|
580
1059
|
end
|
581
1060
|
|
@@ -584,7 +1063,10 @@ module Aws::Athena
|
|
584
1063
|
# @return [Array<String>]
|
585
1064
|
#
|
586
1065
|
# @!attribute [rw] next_token
|
587
|
-
# A token
|
1066
|
+
# A token generated by the Athena service that specifies where to
|
1067
|
+
# continue pagination if a previous request was truncated. To obtain
|
1068
|
+
# the next set of pages, pass in the `NextToken` from the response
|
1069
|
+
# object of the previous page call.
|
588
1070
|
# @return [String]
|
589
1071
|
#
|
590
1072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesOutput AWS API Documentation
|
@@ -592,6 +1074,7 @@ module Aws::Athena
|
|
592
1074
|
class ListNamedQueriesOutput < Struct.new(
|
593
1075
|
:named_query_ids,
|
594
1076
|
:next_token)
|
1077
|
+
SENSITIVE = []
|
595
1078
|
include Aws::Structure
|
596
1079
|
end
|
597
1080
|
|
@@ -605,8 +1088,10 @@ module Aws::Athena
|
|
605
1088
|
# }
|
606
1089
|
#
|
607
1090
|
# @!attribute [rw] next_token
|
608
|
-
#
|
609
|
-
# request was truncated.
|
1091
|
+
# A token generated by the Athena service that specifies where to
|
1092
|
+
# continue pagination if a previous request was truncated. To obtain
|
1093
|
+
# the next set of pages, pass in the `NextToken` from the response
|
1094
|
+
# object of the previous page call.
|
610
1095
|
# @return [String]
|
611
1096
|
#
|
612
1097
|
# @!attribute [rw] max_results
|
@@ -614,9 +1099,9 @@ module Aws::Athena
|
|
614
1099
|
# @return [Integer]
|
615
1100
|
#
|
616
1101
|
# @!attribute [rw] work_group
|
617
|
-
# The name of the workgroup from which queries are returned. If
|
618
|
-
# workgroup is not specified, a list of available query execution
|
619
|
-
# for the queries in the primary workgroup is returned.
|
1102
|
+
# The name of the workgroup from which queries are being returned. If
|
1103
|
+
# a workgroup is not specified, a list of available query execution
|
1104
|
+
# IDs for the queries in the primary workgroup is returned.
|
620
1105
|
# @return [String]
|
621
1106
|
#
|
622
1107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutionsInput AWS API Documentation
|
@@ -625,6 +1110,7 @@ module Aws::Athena
|
|
625
1110
|
:next_token,
|
626
1111
|
:max_results,
|
627
1112
|
:work_group)
|
1113
|
+
SENSITIVE = []
|
628
1114
|
include Aws::Structure
|
629
1115
|
end
|
630
1116
|
|
@@ -641,6 +1127,76 @@ module Aws::Athena
|
|
641
1127
|
class ListQueryExecutionsOutput < Struct.new(
|
642
1128
|
:query_execution_ids,
|
643
1129
|
:next_token)
|
1130
|
+
SENSITIVE = []
|
1131
|
+
include Aws::Structure
|
1132
|
+
end
|
1133
|
+
|
1134
|
+
# @note When making an API call, you may pass ListTableMetadataInput
|
1135
|
+
# data as a hash:
|
1136
|
+
#
|
1137
|
+
# {
|
1138
|
+
# catalog_name: "CatalogNameString", # required
|
1139
|
+
# database_name: "NameString", # required
|
1140
|
+
# expression: "ExpressionString",
|
1141
|
+
# next_token: "Token",
|
1142
|
+
# max_results: 1,
|
1143
|
+
# }
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] catalog_name
|
1146
|
+
# The name of the data catalog for which table metadata should be
|
1147
|
+
# returned.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] database_name
|
1151
|
+
# The name of the database for which table metadata should be
|
1152
|
+
# returned.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] expression
|
1156
|
+
# A regex filter that pattern-matches table names. If no expression is
|
1157
|
+
# supplied, metadata for all tables are listed.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] next_token
|
1161
|
+
# A token generated by the Athena service that specifies where to
|
1162
|
+
# continue pagination if a previous request was truncated. To obtain
|
1163
|
+
# the next set of pages, pass in the NextToken from the response
|
1164
|
+
# object of the previous page call.
|
1165
|
+
# @return [String]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] max_results
|
1168
|
+
# Specifies the maximum number of results to return.
|
1169
|
+
# @return [Integer]
|
1170
|
+
#
|
1171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadataInput AWS API Documentation
|
1172
|
+
#
|
1173
|
+
class ListTableMetadataInput < Struct.new(
|
1174
|
+
:catalog_name,
|
1175
|
+
:database_name,
|
1176
|
+
:expression,
|
1177
|
+
:next_token,
|
1178
|
+
:max_results)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# @!attribute [rw] table_metadata_list
|
1184
|
+
# A list of table metadata.
|
1185
|
+
# @return [Array<Types::TableMetadata>]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] next_token
|
1188
|
+
# A token generated by the Athena service that specifies where to
|
1189
|
+
# continue pagination if a previous request was truncated. To obtain
|
1190
|
+
# the next set of pages, pass in the NextToken from the response
|
1191
|
+
# object of the previous page call.
|
1192
|
+
# @return [String]
|
1193
|
+
#
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadataOutput AWS API Documentation
|
1195
|
+
#
|
1196
|
+
class ListTableMetadataOutput < Struct.new(
|
1197
|
+
:table_metadata_list,
|
1198
|
+
:next_token)
|
1199
|
+
SENSITIVE = []
|
644
1200
|
include Aws::Structure
|
645
1201
|
end
|
646
1202
|
|
@@ -654,18 +1210,18 @@ module Aws::Athena
|
|
654
1210
|
# }
|
655
1211
|
#
|
656
1212
|
# @!attribute [rw] resource_arn
|
657
|
-
# Lists the tags for the
|
1213
|
+
# Lists the tags for the resource with the specified ARN.
|
658
1214
|
# @return [String]
|
659
1215
|
#
|
660
1216
|
# @!attribute [rw] next_token
|
661
1217
|
# The token for the next set of results, or null if there are no
|
662
1218
|
# additional results for this request, where the request lists the
|
663
|
-
# tags for the
|
1219
|
+
# tags for the resource with the specified ARN.
|
664
1220
|
# @return [String]
|
665
1221
|
#
|
666
1222
|
# @!attribute [rw] max_results
|
667
1223
|
# The maximum number of results to be returned per request that lists
|
668
|
-
# the tags for the
|
1224
|
+
# the tags for the resource.
|
669
1225
|
# @return [Integer]
|
670
1226
|
#
|
671
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResourceInput AWS API Documentation
|
@@ -674,11 +1230,12 @@ module Aws::Athena
|
|
674
1230
|
:resource_arn,
|
675
1231
|
:next_token,
|
676
1232
|
:max_results)
|
1233
|
+
SENSITIVE = []
|
677
1234
|
include Aws::Structure
|
678
1235
|
end
|
679
1236
|
|
680
1237
|
# @!attribute [rw] tags
|
681
|
-
# The list of tags associated with
|
1238
|
+
# The list of tags associated with the specified resource.
|
682
1239
|
# @return [Array<Types::Tag>]
|
683
1240
|
#
|
684
1241
|
# @!attribute [rw] next_token
|
@@ -690,6 +1247,7 @@ module Aws::Athena
|
|
690
1247
|
class ListTagsForResourceOutput < Struct.new(
|
691
1248
|
:tags,
|
692
1249
|
:next_token)
|
1250
|
+
SENSITIVE = []
|
693
1251
|
include Aws::Structure
|
694
1252
|
end
|
695
1253
|
|
@@ -702,7 +1260,10 @@ module Aws::Athena
|
|
702
1260
|
# }
|
703
1261
|
#
|
704
1262
|
# @!attribute [rw] next_token
|
705
|
-
# A token
|
1263
|
+
# A token generated by the Athena service that specifies where to
|
1264
|
+
# continue pagination if a previous request was truncated. To obtain
|
1265
|
+
# the next set of pages, pass in the `NextToken` from the response
|
1266
|
+
# object of the previous page call.
|
706
1267
|
# @return [String]
|
707
1268
|
#
|
708
1269
|
# @!attribute [rw] max_results
|
@@ -714,6 +1275,7 @@ module Aws::Athena
|
|
714
1275
|
class ListWorkGroupsInput < Struct.new(
|
715
1276
|
:next_token,
|
716
1277
|
:max_results)
|
1278
|
+
SENSITIVE = []
|
717
1279
|
include Aws::Structure
|
718
1280
|
end
|
719
1281
|
|
@@ -723,7 +1285,10 @@ module Aws::Athena
|
|
723
1285
|
# @return [Array<Types::WorkGroupSummary>]
|
724
1286
|
#
|
725
1287
|
# @!attribute [rw] next_token
|
726
|
-
# A token
|
1288
|
+
# A token generated by the Athena service that specifies where to
|
1289
|
+
# continue pagination if a previous request was truncated. To obtain
|
1290
|
+
# the next set of pages, pass in the `NextToken` from the response
|
1291
|
+
# object of the previous page call.
|
727
1292
|
# @return [String]
|
728
1293
|
#
|
729
1294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroupsOutput AWS API Documentation
|
@@ -731,6 +1296,25 @@ module Aws::Athena
|
|
731
1296
|
class ListWorkGroupsOutput < Struct.new(
|
732
1297
|
:work_groups,
|
733
1298
|
:next_token)
|
1299
|
+
SENSITIVE = []
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# An exception that Athena received when it called a custom metastore.
|
1304
|
+
# Occurs if the error is not caused by user input
|
1305
|
+
# (`InvalidRequestException`) or from the Athena platform
|
1306
|
+
# (`InternalServerException`). For example, if a user-created Lambda
|
1307
|
+
# function is missing permissions, the Lambda `4XX` exception is
|
1308
|
+
# returned in a `MetadataException`.
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] message
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/MetadataException AWS API Documentation
|
1314
|
+
#
|
1315
|
+
class MetadataException < Struct.new(
|
1316
|
+
:message)
|
1317
|
+
SENSITIVE = []
|
734
1318
|
include Aws::Structure
|
735
1319
|
end
|
736
1320
|
|
@@ -770,6 +1354,7 @@ module Aws::Athena
|
|
770
1354
|
:query_string,
|
771
1355
|
:named_query_id,
|
772
1356
|
:work_group)
|
1357
|
+
SENSITIVE = []
|
773
1358
|
include Aws::Structure
|
774
1359
|
end
|
775
1360
|
|
@@ -830,26 +1415,35 @@ module Aws::Athena
|
|
830
1415
|
:status,
|
831
1416
|
:statistics,
|
832
1417
|
:work_group)
|
1418
|
+
SENSITIVE = []
|
833
1419
|
include Aws::Structure
|
834
1420
|
end
|
835
1421
|
|
836
|
-
# The database in which the query execution
|
1422
|
+
# The database and data catalog context in which the query execution
|
1423
|
+
# occurs.
|
837
1424
|
#
|
838
1425
|
# @note When making an API call, you may pass QueryExecutionContext
|
839
1426
|
# data as a hash:
|
840
1427
|
#
|
841
1428
|
# {
|
842
1429
|
# database: "DatabaseString",
|
1430
|
+
# catalog: "CatalogNameString",
|
843
1431
|
# }
|
844
1432
|
#
|
845
1433
|
# @!attribute [rw] database
|
846
|
-
# The name of the database.
|
1434
|
+
# The name of the database used in the query execution.
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] catalog
|
1438
|
+
# The name of the data catalog used in the query execution.
|
847
1439
|
# @return [String]
|
848
1440
|
#
|
849
1441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecutionContext AWS API Documentation
|
850
1442
|
#
|
851
1443
|
class QueryExecutionContext < Struct.new(
|
852
|
-
:database
|
1444
|
+
:database,
|
1445
|
+
:catalog)
|
1446
|
+
SENSITIVE = []
|
853
1447
|
include Aws::Structure
|
854
1448
|
end
|
855
1449
|
|
@@ -913,6 +1507,7 @@ module Aws::Athena
|
|
913
1507
|
:query_queue_time_in_millis,
|
914
1508
|
:query_planning_time_in_millis,
|
915
1509
|
:service_processing_time_in_millis)
|
1510
|
+
SENSITIVE = []
|
916
1511
|
include Aws::Structure
|
917
1512
|
end
|
918
1513
|
|
@@ -927,6 +1522,12 @@ module Aws::Athena
|
|
927
1522
|
# completed without errors. `FAILED` indicates that the query
|
928
1523
|
# experienced an error and did not complete processing. `CANCELLED`
|
929
1524
|
# indicates that a user input interrupted query execution.
|
1525
|
+
#
|
1526
|
+
# <note markdown="1"> Athena automatically retries your queries in cases of certain
|
1527
|
+
# transient errors. As a result, you may see the query state
|
1528
|
+
# transition from `RUNNING` or `FAILED` to `QUEUED`.
|
1529
|
+
#
|
1530
|
+
# </note>
|
930
1531
|
# @return [String]
|
931
1532
|
#
|
932
1533
|
# @!attribute [rw] state_change_reason
|
@@ -948,6 +1549,7 @@ module Aws::Athena
|
|
948
1549
|
:state_change_reason,
|
949
1550
|
:submission_date_time,
|
950
1551
|
:completion_date_time)
|
1552
|
+
SENSITIVE = []
|
951
1553
|
include Aws::Structure
|
952
1554
|
end
|
953
1555
|
|
@@ -964,6 +1566,7 @@ module Aws::Athena
|
|
964
1566
|
class ResourceNotFoundException < Struct.new(
|
965
1567
|
:message,
|
966
1568
|
:resource_name)
|
1569
|
+
SENSITIVE = []
|
967
1570
|
include Aws::Structure
|
968
1571
|
end
|
969
1572
|
|
@@ -1020,6 +1623,7 @@ module Aws::Athena
|
|
1020
1623
|
class ResultConfiguration < Struct.new(
|
1021
1624
|
:output_location,
|
1022
1625
|
:encryption_configuration)
|
1626
|
+
SENSITIVE = []
|
1023
1627
|
include Aws::Structure
|
1024
1628
|
end
|
1025
1629
|
|
@@ -1097,11 +1701,13 @@ module Aws::Athena
|
|
1097
1701
|
:remove_output_location,
|
1098
1702
|
:encryption_configuration,
|
1099
1703
|
:remove_encryption_configuration)
|
1704
|
+
SENSITIVE = []
|
1100
1705
|
include Aws::Structure
|
1101
1706
|
end
|
1102
1707
|
|
1103
1708
|
# The metadata and rows that comprise a query result set. The metadata
|
1104
|
-
# describes the column structure and data types.
|
1709
|
+
# describes the column structure and data types. To return a `ResultSet`
|
1710
|
+
# object, use GetQueryResults.
|
1105
1711
|
#
|
1106
1712
|
# @!attribute [rw] rows
|
1107
1713
|
# The rows in the table.
|
@@ -1117,11 +1723,13 @@ module Aws::Athena
|
|
1117
1723
|
class ResultSet < Struct.new(
|
1118
1724
|
:rows,
|
1119
1725
|
:result_set_metadata)
|
1726
|
+
SENSITIVE = []
|
1120
1727
|
include Aws::Structure
|
1121
1728
|
end
|
1122
1729
|
|
1123
1730
|
# The metadata that describes the column structure and data types of a
|
1124
|
-
# table of query results.
|
1731
|
+
# table of query results. To return a `ResultSetMetadata` object, use
|
1732
|
+
# GetQueryResults.
|
1125
1733
|
#
|
1126
1734
|
# @!attribute [rw] column_info
|
1127
1735
|
# Information about the columns returned in a query result metadata.
|
@@ -1131,6 +1739,7 @@ module Aws::Athena
|
|
1131
1739
|
#
|
1132
1740
|
class ResultSetMetadata < Struct.new(
|
1133
1741
|
:column_info)
|
1742
|
+
SENSITIVE = []
|
1134
1743
|
include Aws::Structure
|
1135
1744
|
end
|
1136
1745
|
|
@@ -1144,6 +1753,7 @@ module Aws::Athena
|
|
1144
1753
|
#
|
1145
1754
|
class Row < Struct.new(
|
1146
1755
|
:data)
|
1756
|
+
SENSITIVE = []
|
1147
1757
|
include Aws::Structure
|
1148
1758
|
end
|
1149
1759
|
|
@@ -1155,6 +1765,7 @@ module Aws::Athena
|
|
1155
1765
|
# client_request_token: "IdempotencyToken",
|
1156
1766
|
# query_execution_context: {
|
1157
1767
|
# database: "DatabaseString",
|
1768
|
+
# catalog: "CatalogNameString",
|
1158
1769
|
# },
|
1159
1770
|
# result_configuration: {
|
1160
1771
|
# output_location: "String",
|
@@ -1212,6 +1823,7 @@ module Aws::Athena
|
|
1212
1823
|
:query_execution_context,
|
1213
1824
|
:result_configuration,
|
1214
1825
|
:work_group)
|
1826
|
+
SENSITIVE = []
|
1215
1827
|
include Aws::Structure
|
1216
1828
|
end
|
1217
1829
|
|
@@ -1223,6 +1835,7 @@ module Aws::Athena
|
|
1223
1835
|
#
|
1224
1836
|
class StartQueryExecutionOutput < Struct.new(
|
1225
1837
|
:query_execution_id)
|
1838
|
+
SENSITIVE = []
|
1226
1839
|
include Aws::Structure
|
1227
1840
|
end
|
1228
1841
|
|
@@ -1244,6 +1857,7 @@ module Aws::Athena
|
|
1244
1857
|
#
|
1245
1858
|
class StopQueryExecutionInput < Struct.new(
|
1246
1859
|
:query_execution_id)
|
1860
|
+
SENSITIVE = []
|
1247
1861
|
include Aws::Structure
|
1248
1862
|
end
|
1249
1863
|
|
@@ -1251,17 +1865,66 @@ module Aws::Athena
|
|
1251
1865
|
#
|
1252
1866
|
class StopQueryExecutionOutput < Aws::EmptyStructure; end
|
1253
1867
|
|
1254
|
-
#
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
#
|
1868
|
+
# Contains metadata for a table.
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] name
|
1871
|
+
# The name of the table.
|
1872
|
+
# @return [String]
|
1873
|
+
#
|
1874
|
+
# @!attribute [rw] create_time
|
1875
|
+
# The time that the table was created.
|
1876
|
+
# @return [Time]
|
1877
|
+
#
|
1878
|
+
# @!attribute [rw] last_access_time
|
1879
|
+
# The last time the table was accessed.
|
1880
|
+
# @return [Time]
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] table_type
|
1883
|
+
# The type of table. In Athena, only `EXTERNAL_TABLE` is supported.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] columns
|
1887
|
+
# A list of the columns in the table.
|
1888
|
+
# @return [Array<Types::Column>]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] partition_keys
|
1891
|
+
# A list of the partition keys in the table.
|
1892
|
+
# @return [Array<Types::Column>]
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] parameters
|
1895
|
+
# A set of custom key/value pairs for table properties.
|
1896
|
+
# @return [Hash<String,String>]
|
1897
|
+
#
|
1898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TableMetadata AWS API Documentation
|
1899
|
+
#
|
1900
|
+
class TableMetadata < Struct.new(
|
1901
|
+
:name,
|
1902
|
+
:create_time,
|
1903
|
+
:last_access_time,
|
1904
|
+
:table_type,
|
1905
|
+
:columns,
|
1906
|
+
:partition_keys,
|
1907
|
+
:parameters)
|
1908
|
+
SENSITIVE = []
|
1909
|
+
include Aws::Structure
|
1910
|
+
end
|
1911
|
+
|
1912
|
+
# A label that you assign to a resource. In Athena, a resource can be a
|
1913
|
+
# workgroup or data catalog. Each tag consists of a key and an optional
|
1914
|
+
# value, both of which you define. For example, you can use tags to
|
1915
|
+
# categorize Athena workgroups or data catalogs by purpose, owner, or
|
1258
1916
|
# environment. Use a consistent set of tag keys to make it easier to
|
1259
|
-
# search and filter workgroups in your account.
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
# unique per
|
1917
|
+
# search and filter workgroups or data catalogs in your account. For
|
1918
|
+
# best practices, see [Tagging Best Practices][1]. Tag keys can be from
|
1919
|
+
# 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256
|
1920
|
+
# UTF-8 Unicode characters. Tags can use letters and numbers
|
1921
|
+
# representable in UTF-8, and the following characters: + - = . \_ : /
|
1922
|
+
# @. Tag keys and values are case-sensitive. Tag keys must be unique per
|
1923
|
+
# resource. If you specify more than one tag, separate them by commas.
|
1924
|
+
#
|
1925
|
+
#
|
1926
|
+
#
|
1927
|
+
# [1]: https://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
1265
1928
|
#
|
1266
1929
|
# @note When making an API call, you may pass Tag
|
1267
1930
|
# data as a hash:
|
@@ -1290,6 +1953,7 @@ module Aws::Athena
|
|
1290
1953
|
class Tag < Struct.new(
|
1291
1954
|
:key,
|
1292
1955
|
:value)
|
1956
|
+
SENSITIVE = []
|
1293
1957
|
include Aws::Structure
|
1294
1958
|
end
|
1295
1959
|
|
@@ -1307,13 +1971,13 @@ module Aws::Athena
|
|
1307
1971
|
# }
|
1308
1972
|
#
|
1309
1973
|
# @!attribute [rw] resource_arn
|
1310
|
-
#
|
1311
|
-
#
|
1974
|
+
# Specifies the ARN of the Athena resource (workgroup or data catalog)
|
1975
|
+
# to which tags are to be added.
|
1312
1976
|
# @return [String]
|
1313
1977
|
#
|
1314
1978
|
# @!attribute [rw] tags
|
1315
|
-
#
|
1316
|
-
#
|
1979
|
+
# A collection of one or more tags, separated by commas, to be added
|
1980
|
+
# to an Athena workgroup or data catalog resource.
|
1317
1981
|
# @return [Array<Types::Tag>]
|
1318
1982
|
#
|
1319
1983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResourceInput AWS API Documentation
|
@@ -1321,6 +1985,7 @@ module Aws::Athena
|
|
1321
1985
|
class TagResourceInput < Struct.new(
|
1322
1986
|
:resource_arn,
|
1323
1987
|
:tags)
|
1988
|
+
SENSITIVE = []
|
1324
1989
|
include Aws::Structure
|
1325
1990
|
end
|
1326
1991
|
|
@@ -1343,6 +2008,7 @@ module Aws::Athena
|
|
1343
2008
|
class TooManyRequestsException < Struct.new(
|
1344
2009
|
:message,
|
1345
2010
|
:reason)
|
2011
|
+
SENSITIVE = []
|
1346
2012
|
include Aws::Structure
|
1347
2013
|
end
|
1348
2014
|
|
@@ -1368,6 +2034,7 @@ module Aws::Athena
|
|
1368
2034
|
:named_query_id,
|
1369
2035
|
:error_code,
|
1370
2036
|
:error_message)
|
2037
|
+
SENSITIVE = []
|
1371
2038
|
include Aws::Structure
|
1372
2039
|
end
|
1373
2040
|
|
@@ -1393,6 +2060,7 @@ module Aws::Athena
|
|
1393
2060
|
:query_execution_id,
|
1394
2061
|
:error_code,
|
1395
2062
|
:error_message)
|
2063
|
+
SENSITIVE = []
|
1396
2064
|
include Aws::Structure
|
1397
2065
|
end
|
1398
2066
|
|
@@ -1405,13 +2073,12 @@ module Aws::Athena
|
|
1405
2073
|
# }
|
1406
2074
|
#
|
1407
2075
|
# @!attribute [rw] resource_arn
|
1408
|
-
#
|
1409
|
-
# specified ARN.
|
2076
|
+
# Specifies the ARN of the resource from which tags are to be removed.
|
1410
2077
|
# @return [String]
|
1411
2078
|
#
|
1412
2079
|
# @!attribute [rw] tag_keys
|
1413
|
-
#
|
1414
|
-
#
|
2080
|
+
# A comma-separated list of one or more tag keys whose tags are to be
|
2081
|
+
# removed from the specified resource.
|
1415
2082
|
# @return [Array<String>]
|
1416
2083
|
#
|
1417
2084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResourceInput AWS API Documentation
|
@@ -1419,6 +2086,7 @@ module Aws::Athena
|
|
1419
2086
|
class UntagResourceInput < Struct.new(
|
1420
2087
|
:resource_arn,
|
1421
2088
|
:tag_keys)
|
2089
|
+
SENSITIVE = []
|
1422
2090
|
include Aws::Structure
|
1423
2091
|
end
|
1424
2092
|
|
@@ -1426,6 +2094,79 @@ module Aws::Athena
|
|
1426
2094
|
#
|
1427
2095
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
1428
2096
|
|
2097
|
+
# @note When making an API call, you may pass UpdateDataCatalogInput
|
2098
|
+
# data as a hash:
|
2099
|
+
#
|
2100
|
+
# {
|
2101
|
+
# name: "CatalogNameString", # required
|
2102
|
+
# type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE
|
2103
|
+
# description: "DescriptionString",
|
2104
|
+
# parameters: {
|
2105
|
+
# "KeyString" => "ParametersMapValue",
|
2106
|
+
# },
|
2107
|
+
# }
|
2108
|
+
#
|
2109
|
+
# @!attribute [rw] name
|
2110
|
+
# The name of the data catalog to update. The catalog name must be
|
2111
|
+
# unique for the AWS account and can use a maximum of 128
|
2112
|
+
# alphanumeric, underscore, at sign, or hyphen characters.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] type
|
2116
|
+
# Specifies the type of data catalog to update. Specify `LAMBDA` for a
|
2117
|
+
# federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an
|
2118
|
+
# external hive metastore.
|
2119
|
+
# @return [String]
|
2120
|
+
#
|
2121
|
+
# @!attribute [rw] description
|
2122
|
+
# New or modified text that describes the data catalog.
|
2123
|
+
# @return [String]
|
2124
|
+
#
|
2125
|
+
# @!attribute [rw] parameters
|
2126
|
+
# Specifies the Lambda function or functions to use for updating the
|
2127
|
+
# data catalog. This is a mapping whose values depend on the catalog
|
2128
|
+
# type.
|
2129
|
+
#
|
2130
|
+
# * For the `HIVE` data catalog type, use the following syntax. The
|
2131
|
+
# `metadata-function` parameter is required. `The sdk-version`
|
2132
|
+
# parameter is optional and defaults to the currently supported
|
2133
|
+
# version.
|
2134
|
+
#
|
2135
|
+
# `metadata-function=lambda_arn, sdk-version=version_number `
|
2136
|
+
#
|
2137
|
+
# * For the `LAMBDA` data catalog type, use one of the following sets
|
2138
|
+
# of required parameters, but not both.
|
2139
|
+
#
|
2140
|
+
# * If you have one Lambda function that processes metadata and
|
2141
|
+
# another for reading the actual data, use the following syntax.
|
2142
|
+
# Both parameters are required.
|
2143
|
+
#
|
2144
|
+
# `metadata-function=lambda_arn, record-function=lambda_arn `
|
2145
|
+
#
|
2146
|
+
# * If you have a composite Lambda function that processes both
|
2147
|
+
# metadata and data, use the following syntax to specify your
|
2148
|
+
# Lambda function.
|
2149
|
+
#
|
2150
|
+
# `function=lambda_arn `
|
2151
|
+
#
|
2152
|
+
# * The `GLUE` type has no parameters.
|
2153
|
+
# @return [Hash<String,String>]
|
2154
|
+
#
|
2155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalogInput AWS API Documentation
|
2156
|
+
#
|
2157
|
+
class UpdateDataCatalogInput < Struct.new(
|
2158
|
+
:name,
|
2159
|
+
:type,
|
2160
|
+
:description,
|
2161
|
+
:parameters)
|
2162
|
+
SENSITIVE = []
|
2163
|
+
include Aws::Structure
|
2164
|
+
end
|
2165
|
+
|
2166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalogOutput AWS API Documentation
|
2167
|
+
#
|
2168
|
+
class UpdateDataCatalogOutput < Aws::EmptyStructure; end
|
2169
|
+
|
1429
2170
|
# @note When making an API call, you may pass UpdateWorkGroupInput
|
1430
2171
|
# data as a hash:
|
1431
2172
|
#
|
@@ -1475,6 +2216,7 @@ module Aws::Athena
|
|
1475
2216
|
:description,
|
1476
2217
|
:configuration_updates,
|
1477
2218
|
:state)
|
2219
|
+
SENSITIVE = []
|
1478
2220
|
include Aws::Structure
|
1479
2221
|
end
|
1480
2222
|
|
@@ -1531,6 +2273,7 @@ module Aws::Athena
|
|
1531
2273
|
:configuration,
|
1532
2274
|
:description,
|
1533
2275
|
:creation_time)
|
2276
|
+
SENSITIVE = []
|
1534
2277
|
include Aws::Structure
|
1535
2278
|
end
|
1536
2279
|
|
@@ -1619,6 +2362,7 @@ module Aws::Athena
|
|
1619
2362
|
:publish_cloud_watch_metrics_enabled,
|
1620
2363
|
:bytes_scanned_cutoff_per_query,
|
1621
2364
|
:requester_pays_enabled)
|
2365
|
+
SENSITIVE = []
|
1622
2366
|
include Aws::Structure
|
1623
2367
|
end
|
1624
2368
|
|
@@ -1705,6 +2449,7 @@ module Aws::Athena
|
|
1705
2449
|
:bytes_scanned_cutoff_per_query,
|
1706
2450
|
:remove_bytes_scanned_cutoff_per_query,
|
1707
2451
|
:requester_pays_enabled)
|
2452
|
+
SENSITIVE = []
|
1708
2453
|
include Aws::Structure
|
1709
2454
|
end
|
1710
2455
|
|
@@ -1734,6 +2479,7 @@ module Aws::Athena
|
|
1734
2479
|
:state,
|
1735
2480
|
:description,
|
1736
2481
|
:creation_time)
|
2482
|
+
SENSITIVE = []
|
1737
2483
|
include Aws::Structure
|
1738
2484
|
end
|
1739
2485
|
|