Amazon DynamoDB Streams Update: Documentation updates for streams.dynamodb

Author: AWS

.changes/next-release/feature-AmazonDynamoDBStreams-c04b3c2.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon DynamoDB Streams",
+    "description": "Documentation updates for streams.dynamodb"
+}

services/dynamodb/src/main/resources/codegen-resources/dynamodbstreams/paginators-1.json

@@ -1,16 +1,4 @@
 {
   "pagination": {
-    "DescribeStream": {
-      "input_token": "ExclusiveStartShardId",
-      "limit_key": "Limit",
-      "output_token": "StreamDescription.LastEvaluatedShardId",
-      "result_key": "StreamDescription.Shards"
-    },
-    "ListStreams": {
-      "input_token": "ExclusiveStartStreamArn",
-      "limit_key": "Limit",
-      "output_token": "LastEvaluatedStreamArn",
-      "result_key": "Streams"
-    }
   }
-}
+}

services/dynamodb/src/main/resources/codegen-resources/dynamodbstreams/service-2.json

@@ -89,46 +89,46 @@
       "members":{
         "S":{
           "shape":"StringAttributeValue",
-          "documentation":"<p>A String data type.</p>"
+          "documentation":"<p>An attribute of type String. For example:</p> <p> <code>\"S\": \"Hello\"</code> </p>"
         },
         "N":{
           "shape":"NumberAttributeValue",
-          "documentation":"<p>A Number data type.</p>"
+          "documentation":"<p>An attribute of type Number. For example:</p> <p> <code>\"N\": \"123.45\"</code> </p> <p>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.</p>"
         },
         "B":{
           "shape":"BinaryAttributeValue",
-          "documentation":"<p>A Binary data type.</p>"
+          "documentation":"<p>An attribute of type Binary. For example:</p> <p> <code>\"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"</code> </p>"
         },
         "SS":{
           "shape":"StringSetAttributeValue",
-          "documentation":"<p>A String Set data type.</p>"
+          "documentation":"<p>An attribute of type String Set. For example:</p> <p> <code>\"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]</code> </p>"
         },
         "NS":{
           "shape":"NumberSetAttributeValue",
-          "documentation":"<p>A Number Set data type.</p>"
+          "documentation":"<p>An attribute of type Number Set. For example:</p> <p> <code>\"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]</code> </p> <p>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.</p>"
         },
         "BS":{
           "shape":"BinarySetAttributeValue",
-          "documentation":"<p>A Binary Set data type.</p>"
+          "documentation":"<p>An attribute of type Binary Set. For example:</p> <p> <code>\"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]</code> </p>"
         },
         "M":{
           "shape":"MapAttributeValue",
-          "documentation":"<p>A Map data type.</p>"
+          "documentation":"<p>An attribute of type Map. For example:</p> <p> <code>\"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}</code> </p>"
         },
         "L":{
           "shape":"ListAttributeValue",
-          "documentation":"<p>A List data type.</p>"
+          "documentation":"<p>An attribute of type List. For example:</p> <p> <code>\"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]</code> </p>"
         },
         "NULL":{
           "shape":"NullAttributeValue",
-          "documentation":"<p>A Null data type.</p>"
+          "documentation":"<p>An attribute of type Null. For example:</p> <p> <code>\"NULL\": true</code> </p>"
         },
         "BOOL":{
           "shape":"BooleanAttributeValue",
-          "documentation":"<p>A Boolean data type.</p>"
+          "documentation":"<p>An attribute of type Boolean. For example:</p> <p> <code>\"BOOL\": true</code> </p>"
         }
       },
-      "documentation":"<p>Represents the data for an attribute. You can set one, and only one, of the elements.</p> <p>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.</p>"
+      "documentation":"<p>Represents the data for an attribute.</p> <p>Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes\">Data Types</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
     },
     "BinaryAttributeValue":{"type":"blob"},
     "BinarySetAttributeValue":{
@@ -294,10 +294,10 @@
         },
         "KeyType":{
           "shape":"KeyType",
-          "documentation":"<p>The attribute data, consisting of the data type and the attribute value itself.</p>"
+          "documentation":"<p>The role that this key attribute will assume:</p> <ul> <li> <p> <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul> <note> <p>The partition key of an item is also known as its <i>hash attribute</i>. 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.</p> <p>The sort key of an item is also known as its <i>range attribute</i>. 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.</p> </note>"
         }
       },
-      "documentation":"<p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</p> <p>A <code>KeySchemaElement</code> represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one <code>KeySchemaElement</code>. A composite primary key (partition key and sort key) would require one <code>KeySchemaElement</code> for the partition key, and another <code>KeySchemaElement</code> for the sort key.</p> <note> <p>The partition key of an item is also known as its <i>hash attribute</i>. 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.</p> <p>The sort key of an item is also known as its <i>range attribute</i>. 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.</p> </note>"
+      "documentation":"<p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</p> <p>A <code>KeySchemaElement</code> represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one <code>KeySchemaElement</code> (for the partition key). A composite primary key would require one <code>KeySchemaElement</code> for the partition key, and another <code>KeySchemaElement</code> for the sort key.</p> <p>A <code>KeySchemaElement</code> 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.</p>"
     },
     "KeyType":{
       "type":"string",
@@ -314,7 +314,7 @@
           "documentation":"<p>Too many operations for a given subscriber.</p>"
         }
       },
-      "documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries\">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
+      "documentation":"<p>There is no limit to the number of daily on-demand backups that can be taken.</p> <p>Up to 50 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>.</p> <p>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.</p> <p>There is a soft account limit of 256 tables.</p>",
       "exception":true
     },
     "ListAttributeValue":{
@@ -426,7 +426,7 @@
           "documentation":"<p>The resource which is being requested does not exist.</p>"
         }
       },
-      "documentation":"<p>The operation tried to access a nonexistent stream.</p>",
+      "documentation":"<p>The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>",
       "exception":true
     },
     "SequenceNumber":{
@@ -439,11 +439,11 @@
       "members":{
         "StartingSequenceNumber":{
           "shape":"SequenceNumber",
-          "documentation":"<p>The first sequence number.</p>"
+          "documentation":"<p>The first sequence number for the stream records contained within a shard. String contains numeric characters only.</p>"
         },
         "EndingSequenceNumber":{
           "shape":"SequenceNumber",
-          "documentation":"<p>The last sequence number.</p>"
+          "documentation":"<p>The last sequence number for the stream records contained within a shard. String contains numeric characters only.</p>"
         }
       },
       "documentation":"<p>The beginning and ending sequence numbers for the stream records contained within a shard.</p>"
@@ -630,9 +630,9 @@
           "documentation":"<p>\"The data you are trying to access has been trimmed.</p>"
         }
       },
-      "documentation":"<p>The operation attempted to read past the oldest stream record in a shard.</p> <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p> <ul> <li><p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p> </li> <li><p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</p> </li> </ul>",
+      "documentation":"<p>The operation attempted to read past the oldest stream record in a shard.</p> <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p> <ul> <li> <p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p> </li> <li> <p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</p> </li> </ul>",
       "exception":true
     }
   },
-  "documentation":"<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html\">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.</p>"
+  "documentation":"<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html\">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.</p>"
 }