docs(client-dynamodb-streams): Documentation updates for DynamoDB Streams

Author: awstools

clients/client-dynamodb-streams/src/DynamoDBStreams.ts

@@ -81,7 +81,6 @@ export interface DynamoDBStreams {
 /**
  * @public
  * <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

clients/client-dynamodb-streams/src/DynamoDBStreamsClient.ts

@@ -248,7 +248,6 @@ export interface DynamoDBStreamsClientResolvedConfig extends DynamoDBStreamsClie
 /**
  * @public
  * <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

clients/client-dynamodb-streams/src/commands/GetRecordsCommand.ts

@@ -161,6 +161,9 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
  *           of concurrent operations.</p>
  *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
  *          <p>There is a soft account quota of 2,500 tables.</p>
+ *          <p>GetRecords was called with a value of more than 1000 for the limit request parameter.</p>
+ *          <p>More than 2 processes are reading from the same streams shard at the same time. Exceeding
+ *           this limit may result in request throttling.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The operation tried to access a nonexistent table or index. The resource

clients/client-dynamodb-streams/src/endpoint/EndpointParameters.ts

@@ -25,7 +25,7 @@ export const resolveClientEndpointParameters = <T>(
 };
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region: string;
+  Region?: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;

clients/client-dynamodb-streams/src/endpoint/ruleset.ts

@@ -6,29 +6,33 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
    or see "smithy.rules#endpointRuleSet"
    in codegen/sdk-codegen/aws-models/dynamodb-streams.json */
 
-const v="fn",
-w="argv",
-x="ref";
-const a=true,
-b=false,
-c="String",
-d="PartitionResult",
-e="tree",
-f="error",
-g="endpoint",
-h="getAttr",
-i="stringEquals",
-j={"required":true,"default":false,"type":"Boolean"},
-k={[x]:"Region"},
-l={[x]:"Endpoint"},
-m={[v]:"booleanEquals",[w]:[{[x]:"UseFIPS"},true]},
-n={[v]:"booleanEquals",[w]:[{[x]:"UseDualStack"},true]},
-o={},
-p={[v]:"booleanEquals",[w]:[true,{[v]:h,[w]:[{[x]:d},"supportsFIPS"]}]},
-q={[x]:d},
-r={[v]:"booleanEquals",[w]:[true,{[v]:h,[w]:[q,"supportsDualStack"]}]},
-s={"url":"https://streams.dynamodb.{Region}.{PartitionResult#dnsSuffix}","properties":{},"headers":{}},
-t=[m],
-u=[n];
-const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:j,UseFIPS:j,Endpoint:{required:b,type:c}},rules:[{conditions:[{[v]:"aws.partition",[w]:[k],assign:d}],type:e,rules:[{conditions:[{[v]:"isSet",[w]:[l]}],type:e,rules:[{conditions:t,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:u,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:l,properties:o,headers:o},type:g}]}]},{conditions:[m,n],type:e,rules:[{conditions:[p,r],type:e,rules:[{endpoint:{url:"https://streams.dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:o,headers:o},type:g}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:t,type:e,rules:[{conditions:[p],type:e,rules:[{type:e,rules:[{conditions:[{[v]:i,[w]:["aws-us-gov",{[v]:h,[w]:[q,"name"]}]}],endpoint:s,type:g},{endpoint:{url:"https://streams.dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",properties:o,headers:o},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:u,type:e,rules:[{conditions:[r],type:e,rules:[{endpoint:{url:"https://streams.dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:o,headers:o},type:g}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{type:e,rules:[{conditions:[{[v]:i,[w]:[k,"local"]}],endpoint:{url:"http://localhost:8000",properties:{authSchemes:[{name:"sigv4",signingRegion:"us-east-1",signingName:"dynamodb"}]},headers:o},type:g},{endpoint:s,type:g}]}]}]};
+const v="required",
+w="type",
+x="fn",
+y="argv",
+z="ref",
+A="properties",
+B="headers";
+const a="isSet",
+b="tree",
+c="error",
+d="endpoint",
+e="PartitionResult",
+f="stringEquals",
+g={[v]:false,[w]:"String"},
+h={[v]:true,"default":false,[w]:"Boolean"},
+i={[z]:"Endpoint"},
+j={[x]:"booleanEquals",[y]:[{[z]:"UseFIPS"},true]},
+k={[x]:"booleanEquals",[y]:[{[z]:"UseDualStack"},true]},
+l={},
+m={[z]:"Region"},
+n={[x]:"booleanEquals",[y]:[true,{[x]:"getAttr",[y]:[{[z]:e},"supportsFIPS"]}]},
+o={[x]:"booleanEquals",[y]:[true,{[x]:"getAttr",[y]:[{[z]:e},"supportsDualStack"]}]},
+p={"conditions":[{[x]:f,[y]:["aws-us-gov",{[x]:"getAttr",[y]:[{[z]:e},"name"]}]}],[d]:{"url":"https://streams.dynamodb.{Region}.amazonaws.com",[A]:{},[B]:{}},[w]:d},
+q={[x]:"getAttr",[y]:[{[z]:e},"name"]},
+r={"url":"https://streams.dynamodb.{Region}.amazonaws.com",[A]:{},[B]:{}},
+s=[j],
+t=[k],
+u=[m];
+const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[x]:a,[y]:[i]}],[w]:b,rules:[{conditions:s,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[w]:c},{[w]:b,rules:[{conditions:t,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[w]:c},{endpoint:{url:i,[A]:l,[B]:l},[w]:d}]}]},{[w]:b,rules:[{conditions:[{[x]:a,[y]:u}],[w]:b,rules:[{conditions:[{[x]:"aws.partition",[y]:u,assign:e}],[w]:b,rules:[{conditions:[j,k],[w]:b,rules:[{conditions:[n,o],[w]:b,rules:[{[w]:b,rules:[{endpoint:{url:"https://streams.dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[A]:l,[B]:l},[w]:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",[w]:c}]},{conditions:s,[w]:b,rules:[{conditions:[n],[w]:b,rules:[{[w]:b,rules:[p,{endpoint:{url:"https://streams.dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",[A]:l,[B]:l},[w]:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",[w]:c}]},{conditions:t,[w]:b,rules:[{conditions:[o],[w]:b,rules:[{[w]:b,rules:[{endpoint:{url:"https://streams.dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",[A]:l,[B]:l},[w]:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",[w]:c}]},{[w]:b,rules:[{conditions:[{[x]:f,[y]:[m,"local"]}],endpoint:{url:"http://localhost:8000",[A]:{authSchemes:[{name:"sigv4",signingName:"dynamodb",signingRegion:"us-east-1"}]},[B]:l},[w]:d},{conditions:[{[x]:f,[y]:["aws",q]}],endpoint:r,[w]:d},{conditions:[{[x]:f,[y]:["aws-cn",q]}],endpoint:{url:"https://streams.dynamodb.{Region}.amazonaws.com.cn",[A]:l,[B]:l},[w]:d},p,{conditions:[{[x]:f,[y]:["aws-iso",q]}],endpoint:{url:"https://streams.dynamodb.{Region}.c2s.ic.gov",[A]:l,[B]:l},[w]:d},{conditions:[{[x]:f,[y]:["aws-iso-b",q]}],endpoint:{url:"https://streams.dynamodb.{Region}.sc2s.sgov.gov",[A]:l,[B]:l},[w]:d},{endpoint:{url:"https://streams.dynamodb.{Region}.{PartitionResult#dnsSuffix}",[A]:l,[B]:l},[w]:d}]}]}]},{error:"Invalid Configuration: Missing Region",[w]:c}]}]};
 export const ruleSet: RuleSetObject = _data;

clients/client-dynamodb-streams/src/index.ts

@@ -2,7 +2,6 @@
 /* eslint-disable */
 /**
  * <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

clients/client-dynamodb-streams/src/models/models_0.ts

@@ -63,11 +63,11 @@ export interface KeySchemaElement {
    * <p>The role that this key attribute will assume:</p>
    *          <ul>
    *             <li>
-   *               <p>
+   *                <p>
    *                   <code>HASH</code> - partition key</p>
    *             </li>
    *             <li>
-   *               <p>
+   *                <p>
    *                   <code>RANGE</code> - sort key</p>
    *             </li>
    *          </ul>
@@ -171,7 +171,7 @@ export interface StreamDescription {
    *       combination of the following three elements is guaranteed to be unique:</p>
    *          <ul>
    *             <li>
-   *                <p>the AWS customer ID.</p>
+   *                <p>the Amazon Web Services customer ID.</p>
    *             </li>
    *             <li>
    *                <p>the table name</p>
@@ -397,6 +397,9 @@ export interface Identity {
  *           of concurrent operations.</p>
  *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
  *          <p>There is a soft account quota of 2,500 tables.</p>
+ *          <p>GetRecords was called with a value of more than 1000 for the limit request parameter.</p>
+ *          <p>More than 2 processes are reading from the same streams shard at the same time. Exceeding
+ *           this limit may result in request throttling.</p>
  */
 export class LimitExceededException extends __BaseException {
   readonly name: "LimitExceededException" = "LimitExceededException";
@@ -567,7 +570,7 @@ export interface _Stream {
    *       combination of the following three elements is guaranteed to be unique:</p>
    *          <ul>
    *             <li>
-   *                <p>the AWS customer ID.</p>
+   *                <p>the Amazon Web Services customer ID.</p>
    *             </li>
    *             <li>
    *                <p>the table name</p>
@@ -877,7 +880,7 @@ export namespace AttributeValue {
  */
 export interface StreamRecord {
   /**
-   * <p>The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format.</p>
+   * <p>The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format and rounded down to the closest second.</p>
    */
   ApproximateCreationDateTime?: Date;
 
@@ -968,7 +971,7 @@ export interface _Record {
   eventVersion?: string;
 
   /**
-   * <p>The AWS service from which the stream record originated.  For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>
+   * <p>The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>
    */
   eventSource?: string;