aws-sdk-redshiftdataapiservice 1.49.0 → 1.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6831e104286b1d71a71266a8c52f44fc019a83f61e1b0e7eb2563d4b32532988
-  data.tar.gz: c3b0ae48092b9a3d661555dff97adf3badc9a8f34e866b3c7ced643641c5f27f
+  metadata.gz: 7fd23c41311ad97cc826a966ec137c69536bf734d68cf84fe6b35e70ec40252d
+  data.tar.gz: e2d843226036ae6642cf07e672a12c13cd6dbdbbf46c9c6a2b55ce29a9c458ae
 SHA512:
-  metadata.gz: e037b889a3d2691b461064201b6087f79d053d606b543ecedf694712e96a56722103a592a1772df9e2b053fba2a8e55b234c9017649ef7c6827e9c868b82cdb3
-  data.tar.gz: 2197a89c234696514ddc4383dbc9c0a2293ed8dfe188c6cfd420c5ba73be1b8d1a3a03be0e4f03210d60b2a24652487f438a408e634fc57beb5eca184f62ac1a
+  metadata.gz: 210db61d786655c1405af71c5fcf45d5852bd5bd40403642574c1d966c45941a0ed9e43cf852d12f590653b31e0c814175c18f1d98822776e22a98331aae4d25
+  data.tar.gz: 0e807f962e59b98b3db1398620dc67e18de96982171d78075eee6773f81f9dc85ea35152edbaeaf2a79b5c2af55799dd033d54ca46da52c411e9c5cad6106fe6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.50.0 (2024-10-29)
+------------------
+
+* Feature - Adding a new API GetStatementResultV2 that supports CSV formatted results from ExecuteStatement and BatchExecuteStatement calls.
+
 1.49.0 (2024-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.49.0
+1.50.0

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

@@ -518,6 +518,10 @@ module Aws::RedshiftDataAPIService
     #   a cluster as a database user and authenticating using temporary
     #   credentials.
     #
+    # @option params [String] :result_format
+    #   The data format of the result of the SQL statement. If no format is
+    #   specified, the default is JSON.
+    #
     # @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.
@@ -569,6 +573,7 @@ module Aws::RedshiftDataAPIService
     #     cluster_identifier: "ClusterIdentifierString",
     #     database: "String",
     #     db_user: "String",
+    #     result_format: "JSON", # accepts JSON, CSV
     #     secret_arn: "SecretArn",
     #     session_id: "UUID",
     #     session_keep_alive_seconds: 1,
@@ -675,6 +680,7 @@ module Aws::RedshiftDataAPIService
     #   * {Types::DescribeStatementResponse#query_string #query_string} => String
     #   * {Types::DescribeStatementResponse#redshift_pid #redshift_pid} => Integer
     #   * {Types::DescribeStatementResponse#redshift_query_id #redshift_query_id} => Integer
+    #   * {Types::DescribeStatementResponse#result_format #result_format} => String
     #   * {Types::DescribeStatementResponse#result_rows #result_rows} => Integer
     #   * {Types::DescribeStatementResponse#result_size #result_size} => Integer
     #   * {Types::DescribeStatementResponse#secret_arn #secret_arn} => String
@@ -706,6 +712,7 @@ module Aws::RedshiftDataAPIService
     #   resp.query_string #=> String
     #   resp.redshift_pid #=> Integer
     #   resp.redshift_query_id #=> Integer
+    #   resp.result_format #=> String, one of "JSON", "CSV"
     #   resp.result_rows #=> Integer
     #   resp.result_size #=> Integer
     #   resp.secret_arn #=> String
@@ -946,6 +953,10 @@ module Aws::RedshiftDataAPIService
     # @option params [Array<Types::SqlParameter>] :parameters
     #   The parameters for the SQL statement.
     #
+    # @option params [String] :result_format
+    #   The data format of the result of the SQL statement. If no format is
+    #   specified, the default is JSON.
+    #
     # @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.
@@ -999,6 +1010,7 @@ module Aws::RedshiftDataAPIService
     #         value: "ParameterValue", # required
     #       },
     #     ],
+    #     result_format: "JSON", # accepts JSON, CSV
     #     secret_arn: "SecretArn",
     #     session_id: "UUID",
     #     session_keep_alive_seconds: 1,
@@ -1030,8 +1042,11 @@ module Aws::RedshiftDataAPIService
       req.send_request(options)
     end
 
-    # Fetches the temporarily cached result of an SQL statement. A token is
-    # returned to page through the statement results.
+    # Fetches the temporarily cached result of an SQL statement in JSON
+    # format. The `ExecuteStatement` or `BatchExecuteStatement` operation
+    # that ran the SQL statement must have specified `ResultFormat` as
+    # `JSON` , or let the format default to JSON. 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
@@ -1110,6 +1125,84 @@ module Aws::RedshiftDataAPIService
       req.send_request(options)
     end
 
+    # Fetches the temporarily cached result of an SQL statement in CSV
+    # format. The `ExecuteStatement` or `BatchExecuteStatement` operation
+    # that ran the SQL statement must have specified `ResultFormat` as
+    # `CSV`. 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
+    #   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
+    #   records in a subsequent request. If a value is returned in a response,
+    #   you can retrieve the next set of records by providing this returned
+    #   NextToken value in the next NextToken parameter and retrying the
+    #   command. If the NextToken field is empty, all response records have
+    #   been retrieved for the request.
+    #
+    # @return [Types::GetStatementResultV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetStatementResultV2Response#column_metadata #column_metadata} => Array&lt;Types::ColumnMetadata&gt;
+    #   * {Types::GetStatementResultV2Response#next_token #next_token} => String
+    #   * {Types::GetStatementResultV2Response#records #records} => Array&lt;Types::QueryRecords&gt;
+    #   * {Types::GetStatementResultV2Response#result_format #result_format} => String
+    #   * {Types::GetStatementResultV2Response#total_num_rows #total_num_rows} => Integer
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_statement_result_v2({
+    #     id: "UUID", # required
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.column_metadata #=> Array
+    #   resp.column_metadata[0].column_default #=> String
+    #   resp.column_metadata[0].is_case_sensitive #=> Boolean
+    #   resp.column_metadata[0].is_currency #=> Boolean
+    #   resp.column_metadata[0].is_signed #=> Boolean
+    #   resp.column_metadata[0].label #=> String
+    #   resp.column_metadata[0].length #=> Integer
+    #   resp.column_metadata[0].name #=> String
+    #   resp.column_metadata[0].nullable #=> Integer
+    #   resp.column_metadata[0].precision #=> Integer
+    #   resp.column_metadata[0].scale #=> Integer
+    #   resp.column_metadata[0].schema_name #=> String
+    #   resp.column_metadata[0].table_name #=> String
+    #   resp.column_metadata[0].type_name #=> String
+    #   resp.next_token #=> String
+    #   resp.records #=> Array
+    #   resp.records[0].csv_records #=> String
+    #   resp.result_format #=> String, one of "JSON", "CSV"
+    #   resp.total_num_rows #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2 AWS API Documentation
+    #
+    # @overload get_statement_result_v2(params = {})
+    # @param [Hash] params ({})
+    def get_statement_result_v2(params = {}, options = {})
+      req = build_request(:get_statement_result_v2, params)
+      req.send_request(options)
+    end
+
     # List the databases in a cluster. A token is returned to page through
     # the database list. Depending on the authorization method, use one of
     # the following combinations of request parameters:
@@ -1435,6 +1528,7 @@ module Aws::RedshiftDataAPIService
     #   resp.statements[0].query_string #=> String
     #   resp.statements[0].query_strings #=> Array
     #   resp.statements[0].query_strings[0] #=> String
+    #   resp.statements[0].result_format #=> String, one of "JSON", "CSV"
     #   resp.statements[0].secret_arn #=> String
     #   resp.statements[0].session_id #=> String
     #   resp.statements[0].statement_name #=> String
@@ -1610,7 +1704,7 @@ module Aws::RedshiftDataAPIService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
-      context[:gem_version] = '1.49.0'
+      context[:gem_version] = '1.50.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -43,8 +43,11 @@ module Aws::RedshiftDataAPIService
     ExecuteStatementOutput = Shapes::StructureShape.new(name: 'ExecuteStatementOutput')
     Field = Shapes::UnionShape.new(name: 'Field')
     FieldList = Shapes::ListShape.new(name: 'FieldList')
+    FormattedSqlRecords = Shapes::ListShape.new(name: 'FormattedSqlRecords')
     GetStatementResultRequest = Shapes::StructureShape.new(name: 'GetStatementResultRequest')
     GetStatementResultResponse = Shapes::StructureShape.new(name: 'GetStatementResultResponse')
+    GetStatementResultV2Request = Shapes::StructureShape.new(name: 'GetStatementResultV2Request')
+    GetStatementResultV2Response = Shapes::StructureShape.new(name: 'GetStatementResultV2Response')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     ListDatabasesRequest = Shapes::StructureShape.new(name: 'ListDatabasesRequest')
@@ -60,8 +63,10 @@ module Aws::RedshiftDataAPIService
     PageSize = Shapes::IntegerShape.new(name: 'PageSize')
     ParameterName = Shapes::StringShape.new(name: 'ParameterName')
     ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
+    QueryRecords = Shapes::UnionShape.new(name: 'QueryRecords')
     QueryTimeoutException = Shapes::StructureShape.new(name: 'QueryTimeoutException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    ResultFormatString = Shapes::StringShape.new(name: 'ResultFormatString')
     SchemaList = Shapes::ListShape.new(name: 'SchemaList')
     SecretArn = Shapes::StringShape.new(name: 'SecretArn')
     SessionAliveSeconds = Shapes::IntegerShape.new(name: 'SessionAliveSeconds')
@@ -101,6 +106,7 @@ module Aws::RedshiftDataAPIService
     BatchExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier"))
     BatchExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
     BatchExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
+    BatchExecuteStatementInput.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
     BatchExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
     BatchExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
     BatchExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds"))
@@ -168,6 +174,7 @@ module Aws::RedshiftDataAPIService
     DescribeStatementResponse.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString"))
     DescribeStatementResponse.add_member(:redshift_pid, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftPid"))
     DescribeStatementResponse.add_member(:redshift_query_id, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftQueryId"))
+    DescribeStatementResponse.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
     DescribeStatementResponse.add_member(:result_rows, Shapes::ShapeRef.new(shape: Long, location_name: "ResultRows"))
     DescribeStatementResponse.add_member(:result_size, Shapes::ShapeRef.new(shape: Long, location_name: "ResultSize"))
     DescribeStatementResponse.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
@@ -204,6 +211,7 @@ module Aws::RedshiftDataAPIService
     ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
     ExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
     ExecuteStatementInput.add_member(:parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "Parameters"))
+    ExecuteStatementInput.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
     ExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
     ExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
     ExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds"))
@@ -242,6 +250,8 @@ module Aws::RedshiftDataAPIService
 
     FieldList.member = Shapes::ShapeRef.new(shape: Field)
 
+    FormattedSqlRecords.member = Shapes::ShapeRef.new(shape: QueryRecords)
+
     GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
     GetStatementResultRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
     GetStatementResultRequest.struct_class = Types::GetStatementResultRequest
@@ -252,6 +262,17 @@ module Aws::RedshiftDataAPIService
     GetStatementResultResponse.add_member(:total_num_rows, Shapes::ShapeRef.new(shape: Long, location_name: "TotalNumRows"))
     GetStatementResultResponse.struct_class = Types::GetStatementResultResponse
 
+    GetStatementResultV2Request.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
+    GetStatementResultV2Request.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    GetStatementResultV2Request.struct_class = Types::GetStatementResultV2Request
+
+    GetStatementResultV2Response.add_member(:column_metadata, Shapes::ShapeRef.new(shape: ColumnMetadataList, location_name: "ColumnMetadata"))
+    GetStatementResultV2Response.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    GetStatementResultV2Response.add_member(:records, Shapes::ShapeRef.new(shape: FormattedSqlRecords, required: true, location_name: "Records"))
+    GetStatementResultV2Response.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
+    GetStatementResultV2Response.add_member(:total_num_rows, Shapes::ShapeRef.new(shape: Long, location_name: "TotalNumRows"))
+    GetStatementResultV2Response.struct_class = Types::GetStatementResultV2Response
+
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Message"))
     InternalServerException.struct_class = Types::InternalServerException
 
@@ -310,6 +331,12 @@ module Aws::RedshiftDataAPIService
     ListTablesResponse.add_member(:tables, Shapes::ShapeRef.new(shape: TableList, location_name: "Tables"))
     ListTablesResponse.struct_class = Types::ListTablesResponse
 
+    QueryRecords.add_member(:csv_records, Shapes::ShapeRef.new(shape: String, location_name: "CSVRecords"))
+    QueryRecords.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    QueryRecords.add_member_subclass(:csv_records, Types::QueryRecords::CsvRecords)
+    QueryRecords.add_member_subclass(:unknown, Types::QueryRecords::Unknown)
+    QueryRecords.struct_class = Types::QueryRecords
+
     QueryTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     QueryTimeoutException.struct_class = Types::QueryTimeoutException
 
@@ -335,6 +362,7 @@ module Aws::RedshiftDataAPIService
     StatementData.add_member(:query_parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "QueryParameters"))
     StatementData.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString"))
     StatementData.add_member(:query_strings, Shapes::ShapeRef.new(shape: StatementStringList, location_name: "QueryStrings"))
+    StatementData.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
     StatementData.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
     StatementData.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
     StatementData.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName"))
@@ -379,6 +407,7 @@ module Aws::RedshiftDataAPIService
 
       api.metadata = {
         "apiVersion" => "2019-12-20",
+        "auth" => ["aws.auth#sigv4"],
         "endpointPrefix" => "redshift-data",
         "jsonVersion" => "1.1",
         "protocol" => "json",
@@ -474,6 +503,22 @@ module Aws::RedshiftDataAPIService
         )
       end)
 
+      api.add_operation(:get_statement_result_v2, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetStatementResultV2"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetStatementResultV2Request)
+        o.output = Shapes::ShapeRef.new(shape: GetStatementResultV2Response)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_databases, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListDatabases"
         o.http_method = "POST"

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

@@ -81,6 +81,11 @@ module Aws::RedshiftDataAPIService
     #   credentials.
     #   @return [String]
     #
+    # @!attribute [rw] result_format
+    #   The data format of the result of the SQL statement. If no format is
+    #   specified, the default is JSON.
+    #   @return [String]
+    #
     # @!attribute [rw] secret_arn
     #   The name or ARN of the secret that enables access to the database.
     #   This parameter is required when authenticating using Secrets
@@ -131,6 +136,7 @@ module Aws::RedshiftDataAPIService
       :cluster_identifier,
       :database,
       :db_user,
+      :result_format,
       :secret_arn,
       :session_id,
       :session_keep_alive_seconds,
@@ -388,6 +394,10 @@ module Aws::RedshiftDataAPIService
     #   `STL_QUERY` system view.
     #   @return [Integer]
     #
+    # @!attribute [rw] result_format
+    #   The data format of the result of the SQL statement.
+    #   @return [String]
+    #
     # @!attribute [rw] result_rows
     #   Either the number of rows returned from the SQL statement or the
     #   number of rows affected. If result size is greater than zero, the
@@ -458,6 +468,7 @@ module Aws::RedshiftDataAPIService
       :query_string,
       :redshift_pid,
       :redshift_query_id,
+      :result_format,
       :result_rows,
       :result_size,
       :secret_arn,
@@ -626,6 +637,11 @@ module Aws::RedshiftDataAPIService
     #   The parameters for the SQL statement.
     #   @return [Array<Types::SqlParameter>]
     #
+    # @!attribute [rw] result_format
+    #   The data format of the result of the SQL statement. If no format is
+    #   specified, the default is JSON.
+    #   @return [String]
+    #
     # @!attribute [rw] secret_arn
     #   The name or ARN of the secret that enables access to the database.
     #   This parameter is required when authenticating using Secrets
@@ -672,6 +688,7 @@ module Aws::RedshiftDataAPIService
       :database,
       :db_user,
       :parameters,
+      :result_format,
       :secret_arn,
       :session_id,
       :session_keep_alive_seconds,
@@ -832,7 +849,7 @@ module Aws::RedshiftDataAPIService
     #   @return [String]
     #
     # @!attribute [rw] records
-    #   The results of the SQL statement.
+    #   The results of the SQL statement in JSON format.
     #   @return [Array<Array<Types::Field>>]
     #
     # @!attribute [rw] total_num_rows
@@ -852,6 +869,73 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
+    # @!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
+    #   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`.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A value that indicates the starting point for the next set of
+    #   response records in a subsequent request. If a value is returned in
+    #   a response, you can retrieve the next set of records by providing
+    #   this returned NextToken value in the next NextToken parameter and
+    #   retrying the command. If the NextToken field is empty, all response
+    #   records have been retrieved for the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2Request AWS API Documentation
+    #
+    class GetStatementResultV2Request < Struct.new(
+      :id,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] column_metadata
+    #   The properties (metadata) of a column.
+    #   @return [Array<Types::ColumnMetadata>]
+    #
+    # @!attribute [rw] next_token
+    #   A value that indicates the starting point for the next set of
+    #   response records in a subsequent request. If a value is returned in
+    #   a response, you can retrieve the next set of records by providing
+    #   this returned NextToken value in the next NextToken parameter and
+    #   retrying the command. If the NextToken field is empty, all response
+    #   records have been retrieved for the request.
+    #   @return [String]
+    #
+    # @!attribute [rw] records
+    #   The results of the SQL statement in CSV format.
+    #   @return [Array<Types::QueryRecords>]
+    #
+    # @!attribute [rw] result_format
+    #   The data format of the result of the SQL statement.
+    #   @return [String]
+    #
+    # @!attribute [rw] total_num_rows
+    #   The total number of rows in the result set returned from a query.
+    #   You can use this number to estimate the number of calls to the
+    #   `GetStatementResultV2` operation needed to page through the results.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2Response AWS API Documentation
+    #
+    class GetStatementResultV2Response < Struct.new(
+      :column_metadata,
+      :next_token,
+      :records,
+      :result_format,
+      :total_num_rows)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The Amazon Redshift Data API operation failed due to invalid input.
     #
     # @!attribute [rw] message
@@ -1240,6 +1324,27 @@ module Aws::RedshiftDataAPIService
       include Aws::Structure
     end
 
+    # The results of the SQL statement.
+    #
+    # @note QueryRecords is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of QueryRecords corresponding to the set member.
+    #
+    # @!attribute [rw] csv_records
+    #   The results of the SQL statement in CSV format.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/QueryRecords AWS API Documentation
+    #
+    class QueryRecords < Struct.new(
+      :csv_records,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class CsvRecords < QueryRecords; end
+      class Unknown < QueryRecords; end
+    end
+
     # The Amazon Redshift Data API operation failed due to timeout.
     #
     # @!attribute [rw] message
@@ -1327,6 +1432,10 @@ module Aws::RedshiftDataAPIService
     #   corresponds to one of the queries in a batch query request.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] result_format
+    #   The data format of the result of the SQL statement.
+    #   @return [String]
+    #
     # @!attribute [rw] secret_arn
     #   The name or Amazon Resource Name (ARN) of the secret that enables
     #   access to the database.
@@ -1359,6 +1468,7 @@ module Aws::RedshiftDataAPIService
       :query_parameters,
       :query_string,
       :query_strings,
+      :result_format,
       :secret_arn,
       :session_id,
       :statement_name,

data/lib/aws-sdk-redshiftdataapiservice.rb

@@ -54,7 +54,7 @@ module Aws::RedshiftDataAPIService
   autoload :EndpointProvider, 'aws-sdk-redshiftdataapiservice/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-redshiftdataapiservice/endpoints'
 
-  GEM_VERSION = '1.49.0'
+  GEM_VERSION = '1.50.0'
 
 end
 

data/sig/client.rbs

@@ -94,6 +94,7 @@ module Aws
                                      ?cluster_identifier: ::String,
                                      ?database: ::String,
                                      ?db_user: ::String,
+                                     ?result_format: ("JSON" | "CSV"),
                                      ?secret_arn: ::String,
                                      ?session_id: ::String,
                                      ?session_keep_alive_seconds: ::Integer,
@@ -127,6 +128,7 @@ module Aws
         def query_string: () -> ::String
         def redshift_pid: () -> ::Integer
         def redshift_query_id: () -> ::Integer
+        def result_format: () -> ("JSON" | "CSV")
         def result_rows: () -> ::Integer
         def result_size: () -> ::Integer
         def secret_arn: () -> ::String
@@ -187,6 +189,7 @@ module Aws
                                    value: ::String
                                  },
                                ],
+                               ?result_format: ("JSON" | "CSV"),
                                ?secret_arn: ::String,
                                ?session_id: ::String,
                                ?session_keep_alive_seconds: ::Integer,
@@ -211,6 +214,21 @@ module Aws
                                 ) -> _GetStatementResultResponseSuccess
                               | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStatementResultResponseSuccess
 
+      interface _GetStatementResultV2ResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetStatementResultV2Response]
+        def column_metadata: () -> ::Array[Types::ColumnMetadata]
+        def next_token: () -> ::String
+        def records: () -> ::Array[Types::QueryRecords]
+        def result_format: () -> ("JSON" | "CSV")
+        def total_num_rows: () -> ::Integer
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#get_statement_result_v2-instance_method
+      def get_statement_result_v2: (
+                                     id: ::String,
+                                     ?next_token: ::String
+                                   ) -> _GetStatementResultV2ResponseSuccess
+                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStatementResultV2ResponseSuccess
+
       interface _ListDatabasesResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListDatabasesResponse]
         def databases: () -> ::Array[::String]

data/sig/types.rbs

@@ -29,6 +29,7 @@ module Aws::RedshiftDataAPIService
       attr_accessor cluster_identifier: ::String
       attr_accessor database: ::String
       attr_accessor db_user: ::String
+      attr_accessor result_format: ("JSON" | "CSV")
       attr_accessor secret_arn: ::String
       attr_accessor session_id: ::String
       attr_accessor session_keep_alive_seconds: ::Integer
@@ -102,6 +103,7 @@ module Aws::RedshiftDataAPIService
       attr_accessor query_string: ::String
       attr_accessor redshift_pid: ::Integer
       attr_accessor redshift_query_id: ::Integer
+      attr_accessor result_format: ("JSON" | "CSV")
       attr_accessor result_rows: ::Integer
       attr_accessor result_size: ::Integer
       attr_accessor secret_arn: ::String
@@ -146,6 +148,7 @@ module Aws::RedshiftDataAPIService
       attr_accessor database: ::String
       attr_accessor db_user: ::String
       attr_accessor parameters: ::Array[Types::SqlParameter]
+      attr_accessor result_format: ("JSON" | "CSV")
       attr_accessor secret_arn: ::String
       attr_accessor session_id: ::String
       attr_accessor session_keep_alive_seconds: ::Integer
@@ -209,6 +212,21 @@ module Aws::RedshiftDataAPIService
       SENSITIVE: []
     end
 
+    class GetStatementResultV2Request
+      attr_accessor id: ::String
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class GetStatementResultV2Response
+      attr_accessor column_metadata: ::Array[Types::ColumnMetadata]
+      attr_accessor next_token: ::String
+      attr_accessor records: ::Array[Types::QueryRecords]
+      attr_accessor result_format: ("JSON" | "CSV")
+      attr_accessor total_num_rows: ::Integer
+      SENSITIVE: []
+    end
+
     class InternalServerException
       attr_accessor message: ::String
       SENSITIVE: []
@@ -285,6 +303,17 @@ module Aws::RedshiftDataAPIService
       SENSITIVE: []
     end
 
+    class QueryRecords
+      attr_accessor csv_records: ::String
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class CsvRecords < QueryRecords
+      end
+      class Unknown < QueryRecords
+      end
+    end
+
     class QueryTimeoutException
       attr_accessor message: ::String
       SENSITIVE: []
@@ -309,6 +338,7 @@ module Aws::RedshiftDataAPIService
       attr_accessor query_parameters: ::Array[Types::SqlParameter]
       attr_accessor query_string: ::String
       attr_accessor query_strings: ::Array[::String]
+      attr_accessor result_format: ("JSON" | "CSV")
       attr_accessor secret_arn: ::String
       attr_accessor session_id: ::String
       attr_accessor statement_name: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-redshiftdataapiservice
 version: !ruby/object:Gem::Version
-  version: 1.49.0
+  version: 1.50.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
 description: Official AWS Ruby gem for Redshift Data API Service. This gem is part
   of the AWS SDK for Ruby.
 email: