docs(client-dynamodb): Documentation only updates for DynamoDB.

aws · May 24, 2024 · e087be2 · e087be2
1 parent 256ea55
commit e087be2
Show file tree

Hide file tree

Showing 14 changed files with 55 additions and 76 deletions.
diff --git a/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts b/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts
@@ -108,6 +108,11 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
  *             <li>
  *                <p>The total request size exceeds 16 MB.</p>
  *             </li>
+ *             <li>
+ *                <p>Any individual items with keys exceeding the key length limits. For a
+ *                     partition key, the limit is 2048 bytes and for a sort key, the limit is 1024
+ *                     bytes.</p>
+ *             </li>
  *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-dynamodb/src/commands/CreateGlobalTableCommand.ts b/clients/client-dynamodb/src/commands/CreateGlobalTableCommand.ts
@@ -31,10 +31,7 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
  *             relationship between two or more DynamoDB tables with the same table name in the
  *             provided Regions. </p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version

diff --git a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts
@@ -36,8 +36,7 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
  *             returns a <code>ResourceNotFoundException</code>. If table is already in the
  *                 <code>DELETING</code> state, no error is returned. </p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 of global tables.
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
  *             </p>
  *          </important>
  *          <note>

diff --git a/clients/client-dynamodb/src/commands/DescribeGlobalTableCommand.ts b/clients/client-dynamodb/src/commands/DescribeGlobalTableCommand.ts
@@ -29,10 +29,7 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
 /**
  * <p>Returns information about the specified global table.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version

diff --git a/clients/client-dynamodb/src/commands/DescribeGlobalTableSettingsCommand.ts b/clients/client-dynamodb/src/commands/DescribeGlobalTableSettingsCommand.ts
@@ -29,10 +29,7 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
 /**
  * <p>Describes Region-specific settings for a global table.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version

diff --git a/clients/client-dynamodb/src/commands/DescribeTableCommand.ts b/clients/client-dynamodb/src/commands/DescribeTableCommand.ts
@@ -30,8 +30,7 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
  * <p>Returns information about the table, including the current status of the table, when
  *             it was created, the primary key schema, and any indexes on the table.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 of global tables.
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
  *             </p>
  *          </important>
  *          <note>

diff --git a/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts
@@ -34,8 +34,7 @@ export interface DescribeTableReplicaAutoScalingCommandOutput
 /**
  * <p>Describes auto scaling settings across replicas of the global table at once.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *             of global tables.</p>
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).</p>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-dynamodb/src/commands/ListGlobalTablesCommand.ts b/clients/client-dynamodb/src/commands/ListGlobalTablesCommand.ts
@@ -29,10 +29,7 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
 /**
  * <p>Lists all global tables that have a replica in the specified Region.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version

diff --git a/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts
@@ -32,10 +32,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
  *             same name as the global table, have the same key schema, have DynamoDB Streams enabled,
  *             and have the same provisioned and maximum write capacity units.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version
@@ -45,8 +42,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
  *          </important>
  *          <note>
  *             <p>
- *                 This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                     2017.11.29</a> of global tables. If you are using global tables <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
+ *                 For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Version
  *                         2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html">UpdateTable</a> instead.
  *             </p>
  *             <p>

diff --git a/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts b/clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts
@@ -29,10 +29,7 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
 /**
  * <p>Updates settings for a global table.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
- *                 2017.11.29 (Legacy)</a> of global tables. We recommend using
- *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than
  *                 2017.11.29 (Legacy). To determine which version you are using, see
  *                 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
  *                 To update existing global tables from version 2017.11.29 (Legacy) to version

diff --git a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts
@@ -30,8 +30,7 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
  * <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
  *             Streams settings for a given table.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 of global tables.
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
  *             </p>
  *          </important>
  *          <p>You can only perform one of the following operations at once:</p>

diff --git a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts
@@ -34,8 +34,7 @@ export interface UpdateTableReplicaAutoScalingCommandOutput
 /**
  * <p>Updates auto scaling settings on your global tables at once.</p>
  *          <important>
- *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
- *                 of global tables.
+ *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
  *             </p>
  *          </important>
  * @example