docs(client-dynamodb): Documentation updates for DynamoDB

aws · Jun 12, 2023 · 4a4ed04 · 4a4ed04
1 parent 5fac884
commit 4a4ed04
Show file tree

Hide file tree

Showing 23 changed files with 71 additions and 8 deletions.
diff --git a/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts b/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts
@@ -40,8 +40,8 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
  *             from one or more tables. You identify requested items by primary key.</p>
  *          <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
  *             items. <code>BatchGetItem</code> returns a partial result if the response size limit is
- *             exceeded, the table's provisioned throughput is exceeded, or an internal processing
- *             failure occurs. If a partial result is returned, the operation returns a value for
+ *             exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested,
+ *             or an internal processing failure occurs. If a partial result is returned, the operation returns a value for
  *                 <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
  *             with the next item to get.</p>
  *          <important>

diff --git a/clients/client-dynamodb/src/commands/CreateBackupCommand.ts b/clients/client-dynamodb/src/commands/CreateBackupCommand.ts
@@ -122,6 +122,9 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
  *             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 TableInUseException} (client fault)
  *  <p>A target table with the specified name is either being created or deleted.

diff --git a/clients/client-dynamodb/src/commands/CreateGlobalTableCommand.ts b/clients/client-dynamodb/src/commands/CreateGlobalTableCommand.ts
@@ -177,6 +177,9 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
  *             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 TableNotFoundException} (client fault)
  *  <p>A source table with the name <code>TableName</code> does not currently exist within

diff --git a/clients/client-dynamodb/src/commands/CreateTableCommand.ts b/clients/client-dynamodb/src/commands/CreateTableCommand.ts
@@ -295,6 +295,9 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/DeleteBackupCommand.ts b/clients/client-dynamodb/src/commands/DeleteBackupCommand.ts
@@ -169,6 +169,9 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
  *             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 DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>

diff --git a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts
@@ -233,6 +233,9 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/DescribeExportCommand.ts b/clients/client-dynamodb/src/commands/DescribeExportCommand.ts
@@ -98,6 +98,9 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
  *             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 DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>

diff --git a/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts
@@ -86,6 +86,9 @@ export interface DisableKinesisStreamingDestinationCommandOutput
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/EnableKinesisStreamingDestinationCommand.ts
@@ -88,6 +88,9 @@ export interface EnableKinesisStreamingDestinationCommandOutput
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/ExportTableToPointInTimeCommand.ts b/clients/client-dynamodb/src/commands/ExportTableToPointInTimeCommand.ts
@@ -112,6 +112,9 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin
  *             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 PointInTimeRecoveryUnavailableException} (client fault)
  *  <p>Point in time recovery has not yet been enabled for this source table.</p>

diff --git a/clients/client-dynamodb/src/commands/ImportTableCommand.ts b/clients/client-dynamodb/src/commands/ImportTableCommand.ts
@@ -216,6 +216,9 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/ListExportsCommand.ts b/clients/client-dynamodb/src/commands/ListExportsCommand.ts
@@ -83,6 +83,9 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
  *             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 DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>

diff --git a/clients/client-dynamodb/src/commands/ListImportsCommand.ts b/clients/client-dynamodb/src/commands/ListImportsCommand.ts
@@ -90,6 +90,9 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
  *             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 DynamoDBServiceException}
  * <p>Base exception class for all service exceptions from DynamoDB service.</p>

diff --git a/clients/client-dynamodb/src/commands/RestoreTableFromBackupCommand.ts b/clients/client-dynamodb/src/commands/RestoreTableFromBackupCommand.ts
@@ -291,6 +291,9 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
  *             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 TableAlreadyExistsException} (client fault)
  *  <p>A target table with the specified name already exists. </p>

diff --git a/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts b/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts
@@ -316,6 +316,9 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
  *             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 PointInTimeRecoveryUnavailableException} (client fault)
  *  <p>Point in time recovery has not yet been enabled for this source table.</p>

diff --git a/clients/client-dynamodb/src/commands/TagResourceCommand.ts b/clients/client-dynamodb/src/commands/TagResourceCommand.ts
@@ -86,6 +86,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/UntagResourceCommand.ts b/clients/client-dynamodb/src/commands/UntagResourceCommand.ts
@@ -81,6 +81,9 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts b/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts
@@ -254,6 +254,9 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
  *             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 ReplicaNotFoundException} (client fault)
  *  <p>The specified replica is no longer part of the global table.</p>

diff --git a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts
@@ -331,6 +331,9 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts
@@ -215,6 +215,9 @@ export interface UpdateTableReplicaAutoScalingCommandOutput
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts b/clients/client-dynamodb/src/commands/UpdateTimeToLiveCommand.ts
@@ -108,6 +108,9 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _
  *             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 ResourceInUseException} (client fault)
  *  <p>The operation conflicts with the resource's availability. For example, you

diff --git a/clients/client-dynamodb/src/models/models_0.ts b/clients/client-dynamodb/src/models/models_0.ts
@@ -452,7 +452,7 @@ export interface KeySchemaElement {
 export interface ProvisionedThroughput {
   /**
    * <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
-   *             returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
+   *             returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
    *                 Developer Guide</i>.</p>
    *          <p>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to
    *             0.</p>
@@ -461,7 +461,7 @@ export interface ProvisionedThroughput {
 
   /**
    * <p>The maximum number of writes consumed per second before DynamoDB returns a
-   *                 <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
+   *                 <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
    *                 Developer Guide</i>.</p>
    *          <p>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to
    *             0.</p>
@@ -1615,6 +1615,9 @@ export interface CreateBackupOutput {
  *             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";