aws-sdk-athena 1.64.0 → 1.66.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-athena/client.rb +259 -19
- data/lib/aws-sdk-athena/client_api.rb +176 -0
- data/lib/aws-sdk-athena/endpoints.rb +98 -0
- data/lib/aws-sdk-athena/plugins/endpoints.rb +14 -0
- data/lib/aws-sdk-athena/types.rb +313 -14
- data/lib/aws-sdk-athena.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-athena/types.rb
CHANGED
@@ -344,6 +344,142 @@ module Aws::Athena
|
|
344
344
|
include Aws::Structure
|
345
345
|
end
|
346
346
|
|
347
|
+
# @!attribute [rw] name
|
348
|
+
# The name of the capacity reservation to cancel.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CancelCapacityReservationInput AWS API Documentation
|
352
|
+
#
|
353
|
+
class CancelCapacityReservationInput < Struct.new(
|
354
|
+
:name)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CancelCapacityReservationOutput AWS API Documentation
|
360
|
+
#
|
361
|
+
class CancelCapacityReservationOutput < Aws::EmptyStructure; end
|
362
|
+
|
363
|
+
# Contains the submission time of a single allocation request for a
|
364
|
+
# capacity reservation and the most recent status of the attempted
|
365
|
+
# allocation.
|
366
|
+
#
|
367
|
+
# @!attribute [rw] status
|
368
|
+
# The status of the capacity allocation.
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] status_message
|
372
|
+
# The status message of the capacity allocation.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] request_time
|
376
|
+
# The time when the capacity allocation was requested.
|
377
|
+
# @return [Time]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] request_completion_time
|
380
|
+
# The time when the capacity allocation request was completed.
|
381
|
+
# @return [Time]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CapacityAllocation AWS API Documentation
|
384
|
+
#
|
385
|
+
class CapacityAllocation < Struct.new(
|
386
|
+
:status,
|
387
|
+
:status_message,
|
388
|
+
:request_time,
|
389
|
+
:request_completion_time)
|
390
|
+
SENSITIVE = []
|
391
|
+
include Aws::Structure
|
392
|
+
end
|
393
|
+
|
394
|
+
# A mapping between one or more workgroups and a capacity reservation.
|
395
|
+
#
|
396
|
+
# @!attribute [rw] work_group_names
|
397
|
+
# The list of workgroup names for the capacity assignment.
|
398
|
+
# @return [Array<String>]
|
399
|
+
#
|
400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CapacityAssignment AWS API Documentation
|
401
|
+
#
|
402
|
+
class CapacityAssignment < Struct.new(
|
403
|
+
:work_group_names)
|
404
|
+
SENSITIVE = []
|
405
|
+
include Aws::Structure
|
406
|
+
end
|
407
|
+
|
408
|
+
# Assigns Athena workgroups (and hence their queries) to capacity
|
409
|
+
# reservations. A capacity reservation can have only one capacity
|
410
|
+
# assignment configuration, but the capacity assignment configuration
|
411
|
+
# can be made up of multiple individual assignments. Each assignment
|
412
|
+
# specifies how Athena queries can consume capacity from the capacity
|
413
|
+
# reservation that their workgroup is mapped to.
|
414
|
+
#
|
415
|
+
# @!attribute [rw] capacity_reservation_name
|
416
|
+
# The name of the reservation that the capacity assignment
|
417
|
+
# configuration is for.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] capacity_assignments
|
421
|
+
# The list of assignments that make up the capacity assignment
|
422
|
+
# configuration.
|
423
|
+
# @return [Array<Types::CapacityAssignment>]
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CapacityAssignmentConfiguration AWS API Documentation
|
426
|
+
#
|
427
|
+
class CapacityAssignmentConfiguration < Struct.new(
|
428
|
+
:capacity_reservation_name,
|
429
|
+
:capacity_assignments)
|
430
|
+
SENSITIVE = []
|
431
|
+
include Aws::Structure
|
432
|
+
end
|
433
|
+
|
434
|
+
# A reservation for a specified number of data processing units (DPUs).
|
435
|
+
# When a reservation is initially created, it has no DPUs. Athena
|
436
|
+
# allocates DPUs until the allocated amount equals the requested amount.
|
437
|
+
#
|
438
|
+
# @!attribute [rw] name
|
439
|
+
# The name of the capacity reservation.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] status
|
443
|
+
# The status of the capacity reservation.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] target_dpus
|
447
|
+
# The number of data processing units requested.
|
448
|
+
# @return [Integer]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] allocated_dpus
|
451
|
+
# The number of data processing units currently allocated.
|
452
|
+
# @return [Integer]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] last_allocation
|
455
|
+
# Contains the submission time of a single allocation request for a
|
456
|
+
# capacity reservation and the most recent status of the attempted
|
457
|
+
# allocation.
|
458
|
+
# @return [Types::CapacityAllocation]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] last_successful_allocation_time
|
461
|
+
# The time of the most recent capacity allocation that succeeded.
|
462
|
+
# @return [Time]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] creation_time
|
465
|
+
# The time in UTC epoch millis when the capacity reservation was
|
466
|
+
# created.
|
467
|
+
# @return [Time]
|
468
|
+
#
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CapacityReservation AWS API Documentation
|
470
|
+
#
|
471
|
+
class CapacityReservation < Struct.new(
|
472
|
+
:name,
|
473
|
+
:status,
|
474
|
+
:target_dpus,
|
475
|
+
:allocated_dpus,
|
476
|
+
:last_allocation,
|
477
|
+
:last_successful_allocation_time,
|
478
|
+
:creation_time)
|
479
|
+
SENSITIVE = []
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
347
483
|
# Contains metadata for a column in a table.
|
348
484
|
#
|
349
485
|
# @!attribute [rw] name
|
@@ -429,6 +565,32 @@ module Aws::Athena
|
|
429
565
|
include Aws::Structure
|
430
566
|
end
|
431
567
|
|
568
|
+
# @!attribute [rw] target_dpus
|
569
|
+
# The number of requested data processing units.
|
570
|
+
# @return [Integer]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] name
|
573
|
+
# The name of the capacity reservation to create.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] tags
|
577
|
+
# The tags for the capacity reservation.
|
578
|
+
# @return [Array<Types::Tag>]
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateCapacityReservationInput AWS API Documentation
|
581
|
+
#
|
582
|
+
class CreateCapacityReservationInput < Struct.new(
|
583
|
+
:target_dpus,
|
584
|
+
:name,
|
585
|
+
:tags)
|
586
|
+
SENSITIVE = []
|
587
|
+
include Aws::Structure
|
588
|
+
end
|
589
|
+
|
590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateCapacityReservationOutput AWS API Documentation
|
591
|
+
#
|
592
|
+
class CreateCapacityReservationOutput < Aws::EmptyStructure; end
|
593
|
+
|
432
594
|
# @!attribute [rw] name
|
433
595
|
# The name of the data catalog to create. The catalog name must be
|
434
596
|
# unique for the Amazon Web Services account and can use a maximum of
|
@@ -1011,7 +1173,7 @@ module Aws::Athena
|
|
1011
1173
|
# @!attribute [rw] coordinator_dpu_size
|
1012
1174
|
# The number of DPUs to use for the coordinator. A coordinator is a
|
1013
1175
|
# special executor that orchestrates processing work and manages other
|
1014
|
-
# executors in a notebook session.
|
1176
|
+
# executors in a notebook session. The default is 1.
|
1015
1177
|
# @return [Integer]
|
1016
1178
|
#
|
1017
1179
|
# @!attribute [rw] max_concurrent_dpus
|
@@ -1021,7 +1183,7 @@ module Aws::Athena
|
|
1021
1183
|
# @!attribute [rw] default_executor_dpu_size
|
1022
1184
|
# The default number of DPUs to use for executors. An executor is the
|
1023
1185
|
# smallest unit of compute that a notebook session can request from
|
1024
|
-
# Athena.
|
1186
|
+
# Athena. The default is 1.
|
1025
1187
|
# @return [Integer]
|
1026
1188
|
#
|
1027
1189
|
# @!attribute [rw] additional_configs
|
@@ -1033,13 +1195,19 @@ module Aws::Athena
|
|
1033
1195
|
# value of the Athena notebook ID.
|
1034
1196
|
# @return [Hash<String,String>]
|
1035
1197
|
#
|
1198
|
+
# @!attribute [rw] spark_properties
|
1199
|
+
# Specifies custom jar files and Spark properties for use cases like
|
1200
|
+
# cluster encryption, table formats, and general Spark tuning.
|
1201
|
+
# @return [Hash<String,String>]
|
1202
|
+
#
|
1036
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/EngineConfiguration AWS API Documentation
|
1037
1204
|
#
|
1038
1205
|
class EngineConfiguration < Struct.new(
|
1039
1206
|
:coordinator_dpu_size,
|
1040
1207
|
:max_concurrent_dpus,
|
1041
1208
|
:default_executor_dpu_size,
|
1042
|
-
:additional_configs
|
1209
|
+
:additional_configs,
|
1210
|
+
:spark_properties)
|
1043
1211
|
SENSITIVE = []
|
1044
1212
|
include Aws::Structure
|
1045
1213
|
end
|
@@ -1282,6 +1450,56 @@ module Aws::Athena
|
|
1282
1450
|
include Aws::Structure
|
1283
1451
|
end
|
1284
1452
|
|
1453
|
+
# @!attribute [rw] capacity_reservation_name
|
1454
|
+
# The name of the capacity reservation to retrieve the capacity
|
1455
|
+
# assignment configuration for.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityAssignmentConfigurationInput AWS API Documentation
|
1459
|
+
#
|
1460
|
+
class GetCapacityAssignmentConfigurationInput < Struct.new(
|
1461
|
+
:capacity_reservation_name)
|
1462
|
+
SENSITIVE = []
|
1463
|
+
include Aws::Structure
|
1464
|
+
end
|
1465
|
+
|
1466
|
+
# @!attribute [rw] capacity_assignment_configuration
|
1467
|
+
# The requested capacity assignment configuration for the specified
|
1468
|
+
# capacity reservation.
|
1469
|
+
# @return [Types::CapacityAssignmentConfiguration]
|
1470
|
+
#
|
1471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityAssignmentConfigurationOutput AWS API Documentation
|
1472
|
+
#
|
1473
|
+
class GetCapacityAssignmentConfigurationOutput < Struct.new(
|
1474
|
+
:capacity_assignment_configuration)
|
1475
|
+
SENSITIVE = []
|
1476
|
+
include Aws::Structure
|
1477
|
+
end
|
1478
|
+
|
1479
|
+
# @!attribute [rw] name
|
1480
|
+
# The name of the capacity reservation.
|
1481
|
+
# @return [String]
|
1482
|
+
#
|
1483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityReservationInput AWS API Documentation
|
1484
|
+
#
|
1485
|
+
class GetCapacityReservationInput < Struct.new(
|
1486
|
+
:name)
|
1487
|
+
SENSITIVE = []
|
1488
|
+
include Aws::Structure
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
# @!attribute [rw] capacity_reservation
|
1492
|
+
# The requested capacity reservation structure.
|
1493
|
+
# @return [Types::CapacityReservation]
|
1494
|
+
#
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityReservationOutput AWS API Documentation
|
1496
|
+
#
|
1497
|
+
class GetCapacityReservationOutput < Struct.new(
|
1498
|
+
:capacity_reservation)
|
1499
|
+
SENSITIVE = []
|
1500
|
+
include Aws::Structure
|
1501
|
+
end
|
1502
|
+
|
1285
1503
|
# @!attribute [rw] name
|
1286
1504
|
# The name of the data catalog to return.
|
1287
1505
|
# @return [String]
|
@@ -1860,6 +2078,44 @@ module Aws::Athena
|
|
1860
2078
|
include Aws::Structure
|
1861
2079
|
end
|
1862
2080
|
|
2081
|
+
# @!attribute [rw] next_token
|
2082
|
+
# A token generated by the Athena service that specifies where to
|
2083
|
+
# continue pagination if a previous request was truncated.
|
2084
|
+
# @return [String]
|
2085
|
+
#
|
2086
|
+
# @!attribute [rw] max_results
|
2087
|
+
# Specifies the maximum number of results to return.
|
2088
|
+
# @return [Integer]
|
2089
|
+
#
|
2090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCapacityReservationsInput AWS API Documentation
|
2091
|
+
#
|
2092
|
+
class ListCapacityReservationsInput < Struct.new(
|
2093
|
+
:next_token,
|
2094
|
+
:max_results)
|
2095
|
+
SENSITIVE = []
|
2096
|
+
include Aws::Structure
|
2097
|
+
end
|
2098
|
+
|
2099
|
+
# @!attribute [rw] next_token
|
2100
|
+
# A token generated by the Athena service that specifies where to
|
2101
|
+
# continue pagination if a previous request was truncated. To obtain
|
2102
|
+
# the next set of pages, pass in the NextToken from the response
|
2103
|
+
# object of the previous page call.
|
2104
|
+
# @return [String]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] capacity_reservations
|
2107
|
+
# The capacity reservations for the current account.
|
2108
|
+
# @return [Array<Types::CapacityReservation>]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCapacityReservationsOutput AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class ListCapacityReservationsOutput < Struct.new(
|
2113
|
+
:next_token,
|
2114
|
+
:capacity_reservations)
|
2115
|
+
SENSITIVE = []
|
2116
|
+
include Aws::Structure
|
2117
|
+
end
|
2118
|
+
|
1863
2119
|
# @!attribute [rw] next_token
|
1864
2120
|
# A token generated by the Athena service that specifies where to
|
1865
2121
|
# continue pagination if a previous request was truncated. To obtain
|
@@ -2666,6 +2922,28 @@ module Aws::Athena
|
|
2666
2922
|
include Aws::Structure
|
2667
2923
|
end
|
2668
2924
|
|
2925
|
+
# @!attribute [rw] capacity_reservation_name
|
2926
|
+
# The name of the capacity reservation to put a capacity assignment
|
2927
|
+
# configuration for.
|
2928
|
+
# @return [String]
|
2929
|
+
#
|
2930
|
+
# @!attribute [rw] capacity_assignments
|
2931
|
+
# The list of assignments for the capacity assignment configuration.
|
2932
|
+
# @return [Array<Types::CapacityAssignment>]
|
2933
|
+
#
|
2934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/PutCapacityAssignmentConfigurationInput AWS API Documentation
|
2935
|
+
#
|
2936
|
+
class PutCapacityAssignmentConfigurationInput < Struct.new(
|
2937
|
+
:capacity_reservation_name,
|
2938
|
+
:capacity_assignments)
|
2939
|
+
SENSITIVE = []
|
2940
|
+
include Aws::Structure
|
2941
|
+
end
|
2942
|
+
|
2943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/PutCapacityAssignmentConfigurationOutput AWS API Documentation
|
2944
|
+
#
|
2945
|
+
class PutCapacityAssignmentConfigurationOutput < Aws::EmptyStructure; end
|
2946
|
+
|
2669
2947
|
# Information about a single instance of a query execution.
|
2670
2948
|
#
|
2671
2949
|
# @!attribute [rw] query_execution_id
|
@@ -3913,14 +4191,14 @@ module Aws::Athena
|
|
3913
4191
|
include Aws::Structure
|
3914
4192
|
end
|
3915
4193
|
|
3916
|
-
# A label that you assign to a resource.
|
3917
|
-
#
|
3918
|
-
# value, both of which you define. For
|
3919
|
-
#
|
3920
|
-
# environment. Use a consistent set of tag keys to make it
|
3921
|
-
# search and filter
|
3922
|
-
#
|
3923
|
-
#
|
4194
|
+
# A label that you assign to a resource. Athena resources include
|
4195
|
+
# workgroups, data catalogs, and capacity reservations. Each tag
|
4196
|
+
# consists of a key and an optional value, both of which you define. For
|
4197
|
+
# example, you can use tags to categorize Athena resources by purpose,
|
4198
|
+
# owner, or environment. Use a consistent set of tag keys to make it
|
4199
|
+
# easier to search and filter the resources in your account. For best
|
4200
|
+
# practices, see [Tagging Best Practices][1]. Tag keys can be from 1 to
|
4201
|
+
# 128 UTF-8 Unicode characters, and tag values can be from 0 to 256
|
3924
4202
|
# UTF-8 Unicode characters. Tags can use letters and numbers
|
3925
4203
|
# representable in UTF-8, and the following characters: + - = . \_ : /
|
3926
4204
|
# @. Tag keys and values are case-sensitive. Tag keys must be unique per
|
@@ -3954,13 +4232,13 @@ module Aws::Athena
|
|
3954
4232
|
end
|
3955
4233
|
|
3956
4234
|
# @!attribute [rw] resource_arn
|
3957
|
-
# Specifies the ARN of the Athena resource
|
3958
|
-
#
|
4235
|
+
# Specifies the ARN of the Athena resource to which tags are to be
|
4236
|
+
# added.
|
3959
4237
|
# @return [String]
|
3960
4238
|
#
|
3961
4239
|
# @!attribute [rw] tags
|
3962
4240
|
# A collection of one or more tags, separated by commas, to be added
|
3963
|
-
# to an Athena
|
4241
|
+
# to an Athena resource.
|
3964
4242
|
# @return [Array<Types::Tag>]
|
3965
4243
|
#
|
3966
4244
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResourceInput AWS API Documentation
|
@@ -4148,6 +4426,27 @@ module Aws::Athena
|
|
4148
4426
|
#
|
4149
4427
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
4150
4428
|
|
4429
|
+
# @!attribute [rw] target_dpus
|
4430
|
+
# The new number of requested data processing units.
|
4431
|
+
# @return [Integer]
|
4432
|
+
#
|
4433
|
+
# @!attribute [rw] name
|
4434
|
+
# The name of the capacity reservation.
|
4435
|
+
# @return [String]
|
4436
|
+
#
|
4437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateCapacityReservationInput AWS API Documentation
|
4438
|
+
#
|
4439
|
+
class UpdateCapacityReservationInput < Struct.new(
|
4440
|
+
:target_dpus,
|
4441
|
+
:name)
|
4442
|
+
SENSITIVE = []
|
4443
|
+
include Aws::Structure
|
4444
|
+
end
|
4445
|
+
|
4446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateCapacityReservationOutput AWS API Documentation
|
4447
|
+
#
|
4448
|
+
class UpdateCapacityReservationOutput < Aws::EmptyStructure; end
|
4449
|
+
|
4151
4450
|
# @!attribute [rw] name
|
4152
4451
|
# The name of the data catalog to update. The catalog name must be
|
4153
4452
|
# unique for the Amazon Web Services account and can use a maximum of
|
data/lib/aws-sdk-athena.rb
CHANGED
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.66.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: 2023-
|
11
|
+
date: 2023-05-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|