Skip to content

Commit 6859832

Browse files
author
awstools
committed
docs(client-dynamodb): Doc only updates for DynamoDB documentation
1 parent d430c2c commit 6859832

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
4848
* <p>
4949
* This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
5050
* 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
51-
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html">DescribeTable</a> instead.
51+
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html">UpdateTable</a> instead.
5252
* </p>
5353
* <p>
5454
* Although you can use <code>UpdateGlobalTable</code> to add replicas and remove

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export type ScalarAttributeType = (typeof ScalarAttributeType)[keyof typeof Scal
8585

8686
/**
8787
* @public
88-
* <p>Represents an attribute for describing the key schema for the table and
88+
* <p>Represents an attribute for describing the schema for the table and
8989
* indexes.</p>
9090
*/
9191
export interface AttributeDefinition {
@@ -640,6 +640,7 @@ export interface Projection {
640640
* index.</p>
641641
* </li>
642642
* </ul>
643+
* <p>When using the DynamoDB console, <code>ALL</code> is selected by default.</p>
643644
*/
644645
ProjectionType?: ProjectionType;
645646

@@ -5153,6 +5154,9 @@ export interface ExportTableToPointInTimeInput {
51535154
* @public
51545155
* <p>The ID of the Amazon Web Services account that owns the bucket the export will be
51555156
* stored in.</p>
5157+
* <note>
5158+
* <p>S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.</p>
5159+
* </note>
51565160
*/
51575161
S3BucketOwner?: string;
51585162

@@ -10787,7 +10791,7 @@ export interface QueryInput {
1078710791
* <p>A <code>FilterExpression</code> is applied after the items have already been read;
1078810792
* the process of filtering does not consume any additional read capacity units.</p>
1078910793
* </note>
10790-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer
10794+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html">Filter Expressions</a> in the <i>Amazon DynamoDB Developer
1079110795
* Guide</i>.</p>
1079210796
*/
1079310797
FilterExpression?: string;

codegen/sdk-codegen/aws-models/dynamodb.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
}
118118
},
119119
"traits": {
120-
"smithy.api#documentation": "<p>Represents an attribute for describing the key schema for the table and\n indexes.</p>"
120+
"smithy.api#documentation": "<p>Represents an attribute for describing the schema for the table and\n indexes.</p>"
121121
}
122122
},
123123
"com.amazonaws.dynamodb#AttributeDefinitions": {
@@ -5469,7 +5469,7 @@
54695469
"S3BucketOwner": {
54705470
"target": "com.amazonaws.dynamodb#S3BucketOwner",
54715471
"traits": {
5472-
"smithy.api#documentation": "<p>The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.</p>"
5472+
"smithy.api#documentation": "<p>The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.</p>\n <note>\n <p>S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.</p>\n </note>"
54735473
}
54745474
},
54755475
"S3Prefix": {
@@ -8012,7 +8012,7 @@
80128012
"ProjectionType": {
80138013
"target": "com.amazonaws.dynamodb#ProjectionType",
80148014
"traits": {
8015-
"smithy.api#documentation": "<p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p>\n <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p>\n <code>INCLUDE</code> - In addition to the attributes described in\n <code>KEYS_ONLY</code>, the secondary index will include other non-key\n attributes that you specify.</p>\n </li>\n <li>\n <p>\n <code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>"
8015+
"smithy.api#documentation": "<p>The set of attributes that are projected into the index:</p>\n <ul>\n <li>\n <p>\n <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the\n index.</p>\n </li>\n <li>\n <p>\n <code>INCLUDE</code> - In addition to the attributes described in\n <code>KEYS_ONLY</code>, the secondary index will include other non-key\n attributes that you specify.</p>\n </li>\n <li>\n <p>\n <code>ALL</code> - All of the table attributes are projected into the\n index.</p>\n </li>\n </ul>\n <p>When using the DynamoDB console, <code>ALL</code> is selected by default.</p>"
80168016
}
80178017
},
80188018
"NonKeyAttributes": {
@@ -8529,7 +8529,7 @@
85298529
"FilterExpression": {
85308530
"target": "com.amazonaws.dynamodb#ConditionExpression",
85318531
"traits": {
8532-
"smithy.api#documentation": "<p>A string that contains conditions that DynamoDB applies after the <code>Query</code>\n operation, but before the data is returned to you. Items that do not satisfy the\n <code>FilterExpression</code> criteria are not returned.</p>\n <p>A <code>FilterExpression</code> does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.</p>\n <note>\n <p>A <code>FilterExpression</code> is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.</p>\n </note>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression\">Filter Expressions</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>"
8532+
"smithy.api#documentation": "<p>A string that contains conditions that DynamoDB applies after the <code>Query</code>\n operation, but before the data is returned to you. Items that do not satisfy the\n <code>FilterExpression</code> criteria are not returned.</p>\n <p>A <code>FilterExpression</code> does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.</p>\n <note>\n <p>A <code>FilterExpression</code> is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.</p>\n </note>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html\">Filter Expressions</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>"
85338533
}
85348534
},
85358535
"KeyConditionExpression": {
@@ -11450,7 +11450,7 @@
1145011450
"aws.api#clientDiscoveredEndpoint": {
1145111451
"required": false
1145211452
},
11453-
"smithy.api#documentation": "<p>Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.</p>\n <important>\n <p>This operation only applies to <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html\">Version\n 2017.11.29 (Legacy)</a> of global tables. We recommend using\n <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html\">Version 2019.11.21 (Current)</a>\n when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than \n 2017.11.29 (Legacy). To determine which version you are using, see \n <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html\">Determining the version</a>. \n To update existing global tables from version 2017.11.29 (Legacy) to version\n 2019.11.21 (Current), see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html\">\n Updating global tables</a>.\n </p>\n </important>\n <note>\n <p>\n This operation only applies to <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html\">Version\n 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\n 2019.11.21</a> you can use <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html\">DescribeTable</a> instead.\n </p>\n <p>\n Although you can use <code>UpdateGlobalTable</code> to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.\n </p>\n </note>\n <p> If global secondary indexes are specified, then the following conditions must also be\n met: </p>\n <ul>\n <li>\n <p> The global secondary indexes must have the same name. </p>\n </li>\n <li>\n <p> The global secondary indexes must have the same hash key and sort key (if\n present). </p>\n </li>\n <li>\n <p> The global secondary indexes must have the same provisioned and maximum write\n capacity units. </p>\n </li>\n </ul>"
11453+
"smithy.api#documentation": "<p>Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.</p>\n <important>\n <p>This operation only applies to <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html\">Version\n 2017.11.29 (Legacy)</a> of global tables. We recommend using\n <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html\">Version 2019.11.21 (Current)</a>\n when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than \n 2017.11.29 (Legacy). To determine which version you are using, see \n <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html\">Determining the version</a>. \n To update existing global tables from version 2017.11.29 (Legacy) to version\n 2019.11.21 (Current), see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html\">\n Updating global tables</a>.\n </p>\n </important>\n <note>\n <p>\n This operation only applies to <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html\">Version\n 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\n 2019.11.21</a> you can use <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html\">UpdateTable</a> instead.\n </p>\n <p>\n Although you can use <code>UpdateGlobalTable</code> to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.\n </p>\n </note>\n <p> If global secondary indexes are specified, then the following conditions must also be\n met: </p>\n <ul>\n <li>\n <p> The global secondary indexes must have the same name. </p>\n </li>\n <li>\n <p> The global secondary indexes must have the same hash key and sort key (if\n present). </p>\n </li>\n <li>\n <p> The global secondary indexes must have the same provisioned and maximum write\n capacity units. </p>\n </li>\n </ul>"
1145411454
}
1145511455
},
1145611456
"com.amazonaws.dynamodb#UpdateGlobalTableInput": {

0 commit comments

Comments
 (0)