aws-sdk-dynamodb 1.72.0 → 1.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0ae31718a0b2d46c5a52ba9ab63b31ae5f64920ec35c791b0429ead01ca80ef
-  data.tar.gz: '058396cdc0515871050fea88f1a2d1d829fe511a3c539523521e7b2d507f00a1'
+  metadata.gz: ded7d0deac349c81a16fb38f201285567cc8da4d710aae51d14d0d81ebee0bca
+  data.tar.gz: 256334b4d6e50bed034253e6c45377559c8ca3eacdbd29bf14c72cc25d53458a
 SHA512:
-  metadata.gz: 2166f3374e7958567e203117297dd10d6258f7e0c36e9e157d62aa5ebe2fb7cc6e612abbc2ed497ee3712cbf00bf0bf0f818f67d35d2493d599515cd09272bab
-  data.tar.gz: ac2bbb93fae8fb18f14891916183ea24154e29d1eb38106d0d92c39612b3e8c886d5fd857aace1255988943f75a491da9e7c014704a759fd2076d724ec193bde
+  metadata.gz: 015c03a66a00e906cd5d90783aca5e6fcce7a6176aa0d3b463f89e8a6b3e35045cc8460467aa86450055d50b198e54b4dc2c1208c1c745caee3107c44d0ce47d
+  data.tar.gz: '094f0881f19aad53e073e834c55ef66f04eab31c4d2864800b304a323c7db8475acff75d86d832accd18a0ec4c04e606bd6a2c0b1f0027b243f2cef9ab4bd229'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.73.0 (2022-02-21)
+------------------
+
+* Feature - DynamoDB ExecuteStatement API now supports Limit as a request parameter to specify the maximum number of items to evaluate. If specified, the service will process up to the Limit and the results will include a LastEvaluatedKey value to continue the read in a subsequent operation.
+
 1.72.0 (2022-02-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.72.0
+1.73.0

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

@@ -3016,6 +3016,19 @@ module Aws::DynamoDB
     # This operation allows you to perform reads and singleton writes on
     # data stored in DynamoDB, using PartiQL.
     #
+    # For PartiQL reads (`SELECT` statement), if the total number of
+    # processed items exceeds the maximum dataset size limit of 1 MB, the
+    # read stops and results are returned to the user as a
+    # `LastEvaluatedKey` value to continue the read in a subsequent
+    # operation. If the filter criteria in `WHERE` clause does not match any
+    # data, the read will return an empty result set.
+    #
+    # A single `SELECT` statement response can return up to the maximum
+    # number of items (if using the Limit parameter) or a maximum of 1 MB of
+    # data (and then apply any filtering to the results using `WHERE`
+    # clause). If `LastEvaluatedKey` is present in the response, you need to
+    # paginate the result set.
+    #
     # @option params [required, String] :statement
     #   The PartiQL statement representing the operation to run.
     #
@@ -3048,11 +3061,24 @@ module Aws::DynamoDB
     #
     #   * `NONE` - No `ConsumedCapacity` details are included in the response.
     #
+    # @option params [Integer] :limit
+    #   The maximum number of items to evaluate (not necessarily the number of
+    #   matching items). If DynamoDB processes the number of items up to the
+    #   limit while processing the results, it stops the operation and returns
+    #   the matching values up to that point, along with a key in
+    #   `LastEvaluatedKey` to apply in a subsequent operation so you can pick
+    #   up where you left off. Also, if the processed dataset size exceeds 1
+    #   MB before DynamoDB reaches this limit, it stops the operation and
+    #   returns the matching values up to the limit, and a key in
+    #   `LastEvaluatedKey` to apply in a subsequent operation to continue the
+    #   operation.
+    #
     # @return [Types::ExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ExecuteStatementOutput#items #items} => Array<Hash<String,Types::AttributeValue>>
     #   * {Types::ExecuteStatementOutput#next_token #next_token} => String
     #   * {Types::ExecuteStatementOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
+    #   * {Types::ExecuteStatementOutput#last_evaluated_key #last_evaluated_key} => Hash<String,Types::AttributeValue>
     #
     # @example Request syntax with placeholder values
     #
@@ -3062,6 +3088,7 @@ module Aws::DynamoDB
     #     consistent_read: false,
     #     next_token: "PartiQLNextToken",
     #     return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
+    #     limit: 1,
     #   })
     #
     # @example Response structure
@@ -3085,6 +3112,8 @@ module Aws::DynamoDB
     #   resp.consumed_capacity.global_secondary_indexes["IndexName"].read_capacity_units #=> Float
     #   resp.consumed_capacity.global_secondary_indexes["IndexName"].write_capacity_units #=> Float
     #   resp.consumed_capacity.global_secondary_indexes["IndexName"].capacity_units #=> Float
+    #   resp.last_evaluated_key #=> Hash
+    #   resp.last_evaluated_key["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatement AWS API Documentation
     #
@@ -7320,7 +7349,7 @@ module Aws::DynamoDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dynamodb'
-      context[:gem_version] = '1.72.0'
+      context[:gem_version] = '1.73.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -835,11 +835,13 @@ module Aws::DynamoDB
     ExecuteStatementInput.add_member(:consistent_read, Shapes::ShapeRef.new(shape: ConsistentRead, location_name: "ConsistentRead"))
     ExecuteStatementInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PartiQLNextToken, location_name: "NextToken"))
     ExecuteStatementInput.add_member(:return_consumed_capacity, Shapes::ShapeRef.new(shape: ReturnConsumedCapacity, location_name: "ReturnConsumedCapacity"))
+    ExecuteStatementInput.add_member(:limit, Shapes::ShapeRef.new(shape: PositiveIntegerObject, location_name: "Limit"))
     ExecuteStatementInput.struct_class = Types::ExecuteStatementInput
 
     ExecuteStatementOutput.add_member(:items, Shapes::ShapeRef.new(shape: ItemList, location_name: "Items"))
     ExecuteStatementOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PartiQLNextToken, location_name: "NextToken"))
     ExecuteStatementOutput.add_member(:consumed_capacity, Shapes::ShapeRef.new(shape: ConsumedCapacity, location_name: "ConsumedCapacity"))
+    ExecuteStatementOutput.add_member(:last_evaluated_key, Shapes::ShapeRef.new(shape: Key, location_name: "LastEvaluatedKey"))
     ExecuteStatementOutput.struct_class = Types::ExecuteStatementOutput
 
     ExecuteTransactionInput.add_member(:transact_statements, Shapes::ShapeRef.new(shape: ParameterizedStatements, required: true, location_name: "TransactStatements"))

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

@@ -3316,6 +3316,7 @@ module Aws::DynamoDB
     #         consistent_read: false,
     #         next_token: "PartiQLNextToken",
     #         return_consumed_capacity: "INDEXES", # accepts INDEXES, TOTAL, NONE
+    #         limit: 1,
     #       }
     #
     # @!attribute [rw] statement
@@ -3357,6 +3358,19 @@ module Aws::DynamoDB
     #     response.
     #   @return [String]
     #
+    # @!attribute [rw] limit
+    #   The maximum number of items to evaluate (not necessarily the number
+    #   of matching items). If DynamoDB processes the number of items up to
+    #   the limit while processing the results, it stops the operation and
+    #   returns the matching values up to that point, along with a key in
+    #   `LastEvaluatedKey` to apply in a subsequent operation so you can
+    #   pick up where you left off. Also, if the processed dataset size
+    #   exceeds 1 MB before DynamoDB reaches this limit, it stops the
+    #   operation and returns the matching values up to the limit, and a key
+    #   in `LastEvaluatedKey` to apply in a subsequent operation to continue
+    #   the operation.
+    #   @return [Integer]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatementInput AWS API Documentation
     #
     class ExecuteStatementInput < Struct.new(
@@ -3364,7 +3378,8 @@ module Aws::DynamoDB
       :parameters,
       :consistent_read,
       :next_token,
-      :return_consumed_capacity)
+      :return_consumed_capacity,
+      :limit)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3395,12 +3410,24 @@ module Aws::DynamoDB
     #   [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html
     #   @return [Types::ConsumedCapacity]
     #
+    # @!attribute [rw] last_evaluated_key
+    #   The primary key of the item where the operation stopped, inclusive
+    #   of the previous result set. Use this value to start a new operation,
+    #   excluding this value in the new request. If `LastEvaluatedKey` is
+    #   empty, then the "last page" of results has been processed and
+    #   there is no more data to be retrieved. If `LastEvaluatedKey` is not
+    #   empty, it does not necessarily mean that there is more data in the
+    #   result set. The only way to know when you have reached the end of
+    #   the result set is when `LastEvaluatedKey` is empty.
+    #   @return [Hash<String,Types::AttributeValue>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatementOutput AWS API Documentation
     #
     class ExecuteStatementOutput < Struct.new(
       :items,
       :next_token,
-      :consumed_capacity)
+      :consumed_capacity,
+      :last_evaluated_key)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-dynamodb.rb

@@ -50,6 +50,6 @@ require_relative 'aws-sdk-dynamodb/customizations'
 # @!group service
 module Aws::DynamoDB
 
-  GEM_VERSION = '1.72.0'
+  GEM_VERSION = '1.73.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dynamodb
 version: !ruby/object:Gem::Version
-  version: 1.72.0
+  version: 1.73.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core