From f51647a5ff7550c4cf83c6afd1d96830beef00c5 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 24 Jul 2024 18:26:03 +0000 Subject: [PATCH] docs(client-dynamodb): DynamoDB doc only update for July --- .../src/auth/httpAuthSchemeProvider.ts | 2 +- .../commands/BatchExecuteStatementCommand.ts | 3 +- .../src/commands/BatchGetItemCommand.ts | 8 +- .../src/commands/BatchWriteItemCommand.ts | 19 +- .../commands/DeleteResourcePolicyCommand.ts | 21 +- .../src/commands/DeleteTableCommand.ts | 7 +- .../src/commands/DescribeEndpointsCommand.ts | 4 +- .../src/commands/DescribeTableCommand.ts | 4 +- .../DescribeTableReplicaAutoScalingCommand.ts | 3 +- ...sableKinesisStreamingDestinationCommand.ts | 4 +- .../src/commands/ExecuteStatementCommand.ts | 4 +- .../src/commands/GetResourcePolicyCommand.ts | 32 ++- .../src/commands/ListBackupsCommand.ts | 14 +- .../src/commands/PutItemCommand.ts | 3 +- .../src/commands/PutResourcePolicyCommand.ts | 19 +- .../RestoreTableToPointInTimeCommand.ts | 4 +- .../src/commands/ScanCommand.ts | 55 ++-- .../src/commands/UpdateGlobalTableCommand.ts | 13 +- .../src/commands/UpdateTableCommand.ts | 4 +- .../UpdateTableReplicaAutoScalingCommand.ts | 4 +- .../client-dynamodb/src/models/models_0.ts | 242 +++++++++++------- codegen/sdk-codegen/aws-models/dynamodb.json | 156 +++++------ 22 files changed, 370 insertions(+), 255 deletions(-) diff --git a/clients/client-dynamodb/src/auth/httpAuthSchemeProvider.ts b/clients/client-dynamodb/src/auth/httpAuthSchemeProvider.ts index fc5e6431dba93..c53a68b67152b 100644 --- a/clients/client-dynamodb/src/auth/httpAuthSchemeProvider.ts +++ b/clients/client-dynamodb/src/auth/httpAuthSchemeProvider.ts @@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: DynamoDBHttpAuthScheme name: "dynamodb", region: authParameters.region, }, - propertiesExtractor: (config: DynamoDBClientConfig, context) => ({ + propertiesExtractor: (config: Partial, context) => ({ /** * @internal */ diff --git a/clients/client-dynamodb/src/commands/BatchExecuteStatementCommand.ts b/clients/client-dynamodb/src/commands/BatchExecuteStatementCommand.ts index 75bb4902fafeb..6388b68f990e9 100644 --- a/clients/client-dynamodb/src/commands/BatchExecuteStatementCommand.ts +++ b/clients/client-dynamodb/src/commands/BatchExecuteStatementCommand.ts @@ -31,7 +31,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen *

This operation allows you to perform batch reads or writes on data stored in DynamoDB, * using PartiQL. Each read statement in a BatchExecuteStatement must specify * an equality condition on all key attributes. This enforces that each SELECT - * statement in a batch returns at most a single item.

+ * statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB + * .

* *

The entire batch must consist of either read statements or write statements, you * cannot mix both in one batch.

diff --git a/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts b/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts index cd9cbb1eda667..11c0dcd6ac07f 100644 --- a/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts +++ b/clients/client-dynamodb/src/commands/BatchGetItemCommand.ts @@ -32,10 +32,10 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat * from one or more tables. You identify requested items by primary key.

*

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 * items. BatchGetItem returns a partial result if the response size limit is - * exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, - * or an internal processing failure occurs. If a partial result is returned, the operation returns a value for - * UnprocessedKeys. You can use this value to retry the operation starting - * with the next item to get.

+ * exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is + * requested, or an internal processing failure occurs. If a partial result is returned, + * the operation returns a value for UnprocessedKeys. You can use this value + * to retry the operation starting with the next item to get.

* *

If you request more than 100 items, BatchGetItem returns a * ValidationException with the message "Too many items requested for diff --git a/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts b/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts index f8adc32b195d0..4faa7b90cf633 100644 --- a/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts +++ b/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts @@ -36,10 +36,10 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met * for the API call. For more details on this distinction, see Naming Rules and Data Types.

* *

- * BatchWriteItem cannot update items. If you perform a BatchWriteItem - * operation on an existing item, that item's values will be overwritten by the - * operation and it will appear like it was updated. To update items, we recommend you - * use the UpdateItem action.

+ * BatchWriteItem cannot update items. If you perform a + * BatchWriteItem operation on an existing item, that item's values + * will be overwritten by the operation and it will appear like it was updated. To + * update items, we recommend you use the UpdateItem action.

* *

The individual PutItem and DeleteItem operations specified * in BatchWriteItem are atomic; however BatchWriteItem as a @@ -50,10 +50,13 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met * BatchWriteItem in a loop. Each iteration would check for unprocessed * items and submit a new BatchWriteItem request with those unprocessed items * until all items have been processed.

- *

If none of the items can be processed due to insufficient - * provisioned throughput on all of the tables in the request, then - * BatchWriteItem returns a - * ProvisionedThroughputExceededException.

+ *

For tables and indexes with provisioned capacity, if none of the items can be + * processed due to insufficient provisioned throughput on all of the tables in the + * request, then BatchWriteItem returns a + * ProvisionedThroughputExceededException. For all tables and indexes, if + * none of the items can be processed due to other throttling scenarios (such as exceeding + * partition level limits), then BatchWriteItem returns a + * ThrottlingException.

* *

If DynamoDB returns any unprocessed items, you should retry the batch operation on * those items. However, we strongly recommend that you use an exponential diff --git a/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts index c11e02cc55b46..7eacb74462a07 100644 --- a/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-dynamodb/src/commands/DeleteResourcePolicyCommand.ts @@ -28,16 +28,27 @@ export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyIn export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyOutput, __MetadataBearer {} /** - *

Deletes the resource-based policy attached to the resource, which can be a table or stream.

+ *

Deletes the resource-based policy attached to the resource, which can be a table or + * stream.

*

- * DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

+ * DeleteResourcePolicy is an idempotent operation; running it multiple + * times on the same resource doesn't result in an error response, + * unless you specify an ExpectedRevisionId, which will then return a + * PolicyNotFoundException.

* - *

To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access. - *

+ *

To make sure that you don't inadvertently lock yourself out of your own resources, + * the root principal in your Amazon Web Services account can perform + * DeleteResourcePolicy requests, even if your resource-based policy + * explicitly denies the root principal's access.

* * *

- * DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

+ * DeleteResourcePolicy is an asynchronous operation. If you issue a + * GetResourcePolicy request immediately after running the + * DeleteResourcePolicy request, DynamoDB might still return + * the deleted policy. This is because the policy for your resource might not have been + * deleted yet. Wait for a few seconds, and then try the GetResourcePolicy + * request again.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts index 0bee95f2cb09a..0766d492b52f4 100644 --- a/clients/client-dynamodb/src/commands/DeleteTableCommand.ts +++ b/clients/client-dynamodb/src/commands/DeleteTableCommand.ts @@ -37,13 +37,14 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB * returns a ResourceNotFoundException. If table is already in the * DELETING state, no error is returned.

* - *

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). - *

+ *

For global tables, this operation only applies to + * global tables using Version 2019.11.21 (Current version).

* * *

DynamoDB might continue to accept data read and write operations, such as * GetItem and PutItem, on a table in the - * DELETING state until the table deletion is complete.

+ * DELETING state until the table deletion is complete. For the full + * list of table states, see TableStatus.

* *

When you delete a table, any indexes on that table are also deleted.

*

If you have DynamoDB Streams enabled on the table, then the corresponding stream on diff --git a/clients/client-dynamodb/src/commands/DescribeEndpointsCommand.ts b/clients/client-dynamodb/src/commands/DescribeEndpointsCommand.ts index 17f92410207af..fbacc2bc25d3e 100644 --- a/clients/client-dynamodb/src/commands/DescribeEndpointsCommand.ts +++ b/clients/client-dynamodb/src/commands/DescribeEndpointsCommand.ts @@ -28,8 +28,8 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {} /** - *

Returns the regional endpoint information. For more information - * on policy permissions, please see Internetwork traffic privacy.

+ *

Returns the regional endpoint information. For more information on policy permissions, + * please see Internetwork traffic privacy.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-dynamodb/src/commands/DescribeTableCommand.ts b/clients/client-dynamodb/src/commands/DescribeTableCommand.ts index cdc8db89afff4..98bee08fe1aba 100644 --- a/clients/client-dynamodb/src/commands/DescribeTableCommand.ts +++ b/clients/client-dynamodb/src/commands/DescribeTableCommand.ts @@ -31,8 +31,8 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad *

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.

* - *

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). - *

+ *

For global tables, this operation only applies to global tables using Version + * 2019.11.21 (Current version).

* * *

If you issue a DescribeTable request immediately after a diff --git a/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts index 07055a899e670..4498beb413676 100644 --- a/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts +++ b/clients/client-dynamodb/src/commands/DescribeTableReplicaAutoScalingCommand.ts @@ -35,7 +35,8 @@ export interface DescribeTableReplicaAutoScalingCommandOutput /** *

Describes auto scaling settings across replicas of the global table at once.

* - *

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

+ *

For global tables, this operation only applies to global tables using Version + * 2019.11.21 (Current version).

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts index 0eec617345625..6a5a1cc74c070 100644 --- a/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/src/commands/DisableKinesisStreamingDestinationCommand.ts @@ -33,8 +33,8 @@ export interface DisableKinesisStreamingDestinationCommandOutput __MetadataBearer {} /** - *

Stops replication from the DynamoDB table to the Kinesis data stream. This is done - * without deleting either of the resources.

+ *

Stops replication from the DynamoDB table to the Kinesis data stream. This + * is done without deleting either of the resources.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-dynamodb/src/commands/ExecuteStatementCommand.ts b/clients/client-dynamodb/src/commands/ExecuteStatementCommand.ts index 2d45b4432930f..b3cc9f8cda0a9 100644 --- a/clients/client-dynamodb/src/commands/ExecuteStatementCommand.ts +++ b/clients/client-dynamodb/src/commands/ExecuteStatementCommand.ts @@ -39,8 +39,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _ * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any * filtering to the results using WHERE clause). If * LastEvaluatedKey is present in the response, you need to paginate the - * result set. If NextToken is present, you need to paginate the result set and include - * NextToken.

+ * result set. If NextToken is present, you need to paginate the result set + * and include NextToken.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-dynamodb/src/commands/GetResourcePolicyCommand.ts b/clients/client-dynamodb/src/commands/GetResourcePolicyCommand.ts index 2c15df5c0907e..8248fc41ec36f 100644 --- a/clients/client-dynamodb/src/commands/GetResourcePolicyCommand.ts +++ b/clients/client-dynamodb/src/commands/GetResourcePolicyCommand.ts @@ -28,24 +28,42 @@ export interface GetResourcePolicyCommandInput extends GetResourcePolicyInput {} export interface GetResourcePolicyCommandOutput extends GetResourcePolicyOutput, __MetadataBearer {} /** - *

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

+ *

Returns the resource-based policy document attached to the resource, which can be a + * table or stream, in JSON format.

*

* GetResourcePolicy follows an * eventually consistent - * model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

+ * model. The following list + * describes the outcomes when you issue the GetResourcePolicy request + * immediately after issuing another request:

*
    *
  • - *

    If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

    + *

    If you issue a GetResourcePolicy request immediately after a + * PutResourcePolicy request, DynamoDB might return a + * PolicyNotFoundException.

    *
    • *
  • - *

    If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

    + *

    If you issue a GetResourcePolicyrequest immediately after a + * DeleteResourcePolicy request, DynamoDB might return + * the policy that was present before the deletion request.

    *
    • *
  • - *

    If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

    + *

    If you issue a GetResourcePolicy request immediately after a + * CreateTable request, which includes a resource-based policy, + * DynamoDB might return a ResourceNotFoundException or + * a PolicyNotFoundException.

    *
    • *
- *

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

- *

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

+ *

Because GetResourcePolicy uses an eventually + * consistent query, the metadata for your policy or table might not be + * available at that moment. Wait for a few seconds, and then retry the + * GetResourcePolicy request.

+ *

After a GetResourcePolicy request returns a policy created using the + * PutResourcePolicy request, the policy will be applied in the + * authorization of requests to the resource. Because this process is eventually + * consistent, it will take some time to apply the policy to all requests to a resource. + * Policies that you attach while creating a table using the CreateTable + * request will always be applied to all requests for that table.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-dynamodb/src/commands/ListBackupsCommand.ts b/clients/client-dynamodb/src/commands/ListBackupsCommand.ts index 61089dd51c0d8..763b7b6cd036c 100644 --- a/clients/client-dynamodb/src/commands/ListBackupsCommand.ts +++ b/clients/client-dynamodb/src/commands/ListBackupsCommand.ts @@ -28,15 +28,17 @@ export interface ListBackupsCommandInput extends ListBackupsInput {} export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataBearer {} /** - *

List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. - * To list these backups for a given table, specify TableName. ListBackups returns a - * paginated list of results with at most 1 MB worth of items in a page. You can also - * specify a maximum number of entries to be returned in a page.

+ *

List DynamoDB backups that are associated with an Amazon Web Services account and + * weren't made with Amazon Web Services Backup. To list these backups for a given table, + * specify TableName. ListBackups returns a paginated list of + * results with at most 1 MB worth of items in a page. You can also specify a maximum + * number of entries to be returned in a page.

*

In the request, start time is inclusive, but end time is exclusive. Note that these * boundaries are for the time at which the original backup was requested.

*

You can call ListBackups a maximum of five times per second.

- *

If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the - * Amazon Web Services Backup list API. + *

If you want to retrieve the complete list of backups made with Amazon Web Services + * Backup, use the Amazon Web Services Backup + * list API. *

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/commands/PutItemCommand.ts b/clients/client-dynamodb/src/commands/PutItemCommand.ts index 24ef2062c91ae..580e25e062867 100644 --- a/clients/client-dynamodb/src/commands/PutItemCommand.ts +++ b/clients/client-dynamodb/src/commands/PutItemCommand.ts @@ -34,8 +34,7 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {} * a new item if one with the specified primary key doesn't exist), or replace an existing * item if it has certain attribute values. You can return the item's attribute values in * the same operation, using the ReturnValues parameter.

- *

When you add an item, the primary key attributes are the only required attributes. - *

+ *

When you add an item, the primary key attributes are the only required attributes.

*

Empty String and Binary attribute values are allowed. Attribute values of type String * and Binary must have a length greater than zero if the attribute is used as a key * attribute for a table or index. Set type attributes cannot be empty.

diff --git a/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts b/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts index f5ad724fe3d93..ff94318ac117e 100644 --- a/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts +++ b/clients/client-dynamodb/src/commands/PutResourcePolicyCommand.ts @@ -28,14 +28,27 @@ export interface PutResourcePolicyCommandInput extends PutResourcePolicyInput {} export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput, __MetadataBearer {} /** - *

Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is + *

Attaches a resource-based policy document to the resource, which can be a table or + * stream. When you attach a resource-based policy using this API, the policy application + * is * eventually consistent * .

*

- * PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

+ * PutResourcePolicy is an idempotent operation; running it multiple times + * on the same resource using the same policy document will return the same revision ID. If + * you specify an ExpectedRevisionId that doesn't match the current policy's + * RevisionId, the PolicyNotFoundException will be + * returned.

* *

- * PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.

+ * PutResourcePolicy is an asynchronous operation. If you issue a + * GetResourcePolicy request immediately after a + * PutResourcePolicy request, DynamoDB might return your + * previous policy, if there was one, or return the + * PolicyNotFoundException. This is because + * GetResourcePolicy uses an eventually consistent query, and the + * metadata for your policy or table might not be available at that moment. Wait for a + * few seconds, and then try the GetResourcePolicy request again.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts b/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts index ef9548cb5d4d6..add5dc5eaec30 100644 --- a/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts +++ b/clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts @@ -34,8 +34,8 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo * users can execute up to 50 concurrent restores (any type of restore) in a given account.

*

When you restore using point in time recovery, DynamoDB restores your table data to * the state based on the selected date and time (day:hour:minute:second) to a new table.

- *

Along with data, the following are also included on the new restored table using - * point in time recovery:

+ *

Along with data, the following are also included on the new restored table using point + * in time recovery:

*
    *
  • *

    Global secondary indexes (GSIs)

    diff --git a/clients/client-dynamodb/src/commands/ScanCommand.ts b/clients/client-dynamodb/src/commands/ScanCommand.ts index 3d43202782d1f..ce9bd53ff721c 100644 --- a/clients/client-dynamodb/src/commands/ScanCommand.ts +++ b/clients/client-dynamodb/src/commands/ScanCommand.ts @@ -31,26 +31,26 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {} *

    The Scan operation returns one or more items and item attributes by * accessing every item in a table or a secondary index. To have DynamoDB return fewer * items, you can provide a FilterExpression operation.

    - *

    If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, - * the scan completes and results are returned to the user. The LastEvaluatedKey - * value is also returned and the requestor can use the LastEvaluatedKey to continue - * the scan in a subsequent operation. Each scan response also includes number of items that were - * scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result - * can result in no items meeting the criteria and the Count will result in zero. If - * you did not use a FilterExpression in the scan request, then Count is - * the same as ScannedCount.

    + *

    If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the + * scan completes and results are returned to the user. The LastEvaluatedKey + * value is also returned and the requestor can use the LastEvaluatedKey to + * continue the scan in a subsequent operation. Each scan response also includes number of + * items that were scanned (ScannedCount) as part of the request. If using a + * FilterExpression, a scan result can result in no items meeting the + * criteria and the Count will result in zero. If you did not use a + * FilterExpression in the scan request, then Count is the + * same as ScannedCount.

    * *

    - * Count and ScannedCount only return the count of items specific to a - * single scan request and, unless the table is less than 1MB, do not represent the total number - * of items in the table. - *

    + * Count and ScannedCount only return the count of items + * specific to a single scan request and, unless the table is less than 1MB, do not + * represent the total number of items in the table.

    *     - *

    A single Scan operation first reads up to the maximum number of items set (if - * using the Limit parameter) or a maximum of 1 MB of data and then applies any - * filtering to the results if a FilterExpression is provided. If - * LastEvaluatedKey is present in the response, pagination is required to complete the - * full table scan. For more information, see Paginating the + *

    A single Scan operation first reads up to the maximum number of items set + * (if using the Limit parameter) or a maximum of 1 MB of data and then + * applies any filtering to the results if a FilterExpression is provided. If + * LastEvaluatedKey is present in the response, pagination is required to + * complete the full table scan. For more information, see Paginating the * Results in the Amazon DynamoDB Developer Guide.

    *

    * Scan operations proceed sequentially; however, for faster performance on @@ -58,17 +58,18 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {} * operation by providing the Segment and TotalSegments * parameters. For more information, see Parallel * Scan in the Amazon DynamoDB Developer Guide.

    - *

    By default, a Scan uses eventually consistent reads when accessing the items in a table. - * Therefore, the results from an eventually consistent Scan may not include the latest item - * changes at the time the scan iterates through each item in the table. If you require a strongly consistent - * read of each item as the scan iterates through the items in the table, you can set the ConsistentRead - * parameter to true. Strong consistency only relates to the consistency of the read at the item level.

    + *

    By default, a Scan uses eventually consistent reads when accessing the + * items in a table. Therefore, the results from an eventually consistent Scan + * may not include the latest item changes at the time the scan iterates through each item + * in the table. If you require a strongly consistent read of each item as the scan + * iterates through the items in the table, you can set the ConsistentRead + * parameter to true. Strong consistency only relates to the consistency of the read at the + * item level.

    * - *

    - * DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead - * parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan - * see a consistent snapshot of the table when the scan operation was requested. - *

    + *

    DynamoDB does not provide snapshot isolation for a scan operation when the + * ConsistentRead parameter is set to true. Thus, a DynamoDB scan + * operation does not guarantee that all reads in a scan see a consistent snapshot of + * the table when the scan operation was requested.

    *     * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts index 694fd5af345fe..378f7f71e5694 100644 --- a/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateGlobalTableCommand.ts @@ -37,15 +37,12 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput, *

    To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

    * * - *

    - * For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version - * 2019.11.21 you can use UpdateTable instead. - *

    - *

    - * Although you can use UpdateGlobalTable to add replicas and remove + *

    For global tables, this operation only applies to global tables using Version + * 2019.11.21 (Current version). If you are using global tables Version + * 2019.11.21 you can use UpdateTable instead.

    + *

    Although you can use UpdateGlobalTable to add replicas and remove * replicas in a single request, for simplicity we recommend that you issue separate - * requests for adding or removing replicas. - *

    + * requests for adding or removing replicas.

    *     *

    If global secondary indexes are specified, then the following conditions must also be * met:

    diff --git a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts index 7c53fa3dd40dd..215223df079b9 100644 --- a/clients/client-dynamodb/src/commands/UpdateTableCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateTableCommand.ts @@ -31,8 +31,8 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB *

    Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB * Streams settings for a given table.

    * - *

    For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). - *

    + *

    For global tables, this operation only applies to global tables using Version + * 2019.11.21 (Current version).

    *     *

    You can only perform one of the following operations at once:

    *
      diff --git a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts index 8c868cbabc0aa..78834b2385df7 100644 --- a/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateTableReplicaAutoScalingCommand.ts @@ -35,8 +35,8 @@ export interface UpdateTableReplicaAutoScalingCommandOutput /** *

      Updates auto scaling settings on your global tables at once.

      * - *

      For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). - *

      + *

      For global tables, this operation only applies to global tables using Version + * 2019.11.21 (Current version).

      *       * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/models/models_0.ts b/clients/client-dynamodb/src/models/models_0.ts index 09c527689bba6..18b880acbbc67 100644 --- a/clients/client-dynamodb/src/models/models_0.ts +++ b/clients/client-dynamodb/src/models/models_0.ts @@ -1696,7 +1696,8 @@ export interface ContributorInsightsSummary { */ export interface CreateBackupInput { /** - *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this + * parameter.

      * @public */ TableName: string | undefined; @@ -2453,7 +2454,8 @@ export interface CreateTableInput { AttributeDefinitions: AttributeDefinition[] | undefined; /** - *

      The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in + * this parameter.

      * @public */ TableName: string | undefined; @@ -2729,24 +2731,35 @@ export interface CreateTableInput { TableClass?: TableClass; /** - *

      Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

      + *

      Indicates whether deletion protection is to be enabled (true) or disabled (false) on + * the table.

      * @public */ DeletionProtectionEnabled?: boolean; /** - *

      An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

      - *

      When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

      - *

      The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

      + *

      An Amazon Web Services resource-based policy document in JSON format that will be + * attached to the table.

      + *

      When you attach a resource-based policy while creating a table, the policy application + * is strongly consistent.

      + *

      The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this + * limit. For a full list of all considerations that apply for resource-based policies, see + * Resource-based + * policy considerations.

      * - *

      You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

      + *

      You need to specify the CreateTable and + * PutResourcePolicy + * IAM actions for authorizing a user to create a table with a + * resource-based policy.

      *       * @public */ ResourcePolicy?: string; /** - *

      Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      + *

      Sets the maximum number of read and write units for the specified table in on-demand + * capacity mode. If you use this parameter, you must specify + * MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      * @public */ OnDemandThroughput?: OnDemandThroughput; @@ -3649,13 +3662,20 @@ export interface DeleteReplicationGroupMemberAction { */ export interface DeleteResourcePolicyInput { /** - *

      The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.

      + *

      The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be + * removed. The resources you can specify include tables and streams. If you remove the + * policy of a table, it will also remove the permissions for the table's indexes defined + * in that policy document. This is because index permissions are defined in the table's + * policy.

      * @public */ ResourceArn: string | undefined; /** - *

      A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.

      + *

      A string value that you can use to conditionally delete your policy. When you provide + * an expected revision ID, if the revision ID of the existing policy on the resource + * doesn't match or if there's no policy attached to the resource, the request will fail + * and return a PolicyNotFoundException.

      * @public */ ExpectedRevisionId?: string; @@ -3667,7 +3687,8 @@ export interface DeleteResourcePolicyInput { export interface DeleteResourcePolicyOutput { /** *

      A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

      - *

      This value will be empty if you make a request against a resource without a policy.

      + *

      This value will be empty if you make a request against a resource without a + * policy.

      * @public */ RevisionId?: string; @@ -3700,7 +3721,8 @@ export class PolicyNotFoundException extends __BaseException { */ export interface DeleteTableInput { /** - *

      The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in + * this parameter.

      * @public */ TableName: string | undefined; @@ -3770,7 +3792,8 @@ export interface DescribeContinuousBackupsOutput { */ export interface DescribeContributorInsightsInput { /** - *

      The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in + * this parameter.

      * @public */ TableName: string | undefined; @@ -4733,7 +4756,8 @@ export class ImportNotFoundException extends __BaseException { */ export interface DescribeKinesisStreamingDestinationInput { /** - *

      The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table + * in this parameter.

      * @public */ TableName: string | undefined; @@ -4853,7 +4877,8 @@ export interface DescribeLimitsOutput { */ export interface DescribeTableInput { /** - *

      The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in + * this parameter.

      * @public */ TableName: string | undefined; @@ -4876,7 +4901,8 @@ export interface DescribeTableOutput { */ export interface DescribeTableReplicaAutoScalingInput { /** - *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this + * parameter.

      * @public */ TableName: string | undefined; @@ -5049,7 +5075,8 @@ export interface DescribeTableReplicaAutoScalingOutput { */ export interface DescribeTimeToLiveInput { /** - *

      The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table + * in this parameter.

      * @public */ TableName: string | undefined; @@ -5083,7 +5110,8 @@ export interface EnableKinesisStreamingConfiguration { */ export interface KinesisStreamingDestinationInput { /** - *

      The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the + * table in this parameter.

      * @public */ TableName: string | undefined; @@ -5321,7 +5349,8 @@ export interface ExportTableToPointInTimeInput { *

      The ID of the Amazon Web Services account that owns the bucket the export will be * stored in.

      * - *

      S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

      + *

      S3BucketOwner is a required parameter when exporting to a S3 bucket in another + * account.

      *       * @public */ @@ -5368,7 +5397,10 @@ export interface ExportTableToPointInTimeInput { ExportFormat?: ExportFormat; /** - *

      Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

      + *

      Choice of whether to execute as a full export or incremental export. Valid values are + * FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If + * INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be + * used.

      * @public */ ExportType?: ExportType; @@ -5437,7 +5469,8 @@ export class PointInTimeRecoveryUnavailableException extends __BaseException { */ export interface GetResourcePolicyInput { /** - *

      The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.

      + *

      The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The + * resources you can specify include tables and streams.

      * @public */ ResourceArn: string | undefined; @@ -5448,7 +5481,8 @@ export interface GetResourcePolicyInput { */ export interface GetResourcePolicyOutput { /** - *

      The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

      + *

      The resource-based policy document attached to the resource, which can be a table or + * stream, in JSON format.

      * @public */ Policy?: string; @@ -5553,7 +5587,8 @@ export interface ImportTableOutput { */ export interface ListBackupsInput { /** - *

      Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      Lists the backups from the table specified in TableName. You can also + * provide the Amazon Resource Name (ARN) of the table in this parameter.

      * @public */ TableName?: string; @@ -5642,7 +5677,8 @@ export interface ListBackupsOutput { */ export interface ListContributorInsightsInput { /** - *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this + * parameter.

      * @public */ TableName?: string; @@ -6004,7 +6040,8 @@ export interface ListTagsOfResourceOutput { */ export interface PutResourcePolicyInput { /** - *

      The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.

      + *

      The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. + * The resources you can specify include tables and streams.

      *

      You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

      * @public */ @@ -6014,29 +6051,42 @@ export interface PutResourcePolicyInput { *

      An Amazon Web Services resource-based policy document in JSON format.

      *
        *
      • - *

        The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.

        + *

        The maximum size supported for a resource-based policy document is 20 KB. + * DynamoDB counts whitespaces when calculating the size of a policy + * against this limit.

        *
        • *
      • - *

        Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.

        + *

        Within a resource-based policy, if the action for a DynamoDB + * service-linked role (SLR) to replicate data for a global table is denied, adding + * or deleting a replica will fail with an error.

        *
        • *
      - *

      For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.

      + *

      For a full list of all considerations that apply while attaching a resource-based + * policy, see Resource-based + * policy considerations.

      * @public */ Policy: string | undefined; /** - *

      A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

      + *

      A string value that you can use to conditionally update your policy. You can provide + * the revision ID of your existing policy to make mutating requests against that + * policy.

      * - *

      When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.

      + *

      When you provide an expected revision ID, if the revision ID of the existing + * policy on the resource doesn't match or if there's no policy attached to the + * resource, your request will be rejected with a + * PolicyNotFoundException.

      *       - *

      To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.

      + *

      To conditionally attach a policy when no policy exists for the resource, specify + * NO_POLICY for the revision ID.

      * @public */ ExpectedRevisionId?: string; /** - *

      Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.

      + *

      Set this parameter to true to confirm that you want to remove your + * permissions to change the policy of this resource in the future.

      * @public */ ConfirmRemoveSelfResourceAccess?: boolean; @@ -6321,7 +6371,8 @@ export interface PointInTimeRecoverySpecification { */ export interface UpdateContinuousBackupsInput { /** - *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this + * parameter.

      * @public */ TableName: string | undefined; @@ -6350,7 +6401,8 @@ export interface UpdateContinuousBackupsOutput { */ export interface UpdateContributorInsightsInput { /** - *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this + * parameter.

      * @public */ TableName: string | undefined; @@ -6700,7 +6752,8 @@ export interface UpdateKinesisStreamingConfiguration { */ export interface UpdateKinesisStreamingDestinationInput { /** - *

      The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.

      + *

      The table name for the Kinesis streaming destination input. You can also provide the + * ARN of the table in this parameter.

      * @public */ TableName: string | undefined; @@ -6948,7 +7001,8 @@ export interface UpdateTableInput { AttributeDefinitions?: AttributeDefinition[]; /** - *

      The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table + * in this parameter.

      * @public */ TableName: string | undefined; @@ -7029,8 +7083,8 @@ export interface UpdateTableInput { /** *

      A list of replica update actions (create, delete, or update) for the table.

      * - *

      For global tables, this property only applies to global tables using Version 2019.11.21 (Current version). - *

      + *

      For global tables, this property only applies to global tables using Version + * 2019.11.21 (Current version).

      *       * @public */ @@ -7044,13 +7098,16 @@ export interface UpdateTableInput { TableClass?: TableClass; /** - *

      Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

      + *

      Indicates whether deletion protection is to be enabled (true) or disabled (false) on + * the table.

      * @public */ DeletionProtectionEnabled?: boolean; /** - *

      Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      + *

      Updates the maximum number of read and write units for the specified table in + * on-demand capacity mode. If you use this parameter, you must specify + * MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      * @public */ OnDemandThroughput?: OnDemandThroughput; @@ -7146,7 +7203,8 @@ export interface UpdateTableReplicaAutoScalingInput { GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexAutoScalingUpdate[]; /** - *

      The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the + * table in this parameter.

      * @public */ TableName: string | undefined; @@ -7203,7 +7261,8 @@ export interface TimeToLiveSpecification { */ export interface UpdateTimeToLiveInput { /** - *

      The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the + * table in this parameter.

      * @public */ TableName: string | undefined; @@ -8068,7 +8127,7 @@ export interface ExecuteStatementInput { /** *

      An optional parameter that returns the item attributes for an - * ExecuteStatement operation that failed a condition check.

      + * ExecuteStatement operation that failed a condition check.

      *

      There is no additional cost associated with requesting a return value aside from the * small network and processing overhead of receiving a larger response. No read capacity * units are consumed.

      @@ -8119,7 +8178,8 @@ export interface Get { */ export interface GetItemInput { /** - *

      The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      + *

      The name of the table containing the requested item. You can also provide the + * Amazon Resource Name (ARN) of the table in this parameter.

      * @public */ TableName: string | undefined; @@ -8267,8 +8327,8 @@ export interface GetItemOutput { * includes the total provisioned throughput consumed, along with statistics for the table * and any indexes involved in the operation. ConsumedCapacity is only * returned if the ReturnConsumedCapacity parameter was specified. For more - * information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer - * Guide.

      + * information, see Capacity unit consumption for read operations in the Amazon + * DynamoDB Developer Guide.

      * @public */ ConsumedCapacity?: ConsumedCapacity; @@ -8857,9 +8917,9 @@ export class TransactionCanceledException extends __BaseException { */ export interface BatchGetItemInput { /** - *

      A map of one or more table names or table ARNs and, for each table, a map that describes one or more - * items to retrieve from that table. Each table name or ARN can be used only once per - * BatchGetItem request.

      + *

      A map of one or more table names or table ARNs and, for each table, a map that + * describes one or more items to retrieve from that table. Each table name or ARN can be + * used only once per BatchGetItem request.

      *

      Each element in the map of items to retrieve consists of the following:

      *
        *
      • @@ -9660,8 +9720,8 @@ export interface PutItemOutput { * includes the total provisioned throughput consumed, along with statistics for the table * and any indexes involved in the operation. ConsumedCapacity is only * returned if the ReturnConsumedCapacity parameter was specified. For more - * information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer - * Guide.

        + * information, see Capacity unity consumption for write operations in the Amazon + * DynamoDB Developer Guide.

        * @public */ ConsumedCapacity?: ConsumedCapacity; @@ -9722,7 +9782,7 @@ export interface QueryOutput { /** *

        The number of items evaluated, before any QueryFilter is applied. A high * ScannedCount value with few, or no, Count results - * indicates an inefficient Query operation. For more information, see Count and + * indicates an inefficient Query operation. For more information, see Count and * ScannedCount in the Amazon DynamoDB Developer * Guide.

        *

        If you did not use a filter in the request, then ScannedCount is the same @@ -9749,8 +9809,8 @@ export interface QueryOutput { * includes the total provisioned throughput consumed, along with statistics for the table * and any indexes involved in the operation. ConsumedCapacity is only * returned if the ReturnConsumedCapacity parameter was specified. For more - * information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer - * Guide.

        + * information, see Capacity unit consumption for read operations in the Amazon + * DynamoDB Developer Guide.

        * @public */ ConsumedCapacity?: ConsumedCapacity; @@ -9809,8 +9869,8 @@ export interface ScanOutput { * includes the total provisioned throughput consumed, along with statistics for the table * and any indexes involved in the operation. ConsumedCapacity is only * returned if the ReturnConsumedCapacity parameter was specified. For more - * information, see - * Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

        + * information, see Capacity unit consumption for read operations in the Amazon + * DynamoDB Developer Guide.

        * @public */ ConsumedCapacity?: ConsumedCapacity; @@ -9824,9 +9884,9 @@ export interface UpdateItemOutput { /** *

        A map of attribute values as they appear before or after the UpdateItem * operation, as determined by the ReturnValues parameter.

        - *

        The Attributes map is only present if the update was successful and ReturnValues was - * specified as something other than NONE in the request. Each element - * represents one attribute.

        + *

        The Attributes map is only present if the update was successful and + * ReturnValues was specified as something other than NONE in + * the request. Each element represents one attribute.

        * @public */ Attributes?: Record; @@ -9836,8 +9896,8 @@ export interface UpdateItemOutput { * returned includes the total provisioned throughput consumed, along with statistics for * the table and any indexes involved in the operation. ConsumedCapacity is * only returned if the ReturnConsumedCapacity parameter was specified. For - * more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer - * Guide.

        + * more information, see Capacity unity consumption for write operations in the Amazon + * DynamoDB Developer Guide.

        * @public */ ConsumedCapacity?: ConsumedCapacity; @@ -9918,9 +9978,9 @@ export interface BatchExecuteStatementOutput { */ export interface BatchGetItemOutput { /** - *

        A map of table name or table ARN to a list of items. Each object in Responses consists - * of a table name or ARN, along with a map of attribute data consisting of the data type and - * attribute value.

        + *

        A map of table name or table ARN to a list of items. Each object in + * Responses consists of a table name or ARN, along with a map of + * attribute data consisting of the data type and attribute value.

        * @public */ Responses?: Record[]>; @@ -9984,7 +10044,7 @@ export interface BatchGetItemOutput { export interface ScanInput { /** *

        The name of the table containing the requested items or if you provide - * IndexName, the name of the table to which that index belongs.

        + * IndexName, the name of the table to which that index belongs.

        *

        You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

        * @public */ @@ -10044,8 +10104,9 @@ export interface ScanInput { *
      • *

        * COUNT - Returns the number of matching items, rather than the - * matching items themselves. Note that this uses the same quantity of read capacity units - * as getting the items, and is subject to the same item size calculations.

        + * matching items themselves. Note that this uses the same quantity of read + * capacity units as getting the items, and is subject to the same item size + * calculations.

        *
        • *
      • *

        @@ -10192,8 +10253,9 @@ export interface ScanInput { *

        A FilterExpression is applied after the items have already been read; * the process of filtering does not consume any additional read capacity units.

        * - *

        For more information, see Filter Expressions in the Amazon DynamoDB Developer - * Guide.

        + *

        For more information, see Filter + * Expressions in the Amazon DynamoDB Developer + * Guide.

        * @public */ FilterExpression?: string; @@ -10308,9 +10370,9 @@ export interface ScanInput { */ export interface BatchWriteItemInput { /** - *

        A map of one or more table names or table ARNs and, for each table, a list of operations to be - * performed (DeleteRequest or PutRequest). Each element in the - * map consists of the following:

        + *

        A map of one or more table names or table ARNs and, for each table, a list of + * operations to be performed (DeleteRequest or PutRequest). Each + * element in the map consists of the following:

        *
          *
        • *

          @@ -10401,7 +10463,8 @@ export interface BatchWriteItemInput { */ export interface DeleteItemInput { /** - *

          The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

          + *

          The name of the table from which to delete the item. You can also provide the + * Amazon Resource Name (ARN) of the table in this parameter.

          * @public */ TableName: string | undefined; @@ -10624,7 +10687,8 @@ export interface DeleteItemInput { */ export interface PutItemInput { /** - *

          The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

          + *

          The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the + * table in this parameter.

          * @public */ TableName: string | undefined; @@ -10861,7 +10925,8 @@ export interface PutItemInput { */ export interface QueryInput { /** - *

          The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

          + *

          The name of the table containing the requested items. You can also provide the + * Amazon Resource Name (ARN) of the table in this parameter.

          * @public */ TableName: string | undefined; @@ -10899,8 +10964,9 @@ export interface QueryInput { *
        • *

          * COUNT - Returns the number of matching items, rather than the - * matching items themselves. Note that this uses the same quantity of read capacity units - * as getting the items, and is subject to the same item size calculations.

          + * matching items themselves. Note that this uses the same quantity of read + * capacity units as getting the items, and is subject to the same item size + * calculations.

          *
          • *
        • *

          @@ -11068,8 +11134,9 @@ export interface QueryInput { *

          A FilterExpression is applied after the items have already been read; * the process of filtering does not consume any additional read capacity units.

          * - *

          For more information, see Filter Expressions in the Amazon DynamoDB Developer - * Guide.

          + *

          For more information, see Filter + * Expressions in the Amazon DynamoDB Developer + * Guide.

          * @public */ FilterExpression?: string; @@ -11284,9 +11351,9 @@ export interface BatchWriteItemOutput { * RequestItems, so you can provide this value directly to a subsequent * BatchWriteItem operation. For more information, see * RequestItems in the Request Parameters section.

          - *

          Each UnprocessedItems entry consists of a table name or table ARN and, for that table, - * a list of operations to perform (DeleteRequest or - * PutRequest).

          + *

          Each UnprocessedItems entry consists of a table name or table ARN + * and, for that table, a list of operations to perform (DeleteRequest or + * PutRequest).

          *
            *
          • *

            @@ -11382,7 +11449,8 @@ export interface BatchWriteItemOutput { */ export interface UpdateItemInput { /** - *

            The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

            + *

            The name of the table containing the item to update. You can also provide the + * Amazon Resource Name (ARN) of the table in this parameter.

            * @public */ TableName: string | undefined; @@ -11424,8 +11492,8 @@ export interface UpdateItemInput { /** *

            Use ReturnValues if you want to get the item attributes as they appear - * before or after they are successfully updated. For UpdateItem, the valid values - * are:

            + * before or after they are successfully updated. For UpdateItem, the valid + * values are:

            *
              *
            • *

              @@ -11717,8 +11785,8 @@ export interface UpdateItemInput { ExpressionAttributeValues?: Record; /** - *

              An optional parameter that returns the item attributes for an UpdateItem operation that failed a - * condition check.

              + *

              An optional parameter that returns the item attributes for an UpdateItem + * operation that failed a condition check.

              *

              There is no additional cost associated with requesting a return value aside from the * small network and processing overhead of receiving a larger response. No read capacity * units are consumed.

              diff --git a/codegen/sdk-codegen/aws-models/dynamodb.json b/codegen/sdk-codegen/aws-models/dynamodb.json index 580b7d6197ff4..9d0ff5c609918 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.json @@ -780,7 +780,7 @@ } ], "traits": { - "smithy.api#documentation": "

              This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item.

              \n \n

              The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

              \n               \n \n

              A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

              \n               " + "smithy.api#documentation": "

              This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB\n .

              \n \n

              The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

              \n               \n \n

              A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

              \n               " } }, "com.amazonaws.dynamodb#BatchExecuteStatementInput": { @@ -807,7 +807,7 @@ "Responses": { "target": "com.amazonaws.dynamodb#PartiQLBatchResponse", "traits": { - "smithy.api#documentation": "

              The response to each PartiQL statement in the batch. The values of the list are \n ordered according to the ordering of the request statements.

              " + "smithy.api#documentation": "

              The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.

              " } }, "ConsumedCapacity": { @@ -850,7 +850,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

              \n

              A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested,\n or an internal processing failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.

              \n \n

              If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

              \n               \n

              For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

              \n

              If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

              \n \n

              If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

              \n

              For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

              \n               \n

              By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

              \n

              In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

              \n

              When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

              \n

              If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

              ", + "smithy.api#documentation": "

              The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

              \n

              A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.

              \n \n

              If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

              \n               \n

              For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

              \n

              If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

              \n \n

              If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

              \n

              For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

              \n               \n

              By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

              \n

              In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

              \n

              When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

              \n

              If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

              ", "smithy.api#examples": [ { "title": "To retrieve multiple items from a table", @@ -919,7 +919,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { - "smithy.api#documentation": "

              A map of one or more table names or table ARNs and, for each table, a map that describes one or more\n items to retrieve from that table. Each table name or ARN can be used only once per\n BatchGetItem request.

              \n

              Each element in the map of items to retrieve consists of the following:

              \n
                \n
              • \n

                \n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.

                \n
                • \n
              • \n

                \n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:

                \n
                  \n
                • \n

                  To access an attribute whose name conflicts with a DynamoDB reserved\n word.

                  \n
                  • \n
                • \n

                  To create a placeholder for repeating occurrences of an attribute name\n in an expression.

                  \n
                  • \n
                • \n

                  To prevent special characters in an attribute name from being\n misinterpreted in an expression.

                  \n
                  • \n
                \n

                Use the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:

                \n
                  \n
                • \n

                  \n Percentile\n

                  \n
                  • \n
                \n

                The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:

                \n
                  \n
                • \n

                  \n {\"#P\":\"Percentile\"}\n

                  \n
                  • \n
                \n

                You could then use this substitution in an expression, as in this\n example:

                \n
                  \n
                • \n

                  \n #P = :val\n

                  \n
                  • \n
                \n \n

                Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.

                \n                 \n

                For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.

                \n
                • \n
              • \n

                \n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.

                \n
                • \n
              • \n

                \n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.

                \n

                If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.

                \n

                For more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.

                \n
                • \n
              • \n

                \n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

                \n
                • \n
              ", + "smithy.api#documentation": "

              A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per BatchGetItem request.

              \n

              Each element in the map of items to retrieve consists of the following:

              \n
                \n
              • \n

                \n ConsistentRead - If true, a strongly consistent read\n is used; if false (the default), an eventually consistent read is\n used.

                \n
                • \n
              • \n

                \n ExpressionAttributeNames - One or more substitution tokens for\n attribute names in the ProjectionExpression parameter. The\n following are some use cases for using\n ExpressionAttributeNames:

                \n
                  \n
                • \n

                  To access an attribute whose name conflicts with a DynamoDB reserved\n word.

                  \n
                  • \n
                • \n

                  To create a placeholder for repeating occurrences of an attribute name\n in an expression.

                  \n
                  • \n
                • \n

                  To prevent special characters in an attribute name from being\n misinterpreted in an expression.

                  \n
                  • \n
                \n

                Use the # character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:

                \n
                  \n
                • \n

                  \n Percentile\n

                  \n
                  • \n
                \n

                The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n Reserved\n Words in the Amazon DynamoDB Developer Guide).\n To work around this, you could specify the following for\n ExpressionAttributeNames:

                \n
                  \n
                • \n

                  \n {\"#P\":\"Percentile\"}\n

                  \n
                  • \n
                \n

                You could then use this substitution in an expression, as in this\n example:

                \n
                  \n
                • \n

                  \n #P = :val\n

                  \n
                  • \n
                \n \n

                Tokens that begin with the : character\n are expression attribute values, which are placeholders\n for the actual value at runtime.

                \n                 \n

                For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.

                \n
                • \n
              • \n

                \n Keys - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n all of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide both the partition key value and the\n sort key value.

                \n
                • \n
              • \n

                \n ProjectionExpression - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.

                \n

                If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.

                \n

                For more information, see Accessing Item Attributes in the Amazon DynamoDB\n Developer Guide.

                \n
                • \n
              • \n

                \n AttributesToGet - This is a legacy parameter. Use\n ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

                \n
                • \n
              ", "smithy.api#required": {} } }, @@ -938,7 +938,7 @@ "Responses": { "target": "com.amazonaws.dynamodb#BatchGetResponseMap", "traits": { - "smithy.api#documentation": "

              A map of table name or table ARN to a list of items. Each object in Responses consists\n of a table name or ARN, along with a map of attribute data consisting of the data type and\n attribute value.

              " + "smithy.api#documentation": "

              A map of table name or table ARN to a list of items. Each object in\n Responses consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.

              " } }, "UnprocessedKeys": { @@ -1171,7 +1171,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.

              \n \n

              \n BatchWriteItem cannot update items. If you perform a BatchWriteItem\n operation on an existing item, that item's values will be overwritten by the\n operation and it will appear like it was updated. To update items, we recommend you\n use the UpdateItem action.

              \n               \n

              The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

              \n

              If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

              \n \n

              If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

              \n

              For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

              \n               \n

              With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

              \n

              If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

              \n

              Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

              \n

              If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

              \n
                \n
              • \n

                One or more tables specified in the BatchWriteItem request does\n not exist.

                \n
                • \n
              • \n

                Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

                \n
                • \n
              • \n

                You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

                \n
                • \n
              • \n

                Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

                \n
                • \n
              • \n

                There are more than 25 requests in the batch.

                \n
                • \n
              • \n

                Any individual item in a batch exceeds 400 KB.

                \n
                • \n
              • \n

                The total request size exceeds 16 MB.

                \n
                • \n
              • \n

                Any individual items with keys exceeding the key length limits. For a\n partition key, the limit is 2048 bytes and for a sort key, the limit is 1024\n bytes.

                \n
                • \n
              ", + "smithy.api#documentation": "

              The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.

              \n \n

              \n BatchWriteItem cannot update items. If you perform a\n BatchWriteItem operation on an existing item, that item's values\n will be overwritten by the operation and it will appear like it was updated. To\n update items, we recommend you use the UpdateItem action.

              \n               \n

              The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

              \n

              For tables and indexes with provisioned capacity, if none of the items can be\n processed due to insufficient provisioned throughput on all of the tables in the\n request, then BatchWriteItem returns a\n ProvisionedThroughputExceededException. For all tables and indexes, if\n none of the items can be processed due to other throttling scenarios (such as exceeding\n partition level limits), then BatchWriteItem returns a\n ThrottlingException.

              \n \n

              If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

              \n

              For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

              \n               \n

              With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

              \n

              If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

              \n

              Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

              \n

              If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

              \n
                \n
              • \n

                One or more tables specified in the BatchWriteItem request does\n not exist.

                \n
                • \n
              • \n

                Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

                \n
                • \n
              • \n

                You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

                \n
                • \n
              • \n

                Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

                \n
                • \n
              • \n

                There are more than 25 requests in the batch.

                \n
                • \n
              • \n

                Any individual item in a batch exceeds 400 KB.

                \n
                • \n
              • \n

                The total request size exceeds 16 MB.

                \n
                • \n
              • \n

                Any individual items with keys exceeding the key length limits. For a\n partition key, the limit is 2048 bytes and for a sort key, the limit is 1024\n bytes.

                \n
                • \n
              ", "smithy.api#examples": [ { "title": "To add multiple items to a table", @@ -1238,7 +1238,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { - "smithy.api#documentation": "

              A map of one or more table names or table ARNs and, for each table, a list of operations to be\n performed (DeleteRequest or PutRequest). Each element in the\n map consists of the following:

              \n
                \n
              • \n

                \n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:

                \n
                  \n
                • \n

                  \n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.

                  \n
                  • \n
                \n
                • \n
              • \n

                \n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:

                \n
                  \n
                • \n

                  \n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.

                  \n

                  If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.

                  \n
                  • \n
                \n
                • \n
              ", + "smithy.api#documentation": "

              A map of one or more table names or table ARNs and, for each table, a list of\n operations to be performed (DeleteRequest or PutRequest). Each\n element in the map consists of the following:

              \n
                \n
              • \n

                \n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:

                \n
                  \n
                • \n

                  \n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value. For each primary key, you must provide\n all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition\n key. For a composite primary key, you must provide values for\n both the partition key and the sort key.

                  \n
                  • \n
                \n
                • \n
              • \n

                \n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:

                \n
                  \n
                • \n

                  \n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values are rejected with a\n ValidationException exception.

                  \n

                  If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.

                  \n
                  • \n
                \n
                • \n
              ", "smithy.api#required": {} } }, @@ -1263,7 +1263,7 @@ "UnprocessedItems": { "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { - "smithy.api#documentation": "

              A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.

              \n

              Each UnprocessedItems entry consists of a table name or table ARN and, for that table,\n a list of operations to perform (DeleteRequest or\n PutRequest).

              \n
                \n
              • \n

                \n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:

                \n
                  \n
                • \n

                  \n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.

                  \n
                  • \n
                \n
                • \n
              • \n

                \n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:

                \n
                  \n
                • \n

                  \n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.

                  \n

                  If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.

                  \n
                  • \n
                \n
                • \n
              \n

              If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

              " + "smithy.api#documentation": "

              A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.

              \n

              Each UnprocessedItems entry consists of a table name or table ARN\n and, for that table, a list of operations to perform (DeleteRequest or\n PutRequest).

              \n
                \n
              • \n

                \n DeleteRequest - Perform a DeleteItem operation on the\n specified item. The item to be deleted is identified by a Key\n subelement:

                \n
                  \n
                • \n

                  \n Key - A map of primary key attribute values that uniquely\n identify the item. Each entry in this map consists of an attribute name\n and an attribute value.

                  \n
                  • \n
                \n
                • \n
              • \n

                \n PutRequest - Perform a PutItem operation on the\n specified item. The item to be put is identified by an Item\n subelement:

                \n
                  \n
                • \n

                  \n Item - A map of attributes and their values. Each entry in\n this map consists of an attribute name and an attribute value. Attribute\n values must not be null; string and binary type attributes must have\n lengths greater than zero; and set type attributes must not be empty.\n Requests that contain empty values will be rejected with a\n ValidationException exception.

                  \n

                  If you specify any attributes that are part of an index key, then the\n data types for those attributes must match those of the schema in the\n table's attribute definition.

                  \n
                  • \n
                \n
                • \n
              \n

              If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

              " } }, "ItemCollectionMetrics": { @@ -1900,7 +1900,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

              ", "smithy.api#required": {} } }, @@ -2141,7 +2141,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

              ", "smithy.api#required": {} } }, @@ -2203,19 +2203,19 @@ "DeletionProtectionEnabled": { "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", "traits": { - "smithy.api#documentation": "

              Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

              " + "smithy.api#documentation": "

              Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

              " } }, "ResourcePolicy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "

              An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

              \n

              When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

              \n

              The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

              \n \n

              You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

              \n               " + "smithy.api#documentation": "

              An Amazon Web Services resource-based policy document in JSON format that will be\n attached to the table.

              \n

              When you attach a resource-based policy while creating a table, the policy application\n is strongly consistent.

              \n

              The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\n limit. For a full list of all considerations that apply for resource-based policies, see\n Resource-based\n policy considerations.

              \n \n

              You need to specify the CreateTable and\n PutResourcePolicy\n IAM actions for authorizing a user to create a table with a\n resource-based policy.

              \n               " } }, "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { - "smithy.api#documentation": "

              Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

              " + "smithy.api#documentation": "

              Sets the maximum number of read and write units for the specified table in on-demand\n capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

              " } } }, @@ -2486,7 +2486,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table from which to delete the item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -2658,7 +2658,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Deletes the resource-based policy attached to the resource, which can be a table or stream.

              \n

              \n DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

              \n \n

              To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.\n

              \n               \n \n

              \n DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

              \n               " + "smithy.api#documentation": "

              Deletes the resource-based policy attached to the resource, which can be a table or\n stream.

              \n

              \n DeleteResourcePolicy is an idempotent operation; running it multiple\n times on the same resource doesn't result in an error response,\n unless you specify an ExpectedRevisionId, which will then return a\n PolicyNotFoundException.

              \n \n

              To make sure that you don't inadvertently lock yourself out of your own resources,\n the root principal in your Amazon Web Services account can perform\n DeleteResourcePolicy requests, even if your resource-based policy\n explicitly denies the root principal's access.

              \n               \n \n

              \n DeleteResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after running the\n DeleteResourcePolicy request, DynamoDB might still return\n the deleted policy. This is because the policy for your resource might not have been\n deleted yet. Wait for a few seconds, and then try the GetResourcePolicy\n request again.

              \n               " } }, "com.amazonaws.dynamodb#DeleteResourcePolicyInput": { @@ -2667,14 +2667,14 @@ "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.

              ", + "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be\n removed. The resources you can specify include tables and streams. If you remove the\n policy of a table, it will also remove the permissions for the table's indexes defined\n in that policy document. This is because index permissions are defined in the table's\n policy.

              ", "smithy.api#required": {} } }, "ExpectedRevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "

              A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.

              " + "smithy.api#documentation": "

              A string value that you can use to conditionally delete your policy. When you provide\n an expected revision ID, if the revision ID of the existing policy on the resource\n doesn't match or if there's no policy attached to the resource, the request will fail\n and return a PolicyNotFoundException.

              " } } }, @@ -2688,7 +2688,7 @@ "RevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "

              A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

              \n

              This value will be empty if you make a request against a resource without a policy.

              " + "smithy.api#documentation": "

              A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

              \n

              This value will be empty if you make a request against a resource without a\n policy.

              " } } }, @@ -2725,7 +2725,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.

              \n \n

              For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n

              \n               \n \n

              DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete.

              \n               \n

              When you delete a table, any indexes on that table are also deleted.

              \n

              If you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.

              \n

              Use the DescribeTable action to check the status of the table.

              ", + "smithy.api#documentation": "

              The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.

              \n \n

              For global tables, this operation only applies to\n global tables using Version 2019.11.21 (Current version).

              \n               \n \n

              DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete. For the full\n list of table states, see TableStatus.

              \n               \n

              When you delete a table, any indexes on that table are also deleted.

              \n

              If you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.

              \n

              Use the DescribeTable action to check the status of the table.

              ", "smithy.api#examples": [ { "title": "To delete a table", @@ -2756,7 +2756,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

              ", "smithy.api#required": {} } } @@ -2920,7 +2920,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

              ", "smithy.api#required": {} } }, @@ -2988,7 +2988,7 @@ "target": "com.amazonaws.dynamodb#DescribeEndpointsResponse" }, "traits": { - "smithy.api#documentation": "

              Returns the regional endpoint information. For more information \n on policy permissions, please see Internetwork traffic privacy.

              " + "smithy.api#documentation": "

              Returns the regional endpoint information. For more information on policy permissions,\n please see Internetwork traffic privacy.

              " } }, "com.amazonaws.dynamodb#DescribeEndpointsRequest": { @@ -3260,7 +3260,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

              ", "smithy.api#required": {} } } @@ -3388,7 +3388,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.

              \n \n

              For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n

              \n               \n \n

              If you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.

              \n               ", + "smithy.api#documentation": "

              Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.

              \n \n

              For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

              \n               \n \n

              If you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.

              \n               ", "smithy.waiters#waitable": { "TableExists": { "acceptors": [ @@ -3431,7 +3431,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

              ", "smithy.api#required": {} } } @@ -3473,7 +3473,7 @@ } ], "traits": { - "smithy.api#documentation": "

              Describes auto scaling settings across replicas of the global table at once.

              \n \n

              For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

              \n               " + "smithy.api#documentation": "

              Describes auto scaling settings across replicas of the global table at once.

              \n \n

              For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

              \n               " } }, "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput": { @@ -3482,7 +3482,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

              ", "smithy.api#required": {} } } @@ -3537,7 +3537,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

              ", "smithy.api#required": {} } } @@ -3630,7 +3630,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Stops replication from the DynamoDB table to the Kinesis data stream. This is done\n without deleting either of the resources.

              " + "smithy.api#documentation": "

              Stops replication from the DynamoDB table to the Kinesis data stream. This\n is done without deleting either of the resources.

              " } }, "com.amazonaws.dynamodb#DoubleObject": { @@ -5055,7 +5055,7 @@ } ], "traits": { - "smithy.api#documentation": "

              This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.

              \n

              For PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.

              \n

              A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set and include \n NextToken.

              " + "smithy.api#documentation": "

              This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.

              \n

              For PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.

              \n

              A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set\n and include NextToken.

              " } }, "com.amazonaws.dynamodb#ExecuteStatementInput": { @@ -5098,7 +5098,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

              An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.

              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              " + "smithy.api#documentation": "

              An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.

              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              " } } }, @@ -5578,7 +5578,7 @@ "S3BucketOwner": { "target": "com.amazonaws.dynamodb#S3BucketOwner", "traits": { - "smithy.api#documentation": "

              The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.

              \n \n

              S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

              \n               " + "smithy.api#documentation": "

              The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.

              \n \n

              S3BucketOwner is a required parameter when exporting to a S3 bucket in another\n account.

              \n               " } }, "S3Prefix": { @@ -5608,7 +5608,7 @@ "ExportType": { "target": "com.amazonaws.dynamodb#ExportType", "traits": { - "smithy.api#documentation": "

              Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

              " + "smithy.api#documentation": "

              Choice of whether to execute as a full export or incremental export. Valid values are\n FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If\n INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be\n used.

              " } }, "IncrementalExportSpecification": { @@ -5837,7 +5837,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table containing the requested item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -5893,7 +5893,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

              The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

              " } } }, @@ -5928,7 +5928,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

              \n

              \n GetResourcePolicy follows an \n eventually consistent\n model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

              \n
                \n
              • \n

                If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

                \n
                • \n
              • \n

                If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

                \n
                • \n
              • \n

                If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

                \n
                • \n
              \n

              Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

              \n

              After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

              " + "smithy.api#documentation": "

              Returns the resource-based policy document attached to the resource, which can be a\n table or stream, in JSON format.

              \n

              \n GetResourcePolicy follows an \n eventually consistent\n model. The following list\n describes the outcomes when you issue the GetResourcePolicy request\n immediately after issuing another request:

              \n
                \n
              • \n

                If you issue a GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return a\n PolicyNotFoundException.

                \n
                • \n
              • \n

                If you issue a GetResourcePolicyrequest immediately after a\n DeleteResourcePolicy request, DynamoDB might return\n the policy that was present before the deletion request.

                \n
                • \n
              • \n

                If you issue a GetResourcePolicy request immediately after a\n CreateTable request, which includes a resource-based policy,\n DynamoDB might return a ResourceNotFoundException or\n a PolicyNotFoundException.

                \n
                • \n
              \n

              Because GetResourcePolicy uses an eventually\n consistent query, the metadata for your policy or table might not be\n available at that moment. Wait for a few seconds, and then retry the\n GetResourcePolicy request.

              \n

              After a GetResourcePolicy request returns a policy created using the\n PutResourcePolicy request, the policy will be applied in the\n authorization of requests to the resource. Because this process is eventually\n consistent, it will take some time to apply the policy to all requests to a resource.\n Policies that you attach while creating a table using the CreateTable\n request will always be applied to all requests for that table.

              " } }, "com.amazonaws.dynamodb#GetResourcePolicyInput": { @@ -5937,7 +5937,7 @@ "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.

              ", + "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The\n resources you can specify include tables and streams.

              ", "smithy.api#required": {} } } @@ -5952,7 +5952,7 @@ "Policy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "

              The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

              " + "smithy.api#documentation": "

              The resource-based policy document attached to the resource, which can be a table or\n stream, in JSON format.

              " } }, "RevisionId": { @@ -7212,7 +7212,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

              ", "smithy.api#required": {} } }, @@ -7304,7 +7304,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. \n To list these backups for a given table, specify TableName. ListBackups returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.

              \n

              In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

              \n

              You can call ListBackups a maximum of five times per second.

              \n

              If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the \n Amazon Web Services Backup list API.\n

              " + "smithy.api#documentation": "

              List DynamoDB backups that are associated with an Amazon Web Services account and\n weren't made with Amazon Web Services Backup. To list these backups for a given table,\n specify TableName. ListBackups returns a paginated list of\n results with at most 1 MB worth of items in a page. You can also specify a maximum\n number of entries to be returned in a page.

              \n

              In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

              \n

              You can call ListBackups a maximum of five times per second.

              \n

              If you want to retrieve the complete list of backups made with Amazon Web Services\n Backup, use the Amazon Web Services Backup\n list API.\n

              " } }, "com.amazonaws.dynamodb#ListBackupsInput": { @@ -7313,7 +7313,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              " + "smithy.api#documentation": "

              Lists the backups from the table specified in TableName. You can also\n provide the Amazon Resource Name (ARN) of the table in this parameter.

              " } }, "Limit": { @@ -7402,7 +7402,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              " + "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

              " } }, "NextToken": { @@ -8483,7 +8483,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

              \n

              When you add an item, the primary key attributes are the only required attributes.\n

              \n

              Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

              \n

              Invalid Requests with empty values will be rejected with a\n ValidationException exception.

              \n \n

              To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

              \n               \n

              For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

              ", + "smithy.api#documentation": "

              Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

              \n

              When you add an item, the primary key attributes are the only required attributes.

              \n

              Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

              \n

              Invalid Requests with empty values will be rejected with a\n ValidationException exception.

              \n \n

              To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

              \n               \n

              For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

              ", "smithy.api#examples": [ { "title": "To add an item to a table", @@ -8519,7 +8519,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

              ", "smithy.api#required": {} } }, @@ -8608,7 +8608,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

              The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

              " } }, "ItemCollectionMetrics": { @@ -8670,7 +8670,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is \n eventually consistent\n .

              \n

              \n PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

              \n \n

              \n PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.

              \n               " + "smithy.api#documentation": "

              Attaches a resource-based policy document to the resource, which can be a table or\n stream. When you attach a resource-based policy using this API, the policy application\n is \n eventually consistent\n .

              \n

              \n PutResourcePolicy is an idempotent operation; running it multiple times\n on the same resource using the same policy document will return the same revision ID. If\n you specify an ExpectedRevisionId that doesn't match the current policy's\n RevisionId, the PolicyNotFoundException will be\n returned.

              \n \n

              \n PutResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return your\n previous policy, if there was one, or return the\n PolicyNotFoundException. This is because\n GetResourcePolicy uses an eventually consistent query, and the\n metadata for your policy or table might not be available at that moment. Wait for a\n few seconds, and then try the GetResourcePolicy request again.

              \n               " } }, "com.amazonaws.dynamodb#PutResourcePolicyInput": { @@ -8679,28 +8679,28 @@ "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.

              \n

              You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

              ", + "smithy.api#documentation": "

              The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.\n The resources you can specify include tables and streams.

              \n

              You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

              ", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "

              An Amazon Web Services resource-based policy document in JSON format.

              \n
                \n
              • \n

                The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.

                \n
                • \n
              • \n

                Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.

                \n
                • \n
              \n

              For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.

              ", + "smithy.api#documentation": "

              An Amazon Web Services resource-based policy document in JSON format.

              \n
                \n
              • \n

                The maximum size supported for a resource-based policy document is 20 KB.\n DynamoDB counts whitespaces when calculating the size of a policy\n against this limit.

                \n
                • \n
              • \n

                Within a resource-based policy, if the action for a DynamoDB\n service-linked role (SLR) to replicate data for a global table is denied, adding\n or deleting a replica will fail with an error.

                \n
                • \n
              \n

              For a full list of all considerations that apply while attaching a resource-based\n policy, see Resource-based\n policy considerations.

              ", "smithy.api#required": {} } }, "ExpectedRevisionId": { "target": "com.amazonaws.dynamodb#PolicyRevisionId", "traits": { - "smithy.api#documentation": "

              A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

              \n \n

              When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.

              \n               \n

              To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.

              " + "smithy.api#documentation": "

              A string value that you can use to conditionally update your policy. You can provide\n the revision ID of your existing policy to make mutating requests against that\n policy.

              \n \n

              When you provide an expected revision ID, if the revision ID of the existing\n policy on the resource doesn't match or if there's no policy attached to the\n resource, your request will be rejected with a\n PolicyNotFoundException.

              \n               \n

              To conditionally attach a policy when no policy exists for the resource, specify\n NO_POLICY for the revision ID.

              " } }, "ConfirmRemoveSelfResourceAccess": { "target": "com.amazonaws.dynamodb#ConfirmRemoveSelfResourceAccess", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

              Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.

              ", + "smithy.api#documentation": "

              Set this parameter to true to confirm that you want to remove your\n permissions to change the policy of this resource in the future.

              ", "smithy.api#httpHeader": "x-amz-confirm-remove-self-resource-access" } } @@ -8796,7 +8796,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table containing the requested items. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -8809,7 +8809,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

              The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

              \n
                \n
              • \n

                \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

                \n
                • \n
              • \n

                \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

                \n
                • \n
              • \n

                \n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read capacity units \n as getting the items, and is subject to the same item size calculations.

                \n
                • \n
              • \n

                \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

                \n

                If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

                \n

                If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

                \n
                • \n
              \n

              If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

              \n \n

              If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

              \n               " + "smithy.api#documentation": "

              The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

              \n
                \n
              • \n

                \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

                \n
                • \n
              • \n

                \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

                \n
                • \n
              • \n

                \n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.

                \n
                • \n
              • \n

                \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

                \n

                If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

                \n

                If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

                \n
                • \n
              \n

              If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

              \n \n

              If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

              \n               " } }, "AttributesToGet": { @@ -8872,7 +8872,7 @@ "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

              A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

              \n

              A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

              \n \n

              A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

              \n               \n

              For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

              \n

              A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

              \n \n

              A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

              \n               \n

              For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

              " } }, "KeyConditionExpression": { @@ -8919,7 +8919,7 @@ "target": "com.amazonaws.dynamodb#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

              The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

              \n

              If you did not use a filter in the request, then ScannedCount is the same\n as Count.

              " + "smithy.api#documentation": "

              The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

              \n

              If you did not use a filter in the request, then ScannedCount is the same\n as Count.

              " } }, "LastEvaluatedKey": { @@ -8931,7 +8931,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

              The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

              " } } }, @@ -9815,7 +9815,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.

              \n

              When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

              \n

              Along with data, the following are also included on the new restored table using\n point in time recovery:

              \n
                \n
              • \n

                Global secondary indexes (GSIs)

                \n
                • \n
              • \n

                Local secondary indexes (LSIs)

                \n
                • \n
              • \n

                Provisioned read and write capacity

                \n
                • \n
              • \n

                Encryption settings

                \n \n

                All these settings come from the current settings of the source table at\n the time of restore.

                \n                 \n
                • \n
              \n

              You must manually set up the following on the restored table:

              \n
                \n
              • \n

                Auto scaling policies

                \n
                • \n
              • \n

                IAM policies

                \n
                • \n
              • \n

                Amazon CloudWatch metrics and alarms

                \n
                • \n
              • \n

                Tags

                \n
                • \n
              • \n

                Stream settings

                \n
                • \n
              • \n

                Time to Live (TTL) settings

                \n
                • \n
              • \n

                Point in time recovery settings

                \n
                • \n
              " + "smithy.api#documentation": "

              Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.

              \n

              When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

              \n

              Along with data, the following are also included on the new restored table using point\n in time recovery:

              \n
                \n
              • \n

                Global secondary indexes (GSIs)

                \n
                • \n
              • \n

                Local secondary indexes (LSIs)

                \n
                • \n
              • \n

                Provisioned read and write capacity

                \n
                • \n
              • \n

                Encryption settings

                \n \n

                All these settings come from the current settings of the source table at\n the time of restore.

                \n                 \n
                • \n
              \n

              You must manually set up the following on the restored table:

              \n
                \n
              • \n

                Auto scaling policies

                \n
                • \n
              • \n

                IAM policies

                \n
                • \n
              • \n

                Amazon CloudWatch metrics and alarms

                \n
                • \n
              • \n

                Tags

                \n
                • \n
              • \n

                Stream settings

                \n
                • \n
              • \n

                Time to Live (TTL) settings

                \n
                • \n
              • \n

                Point in time recovery settings

                \n
                • \n
              " } }, "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { @@ -10242,7 +10242,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.

              \n

              If the total size of scanned items exceeds the maximum dataset size limit of 1 MB,\n the scan completes and results are returned to the user. The LastEvaluatedKey \n value is also returned and the requestor can use the LastEvaluatedKey to continue \n the scan in a subsequent operation. Each scan response also includes number of items that were \n scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result \n can result in no items meeting the criteria and the Count will result in zero. If \n you did not use a FilterExpression in the scan request, then Count is \n the same as ScannedCount.

              \n \n

              \n Count and ScannedCount only return the count of items specific to a \n single scan request and, unless the table is less than 1MB, do not represent the total number \n of items in the table.\n

              \n               \n

              A single Scan operation first reads up to the maximum number of items set (if\n using the Limit parameter) or a maximum of 1 MB of data and then applies any\n filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to complete the\n full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

              \n

              \n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

              \n

              By default, a Scan uses eventually consistent reads when accessing the items in a table. \n Therefore, the results from an eventually consistent Scan may not include the latest item \n changes at the time the scan iterates through each item in the table. If you require a strongly consistent \n read of each item as the scan iterates through the items in the table, you can set the ConsistentRead \n parameter to true. Strong consistency only relates to the consistency of the read at the item level.

              \n \n

              \n DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead \n parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan \n see a consistent snapshot of the table when the scan operation was requested.\n

              \n               ", + "smithy.api#documentation": "

              The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.

              \n

              If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan completes and results are returned to the user. The LastEvaluatedKey\n value is also returned and the requestor can use the LastEvaluatedKey to\n continue the scan in a subsequent operation. Each scan response also includes number of\n items that were scanned (ScannedCount) as part of the request. If using a\n FilterExpression, a scan result can result in no items meeting the\n criteria and the Count will result in zero. If you did not use a\n FilterExpression in the scan request, then Count is the\n same as ScannedCount.

              \n \n

              \n Count and ScannedCount only return the count of items\n specific to a single scan request and, unless the table is less than 1MB, do not\n represent the total number of items in the table.

              \n               \n

              A single Scan operation first reads up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then\n applies any filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to\n complete the full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

              \n

              \n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

              \n

              By default, a Scan uses eventually consistent reads when accessing the\n items in a table. Therefore, the results from an eventually consistent Scan\n may not include the latest item changes at the time the scan iterates through each item\n in the table. If you require a strongly consistent read of each item as the scan\n iterates through the items in the table, you can set the ConsistentRead\n parameter to true. Strong consistency only relates to the consistency of the read at the\n item level.

              \n \n

              DynamoDB does not provide snapshot isolation for a scan operation when the\n ConsistentRead parameter is set to true. Thus, a DynamoDB scan\n operation does not guarantee that all reads in a scan see a consistent snapshot of\n the table when the scan operation was requested.

              \n               ", "smithy.api#examples": [ { "title": "To scan a table", @@ -10301,7 +10301,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.

              \n

              You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.

              \n

              You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -10326,7 +10326,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

              The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

              \n
                \n
              • \n

                \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

                \n
                • \n
              • \n

                \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

                \n
                • \n
              • \n

                \n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read capacity units \n as getting the items, and is subject to the same item size calculations.

                \n
                • \n
              • \n

                \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

                \n

                If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

                \n

                If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

                \n
                • \n
              \n

              If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

              \n \n

              If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

              \n               " + "smithy.api#documentation": "

              The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

              \n
                \n
              • \n

                \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

                \n
                • \n
              • \n

                \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

                \n
                • \n
              • \n

                \n COUNT - Returns the number of matching items, rather than the\n matching items themselves. Note that this uses the same quantity of read\n capacity units as getting the items, and is subject to the same item size\n calculations.

                \n
                • \n
              • \n

                \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

                \n

                If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

                \n

                If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

                \n
                • \n
              \n

              If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

              \n \n

              If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

              \n               " } }, "ScanFilter": { @@ -10371,7 +10371,7 @@ "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

              A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

              \n \n

              A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

              \n               \n

              For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

              \n \n

              A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

              \n               \n

              For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

              " } }, "ExpressionAttributeNames": { @@ -10430,7 +10430,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

              The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see \n Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

              " + "smithy.api#documentation": "

              The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

              " } } }, @@ -11677,7 +11677,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

              ", "smithy.api#required": {} } }, @@ -11733,7 +11733,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

              ", "smithy.api#required": {} } }, @@ -11843,7 +11843,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              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.

              \n \n

              This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

              \n

              To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

              \n               \n \n

              \n For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.\n

              \n

              \n Although you can use UpdateGlobalTable 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

              \n               \n

              If global secondary indexes are specified, then the following conditions must also be\n met:

              \n
                \n
              • \n

                The global secondary indexes must have the same name.

                \n
                • \n
              • \n

                The global secondary indexes must have the same hash key and sort key (if\n present).

                \n
                • \n
              • \n

                The global secondary indexes must have the same provisioned and maximum write\n capacity units.

                \n
                • \n
              " + "smithy.api#documentation": "

              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.

              \n \n

              This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

              \n

              To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

              \n               \n \n

              For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version). If you are using global tables Version\n 2019.11.21 you can use UpdateTable instead.

              \n

              Although you can use UpdateGlobalTable 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               \n

              If global secondary indexes are specified, then the following conditions must also be\n met:

              \n
                \n
              • \n

                The global secondary indexes must have the same name.

                \n
                • \n
              • \n

                The global secondary indexes must have the same hash key and sort key (if\n present).

                \n
                • \n
              • \n

                The global secondary indexes must have the same provisioned and maximum write\n capacity units.

                \n
                • \n
              " } }, "com.amazonaws.dynamodb#UpdateGlobalTableInput": { @@ -12079,7 +12079,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table containing the item to update. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -12111,7 +12111,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

              Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid values\n are:

              \n
                \n
              • \n

                \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

                \n
                • \n
              • \n

                \n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.

                \n
                • \n
              • \n

                \n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.

                \n
                • \n
              • \n

                \n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.

                \n
                • \n
              • \n

                \n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.

                \n
                • \n
              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              \n

              The values returned are strongly consistent.

              " + "smithy.api#documentation": "

              Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid\n values are:

              \n
                \n
              • \n

                \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

                \n
                • \n
              • \n

                \n ALL_OLD - Returns all of the attributes of the item, as they\n appeared before the UpdateItem operation.

                \n
                • \n
              • \n

                \n UPDATED_OLD - Returns only the updated attributes, as they appeared\n before the UpdateItem operation.

                \n
                • \n
              • \n

                \n ALL_NEW - Returns all of the attributes of the item, as they appear\n after the UpdateItem operation.

                \n
                • \n
              • \n

                \n UPDATED_NEW - Returns only the updated attributes, as they appear\n after the UpdateItem operation.

                \n
                • \n
              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              \n

              The values returned are strongly consistent.

              " } }, "ReturnConsumedCapacity": { @@ -12150,7 +12150,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

              An optional parameter that returns the item attributes for an UpdateItem operation that failed a\n condition check.

              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              " + "smithy.api#documentation": "

              An optional parameter that returns the item attributes for an UpdateItem\n operation that failed a condition check.

              \n

              There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

              " } } }, @@ -12165,13 +12165,13 @@ "Attributes": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "

              A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.

              \n

              The Attributes map is only present if the update was successful and ReturnValues was\n specified as something other than NONE in the request. Each element\n represents one attribute.

              " + "smithy.api#documentation": "

              A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.

              \n

              The Attributes map is only present if the update was successful and\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.

              " } }, "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

              The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer\n Guide.

              " + "smithy.api#documentation": "

              The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

              " } }, "ItemCollectionMetrics": { @@ -12238,7 +12238,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.

              ", + "smithy.api#documentation": "

              The table name for the Kinesis streaming destination input. You can also provide the\n ARN of the table in this parameter.

              ", "smithy.api#required": {} } }, @@ -12366,7 +12366,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

              Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

              \n \n

              For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n

              \n               \n

              You can only perform one of the following operations at once:

              \n
                \n
              • \n

                Modify the provisioned throughput settings of the table.

                \n
                • \n
              • \n

                Remove a global secondary index from the table.

                \n
                • \n
              • \n

                Create a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.

                \n
                • \n
              \n

              \n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

              " + "smithy.api#documentation": "

              Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

              \n \n

              For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

              \n               \n

              You can only perform one of the following operations at once:

              \n
                \n
              • \n

                Modify the provisioned throughput settings of the table.

                \n
                • \n
              • \n

                Remove a global secondary index from the table.

                \n
                • \n
              • \n

                Create a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.

                \n
                • \n
              \n

              \n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

              " } }, "com.amazonaws.dynamodb#UpdateTableInput": { @@ -12381,7 +12381,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

              ", "smithy.api#required": {} } }, @@ -12418,7 +12418,7 @@ "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", "traits": { - "smithy.api#documentation": "

              A list of replica update actions (create, delete, or update) for the table.

              \n \n

              For global tables, this property only applies to global tables using Version 2019.11.21 (Current version). \n

              \n               " + "smithy.api#documentation": "

              A list of replica update actions (create, delete, or update) for the table.

              \n \n

              For global tables, this property only applies to global tables using Version\n 2019.11.21 (Current version).

              \n               " } }, "TableClass": { @@ -12430,13 +12430,13 @@ "DeletionProtectionEnabled": { "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", "traits": { - "smithy.api#documentation": "

              Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

              " + "smithy.api#documentation": "

              Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

              " } }, "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { - "smithy.api#documentation": "

              Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

              " + "smithy.api#documentation": "

              Updates the maximum number of read and write units for the specified table in\n on-demand capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

              " } } }, @@ -12483,7 +12483,7 @@ } ], "traits": { - "smithy.api#documentation": "

              Updates auto scaling settings on your global tables at once.

              \n \n

              For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).\n

              \n               " + "smithy.api#documentation": "

              Updates auto scaling settings on your global tables at once.

              \n \n

              For global tables, this operation only applies to global tables using Version\n 2019.11.21 (Current version).

              \n               " } }, "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput": { @@ -12498,7 +12498,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

              ", "smithy.api#required": {} } }, @@ -12568,7 +12568,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

              The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

              ", + "smithy.api#documentation": "

              The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

              ", "smithy.api#required": {} } },