aws-sdk-athena 1.39.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed597ac16a476a05e4b0ac21f5af39d9cf2dfcd9fcfa356bd7aab056ae94ea0
-  data.tar.gz: 5e07b1b22b11d931846360cca9c9781e776c7077c76fd89a2200a0df4d3ba5e5
+  metadata.gz: c274a6c62811a7212f970289fed59e6ad4e45960d65f5e897cf421307502ac99
+  data.tar.gz: 2d315e539775863197343855661939ad73ab32ef3a5693b07af2b5020c63646b
 SHA512:
-  metadata.gz: d375d0bfd768d09d596e2b5c3f64f7a31496070020a5e347863141bd7138be74ab24c5341ec6596dc2e8111fc42ba74c2cbc63063dbd52edc3fb367b1fd357b5
-  data.tar.gz: c765262f5827782873385c5fc7a0493213dc1dc94c594bb9cde13f1f3ec1d0286f89927195fc5801d256cf6ac751dd0b8480dcb59c8e1b224e476b9937adb5e8
+  metadata.gz: f42c558eba6b553f7aef9fa854e8a51b3d9aa645eb6d85883fbc5e753ee534b1e8697abf3de59cab1403a18eed2d0f144498414885111ba2b0cacb1098c2c98e
+  data.tar.gz: 167d97dca9c454bd4e6d22d4b71e79968581da21409193d9a0317de8065fb36417c725a70f0a9febc37636f4ce4430807df94c357a12454ee48f82b6bab1505b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.40.0 (2021-08-06)
+------------------
+
+* Feature - Documentation updates for Athena.
+
 1.39.0 (2021-07-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.39.0
+1.40.0

data/lib/aws-sdk-athena.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-athena/customizations'
 # @!group service
 module Aws::Athena
 
-  GEM_VERSION = '1.39.0'
+  GEM_VERSION = '1.40.0'
 
 end

data/lib/aws-sdk-athena/client.rb

@@ -447,23 +447,18 @@ module Aws::Athena
     end
 
     # Creates (registers) a data catalog with the specified name and
-    # properties. Catalogs created are visible to all users of the same AWS
-    # account.
+    # properties. Catalogs created are visible to all users of the same
+    # Amazon Web Services account.
     #
     # @option params [required, String] :name
     #   The name of the data catalog to create. The catalog name must be
-    #   unique for the AWS account and can use a maximum of 128 alphanumeric,
-    #   underscore, at sign, or hyphen characters.
+    #   unique for the Amazon Web Services account and can use a maximum of
+    #   128 alphanumeric, underscore, at sign, or hyphen characters.
     #
     # @option params [required, String] :type
-    #   The type of data catalog to create: `LAMBDA` for a federated catalog
-    #   or `HIVE` for an external hive metastore.
-    #
-    #   <note markdown="1"> Do not use the `GLUE` type. This refers to the `AwsDataCatalog` that
-    #   already exists in your account, of which you can have only one.
-    #   Specifying the `GLUE` type will result in an `INVALID_INPUT` error.
-    #
-    #    </note>
+    #   The type of data catalog to create: `LAMBDA` for a federated catalog,
+    #   `HIVE` for an external hive metastore, or `GLUE` for an Glue Data
+    #   Catalog.
     #
     # @option params [String] :description
     #   A description of the data catalog to be created.
@@ -495,6 +490,23 @@ module Aws::Athena
     #
     #       `function=lambda_arn `
     #
+    #   * The `GLUE` type takes a catalog ID parameter and is required. The `
+    #     catalog_id ` is the account ID of the Amazon Web Services account to
+    #     which the Glue Data Catalog belongs.
+    #
+    #     `catalog-id=catalog_id `
+    #
+    #     * The `GLUE` data catalog type also applies to the default
+    #       `AwsDataCatalog` that already exists in your account, of which you
+    #       can have only one and cannot modify.
+    #
+    #     * Queries that specify a Glue Data Catalog other than the default
+    #       `AwsDataCatalog` must be run on Athena engine version 2.
+    #
+    #     * In Regions where Athena engine version 2 is not available,
+    #       creating new Glue data catalogs results in an `INVALID_INPUT`
+    #       error.
+    #
     # @option params [Array<Types::Tag>] :tags
     #   A list of comma separated tags to add to the data catalog that is
     #   created.
@@ -530,8 +542,8 @@ module Aws::Athena
     # Creates a named query in the specified workgroup. Requires that you
     # have access to the workgroup.
     #
-    # For code samples using the AWS SDK for Java, see [Examples and Code
-    # Samples][1] in the *Amazon Athena User Guide*.
+    # For code samples using the Amazon Web Services SDK for Java, see
+    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
     #
     #
     #
@@ -556,10 +568,11 @@ module Aws::Athena
     #   and another query is not created. If a parameter has changed, for
     #   example, the `QueryString`, an error is returned.
     #
-    #   This token is listed as not required because AWS SDKs (for example the
-    #   AWS SDK for Java) auto-generate the token for users. If you are not
-    #   using the AWS SDK or the AWS CLI, you must provide this token or the
-    #   action will fail.
+    #   This token is listed as not required because Amazon Web Services SDKs
+    #   (for example the Amazon Web Services SDK for Java) auto-generate the
+    #   token for users. If you are not using the Amazon Web Services SDK or
+    #   the Amazon Web Services CLI, you must provide this token or the action
+    #   will fail.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -641,8 +654,8 @@ module Aws::Athena
     #   Amazon CloudWatch Metrics are enabled for the workgroup, the limit for
     #   the amount of bytes scanned (cutoff) per query, if it is specified,
     #   and whether workgroup's settings (specified with
-    #   EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override
-    #   client-side settings. See
+    #   `EnforceWorkGroupConfiguration`) in the `WorkGroupConfiguration`
+    #   override client-side settings. See
     #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #
     # @option params [String] :description
@@ -718,8 +731,8 @@ module Aws::Athena
     # Deletes the named query if you have access to the workgroup in which
     # the query was saved.
     #
-    # For code samples using the AWS SDK for Java, see [Examples and Code
-    # Samples][1] in the *Amazon Athena User Guide*.
+    # For code samples using the Amazon Web Services SDK for Java, see
+    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
     #
     #
     #
@@ -1159,7 +1172,7 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Lists the data catalogs in the current AWS account.
+    # Lists the data catalogs in the current Amazon Web Services account.
     #
     # @option params [String] :next_token
     #   A token generated by the Athena service that specifies where to
@@ -1292,8 +1305,8 @@ module Aws::Athena
     # workgroup. If a workgroup is not specified, lists the saved queries
     # for the primary workgroup.
     #
-    # For code samples using the AWS SDK for Java, see [Examples and Code
-    # Samples][1] in the *Amazon Athena User Guide*.
+    # For code samples using the Amazon Web Services SDK for Java, see
+    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
     #
     #
     #
@@ -1393,8 +1406,8 @@ module Aws::Athena
     # list of query execution IDs for the primary workgroup. Requires you to
     # have access to the workgroup in which the queries ran.
     #
-    # For code samples using the AWS SDK for Java, see [Examples and Code
-    # Samples][1] in the *Amazon Athena User Guide*.
+    # For code samples using the Amazon Web Services SDK for Java, see
+    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
     #
     #
     #
@@ -1606,8 +1619,9 @@ module Aws::Athena
     # Runs the SQL query statements contained in the `Query`. Requires you
     # to have access to the workgroup in which the query ran. Running
     # queries against an external catalog requires GetDataCatalog permission
-    # to the catalog. For code samples using the AWS SDK for Java, see
-    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
+    # to the catalog. For code samples using the Amazon Web Services SDK for
+    # Java, see [Examples and Code Samples][1] in the *Amazon Athena User
+    # Guide*.
     #
     #
     #
@@ -1623,10 +1637,11 @@ module Aws::Athena
     #   returned and another query is not created. If a parameter has changed,
     #   for example, the `QueryString`, an error is returned.
     #
-    #   This token is listed as not required because AWS SDKs (for example the
-    #   AWS SDK for Java) auto-generate the token for users. If you are not
-    #   using the AWS SDK or the AWS CLI, you must provide this token or the
-    #   action will fail.
+    #   This token is listed as not required because Amazon Web Services SDKs
+    #   (for example the Amazon Web Services SDK for Java) auto-generate the
+    #   token for users. If you are not using the Amazon Web Services SDK or
+    #   the Amazon Web Services CLI, you must provide this token or the action
+    #   will fail.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -1685,8 +1700,8 @@ module Aws::Athena
     # Stops a query execution. Requires you to have access to the workgroup
     # in which the query ran.
     #
-    # For code samples using the AWS SDK for Java, see [Examples and Code
-    # Samples][1] in the *Amazon Athena User Guide*.
+    # For code samples using the Amazon Web Services SDK for Java, see
+    # [Examples and Code Samples][1] in the *Amazon Athena User Guide*.
     #
     #
     #
@@ -1795,18 +1810,13 @@ module Aws::Athena
     #
     # @option params [required, String] :name
     #   The name of the data catalog to update. The catalog name must be
-    #   unique for the AWS account and can use a maximum of 128 alphanumeric,
-    #   underscore, at sign, or hyphen characters.
+    #   unique for the Amazon Web Services account and can use a maximum of
+    #   128 alphanumeric, underscore, at sign, or hyphen characters.
     #
     # @option params [required, String] :type
     #   Specifies the type of data catalog to update. Specify `LAMBDA` for a
-    #   federated catalog or `HIVE` for an external hive metastore.
-    #
-    #   <note markdown="1"> Do not use the `GLUE` type. This refers to the `AwsDataCatalog` that
-    #   already exists in your account, of which you can have only one.
-    #   Specifying the `GLUE` type will result in an `INVALID_INPUT` error.
-    #
-    #    </note>
+    #   federated catalog, `HIVE` for an external hive metastore, or `GLUE`
+    #   for an Glue Data Catalog.
     #
     # @option params [String] :description
     #   New or modified text that describes the data catalog.
@@ -1962,7 +1972,7 @@ module Aws::Athena
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-athena'
-      context[:gem_version] = '1.39.0'
+      context[:gem_version] = '1.40.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-athena/types.rb

@@ -187,19 +187,14 @@ module Aws::Athena
     #
     # @!attribute [rw] name
     #   The name of the data catalog to create. The catalog name must be
-    #   unique for the AWS account and can use a maximum of 128
-    #   alphanumeric, underscore, at sign, or hyphen characters.
+    #   unique for the Amazon Web Services account and can use a maximum of
+    #   128 alphanumeric, underscore, at sign, or hyphen characters.
     #   @return [String]
     #
     # @!attribute [rw] type
-    #   The type of data catalog to create: `LAMBDA` for a federated catalog
-    #   or `HIVE` for an external hive metastore.
-    #
-    #   <note markdown="1"> Do not use the `GLUE` type. This refers to the `AwsDataCatalog` that
-    #   already exists in your account, of which you can have only one.
-    #   Specifying the `GLUE` type will result in an `INVALID_INPUT` error.
-    #
-    #    </note>
+    #   The type of data catalog to create: `LAMBDA` for a federated
+    #   catalog, `HIVE` for an external hive metastore, or `GLUE` for an
+    #   Glue Data Catalog.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -232,6 +227,23 @@ module Aws::Athena
     #       Lambda function.
     #
     #       `function=lambda_arn `
+    #
+    #   * The `GLUE` type takes a catalog ID parameter and is required. The
+    #     ` catalog_id ` is the account ID of the Amazon Web Services
+    #     account to which the Glue Data Catalog belongs.
+    #
+    #     `catalog-id=catalog_id `
+    #
+    #     * The `GLUE` data catalog type also applies to the default
+    #       `AwsDataCatalog` that already exists in your account, of which
+    #       you can have only one and cannot modify.
+    #
+    #     * Queries that specify a Glue Data Catalog other than the default
+    #       `AwsDataCatalog` must be run on Athena engine version 2.
+    #
+    #     * In Regions where Athena engine version 2 is not available,
+    #       creating new Glue data catalogs results in an `INVALID_INPUT`
+    #       error.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] tags
@@ -290,10 +302,11 @@ module Aws::Athena
     #   returned and another query is not created. If a parameter has
     #   changed, for example, the `QueryString`, an error is returned.
     #
-    #   This token is listed as not required because AWS SDKs (for example
-    #   the AWS SDK for Java) auto-generate the token for users. If you are
-    #   not using the AWS SDK or the AWS CLI, you must provide this token or
-    #   the action will fail.
+    #   This token is listed as not required because Amazon Web Services
+    #   SDKs (for example the Amazon Web Services SDK for Java)
+    #   auto-generate the token for users. If you are not using the Amazon
+    #   Web Services SDK or the Amazon Web Services CLI, you must provide
+    #   this token or the action will fail.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -411,7 +424,7 @@ module Aws::Athena
     #   the Amazon CloudWatch Metrics are enabled for the workgroup, the
     #   limit for the amount of bytes scanned (cutoff) per query, if it is
     #   specified, and whether workgroup's settings (specified with
-    #   EnforceWorkGroupConfiguration) in the WorkGroupConfiguration
+    #   `EnforceWorkGroupConfiguration`) in the `WorkGroupConfiguration`
     #   override client-side settings. See
     #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #   @return [Types::WorkGroupConfiguration]
@@ -440,12 +453,13 @@ module Aws::Athena
     #
     class CreateWorkGroupOutput < Aws::EmptyStructure; end
 
-    # Contains information about a data catalog in an AWS account.
+    # Contains information about a data catalog in an Amazon Web Services
+    # account.
     #
     # @!attribute [rw] name
     #   The name of the data catalog. The catalog name must be unique for
-    #   the AWS account and can use a maximum of 128 alphanumeric,
-    #   underscore, at sign, or hyphen characters.
+    #   the Amazon Web Services account and can use a maximum of 128
+    #   alphanumeric, underscore, at sign, or hyphen characters.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -453,10 +467,9 @@ module Aws::Athena
     #   @return [String]
     #
     # @!attribute [rw] type
-    #   The type of data catalog: `LAMBDA` for a federated catalog or `HIVE`
-    #   for an external hive metastore. `GLUE` refers to the
-    #   `AwsDataCatalog` that already exists in your account, of which you
-    #   can have only one.
+    #   The type of data catalog to create: `LAMBDA` for a federated
+    #   catalog, `HIVE` for an external hive metastore, or `GLUE` for an
+    #   Glue Data Catalog.
     #   @return [String]
     #
     # @!attribute [rw] parameters
@@ -484,6 +497,19 @@ module Aws::Athena
     #       Lambda function.
     #
     #       `function=lambda_arn `
+    #
+    #   * The `GLUE` type takes a catalog ID parameter and is required. The
+    #     ` catalog_id ` is the account ID of the Amazon Web Services
+    #     account to which the Glue catalog belongs.
+    #
+    #     `catalog-id=catalog_id `
+    #
+    #     * The `GLUE` data catalog type also applies to the default
+    #       `AwsDataCatalog` that already exists in your account, of which
+    #       you can have only one and cannot modify.
+    #
+    #     * Queries that specify a Glue Data Catalog other than the default
+    #       `AwsDataCatalog` must be run on Athena engine version 2.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DataCatalog AWS API Documentation
@@ -936,7 +962,8 @@ module Aws::Athena
     end
 
     # @!attribute [rw] update_count
-    #   The number of rows inserted with a CREATE TABLE AS SELECT statement.
+    #   The number of rows inserted with a `CREATE TABLE AS SELECT`
+    #   statement.
     #   @return [Integer]
     #
     # @!attribute [rw] result_set
@@ -1677,7 +1704,7 @@ module Aws::Athena
     #   statements. `DML` indicates DML (Data Manipulation Language) query
     #   statements, such as `CREATE TABLE AS SELECT`. `UTILITY` indicates
     #   query statements other than DDL and DML, such as `SHOW CREATE
-    #   TABLE`, or `DESCRIBE <table>`.
+    #   TABLE`, or `DESCRIBE TABLE`.
     #   @return [String]
     #
     # @!attribute [rw] result_configuration
@@ -1740,7 +1767,8 @@ module Aws::Athena
     #       }
     #
     # @!attribute [rw] database
-    #   The name of the database used in the query execution.
+    #   The name of the database used in the query execution. The database
+    #   must exist in the catalog.
     #   @return [String]
     #
     # @!attribute [rw] catalog
@@ -1959,8 +1987,8 @@ module Aws::Athena
     #   then the query uses the location for the query results and the
     #   encryption configuration that are specified for the workgroup. The
     #   "workgroup settings override" is specified in
-    #   EnforceWorkGroupConfiguration (true/false) in the
-    #   WorkGroupConfiguration. See
+    #   `EnforceWorkGroupConfiguration` (true/false) in the
+    #   `WorkGroupConfiguration`. See
     #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #
     #
@@ -1972,9 +2000,9 @@ module Aws::Athena
     #   If set to "true", indicates that the previously-specified query
     #   results location (also known as a client-side setting) for queries
     #   in this workgroup should be ignored and set to null. If set to
-    #   "false" or not set, and a value is present in the OutputLocation
-    #   in ResultConfigurationUpdates (the client-side setting), the
-    #   OutputLocation in the workgroup's ResultConfiguration will be
+    #   "false" or not set, and a value is present in the `OutputLocation`
+    #   in `ResultConfigurationUpdates` (the client-side setting), the
+    #   `OutputLocation` in the workgroup's `ResultConfiguration` will be
     #   updated with the new value. For more information, see [Workgroup
     #   Settings Override Client-Side Settings][1].
     #
@@ -1992,11 +2020,11 @@ module Aws::Athena
     #   encryption configuration (also known as the client-side setting) for
     #   queries in this workgroup should be ignored and set to null. If set
     #   to "false" or not set, and a value is present in the
-    #   EncryptionConfiguration in ResultConfigurationUpdates (the
-    #   client-side setting), the EncryptionConfiguration in the
-    #   workgroup's ResultConfiguration will be updated with the new value.
-    #   For more information, see [Workgroup Settings Override Client-Side
-    #   Settings][1].
+    #   `EncryptionConfiguration` in `ResultConfigurationUpdates` (the
+    #   client-side setting), the `EncryptionConfiguration` in the
+    #   workgroup's `ResultConfiguration` will be updated with the new
+    #   value. For more information, see [Workgroup Settings Override
+    #   Client-Side Settings][1].
     #
     #
     #
@@ -2097,10 +2125,11 @@ module Aws::Athena
     #   returned and another query is not created. If a parameter has
     #   changed, for example, the `QueryString`, an error is returned.
     #
-    #   This token is listed as not required because AWS SDKs (for example
-    #   the AWS SDK for Java) auto-generate the token for users. If you are
-    #   not using the AWS SDK or the AWS CLI, you must provide this token or
-    #   the action will fail.
+    #   This token is listed as not required because Amazon Web Services
+    #   SDKs (for example the Amazon Web Services SDK for Java)
+    #   auto-generate the token for users. If you are not using the Amazon
+    #   Web Services SDK or the Amazon Web Services CLI, you must provide
+    #   this token or the action will fail.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -2417,19 +2446,14 @@ module Aws::Athena
     #
     # @!attribute [rw] name
     #   The name of the data catalog to update. The catalog name must be
-    #   unique for the AWS account and can use a maximum of 128
-    #   alphanumeric, underscore, at sign, or hyphen characters.
+    #   unique for the Amazon Web Services account and can use a maximum of
+    #   128 alphanumeric, underscore, at sign, or hyphen characters.
     #   @return [String]
     #
     # @!attribute [rw] type
     #   Specifies the type of data catalog to update. Specify `LAMBDA` for a
-    #   federated catalog or `HIVE` for an external hive metastore.
-    #
-    #   <note markdown="1"> Do not use the `GLUE` type. This refers to the `AwsDataCatalog` that
-    #   already exists in your account, of which you can have only one.
-    #   Specifying the `GLUE` type will result in an `INVALID_INPUT` error.
-    #
-    #    </note>
+    #   federated catalog, `HIVE` for an external hive metastore, or `GLUE`
+    #   for an Glue Data Catalog.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -2589,8 +2613,8 @@ module Aws::Athena
     # settings), to enable sending query metrics to Amazon CloudWatch, and
     # to establish per-query data usage control limits for all queries in a
     # workgroup. The workgroup settings override is specified in
-    # EnforceWorkGroupConfiguration (true/false) in the
-    # WorkGroupConfiguration. See
+    # `EnforceWorkGroupConfiguration` (true/false) in the
+    # `WorkGroupConfiguration`. See
     # WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #
     # @!attribute [rw] name
@@ -2609,8 +2633,8 @@ module Aws::Athena
     #   settings override client-side settings; and the data usage limits
     #   for the amount of data scanned per query or per workgroup. The
     #   workgroup settings override is specified in
-    #   EnforceWorkGroupConfiguration (true/false) in the
-    #   WorkGroupConfiguration. See
+    #   `EnforceWorkGroupConfiguration` (true/false) in the
+    #   `WorkGroupConfiguration`. See
     #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #   @return [Types::WorkGroupConfiguration]
     #
@@ -2640,8 +2664,8 @@ module Aws::Athena
     # enabled for the workgroup and whether workgroup settings override
     # query settings, and the data usage limits for the amount of data
     # scanned per query or per workgroup. The workgroup settings override is
-    # specified in EnforceWorkGroupConfiguration (true/false) in the
-    # WorkGroupConfiguration. See
+    # specified in `EnforceWorkGroupConfiguration` (true/false) in the
+    # `WorkGroupConfiguration`. See
     # WorkGroupConfiguration$EnforceWorkGroupConfiguration.
     #
     # @note When making an API call, you may pass WorkGroupConfiguration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-athena
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.40.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core