aws-sdk-athena 1.62.0 → 1.64.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-athena/client.rb +41 -35
- data/lib/aws-sdk-athena/client_api.rb +2 -0
- data/lib/aws-sdk-athena/types.rb +132 -88
- data/lib/aws-sdk-athena.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ef4f565c264acbdf2e8231ff320670a5a809e877e71265e84529aee3060a3e24
|
4
|
+
data.tar.gz: 8fc2bc53535c4a9ea120231a3ec2deb2eeb82faa6842d98da3e6552c4d1e71e2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7e47325bfb2ddf6cc4a4f05adb381b19c9e25d1601fce6adc0b4748df3f9d856f3725f9aa3a6e6899ca070b15fb460a69f1a19be3702fd09666ee1c3ea6ce06f
|
7
|
+
data.tar.gz: 7b262a69c7faac4b11fa0847ac78928a4b6b8e127a065110834ab9d7bce6850e452cd293c2a9d80402850e940491afafde26bf46ae1b6bb5b7b7186463ee59f8
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.64.0 (2023-03-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Make DefaultExecutorDpuSize and CoordinatorDpuSize fields optional in StartSession
|
8
|
+
|
9
|
+
1.63.0 (2023-03-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.
|
13
|
+
|
4
14
|
1.62.0 (2023-03-08)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.64.0
|
@@ -794,6 +794,12 @@ module Aws::Athena
|
|
794
794
|
# Gets an authentication token and the URL at which the notebook can be
|
795
795
|
# accessed. During programmatic access, `CreatePresignedNotebookUrl`
|
796
796
|
# must be called every 10 minutes to refresh the authentication token.
|
797
|
+
# For information about granting programmatic access, see [Grant
|
798
|
+
# programmatic access][1].
|
799
|
+
#
|
800
|
+
#
|
801
|
+
#
|
802
|
+
# [1]: https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access
|
797
803
|
#
|
798
804
|
# @option params [required, String] :session_id
|
799
805
|
# The session ID.
|
@@ -825,24 +831,22 @@ module Aws::Athena
|
|
825
831
|
req.send_request(options)
|
826
832
|
end
|
827
833
|
|
828
|
-
# Creates a workgroup with the specified name.
|
829
|
-
#
|
830
|
-
# for a workgroup with multi engine support (for example, an Apache
|
831
|
-
# Spark enabled workgroup) or `Configuration` for an Athena SQL
|
832
|
-
# workgroup.
|
834
|
+
# Creates a workgroup with the specified name. A workgroup can be an
|
835
|
+
# Apache Spark enabled workgroup or an Athena SQL workgroup.
|
833
836
|
#
|
834
837
|
# @option params [required, String] :name
|
835
838
|
# The workgroup name.
|
836
839
|
#
|
837
840
|
# @option params [Types::WorkGroupConfiguration] :configuration
|
838
841
|
# Contains configuration information for creating an Athena SQL
|
839
|
-
# workgroup
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
842
|
+
# workgroup or Spark enabled Athena workgroup. Athena SQL workgroup
|
843
|
+
# configuration includes the location in Amazon S3 where query and
|
844
|
+
# calculation results are stored, the encryption configuration, if any,
|
845
|
+
# used for encrypting query results, whether the Amazon CloudWatch
|
846
|
+
# Metrics are enabled for the workgroup, the limit for the amount of
|
847
|
+
# bytes scanned (cutoff) per query, if it is specified, and whether
|
848
|
+
# workgroup's settings (specified with `EnforceWorkGroupConfiguration`)
|
849
|
+
# in the `WorkGroupConfiguration` override client-side settings. See
|
846
850
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
847
851
|
#
|
848
852
|
# @option params [String] :description
|
@@ -883,6 +887,7 @@ module Aws::Athena
|
|
883
887
|
# customer_content_encryption_configuration: {
|
884
888
|
# kms_key: "KmsKey", # required
|
885
889
|
# },
|
890
|
+
# enable_minimum_encryption_configuration: false,
|
886
891
|
# },
|
887
892
|
# description: "WorkGroupDescriptionString",
|
888
893
|
# tags: [
|
@@ -1014,7 +1019,7 @@ module Aws::Athena
|
|
1014
1019
|
#
|
1015
1020
|
# @option params [Boolean] :recursive_delete_option
|
1016
1021
|
# The option to delete the workgroup and its contents even if the
|
1017
|
-
# workgroup contains any named queries
|
1022
|
+
# workgroup contains any named queries, query executions, or notebooks.
|
1018
1023
|
#
|
1019
1024
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1020
1025
|
#
|
@@ -1116,8 +1121,7 @@ module Aws::Athena
|
|
1116
1121
|
req.send_request(options)
|
1117
1122
|
end
|
1118
1123
|
|
1119
|
-
# Retrieves
|
1120
|
-
# the calculation.
|
1124
|
+
# Retrieves the unencrypted code that was executed for the calculation.
|
1121
1125
|
#
|
1122
1126
|
# @option params [required, String] :calculation_execution_id
|
1123
1127
|
# The calculation execution UUID.
|
@@ -1416,9 +1420,10 @@ module Aws::Athena
|
|
1416
1420
|
|
1417
1421
|
# Streams the results of a single query execution specified by
|
1418
1422
|
# `QueryExecutionId` from the Athena query results location in Amazon
|
1419
|
-
# S3. For more information, see [
|
1420
|
-
#
|
1421
|
-
#
|
1423
|
+
# S3. For more information, see [Working with query results, recent
|
1424
|
+
# queries, and output files][1] in the *Amazon Athena User Guide*. This
|
1425
|
+
# request does not execute the query but returns results. Use
|
1426
|
+
# StartQueryExecution to run a query.
|
1422
1427
|
#
|
1423
1428
|
# To stream query results successfully, the IAM principal with
|
1424
1429
|
# permission to call `GetQueryResults` also must have permissions to the
|
@@ -1723,6 +1728,7 @@ module Aws::Athena
|
|
1723
1728
|
# resp.work_group.configuration.additional_configuration #=> String
|
1724
1729
|
# resp.work_group.configuration.execution_role #=> String
|
1725
1730
|
# resp.work_group.configuration.customer_content_encryption_configuration.kms_key #=> String
|
1731
|
+
# resp.work_group.configuration.enable_minimum_encryption_configuration #=> Boolean
|
1726
1732
|
# resp.work_group.description #=> String
|
1727
1733
|
# resp.work_group.creation_time #=> Time
|
1728
1734
|
#
|
@@ -1790,7 +1796,7 @@ module Aws::Athena
|
|
1790
1796
|
end
|
1791
1797
|
|
1792
1798
|
# Returns the supported DPU sizes for the supported application runtimes
|
1793
|
-
# (for example, `
|
1799
|
+
# (for example, `Athena notebook version 1`).
|
1794
1800
|
#
|
1795
1801
|
# @option params [Integer] :max_results
|
1796
1802
|
# Specifies the maximum number of results to return.
|
@@ -2039,9 +2045,9 @@ module Aws::Athena
|
|
2039
2045
|
req.send_request(options)
|
2040
2046
|
end
|
2041
2047
|
|
2042
|
-
# Lists, in descending order, the executors that
|
2043
|
-
#
|
2044
|
-
#
|
2048
|
+
# Lists, in descending order, the executors that joined a session. Newer
|
2049
|
+
# executors are listed first; older executors are listed later. The
|
2050
|
+
# result can be optionally filtered by state.
|
2045
2051
|
#
|
2046
2052
|
# @option params [required, String] :session_id
|
2047
2053
|
# The session ID.
|
@@ -2606,8 +2612,7 @@ module Aws::Athena
|
|
2606
2612
|
end
|
2607
2613
|
|
2608
2614
|
# Submits calculations for execution within a session. You can supply
|
2609
|
-
# the code to run as an inline code block within the request
|
2610
|
-
# Amazon S3 URL.
|
2615
|
+
# the code to run as an inline code block within the request.
|
2611
2616
|
#
|
2612
2617
|
# @option params [required, String] :session_id
|
2613
2618
|
# The session ID.
|
@@ -2779,9 +2784,12 @@ module Aws::Athena
|
|
2779
2784
|
# parameter mappings.
|
2780
2785
|
#
|
2781
2786
|
# @option params [String] :notebook_version
|
2782
|
-
# The notebook version. This value is
|
2783
|
-
#
|
2784
|
-
# version is
|
2787
|
+
# The notebook version. This value is supplied automatically for
|
2788
|
+
# notebook sessions in the Athena console and is not required for
|
2789
|
+
# programmatic session access. The only valid notebook version is
|
2790
|
+
# `Athena notebook version 1`. If you specify a value for
|
2791
|
+
# `NotebookVersion`, you must also specify a value for `NotebookId`. See
|
2792
|
+
# EngineConfiguration$AdditionalConfigs.
|
2785
2793
|
#
|
2786
2794
|
# @option params [Integer] :session_idle_timeout_in_minutes
|
2787
2795
|
# The idle timeout in minutes for the session.
|
@@ -2924,7 +2932,7 @@ module Aws::Athena
|
|
2924
2932
|
#
|
2925
2933
|
#
|
2926
2934
|
#
|
2927
|
-
# [1]: https://aws.amazon.com/
|
2935
|
+
# [1]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html
|
2928
2936
|
#
|
2929
2937
|
# @option params [required, String] :resource_arn
|
2930
2938
|
# Specifies the ARN of the Athena resource (workgroup or data catalog)
|
@@ -3129,7 +3137,8 @@ module Aws::Athena
|
|
3129
3137
|
# The notebook content type. Currently, the only valid type is `IPYNB`.
|
3130
3138
|
#
|
3131
3139
|
# @option params [String] :session_id
|
3132
|
-
# The
|
3140
|
+
# The active notebook session ID. Required if the notebook has an active
|
3141
|
+
# session.
|
3133
3142
|
#
|
3134
3143
|
# @option params [String] :client_request_token
|
3135
3144
|
# A unique case-sensitive string used to ensure the request to create
|
@@ -3234,11 +3243,7 @@ module Aws::Athena
|
|
3234
3243
|
end
|
3235
3244
|
|
3236
3245
|
# Updates the workgroup with the specified name. The workgroup's name
|
3237
|
-
# cannot be changed. Only
|
3238
|
-
# `ConfigurationUpdates` can be specified; `ConfigurationsUpdates` for a
|
3239
|
-
# workgroup with multi engine support (for example, an Apache Spark
|
3240
|
-
# enabled workgroup) or `ConfigurationUpdates` for an Athena SQL
|
3241
|
-
# workgroup.
|
3246
|
+
# cannot be changed. Only `ConfigurationUpdates` can be specified.
|
3242
3247
|
#
|
3243
3248
|
# @option params [required, String] :work_group
|
3244
3249
|
# The specified workgroup that will be updated.
|
@@ -3290,6 +3295,7 @@ module Aws::Athena
|
|
3290
3295
|
# customer_content_encryption_configuration: {
|
3291
3296
|
# kms_key: "KmsKey", # required
|
3292
3297
|
# },
|
3298
|
+
# enable_minimum_encryption_configuration: false,
|
3293
3299
|
# },
|
3294
3300
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3295
3301
|
# })
|
@@ -3316,7 +3322,7 @@ module Aws::Athena
|
|
3316
3322
|
params: params,
|
3317
3323
|
config: config)
|
3318
3324
|
context[:gem_name] = 'aws-sdk-athena'
|
3319
|
-
context[:gem_version] = '1.
|
3325
|
+
context[:gem_version] = '1.64.0'
|
3320
3326
|
Seahorse::Client::Request.new(handlers, context)
|
3321
3327
|
end
|
3322
3328
|
|
@@ -1184,6 +1184,7 @@ module Aws::Athena
|
|
1184
1184
|
WorkGroupConfiguration.add_member(:additional_configuration, Shapes::ShapeRef.new(shape: NameString, location_name: "AdditionalConfiguration"))
|
1185
1185
|
WorkGroupConfiguration.add_member(:execution_role, Shapes::ShapeRef.new(shape: RoleArn, location_name: "ExecutionRole"))
|
1186
1186
|
WorkGroupConfiguration.add_member(:customer_content_encryption_configuration, Shapes::ShapeRef.new(shape: CustomerContentEncryptionConfiguration, location_name: "CustomerContentEncryptionConfiguration"))
|
1187
|
+
WorkGroupConfiguration.add_member(:enable_minimum_encryption_configuration, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "EnableMinimumEncryptionConfiguration"))
|
1187
1188
|
WorkGroupConfiguration.struct_class = Types::WorkGroupConfiguration
|
1188
1189
|
|
1189
1190
|
WorkGroupConfigurationUpdates.add_member(:enforce_work_group_configuration, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "EnforceWorkGroupConfiguration"))
|
@@ -1197,6 +1198,7 @@ module Aws::Athena
|
|
1197
1198
|
WorkGroupConfigurationUpdates.add_member(:additional_configuration, Shapes::ShapeRef.new(shape: NameString, location_name: "AdditionalConfiguration"))
|
1198
1199
|
WorkGroupConfigurationUpdates.add_member(:execution_role, Shapes::ShapeRef.new(shape: RoleArn, location_name: "ExecutionRole"))
|
1199
1200
|
WorkGroupConfigurationUpdates.add_member(:customer_content_encryption_configuration, Shapes::ShapeRef.new(shape: CustomerContentEncryptionConfiguration, location_name: "CustomerContentEncryptionConfiguration"))
|
1201
|
+
WorkGroupConfigurationUpdates.add_member(:enable_minimum_encryption_configuration, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "EnableMinimumEncryptionConfiguration"))
|
1200
1202
|
WorkGroupConfigurationUpdates.struct_class = Types::WorkGroupConfigurationUpdates
|
1201
1203
|
|
1202
1204
|
WorkGroupSummary.add_member(:name, Shapes::ShapeRef.new(shape: WorkGroupName, location_name: "Name"))
|
data/lib/aws-sdk-athena/types.rb
CHANGED
@@ -45,8 +45,8 @@ module Aws::Athena
|
|
45
45
|
# Contains the application runtime IDs and their supported DPU sizes.
|
46
46
|
#
|
47
47
|
# @!attribute [rw] application_runtime_id
|
48
|
-
# The name of the supported application runtime (for example, `
|
49
|
-
# 1
|
48
|
+
# The name of the supported application runtime (for example, `Athena
|
49
|
+
# notebook version 1`).
|
50
50
|
# @return [String]
|
51
51
|
#
|
52
52
|
# @!attribute [rw] supported_dpu_sizes
|
@@ -690,13 +690,15 @@ module Aws::Athena
|
|
690
690
|
#
|
691
691
|
# @!attribute [rw] configuration
|
692
692
|
# Contains configuration information for creating an Athena SQL
|
693
|
-
# workgroup
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
693
|
+
# workgroup or Spark enabled Athena workgroup. Athena SQL workgroup
|
694
|
+
# configuration includes the location in Amazon S3 where query and
|
695
|
+
# calculation results are stored, the encryption configuration, if
|
696
|
+
# any, used for encrypting query results, whether the Amazon
|
697
|
+
# CloudWatch Metrics are enabled for the workgroup, the limit for the
|
698
|
+
# amount of bytes scanned (cutoff) per query, if it is specified, and
|
699
|
+
# whether workgroup's settings (specified with
|
700
|
+
# `EnforceWorkGroupConfiguration`) in the `WorkGroupConfiguration`
|
701
|
+
# override client-side settings. See
|
700
702
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
701
703
|
# @return [Types::WorkGroupConfiguration]
|
702
704
|
#
|
@@ -957,7 +959,8 @@ module Aws::Athena
|
|
957
959
|
#
|
958
960
|
# @!attribute [rw] recursive_delete_option
|
959
961
|
# The option to delete the workgroup and its contents even if the
|
960
|
-
# workgroup contains any named queries
|
962
|
+
# workgroup contains any named queries, query executions, or
|
963
|
+
# notebooks.
|
961
964
|
# @return [Boolean]
|
962
965
|
#
|
963
966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroupInput AWS API Documentation
|
@@ -973,8 +976,9 @@ module Aws::Athena
|
|
973
976
|
#
|
974
977
|
class DeleteWorkGroupOutput < Aws::EmptyStructure; end
|
975
978
|
|
976
|
-
# If query results are encrypted in Amazon S3, indicates
|
977
|
-
# option used (for example, `SSE_KMS` or `CSE_KMS`) and
|
979
|
+
# If query and calculation results are encrypted in Amazon S3, indicates
|
980
|
+
# the encryption option used (for example, `SSE_KMS` or `CSE_KMS`) and
|
981
|
+
# key information.
|
978
982
|
#
|
979
983
|
# @!attribute [rw] encryption_option
|
980
984
|
# Indicates whether Amazon S3 server-side encryption with Amazon
|
@@ -1022,11 +1026,11 @@ module Aws::Athena
|
|
1022
1026
|
#
|
1023
1027
|
# @!attribute [rw] additional_configs
|
1024
1028
|
# Contains additional notebook engine `MAP<string, string>` parameter
|
1025
|
-
# mappings in the form of key-value pairs. To specify an
|
1026
|
-
# that the Jupyter server will download and serve, specify a
|
1027
|
-
# the StartSessionRequest$NotebookVersion field, and then
|
1028
|
-
# named `
|
1029
|
-
#
|
1029
|
+
# mappings in the form of key-value pairs. To specify an Athena
|
1030
|
+
# notebook that the Jupyter server will download and serve, specify a
|
1031
|
+
# value for the StartSessionRequest$NotebookVersion field, and then
|
1032
|
+
# add a key named `NotebookId` to `AdditionalConfigs` that has the
|
1033
|
+
# value of the Athena notebook ID.
|
1030
1034
|
# @return [Hash<String,String>]
|
1031
1035
|
#
|
1032
1036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/EngineConfiguration AWS API Documentation
|
@@ -1181,7 +1185,7 @@ module Aws::Athena
|
|
1181
1185
|
end
|
1182
1186
|
|
1183
1187
|
# @!attribute [rw] code_block
|
1184
|
-
#
|
1188
|
+
# The unencrypted code that was executed for the calculation.
|
1185
1189
|
# @return [String]
|
1186
1190
|
#
|
1187
1191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionCodeResponse AWS API Documentation
|
@@ -1703,7 +1707,7 @@ module Aws::Athena
|
|
1703
1707
|
end
|
1704
1708
|
|
1705
1709
|
# @!attribute [rw] notebook_id
|
1706
|
-
# The ID
|
1710
|
+
# The ID assigned to the imported notebook.
|
1707
1711
|
# @return [String]
|
1708
1712
|
#
|
1709
1713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ImportNotebookOutput AWS API Documentation
|
@@ -2681,12 +2685,12 @@ module Aws::Athena
|
|
2681
2685
|
# @return [String]
|
2682
2686
|
#
|
2683
2687
|
# @!attribute [rw] result_configuration
|
2684
|
-
# The location in Amazon S3 where query
|
2685
|
-
# encryption option, if any, used for query results.
|
2686
|
-
# as "client-side settings". If workgroup settings
|
2687
|
-
# client-side settings, then the query uses the location for
|
2688
|
-
# results and the encryption configuration that are
|
2689
|
-
# workgroup.
|
2688
|
+
# The location in Amazon S3 where query and calculation results are
|
2689
|
+
# stored and the encryption option, if any, used for query results.
|
2690
|
+
# These are known as "client-side settings". If workgroup settings
|
2691
|
+
# override client-side settings, then the query uses the location for
|
2692
|
+
# the query results and the encryption configuration that are
|
2693
|
+
# specified for the workgroup.
|
2690
2694
|
# @return [Types::ResultConfiguration]
|
2691
2695
|
#
|
2692
2696
|
# @!attribute [rw] result_reuse_configuration
|
@@ -3096,19 +3100,21 @@ module Aws::Athena
|
|
3096
3100
|
include Aws::Structure
|
3097
3101
|
end
|
3098
3102
|
|
3099
|
-
# The location in Amazon S3 where query results are
|
3100
|
-
# encryption option, if any, used for query
|
3101
|
-
# "client-side settings". If
|
3102
|
-
# settings, then the query uses
|
3103
|
+
# The location in Amazon S3 where query and calculation results are
|
3104
|
+
# stored and the encryption option, if any, used for query and
|
3105
|
+
# calculation results. These are known as "client-side settings". If
|
3106
|
+
# workgroup settings override client-side settings, then the query uses
|
3107
|
+
# the workgroup settings.
|
3103
3108
|
#
|
3104
3109
|
# @!attribute [rw] output_location
|
3105
|
-
# The location in Amazon S3 where your query
|
3106
|
-
# as `s3://path/to/query/bucket/`. To run the query,
|
3107
|
-
# the query results location using one of the ways:
|
3108
|
-
# individual queries using either this setting
|
3109
|
-
# the workgroup, using WorkGroupConfiguration. If
|
3110
|
-
# Athena issues an error that no output location
|
3111
|
-
# information, see [
|
3110
|
+
# The location in Amazon S3 where your query and calculation results
|
3111
|
+
# are stored, such as `s3://path/to/query/bucket/`. To run the query,
|
3112
|
+
# you must specify the query results location using one of the ways:
|
3113
|
+
# either for individual queries using either this setting
|
3114
|
+
# (client-side), or in the workgroup, using WorkGroupConfiguration. If
|
3115
|
+
# none of them is set, Athena issues an error that no output location
|
3116
|
+
# is provided. For more information, see [Working with query results,
|
3117
|
+
# recent queries, and output files][1]. If workgroup settings override
|
3112
3118
|
# client-side settings, then the query uses the settings specified for
|
3113
3119
|
# the workgroup. See
|
3114
3120
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
@@ -3119,12 +3125,13 @@ module Aws::Athena
|
|
3119
3125
|
# @return [String]
|
3120
3126
|
#
|
3121
3127
|
# @!attribute [rw] encryption_configuration
|
3122
|
-
# If query results are encrypted in Amazon S3,
|
3123
|
-
# encryption option used (for example, `SSE_KMS` or
|
3124
|
-
# information. This is a client-side setting. If
|
3125
|
-
# override client-side settings, then the query
|
3126
|
-
# configuration that is specified for the
|
3127
|
-
# location for storing query results
|
3128
|
+
# If query and calculation results are encrypted in Amazon S3,
|
3129
|
+
# indicates the encryption option used (for example, `SSE_KMS` or
|
3130
|
+
# `CSE_KMS`) and key information. This is a client-side setting. If
|
3131
|
+
# workgroup settings override client-side settings, then the query
|
3132
|
+
# uses the encryption configuration that is specified for the
|
3133
|
+
# workgroup, and also uses the location for storing query results
|
3134
|
+
# specified in the workgroup. See
|
3128
3135
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration and [Workgroup
|
3129
3136
|
# Settings Override Client-Side Settings][1].
|
3130
3137
|
#
|
@@ -3185,12 +3192,13 @@ module Aws::Athena
|
|
3185
3192
|
# location and encryption configuration for the query results.
|
3186
3193
|
#
|
3187
3194
|
# @!attribute [rw] output_location
|
3188
|
-
# The location in Amazon S3 where your query
|
3189
|
-
# as `s3://path/to/query/bucket/`. For more
|
3190
|
-
#
|
3191
|
-
#
|
3192
|
-
#
|
3193
|
-
#
|
3195
|
+
# The location in Amazon S3 where your query and calculation results
|
3196
|
+
# are stored, such as `s3://path/to/query/bucket/`. For more
|
3197
|
+
# information, see [Working with query results, recent queries, and
|
3198
|
+
# output files][1]. If workgroup settings override client-side
|
3199
|
+
# settings, then the query uses the location for the query results and
|
3200
|
+
# the encryption configuration that are specified for the workgroup.
|
3201
|
+
# The "workgroup settings override" is specified in
|
3194
3202
|
# `EnforceWorkGroupConfiguration` (true/false) in the
|
3195
3203
|
# `WorkGroupConfiguration`. See
|
3196
3204
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
@@ -3216,7 +3224,7 @@ module Aws::Athena
|
|
3216
3224
|
# @return [Boolean]
|
3217
3225
|
#
|
3218
3226
|
# @!attribute [rw] encryption_configuration
|
3219
|
-
# The encryption configuration for
|
3227
|
+
# The encryption configuration for query and calculation results.
|
3220
3228
|
# @return [Types::EncryptionConfiguration]
|
3221
3229
|
#
|
3222
3230
|
# @!attribute [rw] remove_encryption_configuration
|
@@ -3437,9 +3445,9 @@ module Aws::Athena
|
|
3437
3445
|
# @return [Integer]
|
3438
3446
|
#
|
3439
3447
|
# @!attribute [rw] encryption_configuration
|
3440
|
-
# If query results are encrypted in Amazon S3,
|
3441
|
-
# encryption option used (for example, `SSE_KMS` or
|
3442
|
-
# information.
|
3448
|
+
# If query and calculation results are encrypted in Amazon S3,
|
3449
|
+
# indicates the encryption option used (for example, `SSE_KMS` or
|
3450
|
+
# `CSE_KMS`) and key information.
|
3443
3451
|
# @return [Types::EncryptionConfiguration]
|
3444
3452
|
#
|
3445
3453
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/SessionConfiguration AWS API Documentation
|
@@ -3453,7 +3461,7 @@ module Aws::Athena
|
|
3453
3461
|
include Aws::Structure
|
3454
3462
|
end
|
3455
3463
|
|
3456
|
-
# Contains statistics for a
|
3464
|
+
# Contains statistics for a session.
|
3457
3465
|
#
|
3458
3466
|
# @!attribute [rw] dpu_execution_in_millis
|
3459
3467
|
# The data processing unit execution time for a session in
|
@@ -3468,7 +3476,7 @@ module Aws::Athena
|
|
3468
3476
|
include Aws::Structure
|
3469
3477
|
end
|
3470
3478
|
|
3471
|
-
# Contains information about the status of a
|
3479
|
+
# Contains information about the status of a session.
|
3472
3480
|
#
|
3473
3481
|
# @!attribute [rw] start_date_time
|
3474
3482
|
# The date and time that the session started.
|
@@ -3528,7 +3536,7 @@ module Aws::Athena
|
|
3528
3536
|
include Aws::Structure
|
3529
3537
|
end
|
3530
3538
|
|
3531
|
-
# Contains summary information about a
|
3539
|
+
# Contains summary information about a session.
|
3532
3540
|
#
|
3533
3541
|
# @!attribute [rw] session_id
|
3534
3542
|
# The session ID.
|
@@ -3727,9 +3735,12 @@ module Aws::Athena
|
|
3727
3735
|
# @return [Types::EngineConfiguration]
|
3728
3736
|
#
|
3729
3737
|
# @!attribute [rw] notebook_version
|
3730
|
-
# The notebook version. This value is
|
3731
|
-
#
|
3732
|
-
# notebook version is
|
3738
|
+
# The notebook version. This value is supplied automatically for
|
3739
|
+
# notebook sessions in the Athena console and is not required for
|
3740
|
+
# programmatic session access. The only valid notebook version is
|
3741
|
+
# `Athena notebook version 1`. If you specify a value for
|
3742
|
+
# `NotebookVersion`, you must also specify a value for `NotebookId`.
|
3743
|
+
# See EngineConfiguration$AdditionalConfigs.
|
3733
3744
|
# @return [String]
|
3734
3745
|
#
|
3735
3746
|
# @!attribute [rw] session_idle_timeout_in_minutes
|
@@ -3917,7 +3928,7 @@ module Aws::Athena
|
|
3917
3928
|
#
|
3918
3929
|
#
|
3919
3930
|
#
|
3920
|
-
# [1]: https://aws.amazon.com/
|
3931
|
+
# [1]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html
|
3921
3932
|
#
|
3922
3933
|
# @!attribute [rw] key
|
3923
3934
|
# A tag key. The tag key length is from 1 to 128 Unicode characters in
|
@@ -4243,7 +4254,8 @@ module Aws::Athena
|
|
4243
4254
|
# @return [String]
|
4244
4255
|
#
|
4245
4256
|
# @!attribute [rw] session_id
|
4246
|
-
# The
|
4257
|
+
# The active notebook session ID. Required if the notebook has an
|
4258
|
+
# active session.
|
4247
4259
|
# @return [String]
|
4248
4260
|
#
|
4249
4261
|
# @!attribute [rw] client_request_token
|
@@ -4390,12 +4402,12 @@ module Aws::Athena
|
|
4390
4402
|
#
|
4391
4403
|
# @!attribute [rw] configuration
|
4392
4404
|
# The configuration of the workgroup, which includes the location in
|
4393
|
-
# Amazon S3 where query results are stored, the
|
4394
|
-
# configuration, if any, used for query
|
4395
|
-
# CloudWatch Metrics are enabled for the
|
4396
|
-
# settings override client-side settings;
|
4397
|
-
# for the amount of data scanned per query
|
4398
|
-
# workgroup settings override is specified in
|
4405
|
+
# Amazon S3 where query and calculation results are stored, the
|
4406
|
+
# encryption configuration, if any, used for query and calculation
|
4407
|
+
# results; whether the Amazon CloudWatch Metrics are enabled for the
|
4408
|
+
# workgroup; whether workgroup settings override client-side settings;
|
4409
|
+
# and the data usage limits for the amount of data scanned per query
|
4410
|
+
# or per workgroup. The workgroup settings override is specified in
|
4399
4411
|
# `EnforceWorkGroupConfiguration` (true/false) in the
|
4400
4412
|
# `WorkGroupConfiguration`. See
|
4401
4413
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
@@ -4422,24 +4434,27 @@ module Aws::Athena
|
|
4422
4434
|
end
|
4423
4435
|
|
4424
4436
|
# The configuration of the workgroup, which includes the location in
|
4425
|
-
# Amazon S3 where query results are stored, the
|
4426
|
-
# any, used for query results,
|
4427
|
-
#
|
4428
|
-
#
|
4429
|
-
#
|
4430
|
-
#
|
4437
|
+
# Amazon S3 where query and calculation results are stored, the
|
4438
|
+
# encryption option, if any, used for query and calculation results,
|
4439
|
+
# whether the Amazon CloudWatch Metrics are enabled for the workgroup
|
4440
|
+
# and whether workgroup settings override query settings, and the data
|
4441
|
+
# usage limits for the amount of data scanned per query or per
|
4442
|
+
# workgroup. The workgroup settings override is specified in
|
4443
|
+
# `EnforceWorkGroupConfiguration` (true/false) in the
|
4431
4444
|
# `WorkGroupConfiguration`. See
|
4432
4445
|
# WorkGroupConfiguration$EnforceWorkGroupConfiguration.
|
4433
4446
|
#
|
4434
4447
|
# @!attribute [rw] result_configuration
|
4435
4448
|
# The configuration for the workgroup, which includes the location in
|
4436
|
-
# Amazon S3 where query results are stored and the
|
4437
|
-
# if any, used for query results.
|
4438
|
-
# the query
|
4439
|
-
# workgroup using this setting, or for
|
4440
|
-
# (client-side), using
|
4441
|
-
# them is set, Athena
|
4442
|
-
#
|
4449
|
+
# Amazon S3 where query and calculation results are stored and the
|
4450
|
+
# encryption option, if any, used for query and calculation results.
|
4451
|
+
# To run the query, you must specify the query results location using
|
4452
|
+
# one of the ways: either in the workgroup using this setting, or for
|
4453
|
+
# individual queries (client-side), using
|
4454
|
+
# ResultConfiguration$OutputLocation. If none of them is set, Athena
|
4455
|
+
# issues an error that no output location is provided. For more
|
4456
|
+
# information, see [Working with query results, recent queries, and
|
4457
|
+
# output files][1].
|
4443
4458
|
#
|
4444
4459
|
#
|
4445
4460
|
#
|
@@ -4493,7 +4508,7 @@ module Aws::Athena
|
|
4493
4508
|
# @return [String]
|
4494
4509
|
#
|
4495
4510
|
# @!attribute [rw] execution_role
|
4496
|
-
# Role used in a
|
4511
|
+
# Role used in a session for accessing the user's resources.
|
4497
4512
|
# @return [String]
|
4498
4513
|
#
|
4499
4514
|
# @!attribute [rw] customer_content_encryption_configuration
|
@@ -4501,6 +4516,19 @@ module Aws::Athena
|
|
4501
4516
|
# stores in Athena.
|
4502
4517
|
# @return [Types::CustomerContentEncryptionConfiguration]
|
4503
4518
|
#
|
4519
|
+
# @!attribute [rw] enable_minimum_encryption_configuration
|
4520
|
+
# Enforces a minimal level of encryption for the workgroup for query
|
4521
|
+
# and calculation results that are written to Amazon S3. When enabled,
|
4522
|
+
# workgroup users can set encryption only to the minimum level set by
|
4523
|
+
# the administrator or higher when they submit queries.
|
4524
|
+
#
|
4525
|
+
# The `EnforceWorkGroupConfiguration` setting takes precedence over
|
4526
|
+
# the `EnableMinimumEncryptionConfiguration` flag. This means that if
|
4527
|
+
# `EnforceWorkGroupConfiguration` is true, the
|
4528
|
+
# `EnableMinimumEncryptionConfiguration` flag is ignored, and the
|
4529
|
+
# workgroup configuration for encryption is used.
|
4530
|
+
# @return [Boolean]
|
4531
|
+
#
|
4504
4532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfiguration AWS API Documentation
|
4505
4533
|
#
|
4506
4534
|
class WorkGroupConfiguration < Struct.new(
|
@@ -4512,18 +4540,19 @@ module Aws::Athena
|
|
4512
4540
|
:engine_version,
|
4513
4541
|
:additional_configuration,
|
4514
4542
|
:execution_role,
|
4515
|
-
:customer_content_encryption_configuration
|
4543
|
+
:customer_content_encryption_configuration,
|
4544
|
+
:enable_minimum_encryption_configuration)
|
4516
4545
|
SENSITIVE = []
|
4517
4546
|
include Aws::Structure
|
4518
4547
|
end
|
4519
4548
|
|
4520
4549
|
# The configuration information that will be updated for this workgroup,
|
4521
|
-
# which includes the location in Amazon S3 where query
|
4522
|
-
# stored, the encryption option, if any, used for query
|
4523
|
-
# the Amazon CloudWatch Metrics are enabled for the
|
4524
|
-
# the workgroup settings override the client-side
|
4525
|
-
# usage limit for the amount of bytes scanned per
|
4526
|
-
# specified.
|
4550
|
+
# which includes the location in Amazon S3 where query and calculation
|
4551
|
+
# results are stored, the encryption option, if any, used for query
|
4552
|
+
# results, whether the Amazon CloudWatch Metrics are enabled for the
|
4553
|
+
# workgroup, whether the workgroup settings override the client-side
|
4554
|
+
# settings, and the data usage limit for the amount of bytes scanned per
|
4555
|
+
# query, if it is specified.
|
4527
4556
|
#
|
4528
4557
|
# @!attribute [rw] enforce_work_group_configuration
|
4529
4558
|
# If set to "true", the settings for the workgroup override
|
@@ -4597,6 +4626,20 @@ module Aws::Athena
|
|
4597
4626
|
# stores in Athena.
|
4598
4627
|
# @return [Types::CustomerContentEncryptionConfiguration]
|
4599
4628
|
#
|
4629
|
+
# @!attribute [rw] enable_minimum_encryption_configuration
|
4630
|
+
# Enforces a minimal level of encryption for the workgroup for query
|
4631
|
+
# and calculation results that are written to Amazon S3. When enabled,
|
4632
|
+
# workgroup users can set encryption only to the minimum level set by
|
4633
|
+
# the administrator or higher when they submit queries. This setting
|
4634
|
+
# does not apply to Spark-enabled workgroups.
|
4635
|
+
#
|
4636
|
+
# The `EnforceWorkGroupConfiguration` setting takes precedence over
|
4637
|
+
# the `EnableMinimumEncryptionConfiguration` flag. This means that if
|
4638
|
+
# `EnforceWorkGroupConfiguration` is true, the
|
4639
|
+
# `EnableMinimumEncryptionConfiguration` flag is ignored, and the
|
4640
|
+
# workgroup configuration for encryption is used.
|
4641
|
+
# @return [Boolean]
|
4642
|
+
#
|
4600
4643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfigurationUpdates AWS API Documentation
|
4601
4644
|
#
|
4602
4645
|
class WorkGroupConfigurationUpdates < Struct.new(
|
@@ -4610,7 +4653,8 @@ module Aws::Athena
|
|
4610
4653
|
:remove_customer_content_encryption_configuration,
|
4611
4654
|
:additional_configuration,
|
4612
4655
|
:execution_role,
|
4613
|
-
:customer_content_encryption_configuration
|
4656
|
+
:customer_content_encryption_configuration,
|
4657
|
+
:enable_minimum_encryption_configuration)
|
4614
4658
|
SENSITIVE = []
|
4615
4659
|
include Aws::Structure
|
4616
4660
|
end
|
data/lib/aws-sdk-athena.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-athena
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.64.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-03-
|
11
|
+
date: 2023-03-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|