aws-sdk-athena 1.53.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45eafd0db4a2dd576613f0620092497ee6adcf1ed681f4ba4a1500b04ae14e3
-  data.tar.gz: a53b56f8fbf2a72fb9ca8dcb7c7563ac2bee565c5895f3a149e77b3f25c3d637
+  metadata.gz: cee70bdcc6ab700eeb11158edbc2bb745af148eea586294ba4142df7bb47204d
+  data.tar.gz: 280a727beec9639123a521f021f374b7ad6ab410ab3a6fefd70d3596a66dcf61
 SHA512:
-  metadata.gz: 05ea3defd3b925e981cbcde008389fb2223161f14a30a29f1a164cf8ec6655bb50445f31cea00889d6d8446fc53a4cd1142ef5447ca3b23da62096642f6c3156
-  data.tar.gz: f9c403030dbec36516adc375bfd1a50a1d84259e739e68deb130687d13021165f3f70eb54d8af2bf3190a13175e64efab9944dc222c1b4abe7bcb5c0899d871d
+  metadata.gz: db41ec6386f593a687cca832efbf2e66ecf9bd5a0f159a8dc5e516a4d6162d6094b1036afefd3b6ff4956ee9e45d25667ed22f21427bf0863c9290f86a550ff6
+  data.tar.gz: 28bcdfbc159efb09fbbe90559d887295e490d869775c259f9e1d4537f61454f23708a94274fb107876644e1c3cee417f7a31309b569d48ab13cfd2adba65f617

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.54.0 (2022-06-30)
+------------------
+
+* Feature - This feature introduces the API support for Athena's parameterized query and BatchGetPreparedStatement API.
+
 1.53.0 (2022-04-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.53.0
+1.54.0

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

@@ -409,6 +409,53 @@ module Aws::Athena
       req.send_request(options)
     end
 
+    # Returns the details of a single prepared statement or a list of up to
+    # 256 prepared statements for the array of prepared statement names that
+    # you provide. Requires you to have access to the workgroup to which the
+    # prepared statements belong. If a prepared statement cannot be
+    # retrieved for the name specified, the statement is listed in
+    # `UnprocessedPreparedStatementNames`.
+    #
+    # @option params [required, Array<String>] :prepared_statement_names
+    #   A list of prepared statement names to return.
+    #
+    # @option params [required, String] :work_group
+    #   The name of the workgroup to which the prepared statements belong.
+    #
+    # @return [Types::BatchGetPreparedStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetPreparedStatementOutput#prepared_statements #prepared_statements} => Array&lt;Types::PreparedStatement&gt;
+    #   * {Types::BatchGetPreparedStatementOutput#unprocessed_prepared_statement_names #unprocessed_prepared_statement_names} => Array&lt;Types::UnprocessedPreparedStatementName&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_prepared_statement({
+    #     prepared_statement_names: ["StatementName"], # required
+    #     work_group: "WorkGroupName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.prepared_statements #=> Array
+    #   resp.prepared_statements[0].statement_name #=> String
+    #   resp.prepared_statements[0].query_statement #=> String
+    #   resp.prepared_statements[0].work_group_name #=> String
+    #   resp.prepared_statements[0].description #=> String
+    #   resp.prepared_statements[0].last_modified_time #=> Time
+    #   resp.unprocessed_prepared_statement_names #=> Array
+    #   resp.unprocessed_prepared_statement_names[0].statement_name #=> String
+    #   resp.unprocessed_prepared_statement_names[0].error_code #=> String
+    #   resp.unprocessed_prepared_statement_names[0].error_message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetPreparedStatement AWS API Documentation
+    #
+    # @overload batch_get_prepared_statement(params = {})
+    # @param [Hash] params ({})
+    def batch_get_prepared_statement(params = {}, options = {})
+      req = build_request(:batch_get_prepared_statement, params)
+      req.send_request(options)
+    end
+
     # 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. Requires you to have access to the workgroup in which the
@@ -462,6 +509,8 @@ module Aws::Athena
     #   resp.query_executions[0].work_group #=> String
     #   resp.query_executions[0].engine_version.selected_engine_version #=> String
     #   resp.query_executions[0].engine_version.effective_engine_version #=> String
+    #   resp.query_executions[0].execution_parameters #=> Array
+    #   resp.query_executions[0].execution_parameters[0] #=> 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
@@ -1038,6 +1087,8 @@ module Aws::Athena
     #   resp.query_execution.work_group #=> String
     #   resp.query_execution.engine_version.selected_engine_version #=> String
     #   resp.query_execution.engine_version.effective_engine_version #=> String
+    #   resp.query_execution.execution_parameters #=> Array
+    #   resp.query_execution.execution_parameters[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution AWS API Documentation
     #
@@ -1400,7 +1451,7 @@ module Aws::Athena
       req.send_request(options)
     end
 
-    # Lists the prepared statements in the specfied workgroup.
+    # Lists the prepared statements in the specified workgroup.
     #
     # @option params [required, String] :work_group
     #   The workgroup to list the prepared statements for.
@@ -1705,6 +1756,11 @@ module Aws::Athena
     # @option params [String] :work_group
     #   The name of the workgroup in which the query is being started.
     #
+    # @option params [Array<String>] :execution_parameters
+    #   A list of values for the parameters in a query. The values are applied
+    #   sequentially to the parameters in the query in the order in which the
+    #   parameters occur.
+    #
     # @return [Types::StartQueryExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartQueryExecutionOutput#query_execution_id #query_execution_id} => String
@@ -1730,6 +1786,7 @@ module Aws::Athena
     #       },
     #     },
     #     work_group: "WorkGroupName",
+    #     execution_parameters: ["ExecutionParameter"],
     #   })
     #
     # @example Response structure
@@ -2063,7 +2120,7 @@ module Aws::Athena
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-athena'
-      context[:gem_version] = '1.53.0'
+      context[:gem_version] = '1.54.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -18,6 +18,8 @@ module Aws::Athena
     AthenaError = Shapes::StructureShape.new(name: 'AthenaError')
     BatchGetNamedQueryInput = Shapes::StructureShape.new(name: 'BatchGetNamedQueryInput')
     BatchGetNamedQueryOutput = Shapes::StructureShape.new(name: 'BatchGetNamedQueryOutput')
+    BatchGetPreparedStatementInput = Shapes::StructureShape.new(name: 'BatchGetPreparedStatementInput')
+    BatchGetPreparedStatementOutput = Shapes::StructureShape.new(name: 'BatchGetPreparedStatementOutput')
     BatchGetQueryExecutionInput = Shapes::StructureShape.new(name: 'BatchGetQueryExecutionInput')
     BatchGetQueryExecutionOutput = Shapes::StructureShape.new(name: 'BatchGetQueryExecutionOutput')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
@@ -64,6 +66,8 @@ module Aws::Athena
     ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     ErrorType = Shapes::IntegerShape.new(name: 'ErrorType')
+    ExecutionParameter = Shapes::StringShape.new(name: 'ExecutionParameter')
+    ExecutionParameters = Shapes::ListShape.new(name: 'ExecutionParameters')
     ExpressionString = Shapes::StringShape.new(name: 'ExpressionString')
     GetDataCatalogInput = Shapes::StructureShape.new(name: 'GetDataCatalogInput')
     GetDataCatalogOutput = Shapes::StructureShape.new(name: 'GetDataCatalogOutput')
@@ -125,6 +129,8 @@ module Aws::Athena
     ParametersMap = Shapes::MapShape.new(name: 'ParametersMap')
     ParametersMapValue = Shapes::StringShape.new(name: 'ParametersMapValue')
     PreparedStatement = Shapes::StructureShape.new(name: 'PreparedStatement')
+    PreparedStatementDetailsList = Shapes::ListShape.new(name: 'PreparedStatementDetailsList')
+    PreparedStatementNameList = Shapes::ListShape.new(name: 'PreparedStatementNameList')
     PreparedStatementSummary = Shapes::StructureShape.new(name: 'PreparedStatementSummary')
     PreparedStatementsList = Shapes::ListShape.new(name: 'PreparedStatementsList')
     QueryExecution = Shapes::StructureShape.new(name: 'QueryExecution')
@@ -168,6 +174,8 @@ module Aws::Athena
     TypeString = Shapes::StringShape.new(name: 'TypeString')
     UnprocessedNamedQueryId = Shapes::StructureShape.new(name: 'UnprocessedNamedQueryId')
     UnprocessedNamedQueryIdList = Shapes::ListShape.new(name: 'UnprocessedNamedQueryIdList')
+    UnprocessedPreparedStatementName = Shapes::StructureShape.new(name: 'UnprocessedPreparedStatementName')
+    UnprocessedPreparedStatementNameList = Shapes::ListShape.new(name: 'UnprocessedPreparedStatementNameList')
     UnprocessedQueryExecutionId = Shapes::StructureShape.new(name: 'UnprocessedQueryExecutionId')
     UnprocessedQueryExecutionIdList = Shapes::ListShape.new(name: 'UnprocessedQueryExecutionIdList')
     UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
@@ -207,6 +215,14 @@ module Aws::Athena
     BatchGetNamedQueryOutput.add_member(:unprocessed_named_query_ids, Shapes::ShapeRef.new(shape: UnprocessedNamedQueryIdList, location_name: "UnprocessedNamedQueryIds"))
     BatchGetNamedQueryOutput.struct_class = Types::BatchGetNamedQueryOutput
 
+    BatchGetPreparedStatementInput.add_member(:prepared_statement_names, Shapes::ShapeRef.new(shape: PreparedStatementNameList, required: true, location_name: "PreparedStatementNames"))
+    BatchGetPreparedStatementInput.add_member(:work_group, Shapes::ShapeRef.new(shape: WorkGroupName, required: true, location_name: "WorkGroup"))
+    BatchGetPreparedStatementInput.struct_class = Types::BatchGetPreparedStatementInput
+
+    BatchGetPreparedStatementOutput.add_member(:prepared_statements, Shapes::ShapeRef.new(shape: PreparedStatementDetailsList, location_name: "PreparedStatements"))
+    BatchGetPreparedStatementOutput.add_member(:unprocessed_prepared_statement_names, Shapes::ShapeRef.new(shape: UnprocessedPreparedStatementNameList, location_name: "UnprocessedPreparedStatementNames"))
+    BatchGetPreparedStatementOutput.struct_class = Types::BatchGetPreparedStatementOutput
+
     BatchGetQueryExecutionInput.add_member(:query_execution_ids, Shapes::ShapeRef.new(shape: QueryExecutionIdList, required: true, location_name: "QueryExecutionIds"))
     BatchGetQueryExecutionInput.struct_class = Types::BatchGetQueryExecutionInput
 
@@ -325,6 +341,8 @@ module Aws::Athena
 
     EngineVersionsList.member = Shapes::ShapeRef.new(shape: EngineVersion)
 
+    ExecutionParameters.member = Shapes::ShapeRef.new(shape: ExecutionParameter)
+
     GetDataCatalogInput.add_member(:name, Shapes::ShapeRef.new(shape: CatalogNameString, required: true, location_name: "Name"))
     GetDataCatalogInput.struct_class = Types::GetDataCatalogInput
 
@@ -493,6 +511,10 @@ module Aws::Athena
     PreparedStatement.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Date, location_name: "LastModifiedTime"))
     PreparedStatement.struct_class = Types::PreparedStatement
 
+    PreparedStatementDetailsList.member = Shapes::ShapeRef.new(shape: PreparedStatement)
+
+    PreparedStatementNameList.member = Shapes::ShapeRef.new(shape: StatementName)
+
     PreparedStatementSummary.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementName, location_name: "StatementName"))
     PreparedStatementSummary.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Date, location_name: "LastModifiedTime"))
     PreparedStatementSummary.struct_class = Types::PreparedStatementSummary
@@ -508,6 +530,7 @@ module Aws::Athena
     QueryExecution.add_member(:statistics, Shapes::ShapeRef.new(shape: QueryExecutionStatistics, location_name: "Statistics"))
     QueryExecution.add_member(:work_group, Shapes::ShapeRef.new(shape: WorkGroupName, location_name: "WorkGroup"))
     QueryExecution.add_member(:engine_version, Shapes::ShapeRef.new(shape: EngineVersion, location_name: "EngineVersion"))
+    QueryExecution.add_member(:execution_parameters, Shapes::ShapeRef.new(shape: ExecutionParameters, location_name: "ExecutionParameters"))
     QueryExecution.struct_class = Types::QueryExecution
 
     QueryExecutionContext.add_member(:database, Shapes::ShapeRef.new(shape: DatabaseString, location_name: "Database"))
@@ -571,6 +594,7 @@ module Aws::Athena
     StartQueryExecutionInput.add_member(:query_execution_context, Shapes::ShapeRef.new(shape: QueryExecutionContext, location_name: "QueryExecutionContext"))
     StartQueryExecutionInput.add_member(:result_configuration, Shapes::ShapeRef.new(shape: ResultConfiguration, location_name: "ResultConfiguration"))
     StartQueryExecutionInput.add_member(:work_group, Shapes::ShapeRef.new(shape: WorkGroupName, location_name: "WorkGroup"))
+    StartQueryExecutionInput.add_member(:execution_parameters, Shapes::ShapeRef.new(shape: ExecutionParameters, location_name: "ExecutionParameters"))
     StartQueryExecutionInput.struct_class = Types::StartQueryExecutionInput
 
     StartQueryExecutionOutput.add_member(:query_execution_id, Shapes::ShapeRef.new(shape: QueryExecutionId, location_name: "QueryExecutionId"))
@@ -617,6 +641,13 @@ module Aws::Athena
 
     UnprocessedNamedQueryIdList.member = Shapes::ShapeRef.new(shape: UnprocessedNamedQueryId)
 
+    UnprocessedPreparedStatementName.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementName, location_name: "StatementName"))
+    UnprocessedPreparedStatementName.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
+    UnprocessedPreparedStatementName.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
+    UnprocessedPreparedStatementName.struct_class = Types::UnprocessedPreparedStatementName
+
+    UnprocessedPreparedStatementNameList.member = Shapes::ShapeRef.new(shape: UnprocessedPreparedStatementName)
+
     UnprocessedQueryExecutionId.add_member(:query_execution_id, Shapes::ShapeRef.new(shape: QueryExecutionId, location_name: "QueryExecutionId"))
     UnprocessedQueryExecutionId.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
     UnprocessedQueryExecutionId.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
@@ -725,6 +756,16 @@ module Aws::Athena
         o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
       end)
 
+      api.add_operation(:batch_get_prepared_statement, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchGetPreparedStatement"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: BatchGetPreparedStatementInput)
+        o.output = Shapes::ShapeRef.new(shape: BatchGetPreparedStatementOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+      end)
+
       api.add_operation(:batch_get_query_execution, Seahorse::Model::Operation.new.tap do |o|
         o.name = "BatchGetQueryExecution"
         o.http_method = "POST"

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

@@ -132,6 +132,49 @@ module Aws::Athena
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass BatchGetPreparedStatementInput
+    #   data as a hash:
+    #
+    #       {
+    #         prepared_statement_names: ["StatementName"], # required
+    #         work_group: "WorkGroupName", # required
+    #       }
+    #
+    # @!attribute [rw] prepared_statement_names
+    #   A list of prepared statement names to return.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] work_group
+    #   The name of the workgroup to which the prepared statements belong.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetPreparedStatementInput AWS API Documentation
+    #
+    class BatchGetPreparedStatementInput < Struct.new(
+      :prepared_statement_names,
+      :work_group)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] prepared_statements
+    #   The list of prepared statements returned.
+    #   @return [Array<Types::PreparedStatement>]
+    #
+    # @!attribute [rw] unprocessed_prepared_statement_names
+    #   A list of one or more prepared statements that were requested but
+    #   could not be returned.
+    #   @return [Array<Types::UnprocessedPreparedStatementName>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetPreparedStatementOutput AWS API Documentation
+    #
+    class BatchGetPreparedStatementOutput < Struct.new(
+      :prepared_statements,
+      :unprocessed_prepared_statement_names)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass BatchGetQueryExecutionInput
     #   data as a hash:
     #
@@ -1837,6 +1880,12 @@ module Aws::Athena
     #   The engine version that executed the query.
     #   @return [Types::EngineVersion]
     #
+    # @!attribute [rw] execution_parameters
+    #   A list of values for the parameters in a query. The values are
+    #   applied sequentially to the parameters in the query in the order in
+    #   which the parameters occur.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecution AWS API Documentation
     #
     class QueryExecution < Struct.new(
@@ -1848,7 +1897,8 @@ module Aws::Athena
       :status,
       :statistics,
       :work_group,
-      :engine_version)
+      :engine_version,
+      :execution_parameters)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1999,6 +2049,7 @@ module Aws::Athena
     #   @return [String]
     #
     # @!attribute [rw] resource_name
+    #   The name of the Amazon resource.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResourceNotFoundException AWS API Documentation
@@ -2326,6 +2377,7 @@ module Aws::Athena
     #           },
     #         },
     #         work_group: "WorkGroupName",
+    #         execution_parameters: ["ExecutionParameter"],
     #       }
     #
     # @!attribute [rw] query_string
@@ -2367,6 +2419,12 @@ module Aws::Athena
     #   The name of the workgroup in which the query is being started.
     #   @return [String]
     #
+    # @!attribute [rw] execution_parameters
+    #   A list of values for the parameters in a query. The values are
+    #   applied sequentially to the parameters in the query in the order in
+    #   which the parameters occur.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecutionInput AWS API Documentation
     #
     class StartQueryExecutionInput < Struct.new(
@@ -2374,7 +2432,8 @@ module Aws::Athena
       :client_request_token,
       :query_execution_context,
       :result_configuration,
-      :work_group)
+      :work_group,
+      :execution_parameters)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2590,6 +2649,42 @@ module Aws::Athena
       include Aws::Structure
     end
 
+    # The name of a prepared statement that could not be returned.
+    #
+    # @!attribute [rw] statement_name
+    #   The name of a prepared statement that could not be returned due to
+    #   an error.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_code
+    #   The error code returned when the request for the prepared statement
+    #   failed.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   The error message containing the reason why the prepared statement
+    #   could not be returned. The following error messages are possible:
+    #
+    #   * `INVALID_INPUT` - The name of the prepared statement that was
+    #     provided is not valid (for example, the name is too long).
+    #
+    #   * `STATEMENT_NOT_FOUND` - A prepared statement with the name
+    #     provided could not be found.
+    #
+    #   * `UNAUTHORIZED` - The requester does not have permission to access
+    #     the workgroup that contains the prepared statement.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UnprocessedPreparedStatementName AWS API Documentation
+    #
+    class UnprocessedPreparedStatementName < Struct.new(
+      :statement_name,
+      :error_code,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Describes a query execution that failed to process.
     #
     # @!attribute [rw] query_execution_id

data/lib/aws-sdk-athena.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-athena
 version: !ruby/object:Gem::Version
-  version: 1.53.0
+  version: 1.54.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core