Skip to content

Commit 249cd33

Browse files
author
awstools
committed
docs(client-dynamodb): Doc-only update for DynamoDB. Fixed Important note in 6 Global table APIs - CreateGlobalTable, DescribeGlobalTable, DescribeGlobalTableSettings, ListGlobalTables, UpdateGlobalTable, and UpdateGlobalTableSettings.
1 parent 622edd0 commit 249cd33

File tree

7 files changed

+18
-48
lines changed

7 files changed

+18
-48
lines changed

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,8 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
3232
* relationship between two or more DynamoDB tables with the same table name in the
3333
* provided Regions. </p>
3434
* <important>
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
36-
* 2017.11.29 (Legacy). To determine which version you are using, see
37-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
38-
* To update existing global tables from version 2017.11.29 (Legacy) to version
39-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
40-
* Updating global tables</a>.
41-
* </p>
35+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
36+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4237
* </important>
4338
* <p>If you want to add a new replica table to a global table, each of the following
4439
* conditions must be true:</p>

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,8 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
3030
/**
3131
* <p>Returns information about the specified global table.</p>
3232
* <important>
33-
* <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
34-
* 2017.11.29 (Legacy). To determine which version you are using, see
35-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
36-
* To update existing global tables from version 2017.11.29 (Legacy) to version
37-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
38-
* Updating global tables</a>.
39-
* </p>
33+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
34+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4035
* </important>
4136
* @example
4237
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,8 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
3030
/**
3131
* <p>Describes Region-specific settings for a global table.</p>
3232
* <important>
33-
* <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
34-
* 2017.11.29 (Legacy). To determine which version you are using, see
35-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
36-
* To update existing global tables from version 2017.11.29 (Legacy) to version
37-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
38-
* Updating global tables</a>.
39-
* </p>
33+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
34+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4035
* </important>
4136
* @example
4237
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,8 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
3030
/**
3131
* <p>Lists all global tables that have a replica in the specified Region.</p>
3232
* <important>
33-
* <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
34-
* 2017.11.29 (Legacy). To determine which version you are using, see
35-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
36-
* To update existing global tables from version 2017.11.29 (Legacy) to version
37-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
38-
* Updating global tables</a>.
39-
* </p>
33+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
34+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4035
* </important>
4136
* @example
4237
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,8 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
3333
* same name as the global table, have the same key schema, have DynamoDB Streams enabled,
3434
* and have the same provisioned and maximum write capacity units.</p>
3535
* <important>
36-
* <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
37-
* 2017.11.29 (Legacy). To determine which version you are using, see
38-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
39-
* To update existing global tables from version 2017.11.29 (Legacy) to version
40-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
41-
* Updating global tables</a>.
42-
* </p>
36+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
37+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4338
* </important>
4439
* <note>
4540
* <p>

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,8 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
3030
/**
3131
* <p>Updates settings for a global table.</p>
3232
* <important>
33-
* <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
34-
* 2017.11.29 (Legacy). To determine which version you are using, see
35-
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
36-
* To update existing global tables from version 2017.11.29 (Legacy) to version
37-
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
38-
* Updating global tables</a>.
39-
* </p>
33+
* <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
34+
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
4035
* </important>
4136
* @example
4237
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)