aws-sdk-redshiftdataapiservice 1.6.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db757f2e1e55d2dfdc2b9870ffa0e6f7578b531ccb7dedd5f17c99cee6ed1261
-  data.tar.gz: cae17742ef8294622a038f2fcad37ab503340d46fcab447c91b4f848529b79ac
+  metadata.gz: ec22576cf3897780d8b172d1ac51c1df296eaf7122f2b2992fd1e33bb9bc1929
+  data.tar.gz: 958252c335bc2bb2b742ea46b1b13cc40ccba47139132be27c7b274af915bd10
 SHA512:
-  metadata.gz: addb578b4de8100d0c60576adfb63f38708c475ac8d8e2504d11f48aa598c191f9c997de2410a03456b0ae82244cea54964d2e2a63a4447e529fa97a753c1994
-  data.tar.gz: 76860b18b8c8a43f3e9ff8a4d770b5e70cb1b6962a516a0fec4d2446be2c04459e32b4dabbaabedf9eef06e365e39ae9672b9a24f57757c2a6e34125596987d9
+  metadata.gz: f60bf6d2a98a635a30ed95b090b13a55ca32623d14dbb45e6d4d7158900b5af09b85a5b5f8db286031d7d775cbc656756214be926ade36d21f1d9b2a261ae17b
+  data.tar.gz: d5eab0a71e63857a61903c0a680531f207c5c98824ba6bf10e4d0400be34641a5962323d9f378e3a9b5a81cd4a948f843581f02ed9f48c90f1a77d2460fabad2

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.10.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.9.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.8.0 (2021-07-27)
+------------------
+
+* Feature - Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction.
+
+1.7.0 (2021-06-15)
+------------------
+
+* Feature - Redshift Data API service now supports SQL parameterization.
+
 1.6.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.10.0

data/lib/aws-sdk-redshiftdataapiservice.rb

@@ -28,7 +28,7 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
 # structure.
 #
 #     redshift_data_api_service = Aws::RedshiftDataAPIService::Client.new
-#     resp = redshift_data_api_service.cancel_statement(params)
+#     resp = redshift_data_api_service.batch_execute_statement(params)
 #
 # See {Client} for more information.
 #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
 # @!group service
 module Aws::RedshiftDataAPIService
 
-  GEM_VERSION = '1.6.0'
+  GEM_VERSION = '1.10.0'
 
 end

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

@@ -337,13 +337,93 @@ module Aws::RedshiftDataAPIService
 
     # @!group API Operations
 
+    # Runs one or more SQL statements, which can be data manipulation
+    # language (DML) or data definition language (DDL). Depending on the
+    # authorization method, use one of the following combinations of request
+    # parameters:
+    #
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
+    #
+    # * Temporary credentials - specify the cluster identifier, the database
+    #   name, and the database user name. Permission to call the
+    #   `redshift:GetClusterCredentials` operation is required to use this
+    #   method.
+    #
+    # @option params [required, String] :cluster_identifier
+    #   The cluster identifier. This parameter is required when authenticating
+    #   using either Secrets Manager or temporary credentials.
+    #
+    # @option params [required, String] :database
+    #   The name of the database. This parameter is required when
+    #   authenticating using either Secrets Manager or temporary credentials.
+    #
+    # @option params [String] :db_user
+    #   The database user name. This parameter is required when authenticating
+    #   using temporary credentials.
+    #
+    # @option params [String] :secret_arn
+    #   The name or ARN of the secret that enables access to the database.
+    #   This parameter is required when authenticating using Secrets Manager.
+    #
+    # @option params [required, Array<String>] :sqls
+    #   One or more SQL statements to run.
+    #
+    # @option params [String] :statement_name
+    #   The name of the SQL statements. You can name the SQL statements when
+    #   you create them to identify the query.
+    #
+    # @option params [Boolean] :with_event
+    #   A value that indicates whether to send an event to the Amazon
+    #   EventBridge event bus after the SQL statements run.
+    #
+    # @return [Types::BatchExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchExecuteStatementOutput#cluster_identifier #cluster_identifier} => String
+    #   * {Types::BatchExecuteStatementOutput#created_at #created_at} => Time
+    #   * {Types::BatchExecuteStatementOutput#database #database} => String
+    #   * {Types::BatchExecuteStatementOutput#db_user #db_user} => String
+    #   * {Types::BatchExecuteStatementOutput#id #id} => String
+    #   * {Types::BatchExecuteStatementOutput#secret_arn #secret_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_execute_statement({
+    #     cluster_identifier: "Location", # required
+    #     database: "String", # required
+    #     db_user: "String",
+    #     secret_arn: "SecretArn",
+    #     sqls: ["StatementString"], # required
+    #     statement_name: "StatementNameString",
+    #     with_event: false,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.cluster_identifier #=> String
+    #   resp.created_at #=> Time
+    #   resp.database #=> String
+    #   resp.db_user #=> String
+    #   resp.id #=> String
+    #   resp.secret_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement AWS API Documentation
+    #
+    # @overload batch_execute_statement(params = {})
+    # @param [Hash] params ({})
+    def batch_execute_statement(params = {}, options = {})
+      req = build_request(:batch_execute_statement, params)
+      req.send_request(options)
+    end
+
     # Cancels a running query. To be canceled, a query must be running.
     #
     # @option params [required, String] :id
     #   The identifier of the SQL statement to cancel. This value is a
     #   universally unique identifier (UUID) generated by Amazon Redshift Data
-    #   API. This identifier is returned by `ExecuteStatment` and
-    #   `ListStatements`.
+    #   API. This identifier is returned by `BatchExecuteStatment`,
+    #   `ExecuteStatment`, and `ListStatements`.
     #
     # @return [Types::CancelStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -352,7 +432,7 @@ module Aws::RedshiftDataAPIService
     # @example Request syntax with placeholder values
     #
     #   resp = client.cancel_statement({
-    #     id: "UUID", # required
+    #     id: "StatementId", # required
     #   })
     #
     # @example Response structure
@@ -376,7 +456,10 @@ module Aws::RedshiftDataAPIService
     # @option params [required, String] :id
     #   The identifier of the SQL statement to describe. This value is a
     #   universally unique identifier (UUID) generated by Amazon Redshift Data
-    #   API. This identifier is returned by `ExecuteStatment` and
+    #   API. A suffix indicates the number of the SQL statement. For example,
+    #   `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that
+    #   indicates the second SQL statement of a batch query. This identifier
+    #   is returned by `BatchExecuteStatment`, `ExecuteStatement`, and
     #   `ListStatements`.
     #
     # @return [Types::DescribeStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -389,6 +472,7 @@ module Aws::RedshiftDataAPIService
     #   * {Types::DescribeStatementResponse#error #error} => String
     #   * {Types::DescribeStatementResponse#has_result_set #has_result_set} => Boolean
     #   * {Types::DescribeStatementResponse#id #id} => String
+    #   * {Types::DescribeStatementResponse#query_parameters #query_parameters} => Array&lt;Types::SqlParameter&gt;
     #   * {Types::DescribeStatementResponse#query_string #query_string} => String
     #   * {Types::DescribeStatementResponse#redshift_pid #redshift_pid} => Integer
     #   * {Types::DescribeStatementResponse#redshift_query_id #redshift_query_id} => Integer
@@ -396,12 +480,13 @@ module Aws::RedshiftDataAPIService
     #   * {Types::DescribeStatementResponse#result_size #result_size} => Integer
     #   * {Types::DescribeStatementResponse#secret_arn #secret_arn} => String
     #   * {Types::DescribeStatementResponse#status #status} => String
+    #   * {Types::DescribeStatementResponse#sub_statements #sub_statements} => Array&lt;Types::SubStatementData&gt;
     #   * {Types::DescribeStatementResponse#updated_at #updated_at} => Time
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_statement({
-    #     id: "UUID", # required
+    #     id: "StatementId", # required
     #   })
     #
     # @example Response structure
@@ -414,6 +499,9 @@ module Aws::RedshiftDataAPIService
     #   resp.error #=> String
     #   resp.has_result_set #=> Boolean
     #   resp.id #=> String
+    #   resp.query_parameters #=> Array
+    #   resp.query_parameters[0].name #=> String
+    #   resp.query_parameters[0].value #=> String
     #   resp.query_string #=> String
     #   resp.redshift_pid #=> Integer
     #   resp.redshift_query_id #=> Integer
@@ -421,6 +509,18 @@ module Aws::RedshiftDataAPIService
     #   resp.result_size #=> Integer
     #   resp.secret_arn #=> String
     #   resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
+    #   resp.sub_statements #=> Array
+    #   resp.sub_statements[0].created_at #=> Time
+    #   resp.sub_statements[0].duration #=> Integer
+    #   resp.sub_statements[0].error #=> String
+    #   resp.sub_statements[0].has_result_set #=> Boolean
+    #   resp.sub_statements[0].id #=> String
+    #   resp.sub_statements[0].query_string #=> String
+    #   resp.sub_statements[0].redshift_query_id #=> Integer
+    #   resp.sub_statements[0].result_rows #=> Integer
+    #   resp.sub_statements[0].result_size #=> Integer
+    #   resp.sub_statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
+    #   resp.sub_statements[0].updated_at #=> Time
     #   resp.updated_at #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement AWS API Documentation
@@ -437,9 +537,9 @@ module Aws::RedshiftDataAPIService
     # page through the column list. Depending on the authorization method,
     # use one of the following combinations of request parameters:
     #
-    # * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the
-    #   secret and the cluster identifier that matches the cluster in the
-    #   secret.
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
     #
     # * Temporary credentials - specify the cluster identifier, the database
     #   name, and the database user name. Permission to call the
@@ -448,7 +548,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [required, String] :cluster_identifier
     #   The cluster identifier. This parameter is required when authenticating
-    #   using either AWS Secrets Manager or temporary credentials.
+    #   using either Secrets Manager or temporary credentials.
     #
     # @option params [String] :connected_database
     #   A database name. The connected database is specified when you connect
@@ -482,8 +582,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
-    #   This parameter is required when authenticating using AWS Secrets
-    #   Manager.
+    #   This parameter is required when authenticating using Secrets Manager.
     #
     # @option params [String] :table
     #   The table name. If no table is specified, then all tables for all
@@ -545,9 +644,9 @@ module Aws::RedshiftDataAPIService
     # statement. Depending on the authorization method, use one of the
     # following combinations of request parameters:
     #
-    # * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the
-    #   secret and the cluster identifier that matches the cluster in the
-    #   secret.
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
     #
     # * Temporary credentials - specify the cluster identifier, the database
     #   name, and the database user name. Permission to call the
@@ -556,20 +655,22 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [required, String] :cluster_identifier
     #   The cluster identifier. This parameter is required when authenticating
-    #   using either AWS Secrets Manager or temporary credentials.
+    #   using either Secrets Manager or temporary credentials.
     #
-    # @option params [String] :database
+    # @option params [required, String] :database
     #   The name of the database. This parameter is required when
-    #   authenticating using temporary credentials.
+    #   authenticating using either Secrets Manager or temporary credentials.
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when authenticating
     #   using temporary credentials.
     #
+    # @option params [Array<Types::SqlParameter>] :parameters
+    #   The parameters for the SQL statement.
+    #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
-    #   This parameter is required when authenticating using AWS Secrets
-    #   Manager.
+    #   This parameter is required when authenticating using Secrets Manager.
     #
     # @option params [required, String] :sql
     #   The SQL statement text to run.
@@ -595,8 +696,14 @@ module Aws::RedshiftDataAPIService
     #
     #   resp = client.execute_statement({
     #     cluster_identifier: "Location", # required
-    #     database: "String",
+    #     database: "String", # required
     #     db_user: "String",
+    #     parameters: [
+    #       {
+    #         name: "ParameterName", # required
+    #         value: "ParameterValue", # required
+    #       },
+    #     ],
     #     secret_arn: "SecretArn",
     #     sql: "StatementString", # required
     #     statement_name: "StatementNameString",
@@ -627,8 +734,11 @@ module Aws::RedshiftDataAPIService
     # @option params [required, String] :id
     #   The identifier of the SQL statement whose results are to be fetched.
     #   This value is a universally unique identifier (UUID) generated by
-    #   Amazon Redshift Data API. This identifier is returned by
-    #   `ExecuteStatment` and `ListStatements`.
+    #   Amazon Redshift Data API. A suffix indicates then number of the SQL
+    #   statement. For example, `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a
+    #   suffix of `:2` that indicates the second SQL statement of a batch
+    #   query. This identifier is returned by `BatchExecuteStatment`,
+    #   `ExecuteStatment`, and `ListStatements`.
     #
     # @option params [String] :next_token
     #   A value that indicates the starting point for the next set of response
@@ -650,7 +760,7 @@ module Aws::RedshiftDataAPIService
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_statement_result({
-    #     id: "UUID", # required
+    #     id: "StatementId", # required
     #     next_token: "String",
     #   })
     #
@@ -694,9 +804,9 @@ module Aws::RedshiftDataAPIService
     # the database list. Depending on the authorization method, use one of
     # the following combinations of request parameters:
     #
-    # * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the
-    #   secret and the cluster identifier that matches the cluster in the
-    #   secret.
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
     #
     # * Temporary credentials - specify the cluster identifier, the database
     #   name, and the database user name. Permission to call the
@@ -705,11 +815,11 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [required, String] :cluster_identifier
     #   The cluster identifier. This parameter is required when authenticating
-    #   using either AWS Secrets Manager or temporary credentials.
+    #   using either Secrets Manager or temporary credentials.
     #
-    # @option params [String] :database
+    # @option params [required, String] :database
     #   The name of the database. This parameter is required when
-    #   authenticating using temporary credentials.
+    #   authenticating using either Secrets Manager or temporary credentials.
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when authenticating
@@ -730,8 +840,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
-    #   This parameter is required when authenticating using AWS Secrets
-    #   Manager.
+    #   This parameter is required when authenticating using Secrets Manager.
     #
     # @return [Types::ListDatabasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -744,7 +853,7 @@ module Aws::RedshiftDataAPIService
     #
     #   resp = client.list_databases({
     #     cluster_identifier: "Location", # required
-    #     database: "String",
+    #     database: "String", # required
     #     db_user: "String",
     #     max_results: 1,
     #     next_token: "String",
@@ -770,9 +879,9 @@ module Aws::RedshiftDataAPIService
     # the schema list. Depending on the authorization method, use one of the
     # following combinations of request parameters:
     #
-    # * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the
-    #   secret and the cluster identifier that matches the cluster in the
-    #   secret.
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
     #
     # * Temporary credentials - specify the cluster identifier, the database
     #   name, and the database user name. Permission to call the
@@ -781,7 +890,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [required, String] :cluster_identifier
     #   The cluster identifier. This parameter is required when authenticating
-    #   using either AWS Secrets Manager or temporary credentials.
+    #   using either Secrets Manager or temporary credentials.
     #
     # @option params [String] :connected_database
     #   A database name. The connected database is specified when you connect
@@ -817,8 +926,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
-    #   This parameter is required when authenticating using AWS Secrets
-    #   Manager.
+    #   This parameter is required when authenticating using Secrets Manager.
     #
     # @return [Types::ListSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -878,12 +986,13 @@ module Aws::RedshiftDataAPIService
     #   IAM session are returned. The default is true.
     #
     # @option params [String] :statement_name
-    #   The name of the SQL statement specified as input to `ExecuteStatement`
-    #   to identify the query. You can list multiple statements by providing a
-    #   prefix that matches the beginning of the statement name. For example,
-    #   to list myStatement1, myStatement2, myStatement3, and so on, then
-    #   provide the a value of `myStatement`. Data API does a case-sensitive
-    #   match of SQL statement names to the prefix value you provide.
+    #   The name of the SQL statement specified as input to
+    #   `BatchExecuteStatement` or `ExecuteStatement` to identify the query.
+    #   You can list multiple statements by providing a prefix that matches
+    #   the beginning of the statement name. For example, to list
+    #   myStatement1, myStatement2, myStatement3, and so on, then provide the
+    #   a value of `myStatement`. Data API does a case-sensitive match of SQL
+    #   statement names to the prefix value you provide.
     #
     # @option params [String] :status
     #   The status of the SQL statement to list. Status values are defined as
@@ -927,7 +1036,13 @@ module Aws::RedshiftDataAPIService
     #   resp.statements #=> Array
     #   resp.statements[0].created_at #=> Time
     #   resp.statements[0].id #=> String
+    #   resp.statements[0].is_batch_statement #=> Boolean
+    #   resp.statements[0].query_parameters #=> Array
+    #   resp.statements[0].query_parameters[0].name #=> String
+    #   resp.statements[0].query_parameters[0].value #=> String
     #   resp.statements[0].query_string #=> String
+    #   resp.statements[0].query_strings #=> Array
+    #   resp.statements[0].query_strings[0] #=> String
     #   resp.statements[0].secret_arn #=> String
     #   resp.statements[0].statement_name #=> String
     #   resp.statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
@@ -948,9 +1063,9 @@ module Aws::RedshiftDataAPIService
     # Depending on the authorization method, use one of the following
     # combinations of request parameters:
     #
-    # * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the
-    #   secret and the cluster identifier that matches the cluster in the
-    #   secret.
+    # * Secrets Manager - specify the Amazon Resource Name (ARN) of the
+    #   secret, the database name, and the cluster identifier that matches
+    #   the cluster in the secret.
     #
     # * Temporary credentials - specify the cluster identifier, the database
     #   name, and the database user name. Permission to call the
@@ -959,7 +1074,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [required, String] :cluster_identifier
     #   The cluster identifier. This parameter is required when authenticating
-    #   using either AWS Secrets Manager or temporary credentials.
+    #   using either Secrets Manager or temporary credentials.
     #
     # @option params [String] :connected_database
     #   A database name. The connected database is specified when you connect
@@ -998,8 +1113,7 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
-    #   This parameter is required when authenticating using AWS Secrets
-    #   Manager.
+    #   This parameter is required when authenticating using Secrets Manager.
     #
     # @option params [String] :table_pattern
     #   A pattern to filter results by table name. Within a table pattern,
@@ -1061,7 +1175,7 @@ module Aws::RedshiftDataAPIService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
-      context[:gem_version] = '1.6.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end