docs(client-dynamodb): DynamoDB doc only update for July

Author: awstools

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<DynamoDBClientConfig>, context) => ({
       /**
        * @internal
        */

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

@@ -31,7 +31,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
  * <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
  *             using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
  *             an equality condition on all key attributes. This enforces that each <code>SELECT</code>
- *             statement in a batch returns at most a single item.</p>
+ *             statement in a batch returns at most a single item. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html">Running batch operations with PartiQL for DynamoDB
+ *             </a>.</p>
  *          <note>
  *             <p>The entire batch must consist of either read statements or write statements, you
  *                 cannot mix both in one batch.</p>

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.</p>
  *          <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
  *             items. <code>BatchGetItem</code> 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
- *                 <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
- *             with the next item to get.</p>
+ *             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 <code>UnprocessedKeys</code>. You can use this value
+ *             to retry the operation starting with the next item to get.</p>
  *          <important>
  *             <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
  *                     <code>ValidationException</code> with the message "Too many items requested for

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 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html">Naming Rules and Data Types</a>.</p>
  *          <note>
  *             <p>
- *                <code>BatchWriteItem</code> cannot update items. If you perform a <code>BatchWriteItem</code>
- *                 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 <code>UpdateItem</code> action.</p>
+ *                <code>BatchWriteItem</code> cannot update items. If you perform a
+ *                     <code>BatchWriteItem</code> 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 <code>UpdateItem</code> action.</p>
  *          </note>
  *          <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
  *             in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
@@ -50,10 +50,13 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
  *                 <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
  *             items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
  *             until all items have been processed.</p>
- *          <p>If <i>none</i> of the items can be processed due to insufficient
- *             provisioned throughput on all of the tables in the request, then
- *                 <code>BatchWriteItem</code> returns a
- *                 <code>ProvisionedThroughputExceededException</code>.</p>
+ *          <p>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 <code>BatchWriteItem</code> returns a
+ *                 <code>ProvisionedThroughputExceededException</code>. 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 <code>BatchWriteItem</code> returns a
+ *                 <code>ThrottlingException</code>.</p>
  *          <important>
  *             <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
  *                 those items. However, <i>we strongly recommend that you use an exponential

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

@@ -28,16 +28,27 @@ export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyIn
 export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyOutput, __MetadataBearer {}
 
 /**
- * <p>Deletes the resource-based policy attached to the resource, which can be a table or stream.</p>
+ * <p>Deletes the resource-based policy attached to the resource, which can be a table or
+ *             stream.</p>
  *          <p>
- *             <code>DeleteResourcePolicy</code> is an idempotent operation; running it multiple times on the same resource <i>doesn't</i> result in an error response, unless you specify an <code>ExpectedRevisionId</code>, which will then return a <code>PolicyNotFoundException</code>.</p>
+ *             <code>DeleteResourcePolicy</code> is an idempotent operation; running it multiple
+ *             times on the same resource <i>doesn't</i> result in an error response,
+ *             unless you specify an <code>ExpectedRevisionId</code>, which will then return a
+ *                 <code>PolicyNotFoundException</code>.</p>
  *          <important>
- *             <p>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 <code>DeleteResourcePolicy</code> requests, even if your resource-based policy explicitly denies the root principal's access.
- *             </p>
+ *             <p>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
+ *                     <code>DeleteResourcePolicy</code> requests, even if your resource-based policy
+ *                 explicitly denies the root principal's access. </p>
  *          </important>
  *          <note>
  *             <p>
- *                <code>DeleteResourcePolicy</code> is an asynchronous operation. If you issue a <code>GetResourcePolicy</code> request immediately after running the <code>DeleteResourcePolicy</code> 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 <code>GetResourcePolicy</code> request again.</p>
+ *                <code>DeleteResourcePolicy</code> is an asynchronous operation. If you issue a
+ *                     <code>GetResourcePolicy</code> request immediately after running the
+ *                     <code>DeleteResourcePolicy</code> 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 <code>GetResourcePolicy</code>
+ *                 request again.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -37,13 +37,14 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
  *             returns a <code>ResourceNotFoundException</code>. If table is already in the
  *                 <code>DELETING</code> state, no error is returned. </p>
  *          <important>
- *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
- *             </p>
+ *             <p>For global tables, this operation only applies to
+ *                 global tables using Version 2019.11.21 (Current version). </p>
  *          </important>
  *          <note>
  *             <p>DynamoDB might continue to accept data read and write operations, such as
  *                     <code>GetItem</code> and <code>PutItem</code>, on a table in the
- *                     <code>DELETING</code> state until the table deletion is complete.</p>
+ *                     <code>DELETING</code> state until the table deletion is complete. For the full
+ *                 list of table states, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TableDescription.html#DDB-Type-TableDescription-TableStatus">TableStatus</a>.</p>
  *          </note>
  *          <p>When you delete a table, any indexes on that table are also deleted.</p>
  *          <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on

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

@@ -28,8 +28,8 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest
 export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {}
 
 /**
- * <p>Returns the regional endpoint information. For more information
- *             on policy permissions, please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
+ * <p>Returns the regional endpoint information. For more information on policy permissions,
+ *             please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -31,8 +31,8 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
  * <p>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.</p>
  *          <important>
- *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
- *             </p>
+ *             <p>For global tables, this operation only applies to global tables using Version
+ *                 2019.11.21 (Current version). </p>
  *          </important>
  *          <note>
  *             <p>If you issue a <code>DescribeTable</code> request immediately after a

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

@@ -35,7 +35,8 @@ export interface DescribeTableReplicaAutoScalingCommandOutput
 /**
  * <p>Describes auto scaling settings across replicas of the global table at once.</p>
  *          <important>
- *             <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).</p>
+ *             <p>For global tables, this operation only applies to global tables using Version
+ *                 2019.11.21 (Current version).</p>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -33,8 +33,8 @@ export interface DisableKinesisStreamingDestinationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Stops replication from the DynamoDB table to the Kinesis data stream. This is done
- *             without deleting either of the resources.</p>
+ * <p>Stops replication from the DynamoDB table to the Kinesis data stream. This
+ *             is done without deleting either of the resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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 <code>WHERE</code> clause). If
  *                 <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
- *             result set. If <code>NextToken</code> is present, you need to paginate the result set and include
- *             <code>NextToken</code>.</p>
+ *             result set. If <code>NextToken</code> is present, you need to paginate the result set
+ *             and include <code>NextToken</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,24 +28,42 @@ export interface GetResourcePolicyCommandInput extends GetResourcePolicyInput {}
 export interface GetResourcePolicyCommandOutput extends GetResourcePolicyOutput, __MetadataBearer {}
 
 /**
- * <p>Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.</p>
+ * <p>Returns the resource-based policy document attached to the resource, which can be a
+ *             table or stream, in JSON format.</p>
  *          <p>
  *             <code>GetResourcePolicy</code> follows an <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
  *                <i>eventually consistent</i>
- *             </a> model. The following list describes the outcomes when you issue the <code>GetResourcePolicy</code> request immediately after issuing another request:</p>
+ *             </a> model. The following list
+ *             describes the outcomes when you issue the <code>GetResourcePolicy</code> request
+ *             immediately after issuing another request:</p>
  *          <ul>
  *             <li>
- *                <p>If you issue a <code>GetResourcePolicy</code> request immediately after a <code>PutResourcePolicy</code> request, DynamoDB might return a <code>PolicyNotFoundException</code>.</p>
+ *                <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
+ *                         <code>PutResourcePolicy</code> request, DynamoDB might return a
+ *                         <code>PolicyNotFoundException</code>.</p>
  *             </li>
  *             <li>
- *                <p>If you issue a <code>GetResourcePolicy</code>request immediately after a <code>DeleteResourcePolicy</code> request, DynamoDB might return the policy that was present before the deletion request.</p>
+ *                <p>If you issue a <code>GetResourcePolicy</code>request immediately after a
+ *                         <code>DeleteResourcePolicy</code> request, DynamoDB might return
+ *                     the policy that was present before the deletion request.</p>
  *             </li>
  *             <li>
- *                <p>If you issue a <code>GetResourcePolicy</code> request immediately after a <code>CreateTable</code> request, which includes a resource-based policy, DynamoDB might return a <code>ResourceNotFoundException</code> or a <code>PolicyNotFoundException</code>.</p>
+ *                <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
+ *                         <code>CreateTable</code> request, which includes a resource-based policy,
+ *                         DynamoDB might return a <code>ResourceNotFoundException</code> or
+ *                     a <code>PolicyNotFoundException</code>.</p>
  *             </li>
  *          </ul>
- *          <p>Because <code>GetResourcePolicy</code> uses an <i>eventually consistent</i> query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the <code>GetResourcePolicy</code> request.</p>
- *          <p>After a <code>GetResourcePolicy</code> request returns a policy created using the <code>PutResourcePolicy</code> 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 <code>CreateTable</code> request will always be applied to all requests for that table.</p>
+ *          <p>Because <code>GetResourcePolicy</code> uses an <i>eventually
+ *                 consistent</i> query, the metadata for your policy or table might not be
+ *             available at that moment. Wait for a few seconds, and then retry the
+ *                 <code>GetResourcePolicy</code> request.</p>
+ *          <p>After a <code>GetResourcePolicy</code> request returns a policy created using the
+ *                 <code>PutResourcePolicy</code> 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 <code>CreateTable</code>
+ *             request will always be applied to all requests for that table.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,15 +28,17 @@ export interface ListBackupsCommandInput extends ListBackupsInput {}
 export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataBearer {}
 
 /**
- * <p>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 <code>TableName</code>. <code>ListBackups</code> 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.</p>
+ * <p>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 <code>TableName</code>. <code>ListBackups</code> 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.</p>
  *          <p>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.</p>
  *          <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
- *          <p>If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the
- *             <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html">Amazon Web Services Backup list API.</a>
+ *          <p>If you want to retrieve the complete list of backups made with Amazon Web Services
+ *             Backup, use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html">Amazon Web Services Backup
+ *                 list API.</a>
  *          </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.