aws-sdk-athena 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a15ace46959b2ff61a075fdb359f167e9646eaf
-  data.tar.gz: f9f4d0f7a9f6a1bbf879b546a598274be12c9115
+  metadata.gz: f3f05a7acb18b1ee76dfa81d9655f46a47c20839
+  data.tar.gz: 80399f4c18a7669cf3a4462aa9ee98e4539ae17a
 SHA512:
-  metadata.gz: dbd5ae18a56715fa8b89896c55f8d12232c187b6d2bf9f4b44941e3a3491bfa83670f800155805fefb563f658a0fae54e0dca33d36327e0cb6cafb90480cd832
-  data.tar.gz: f96e0039d8a8494b2ffda2a50ae325f990636f758b70e05ae7954946955cfebf143d617d2ec1be8f45648c78b46f3fea66cf1fba1a4538bbbc209951e9492caa
+  metadata.gz: 249d007ee5b2c81ef8bf8ba5d4eb64bb75c7f7cc6d451d0ebfa554f54071ffbbf574dfa43d02333d269fcd1dfd55168d899498d4041be1fcb230cc3e50530347
+  data.tar.gz: ead2cb8ef4ee5bde5e05a1b855b5c385a1b185fd383c662c63878b1382423879c70d7c700e1457772ac4ccf12e81f568818458500747e785b9bd9cfc99de44d9

data/lib/aws-sdk-athena.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-athena/customizations'
 # @service
 module Aws::Athena
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.8.0'
 
 end

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

@@ -216,14 +216,15 @@ module Aws::Athena
     # @!group API Operations
 
     # Returns the details of a single named query or a list of up to 50
-    # queries, which you provide as an array of query ID strings. Use
-    # ListNamedQueries to get the list of named query IDs. If information
-    # could not be retrieved for a submitted query ID, information about the
-    # query ID submitted is listed under UnprocessedNamedQueryId. Named
-    # queries are different from executed queries. Use
-    # BatchGetQueryExecution to get details about each unique query
-    # execution, and ListQueryExecutions to get a list of query execution
-    # IDs.
+    # queries, which you provide as an array of query ID strings. Requires
+    # you to have access to the workgroup in which the queries were saved.
+    # Use ListNamedQueriesInput to get the list of named query IDs in the
+    # specified workgroup. If information could not be retrieved for a
+    # submitted query ID, information about the query ID submitted is listed
+    # under UnprocessedNamedQueryId. Named queries differ from executed
+    # queries. Use BatchGetQueryExecutionInput to get details about each
+    # unique query execution, and ListQueryExecutionsInput to get a list of
+    # query execution IDs.
     #
     # @option params [required, Array<String>] :named_query_ids
     #   An array of query IDs.
@@ -247,6 +248,7 @@ module Aws::Athena
     #   resp.named_queries[0].database #=> String
     #   resp.named_queries[0].query_string #=> String
     #   resp.named_queries[0].named_query_id #=> String
+    #   resp.named_queries[0].work_group #=> String
     #   resp.unprocessed_named_query_ids #=> Array
     #   resp.unprocessed_named_query_ids[0].named_query_id #=> String
     #   resp.unprocessed_named_query_ids[0].error_code #=> String
@@ -263,9 +265,11 @@ module Aws::Athena
 
     # Returns the details of a single query execution or a list of up to 50
     # query executions, which you provide as an array of query execution ID
-    # strings. To get a list of query execution IDs, use
-    # ListQueryExecutions. Query executions are different from named (saved)
-    # queries. Use BatchGetNamedQuery to get details about named queries.
+    # strings. Requires you to have access to the workgroup in which the
+    # queries ran. To get a list of query execution IDs, use
+    # ListQueryExecutionsInput$WorkGroup. Query executions differ from named
+    # (saved) queries. Use BatchGetNamedQueryInput to get details about
+    # named queries.
     #
     # @option params [required, Array<String>] :query_execution_ids
     #   An array of query execution IDs.
@@ -297,6 +301,7 @@ module Aws::Athena
     #   resp.query_executions[0].status.completion_date_time #=> Time
     #   resp.query_executions[0].statistics.engine_execution_time_in_millis #=> Integer
     #   resp.query_executions[0].statistics.data_scanned_in_bytes #=> Integer
+    #   resp.query_executions[0].work_group #=> String
     #   resp.unprocessed_query_execution_ids #=> Array
     #   resp.unprocessed_query_execution_ids[0].query_execution_id #=> String
     #   resp.unprocessed_query_execution_ids[0].error_code #=> String
@@ -311,7 +316,8 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Creates a named query.
+    # 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*.
@@ -321,16 +327,16 @@ module Aws::Athena
     # [1]: http://docs.aws.amazon.com/athena/latest/ug/code-samples.html
     #
     # @option params [required, String] :name
-    #   The plain language name for the query.
+    #   The query name.
     #
     # @option params [String] :description
-    #   A brief explanation of the query.
+    #   The query description.
     #
     # @option params [required, String] :database
     #   The database to which the query belongs.
     #
     # @option params [required, String] :query_string
-    #   The text of the query itself. In other words, all query statements.
+    #   The contents of the query with all query statements.
     #
     # @option params [String] :client_request_token
     #   A unique case-sensitive string used to ensure the request to create
@@ -347,6 +353,9 @@ module Aws::Athena
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
     #
+    # @option params [String] :work_group
+    #   The name of the workgroup in which the named query is being created.
+    #
     # @return [Types::CreateNamedQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateNamedQueryOutput#named_query_id #named_query_id} => String
@@ -359,6 +368,7 @@ module Aws::Athena
     #     database: "DatabaseString", # required
     #     query_string: "QueryString", # required
     #     client_request_token: "IdempotencyToken",
+    #     work_group: "WorkGroupName",
     #   })
     #
     # @example Response structure
@@ -374,7 +384,57 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Deletes a named query.
+    # Creates a workgroup with the specified name.
+    #
+    # @option params [required, String] :name
+    #   The workgroup name.
+    #
+    # @option params [Types::WorkGroupConfiguration] :configuration
+    #   The configuration for the workgroup, which includes the location in
+    #   Amazon S3 where query results are stored, the encryption
+    #   configuration, if any, used for encrypting query results, whether 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 override
+    #   client-side settings. See
+    #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
+    #
+    # @option params [String] :description
+    #   The workgroup description.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_work_group({
+    #     name: "WorkGroupName", # required
+    #     configuration: {
+    #       result_configuration: {
+    #         output_location: "String",
+    #         encryption_configuration: {
+    #           encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
+    #           kms_key: "String",
+    #         },
+    #       },
+    #       enforce_work_group_configuration: false,
+    #       publish_cloud_watch_metrics_enabled: false,
+    #       bytes_scanned_cutoff_per_query: 1,
+    #     },
+    #     description: "WorkGroupDescriptionString",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroup AWS API Documentation
+    #
+    # @overload create_work_group(params = {})
+    # @param [Hash] params ({})
+    def create_work_group(params = {}, options = {})
+      req = build_request(:create_work_group, params)
+      req.send_request(options)
+    end
+
+    # 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*.
@@ -406,7 +466,36 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Returns information about a single query.
+    # Deletes the workgroup with the specified name. The primary workgroup
+    # cannot be deleted.
+    #
+    # @option params [required, String] :work_group
+    #   The unique name of the workgroup to delete.
+    #
+    # @option params [Boolean] :recursive_delete_option
+    #   The option to delete the workgroup and its contents even if the
+    #   workgroup contains any named queries.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_work_group({
+    #     work_group: "WorkGroupName", # required
+    #     recursive_delete_option: false,
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroup AWS API Documentation
+    #
+    # @overload delete_work_group(params = {})
+    # @param [Hash] params ({})
+    def delete_work_group(params = {}, options = {})
+      req = build_request(:delete_work_group, params)
+      req.send_request(options)
+    end
+
+    # Returns information about a single query. Requires that you have
+    # access to the workgroup in which the query was saved.
     #
     # @option params [required, String] :named_query_id
     #   The unique ID of the query. Use ListNamedQueries to get query IDs.
@@ -428,6 +517,7 @@ module Aws::Athena
     #   resp.named_query.database #=> String
     #   resp.named_query.query_string #=> String
     #   resp.named_query.named_query_id #=> String
+    #   resp.named_query.work_group #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQuery AWS API Documentation
     #
@@ -438,9 +528,10 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Returns information about a single execution of a query. Each time a
-    # query executes, information about the query execution is saved with a
-    # unique ID.
+    # Returns information about a single execution of a query if you have
+    # access to the workgroup in which the query ran. Each time a query
+    # executes, information about the query execution is saved with a unique
+    # ID.
     #
     # @option params [required, String] :query_execution_id
     #   The unique ID of the query execution.
@@ -470,6 +561,7 @@ module Aws::Athena
     #   resp.query_execution.status.completion_date_time #=> Time
     #   resp.query_execution.statistics.engine_execution_time_in_millis #=> Integer
     #   resp.query_execution.statistics.data_scanned_in_bytes #=> Integer
+    #   resp.query_execution.work_group #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution AWS API Documentation
     #
@@ -481,8 +573,9 @@ module Aws::Athena
     end
 
     # Returns the results of a single query execution specified by
-    # `QueryExecutionId`. This request does not execute the query but
-    # returns results. Use StartQueryExecution to run a query.
+    # `QueryExecutionId` if you have access to the workgroup in which the
+    # query ran. This request does not execute the query but returns
+    # results. Use StartQueryExecution to run a query.
     #
     # @option params [required, String] :query_execution_id
     #   The unique ID of the query execution.
@@ -536,7 +629,45 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Provides a list of all available query IDs.
+    # Returns information about the workgroup with the speficied name.
+    #
+    # @option params [required, String] :work_group
+    #   The name of the workgroup.
+    #
+    # @return [Types::GetWorkGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetWorkGroupOutput#work_group #work_group} => Types::WorkGroup
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_work_group({
+    #     work_group: "WorkGroupName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.work_group.name #=> String
+    #   resp.work_group.state #=> String, one of "ENABLED", "DISABLED"
+    #   resp.work_group.configuration.result_configuration.output_location #=> String
+    #   resp.work_group.configuration.result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
+    #   resp.work_group.configuration.result_configuration.encryption_configuration.kms_key #=> String
+    #   resp.work_group.configuration.enforce_work_group_configuration #=> Boolean
+    #   resp.work_group.configuration.publish_cloud_watch_metrics_enabled #=> Boolean
+    #   resp.work_group.configuration.bytes_scanned_cutoff_per_query #=> Integer
+    #   resp.work_group.description #=> String
+    #   resp.work_group.creation_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetWorkGroup AWS API Documentation
+    #
+    # @overload get_work_group(params = {})
+    # @param [Hash] params ({})
+    def get_work_group(params = {}, options = {})
+      req = build_request(:get_work_group, params)
+      req.send_request(options)
+    end
+
+    # Provides a list of available query IDs only for queries saved 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*.
@@ -552,6 +683,10 @@ module Aws::Athena
     # @option params [Integer] :max_results
     #   The maximum number of queries to return in this request.
     #
+    # @option params [String] :work_group
+    #   The name of the workgroup from which the named queries are being
+    #   returned.
+    #
     # @return [Types::ListNamedQueriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListNamedQueriesOutput#named_query_ids #named_query_ids} => Array&lt;String&gt;
@@ -562,6 +697,7 @@ module Aws::Athena
     #   resp = client.list_named_queries({
     #     next_token: "Token",
     #     max_results: 1,
+    #     work_group: "WorkGroupName",
     #   })
     #
     # @example Response structure
@@ -579,7 +715,9 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Provides a list of all available query execution IDs.
+    # Provides a list of available query execution IDs for the queries in
+    # the specified 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*.
@@ -595,6 +733,9 @@ module Aws::Athena
     # @option params [Integer] :max_results
     #   The maximum number of query executions to return in this request.
     #
+    # @option params [String] :work_group
+    #   The name of the workgroup from which queries are being returned.
+    #
     # @return [Types::ListQueryExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListQueryExecutionsOutput#query_execution_ids #query_execution_ids} => Array&lt;String&gt;
@@ -605,6 +746,7 @@ module Aws::Athena
     #   resp = client.list_query_executions({
     #     next_token: "Token",
     #     max_results: 1,
+    #     work_group: "WorkGroupName",
     #   })
     #
     # @example Response structure
@@ -622,8 +764,46 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Runs (executes) the SQL query statements contained in the `Query`
-    # string.
+    # Lists available workgroups for the account.
+    #
+    # @option params [String] :next_token
+    #   A token to be used by the next request if this request is truncated.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of workgroups to return in this request.
+    #
+    # @return [Types::ListWorkGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWorkGroupsOutput#work_groups #work_groups} => Array&lt;Types::WorkGroupSummary&gt;
+    #   * {Types::ListWorkGroupsOutput#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_work_groups({
+    #     next_token: "Token",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.work_groups #=> Array
+    #   resp.work_groups[0].name #=> String
+    #   resp.work_groups[0].state #=> String, one of "ENABLED", "DISABLED"
+    #   resp.work_groups[0].description #=> String
+    #   resp.work_groups[0].creation_time #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups AWS API Documentation
+    #
+    # @overload list_work_groups(params = {})
+    # @param [Hash] params ({})
+    def list_work_groups(params = {}, options = {})
+      req = build_request(:list_work_groups, params)
+      req.send_request(options)
+    end
+
+    # Runs the SQL query statements contained in the `Query`. 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*.
@@ -653,9 +833,17 @@ module Aws::Athena
     # @option params [Types::QueryExecutionContext] :query_execution_context
     #   The database within which the query executes.
     #
-    # @option params [required, Types::ResultConfiguration] :result_configuration
+    # @option params [Types::ResultConfiguration] :result_configuration
     #   Specifies information about where and how to save the results of the
-    #   query execution.
+    #   query execution. If the query runs in a workgroup, then workgroup's
+    #   settings may override query settings. This affects the query results
+    #   location. The workgroup settings override is specified in
+    #   EnforceWorkGroupConfiguration (true/false) in the
+    #   WorkGroupConfiguration. See
+    #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
+    #
+    # @option params [String] :work_group
+    #   The name of the workgroup in which the query is being started.
     #
     # @return [Types::StartQueryExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -669,13 +857,14 @@ module Aws::Athena
     #     query_execution_context: {
     #       database: "DatabaseString",
     #     },
-    #     result_configuration: { # required
-    #       output_location: "String", # required
+    #     result_configuration: {
+    #       output_location: "String",
     #       encryption_configuration: {
     #         encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
     #         kms_key: "String",
     #       },
     #     },
+    #     work_group: "WorkGroupName",
     #   })
     #
     # @example Response structure
@@ -691,7 +880,8 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Stops a query execution.
+    # 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*.
@@ -723,6 +913,56 @@ module Aws::Athena
       req.send_request(options)
     end
 
+    # Updates the workgroup with the specified name. The workgroup's name
+    # cannot be changed.
+    #
+    # @option params [required, String] :work_group
+    #   The specified workgroup that will be updated.
+    #
+    # @option params [String] :description
+    #   The workgroup description.
+    #
+    # @option params [Types::WorkGroupConfigurationUpdates] :configuration_updates
+    #   The workgroup configuration that will be updated for the given
+    #   workgroup.
+    #
+    # @option params [String] :state
+    #   The workgroup state that will be updated for the given workgroup.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_work_group({
+    #     work_group: "WorkGroupName", # required
+    #     description: "WorkGroupDescriptionString",
+    #     configuration_updates: {
+    #       enforce_work_group_configuration: false,
+    #       result_configuration_updates: {
+    #         output_location: "String",
+    #         remove_output_location: false,
+    #         encryption_configuration: {
+    #           encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
+    #           kms_key: "String",
+    #         },
+    #         remove_encryption_configuration: false,
+    #       },
+    #       publish_cloud_watch_metrics_enabled: false,
+    #       bytes_scanned_cutoff_per_query: 1,
+    #       remove_bytes_scanned_cutoff_per_query: false,
+    #     },
+    #     state: "ENABLED", # accepts ENABLED, DISABLED
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup AWS API Documentation
+    #
+    # @overload update_work_group(params = {})
+    # @param [Hash] params ({})
+    def update_work_group(params = {}, options = {})
+      req = build_request(:update_work_group, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -736,7 +976,7 @@ module Aws::Athena
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-athena'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end