Skip to content

Commit e087be2

Browse files
author
awstools
committed
docs(client-dynamodb): Documentation only updates for DynamoDB.
1 parent 256ea55 commit e087be2

14 files changed

+55
-76
lines changed

clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
108108
* <li>
109109
* <p>The total request size exceeds 16 MB.</p>
110110
* </li>
111+
* <li>
112+
* <p>Any individual items with keys exceeding the key length limits. For a
113+
* partition key, the limit is 2048 bytes and for a sort key, the limit is 1024
114+
* bytes.</p>
115+
* </li>
111116
* </ul>
112117
* @example
113118
* Use a bare-bones client and the command you need to make an API call.

clients/client-dynamodb/src/commands/CreateGlobalTableCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,7 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
3131
* relationship between two or more DynamoDB tables with the same table name in the
3232
* provided Regions. </p>
3333
* <important>
34-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
35-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
36-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
37-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
34+
* <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
3835
* 2017.11.29 (Legacy). To determine which version you are using, see
3936
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
4037
* To update existing global tables from version 2017.11.29 (Legacy) to version

clients/client-dynamodb/src/commands/DeleteTableCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
3636
* returns a <code>ResourceNotFoundException</code>. If table is already in the
3737
* <code>DELETING</code> state, no error is returned. </p>
3838
* <important>
39-
* <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>
40-
* of global tables.
39+
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
4140
* </p>
4241
* </important>
4342
* <note>

clients/client-dynamodb/src/commands/DescribeGlobalTableCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
2929
/**
3030
* <p>Returns information about the specified global table.</p>
3131
* <important>
32-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
33-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
34-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
35-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
32+
* <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
3633
* 2017.11.29 (Legacy). To determine which version you are using, see
3734
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
3835
* To update existing global tables from version 2017.11.29 (Legacy) to version

clients/client-dynamodb/src/commands/DescribeGlobalTableSettingsCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
2929
/**
3030
* <p>Describes Region-specific settings for a global table.</p>
3131
* <important>
32-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
33-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
34-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
35-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
32+
* <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
3633
* 2017.11.29 (Legacy). To determine which version you are using, see
3734
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
3835
* To update existing global tables from version 2017.11.29 (Legacy) to version

clients/client-dynamodb/src/commands/DescribeTableCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
3030
* <p>Returns information about the table, including the current status of the table, when
3131
* it was created, the primary key schema, and any indexes on the table.</p>
3232
* <important>
33-
* <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>
34-
* of global tables.
33+
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
3534
* </p>
3635
* </important>
3736
* <note>

clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ export interface DescribeTableReplicaAutoScalingCommandOutput
3434
/**
3535
* <p>Describes auto scaling settings across replicas of the global table at once.</p>
3636
* <important>
37-
* <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>
38-
* of global tables.</p>
37+
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).</p>
3938
* </important>
4039
* @example
4140
* Use a bare-bones client and the command you need to make an API call.

clients/client-dynamodb/src/commands/ListGlobalTablesCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
2929
/**
3030
* <p>Lists all global tables that have a replica in the specified Region.</p>
3131
* <important>
32-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
33-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
34-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
35-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
32+
* <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
3633
* 2017.11.29 (Legacy). To determine which version you are using, see
3734
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
3835
* To update existing global tables from version 2017.11.29 (Legacy) to version

clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
3232
* same name as the global table, have the same key schema, have DynamoDB Streams enabled,
3333
* and have the same provisioned and maximum write capacity units.</p>
3434
* <important>
35-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
36-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
37-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
38-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
35+
* <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
3936
* 2017.11.29 (Legacy). To determine which version you are using, see
4037
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
4138
* To update existing global tables from version 2017.11.29 (Legacy) to version
@@ -45,8 +42,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
4542
* </important>
4643
* <note>
4744
* <p>
48-
* This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
49-
* 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
45+
* 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
5046
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html">UpdateTable</a> instead.
5147
* </p>
5248
* <p>

clients/client-dynamodb/src/commands/UpdateGlobalTableSettingsCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
2929
/**
3030
* <p>Updates settings for a global table.</p>
3131
* <important>
32-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
33-
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
34-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
35-
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
32+
* <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
3633
* 2017.11.29 (Legacy). To determine which version you are using, see
3734
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
3835
* To update existing global tables from version 2017.11.29 (Legacy) to version

clients/client-dynamodb/src/commands/UpdateTableCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
3030
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
3131
* Streams settings for a given table.</p>
3232
* <important>
33-
* <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>
34-
* of global tables.
33+
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
3534
* </p>
3635
* </important>
3736
* <p>You can only perform one of the following operations at once:</p>

clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ export interface UpdateTableReplicaAutoScalingCommandOutput
3434
/**
3535
* <p>Updates auto scaling settings on your global tables at once.</p>
3636
* <important>
37-
* <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>
38-
* of global tables.
37+
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
3938
* </p>
4039
* </important>
4140
* @example

0 commit comments

Comments
 (0)