aws-sdk-dynamodbstreams 1.0.0.rc6 → 1.0.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b80b0f39ea380d208da85cacd13898173a74d4d
-  data.tar.gz: a5387dfc9a679a7134954e3fefcb1afd71b68dbb
+  metadata.gz: 146687703e16df11db74c2ad8e0c03fbca914fb0
+  data.tar.gz: 584bf07de0e337cb9d8febe4865da86dfa807347
 SHA512:
-  metadata.gz: a0445b4e6974a8e6d79b98f33bdb0781f96e0cd3556b9c75351f6fffdca5b7b23f4b14cebae627fb4f57b9e25f87a30f98d5dfe1541c42694e0635bf2612aa65
-  data.tar.gz: 3a93d7755917644d9a3e6bc8bb52f0edf5ef5b2e78dfc6bf7d59ba740730fbd9ec172a889cb67caf497836a6c06263381eac6c75ed63c49821fd071648692a62
+  metadata.gz: a9eda92dc4cbd5076131645e7e9d8e83bb28f83ff5ad50b3524e60ccea1a5ef03c0128cc27810d7c097b20cfe3d07dbd38babc37ad284892259b448f82940b43
+  data.tar.gz: ade89e25d34a29283fafc6567d8a03d2b54bc6fcd8de7857c1e190a57c5649a6673be1ba5ce8e7906b0abf10e0e7d1056ff5b7525b8e0c649e22c4e500e3f995

data/lib/aws-sdk-dynamodbstreams.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-dynamodbstreams/customizations'
 # @service
 module Aws::DynamoDBStreams
 
-  GEM_VERSION = '1.0.0.rc6'
+  GEM_VERSION = '1.0.0.rc7'
 
 end

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

@@ -186,6 +186,69 @@ module Aws::DynamoDBStreams
     #
     #   * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
     #
+    #
+    # @example Example: To describe a stream with a given stream ARN
+    #
+    #   # The following example describes a stream with a given stream ARN.
+    #
+    #   resp = client.describe_stream({
+    #     stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     stream_description: {
+    #       creation_request_date_time: Time.parse("Wed May 20 13:51:10 PDT 2015"), 
+    #       key_schema: [
+    #         {
+    #           attribute_name: "ForumName", 
+    #           key_type: "HASH", 
+    #         }, 
+    #         {
+    #           attribute_name: "Subject", 
+    #           key_type: "RANGE", 
+    #         }, 
+    #       ], 
+    #       shards: [
+    #         {
+    #           sequence_number_range: {
+    #             ending_sequence_number: "20500000000000000910398", 
+    #             starting_sequence_number: "20500000000000000910398", 
+    #           }, 
+    #           shard_id: "shardId-00000001414562045508-2bac9cd2", 
+    #         }, 
+    #         {
+    #           parent_shard_id: "shardId-00000001414562045508-2bac9cd2", 
+    #           sequence_number_range: {
+    #             ending_sequence_number: "820400000000000001192334", 
+    #             starting_sequence_number: "820400000000000001192334", 
+    #           }, 
+    #           shard_id: "shardId-00000001414576573621-f55eea83", 
+    #         }, 
+    #         {
+    #           parent_shard_id: "shardId-00000001414576573621-f55eea83", 
+    #           sequence_number_range: {
+    #             ending_sequence_number: "1683700000000000001135967", 
+    #             starting_sequence_number: "1683700000000000001135967", 
+    #           }, 
+    #           shard_id: "shardId-00000001414592258131-674fd923", 
+    #         }, 
+    #         {
+    #           parent_shard_id: "shardId-00000001414592258131-674fd923", 
+    #           sequence_number_range: {
+    #             starting_sequence_number: "2574600000000000000935255", 
+    #           }, 
+    #           shard_id: "shardId-00000001414608446368-3a1afbaf", 
+    #         }, 
+    #       ], 
+    #       stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
+    #       stream_label: "2015-05-20T20:51:10.252", 
+    #       stream_status: "ENABLED", 
+    #       stream_view_type: "NEW_AND_OLD_IMAGES", 
+    #       table_name: "Forum", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_stream({
@@ -250,6 +313,85 @@ module Aws::DynamoDBStreams
     #   * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
     #   * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
     #
+    #
+    # @example Example: To retrieve all the stream records from a shard
+    #
+    #   # The following example retrieves all the stream records from a shard.
+    #
+    #   resp = client.get_records({
+    #     shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ...", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     next_shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...", 
+    #     records: [
+    #       {
+    #         aws_region: "us-west-2", 
+    #         dynamodb: {
+    #           approximate_creation_date_time: Time.parse("1.46480646E9"), 
+    #           keys: {
+    #             "ForumName" => {
+    #               s: "DynamoDB", 
+    #             }, 
+    #             "Subject" => {
+    #               s: "DynamoDB Thread 3", 
+    #             }, 
+    #           }, 
+    #           sequence_number: "300000000000000499659", 
+    #           size_bytes: 41, 
+    #           stream_view_type: "KEYS_ONLY", 
+    #         }, 
+    #         event_id: "e2fd9c34eff2d779b297b26f5fef4206", 
+    #         event_name: "INSERT", 
+    #         event_source: "aws:dynamodb", 
+    #         event_version: "1.0", 
+    #       }, 
+    #       {
+    #         aws_region: "us-west-2", 
+    #         dynamodb: {
+    #           approximate_creation_date_time: Time.parse("1.46480527E9"), 
+    #           keys: {
+    #             "ForumName" => {
+    #               s: "DynamoDB", 
+    #             }, 
+    #             "Subject" => {
+    #               s: "DynamoDB Thread 1", 
+    #             }, 
+    #           }, 
+    #           sequence_number: "400000000000000499660", 
+    #           size_bytes: 41, 
+    #           stream_view_type: "KEYS_ONLY", 
+    #         }, 
+    #         event_id: "4b25bd0da9a181a155114127e4837252", 
+    #         event_name: "MODIFY", 
+    #         event_source: "aws:dynamodb", 
+    #         event_version: "1.0", 
+    #       }, 
+    #       {
+    #         aws_region: "us-west-2", 
+    #         dynamodb: {
+    #           approximate_creation_date_time: Time.parse("1.46480646E9"), 
+    #           keys: {
+    #             "ForumName" => {
+    #               s: "DynamoDB", 
+    #             }, 
+    #             "Subject" => {
+    #               s: "DynamoDB Thread 2", 
+    #             }, 
+    #           }, 
+    #           sequence_number: "500000000000000499661", 
+    #           size_bytes: 41, 
+    #           stream_view_type: "KEYS_ONLY", 
+    #         }, 
+    #         event_id: "740280c73a3df7842edab3548a1b08ad", 
+    #         event_name: "REMOVE", 
+    #         event_source: "aws:dynamodb", 
+    #         event_version: "1.0", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_records({
@@ -333,6 +475,22 @@ module Aws::DynamoDBStreams
     #
     #   * {Types::GetShardIteratorOutput#shard_iterator #shard_iterator} => String
     #
+    #
+    # @example Example: To obtain a shard iterator for the provided stream ARN and shard ID
+    #
+    #   # The following example returns a shard iterator for the provided stream ARN and shard ID.
+    #
+    #   resp = client.get_shard_iterator({
+    #     shard_id: "00000001414576573621-f55eea83", 
+    #     shard_iterator_type: "TRIM_HORIZON", 
+    #     stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ...", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_shard_iterator({
@@ -380,6 +538,35 @@ module Aws::DynamoDBStreams
     #   * {Types::ListStreamsOutput#streams #streams} => Array&lt;Types::Stream&gt;
     #   * {Types::ListStreamsOutput#last_evaluated_stream_arn #last_evaluated_stream_arn} => String
     #
+    #
+    # @example Example: To list all of the stream ARNs 
+    #
+    #   # The following example lists all of the stream ARNs.
+    #
+    #   resp = client.list_streams({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     streams: [
+    #       {
+    #         stream_arn: "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
+    #         stream_label: "2015-05-20T20:51:10.252", 
+    #         table_name: "Forum", 
+    #       }, 
+    #       {
+    #         stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714", 
+    #         stream_label: "2015-05-20T20:50:02.714", 
+    #         table_name: "Forum", 
+    #       }, 
+    #       {
+    #         stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641", 
+    #         stream_label: "2015-05-19T23:03:50.641", 
+    #         table_name: "Forum", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_streams({
@@ -418,7 +605,7 @@ module Aws::DynamoDBStreams
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dynamodbstreams'
-      context[:gem_version] = '1.0.0.rc6'
+      context[:gem_version] = '1.0.0.rc7'
       Seahorse::Client::Request.new(handlers, context)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dynamodbstreams
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc6
+  version: 1.0.0.rc7
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc12
+        version: 3.0.0.rc14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc12
+        version: 3.0.0.rc14
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement