Skip to content

Commit

Permalink
docs(client-dynamodb): Doc only updates for DynamoDB documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Mar 6, 2024
1 parent d430c2c commit 6859832
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
* <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
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html">DescribeTable</a> instead.
* 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>
* Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
Expand Down
8 changes: 6 additions & 2 deletions clients/client-dynamodb/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export type ScalarAttributeType = (typeof ScalarAttributeType)[keyof typeof Scal

/**
* @public
* <p>Represents an attribute for describing the key schema for the table and
* <p>Represents an attribute for describing the schema for the table and
* indexes.</p>
*/
export interface AttributeDefinition {
Expand Down Expand Up @@ -640,6 +640,7 @@ export interface Projection {
* index.</p>
* </li>
* </ul>
* <p>When using the DynamoDB console, <code>ALL</code> is selected by default.</p>
*/
ProjectionType?: ProjectionType;

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

Expand Down Expand Up @@ -10787,7 +10791,7 @@ export interface QueryInput {
* <p>A <code>FilterExpression</code> is applied after the items have already been read;
* the process of filtering does not consume any additional read capacity units.</p>
* </note>
* <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
* <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
* Guide</i>.</p>
*/
FilterExpression?: string;
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/dynamodb.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an attribute for describing the key schema for the table and\n indexes.</p>"
"smithy.api#documentation": "<p>Represents an attribute for describing the schema for the table and\n indexes.</p>"
}
},
"com.amazonaws.dynamodb#AttributeDefinitions": {
Expand Down Expand Up @@ -5469,7 +5469,7 @@
"S3BucketOwner": {
"target": "com.amazonaws.dynamodb#S3BucketOwner",
"traits": {
"smithy.api#documentation": "<p>The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.</p>"
"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>"
}
},
"S3Prefix": {
Expand Down Expand Up @@ -8012,7 +8012,7 @@
"ProjectionType": {
"target": "com.amazonaws.dynamodb#ProjectionType",
"traits": {
"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>"
"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>"
}
},
"NonKeyAttributes": {
Expand Down Expand Up @@ -8529,7 +8529,7 @@
"FilterExpression": {
"target": "com.amazonaws.dynamodb#ConditionExpression",
"traits": {
"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>"
"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>"
}
},
"KeyConditionExpression": {
Expand Down Expand Up @@ -11450,7 +11450,7 @@
"aws.api#clientDiscoveredEndpoint": {
"required": false
},
"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>"
"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>"
}
},
"com.amazonaws.dynamodb#UpdateGlobalTableInput": {
Expand Down

0 comments on commit 6859832

Please sign in to comment.