aws-sdk-athena 1.74.0 → 1.83.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.
@@ -541,7 +541,7 @@ module Aws::Athena
541
541
  # @return [Integer]
542
542
  #
543
543
  # @!attribute [rw] nullable
544
- # Indicates the column's nullable status.
544
+ # Unsupported constraint. This value always shows as `UNKNOWN`.
545
545
  # @return [String]
546
546
  #
547
547
  # @!attribute [rw] case_sensitive
@@ -646,12 +646,7 @@ module Aws::Athena
646
646
  # `AwsDataCatalog` that already exists in your account, of which
647
647
  # you can have only one and cannot modify.
648
648
  #
649
- # * Queries that specify a Glue Data Catalog other than the default
650
- # `AwsDataCatalog` must be run on Athena engine version 2.
651
- #
652
- # * In Regions where Athena engine version 2 is not available,
653
- # creating new Glue data catalogs results in an `INVALID_INPUT`
654
- # error.
649
+ # ^
655
650
  # @return [Hash<String,String>]
656
651
  #
657
652
  # @!attribute [rw] tags
@@ -888,12 +883,14 @@ module Aws::Athena
888
883
  #
889
884
  class CreateWorkGroupOutput < Aws::EmptyStructure; end
890
885
 
891
- # Specifies the KMS key that is used to encrypt the user's data stores
892
- # in Athena. This setting does not apply to Athena SQL workgroups.
886
+ # Specifies the customer managed KMS key that is used to encrypt the
887
+ # user's data stores in Athena. When an Amazon Web Services managed key
888
+ # is used, this value is null. This setting does not apply to Athena SQL
889
+ # workgroups.
893
890
  #
894
891
  # @!attribute [rw] kms_key
895
- # The KMS key that is used to encrypt the user's data stores in
896
- # Athena.
892
+ # The customer managed KMS key that is used to encrypt the user's
893
+ # data stores in Athena.
897
894
  # @return [String]
898
895
  #
899
896
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CustomerContentEncryptionConfiguration AWS API Documentation
@@ -966,8 +963,7 @@ module Aws::Athena
966
963
  # `AwsDataCatalog` that already exists in your account, of which
967
964
  # you can have only one and cannot modify.
968
965
  #
969
- # * Queries that specify a Glue Data Catalog other than the default
970
- # `AwsDataCatalog` must be run on Athena engine version 2.
966
+ # ^
971
967
  # @return [Hash<String,String>]
972
968
  #
973
969
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DataCatalog AWS API Documentation
@@ -1520,10 +1516,16 @@ module Aws::Athena
1520
1516
  # The name of the data catalog to return.
1521
1517
  # @return [String]
1522
1518
  #
1519
+ # @!attribute [rw] work_group
1520
+ # The name of the workgroup. Required if making an IAM Identity Center
1521
+ # request.
1522
+ # @return [String]
1523
+ #
1523
1524
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalogInput AWS API Documentation
1524
1525
  #
1525
1526
  class GetDataCatalogInput < Struct.new(
1526
- :name)
1527
+ :name,
1528
+ :work_group)
1527
1529
  SENSITIVE = []
1528
1530
  include Aws::Structure
1529
1531
  end
@@ -1548,11 +1550,18 @@ module Aws::Athena
1548
1550
  # The name of the database to return.
1549
1551
  # @return [String]
1550
1552
  #
1553
+ # @!attribute [rw] work_group
1554
+ # The name of the workgroup for which the metadata is being fetched.
1555
+ # Required if requesting an IAM Identity Center enabled Glue Data
1556
+ # Catalog.
1557
+ # @return [String]
1558
+ #
1551
1559
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabaseInput AWS API Documentation
1552
1560
  #
1553
1561
  class GetDatabaseInput < Struct.new(
1554
1562
  :catalog_name,
1555
- :database_name)
1563
+ :database_name,
1564
+ :work_group)
1556
1565
  SENSITIVE = []
1557
1566
  include Aws::Structure
1558
1567
  end
@@ -1854,12 +1863,19 @@ module Aws::Athena
1854
1863
  # The name of the table for which metadata is returned.
1855
1864
  # @return [String]
1856
1865
  #
1866
+ # @!attribute [rw] work_group
1867
+ # The name of the workgroup for which the metadata is being fetched.
1868
+ # Required if requesting an IAM Identity Center enabled Glue Data
1869
+ # Catalog.
1870
+ # @return [String]
1871
+ #
1857
1872
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetTableMetadataInput AWS API Documentation
1858
1873
  #
1859
1874
  class GetTableMetadataInput < Struct.new(
1860
1875
  :catalog_name,
1861
1876
  :database_name,
1862
- :table_name)
1877
+ :table_name,
1878
+ :work_group)
1863
1879
  SENSITIVE = []
1864
1880
  include Aws::Structure
1865
1881
  end
@@ -1900,6 +1916,26 @@ module Aws::Athena
1900
1916
  include Aws::Structure
1901
1917
  end
1902
1918
 
1919
+ # Specifies whether the workgroup is IAM Identity Center supported.
1920
+ #
1921
+ # @!attribute [rw] enable_identity_center
1922
+ # Specifies whether the workgroup is IAM Identity Center supported.
1923
+ # @return [Boolean]
1924
+ #
1925
+ # @!attribute [rw] identity_center_instance_arn
1926
+ # The IAM Identity Center instance ARN that the workgroup associates
1927
+ # to.
1928
+ # @return [String]
1929
+ #
1930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/IdentityCenterConfiguration AWS API Documentation
1931
+ #
1932
+ class IdentityCenterConfiguration < Struct.new(
1933
+ :enable_identity_center,
1934
+ :identity_center_instance_arn)
1935
+ SENSITIVE = []
1936
+ include Aws::Structure
1937
+ end
1938
+
1903
1939
  # @!attribute [rw] work_group
1904
1940
  # The name of the Spark enabled workgroup to import the notebook to.
1905
1941
  # @return [String]
@@ -1909,7 +1945,8 @@ module Aws::Athena
1909
1945
  # @return [String]
1910
1946
  #
1911
1947
  # @!attribute [rw] payload
1912
- # The notebook content to be imported.
1948
+ # The notebook content to be imported. The payload must be in `ipynb`
1949
+ # format.
1913
1950
  # @return [String]
1914
1951
  #
1915
1952
  # @!attribute [rw] type
@@ -1917,6 +1954,11 @@ module Aws::Athena
1917
1954
  # `IPYNB`.
1918
1955
  # @return [String]
1919
1956
  #
1957
+ # @!attribute [rw] notebook_s3_location_uri
1958
+ # A URI that specifies the Amazon S3 location of a notebook file in
1959
+ # `ipynb` format.
1960
+ # @return [String]
1961
+ #
1920
1962
  # @!attribute [rw] client_request_token
1921
1963
  # A unique case-sensitive string used to ensure the request to import
1922
1964
  # the notebook is idempotent (executes only once).
@@ -1935,6 +1977,7 @@ module Aws::Athena
1935
1977
  :name,
1936
1978
  :payload,
1937
1979
  :type,
1980
+ :notebook_s3_location_uri,
1938
1981
  :client_request_token)
1939
1982
  SENSITIVE = []
1940
1983
  include Aws::Structure
@@ -2143,11 +2186,17 @@ module Aws::Athena
2143
2186
  # Specifies the maximum number of data catalogs to return.
2144
2187
  # @return [Integer]
2145
2188
  #
2189
+ # @!attribute [rw] work_group
2190
+ # The name of the workgroup. Required if making an IAM Identity Center
2191
+ # request.
2192
+ # @return [String]
2193
+ #
2146
2194
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDataCatalogsInput AWS API Documentation
2147
2195
  #
2148
2196
  class ListDataCatalogsInput < Struct.new(
2149
2197
  :next_token,
2150
- :max_results)
2198
+ :max_results,
2199
+ :work_group)
2151
2200
  SENSITIVE = []
2152
2201
  include Aws::Structure
2153
2202
  end
@@ -2187,12 +2236,19 @@ module Aws::Athena
2187
2236
  # Specifies the maximum number of results to return.
2188
2237
  # @return [Integer]
2189
2238
  #
2239
+ # @!attribute [rw] work_group
2240
+ # The name of the workgroup for which the metadata is being fetched.
2241
+ # Required if requesting an IAM Identity Center enabled Glue Data
2242
+ # Catalog.
2243
+ # @return [String]
2244
+ #
2190
2245
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDatabasesInput AWS API Documentation
2191
2246
  #
2192
2247
  class ListDatabasesInput < Struct.new(
2193
2248
  :catalog_name,
2194
2249
  :next_token,
2195
- :max_results)
2250
+ :max_results,
2251
+ :work_group)
2196
2252
  SENSITIVE = []
2197
2253
  include Aws::Structure
2198
2254
  end
@@ -2652,6 +2708,12 @@ module Aws::Athena
2652
2708
  # Specifies the maximum number of results to return.
2653
2709
  # @return [Integer]
2654
2710
  #
2711
+ # @!attribute [rw] work_group
2712
+ # The name of the workgroup for which the metadata is being fetched.
2713
+ # Required if requesting an IAM Identity Center enabled Glue Data
2714
+ # Catalog.
2715
+ # @return [String]
2716
+ #
2655
2717
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadataInput AWS API Documentation
2656
2718
  #
2657
2719
  class ListTableMetadataInput < Struct.new(
@@ -2659,7 +2721,8 @@ module Aws::Athena
2659
2721
  :database_name,
2660
2722
  :expression,
2661
2723
  :next_token,
2662
- :max_results)
2724
+ :max_results,
2725
+ :work_group)
2663
2726
  SENSITIVE = []
2664
2727
  include Aws::Structure
2665
2728
  end
@@ -3026,6 +3089,11 @@ module Aws::Athena
3026
3089
  # The kind of query statement that was run.
3027
3090
  # @return [String]
3028
3091
  #
3092
+ # @!attribute [rw] query_results_s3_access_grants_configuration
3093
+ # Specifies whether Amazon S3 access grants are enabled for query
3094
+ # results.
3095
+ # @return [Types::QueryResultsS3AccessGrantsConfiguration]
3096
+ #
3029
3097
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecution AWS API Documentation
3030
3098
  #
3031
3099
  class QueryExecution < Struct.new(
@@ -3040,7 +3108,8 @@ module Aws::Athena
3040
3108
  :work_group,
3041
3109
  :engine_version,
3042
3110
  :execution_parameters,
3043
- :substatement_type)
3111
+ :substatement_type,
3112
+ :query_results_s3_access_grants_configuration)
3044
3113
  SENSITIVE = []
3045
3114
  include Aws::Structure
3046
3115
  end
@@ -3103,6 +3172,11 @@ module Aws::Athena
3103
3172
  # might automatically add the query back to the queue.
3104
3173
  # @return [Integer]
3105
3174
  #
3175
+ # @!attribute [rw] service_pre_processing_time_in_millis
3176
+ # The number of milliseconds that Athena took to preprocess the query
3177
+ # before submitting the query to the query engine.
3178
+ # @return [Integer]
3179
+ #
3106
3180
  # @!attribute [rw] query_planning_time_in_millis
3107
3181
  # The number of milliseconds that Athena took to plan the query
3108
3182
  # processing flow. This includes the time spent retrieving table
@@ -3129,6 +3203,7 @@ module Aws::Athena
3129
3203
  :data_manifest_location,
3130
3204
  :total_execution_time_in_millis,
3131
3205
  :query_queue_time_in_millis,
3206
+ :service_pre_processing_time_in_millis,
3132
3207
  :query_planning_time_in_millis,
3133
3208
  :service_processing_time_in_millis,
3134
3209
  :result_reuse_information)
@@ -3183,6 +3258,34 @@ module Aws::Athena
3183
3258
  include Aws::Structure
3184
3259
  end
3185
3260
 
3261
+ # Specifies whether Amazon S3 access grants are enabled for query
3262
+ # results.
3263
+ #
3264
+ # @!attribute [rw] enable_s3_access_grants
3265
+ # Specifies whether Amazon S3 access grants are enabled for query
3266
+ # results.
3267
+ # @return [Boolean]
3268
+ #
3269
+ # @!attribute [rw] create_user_level_prefix
3270
+ # When enabled, appends the user ID as an Amazon S3 path prefix to the
3271
+ # query result output location.
3272
+ # @return [Boolean]
3273
+ #
3274
+ # @!attribute [rw] authentication_type
3275
+ # The authentication type used for Amazon S3 access grants. Currently,
3276
+ # only `DIRECTORY_IDENTITY` is supported.
3277
+ # @return [String]
3278
+ #
3279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryResultsS3AccessGrantsConfiguration AWS API Documentation
3280
+ #
3281
+ class QueryResultsS3AccessGrantsConfiguration < Struct.new(
3282
+ :enable_s3_access_grants,
3283
+ :create_user_level_prefix,
3284
+ :authentication_type)
3285
+ SENSITIVE = []
3286
+ include Aws::Structure
3287
+ end
3288
+
3186
3289
  # The query execution timeline, statistics on input and output rows and
3187
3290
  # bytes, and the different query stages that form the query execution
3188
3291
  # plan.
@@ -3254,6 +3357,11 @@ module Aws::Athena
3254
3357
  # might automatically add the query back to the queue.
3255
3358
  # @return [Integer]
3256
3359
  #
3360
+ # @!attribute [rw] service_pre_processing_time_in_millis
3361
+ # The number of milliseconds that Athena spends on preprocessing
3362
+ # before it submits the query to the engine.
3363
+ # @return [Integer]
3364
+ #
3257
3365
  # @!attribute [rw] query_planning_time_in_millis
3258
3366
  # The number of milliseconds that Athena took to plan the query
3259
3367
  # processing flow. This includes the time spent retrieving table
@@ -3279,6 +3387,7 @@ module Aws::Athena
3279
3387
  #
3280
3388
  class QueryRuntimeStatisticsTimeline < Struct.new(
3281
3389
  :query_queue_time_in_millis,
3390
+ :service_pre_processing_time_in_millis,
3282
3391
  :query_planning_time_in_millis,
3283
3392
  :engine_execution_time_in_millis,
3284
3393
  :service_processing_time_in_millis,
@@ -3728,7 +3837,10 @@ module Aws::Athena
3728
3837
  # Contains session configuration information.
3729
3838
  #
3730
3839
  # @!attribute [rw] execution_role
3731
- # The ARN of the execution role used for the session.
3840
+ # The ARN of the execution role used to access user resources for
3841
+ # Spark sessions and Identity Center enabled workgroups. This property
3842
+ # applies only to Spark enabled workgroups and Identity Center enabled
3843
+ # workgroups.
3732
3844
  # @return [String]
3733
3845
  #
3734
3846
  # @!attribute [rw] working_directory
@@ -3879,7 +3991,9 @@ module Aws::Athena
3879
3991
  # @return [Types::CalculationConfiguration]
3880
3992
  #
3881
3993
  # @!attribute [rw] code_block
3882
- # A string that contains the code of the calculation.
3994
+ # A string that contains the code of the calculation. Use this
3995
+ # parameter instead of CalculationConfiguration$CodeBlock, which is
3996
+ # deprecated.
3883
3997
  # @return [String]
3884
3998
  #
3885
3999
  # @!attribute [rw] client_request_token
@@ -3949,8 +4063,11 @@ module Aws::Athena
3949
4063
  # A unique case-sensitive string used to ensure the request to create
3950
4064
  # the query is idempotent (executes only once). If another
3951
4065
  # `StartQueryExecution` request is received, the same response is
3952
- # returned and another query is not created. If a parameter has
3953
- # changed, for example, the `QueryString`, an error is returned.
4066
+ # returned and another query is not created. An error is returned if a
4067
+ # parameter, such as `QueryString`, has changed. A call to
4068
+ # `StartQueryExecution` that uses a previous client request token
4069
+ # returns the same `QueryExecutionId` even if the requester doesn't
4070
+ # have permission on the tables specified in `QueryString`.
3954
4071
  #
3955
4072
  # This token is listed as not required because Amazon Web Services
3956
4073
  # SDKs (for example the Amazon Web Services SDK for Java)
@@ -4737,6 +4854,11 @@ module Aws::Athena
4737
4854
  # The date and time the workgroup was created.
4738
4855
  # @return [Time]
4739
4856
  #
4857
+ # @!attribute [rw] identity_center_application_arn
4858
+ # The ARN of the IAM Identity Center enabled application associated
4859
+ # with the workgroup.
4860
+ # @return [String]
4861
+ #
4740
4862
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroup AWS API Documentation
4741
4863
  #
4742
4864
  class WorkGroup < Struct.new(
@@ -4744,7 +4866,8 @@ module Aws::Athena
4744
4866
  :state,
4745
4867
  :configuration,
4746
4868
  :description,
4747
- :creation_time)
4869
+ :creation_time,
4870
+ :identity_center_application_arn)
4748
4871
  SENSITIVE = []
4749
4872
  include Aws::Structure
4750
4873
  end
@@ -4824,7 +4947,11 @@ module Aws::Athena
4824
4947
  # @return [String]
4825
4948
  #
4826
4949
  # @!attribute [rw] execution_role
4827
- # Role used in a session for accessing the user's resources.
4950
+ # The ARN of the execution role used to access user resources for
4951
+ # Spark sessions and IAM Identity Center enabled workgroups. This
4952
+ # property applies only to Spark enabled workgroups and IAM Identity
4953
+ # Center enabled workgroups. The property is required for IAM Identity
4954
+ # Center enabled workgroups.
4828
4955
  # @return [String]
4829
4956
  #
4830
4957
  # @!attribute [rw] customer_content_encryption_configuration
@@ -4846,6 +4973,15 @@ module Aws::Athena
4846
4973
  # workgroup configuration for encryption is used.
4847
4974
  # @return [Boolean]
4848
4975
  #
4976
+ # @!attribute [rw] identity_center_configuration
4977
+ # Specifies whether the workgroup is IAM Identity Center supported.
4978
+ # @return [Types::IdentityCenterConfiguration]
4979
+ #
4980
+ # @!attribute [rw] query_results_s3_access_grants_configuration
4981
+ # Specifies whether Amazon S3 access grants are enabled for query
4982
+ # results.
4983
+ # @return [Types::QueryResultsS3AccessGrantsConfiguration]
4984
+ #
4849
4985
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfiguration AWS API Documentation
4850
4986
  #
4851
4987
  class WorkGroupConfiguration < Struct.new(
@@ -4858,7 +4994,9 @@ module Aws::Athena
4858
4994
  :additional_configuration,
4859
4995
  :execution_role,
4860
4996
  :customer_content_encryption_configuration,
4861
- :enable_minimum_encryption_configuration)
4997
+ :enable_minimum_encryption_configuration,
4998
+ :identity_center_configuration,
4999
+ :query_results_s3_access_grants_configuration)
4862
5000
  SENSITIVE = []
4863
5001
  include Aws::Structure
4864
5002
  end
@@ -4936,13 +5074,17 @@ module Aws::Athena
4936
5074
  # @return [String]
4937
5075
  #
4938
5076
  # @!attribute [rw] execution_role
4939
- # Contains the ARN of the execution role for the workgroup
5077
+ # The ARN of the execution role used to access user resources for
5078
+ # Spark sessions and Identity Center enabled workgroups. This property
5079
+ # applies only to Spark enabled workgroups and Identity Center enabled
5080
+ # workgroups.
4940
5081
  # @return [String]
4941
5082
  #
4942
5083
  # @!attribute [rw] customer_content_encryption_configuration
4943
- # Specifies the KMS key that is used to encrypt the user's data
4944
- # stores in Athena. This setting does not apply to Athena SQL
4945
- # workgroups.
5084
+ # Specifies the customer managed KMS key that is used to encrypt the
5085
+ # user's data stores in Athena. When an Amazon Web Services managed
5086
+ # key is used, this value is null. This setting does not apply to
5087
+ # Athena SQL workgroups.
4946
5088
  # @return [Types::CustomerContentEncryptionConfiguration]
4947
5089
  #
4948
5090
  # @!attribute [rw] enable_minimum_encryption_configuration
@@ -4959,6 +5101,11 @@ module Aws::Athena
4959
5101
  # workgroup configuration for encryption is used.
4960
5102
  # @return [Boolean]
4961
5103
  #
5104
+ # @!attribute [rw] query_results_s3_access_grants_configuration
5105
+ # Specifies whether Amazon S3 access grants are enabled for query
5106
+ # results.
5107
+ # @return [Types::QueryResultsS3AccessGrantsConfiguration]
5108
+ #
4962
5109
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupConfigurationUpdates AWS API Documentation
4963
5110
  #
4964
5111
  class WorkGroupConfigurationUpdates < Struct.new(
@@ -4973,7 +5120,8 @@ module Aws::Athena
4973
5120
  :additional_configuration,
4974
5121
  :execution_role,
4975
5122
  :customer_content_encryption_configuration,
4976
- :enable_minimum_encryption_configuration)
5123
+ :enable_minimum_encryption_configuration,
5124
+ :query_results_s3_access_grants_configuration)
4977
5125
  SENSITIVE = []
4978
5126
  include Aws::Structure
4979
5127
  end
@@ -5003,6 +5151,11 @@ module Aws::Athena
5003
5151
  # preview engine regardless of this setting.
5004
5152
  # @return [Types::EngineVersion]
5005
5153
  #
5154
+ # @!attribute [rw] identity_center_application_arn
5155
+ # The ARN of the IAM Identity Center enabled application associated
5156
+ # with the workgroup.
5157
+ # @return [String]
5158
+ #
5006
5159
  # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/WorkGroupSummary AWS API Documentation
5007
5160
  #
5008
5161
  class WorkGroupSummary < Struct.new(
@@ -5010,7 +5163,8 @@ module Aws::Athena
5010
5163
  :state,
5011
5164
  :description,
5012
5165
  :creation_time,
5013
- :engine_version)
5166
+ :engine_version,
5167
+ :identity_center_application_arn)
5014
5168
  SENSITIVE = []
5015
5169
  include Aws::Structure
5016
5170
  end
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-athena/customizations'
52
52
  # @!group service
53
53
  module Aws::Athena
54
54
 
55
- GEM_VERSION = '1.74.0'
55
+ GEM_VERSION = '1.83.0'
56
56
 
57
57
  end