aws-sdk-athena 1.58.0 → 1.59.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.
@@ -20,13 +20,6 @@ module Aws::Athena
20
20
  #
21
21
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview
22
22
  #
23
- # @note When making an API call, you may pass AclConfiguration
24
- # data as a hash:
25
- #
26
- # {
27
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
28
- # }
29
- #
30
23
  # @!attribute [rw] s3_acl_option
31
24
  # The Amazon S3 canned ACL that Athena should specify when storing
32
25
  # query results. Currently the only supported canned ACL is
@@ -49,6 +42,27 @@ module Aws::Athena
49
42
  include Aws::Structure
50
43
  end
51
44
 
45
+ # Contains the application runtime IDs and their supported DPU sizes.
46
+ #
47
+ # @!attribute [rw] application_runtime_id
48
+ # The name of the supported application runtime (for example, `Jupyter
49
+ # 1.0`).
50
+ # @return [String]
51
+ #
52
+ # @!attribute [rw] supported_dpu_sizes
53
+ # A list of the supported DPU sizes that the application runtime
54
+ # supports.
55
+ # @return [Array<Integer>]
56
+ #
57
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ApplicationDPUSizes AWS API Documentation
58
+ #
59
+ class ApplicationDPUSizes < Struct.new(
60
+ :application_runtime_id,
61
+ :supported_dpu_sizes)
62
+ SENSITIVE = []
63
+ include Aws::Structure
64
+ end
65
+
52
66
  # Provides information about an Athena query error. The `AthenaError`
53
67
  # feature provides standardized error information to help you understand
54
68
  # failed queries and take steps after a query failure occurs.
@@ -98,13 +112,6 @@ module Aws::Athena
98
112
 
99
113
  # Contains an array of named query IDs.
100
114
  #
101
- # @note When making an API call, you may pass BatchGetNamedQueryInput
102
- # data as a hash:
103
- #
104
- # {
105
- # named_query_ids: ["NamedQueryId"], # required
106
- # }
107
- #
108
115
  # @!attribute [rw] named_query_ids
109
116
  # An array of query IDs.
110
117
  # @return [Array<String>]
@@ -134,14 +141,6 @@ module Aws::Athena
134
141
  include Aws::Structure
135
142
  end
136
143
 
137
- # @note When making an API call, you may pass BatchGetPreparedStatementInput
138
- # data as a hash:
139
- #
140
- # {
141
- # prepared_statement_names: ["StatementName"], # required
142
- # work_group: "WorkGroupName", # required
143
- # }
144
- #
145
144
  # @!attribute [rw] prepared_statement_names
146
145
  # A list of prepared statement names to return.
147
146
  # @return [Array<String>]
@@ -179,13 +178,6 @@ module Aws::Athena
179
178
 
180
179
  # Contains an array of query execution IDs.
181
180
  #
182
- # @note When making an API call, you may pass BatchGetQueryExecutionInput
183
- # data as a hash:
184
- #
185
- # {
186
- # query_execution_ids: ["QueryExecutionId"], # required
187
- # }
188
- #
189
181
  # @!attribute [rw] query_execution_ids
190
182
  # An array of query execution IDs.
191
183
  # @return [Array<String>]
@@ -215,6 +207,143 @@ module Aws::Athena
215
207
  include Aws::Structure
216
208
  end
217
209
 
210
+ # Contains configuration information for the calculation.
211
+ #
212
+ # @!attribute [rw] code_block
213
+ # A string that contains the code for the calculation.
214
+ # @return [String]
215
+ #
216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CalculationConfiguration AWS API Documentation
217
+ #
218
+ class CalculationConfiguration < Struct.new(
219
+ :code_block)
220
+ SENSITIVE = []
221
+ include Aws::Structure
222
+ end
223
+
224
+ # Contains information about an application-specific calculation result.
225
+ #
226
+ # @!attribute [rw] std_out_s3_uri
227
+ # The Amazon S3 location of the `stdout` file for the calculation.
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] std_error_s3_uri
231
+ # The Amazon S3 location of the `stderr` error messages file for the
232
+ # calculation.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] result_s3_uri
236
+ # The Amazon S3 location of the folder for the calculation results.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] result_type
240
+ # The data format of the calculation result.
241
+ # @return [String]
242
+ #
243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CalculationResult AWS API Documentation
244
+ #
245
+ class CalculationResult < Struct.new(
246
+ :std_out_s3_uri,
247
+ :std_error_s3_uri,
248
+ :result_s3_uri,
249
+ :result_type)
250
+ SENSITIVE = []
251
+ include Aws::Structure
252
+ end
253
+
254
+ # Contains statistics for a notebook calculation.
255
+ #
256
+ # @!attribute [rw] dpu_execution_in_millis
257
+ # The data processing unit execution time in milliseconds for the
258
+ # calculation.
259
+ # @return [Integer]
260
+ #
261
+ # @!attribute [rw] progress
262
+ # The progress of the calculation.
263
+ # @return [String]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CalculationStatistics AWS API Documentation
266
+ #
267
+ class CalculationStatistics < Struct.new(
268
+ :dpu_execution_in_millis,
269
+ :progress)
270
+ SENSITIVE = []
271
+ include Aws::Structure
272
+ end
273
+
274
+ # Contains information about the status of a notebook calculation.
275
+ #
276
+ # @!attribute [rw] submission_date_time
277
+ # The date and time the calculation was submitted for processing.
278
+ # @return [Time]
279
+ #
280
+ # @!attribute [rw] completion_date_time
281
+ # The date and time the calculation completed processing.
282
+ # @return [Time]
283
+ #
284
+ # @!attribute [rw] state
285
+ # The state of the calculation execution. A description of each state
286
+ # follows.
287
+ #
288
+ # `CREATING` - The calculation is in the process of being created.
289
+ #
290
+ # `CREATED` - The calculation has been created and is ready to run.
291
+ #
292
+ # `QUEUED` - The calculation has been queued for processing.
293
+ #
294
+ # `RUNNING` - The calculation is running.
295
+ #
296
+ # `CANCELING` - A request to cancel the calculation has been received
297
+ # and the system is working to stop it.
298
+ #
299
+ # `CANCELED` - The calculation is no longer running as the result of a
300
+ # cancel request.
301
+ #
302
+ # `COMPLETED` - The calculation has completed without error.
303
+ #
304
+ # `FAILED` - The calculation failed and is no longer running.
305
+ # @return [String]
306
+ #
307
+ # @!attribute [rw] state_change_reason
308
+ # The reason for the calculation state change (for example, the
309
+ # calculation was canceled because the session was terminated).
310
+ # @return [String]
311
+ #
312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CalculationStatus AWS API Documentation
313
+ #
314
+ class CalculationStatus < Struct.new(
315
+ :submission_date_time,
316
+ :completion_date_time,
317
+ :state,
318
+ :state_change_reason)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # Summary information for a notebook calculation.
324
+ #
325
+ # @!attribute [rw] calculation_execution_id
326
+ # The calculation execution UUID.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] description
330
+ # A description of the calculation.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] status
334
+ # Contains information about the status of the calculation.
335
+ # @return [Types::CalculationStatus]
336
+ #
337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CalculationSummary AWS API Documentation
338
+ #
339
+ class CalculationSummary < Struct.new(
340
+ :calculation_execution_id,
341
+ :description,
342
+ :status)
343
+ SENSITIVE = []
344
+ include Aws::Structure
345
+ end
346
+
218
347
  # Contains metadata for a column in a table.
219
348
  #
220
349
  # @!attribute [rw] name
@@ -300,24 +429,6 @@ module Aws::Athena
300
429
  include Aws::Structure
301
430
  end
302
431
 
303
- # @note When making an API call, you may pass CreateDataCatalogInput
304
- # data as a hash:
305
- #
306
- # {
307
- # name: "CatalogNameString", # required
308
- # type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE
309
- # description: "DescriptionString",
310
- # parameters: {
311
- # "KeyString" => "ParametersMapValue",
312
- # },
313
- # tags: [
314
- # {
315
- # key: "TagKey",
316
- # value: "TagValue",
317
- # },
318
- # ],
319
- # }
320
- #
321
432
  # @!attribute [rw] name
322
433
  # The name of the data catalog to create. The catalog name must be
323
434
  # unique for the Amazon Web Services account and can use a maximum of
@@ -402,18 +513,6 @@ module Aws::Athena
402
513
  #
403
514
  class CreateDataCatalogOutput < Aws::EmptyStructure; end
404
515
 
405
- # @note When making an API call, you may pass CreateNamedQueryInput
406
- # data as a hash:
407
- #
408
- # {
409
- # name: "NameString", # required
410
- # description: "DescriptionString",
411
- # database: "DatabaseString", # required
412
- # query_string: "QueryString", # required
413
- # client_request_token: "IdempotencyToken",
414
- # work_group: "WorkGroupName",
415
- # }
416
- #
417
516
  # @!attribute [rw] name
418
517
  # The query name.
419
518
  # @return [String]
@@ -476,16 +575,49 @@ module Aws::Athena
476
575
  include Aws::Structure
477
576
  end
478
577
 
479
- # @note When making an API call, you may pass CreatePreparedStatementInput
480
- # data as a hash:
578
+ # @!attribute [rw] work_group
579
+ # The name of the Spark enabled workgroup in which the notebook will
580
+ # be created.
581
+ # @return [String]
582
+ #
583
+ # @!attribute [rw] name
584
+ # The name of the `ipynb` file to be created in the Spark workgroup,
585
+ # without the `.ipynb` extension.
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] client_request_token
589
+ # A unique case-sensitive string used to ensure the request to create
590
+ # the notebook is idempotent (executes only once).
591
+ #
592
+ # This token is listed as not required because Amazon Web Services
593
+ # SDKs (for example the Amazon Web Services SDK for Java)
594
+ # auto-generate the token for you. If you are not using the Amazon Web
595
+ # Services SDK or the Amazon Web Services CLI, you must provide this
596
+ # token or the action will fail.
597
+ # @return [String]
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNotebookInput AWS API Documentation
600
+ #
601
+ class CreateNotebookInput < Struct.new(
602
+ :work_group,
603
+ :name,
604
+ :client_request_token)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] notebook_id
610
+ # A unique identifier for the notebook.
611
+ # @return [String]
481
612
  #
482
- # {
483
- # statement_name: "StatementName", # required
484
- # work_group: "WorkGroupName", # required
485
- # query_statement: "QueryString", # required
486
- # description: "DescriptionString",
487
- # }
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNotebookOutput AWS API Documentation
488
614
  #
615
+ class CreateNotebookOutput < Struct.new(
616
+ :notebook_id)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
489
621
  # @!attribute [rw] statement_name
490
622
  # The name of the prepared statement.
491
623
  # @return [String]
@@ -517,54 +649,54 @@ module Aws::Athena
517
649
  #
518
650
  class CreatePreparedStatementOutput < Aws::EmptyStructure; end
519
651
 
520
- # @note When making an API call, you may pass CreateWorkGroupInput
521
- # data as a hash:
522
- #
523
- # {
524
- # name: "WorkGroupName", # required
525
- # configuration: {
526
- # result_configuration: {
527
- # output_location: "ResultOutputLocation",
528
- # encryption_configuration: {
529
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
530
- # kms_key: "String",
531
- # },
532
- # expected_bucket_owner: "AwsAccountId",
533
- # acl_configuration: {
534
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
535
- # },
536
- # },
537
- # enforce_work_group_configuration: false,
538
- # publish_cloud_watch_metrics_enabled: false,
539
- # bytes_scanned_cutoff_per_query: 1,
540
- # requester_pays_enabled: false,
541
- # engine_version: {
542
- # selected_engine_version: "NameString",
543
- # effective_engine_version: "NameString",
544
- # },
545
- # },
546
- # description: "WorkGroupDescriptionString",
547
- # tags: [
548
- # {
549
- # key: "TagKey",
550
- # value: "TagValue",
551
- # },
552
- # ],
553
- # }
652
+ # @!attribute [rw] session_id
653
+ # The session ID.
654
+ # @return [String]
655
+ #
656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreatePresignedNotebookUrlRequest AWS API Documentation
657
+ #
658
+ class CreatePresignedNotebookUrlRequest < Struct.new(
659
+ :session_id)
660
+ SENSITIVE = []
661
+ include Aws::Structure
662
+ end
663
+
664
+ # @!attribute [rw] notebook_url
665
+ # The URL of the notebook. The URL includes the authentication token
666
+ # and notebook file name and points directly to the opened notebook.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] auth_token
670
+ # The authentication token for the notebook.
671
+ # @return [String]
672
+ #
673
+ # @!attribute [rw] auth_token_expiration_time
674
+ # The UTC epoch time when the authentication token expires.
675
+ # @return [Integer]
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreatePresignedNotebookUrlResponse AWS API Documentation
554
678
  #
679
+ class CreatePresignedNotebookUrlResponse < Struct.new(
680
+ :notebook_url,
681
+ :auth_token,
682
+ :auth_token_expiration_time)
683
+ SENSITIVE = []
684
+ include Aws::Structure
685
+ end
686
+
555
687
  # @!attribute [rw] name
556
688
  # The workgroup name.
557
689
  # @return [String]
558
690
  #
559
691
  # @!attribute [rw] configuration
560
- # The configuration for the workgroup, which includes the location in
561
- # Amazon S3 where query results are stored, the encryption
562
- # configuration, if any, used for encrypting query results, whether
563
- # the Amazon CloudWatch Metrics are enabled for the workgroup, the
564
- # limit for the amount of bytes scanned (cutoff) per query, if it is
565
- # specified, and whether workgroup's settings (specified with
566
- # `EnforceWorkGroupConfiguration`) in the `WorkGroupConfiguration`
567
- # override client-side settings. See
692
+ # Contains configuration information for creating an Athena SQL
693
+ # workgroup, which includes the location in Amazon S3 where query
694
+ # results are stored, the encryption configuration, if any, used for
695
+ # encrypting query results, whether the Amazon CloudWatch Metrics are
696
+ # enabled for the workgroup, the limit for the amount of bytes scanned
697
+ # (cutoff) per query, if it is specified, and whether workgroup's
698
+ # settings (specified with `EnforceWorkGroupConfiguration`) in the
699
+ # `WorkGroupConfiguration` override client-side settings. See
568
700
  # WorkGroupConfiguration$EnforceWorkGroupConfiguration.
569
701
  # @return [Types::WorkGroupConfiguration]
570
702
  #
@@ -592,6 +724,22 @@ module Aws::Athena
592
724
  #
593
725
  class CreateWorkGroupOutput < Aws::EmptyStructure; end
594
726
 
727
+ # Specifies the KMS key that is used to encrypt the user's data stores
728
+ # in Athena.
729
+ #
730
+ # @!attribute [rw] kms_key
731
+ # The KMS key that is used to encrypt the user's data stores in
732
+ # Athena.
733
+ # @return [String]
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CustomerContentEncryptionConfiguration AWS API Documentation
736
+ #
737
+ class CustomerContentEncryptionConfiguration < Struct.new(
738
+ :kms_key)
739
+ SENSITIVE = []
740
+ include Aws::Structure
741
+ end
742
+
595
743
  # Contains information about a data catalog in an Amazon Web Services
596
744
  # account.
597
745
  #
@@ -726,13 +874,6 @@ module Aws::Athena
726
874
  include Aws::Structure
727
875
  end
728
876
 
729
- # @note When making an API call, you may pass DeleteDataCatalogInput
730
- # data as a hash:
731
- #
732
- # {
733
- # name: "CatalogNameString", # required
734
- # }
735
- #
736
877
  # @!attribute [rw] name
737
878
  # The name of the data catalog to delete.
738
879
  # @return [String]
@@ -749,13 +890,6 @@ module Aws::Athena
749
890
  #
750
891
  class DeleteDataCatalogOutput < Aws::EmptyStructure; end
751
892
 
752
- # @note When making an API call, you may pass DeleteNamedQueryInput
753
- # data as a hash:
754
- #
755
- # {
756
- # named_query_id: "NamedQueryId", # required
757
- # }
758
- #
759
893
  # @!attribute [rw] named_query_id
760
894
  # The unique ID of the query to delete.
761
895
  #
@@ -775,14 +909,22 @@ module Aws::Athena
775
909
  #
776
910
  class DeleteNamedQueryOutput < Aws::EmptyStructure; end
777
911
 
778
- # @note When making an API call, you may pass DeletePreparedStatementInput
779
- # data as a hash:
912
+ # @!attribute [rw] notebook_id
913
+ # The ID of the notebook to delete.
914
+ # @return [String]
780
915
  #
781
- # {
782
- # statement_name: "StatementName", # required
783
- # work_group: "WorkGroupName", # required
784
- # }
916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNotebookInput AWS API Documentation
917
+ #
918
+ class DeleteNotebookInput < Struct.new(
919
+ :notebook_id)
920
+ SENSITIVE = []
921
+ include Aws::Structure
922
+ end
923
+
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNotebookOutput AWS API Documentation
785
925
  #
926
+ class DeleteNotebookOutput < Aws::EmptyStructure; end
927
+
786
928
  # @!attribute [rw] statement_name
787
929
  # The name of the prepared statement to delete.
788
930
  # @return [String]
@@ -804,14 +946,6 @@ module Aws::Athena
804
946
  #
805
947
  class DeletePreparedStatementOutput < Aws::EmptyStructure; end
806
948
 
807
- # @note When making an API call, you may pass DeleteWorkGroupInput
808
- # data as a hash:
809
- #
810
- # {
811
- # work_group: "WorkGroupName", # required
812
- # recursive_delete_option: false,
813
- # }
814
- #
815
949
  # @!attribute [rw] work_group
816
950
  # The unique name of the workgroup to delete.
817
951
  # @return [String]
@@ -837,14 +971,6 @@ module Aws::Athena
837
971
  # If query results are encrypted in Amazon S3, indicates the encryption
838
972
  # option used (for example, `SSE_KMS` or `CSE_KMS`) and key information.
839
973
  #
840
- # @note When making an API call, you may pass EncryptionConfiguration
841
- # data as a hash:
842
- #
843
- # {
844
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
845
- # kms_key: "String",
846
- # }
847
- #
848
974
  # @!attribute [rw] encryption_option
849
975
  # Indicates whether Amazon S3 server-side encryption with Amazon
850
976
  # S3-managed keys (`SSE_S3`), server-side encryption with KMS-managed
@@ -870,15 +996,47 @@ module Aws::Athena
870
996
  include Aws::Structure
871
997
  end
872
998
 
873
- # The Athena engine version for running queries.
999
+ # Contains data processing unit (DPU) configuration settings and
1000
+ # parameter mappings for a notebook engine.
1001
+ #
1002
+ # @!attribute [rw] coordinator_dpu_size
1003
+ # The number of DPUs to use for the coordinator. A coordinator is a
1004
+ # special executor that orchestrates processing work and manages other
1005
+ # executors in a notebook session.
1006
+ # @return [Integer]
874
1007
  #
875
- # @note When making an API call, you may pass EngineVersion
876
- # data as a hash:
1008
+ # @!attribute [rw] max_concurrent_dpus
1009
+ # The maximum number of DPUs that can run concurrently.
1010
+ # @return [Integer]
1011
+ #
1012
+ # @!attribute [rw] default_executor_dpu_size
1013
+ # The default number of DPUs to use for executors. An executor is the
1014
+ # smallest unit of compute that a notebook session can request from
1015
+ # Athena.
1016
+ # @return [Integer]
877
1017
  #
878
- # {
879
- # selected_engine_version: "NameString",
880
- # effective_engine_version: "NameString",
881
- # }
1018
+ # @!attribute [rw] additional_configs
1019
+ # Contains additional notebook engine `MAP<string, string>` parameter
1020
+ # mappings in the form of key-value pairs. To specify an Amazon S3 URI
1021
+ # that the Jupyter server will download and serve, specify a value for
1022
+ # the StartSessionRequest$NotebookVersion field, and then add a key
1023
+ # named `NotebookFileURI` to `AdditionalConfigs` that has value of the
1024
+ # Amazon S3 URI.
1025
+ # @return [Hash<String,String>]
1026
+ #
1027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/EngineConfiguration AWS API Documentation
1028
+ #
1029
+ class EngineConfiguration < Struct.new(
1030
+ :coordinator_dpu_size,
1031
+ :max_concurrent_dpus,
1032
+ :default_executor_dpu_size,
1033
+ :additional_configs)
1034
+ SENSITIVE = []
1035
+ include Aws::Structure
1036
+ end
1037
+
1038
+ # The Athena engine version for running queries, or the PySpark engine
1039
+ # version for running sessions.
882
1040
  #
883
1041
  # @!attribute [rw] selected_engine_version
884
1042
  # The engine version requested by the user. Possible values are
@@ -905,126 +1063,330 @@ module Aws::Athena
905
1063
  include Aws::Structure
906
1064
  end
907
1065
 
908
- # @note When making an API call, you may pass GetDataCatalogInput
909
- # data as a hash:
1066
+ # Contains summary information about an executor.
910
1067
  #
911
- # {
912
- # name: "CatalogNameString", # required
913
- # }
1068
+ # @!attribute [rw] executor_id
1069
+ # The UUID of the executor.
1070
+ # @return [String]
914
1071
  #
915
- # @!attribute [rw] name
916
- # The name of the data catalog to return.
1072
+ # @!attribute [rw] executor_type
1073
+ # The type of executor used for the application (`COORDINATOR`,
1074
+ # `GATEWAY`, or `WORKER`).
917
1075
  # @return [String]
918
1076
  #
919
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogInput AWS API Documentation
1077
+ # @!attribute [rw] start_date_time
1078
+ # The date and time that the executor started.
1079
+ # @return [Integer]
920
1080
  #
921
- class GetDataCatalogInput < Struct.new(
922
- :name)
1081
+ # @!attribute [rw] termination_date_time
1082
+ # The date and time that the executor was terminated.
1083
+ # @return [Integer]
1084
+ #
1085
+ # @!attribute [rw] executor_state
1086
+ # The processing state of the executor. A description of each state
1087
+ # follows.
1088
+ #
1089
+ # `CREATING` - The executor is being started, including acquiring
1090
+ # resources.
1091
+ #
1092
+ # `CREATED` - The executor has been started.
1093
+ #
1094
+ # `REGISTERED` - The executor has been registered.
1095
+ #
1096
+ # `TERMINATING` - The executor is in the process of shutting down.
1097
+ #
1098
+ # `TERMINATED` - The executor is no longer running.
1099
+ #
1100
+ # `FAILED` - Due to a failure, the executor is no longer running.
1101
+ # @return [String]
1102
+ #
1103
+ # @!attribute [rw] executor_size
1104
+ # The smallest unit of compute that a session can request from Athena.
1105
+ # Size is measured in data processing unit (DPU) values, a relative
1106
+ # measure of processing power.
1107
+ # @return [Integer]
1108
+ #
1109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ExecutorsSummary AWS API Documentation
1110
+ #
1111
+ class ExecutorsSummary < Struct.new(
1112
+ :executor_id,
1113
+ :executor_type,
1114
+ :start_date_time,
1115
+ :termination_date_time,
1116
+ :executor_state,
1117
+ :executor_size)
923
1118
  SENSITIVE = []
924
1119
  include Aws::Structure
925
1120
  end
926
1121
 
927
- # @!attribute [rw] data_catalog
928
- # The data catalog returned.
929
- # @return [Types::DataCatalog]
1122
+ # @!attribute [rw] notebook_id
1123
+ # The ID of the notebook to export.
1124
+ # @return [String]
930
1125
  #
931
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogOutput AWS API Documentation
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ExportNotebookInput AWS API Documentation
932
1127
  #
933
- class GetDataCatalogOutput < Struct.new(
934
- :data_catalog)
1128
+ class ExportNotebookInput < Struct.new(
1129
+ :notebook_id)
935
1130
  SENSITIVE = []
936
1131
  include Aws::Structure
937
1132
  end
938
1133
 
939
- # @note When making an API call, you may pass GetDatabaseInput
940
- # data as a hash:
941
- #
942
- # {
943
- # catalog_name: "CatalogNameString", # required
944
- # database_name: "NameString", # required
945
- # }
946
- #
947
- # @!attribute [rw] catalog_name
948
- # The name of the data catalog that contains the database to return.
949
- # @return [String]
1134
+ # @!attribute [rw] notebook_metadata
1135
+ # The notebook metadata, including notebook ID, notebook name, and
1136
+ # workgroup name.
1137
+ # @return [Types::NotebookMetadata]
950
1138
  #
951
- # @!attribute [rw] database_name
952
- # The name of the database to return.
1139
+ # @!attribute [rw] payload
1140
+ # The content of the exported notebook.
953
1141
  # @return [String]
954
1142
  #
955
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseInput AWS API Documentation
1143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ExportNotebookOutput AWS API Documentation
956
1144
  #
957
- class GetDatabaseInput < Struct.new(
958
- :catalog_name,
959
- :database_name)
1145
+ class ExportNotebookOutput < Struct.new(
1146
+ :notebook_metadata,
1147
+ :payload)
960
1148
  SENSITIVE = []
961
1149
  include Aws::Structure
962
1150
  end
963
1151
 
964
- # @!attribute [rw] database
965
- # The database returned.
966
- # @return [Types::Database]
1152
+ # A string for searching notebook names.
967
1153
  #
968
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseOutput AWS API Documentation
1154
+ # @!attribute [rw] name
1155
+ # The name of the notebook to search for.
1156
+ # @return [String]
969
1157
  #
970
- class GetDatabaseOutput < Struct.new(
971
- :database)
1158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/FilterDefinition AWS API Documentation
1159
+ #
1160
+ class FilterDefinition < Struct.new(
1161
+ :name)
972
1162
  SENSITIVE = []
973
1163
  include Aws::Structure
974
1164
  end
975
1165
 
976
- # @note When making an API call, you may pass GetNamedQueryInput
977
- # data as a hash:
1166
+ # @!attribute [rw] calculation_execution_id
1167
+ # The calculation execution UUID.
1168
+ # @return [String]
978
1169
  #
979
- # {
980
- # named_query_id: "NamedQueryId", # required
981
- # }
1170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionCodeRequest AWS API Documentation
982
1171
  #
983
- # @!attribute [rw] named_query_id
984
- # The unique ID of the query. Use ListNamedQueries to get query IDs.
1172
+ class GetCalculationExecutionCodeRequest < Struct.new(
1173
+ :calculation_execution_id)
1174
+ SENSITIVE = []
1175
+ include Aws::Structure
1176
+ end
1177
+
1178
+ # @!attribute [rw] code_block
1179
+ # A pre-signed URL to the code that executed the calculation.
985
1180
  # @return [String]
986
1181
  #
987
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryInput AWS API Documentation
1182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionCodeResponse AWS API Documentation
988
1183
  #
989
- class GetNamedQueryInput < Struct.new(
990
- :named_query_id)
1184
+ class GetCalculationExecutionCodeResponse < Struct.new(
1185
+ :code_block)
991
1186
  SENSITIVE = []
992
1187
  include Aws::Structure
993
1188
  end
994
1189
 
995
- # @!attribute [rw] named_query
996
- # Information about the query.
997
- # @return [Types::NamedQuery]
1190
+ # @!attribute [rw] calculation_execution_id
1191
+ # The calculation execution UUID.
1192
+ # @return [String]
998
1193
  #
999
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryOutput AWS API Documentation
1194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionRequest AWS API Documentation
1000
1195
  #
1001
- class GetNamedQueryOutput < Struct.new(
1002
- :named_query)
1196
+ class GetCalculationExecutionRequest < Struct.new(
1197
+ :calculation_execution_id)
1003
1198
  SENSITIVE = []
1004
1199
  include Aws::Structure
1005
1200
  end
1006
1201
 
1007
- # @note When making an API call, you may pass GetPreparedStatementInput
1008
- # data as a hash:
1202
+ # @!attribute [rw] calculation_execution_id
1203
+ # The calculation execution UUID.
1204
+ # @return [String]
1009
1205
  #
1010
- # {
1011
- # statement_name: "StatementName", # required
1012
- # work_group: "WorkGroupName", # required
1013
- # }
1206
+ # @!attribute [rw] session_id
1207
+ # The session ID that the calculation ran in.
1208
+ # @return [String]
1014
1209
  #
1015
- # @!attribute [rw] statement_name
1016
- # The name of the prepared statement to retrieve.
1210
+ # @!attribute [rw] description
1211
+ # The description of the calculation execution.
1017
1212
  # @return [String]
1018
1213
  #
1019
- # @!attribute [rw] work_group
1020
- # The workgroup to which the statement to be retrieved belongs.
1214
+ # @!attribute [rw] working_directory
1215
+ # The Amazon S3 location in which calculation results are stored.
1021
1216
  # @return [String]
1022
1217
  #
1023
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetPreparedStatementInput AWS API Documentation
1218
+ # @!attribute [rw] status
1219
+ # Contains information about the status of the calculation.
1220
+ # @return [Types::CalculationStatus]
1024
1221
  #
1025
- class GetPreparedStatementInput < Struct.new(
1026
- :statement_name,
1027
- :work_group)
1222
+ # @!attribute [rw] statistics
1223
+ # Contains information about the data processing unit (DPU) execution
1224
+ # time and progress. This field is populated only when statistics are
1225
+ # available.
1226
+ # @return [Types::CalculationStatistics]
1227
+ #
1228
+ # @!attribute [rw] result
1229
+ # Contains result information. This field is populated only if the
1230
+ # calculation is completed.
1231
+ # @return [Types::CalculationResult]
1232
+ #
1233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionResponse AWS API Documentation
1234
+ #
1235
+ class GetCalculationExecutionResponse < Struct.new(
1236
+ :calculation_execution_id,
1237
+ :session_id,
1238
+ :description,
1239
+ :working_directory,
1240
+ :status,
1241
+ :statistics,
1242
+ :result)
1243
+ SENSITIVE = []
1244
+ include Aws::Structure
1245
+ end
1246
+
1247
+ # @!attribute [rw] calculation_execution_id
1248
+ # The calculation execution UUID.
1249
+ # @return [String]
1250
+ #
1251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionStatusRequest AWS API Documentation
1252
+ #
1253
+ class GetCalculationExecutionStatusRequest < Struct.new(
1254
+ :calculation_execution_id)
1255
+ SENSITIVE = []
1256
+ include Aws::Structure
1257
+ end
1258
+
1259
+ # @!attribute [rw] status
1260
+ # Contains information about the calculation execution status.
1261
+ # @return [Types::CalculationStatus]
1262
+ #
1263
+ # @!attribute [rw] statistics
1264
+ # Contains information about the DPU execution time and progress.
1265
+ # @return [Types::CalculationStatistics]
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionStatusResponse AWS API Documentation
1268
+ #
1269
+ class GetCalculationExecutionStatusResponse < Struct.new(
1270
+ :status,
1271
+ :statistics)
1272
+ SENSITIVE = []
1273
+ include Aws::Structure
1274
+ end
1275
+
1276
+ # @!attribute [rw] name
1277
+ # The name of the data catalog to return.
1278
+ # @return [String]
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogInput AWS API Documentation
1281
+ #
1282
+ class GetDataCatalogInput < Struct.new(
1283
+ :name)
1284
+ SENSITIVE = []
1285
+ include Aws::Structure
1286
+ end
1287
+
1288
+ # @!attribute [rw] data_catalog
1289
+ # The data catalog returned.
1290
+ # @return [Types::DataCatalog]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogOutput AWS API Documentation
1293
+ #
1294
+ class GetDataCatalogOutput < Struct.new(
1295
+ :data_catalog)
1296
+ SENSITIVE = []
1297
+ include Aws::Structure
1298
+ end
1299
+
1300
+ # @!attribute [rw] catalog_name
1301
+ # The name of the data catalog that contains the database to return.
1302
+ # @return [String]
1303
+ #
1304
+ # @!attribute [rw] database_name
1305
+ # The name of the database to return.
1306
+ # @return [String]
1307
+ #
1308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseInput AWS API Documentation
1309
+ #
1310
+ class GetDatabaseInput < Struct.new(
1311
+ :catalog_name,
1312
+ :database_name)
1313
+ SENSITIVE = []
1314
+ include Aws::Structure
1315
+ end
1316
+
1317
+ # @!attribute [rw] database
1318
+ # The database returned.
1319
+ # @return [Types::Database]
1320
+ #
1321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseOutput AWS API Documentation
1322
+ #
1323
+ class GetDatabaseOutput < Struct.new(
1324
+ :database)
1325
+ SENSITIVE = []
1326
+ include Aws::Structure
1327
+ end
1328
+
1329
+ # @!attribute [rw] named_query_id
1330
+ # The unique ID of the query. Use ListNamedQueries to get query IDs.
1331
+ # @return [String]
1332
+ #
1333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryInput AWS API Documentation
1334
+ #
1335
+ class GetNamedQueryInput < Struct.new(
1336
+ :named_query_id)
1337
+ SENSITIVE = []
1338
+ include Aws::Structure
1339
+ end
1340
+
1341
+ # @!attribute [rw] named_query
1342
+ # Information about the query.
1343
+ # @return [Types::NamedQuery]
1344
+ #
1345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryOutput AWS API Documentation
1346
+ #
1347
+ class GetNamedQueryOutput < Struct.new(
1348
+ :named_query)
1349
+ SENSITIVE = []
1350
+ include Aws::Structure
1351
+ end
1352
+
1353
+ # @!attribute [rw] notebook_id
1354
+ # The ID of the notebook whose metadata is to be retrieved.
1355
+ # @return [String]
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNotebookMetadataInput AWS API Documentation
1358
+ #
1359
+ class GetNotebookMetadataInput < Struct.new(
1360
+ :notebook_id)
1361
+ SENSITIVE = []
1362
+ include Aws::Structure
1363
+ end
1364
+
1365
+ # @!attribute [rw] notebook_metadata
1366
+ # The metadata that is returned for the specified notebook ID.
1367
+ # @return [Types::NotebookMetadata]
1368
+ #
1369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNotebookMetadataOutput AWS API Documentation
1370
+ #
1371
+ class GetNotebookMetadataOutput < Struct.new(
1372
+ :notebook_metadata)
1373
+ SENSITIVE = []
1374
+ include Aws::Structure
1375
+ end
1376
+
1377
+ # @!attribute [rw] statement_name
1378
+ # The name of the prepared statement to retrieve.
1379
+ # @return [String]
1380
+ #
1381
+ # @!attribute [rw] work_group
1382
+ # The workgroup to which the statement to be retrieved belongs.
1383
+ # @return [String]
1384
+ #
1385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetPreparedStatementInput AWS API Documentation
1386
+ #
1387
+ class GetPreparedStatementInput < Struct.new(
1388
+ :statement_name,
1389
+ :work_group)
1028
1390
  SENSITIVE = []
1029
1391
  include Aws::Structure
1030
1392
  end
@@ -1041,13 +1403,6 @@ module Aws::Athena
1041
1403
  include Aws::Structure
1042
1404
  end
1043
1405
 
1044
- # @note When making an API call, you may pass GetQueryExecutionInput
1045
- # data as a hash:
1046
- #
1047
- # {
1048
- # query_execution_id: "QueryExecutionId", # required
1049
- # }
1050
- #
1051
1406
  # @!attribute [rw] query_execution_id
1052
1407
  # The unique ID of the query execution.
1053
1408
  # @return [String]
@@ -1072,15 +1427,6 @@ module Aws::Athena
1072
1427
  include Aws::Structure
1073
1428
  end
1074
1429
 
1075
- # @note When making an API call, you may pass GetQueryResultsInput
1076
- # data as a hash:
1077
- #
1078
- # {
1079
- # query_execution_id: "QueryExecutionId", # required
1080
- # next_token: "Token",
1081
- # max_results: 1,
1082
- # }
1083
- #
1084
1430
  # @!attribute [rw] query_execution_id
1085
1431
  # The unique ID of the query execution.
1086
1432
  # @return [String]
@@ -1132,13 +1478,6 @@ module Aws::Athena
1132
1478
  include Aws::Structure
1133
1479
  end
1134
1480
 
1135
- # @note When making an API call, you may pass GetQueryRuntimeStatisticsInput
1136
- # data as a hash:
1137
- #
1138
- # {
1139
- # query_execution_id: "QueryExecutionId", # required
1140
- # }
1141
- #
1142
1481
  # @!attribute [rw] query_execution_id
1143
1482
  # The unique ID of the query execution.
1144
1483
  # @return [String]
@@ -1163,15 +1502,102 @@ module Aws::Athena
1163
1502
  include Aws::Structure
1164
1503
  end
1165
1504
 
1166
- # @note When making an API call, you may pass GetTableMetadataInput
1167
- # data as a hash:
1505
+ # @!attribute [rw] session_id
1506
+ # The session ID.
1507
+ # @return [String]
1508
+ #
1509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSessionRequest AWS API Documentation
1510
+ #
1511
+ class GetSessionRequest < Struct.new(
1512
+ :session_id)
1513
+ SENSITIVE = []
1514
+ include Aws::Structure
1515
+ end
1516
+
1517
+ # @!attribute [rw] session_id
1518
+ # The session ID.
1519
+ # @return [String]
1520
+ #
1521
+ # @!attribute [rw] description
1522
+ # The session description.
1523
+ # @return [String]
1524
+ #
1525
+ # @!attribute [rw] work_group
1526
+ # The workgroup to which the session belongs.
1527
+ # @return [String]
1528
+ #
1529
+ # @!attribute [rw] engine_version
1530
+ # The engine version used by the session (for example, `PySpark engine
1531
+ # version 3`). You can get a list of engine versions by calling
1532
+ # ListEngineVersions.
1533
+ # @return [String]
1534
+ #
1535
+ # @!attribute [rw] engine_configuration
1536
+ # Contains engine configuration information like DPU usage.
1537
+ # @return [Types::EngineConfiguration]
1538
+ #
1539
+ # @!attribute [rw] notebook_version
1540
+ # The notebook version.
1541
+ # @return [String]
1542
+ #
1543
+ # @!attribute [rw] session_configuration
1544
+ # Contains the workgroup configuration information used by the
1545
+ # session.
1546
+ # @return [Types::SessionConfiguration]
1547
+ #
1548
+ # @!attribute [rw] status
1549
+ # Contains information about the status of the session.
1550
+ # @return [Types::SessionStatus]
1551
+ #
1552
+ # @!attribute [rw] statistics
1553
+ # Contains the DPU execution time.
1554
+ # @return [Types::SessionStatistics]
1555
+ #
1556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSessionResponse AWS API Documentation
1557
+ #
1558
+ class GetSessionResponse < Struct.new(
1559
+ :session_id,
1560
+ :description,
1561
+ :work_group,
1562
+ :engine_version,
1563
+ :engine_configuration,
1564
+ :notebook_version,
1565
+ :session_configuration,
1566
+ :status,
1567
+ :statistics)
1568
+ SENSITIVE = []
1569
+ include Aws::Structure
1570
+ end
1571
+
1572
+ # @!attribute [rw] session_id
1573
+ # The session ID.
1574
+ # @return [String]
1168
1575
  #
1169
- # {
1170
- # catalog_name: "CatalogNameString", # required
1171
- # database_name: "NameString", # required
1172
- # table_name: "NameString", # required
1173
- # }
1576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSessionStatusRequest AWS API Documentation
1577
+ #
1578
+ class GetSessionStatusRequest < Struct.new(
1579
+ :session_id)
1580
+ SENSITIVE = []
1581
+ include Aws::Structure
1582
+ end
1583
+
1584
+ # @!attribute [rw] session_id
1585
+ # The session ID.
1586
+ # @return [String]
1174
1587
  #
1588
+ # @!attribute [rw] status
1589
+ # Contains information about the status of the session.
1590
+ # @return [Types::SessionStatus]
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSessionStatusResponse AWS API Documentation
1593
+ #
1594
+ class GetSessionStatusResponse < Struct.new(
1595
+ :session_id,
1596
+ :status)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1175
1601
  # @!attribute [rw] catalog_name
1176
1602
  # The name of the data catalog that contains the database and table
1177
1603
  # metadata to return.
@@ -1207,13 +1633,6 @@ module Aws::Athena
1207
1633
  include Aws::Structure
1208
1634
  end
1209
1635
 
1210
- # @note When making an API call, you may pass GetWorkGroupInput
1211
- # data as a hash:
1212
- #
1213
- # {
1214
- # work_group: "WorkGroupName", # required
1215
- # }
1216
- #
1217
1636
  # @!attribute [rw] work_group
1218
1637
  # The name of the workgroup.
1219
1638
  # @return [String]
@@ -1238,6 +1657,58 @@ module Aws::Athena
1238
1657
  include Aws::Structure
1239
1658
  end
1240
1659
 
1660
+ # @!attribute [rw] work_group
1661
+ # The name of the Spark enabled workgroup to import the notebook to.
1662
+ # @return [String]
1663
+ #
1664
+ # @!attribute [rw] name
1665
+ # The name of the notebook to import.
1666
+ # @return [String]
1667
+ #
1668
+ # @!attribute [rw] payload
1669
+ # The notebook content to be imported.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] type
1673
+ # The notebook content type. Currently, the only valid type is
1674
+ # `IPYNB`.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] client_request_token
1678
+ # A unique case-sensitive string used to ensure the request to import
1679
+ # the notebook is idempotent (executes only once).
1680
+ #
1681
+ # This token is listed as not required because Amazon Web Services
1682
+ # SDKs (for example the Amazon Web Services SDK for Java)
1683
+ # auto-generate the token for you. If you are not using the Amazon Web
1684
+ # Services SDK or the Amazon Web Services CLI, you must provide this
1685
+ # token or the action will fail.
1686
+ # @return [String]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ImportNotebookInput AWS API Documentation
1689
+ #
1690
+ class ImportNotebookInput < Struct.new(
1691
+ :work_group,
1692
+ :name,
1693
+ :payload,
1694
+ :type,
1695
+ :client_request_token)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # @!attribute [rw] notebook_id
1701
+ # The ID of the notebook to import.
1702
+ # @return [String]
1703
+ #
1704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ImportNotebookOutput AWS API Documentation
1705
+ #
1706
+ class ImportNotebookOutput < Struct.new(
1707
+ :notebook_id)
1708
+ SENSITIVE = []
1709
+ include Aws::Structure
1710
+ end
1711
+
1241
1712
  # Indicates a platform issue, which may be due to a transient condition
1242
1713
  # or outage.
1243
1714
  #
@@ -1272,14 +1743,114 @@ module Aws::Athena
1272
1743
  include Aws::Structure
1273
1744
  end
1274
1745
 
1275
- # @note When making an API call, you may pass ListDataCatalogsInput
1276
- # data as a hash:
1746
+ # @!attribute [rw] max_results
1747
+ # Specifies the maximum number of results to return.
1748
+ # @return [Integer]
1749
+ #
1750
+ # @!attribute [rw] next_token
1751
+ # A token generated by the Athena service that specifies where to
1752
+ # continue pagination if a previous request was truncated.
1753
+ # @return [String]
1754
+ #
1755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListApplicationDPUSizesInput AWS API Documentation
1756
+ #
1757
+ class ListApplicationDPUSizesInput < Struct.new(
1758
+ :max_results,
1759
+ :next_token)
1760
+ SENSITIVE = []
1761
+ include Aws::Structure
1762
+ end
1763
+
1764
+ # @!attribute [rw] application_dpu_sizes
1765
+ # A list of the supported DPU sizes that the application runtime
1766
+ # supports.
1767
+ # @return [Array<Types::ApplicationDPUSizes>]
1768
+ #
1769
+ # @!attribute [rw] next_token
1770
+ # A token generated by the Athena service that specifies where to
1771
+ # continue pagination if a previous request was truncated. To obtain
1772
+ # the next set of pages, pass in the `NextToken` from the response
1773
+ # object of the previous page call.
1774
+ # @return [String]
1775
+ #
1776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListApplicationDPUSizesOutput AWS API Documentation
1777
+ #
1778
+ class ListApplicationDPUSizesOutput < Struct.new(
1779
+ :application_dpu_sizes,
1780
+ :next_token)
1781
+ SENSITIVE = []
1782
+ include Aws::Structure
1783
+ end
1784
+
1785
+ # @!attribute [rw] session_id
1786
+ # The session ID.
1787
+ # @return [String]
1788
+ #
1789
+ # @!attribute [rw] state_filter
1790
+ # A filter for a specific calculation execution state. A description
1791
+ # of each state follows.
1792
+ #
1793
+ # `CREATING` - The calculation is in the process of being created.
1794
+ #
1795
+ # `CREATED` - The calculation has been created and is ready to run.
1796
+ #
1797
+ # `QUEUED` - The calculation has been queued for processing.
1798
+ #
1799
+ # `RUNNING` - The calculation is running.
1800
+ #
1801
+ # `CANCELING` - A request to cancel the calculation has been received
1802
+ # and the system is working to stop it.
1803
+ #
1804
+ # `CANCELED` - The calculation is no longer running as the result of a
1805
+ # cancel request.
1806
+ #
1807
+ # `COMPLETED` - The calculation has completed without error.
1808
+ #
1809
+ # `FAILED` - The calculation failed and is no longer running.
1810
+ # @return [String]
1811
+ #
1812
+ # @!attribute [rw] max_results
1813
+ # The maximum number of calculation executions to return.
1814
+ # @return [Integer]
1815
+ #
1816
+ # @!attribute [rw] next_token
1817
+ # A token generated by the Athena service that specifies where to
1818
+ # continue pagination if a previous request was truncated. To obtain
1819
+ # the next set of pages, pass in the `NextToken` from the response
1820
+ # object of the previous page call.
1821
+ # @return [String]
1822
+ #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCalculationExecutionsRequest AWS API Documentation
1824
+ #
1825
+ class ListCalculationExecutionsRequest < Struct.new(
1826
+ :session_id,
1827
+ :state_filter,
1828
+ :max_results,
1829
+ :next_token)
1830
+ SENSITIVE = []
1831
+ include Aws::Structure
1832
+ end
1833
+
1834
+ # @!attribute [rw] next_token
1835
+ # A token generated by the Athena service that specifies where to
1836
+ # continue pagination if a previous request was truncated. To obtain
1837
+ # the next set of pages, pass in the `NextToken` from the response
1838
+ # object of the previous page call.
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] calculations
1842
+ # A list of CalculationSummary objects.
1843
+ # @return [Array<Types::CalculationSummary>]
1277
1844
  #
1278
- # {
1279
- # next_token: "Token",
1280
- # max_results: 1,
1281
- # }
1845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCalculationExecutionsResponse AWS API Documentation
1282
1846
  #
1847
+ class ListCalculationExecutionsResponse < Struct.new(
1848
+ :next_token,
1849
+ :calculations)
1850
+ SENSITIVE = []
1851
+ include Aws::Structure
1852
+ end
1853
+
1283
1854
  # @!attribute [rw] next_token
1284
1855
  # A token generated by the Athena service that specifies where to
1285
1856
  # continue pagination if a previous request was truncated. To obtain
@@ -1320,15 +1891,6 @@ module Aws::Athena
1320
1891
  include Aws::Structure
1321
1892
  end
1322
1893
 
1323
- # @note When making an API call, you may pass ListDatabasesInput
1324
- # data as a hash:
1325
- #
1326
- # {
1327
- # catalog_name: "CatalogNameString", # required
1328
- # next_token: "Token",
1329
- # max_results: 1,
1330
- # }
1331
- #
1332
1894
  # @!attribute [rw] catalog_name
1333
1895
  # The name of the data catalog that contains the databases to return.
1334
1896
  # @return [String]
@@ -1374,14 +1936,6 @@ module Aws::Athena
1374
1936
  include Aws::Structure
1375
1937
  end
1376
1938
 
1377
- # @note When making an API call, you may pass ListEngineVersionsInput
1378
- # data as a hash:
1379
- #
1380
- # {
1381
- # next_token: "Token",
1382
- # max_results: 1,
1383
- # }
1384
- #
1385
1939
  # @!attribute [rw] next_token
1386
1940
  # A token generated by the Athena service that specifies where to
1387
1941
  # continue pagination if a previous request was truncated. To obtain
@@ -1422,15 +1976,75 @@ module Aws::Athena
1422
1976
  include Aws::Structure
1423
1977
  end
1424
1978
 
1425
- # @note When making an API call, you may pass ListNamedQueriesInput
1426
- # data as a hash:
1979
+ # @!attribute [rw] session_id
1980
+ # The session ID.
1981
+ # @return [String]
1982
+ #
1983
+ # @!attribute [rw] executor_state_filter
1984
+ # A filter for a specific executor state. A description of each state
1985
+ # follows.
1986
+ #
1987
+ # `CREATING` - The executor is being started, including acquiring
1988
+ # resources.
1989
+ #
1990
+ # `CREATED` - The executor has been started.
1991
+ #
1992
+ # `REGISTERED` - The executor has been registered.
1993
+ #
1994
+ # `TERMINATING` - The executor is in the process of shutting down.
1995
+ #
1996
+ # `TERMINATED` - The executor is no longer running.
1997
+ #
1998
+ # `FAILED` - Due to a failure, the executor is no longer running.
1999
+ # @return [String]
2000
+ #
2001
+ # @!attribute [rw] max_results
2002
+ # The maximum number of executors to return.
2003
+ # @return [Integer]
2004
+ #
2005
+ # @!attribute [rw] next_token
2006
+ # A token generated by the Athena service that specifies where to
2007
+ # continue pagination if a previous request was truncated. To obtain
2008
+ # the next set of pages, pass in the `NextToken` from the response
2009
+ # object of the previous page call.
2010
+ # @return [String]
2011
+ #
2012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListExecutorsRequest AWS API Documentation
2013
+ #
2014
+ class ListExecutorsRequest < Struct.new(
2015
+ :session_id,
2016
+ :executor_state_filter,
2017
+ :max_results,
2018
+ :next_token)
2019
+ SENSITIVE = []
2020
+ include Aws::Structure
2021
+ end
2022
+
2023
+ # @!attribute [rw] session_id
2024
+ # The session ID.
2025
+ # @return [String]
1427
2026
  #
1428
- # {
1429
- # next_token: "Token",
1430
- # max_results: 1,
1431
- # work_group: "WorkGroupName",
1432
- # }
2027
+ # @!attribute [rw] next_token
2028
+ # A token generated by the Athena service that specifies where to
2029
+ # continue pagination if a previous request was truncated. To obtain
2030
+ # the next set of pages, pass in the `NextToken` from the response
2031
+ # object of the previous page call.
2032
+ # @return [String]
2033
+ #
2034
+ # @!attribute [rw] executors_summary
2035
+ # Contains summary information about the executor.
2036
+ # @return [Array<Types::ExecutorsSummary>]
1433
2037
  #
2038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListExecutorsResponse AWS API Documentation
2039
+ #
2040
+ class ListExecutorsResponse < Struct.new(
2041
+ :session_id,
2042
+ :next_token,
2043
+ :executors_summary)
2044
+ SENSITIVE = []
2045
+ include Aws::Structure
2046
+ end
2047
+
1434
2048
  # @!attribute [rw] next_token
1435
2049
  # A token generated by the Athena service that specifies where to
1436
2050
  # continue pagination if a previous request was truncated. To obtain
@@ -1448,19 +2062,113 @@ module Aws::Athena
1448
2062
  # primary workgroup are returned.
1449
2063
  # @return [String]
1450
2064
  #
1451
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesInput AWS API Documentation
2065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesInput AWS API Documentation
2066
+ #
2067
+ class ListNamedQueriesInput < Struct.new(
2068
+ :next_token,
2069
+ :max_results,
2070
+ :work_group)
2071
+ SENSITIVE = []
2072
+ include Aws::Structure
2073
+ end
2074
+
2075
+ # @!attribute [rw] named_query_ids
2076
+ # The list of unique query IDs.
2077
+ # @return [Array<String>]
2078
+ #
2079
+ # @!attribute [rw] next_token
2080
+ # A token generated by the Athena service that specifies where to
2081
+ # continue pagination if a previous request was truncated. To obtain
2082
+ # the next set of pages, pass in the `NextToken` from the response
2083
+ # object of the previous page call.
2084
+ # @return [String]
2085
+ #
2086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesOutput AWS API Documentation
2087
+ #
2088
+ class ListNamedQueriesOutput < Struct.new(
2089
+ :named_query_ids,
2090
+ :next_token)
2091
+ SENSITIVE = []
2092
+ include Aws::Structure
2093
+ end
2094
+
2095
+ # @!attribute [rw] filters
2096
+ # Search filter string.
2097
+ # @return [Types::FilterDefinition]
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.
2102
+ # @return [String]
2103
+ #
2104
+ # @!attribute [rw] max_results
2105
+ # Specifies the maximum number of results to return.
2106
+ # @return [Integer]
2107
+ #
2108
+ # @!attribute [rw] work_group
2109
+ # The name of the Spark enabled workgroup to retrieve notebook
2110
+ # metadata for.
2111
+ # @return [String]
2112
+ #
2113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookMetadataInput AWS API Documentation
2114
+ #
2115
+ class ListNotebookMetadataInput < Struct.new(
2116
+ :filters,
2117
+ :next_token,
2118
+ :max_results,
2119
+ :work_group)
2120
+ SENSITIVE = []
2121
+ include Aws::Structure
2122
+ end
2123
+
2124
+ # @!attribute [rw] next_token
2125
+ # A token generated by the Athena service that specifies where to
2126
+ # continue pagination if a previous request was truncated. To obtain
2127
+ # the next set of pages, pass in the `NextToken` from the response
2128
+ # object of the previous page call.
2129
+ # @return [String]
2130
+ #
2131
+ # @!attribute [rw] notebook_metadata_list
2132
+ # The list of notebook metadata for the specified workgroup.
2133
+ # @return [Array<Types::NotebookMetadata>]
2134
+ #
2135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookMetadataOutput AWS API Documentation
2136
+ #
2137
+ class ListNotebookMetadataOutput < Struct.new(
2138
+ :next_token,
2139
+ :notebook_metadata_list)
2140
+ SENSITIVE = []
2141
+ include Aws::Structure
2142
+ end
2143
+
2144
+ # @!attribute [rw] notebook_id
2145
+ # The ID of the notebook to list sessions for.
2146
+ # @return [String]
2147
+ #
2148
+ # @!attribute [rw] max_results
2149
+ # The maximum number of notebook sessions to return.
2150
+ # @return [Integer]
2151
+ #
2152
+ # @!attribute [rw] next_token
2153
+ # A token generated by the Athena service that specifies where to
2154
+ # continue pagination if a previous request was truncated. To obtain
2155
+ # the next set of pages, pass in the `NextToken` from the response
2156
+ # object of the previous page call.
2157
+ # @return [String]
2158
+ #
2159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookSessionsRequest AWS API Documentation
1452
2160
  #
1453
- class ListNamedQueriesInput < Struct.new(
1454
- :next_token,
2161
+ class ListNotebookSessionsRequest < Struct.new(
2162
+ :notebook_id,
1455
2163
  :max_results,
1456
- :work_group)
2164
+ :next_token)
1457
2165
  SENSITIVE = []
1458
2166
  include Aws::Structure
1459
2167
  end
1460
2168
 
1461
- # @!attribute [rw] named_query_ids
1462
- # The list of unique query IDs.
1463
- # @return [Array<String>]
2169
+ # @!attribute [rw] notebook_sessions_list
2170
+ # A list of the sessions belonging to the notebook.
2171
+ # @return [Array<Types::NotebookSessionSummary>]
1464
2172
  #
1465
2173
  # @!attribute [rw] next_token
1466
2174
  # A token generated by the Athena service that specifies where to
@@ -1469,24 +2177,15 @@ module Aws::Athena
1469
2177
  # object of the previous page call.
1470
2178
  # @return [String]
1471
2179
  #
1472
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesOutput AWS API Documentation
2180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookSessionsResponse AWS API Documentation
1473
2181
  #
1474
- class ListNamedQueriesOutput < Struct.new(
1475
- :named_query_ids,
2182
+ class ListNotebookSessionsResponse < Struct.new(
2183
+ :notebook_sessions_list,
1476
2184
  :next_token)
1477
2185
  SENSITIVE = []
1478
2186
  include Aws::Structure
1479
2187
  end
1480
2188
 
1481
- # @note When making an API call, you may pass ListPreparedStatementsInput
1482
- # data as a hash:
1483
- #
1484
- # {
1485
- # work_group: "WorkGroupName", # required
1486
- # next_token: "Token",
1487
- # max_results: 1,
1488
- # }
1489
- #
1490
2189
  # @!attribute [rw] work_group
1491
2190
  # The workgroup to list the prepared statements for.
1492
2191
  # @return [String]
@@ -1532,15 +2231,6 @@ module Aws::Athena
1532
2231
  include Aws::Structure
1533
2232
  end
1534
2233
 
1535
- # @note When making an API call, you may pass ListQueryExecutionsInput
1536
- # data as a hash:
1537
- #
1538
- # {
1539
- # next_token: "Token",
1540
- # max_results: 1,
1541
- # work_group: "WorkGroupName",
1542
- # }
1543
- #
1544
2234
  # @!attribute [rw] next_token
1545
2235
  # A token generated by the Athena service that specifies where to
1546
2236
  # continue pagination if a previous request was truncated. To obtain
@@ -1585,17 +2275,76 @@ module Aws::Athena
1585
2275
  include Aws::Structure
1586
2276
  end
1587
2277
 
1588
- # @note When making an API call, you may pass ListTableMetadataInput
1589
- # data as a hash:
2278
+ # @!attribute [rw] work_group
2279
+ # The workgroup to which the session belongs.
2280
+ # @return [String]
2281
+ #
2282
+ # @!attribute [rw] state_filter
2283
+ # A filter for a specific session state. A description of each state
2284
+ # follows.
2285
+ #
2286
+ # `CREATING` - The session is being started, including acquiring
2287
+ # resources.
2288
+ #
2289
+ # `CREATED` - The session has been started.
2290
+ #
2291
+ # `IDLE` - The session is able to accept a calculation.
2292
+ #
2293
+ # `BUSY` - The session is processing another task and is unable to
2294
+ # accept a calculation.
2295
+ #
2296
+ # `TERMINATING` - The session is in the process of shutting down.
2297
+ #
2298
+ # `TERMINATED` - The session and its resources are no longer running.
2299
+ #
2300
+ # `DEGRADED` - The session has no healthy coordinators.
2301
+ #
2302
+ # `FAILED` - Due to a failure, the session and its resources are no
2303
+ # longer running.
2304
+ # @return [String]
2305
+ #
2306
+ # @!attribute [rw] max_results
2307
+ # The maximum number of sessions to return.
2308
+ # @return [Integer]
2309
+ #
2310
+ # @!attribute [rw] next_token
2311
+ # A token generated by the Athena service that specifies where to
2312
+ # continue pagination if a previous request was truncated. To obtain
2313
+ # the next set of pages, pass in the `NextToken` from the response
2314
+ # object of the previous page call.
2315
+ # @return [String]
2316
+ #
2317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListSessionsRequest AWS API Documentation
2318
+ #
2319
+ class ListSessionsRequest < Struct.new(
2320
+ :work_group,
2321
+ :state_filter,
2322
+ :max_results,
2323
+ :next_token)
2324
+ SENSITIVE = []
2325
+ include Aws::Structure
2326
+ end
2327
+
2328
+ # @!attribute [rw] next_token
2329
+ # A token generated by the Athena service that specifies where to
2330
+ # continue pagination if a previous request was truncated. To obtain
2331
+ # the next set of pages, pass in the `NextToken` from the response
2332
+ # object of the previous page call.
2333
+ # @return [String]
2334
+ #
2335
+ # @!attribute [rw] sessions
2336
+ # A list of sessions.
2337
+ # @return [Array<Types::SessionSummary>]
1590
2338
  #
1591
- # {
1592
- # catalog_name: "CatalogNameString", # required
1593
- # database_name: "NameString", # required
1594
- # expression: "ExpressionString",
1595
- # next_token: "Token",
1596
- # max_results: 1,
1597
- # }
2339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListSessionsResponse AWS API Documentation
1598
2340
  #
2341
+ class ListSessionsResponse < Struct.new(
2342
+ :next_token,
2343
+ :sessions)
2344
+ SENSITIVE = []
2345
+ include Aws::Structure
2346
+ end
2347
+
1599
2348
  # @!attribute [rw] catalog_name
1600
2349
  # The name of the data catalog for which table metadata should be
1601
2350
  # returned.
@@ -1654,15 +2403,6 @@ module Aws::Athena
1654
2403
  include Aws::Structure
1655
2404
  end
1656
2405
 
1657
- # @note When making an API call, you may pass ListTagsForResourceInput
1658
- # data as a hash:
1659
- #
1660
- # {
1661
- # resource_arn: "AmazonResourceName", # required
1662
- # next_token: "Token",
1663
- # max_results: 1,
1664
- # }
1665
- #
1666
2406
  # @!attribute [rw] resource_arn
1667
2407
  # Lists the tags for the resource with the specified ARN.
1668
2408
  # @return [String]
@@ -1705,14 +2445,6 @@ module Aws::Athena
1705
2445
  include Aws::Structure
1706
2446
  end
1707
2447
 
1708
- # @note When making an API call, you may pass ListWorkGroupsInput
1709
- # data as a hash:
1710
- #
1711
- # {
1712
- # next_token: "Token",
1713
- # max_results: 1,
1714
- # }
1715
- #
1716
2448
  # @!attribute [rw] next_token
1717
2449
  # A token generated by the Athena service that specifies where to
1718
2450
  # continue pagination if a previous request was truncated. To obtain
@@ -1812,6 +2544,66 @@ module Aws::Athena
1812
2544
  include Aws::Structure
1813
2545
  end
1814
2546
 
2547
+ # Contains metadata for notebook, including the notebook name, ID,
2548
+ # workgroup, and time created.
2549
+ #
2550
+ # @!attribute [rw] notebook_id
2551
+ # The notebook ID.
2552
+ # @return [String]
2553
+ #
2554
+ # @!attribute [rw] name
2555
+ # The name of the notebook.
2556
+ # @return [String]
2557
+ #
2558
+ # @!attribute [rw] work_group
2559
+ # The name of the Spark enabled workgroup to which the notebook
2560
+ # belongs.
2561
+ # @return [String]
2562
+ #
2563
+ # @!attribute [rw] creation_time
2564
+ # The time when the notebook was created.
2565
+ # @return [Time]
2566
+ #
2567
+ # @!attribute [rw] type
2568
+ # The type of notebook. Currently, the only valid type is `IPYNB`.
2569
+ # @return [String]
2570
+ #
2571
+ # @!attribute [rw] last_modified_time
2572
+ # The time when the notebook was last modified.
2573
+ # @return [Time]
2574
+ #
2575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/NotebookMetadata AWS API Documentation
2576
+ #
2577
+ class NotebookMetadata < Struct.new(
2578
+ :notebook_id,
2579
+ :name,
2580
+ :work_group,
2581
+ :creation_time,
2582
+ :type,
2583
+ :last_modified_time)
2584
+ SENSITIVE = []
2585
+ include Aws::Structure
2586
+ end
2587
+
2588
+ # Contains the notebook session ID and notebook session creation time.
2589
+ #
2590
+ # @!attribute [rw] session_id
2591
+ # The notebook session ID.
2592
+ # @return [String]
2593
+ #
2594
+ # @!attribute [rw] creation_time
2595
+ # The time when the notebook session was created.
2596
+ # @return [Time]
2597
+ #
2598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/NotebookSessionSummary AWS API Documentation
2599
+ #
2600
+ class NotebookSessionSummary < Struct.new(
2601
+ :session_id,
2602
+ :creation_time)
2603
+ SENSITIVE = []
2604
+ include Aws::Structure
2605
+ end
2606
+
1815
2607
  # A prepared SQL statement for use with Athena.
1816
2608
  #
1817
2609
  # @!attribute [rw] statement_name
@@ -1947,14 +2739,6 @@ module Aws::Athena
1947
2739
  # The database and data catalog context in which the query execution
1948
2740
  # occurs.
1949
2741
  #
1950
- # @note When making an API call, you may pass QueryExecutionContext
1951
- # data as a hash:
1952
- #
1953
- # {
1954
- # database: "DatabaseString",
1955
- # catalog: "CatalogNameString",
1956
- # }
1957
- #
1958
2742
  # @!attribute [rw] database
1959
2743
  # The name of the database used in the query execution. The database
1960
2744
  # must exist in the catalog.
@@ -2307,21 +3091,6 @@ module Aws::Athena
2307
3091
  # "client-side settings". If workgroup settings override client-side
2308
3092
  # settings, then the query uses the workgroup settings.
2309
3093
  #
2310
- # @note When making an API call, you may pass ResultConfiguration
2311
- # data as a hash:
2312
- #
2313
- # {
2314
- # output_location: "ResultOutputLocation",
2315
- # encryption_configuration: {
2316
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
2317
- # kms_key: "String",
2318
- # },
2319
- # expected_bucket_owner: "AwsAccountId",
2320
- # acl_configuration: {
2321
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
2322
- # },
2323
- # }
2324
- #
2325
3094
  # @!attribute [rw] output_location
2326
3095
  # The location in Amazon S3 where your query results are stored, such
2327
3096
  # as `s3://path/to/query/bucket/`. To run the query, you must specify
@@ -2405,25 +3174,6 @@ module Aws::Athena
2405
3174
  # The information about the updates in the query results, such as output
2406
3175
  # location and encryption configuration for the query results.
2407
3176
  #
2408
- # @note When making an API call, you may pass ResultConfigurationUpdates
2409
- # data as a hash:
2410
- #
2411
- # {
2412
- # output_location: "ResultOutputLocation",
2413
- # remove_output_location: false,
2414
- # encryption_configuration: {
2415
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
2416
- # kms_key: "String",
2417
- # },
2418
- # remove_encryption_configuration: false,
2419
- # expected_bucket_owner: "AwsAccountId",
2420
- # remove_expected_bucket_owner: false,
2421
- # acl_configuration: {
2422
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
2423
- # },
2424
- # remove_acl_configuration: false,
2425
- # }
2426
- #
2427
3177
  # @!attribute [rw] output_location
2428
3178
  # The location in Amazon S3 where your query results are stored, such
2429
3179
  # as `s3://path/to/query/bucket/`. For more information, see [Query
@@ -2547,14 +3297,6 @@ module Aws::Athena
2547
3297
  # Specifies whether previous query results are reused, and if so, their
2548
3298
  # maximum age.
2549
3299
  #
2550
- # @note When making an API call, you may pass ResultReuseByAgeConfiguration
2551
- # data as a hash:
2552
- #
2553
- # {
2554
- # enabled: false, # required
2555
- # max_age_in_minutes: 1,
2556
- # }
2557
- #
2558
3300
  # @!attribute [rw] enabled
2559
3301
  # True if previous query results can be reused when the query is run;
2560
3302
  # otherwise, false. The default is false.
@@ -2574,130 +3316,318 @@ module Aws::Athena
2574
3316
  include Aws::Structure
2575
3317
  end
2576
3318
 
2577
- # Specifies the query result reuse behavior for the query.
3319
+ # Specifies the query result reuse behavior for the query.
3320
+ #
3321
+ # @!attribute [rw] result_reuse_by_age_configuration
3322
+ # Specifies whether previous query results are reused, and if so,
3323
+ # their maximum age.
3324
+ # @return [Types::ResultReuseByAgeConfiguration]
3325
+ #
3326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultReuseConfiguration AWS API Documentation
3327
+ #
3328
+ class ResultReuseConfiguration < Struct.new(
3329
+ :result_reuse_by_age_configuration)
3330
+ SENSITIVE = []
3331
+ include Aws::Structure
3332
+ end
3333
+
3334
+ # Contains information about whether the result of a previous query was
3335
+ # reused.
3336
+ #
3337
+ # @!attribute [rw] reused_previous_result
3338
+ # True if a previous query result was reused; false if the result was
3339
+ # generated from a new run of the query.
3340
+ # @return [Boolean]
3341
+ #
3342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultReuseInformation AWS API Documentation
3343
+ #
3344
+ class ResultReuseInformation < Struct.new(
3345
+ :reused_previous_result)
3346
+ SENSITIVE = []
3347
+ include Aws::Structure
3348
+ end
3349
+
3350
+ # The metadata and rows that make up a query result set. The metadata
3351
+ # describes the column structure and data types. To return a `ResultSet`
3352
+ # object, use GetQueryResults.
3353
+ #
3354
+ # @!attribute [rw] rows
3355
+ # The rows in the table.
3356
+ # @return [Array<Types::Row>]
3357
+ #
3358
+ # @!attribute [rw] result_set_metadata
3359
+ # The metadata that describes the column structure and data types of a
3360
+ # table of query results.
3361
+ # @return [Types::ResultSetMetadata]
3362
+ #
3363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSet AWS API Documentation
3364
+ #
3365
+ class ResultSet < Struct.new(
3366
+ :rows,
3367
+ :result_set_metadata)
3368
+ SENSITIVE = []
3369
+ include Aws::Structure
3370
+ end
3371
+
3372
+ # The metadata that describes the column structure and data types of a
3373
+ # table of query results. To return a `ResultSetMetadata` object, use
3374
+ # GetQueryResults.
3375
+ #
3376
+ # @!attribute [rw] column_info
3377
+ # Information about the columns returned in a query result metadata.
3378
+ # @return [Array<Types::ColumnInfo>]
3379
+ #
3380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSetMetadata AWS API Documentation
3381
+ #
3382
+ class ResultSetMetadata < Struct.new(
3383
+ :column_info)
3384
+ SENSITIVE = []
3385
+ include Aws::Structure
3386
+ end
3387
+
3388
+ # The rows that make up a query result table.
3389
+ #
3390
+ # @!attribute [rw] data
3391
+ # The data that populates a row in a query result table.
3392
+ # @return [Array<Types::Datum>]
3393
+ #
3394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Row AWS API Documentation
3395
+ #
3396
+ class Row < Struct.new(
3397
+ :data)
3398
+ SENSITIVE = []
3399
+ include Aws::Structure
3400
+ end
3401
+
3402
+ # The specified session already exists.
3403
+ #
3404
+ # @!attribute [rw] message
3405
+ # @return [String]
3406
+ #
3407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionAlreadyExistsException AWS API Documentation
3408
+ #
3409
+ class SessionAlreadyExistsException < Struct.new(
3410
+ :message)
3411
+ SENSITIVE = []
3412
+ include Aws::Structure
3413
+ end
3414
+
3415
+ # Contains session configuration information.
3416
+ #
3417
+ # @!attribute [rw] execution_role
3418
+ # The ARN of the execution role used for the session.
3419
+ # @return [String]
3420
+ #
3421
+ # @!attribute [rw] working_directory
3422
+ # The Amazon S3 location that stores information for the notebook.
3423
+ # @return [String]
3424
+ #
3425
+ # @!attribute [rw] idle_timeout_seconds
3426
+ # The idle timeout in seconds for the session.
3427
+ # @return [Integer]
3428
+ #
3429
+ # @!attribute [rw] encryption_configuration
3430
+ # If query results are encrypted in Amazon S3, indicates the
3431
+ # encryption option used (for example, `SSE_KMS` or `CSE_KMS`) and key
3432
+ # information.
3433
+ # @return [Types::EncryptionConfiguration]
3434
+ #
3435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionConfiguration AWS API Documentation
3436
+ #
3437
+ class SessionConfiguration < Struct.new(
3438
+ :execution_role,
3439
+ :working_directory,
3440
+ :idle_timeout_seconds,
3441
+ :encryption_configuration)
3442
+ SENSITIVE = []
3443
+ include Aws::Structure
3444
+ end
3445
+
3446
+ # Contains statistics for a notebook session.
3447
+ #
3448
+ # @!attribute [rw] dpu_execution_in_millis
3449
+ # The data processing unit execution time for a session in
3450
+ # milliseconds.
3451
+ # @return [Integer]
3452
+ #
3453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionStatistics AWS API Documentation
3454
+ #
3455
+ class SessionStatistics < Struct.new(
3456
+ :dpu_execution_in_millis)
3457
+ SENSITIVE = []
3458
+ include Aws::Structure
3459
+ end
3460
+
3461
+ # Contains information about the status of a notebook session.
3462
+ #
3463
+ # @!attribute [rw] start_date_time
3464
+ # The date and time that the session started.
3465
+ # @return [Time]
3466
+ #
3467
+ # @!attribute [rw] last_modified_date_time
3468
+ # The most recent date and time that the session was modified.
3469
+ # @return [Time]
3470
+ #
3471
+ # @!attribute [rw] end_date_time
3472
+ # The date and time that the session ended.
3473
+ # @return [Time]
3474
+ #
3475
+ # @!attribute [rw] idle_since_date_time
3476
+ # The date and time starting at which the session became idle. Can be
3477
+ # empty if the session is not currently idle.
3478
+ # @return [Time]
3479
+ #
3480
+ # @!attribute [rw] state
3481
+ # The state of the session. A description of each state follows.
3482
+ #
3483
+ # `CREATING` - The session is being started, including acquiring
3484
+ # resources.
3485
+ #
3486
+ # `CREATED` - The session has been started.
3487
+ #
3488
+ # `IDLE` - The session is able to accept a calculation.
3489
+ #
3490
+ # `BUSY` - The session is processing another task and is unable to
3491
+ # accept a calculation.
3492
+ #
3493
+ # `TERMINATING` - The session is in the process of shutting down.
3494
+ #
3495
+ # `TERMINATED` - The session and its resources are no longer running.
3496
+ #
3497
+ # `DEGRADED` - The session has no healthy coordinators.
3498
+ #
3499
+ # `FAILED` - Due to a failure, the session and its resources are no
3500
+ # longer running.
3501
+ # @return [String]
3502
+ #
3503
+ # @!attribute [rw] state_change_reason
3504
+ # The reason for the session state change (for example, canceled
3505
+ # because the session was terminated).
3506
+ # @return [String]
3507
+ #
3508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionStatus AWS API Documentation
3509
+ #
3510
+ class SessionStatus < Struct.new(
3511
+ :start_date_time,
3512
+ :last_modified_date_time,
3513
+ :end_date_time,
3514
+ :idle_since_date_time,
3515
+ :state,
3516
+ :state_change_reason)
3517
+ SENSITIVE = []
3518
+ include Aws::Structure
3519
+ end
3520
+
3521
+ # Contains summary information about a notebook session.
2578
3522
  #
2579
- # @note When making an API call, you may pass ResultReuseConfiguration
2580
- # data as a hash:
3523
+ # @!attribute [rw] session_id
3524
+ # The session ID.
3525
+ # @return [String]
2581
3526
  #
2582
- # {
2583
- # result_reuse_by_age_configuration: {
2584
- # enabled: false, # required
2585
- # max_age_in_minutes: 1,
2586
- # },
2587
- # }
3527
+ # @!attribute [rw] description
3528
+ # The session description.
3529
+ # @return [String]
2588
3530
  #
2589
- # @!attribute [rw] result_reuse_by_age_configuration
2590
- # Specifies whether previous query results are reused, and if so,
2591
- # their maximum age.
2592
- # @return [Types::ResultReuseByAgeConfiguration]
3531
+ # @!attribute [rw] engine_version
3532
+ # The engine version used by the session (for example, `PySpark engine
3533
+ # version 3`).
3534
+ # @return [Types::EngineVersion]
2593
3535
  #
2594
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultReuseConfiguration AWS API Documentation
3536
+ # @!attribute [rw] notebook_version
3537
+ # The notebook version.
3538
+ # @return [String]
2595
3539
  #
2596
- class ResultReuseConfiguration < Struct.new(
2597
- :result_reuse_by_age_configuration)
3540
+ # @!attribute [rw] status
3541
+ # Contains information about the session status.
3542
+ # @return [Types::SessionStatus]
3543
+ #
3544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionSummary AWS API Documentation
3545
+ #
3546
+ class SessionSummary < Struct.new(
3547
+ :session_id,
3548
+ :description,
3549
+ :engine_version,
3550
+ :notebook_version,
3551
+ :status)
2598
3552
  SENSITIVE = []
2599
3553
  include Aws::Structure
2600
3554
  end
2601
3555
 
2602
- # Contains information about whether the result of a previous query was
2603
- # reused.
3556
+ # @!attribute [rw] session_id
3557
+ # The session ID.
3558
+ # @return [String]
2604
3559
  #
2605
- # @!attribute [rw] reused_previous_result
2606
- # True if a previous query result was reused; false if the result was
2607
- # generated from a new run of the query.
2608
- # @return [Boolean]
3560
+ # @!attribute [rw] description
3561
+ # A description of the calculation.
3562
+ # @return [String]
2609
3563
  #
2610
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultReuseInformation AWS API Documentation
3564
+ # @!attribute [rw] calculation_configuration
3565
+ # Contains configuration information for the calculation.
3566
+ # @return [Types::CalculationConfiguration]
2611
3567
  #
2612
- class ResultReuseInformation < Struct.new(
2613
- :reused_previous_result)
2614
- SENSITIVE = []
2615
- include Aws::Structure
2616
- end
2617
-
2618
- # The metadata and rows that make up a query result set. The metadata
2619
- # describes the column structure and data types. To return a `ResultSet`
2620
- # object, use GetQueryResults.
3568
+ # @!attribute [rw] code_block
3569
+ # A string that contains the code of the calculation.
3570
+ # @return [String]
2621
3571
  #
2622
- # @!attribute [rw] rows
2623
- # The rows in the table.
2624
- # @return [Array<Types::Row>]
3572
+ # @!attribute [rw] client_request_token
3573
+ # A unique case-sensitive string used to ensure the request to create
3574
+ # the calculation is idempotent (executes only once). If another
3575
+ # `StartCalculationExecutionRequest` is received, the same response is
3576
+ # returned and another calculation is not created. If a parameter has
3577
+ # changed, an error is returned.
2625
3578
  #
2626
- # @!attribute [rw] result_set_metadata
2627
- # The metadata that describes the column structure and data types of a
2628
- # table of query results.
2629
- # @return [Types::ResultSetMetadata]
3579
+ # This token is listed as not required because Amazon Web Services
3580
+ # SDKs (for example the Amazon Web Services SDK for Java)
3581
+ # auto-generate the token for users. If you are not using the Amazon
3582
+ # Web Services SDK or the Amazon Web Services CLI, you must provide
3583
+ # this token or the action will fail.
3584
+ # @return [String]
2630
3585
  #
2631
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSet AWS API Documentation
3586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartCalculationExecutionRequest AWS API Documentation
2632
3587
  #
2633
- class ResultSet < Struct.new(
2634
- :rows,
2635
- :result_set_metadata)
3588
+ class StartCalculationExecutionRequest < Struct.new(
3589
+ :session_id,
3590
+ :description,
3591
+ :calculation_configuration,
3592
+ :code_block,
3593
+ :client_request_token)
2636
3594
  SENSITIVE = []
2637
3595
  include Aws::Structure
2638
3596
  end
2639
3597
 
2640
- # The metadata that describes the column structure and data types of a
2641
- # table of query results. To return a `ResultSetMetadata` object, use
2642
- # GetQueryResults.
3598
+ # @!attribute [rw] calculation_execution_id
3599
+ # The calculation execution UUID.
3600
+ # @return [String]
2643
3601
  #
2644
- # @!attribute [rw] column_info
2645
- # Information about the columns returned in a query result metadata.
2646
- # @return [Array<Types::ColumnInfo>]
3602
+ # @!attribute [rw] state
3603
+ # `CREATING` - The calculation is in the process of being created.
2647
3604
  #
2648
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSetMetadata AWS API Documentation
3605
+ # `CREATED` - The calculation has been created and is ready to run.
2649
3606
  #
2650
- class ResultSetMetadata < Struct.new(
2651
- :column_info)
2652
- SENSITIVE = []
2653
- include Aws::Structure
2654
- end
2655
-
2656
- # The rows that make up a query result table.
3607
+ # `QUEUED` - The calculation has been queued for processing.
2657
3608
  #
2658
- # @!attribute [rw] data
2659
- # The data that populates a row in a query result table.
2660
- # @return [Array<Types::Datum>]
3609
+ # `RUNNING` - The calculation is running.
2661
3610
  #
2662
- # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Row AWS API Documentation
3611
+ # `CANCELING` - A request to cancel the calculation has been received
3612
+ # and the system is working to stop it.
2663
3613
  #
2664
- class Row < Struct.new(
2665
- :data)
3614
+ # `CANCELED` - The calculation is no longer running as the result of a
3615
+ # cancel request.
3616
+ #
3617
+ # `COMPLETED` - The calculation has completed without error.
3618
+ #
3619
+ # `FAILED` - The calculation failed and is no longer running.
3620
+ # @return [String]
3621
+ #
3622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartCalculationExecutionResponse AWS API Documentation
3623
+ #
3624
+ class StartCalculationExecutionResponse < Struct.new(
3625
+ :calculation_execution_id,
3626
+ :state)
2666
3627
  SENSITIVE = []
2667
3628
  include Aws::Structure
2668
3629
  end
2669
3630
 
2670
- # @note When making an API call, you may pass StartQueryExecutionInput
2671
- # data as a hash:
2672
- #
2673
- # {
2674
- # query_string: "QueryString", # required
2675
- # client_request_token: "IdempotencyToken",
2676
- # query_execution_context: {
2677
- # database: "DatabaseString",
2678
- # catalog: "CatalogNameString",
2679
- # },
2680
- # result_configuration: {
2681
- # output_location: "ResultOutputLocation",
2682
- # encryption_configuration: {
2683
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
2684
- # kms_key: "String",
2685
- # },
2686
- # expected_bucket_owner: "AwsAccountId",
2687
- # acl_configuration: {
2688
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
2689
- # },
2690
- # },
2691
- # work_group: "WorkGroupName",
2692
- # execution_parameters: ["ExecutionParameter"],
2693
- # result_reuse_configuration: {
2694
- # result_reuse_by_age_configuration: {
2695
- # enabled: false, # required
2696
- # max_age_in_minutes: 1,
2697
- # },
2698
- # },
2699
- # }
2700
- #
2701
3631
  # @!attribute [rw] query_string
2702
3632
  # The SQL query statements to be executed.
2703
3633
  # @return [String]
@@ -2773,13 +3703,132 @@ module Aws::Athena
2773
3703
  include Aws::Structure
2774
3704
  end
2775
3705
 
2776
- # @note When making an API call, you may pass StopQueryExecutionInput
2777
- # data as a hash:
3706
+ # @!attribute [rw] description
3707
+ # The session description.
3708
+ # @return [String]
3709
+ #
3710
+ # @!attribute [rw] work_group
3711
+ # The workgroup to which the session belongs.
3712
+ # @return [String]
3713
+ #
3714
+ # @!attribute [rw] engine_configuration
3715
+ # Contains engine data processing unit (DPU) configuration settings
3716
+ # and parameter mappings.
3717
+ # @return [Types::EngineConfiguration]
3718
+ #
3719
+ # @!attribute [rw] notebook_version
3720
+ # The notebook version. This value is required only when requesting
3721
+ # that a notebook server be started for the session. The only valid
3722
+ # notebook version is `Jupyter1.0`.
3723
+ # @return [String]
3724
+ #
3725
+ # @!attribute [rw] session_idle_timeout_in_minutes
3726
+ # The idle timeout in minutes for the session.
3727
+ # @return [Integer]
3728
+ #
3729
+ # @!attribute [rw] client_request_token
3730
+ # A unique case-sensitive string used to ensure the request to create
3731
+ # the session is idempotent (executes only once). If another
3732
+ # `StartSessionRequest` is received, the same response is returned and
3733
+ # another session is not created. If a parameter has changed, an error
3734
+ # is returned.
3735
+ #
3736
+ # This token is listed as not required because Amazon Web Services
3737
+ # SDKs (for example the Amazon Web Services SDK for Java)
3738
+ # auto-generate the token for users. If you are not using the Amazon
3739
+ # Web Services SDK or the Amazon Web Services CLI, you must provide
3740
+ # this token or the action will fail.
3741
+ # @return [String]
3742
+ #
3743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartSessionRequest AWS API Documentation
3744
+ #
3745
+ class StartSessionRequest < Struct.new(
3746
+ :description,
3747
+ :work_group,
3748
+ :engine_configuration,
3749
+ :notebook_version,
3750
+ :session_idle_timeout_in_minutes,
3751
+ :client_request_token)
3752
+ SENSITIVE = []
3753
+ include Aws::Structure
3754
+ end
3755
+
3756
+ # @!attribute [rw] session_id
3757
+ # The session ID.
3758
+ # @return [String]
3759
+ #
3760
+ # @!attribute [rw] state
3761
+ # The state of the session. A description of each state follows.
3762
+ #
3763
+ # `CREATING` - The session is being started, including acquiring
3764
+ # resources.
3765
+ #
3766
+ # `CREATED` - The session has been started.
3767
+ #
3768
+ # `IDLE` - The session is able to accept a calculation.
3769
+ #
3770
+ # `BUSY` - The session is processing another task and is unable to
3771
+ # accept a calculation.
3772
+ #
3773
+ # `TERMINATING` - The session is in the process of shutting down.
3774
+ #
3775
+ # `TERMINATED` - The session and its resources are no longer running.
3776
+ #
3777
+ # `DEGRADED` - The session has no healthy coordinators.
3778
+ #
3779
+ # `FAILED` - Due to a failure, the session and its resources are no
3780
+ # longer running.
3781
+ # @return [String]
3782
+ #
3783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartSessionResponse AWS API Documentation
3784
+ #
3785
+ class StartSessionResponse < Struct.new(
3786
+ :session_id,
3787
+ :state)
3788
+ SENSITIVE = []
3789
+ include Aws::Structure
3790
+ end
3791
+
3792
+ # @!attribute [rw] calculation_execution_id
3793
+ # The calculation execution UUID.
3794
+ # @return [String]
3795
+ #
3796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopCalculationExecutionRequest AWS API Documentation
3797
+ #
3798
+ class StopCalculationExecutionRequest < Struct.new(
3799
+ :calculation_execution_id)
3800
+ SENSITIVE = []
3801
+ include Aws::Structure
3802
+ end
3803
+
3804
+ # @!attribute [rw] state
3805
+ # `CREATING` - The calculation is in the process of being created.
3806
+ #
3807
+ # `CREATED` - The calculation has been created and is ready to run.
3808
+ #
3809
+ # `QUEUED` - The calculation has been queued for processing.
3810
+ #
3811
+ # `RUNNING` - The calculation is running.
3812
+ #
3813
+ # `CANCELING` - A request to cancel the calculation has been received
3814
+ # and the system is working to stop it.
3815
+ #
3816
+ # `CANCELED` - The calculation is no longer running as the result of a
3817
+ # cancel request.
3818
+ #
3819
+ # `COMPLETED` - The calculation has completed without error.
3820
+ #
3821
+ # `FAILED` - The calculation failed and is no longer running.
3822
+ # @return [String]
2778
3823
  #
2779
- # {
2780
- # query_execution_id: "QueryExecutionId", # required
2781
- # }
3824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopCalculationExecutionResponse AWS API Documentation
2782
3825
  #
3826
+ class StopCalculationExecutionResponse < Struct.new(
3827
+ :state)
3828
+ SENSITIVE = []
3829
+ include Aws::Structure
3830
+ end
3831
+
2783
3832
  # @!attribute [rw] query_execution_id
2784
3833
  # The unique ID of the query execution to stop.
2785
3834
  #
@@ -2860,14 +3909,6 @@ module Aws::Athena
2860
3909
  #
2861
3910
  # [1]: https://aws.amazon.com/answers/account-management/aws-tagging-strategies/
2862
3911
  #
2863
- # @note When making an API call, you may pass Tag
2864
- # data as a hash:
2865
- #
2866
- # {
2867
- # key: "TagKey",
2868
- # value: "TagValue",
2869
- # }
2870
- #
2871
3912
  # @!attribute [rw] key
2872
3913
  # A tag key. The tag key length is from 1 to 128 Unicode characters in
2873
3914
  # UTF-8. You can use letters and numbers representable in UTF-8, and
@@ -2891,19 +3932,6 @@ module Aws::Athena
2891
3932
  include Aws::Structure
2892
3933
  end
2893
3934
 
2894
- # @note When making an API call, you may pass TagResourceInput
2895
- # data as a hash:
2896
- #
2897
- # {
2898
- # resource_arn: "AmazonResourceName", # required
2899
- # tags: [ # required
2900
- # {
2901
- # key: "TagKey",
2902
- # value: "TagValue",
2903
- # },
2904
- # ],
2905
- # }
2906
- #
2907
3935
  # @!attribute [rw] resource_arn
2908
3936
  # Specifies the ARN of the Athena resource (workgroup or data catalog)
2909
3937
  # to which tags are to be added.
@@ -2927,6 +3955,49 @@ module Aws::Athena
2927
3955
  #
2928
3956
  class TagResourceOutput < Aws::EmptyStructure; end
2929
3957
 
3958
+ # @!attribute [rw] session_id
3959
+ # The session ID.
3960
+ # @return [String]
3961
+ #
3962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TerminateSessionRequest AWS API Documentation
3963
+ #
3964
+ class TerminateSessionRequest < Struct.new(
3965
+ :session_id)
3966
+ SENSITIVE = []
3967
+ include Aws::Structure
3968
+ end
3969
+
3970
+ # @!attribute [rw] state
3971
+ # The state of the session. A description of each state follows.
3972
+ #
3973
+ # `CREATING` - The session is being started, including acquiring
3974
+ # resources.
3975
+ #
3976
+ # `CREATED` - The session has been started.
3977
+ #
3978
+ # `IDLE` - The session is able to accept a calculation.
3979
+ #
3980
+ # `BUSY` - The session is processing another task and is unable to
3981
+ # accept a calculation.
3982
+ #
3983
+ # `TERMINATING` - The session is in the process of shutting down.
3984
+ #
3985
+ # `TERMINATED` - The session and its resources are no longer running.
3986
+ #
3987
+ # `DEGRADED` - The session has no healthy coordinators.
3988
+ #
3989
+ # `FAILED` - Due to a failure, the session and its resources are no
3990
+ # longer running.
3991
+ # @return [String]
3992
+ #
3993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TerminateSessionResponse AWS API Documentation
3994
+ #
3995
+ class TerminateSessionResponse < Struct.new(
3996
+ :state)
3997
+ SENSITIVE = []
3998
+ include Aws::Structure
3999
+ end
4000
+
2930
4001
  # Indicates that the request was throttled.
2931
4002
  #
2932
4003
  # @!attribute [rw] message
@@ -3034,14 +4105,6 @@ module Aws::Athena
3034
4105
  include Aws::Structure
3035
4106
  end
3036
4107
 
3037
- # @note When making an API call, you may pass UntagResourceInput
3038
- # data as a hash:
3039
- #
3040
- # {
3041
- # resource_arn: "AmazonResourceName", # required
3042
- # tag_keys: ["TagKey"], # required
3043
- # }
3044
- #
3045
4108
  # @!attribute [rw] resource_arn
3046
4109
  # Specifies the ARN of the resource from which tags are to be removed.
3047
4110
  # @return [String]
@@ -3064,18 +4127,6 @@ module Aws::Athena
3064
4127
  #
3065
4128
  class UntagResourceOutput < Aws::EmptyStructure; end
3066
4129
 
3067
- # @note When making an API call, you may pass UpdateDataCatalogInput
3068
- # data as a hash:
3069
- #
3070
- # {
3071
- # name: "CatalogNameString", # required
3072
- # type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE
3073
- # description: "DescriptionString",
3074
- # parameters: {
3075
- # "KeyString" => "ParametersMapValue",
3076
- # },
3077
- # }
3078
- #
3079
4130
  # @!attribute [rw] name
3080
4131
  # The name of the data catalog to update. The catalog name must be
3081
4132
  # unique for the Amazon Web Services account and can use a maximum of
@@ -3137,16 +4188,6 @@ module Aws::Athena
3137
4188
  #
3138
4189
  class UpdateDataCatalogOutput < Aws::EmptyStructure; end
3139
4190
 
3140
- # @note When making an API call, you may pass UpdateNamedQueryInput
3141
- # data as a hash:
3142
- #
3143
- # {
3144
- # named_query_id: "NamedQueryId", # required
3145
- # name: "NameString", # required
3146
- # description: "NamedQueryDescriptionString",
3147
- # query_string: "QueryString", # required
3148
- # }
3149
- #
3150
4191
  # @!attribute [rw] named_query_id
3151
4192
  # The unique identifier (UUID) of the query.
3152
4193
  # @return [String]
@@ -3178,16 +4219,83 @@ module Aws::Athena
3178
4219
  #
3179
4220
  class UpdateNamedQueryOutput < Aws::EmptyStructure; end
3180
4221
 
3181
- # @note When making an API call, you may pass UpdatePreparedStatementInput
3182
- # data as a hash:
4222
+ # @!attribute [rw] notebook_id
4223
+ # The ID of the notebook to update.
4224
+ # @return [String]
4225
+ #
4226
+ # @!attribute [rw] payload
4227
+ # The updated content for the notebook.
4228
+ # @return [String]
4229
+ #
4230
+ # @!attribute [rw] type
4231
+ # The notebook content type. Currently, the only valid type is
4232
+ # `IPYNB`.
4233
+ # @return [String]
4234
+ #
4235
+ # @!attribute [rw] session_id
4236
+ # The ID of the session in which the notebook will be updated.
4237
+ # @return [String]
4238
+ #
4239
+ # @!attribute [rw] client_request_token
4240
+ # A unique case-sensitive string used to ensure the request to create
4241
+ # the notebook is idempotent (executes only once).
4242
+ #
4243
+ # This token is listed as not required because Amazon Web Services
4244
+ # SDKs (for example the Amazon Web Services SDK for Java)
4245
+ # auto-generate the token for you. If you are not using the Amazon Web
4246
+ # Services SDK or the Amazon Web Services CLI, you must provide this
4247
+ # token or the action will fail.
4248
+ # @return [String]
4249
+ #
4250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookInput AWS API Documentation
4251
+ #
4252
+ class UpdateNotebookInput < Struct.new(
4253
+ :notebook_id,
4254
+ :payload,
4255
+ :type,
4256
+ :session_id,
4257
+ :client_request_token)
4258
+ SENSITIVE = []
4259
+ include Aws::Structure
4260
+ end
4261
+
4262
+ # @!attribute [rw] notebook_id
4263
+ # The ID of the notebook to update the metadata for.
4264
+ # @return [String]
4265
+ #
4266
+ # @!attribute [rw] client_request_token
4267
+ # A unique case-sensitive string used to ensure the request to create
4268
+ # the notebook is idempotent (executes only once).
4269
+ #
4270
+ # This token is listed as not required because Amazon Web Services
4271
+ # SDKs (for example the Amazon Web Services SDK for Java)
4272
+ # auto-generate the token for you. If you are not using the Amazon Web
4273
+ # Services SDK or the Amazon Web Services CLI, you must provide this
4274
+ # token or the action will fail.
4275
+ # @return [String]
4276
+ #
4277
+ # @!attribute [rw] name
4278
+ # The name to update the notebook to.
4279
+ # @return [String]
4280
+ #
4281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookMetadataInput AWS API Documentation
4282
+ #
4283
+ class UpdateNotebookMetadataInput < Struct.new(
4284
+ :notebook_id,
4285
+ :client_request_token,
4286
+ :name)
4287
+ SENSITIVE = []
4288
+ include Aws::Structure
4289
+ end
4290
+
4291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookMetadataOutput AWS API Documentation
3183
4292
  #
3184
- # {
3185
- # statement_name: "StatementName", # required
3186
- # work_group: "WorkGroupName", # required
3187
- # query_statement: "QueryString", # required
3188
- # description: "DescriptionString",
3189
- # }
4293
+ class UpdateNotebookMetadataOutput < Aws::EmptyStructure; end
4294
+
4295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookOutput AWS API Documentation
3190
4296
  #
4297
+ class UpdateNotebookOutput < Aws::EmptyStructure; end
4298
+
3191
4299
  # @!attribute [rw] statement_name
3192
4300
  # The name of the prepared statement.
3193
4301
  # @return [String]
@@ -3219,41 +4327,6 @@ module Aws::Athena
3219
4327
  #
3220
4328
  class UpdatePreparedStatementOutput < Aws::EmptyStructure; end
3221
4329
 
3222
- # @note When making an API call, you may pass UpdateWorkGroupInput
3223
- # data as a hash:
3224
- #
3225
- # {
3226
- # work_group: "WorkGroupName", # required
3227
- # description: "WorkGroupDescriptionString",
3228
- # configuration_updates: {
3229
- # enforce_work_group_configuration: false,
3230
- # result_configuration_updates: {
3231
- # output_location: "ResultOutputLocation",
3232
- # remove_output_location: false,
3233
- # encryption_configuration: {
3234
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
3235
- # kms_key: "String",
3236
- # },
3237
- # remove_encryption_configuration: false,
3238
- # expected_bucket_owner: "AwsAccountId",
3239
- # remove_expected_bucket_owner: false,
3240
- # acl_configuration: {
3241
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
3242
- # },
3243
- # remove_acl_configuration: false,
3244
- # },
3245
- # publish_cloud_watch_metrics_enabled: false,
3246
- # bytes_scanned_cutoff_per_query: 1,
3247
- # remove_bytes_scanned_cutoff_per_query: false,
3248
- # requester_pays_enabled: false,
3249
- # engine_version: {
3250
- # selected_engine_version: "NameString",
3251
- # effective_engine_version: "NameString",
3252
- # },
3253
- # },
3254
- # state: "ENABLED", # accepts ENABLED, DISABLED
3255
- # }
3256
- #
3257
4330
  # @!attribute [rw] work_group
3258
4331
  # The specified workgroup that will be updated.
3259
4332
  # @return [String]
@@ -3263,8 +4336,7 @@ module Aws::Athena
3263
4336
  # @return [String]
3264
4337
  #
3265
4338
  # @!attribute [rw] configuration_updates
3266
- # The workgroup configuration that will be updated for the given
3267
- # workgroup.
4339
+ # Contains configuration updates for an Athena SQL workgroup.
3268
4340
  # @return [Types::WorkGroupConfigurationUpdates]
3269
4341
  #
3270
4342
  # @!attribute [rw] state
@@ -3349,31 +4421,6 @@ module Aws::Athena
3349
4421
  # `WorkGroupConfiguration`. See
3350
4422
  # WorkGroupConfiguration$EnforceWorkGroupConfiguration.
3351
4423
  #
3352
- # @note When making an API call, you may pass WorkGroupConfiguration
3353
- # data as a hash:
3354
- #
3355
- # {
3356
- # result_configuration: {
3357
- # output_location: "ResultOutputLocation",
3358
- # encryption_configuration: {
3359
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
3360
- # kms_key: "String",
3361
- # },
3362
- # expected_bucket_owner: "AwsAccountId",
3363
- # acl_configuration: {
3364
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
3365
- # },
3366
- # },
3367
- # enforce_work_group_configuration: false,
3368
- # publish_cloud_watch_metrics_enabled: false,
3369
- # bytes_scanned_cutoff_per_query: 1,
3370
- # requester_pays_enabled: false,
3371
- # engine_version: {
3372
- # selected_engine_version: "NameString",
3373
- # effective_engine_version: "NameString",
3374
- # },
3375
- # }
3376
- #
3377
4424
  # @!attribute [rw] result_configuration
3378
4425
  # The configuration for the workgroup, which includes the location in
3379
4426
  # Amazon S3 where query results are stored and the encryption option,
@@ -3430,6 +4477,20 @@ module Aws::Athena
3430
4477
  # the preview engine regardless of this setting.
3431
4478
  # @return [Types::EngineVersion]
3432
4479
  #
4480
+ # @!attribute [rw] additional_configuration
4481
+ # Specifies a user defined JSON string that is passed to the notebook
4482
+ # engine.
4483
+ # @return [String]
4484
+ #
4485
+ # @!attribute [rw] execution_role
4486
+ # Role used in a notebook session for accessing the user's resources.
4487
+ # @return [String]
4488
+ #
4489
+ # @!attribute [rw] customer_content_encryption_configuration
4490
+ # Specifies the KMS key that is used to encrypt the user's data
4491
+ # stores in Athena.
4492
+ # @return [Types::CustomerContentEncryptionConfiguration]
4493
+ #
3433
4494
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfiguration AWS API Documentation
3434
4495
  #
3435
4496
  class WorkGroupConfiguration < Struct.new(
@@ -3438,7 +4499,10 @@ module Aws::Athena
3438
4499
  :publish_cloud_watch_metrics_enabled,
3439
4500
  :bytes_scanned_cutoff_per_query,
3440
4501
  :requester_pays_enabled,
3441
- :engine_version)
4502
+ :engine_version,
4503
+ :additional_configuration,
4504
+ :execution_role,
4505
+ :customer_content_encryption_configuration)
3442
4506
  SENSITIVE = []
3443
4507
  include Aws::Structure
3444
4508
  end
@@ -3451,36 +4515,6 @@ module Aws::Athena
3451
4515
  # usage limit for the amount of bytes scanned per query, if it is
3452
4516
  # specified.
3453
4517
  #
3454
- # @note When making an API call, you may pass WorkGroupConfigurationUpdates
3455
- # data as a hash:
3456
- #
3457
- # {
3458
- # enforce_work_group_configuration: false,
3459
- # result_configuration_updates: {
3460
- # output_location: "ResultOutputLocation",
3461
- # remove_output_location: false,
3462
- # encryption_configuration: {
3463
- # encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
3464
- # kms_key: "String",
3465
- # },
3466
- # remove_encryption_configuration: false,
3467
- # expected_bucket_owner: "AwsAccountId",
3468
- # remove_expected_bucket_owner: false,
3469
- # acl_configuration: {
3470
- # s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
3471
- # },
3472
- # remove_acl_configuration: false,
3473
- # },
3474
- # publish_cloud_watch_metrics_enabled: false,
3475
- # bytes_scanned_cutoff_per_query: 1,
3476
- # remove_bytes_scanned_cutoff_per_query: false,
3477
- # requester_pays_enabled: false,
3478
- # engine_version: {
3479
- # selected_engine_version: "NameString",
3480
- # effective_engine_version: "NameString",
3481
- # },
3482
- # }
3483
- #
3484
4518
  # @!attribute [rw] enforce_work_group_configuration
3485
4519
  # If set to "true", the settings for the workgroup override
3486
4520
  # client-side settings. If set to "false" client-side settings are
@@ -3535,6 +4569,24 @@ module Aws::Athena
3535
4569
  # the preview engine regardless of this setting.
3536
4570
  # @return [Types::EngineVersion]
3537
4571
  #
4572
+ # @!attribute [rw] remove_customer_content_encryption_configuration
4573
+ # Removes content encryption configuration for a workgroup.
4574
+ # @return [Boolean]
4575
+ #
4576
+ # @!attribute [rw] additional_configuration
4577
+ # Contains a user defined string in JSON format for a Spark-enabled
4578
+ # workgroup.
4579
+ # @return [String]
4580
+ #
4581
+ # @!attribute [rw] execution_role
4582
+ # Contains the ARN of the execution role for the workgroup
4583
+ # @return [String]
4584
+ #
4585
+ # @!attribute [rw] customer_content_encryption_configuration
4586
+ # Specifies the KMS key that is used to encrypt the user's data
4587
+ # stores in Athena.
4588
+ # @return [Types::CustomerContentEncryptionConfiguration]
4589
+ #
3538
4590
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfigurationUpdates AWS API Documentation
3539
4591
  #
3540
4592
  class WorkGroupConfigurationUpdates < Struct.new(
@@ -3544,7 +4596,11 @@ module Aws::Athena
3544
4596
  :bytes_scanned_cutoff_per_query,
3545
4597
  :remove_bytes_scanned_cutoff_per_query,
3546
4598
  :requester_pays_enabled,
3547
- :engine_version)
4599
+ :engine_version,
4600
+ :remove_customer_content_encryption_configuration,
4601
+ :additional_configuration,
4602
+ :execution_role,
4603
+ :customer_content_encryption_configuration)
3548
4604
  SENSITIVE = []
3549
4605
  include Aws::Structure
3550
4606
  end