aws-sdk-rdsdataservice 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1375e9c259d0ef50feb469e26f9f60248e31fc1e880c92a597d1032f87e134b
-  data.tar.gz: ca1be1bc69af456655b8da0ff9f9ecaca974abffac5e2cf503088baa0c95d9d8
+  metadata.gz: 6b18cfee3b55ebf273e66c488b4b927b02f7fc0823825bde48bcc4656a080853
+  data.tar.gz: dc5eaede4e2c821e719bd71cd517e46d1cacd1f302af063ae9d7f3446b19886d
 SHA512:
-  metadata.gz: 8c24c2c3ad8302a40e88fb8a13c16584f341103566d3dea88e3b713457b1691152644760057f91cc6d80e9c35e312c53c4c13ad4ae9451d6b7f6ee0f00e64236
-  data.tar.gz: 51ee8608ccdf553fcefe88f12d4f34b4117d59a0ce8abe500978cfa7df17e0da204b9b8ccbc0f61cdd54eedbadc791aec9be64d0a148a65f8777a215dca0c0af
+  metadata.gz: 4b28867ed86d5e9992064439278f38cb759c7e62ededf8cbad4411b86004c76a1311f1a62a696cacb66722572934a2ac300cfa4d81adab886f2302e7f9c73522
+  data.tar.gz: e86e103e4a852ccce205e27e3ca0f68189ded1e8797e9fd2d5e5585e584c0b6823b3f38ec7c9ddb22b7a5f8697731ed0be72fd70d9ed94fab3902083054dfc71

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.35.0 (2022-04-25)
+------------------
+
+* Feature - Support to receive SQL query results in the form of a simplified JSON string. This enables developers using the new JSON string format to more easily convert it to an object using popular JSON string parsing libraries.
+
 1.34.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.35.0

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

@@ -641,8 +641,8 @@ module Aws::RDSDataService
     # `transactionID` parameter, changes that result from the call are
     # committed automatically.
     #
-    # The response size limit is 1 MB. If the call returns more than 1 MB of
-    # response data, the call is terminated.
+    # If the binary response data from the database is more than 1 MB, the
+    # call is terminated.
     #
     # @option params [Boolean] :continue_after_timeout
     #   A value that indicates whether to continue running the statement after
@@ -657,6 +657,20 @@ module Aws::RDSDataService
     # @option params [String] :database
     #   The name of the database.
     #
+    # @option params [String] :format_records_as
+    #   A value that indicates whether to format the result set as a single
+    #   JSON string. This parameter only applies to `SELECT` statements and is
+    #   ignored for other types of statements. Allowed values are `NONE` and
+    #   `JSON`. The default value is `NONE`. The result is returned in the
+    #   `formattedRecords` field.
+    #
+    #   For usage information about the JSON format for result sets, see
+    #   [Using the Data API][1] in the *Amazon Aurora User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
+    #
     # @option params [Boolean] :include_result_metadata
     #   A value that indicates whether to include metadata in the results.
     #
@@ -697,6 +711,7 @@ module Aws::RDSDataService
     # @return [Types::ExecuteStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ExecuteStatementResponse#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
+    #   * {Types::ExecuteStatementResponse#formatted_records #formatted_records} => String
     #   * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array<Types::Field>
     #   * {Types::ExecuteStatementResponse#number_of_records_updated #number_of_records_updated} => Integer
     #   * {Types::ExecuteStatementResponse#records #records} => Array<Array<Types::Field>>
@@ -706,6 +721,7 @@ module Aws::RDSDataService
     #   resp = client.execute_statement({
     #     continue_after_timeout: false,
     #     database: "DbName",
+    #     format_records_as: "NONE", # accepts NONE, JSON
     #     include_result_metadata: false,
     #     parameters: [
     #       {
@@ -735,6 +751,7 @@ module Aws::RDSDataService
     #     resource_arn: "Arn", # required
     #     result_set_options: {
     #       decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
+    #       long_return_type: "STRING", # accepts STRING, LONG
     #     },
     #     schema: "DbName",
     #     secret_arn: "Arn", # required
@@ -759,6 +776,7 @@ module Aws::RDSDataService
     #   resp.column_metadata[0].table_name #=> String
     #   resp.column_metadata[0].type #=> Integer
     #   resp.column_metadata[0].type_name #=> String
+    #   resp.formatted_records #=> String
     #   resp.generated_fields #=> Array
     #   resp.generated_fields[0].array_value.array_values #=> Array
     #   resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
@@ -855,7 +873,7 @@ module Aws::RDSDataService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rdsdataservice'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -13,6 +13,7 @@ module Aws::RDSDataService
 
     include Seahorse::Model
 
+    AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     Arn = Shapes::StringShape.new(name: 'Arn')
     ArrayOfArray = Shapes::ListShape.new(name: 'ArrayOfArray')
     ArrayValue = Shapes::UnionShape.new(name: 'ArrayValue')
@@ -44,16 +45,19 @@ module Aws::RDSDataService
     Field = Shapes::UnionShape.new(name: 'Field')
     FieldList = Shapes::ListShape.new(name: 'FieldList')
     ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
+    FormattedSqlRecords = Shapes::StringShape.new(name: 'FormattedSqlRecords')
     Id = Shapes::StringShape.new(name: 'Id')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
     InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
     Long = Shapes::IntegerShape.new(name: 'Long')
     LongArray = Shapes::ListShape.new(name: 'LongArray')
+    LongReturnType = Shapes::StringShape.new(name: 'LongReturnType')
     Metadata = Shapes::ListShape.new(name: 'Metadata')
     NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
     ParameterName = Shapes::StringShape.new(name: 'ParameterName')
     Record = Shapes::StructureShape.new(name: 'Record')
     Records = Shapes::ListShape.new(name: 'Records')
+    RecordsFormatType = Shapes::StringShape.new(name: 'RecordsFormatType')
     RecordsUpdated = Shapes::IntegerShape.new(name: 'RecordsUpdated')
     ResultFrame = Shapes::StructureShape.new(name: 'ResultFrame')
     ResultSetMetadata = Shapes::StructureShape.new(name: 'ResultSetMetadata')
@@ -79,6 +83,9 @@ module Aws::RDSDataService
     UpdateResults = Shapes::ListShape.new(name: 'UpdateResults')
     Value = Shapes::UnionShape.new(name: 'Value')
 
+    AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
+    AccessDeniedException.struct_class = Types::AccessDeniedException
+
     ArrayOfArray.member = Shapes::ShapeRef.new(shape: ArrayValue)
 
     ArrayValue.add_member(:array_values, Shapes::ShapeRef.new(shape: ArrayOfArray, location_name: "arrayValues"))
@@ -161,6 +168,7 @@ module Aws::RDSDataService
 
     ExecuteStatementRequest.add_member(:continue_after_timeout, Shapes::ShapeRef.new(shape: Boolean, location_name: "continueAfterTimeout"))
     ExecuteStatementRequest.add_member(:database, Shapes::ShapeRef.new(shape: DbName, location_name: "database"))
+    ExecuteStatementRequest.add_member(:format_records_as, Shapes::ShapeRef.new(shape: RecordsFormatType, location_name: "formatRecordsAs"))
     ExecuteStatementRequest.add_member(:include_result_metadata, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeResultMetadata"))
     ExecuteStatementRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "parameters"))
     ExecuteStatementRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn"))
@@ -172,6 +180,7 @@ module Aws::RDSDataService
     ExecuteStatementRequest.struct_class = Types::ExecuteStatementRequest
 
     ExecuteStatementResponse.add_member(:column_metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "columnMetadata"))
+    ExecuteStatementResponse.add_member(:formatted_records, Shapes::ShapeRef.new(shape: FormattedSqlRecords, location_name: "formattedRecords"))
     ExecuteStatementResponse.add_member(:generated_fields, Shapes::ShapeRef.new(shape: FieldList, location_name: "generatedFields"))
     ExecuteStatementResponse.add_member(:number_of_records_updated, Shapes::ShapeRef.new(shape: RecordsUpdated, location_name: "numberOfRecordsUpdated"))
     ExecuteStatementResponse.add_member(:records, Shapes::ShapeRef.new(shape: SqlRecords, location_name: "records"))
@@ -223,6 +232,7 @@ module Aws::RDSDataService
     ResultSetMetadata.struct_class = Types::ResultSetMetadata
 
     ResultSetOptions.add_member(:decimal_return_type, Shapes::ShapeRef.new(shape: DecimalReturnType, location_name: "decimalReturnType"))
+    ResultSetOptions.add_member(:long_return_type, Shapes::ShapeRef.new(shape: LongReturnType, location_name: "longReturnType"))
     ResultSetOptions.struct_class = Types::ResultSetOptions
 
     RollbackTransactionRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn"))
@@ -316,6 +326,7 @@ module Aws::RDSDataService
         o.http_request_uri = "/BatchExecute"
         o.input = Shapes::ShapeRef.new(shape: BatchExecuteStatementRequest)
         o.output = Shapes::ShapeRef.new(shape: BatchExecuteStatementResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
@@ -329,6 +340,7 @@ module Aws::RDSDataService
         o.http_request_uri = "/BeginTransaction"
         o.input = Shapes::ShapeRef.new(shape: BeginTransactionRequest)
         o.output = Shapes::ShapeRef.new(shape: BeginTransactionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
@@ -342,6 +354,7 @@ module Aws::RDSDataService
         o.http_request_uri = "/CommitTransaction"
         o.input = Shapes::ShapeRef.new(shape: CommitTransactionRequest)
         o.output = Shapes::ShapeRef.new(shape: CommitTransactionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
@@ -357,6 +370,7 @@ module Aws::RDSDataService
         o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: ExecuteSqlRequest)
         o.output = Shapes::ShapeRef.new(shape: ExecuteSqlResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
         o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
@@ -369,6 +383,7 @@ module Aws::RDSDataService
         o.http_request_uri = "/Execute"
         o.input = Shapes::ShapeRef.new(shape: ExecuteStatementRequest)
         o.output = Shapes::ShapeRef.new(shape: ExecuteStatementResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
@@ -382,6 +397,7 @@ module Aws::RDSDataService
         o.http_request_uri = "/RollbackTransaction"
         o.input = Shapes::ShapeRef.new(shape: RollbackTransactionRequest)
         o.output = Shapes::ShapeRef.new(shape: RollbackTransactionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
         o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)

data/lib/aws-sdk-rdsdataservice/errors.rb

@@ -27,6 +27,7 @@ module Aws::RDSDataService
   # See {Seahorse::Client::RequestContext} for more information.
   #
   # ## Error Classes
+  # * {AccessDeniedException}
   # * {BadRequestException}
   # * {ForbiddenException}
   # * {InternalServerErrorException}
@@ -40,6 +41,21 @@ module Aws::RDSDataService
 
     extend Aws::Errors::DynamicErrors
 
+    class AccessDeniedException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::RDSDataService::Types::AccessDeniedException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class BadRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

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

@@ -10,6 +10,19 @@
 module Aws::RDSDataService
   module Types
 
+    # You do not have sufficient access to perform this action.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains an array.
     #
     # @note ArrayValue is a union - when making an API calls you must set exactly one of the members.
@@ -25,11 +38,11 @@ module Aws::RDSDataService
     #   @return [Array<Boolean>]
     #
     # @!attribute [rw] double_values
-    #   An array of integers.
+    #   An array of floating-point numbers.
     #   @return [Array<Float>]
     #
     # @!attribute [rw] long_values
-    #   An array of floating point numbers.
+    #   An array of integers.
     #   @return [Array<Integer>]
     #
     # @!attribute [rw] string_values
@@ -446,6 +459,7 @@ module Aws::RDSDataService
     #       {
     #         continue_after_timeout: false,
     #         database: "DbName",
+    #         format_records_as: "NONE", # accepts NONE, JSON
     #         include_result_metadata: false,
     #         parameters: [
     #           {
@@ -475,6 +489,7 @@ module Aws::RDSDataService
     #         resource_arn: "Arn", # required
     #         result_set_options: {
     #           decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
+    #           long_return_type: "STRING", # accepts STRING, LONG
     #         },
     #         schema: "DbName",
     #         secret_arn: "Arn", # required
@@ -497,6 +512,21 @@ module Aws::RDSDataService
     #   The name of the database.
     #   @return [String]
     #
+    # @!attribute [rw] format_records_as
+    #   A value that indicates whether to format the result set as a single
+    #   JSON string. This parameter only applies to `SELECT` statements and
+    #   is ignored for other types of statements. Allowed values are `NONE`
+    #   and `JSON`. The default value is `NONE`. The result is returned in
+    #   the `formattedRecords` field.
+    #
+    #   For usage information about the JSON format for result sets, see
+    #   [Using the Data API][1] in the *Amazon Aurora User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
+    #   @return [String]
+    #
     # @!attribute [rw] include_result_metadata
     #   A value that indicates whether to include metadata in the results.
     #   @return [Boolean]
@@ -547,6 +577,7 @@ module Aws::RDSDataService
     class ExecuteStatementRequest < Struct.new(
       :continue_after_timeout,
       :database,
+      :format_records_as,
       :include_result_metadata,
       :parameters,
       :resource_arn,
@@ -563,11 +594,22 @@ module Aws::RDSDataService
     # statement against a database.
     #
     # @!attribute [rw] column_metadata
-    #   Metadata for the columns included in the results.
+    #   Metadata for the columns included in the results. This field is
+    #   blank if the `formatRecordsAs` parameter is set to `JSON`.
     #   @return [Array<Types::ColumnMetadata>]
     #
+    # @!attribute [rw] formatted_records
+    #   A string value that represents the result set of a `SELECT`
+    #   statement in JSON format. This value is only present when the
+    #   `formatRecordsAs` parameter is set to `JSON`.
+    #
+    #   The size limit for this field is currently 10 MB. If the
+    #   JSON-formatted string representing the result set requires more than
+    #   10 MB, the call returns an error.
+    #   @return [String]
+    #
     # @!attribute [rw] generated_fields
-    #   Values for fields generated during the request.
+    #   Values for fields generated during a DML request.
     #
     #        <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
     #   @return [Array<Types::Field>]
@@ -577,13 +619,15 @@ module Aws::RDSDataService
     #   @return [Integer]
     #
     # @!attribute [rw] records
-    #   The records returned by the SQL statement.
+    #   The records returned by the SQL statement. This field is blank if
+    #   the `formatRecordsAs` parameter is set to `JSON`.
     #   @return [Array<Array<Types::Field>>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementResponse AWS API Documentation
     #
     class ExecuteStatementResponse < Struct.new(
       :column_metadata,
+      :formatted_records,
       :generated_fields,
       :number_of_records_updated,
       :records)
@@ -687,6 +731,10 @@ module Aws::RDSDataService
 
     # A record returned by a call.
     #
+    # This data structure is only used with the deprecated `ExecuteSql`
+    # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
+    # operation instead.
+    #
     # @!attribute [rw] values
     #   The values returned in the record.
     #   @return [Array<Types::Value>]
@@ -701,6 +749,10 @@ module Aws::RDSDataService
 
     # The result set returned by a SQL statement.
     #
+    # This data structure is only used with the deprecated `ExecuteSql`
+    # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
+    # operation instead.
+    #
     # @!attribute [rw] records
     #   The records in the result set.
     #   @return [Array<Types::Record>]
@@ -744,6 +796,7 @@ module Aws::RDSDataService
     #
     #       {
     #         decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
+    #         long_return_type: "STRING", # accepts STRING, LONG
     #       }
     #
     # @!attribute [rw] decimal_return_type
@@ -758,10 +811,18 @@ module Aws::RDSDataService
     #   working with currency values.
     #   @return [String]
     #
+    # @!attribute [rw] long_return_type
+    #   A value that indicates how a field of `LONG` type is represented.
+    #   Allowed values are `LONG` and `STRING`. The default is `LONG`.
+    #   Specify `STRING` if the length or precision of numeric values might
+    #   cause truncation or rounding errors.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultSetOptions AWS API Documentation
     #
     class ResultSetOptions < Struct.new(
-      :decimal_return_type)
+      :decimal_return_type,
+      :long_return_type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -896,7 +957,7 @@ module Aws::RDSDataService
 
     # The result of a SQL statement.
     #
-    #      <important> <p>This data type is deprecated.</p> </important>
+    #      <important> <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p> </important>
     #
     # @!attribute [rw] number_of_records_updated
     #   The number of records updated by a SQL statement.
@@ -937,6 +998,10 @@ module Aws::RDSDataService
 
     # A structure value returned by a call.
     #
+    # This data structure is only used with the deprecated `ExecuteSql`
+    # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
+    # operation instead.
+    #
     # @!attribute [rw] attributes
     #   The attributes returned in the record.
     #   @return [Array<Types::Value>]
@@ -965,7 +1030,7 @@ module Aws::RDSDataService
 
     # Contains the value of a column.
     #
-    #      <important> <p>This data type is deprecated.</p> </important>
+    #      <important> <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p> </important>
     #
     # @note Value is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Value corresponding to the set member.
     #

data/lib/aws-sdk-rdsdataservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-rdsdataservice/customizations'
 # @!group service
 module Aws::RDSDataService
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rdsdataservice
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core