aws-sdk-redshiftdataapiservice 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e64f6f1fbd5d2851e4e9af309aa8c391149c073126b08f8285813cf07a707c0
-  data.tar.gz: 78b056c13630563f1fdf3f1985e14a578dddeca5a25618b0b1bd7556632f19d0
+  metadata.gz: e6c757a593b737ecc71e5f7bf9e98a618743a89f43bb5405ce41665b69f94a82
+  data.tar.gz: 4156423fe7e60ffe281ce21d10d4317ba990e42e7d133d4daf7e6ae93695fba5
 SHA512:
-  metadata.gz: 695645f2c10c7eb533bacb634f538f058dafbc7ab060565c72d9052df4558b5adb52d43b4d37621a3cc3f8e0aef9bf443399b0170ddf97e5aa13a86ff03aeb2a
-  data.tar.gz: 2c6e6e834417b47c2b207e17ab24f9c4b5156019b9dcb1e27892bad9c2ba4efcae35590a4951f8ee835064b294cfc788100d83e45c635d78971573ca6f48687d
+  metadata.gz: 98bd97ff6f0dfb056dd851b8ed7e68160f1856404e74cb11c81a2acaf02e9e41ad2bcf5ff9268790eb0b1aa953da4cac12df0251e00a2f46838aabc1f65fbba1
+  data.tar.gz: 98da868e069cf8a61fad52c132a1c66de7e0accee5cf2174c30e6694ce24046252322b01304d4b15602d95c76382c0c7e27147d98f03ba938ee23a310df971e7

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.23.0 (2022-12-14)
+------------------
+
+* Feature - This release adds a new --client-token field to ExecuteStatement and BatchExecuteStatement operations. Customers can now run queries with the additional client token parameter to ensures idempotency.
+
 1.22.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.22.0
+1.23.0

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

@@ -396,6 +396,21 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -414,7 +429,11 @@ module Aws::RedshiftDataAPIService
     #   This parameter is required when authenticating using Secrets Manager.
     #
     # @option params [required, Array<String>] :sqls
-    #   One or more SQL statements to run.
+    #   One or more SQL statements to run.      The SQL statements are run as
+    #   a single transaction. They run serially in the order of the array.
+    #   Subsequent SQL statements don't start until the previous statement in
+    #   the array completes. If any SQL statement fails, then because they are
+    #   run as one transaction, all work is rolled back.</p>
     #
     # @option params [String] :statement_name
     #   The name of the SQL statements. You can name the SQL statements when
@@ -442,6 +461,7 @@ module Aws::RedshiftDataAPIService
     # @example Request syntax with placeholder values
     #
     #   resp = client.batch_execute_statement({
+    #     client_token: "ClientToken",
     #     cluster_identifier: "Location",
     #     database: "String", # required
     #     db_user: "String",
@@ -473,6 +493,14 @@ module Aws::RedshiftDataAPIService
 
     # Cancels a running query. To be canceled, a query must be running.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @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
@@ -507,6 +535,14 @@ module Aws::RedshiftDataAPIService
     # query started, when it finished, the query status, the number of rows
     # returned, and the SQL statement.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @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
@@ -606,6 +642,14 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -724,6 +768,21 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -773,6 +832,7 @@ module Aws::RedshiftDataAPIService
     # @example Request syntax with placeholder values
     #
     #   resp = client.execute_statement({
+    #     client_token: "ClientToken",
     #     cluster_identifier: "Location",
     #     database: "String", # required
     #     db_user: "String",
@@ -811,6 +871,14 @@ module Aws::RedshiftDataAPIService
     # Fetches the temporarily cached result of an SQL statement. A token is
     # returned to page through the statement results.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @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
@@ -897,6 +965,14 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -983,6 +1059,14 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -1068,6 +1152,14 @@ module Aws::RedshiftDataAPIService
     # List of SQL statements. By default, only finished statements are
     # shown. A token is returned to page through the statement list.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @option params [Integer] :max_results
     #   The maximum number of SQL statements to return in the response. If
     #   more SQL statements exist than fit in one response, then `NextToken`
@@ -1178,6 +1270,14 @@ module Aws::RedshiftDataAPIService
     #   specify the workgroup name and database name. Also, permission to
     #   call the `redshift-serverless:GetCredentials` operation is required.
     #
+    # For more information about the Amazon Redshift Data API and CLI usage
+    # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
+    # Redshift Management Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
+    #
     # @option params [String] :cluster_identifier
     #   The cluster identifier. This parameter is required when connecting to
     #   a cluster and authenticating using either Secrets Manager or temporary
@@ -1288,7 +1388,7 @@ module Aws::RedshiftDataAPIService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -24,6 +24,7 @@ module Aws::RedshiftDataAPIService
     BoxedLong = Shapes::IntegerShape.new(name: 'BoxedLong')
     CancelStatementRequest = Shapes::StructureShape.new(name: 'CancelStatementRequest')
     CancelStatementResponse = Shapes::StructureShape.new(name: 'CancelStatementResponse')
+    ClientToken = Shapes::StringShape.new(name: 'ClientToken')
     ColumnList = Shapes::ListShape.new(name: 'ColumnList')
     ColumnMetadata = Shapes::StructureShape.new(name: 'ColumnMetadata')
     ColumnMetadataList = Shapes::ListShape.new(name: 'ColumnMetadataList')
@@ -88,6 +89,7 @@ module Aws::RedshiftDataAPIService
     BatchExecuteStatementException.add_member(:statement_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "StatementId"))
     BatchExecuteStatementException.struct_class = Types::BatchExecuteStatementException
 
+    BatchExecuteStatementInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
     BatchExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier"))
     BatchExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
     BatchExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
@@ -182,6 +184,7 @@ module Aws::RedshiftDataAPIService
     ExecuteStatementException.add_member(:statement_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "StatementId"))
     ExecuteStatementException.struct_class = Types::ExecuteStatementException
 
+    ExecuteStatementInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
     ExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier"))
     ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
     ExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))

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

@@ -41,19 +41,13 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass BatchExecuteStatementInput
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         secret_arn: "SecretArn",
-    #         sqls: ["StatementString"], # required
-    #         statement_name: "StatementNameString",
-    #         with_event: false,
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
     #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
@@ -79,7 +73,12 @@ module Aws::RedshiftDataAPIService
     #   @return [String]
     #
     # @!attribute [rw] sqls
-    #   One or more SQL statements to run.
+    #   One or more SQL statements to run.      The SQL statements are run
+    #   as a single transaction. They run serially in the order of the
+    #   array. Subsequent SQL statements don't start until the previous
+    #   statement in the array completes. If any SQL statement fails, then
+    #   because they are run as one transaction, all work is rolled
+    #   back.</p>
     #   @return [Array<String>]
     #
     # @!attribute [rw] statement_name
@@ -101,6 +100,7 @@ module Aws::RedshiftDataAPIService
     # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementInput AWS API Documentation
     #
     class BatchExecuteStatementInput < Struct.new(
+      :client_token,
       :cluster_identifier,
       :database,
       :db_user,
@@ -160,13 +160,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass CancelStatementRequest
-    #   data as a hash:
-    #
-    #       {
-    #         id: "StatementId", # required
-    #       }
-    #
     # @!attribute [rw] id
     #   The identifier of the SQL statement to cancel. This value is a
     #   universally unique identifier (UUID) generated by Amazon Redshift
@@ -283,13 +276,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass DescribeStatementRequest
-    #   data as a hash:
-    #
-    #       {
-    #         id: "StatementId", # required
-    #       }
-    #
     # @!attribute [rw] id
     #   The identifier of the SQL statement to describe. This value is a
     #   universally unique identifier (UUID) generated by Amazon Redshift
@@ -440,22 +426,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass DescribeTableRequest
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         connected_database: "String",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         max_results: 1,
-    #         next_token: "String",
-    #         schema: "String",
-    #         secret_arn: "SecretArn",
-    #         table: "String",
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
-    #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
     #   to a cluster and authenticating using either Secrets Manager or
@@ -580,25 +550,13 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ExecuteStatementInput
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         parameters: [
-    #           {
-    #             name: "ParameterName", # required
-    #             value: "ParameterValue", # required
-    #           },
-    #         ],
-    #         secret_arn: "SecretArn",
-    #         sql: "StatementString", # required
-    #         statement_name: "StatementNameString",
-    #         with_event: false,
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
     #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
@@ -650,6 +608,7 @@ module Aws::RedshiftDataAPIService
     # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementInput AWS API Documentation
     #
     class ExecuteStatementInput < Struct.new(
+      :client_token,
       :cluster_identifier,
       :database,
       :db_user,
@@ -760,14 +719,6 @@ module Aws::RedshiftDataAPIService
       class Unknown < Field; end
     end
 
-    # @note When making an API call, you may pass GetStatementResultRequest
-    #   data as a hash:
-    #
-    #       {
-    #         id: "StatementId", # required
-    #         next_token: "String",
-    #       }
-    #
     # @!attribute [rw] id
     #   The identifier of the SQL statement whose results are to be fetched.
     #   This value is a universally unique identifier (UUID) generated by
@@ -844,19 +795,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListDatabasesRequest
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         max_results: 1,
-    #         next_token: "String",
-    #         secret_arn: "SecretArn",
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
-    #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
     #   to a cluster and authenticating using either Secrets Manager or
@@ -937,21 +875,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListSchemasRequest
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         connected_database: "String",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         max_results: 1,
-    #         next_token: "String",
-    #         schema_pattern: "String",
-    #         secret_arn: "SecretArn",
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
-    #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
     #   to a cluster and authenticating using either Secrets Manager or
@@ -1046,17 +969,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListStatementsRequest
-    #   data as a hash:
-    #
-    #       {
-    #         max_results: 1,
-    #         next_token: "String",
-    #         role_level: false,
-    #         statement_name: "StatementNameString",
-    #         status: "SUBMITTED", # accepts SUBMITTED, PICKED, STARTED, FINISHED, ABORTED, FAILED, ALL
-    #       }
-    #
     # @!attribute [rw] max_results
     #   The maximum number of SQL statements to return in the response. If
     #   more SQL statements exist than fit in one response, then `NextToken`
@@ -1143,22 +1055,6 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListTablesRequest
-    #   data as a hash:
-    #
-    #       {
-    #         cluster_identifier: "Location",
-    #         connected_database: "String",
-    #         database: "String", # required
-    #         db_user: "String",
-    #         max_results: 1,
-    #         next_token: "String",
-    #         schema_pattern: "String",
-    #         secret_arn: "SecretArn",
-    #         table_pattern: "String",
-    #         workgroup_name: "WorkgroupNameString",
-    #       }
-    #
     # @!attribute [rw] cluster_identifier
     #   The cluster identifier. This parameter is required when connecting
     #   to a cluster and authenticating using either Secrets Manager or
@@ -1289,21 +1185,13 @@ module Aws::RedshiftDataAPIService
 
     # A parameter used in a SQL statement.
     #
-    # @note When making an API call, you may pass SqlParameter
-    #   data as a hash:
-    #
-    #       {
-    #         name: "ParameterName", # required
-    #         value: "ParameterValue", # required
-    #       }
-    #
     # @!attribute [rw] name
     #   The name of the parameter.
     #   @return [String]
     #
     # @!attribute [rw] value
     #   The value of the parameter. Amazon Redshift implicitly converts to
-    #   the proper data type. For more inforation, see [Data types][1] in
+    #   the proper data type. For more information, see [Data types][1] in
     #   the *Amazon Redshift Database Developer Guide*.
     #
     #

data/lib/aws-sdk-redshiftdataapiservice.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
 # @!group service
 module Aws::RedshiftDataAPIService
 
-  GEM_VERSION = '1.22.0'
+  GEM_VERSION = '1.23.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-redshiftdataapiservice
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core