aws-sdk-dynamodbstreams 1.23.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b2682c80b22863a7aadb81dc79da9c479cd34d4303598f231c33f1c4f296072
-  data.tar.gz: 0b5ad61f61fb7f714bd701aa5eb474478553b1882d6d5a7a1b27762d729d8e6e
+  metadata.gz: 1b25ccc8b1bcbb5930ccf0c4fc4a4fc9c19822608814b4da4368f7738635cc15
+  data.tar.gz: a7666236432ea4024baa072a22bc8c25a64779e36f89001dce3f73d9625354c9
 SHA512:
-  metadata.gz: 9294d1b5827fd3f15322adb6897f65d857ebcc257e576b63fd398b69cf5b0a5b857c4980dc92150d8cea0be5ab67d66375226290a86dde5804b17236b60c36f3
-  data.tar.gz: 7e989072f69b7863d847be29162b906238223182c31f0ecbb97f880017545580de1d61545e25104ea89d33353ad77714b95cb499f1ddd3ce7dcd103e298b8427
+  metadata.gz: 8ff3a9a68ff26170d11101de46a8475275db4ef345f79b6e12d6ad21aad9e08114e9c651931e2744941b56223f46e11e5359864590b296c7cf2bb0e640bc32a9
+  data.tar.gz: 3698efd18c17ca973319efa79b2e37297d92d5ec361906e92fe42a2412422a1f44c08e9ea31e9328f7dea4290ce03fbc7773d41c3f645b830572acfc8d3f0020

data/lib/aws-sdk-dynamodbstreams.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-dynamodbstreams/customizations'
 # @!group service
 module Aws::DynamoDBStreams
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.28.0'
 
 end

data/lib/aws-sdk-dynamodbstreams/attribute_translator.rb

@@ -0,0 +1,40 @@
+module Aws
+  module DynamoDBStreams
+    # A utility class that translates DynamoDBStream events from Lambda
+    # functions into their simple attribute equivalents.
+    class AttributeTranslator
+      # Parse a DynamoDBStream event hash from Lambda that contains 1 or more
+      # records. When using the SDK to retrieve DynamoDB stream records, use the
+      # `simple_attributes: true` client option instead.
+      #
+      # @param [Hash] event A DynamoDBStream event.
+      #
+      # @example Parse a DynamoDB stream event from Lambda
+      #   def lambda_handler(event:, context:)
+      #     records = Aws::DynamoDBStreams::AttributeTranslator.from_event(event)
+      #     records.each do |record|
+      #       puts record.dynamodb.new_image
+      #       # => { "size" => 123, "enabled" => true, ... }
+      #     end
+      #   end
+      def self.from_event(event)
+        return unless event.is_a?(Hash)
+
+        # TODO: This implementation is slow and inefficient. It would be
+        # better to write a switch-case that has similar logic to AttributeValue
+        # used in the ValueTranslator. This implementation however provides
+        # consistency between both DynamoDB and DynamoDBStreams. The translator
+        # only works with shapes and structs and not a regular Ruby hash.
+        shape_ref = ClientApi::Shapes::ShapeRef.new(
+          shape: ClientApi::GetRecordsOutput
+        )
+        translator = Plugins::SimpleAttributes::ValueTranslator.new(
+          shape_ref, :unmarshal
+        )
+        parser = Aws::Json::Parser.new(shape_ref)
+        input = parser.parse(Aws::Json.dump(event))
+        translator.apply(input).records
+      end
+    end
+  end
+end

data/lib/aws-sdk-dynamodbstreams/attribute_value.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'stringio'
+require 'set'
+
+module Aws
+  module DynamoDBStreams
+    # @api private
+    class AttributeValue
+
+      def initialize
+        @unmarshaler = Unmarshaler.new
+      end
+
+      def unmarshal(value)
+        @unmarshaler.format(value)
+      end
+
+      class Unmarshaler
+
+        def format(obj)
+          type, value = extract_type_and_value(obj)
+          case type
+          when :m
+            value.each.with_object({}) do |(k, v), map|
+              map[k] = format(v)
+            end
+          when :l then value.map { |v| format(v) }
+          when :s then value
+          when :n then BigDecimal(value)
+          when :b then StringIO.new(value)
+          when :null then nil
+          when :bool then value
+          when :ss then Set.new(value)
+          when :ns then Set.new(value.map { |n| BigDecimal(n) })
+          when :bs then Set.new(value.map { |b| StringIO.new(b) })
+          else
+            raise ArgumentError, "unhandled type #{type.inspect}"
+          end
+        end
+
+        private
+
+        def extract_type_and_value(obj)
+          case obj
+          when Hash then obj.to_a.first
+          when Struct
+            obj.members.each do |key|
+              value = obj[key]
+              return [key, value] unless value.nil?
+            end
+          else
+            raise ArgumentError, "unhandled type #{obj.inspect}"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -29,6 +29,7 @@ require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
+require 'aws-sdk-dynamodbstreams/plugins/simple_attributes.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:dynamodbstreams)
 
@@ -75,6 +76,7 @@ module Aws::DynamoDBStreams
     add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
+    add_plugin(Aws::DynamoDBStreams::Plugins::SimpleAttributes)
 
     # @overload initialize(options)
     #   @param [Hash] options
@@ -266,6 +268,10 @@ module Aws::DynamoDBStreams
     #
     #   @option options [String] :session_token
     #
+    #   @option options [Boolean] :simple_attributes (false)
+    #     When enabled, returns DynamoDBStream attribute values using
+    #     hashes, arrays, sets, integers, floats, booleans, and nil.
+    #
     #   @option options [Boolean] :simple_json (false)
     #     Disables request parameter conversion, validation, and formatting.
     #     Also disable response data type conversions. This option is useful
@@ -787,7 +793,7 @@ module Aws::DynamoDBStreams
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dynamodbstreams'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -214,6 +214,7 @@ module Aws::DynamoDBStreams
         "jsonVersion" => "1.0",
         "protocol" => "json",
         "serviceFullName" => "Amazon DynamoDB Streams",
+        "serviceId" => "DynamoDB Streams",
         "signatureVersion" => "v4",
         "signingName" => "dynamodb",
         "targetPrefix" => "DynamoDBStreams_20120810",

data/lib/aws-sdk-dynamodbstreams/customizations.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# utility classes
+require 'aws-sdk-dynamodbstreams/attribute_translator'
+require 'aws-sdk-dynamodbstreams/attribute_value'

data/lib/aws-sdk-dynamodbstreams/plugins/simple_attributes.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Aws
+  module DynamoDBStreams
+    module Plugins
+      # Simplifies working with Amazon DynamoDBStreams attribute values.
+      # Translates attribute values from responses to sensible Ruby natives.
+      #
+      # This plugin is disabled by default for all {DynamoDBStreams::Client}
+      # objects. You can enable this plugin by passing
+      # `simple_attributes: false` to the client constructor:
+      #
+      #     ddb = Aws::DynamoDBStreams::Client.new(simple_attributes: true)
+      #
+      # ## Output Examples
+      #
+      # With this plugin **enabled**, `simple_attributes: true`:
+      #
+      #     resp = dynamodbstreams.get_records(shard_iterator: iterator)
+      #     resp.records.first.dynamodb.new_image
+      #     {
+      #       id: 'uuid',
+      #       enabled: true,
+      #       tags: #<Set: {"attributes", "simple"}>,
+      #       data: #<StringIO:0x00007fe4061e6bc0>,
+      #       scores: [0.1e1, 0.2e1, 0.3e1, nil],
+      #       name: {
+      #         first: 'John',
+      #         last: 'Doe',
+      #       }
+      #     }
+      #
+      # With this plugin **disabled**, `simple_attributes: false`:
+      #
+      #     resp = dynamodbstreams.get_records(shard_iterator: iterator)
+      #     resp.records.first.dynamodb.new_image
+      #     {
+      #       "id"=> <struct s='uuid', n=nil, b=nil, ss=nil, ns=nil, bs=nil, m=nil, l=nil, null=nil, bool=nil>
+      #       "enabled"=> <struct s=nil, n=nil, b=nil, ss=nil, ns=nil, bs=nil, m=nil, l=nil, null=nil, bool=true>
+      #       ...
+      #     }
+      #
+      class SimpleAttributes < Seahorse::Client::Plugin
+
+        option(:simple_attributes,
+          default: false,
+          doc_type: 'Boolean',
+          docstring: <<-DOCS
+When enabled, returns DynamoDBStream attribute values using
+hashes, arrays, sets, integers, floats, booleans, and nil.
+        DOCS
+        )
+
+        def add_handlers(handlers, config)
+          if config.simple_attributes
+            handlers.add(Handler, step: :initialize, operations: [:get_records])
+          end
+        end
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            @handler.call(context).on(200) do |response|
+              response.data = translate_output(response)
+            end
+          end
+
+          private
+
+          def translate_output(response)
+            if shape = response.context.operation.output
+              ValueTranslator.new(shape, :unmarshal).apply(response.data)
+            else
+              response.data
+            end
+          end
+
+        end
+
+        # @api private
+        class ValueTranslator
+
+          include Seahorse::Model::Shapes
+
+          def self.apply(rules, mode, data)
+            new(rules, mode).apply(data)
+          end
+
+          def initialize(rules, mode)
+            @rules = rules
+            @mode = mode
+          end
+
+          def apply(values)
+            structure(@rules, values) if @rules
+          end
+
+          private
+
+          def structure(ref, values)
+            shape = ref.shape
+            if values.is_a?(Struct)
+              values.members.each.with_object(values.class.new) do |key, st|
+                st[key] = translate(shape.member(key), values[key])
+              end
+            elsif values.is_a?(Hash)
+              values.each.with_object({}) do |(key, value), hash|
+                hash[key] = translate(shape.member(key), value)
+              end
+            else
+              values
+            end
+          end
+
+          def list(ref, values)
+            return values unless values.is_a?(Array)
+            member_ref = ref.shape.member
+            values.inject([]) do |list, value|
+              list << translate(member_ref, value)
+            end
+          end
+
+          def map(ref, values)
+            return values unless values.is_a?(Hash)
+            value_ref = ref.shape.value
+            values.each.with_object({}) do |(key, value), hash|
+              hash[key] = translate(value_ref, value)
+            end
+          end
+
+          def translate(ref, value)
+            if ClientApi::AttributeValue === ref.shape
+              AttributeValue.new.send(@mode, value)
+            else
+              translate_complex(ref, value)
+            end
+          end
+
+          def translate_complex(ref, value)
+            case ref.shape
+            when StructureShape then structure(ref, value)
+            when ListShape then list(ref, value)
+            when MapShape then map(ref, value)
+            else value
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -10,53 +10,86 @@
 module Aws::DynamoDBStreams
   module Types
 
-    # Represents the data for an attribute. You can set one, and only one,
-    # of the elements.
+    # Represents the data for an attribute.
     #
-    # Each attribute in an item is a name-value pair. An attribute can be
-    # single-valued or multi-valued set. For example, a book item can have
-    # title and authors attributes. Each book has one title but can have
-    # many authors. The multi-valued attribute is a set; duplicate values
-    # are not allowed.
+    # Each attribute value is described as a name-value pair. The name is
+    # the data type, and the value is the data itself.
+    #
+    # For more information, see [Data Types][1] in the *Amazon DynamoDB
+    # Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes
     #
     # @!attribute [rw] s
-    #   A String data type.
+    #   An attribute of type String. For example:
+    #
+    #   `"S": "Hello"`
     #   @return [String]
     #
     # @!attribute [rw] n
-    #   A Number data type.
+    #   An attribute of type Number. For example:
+    #
+    #   `"N": "123.45"`
+    #
+    #   Numbers are sent across the network to DynamoDB as strings, to
+    #   maximize compatibility across languages and libraries. However,
+    #   DynamoDB treats them as number type attributes for mathematical
+    #   operations.
     #   @return [String]
     #
     # @!attribute [rw] b
-    #   A Binary data type.
+    #   An attribute of type Binary. For example:
+    #
+    #   `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
     #   @return [String]
     #
     # @!attribute [rw] ss
-    #   A String Set data type.
+    #   An attribute of type String Set. For example:
+    #
+    #   `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
     #   @return [Array<String>]
     #
     # @!attribute [rw] ns
-    #   A Number Set data type.
+    #   An attribute of type Number Set. For example:
+    #
+    #   `"NS": ["42.2", "-19", "7.5", "3.14"]`
+    #
+    #   Numbers are sent across the network to DynamoDB as strings, to
+    #   maximize compatibility across languages and libraries. However,
+    #   DynamoDB treats them as number type attributes for mathematical
+    #   operations.
     #   @return [Array<String>]
     #
     # @!attribute [rw] bs
-    #   A Binary Set data type.
+    #   An attribute of type Binary Set. For example:
+    #
+    #   `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
     #   @return [Array<String>]
     #
     # @!attribute [rw] m
-    #   A Map data type.
+    #   An attribute of type Map. For example:
+    #
+    #   `"M": \{"Name": \{"S": "Joe"\}, "Age": \{"N": "35"\}\}`
     #   @return [Hash<String,Types::AttributeValue>]
     #
     # @!attribute [rw] l
-    #   A List data type.
+    #   An attribute of type List. For example:
+    #
+    #   `"L": [ \{"S": "Cookies"\} , \{"S": "Coffee"\}, \{"N", "3.14159"\}]`
     #   @return [Array<Types::AttributeValue>]
     #
     # @!attribute [rw] null
-    #   A Null data type.
+    #   An attribute of type Null. For example:
+    #
+    #   `"NULL": true`
     #   @return [Boolean]
     #
     # @!attribute [rw] bool
-    #   A Boolean data type.
+    #   An attribute of type Boolean. For example:
+    #
+    #   `"BOOL": true`
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/AttributeValue AWS API Documentation
@@ -311,30 +344,37 @@ module Aws::DynamoDBStreams
     # attributes of an index.
     #
     # A `KeySchemaElement` represents exactly one attribute of the primary
-    # key. For example, a simple primary key (partition key) would be
-    # represented by one `KeySchemaElement`. A composite primary key
-    # (partition key and sort key) would require one `KeySchemaElement` for
-    # the partition key, and another `KeySchemaElement` for the sort key.
-    #
-    # <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
-    # The term "hash attribute" derives from DynamoDB's usage of an
-    # internal hash function to evenly distribute data items across
-    # partitions, based on their partition key values.
-    #
-    #  The sort key of an item is also known as its *range attribute*. The
-    # term "range attribute" derives from the way DynamoDB stores items
-    # with the same partition key physically close together, in sorted order
-    # by the sort key value.
+    # key. For example, a simple primary key would be represented by one
+    # `KeySchemaElement` (for the partition key). A composite primary key
+    # would require one `KeySchemaElement` for the partition key, and
+    # another `KeySchemaElement` for the sort key.
     #
-    #  </note>
+    # A `KeySchemaElement` must be a scalar, top-level attribute (not a
+    # nested attribute). The data type must be one of String, Number, or
+    # Binary. The attribute cannot be nested within a List or a Map.
     #
     # @!attribute [rw] attribute_name
     #   The name of a key attribute.
     #   @return [String]
     #
     # @!attribute [rw] key_type
-    #   The attribute data, consisting of the data type and the attribute
-    #   value itself.
+    #   The role that this key attribute will assume:
+    #
+    #   * `HASH` - partition key
+    #
+    #   * `RANGE` - sort key
+    #
+    #   <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
+    #   The term "hash attribute" derives from DynamoDB's usage of an
+    #   internal hash function to evenly distribute data items across
+    #   partitions, based on their partition key values.
+    #
+    #    The sort key of an item is also known as its *range attribute*. The
+    #   term "range attribute" derives from the way DynamoDB stores items
+    #   with the same partition key physically close together, in sorted
+    #   order by the sort key value.
+    #
+    #    </note>
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/KeySchemaElement AWS API Documentation
@@ -346,16 +386,20 @@ module Aws::DynamoDBStreams
       include Aws::Structure
     end
 
-    # Your request rate is too high. The AWS SDKs for DynamoDB automatically
-    # retry requests that receive this exception. Your request is eventually
-    # successful, unless your retry queue is too large to finish. Reduce the
-    # frequency of requests and use exponential backoff. For more
-    # information, go to [Error Retries and Exponential Backoff][1] in the
-    # *Amazon DynamoDB Developer Guide*.
+    # There is no limit to the number of daily on-demand backups that can be
+    # taken.
     #
+    # Up to 50 simultaneous table operations are allowed per account. These
+    # operations include `CreateTable`, `UpdateTable`,
+    # `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and
+    # `RestoreTableToPointInTime`.
     #
+    # The only exception is when you are creating a table with one or more
+    # secondary indexes. You can have up to 25 such requests running at a
+    # time; however, if the table or index specifications are complex,
+    # DynamoDB might temporarily reduce the number of concurrent operations.
     #
-    # [1]: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries
+    # There is a soft account quota of 256 tables.
     #
     # @!attribute [rw] message
     #   Too many operations for a given subscriber.
@@ -506,7 +550,9 @@ module Aws::DynamoDBStreams
       include Aws::Structure
     end
 
-    # The operation tried to access a nonexistent stream.
+    # The operation tried to access a nonexistent table or index. The
+    # resource might not be specified correctly, or its status might not be
+    # `ACTIVE`.
     #
     # @!attribute [rw] message
     #   The resource which is being requested does not exist.
@@ -524,11 +570,13 @@ module Aws::DynamoDBStreams
     # contained within a shard.
     #
     # @!attribute [rw] starting_sequence_number
-    #   The first sequence number.
+    #   The first sequence number for the stream records contained within a
+    #   shard. String contains numeric characters only.
     #   @return [String]
     #
     # @!attribute [rw] ending_sequence_number
-    #   The last sequence number.
+    #   The last sequence number for the stream records contained within a
+    #   shard. String contains numeric characters only.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/SequenceNumberRange AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dynamodbstreams
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -53,10 +53,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/aws-sdk-dynamodbstreams.rb
+- lib/aws-sdk-dynamodbstreams/attribute_translator.rb
+- lib/aws-sdk-dynamodbstreams/attribute_value.rb
 - lib/aws-sdk-dynamodbstreams/client.rb
 - lib/aws-sdk-dynamodbstreams/client_api.rb
 - lib/aws-sdk-dynamodbstreams/customizations.rb
 - lib/aws-sdk-dynamodbstreams/errors.rb
+- lib/aws-sdk-dynamodbstreams/plugins/simple_attributes.rb
 - lib/aws-sdk-dynamodbstreams/resource.rb
 - lib/aws-sdk-dynamodbstreams/types.rb
 homepage: https://github.com/aws/aws-sdk-ruby