Skip to content

Commit f51647a

Browse files
author
awstools
committed
docs(client-dynamodb): DynamoDB doc only update for July
1 parent f1138f7 commit f51647a

22 files changed

+370
-255
lines changed

clients/client-dynamodb/src/auth/httpAuthSchemeProvider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: DynamoDBHttpAuthScheme
6060
name: "dynamodb",
6161
region: authParameters.region,
6262
},
63-
propertiesExtractor: (config: DynamoDBClientConfig, context) => ({
63+
propertiesExtractor: (config: Partial<DynamoDBClientConfig>, context) => ({
6464
/**
6565
* @internal
6666
*/

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
3131
* <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
3232
* using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
3333
* an equality condition on all key attributes. This enforces that each <code>SELECT</code>
34-
* statement in a batch returns at most a single item.</p>
34+
* 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
35+
* </a>.</p>
3536
* <note>
3637
* <p>The entire batch must consist of either read statements or write statements, you
3738
* cannot mix both in one batch.</p>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
3232
* from one or more tables. You identify requested items by primary key.</p>
3333
* <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
3434
* items. <code>BatchGetItem</code> returns a partial result if the response size limit is
35-
* exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested,
36-
* or an internal processing failure occurs. If a partial result is returned, the operation returns a value for
37-
* <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
38-
* with the next item to get.</p>
35+
* exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is
36+
* requested, or an internal processing failure occurs. If a partial result is returned,
37+
* the operation returns a value for <code>UnprocessedKeys</code>. You can use this value
38+
* to retry the operation starting with the next item to get.</p>
3939
* <important>
4040
* <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
4141
* <code>ValidationException</code> with the message "Too many items requested for

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
3636
* 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>
3737
* <note>
3838
* <p>
39-
* <code>BatchWriteItem</code> cannot update items. If you perform a <code>BatchWriteItem</code>
40-
* operation on an existing item, that item's values will be overwritten by the
41-
* operation and it will appear like it was updated. To update items, we recommend you
42-
* use the <code>UpdateItem</code> action.</p>
39+
* <code>BatchWriteItem</code> cannot update items. If you perform a
40+
* <code>BatchWriteItem</code> operation on an existing item, that item's values
41+
* will be overwritten by the operation and it will appear like it was updated. To
42+
* update items, we recommend you use the <code>UpdateItem</code> action.</p>
4343
* </note>
4444
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
4545
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
@@ -50,10 +50,13 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
5050
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
5151
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
5252
* until all items have been processed.</p>
53-
* <p>If <i>none</i> of the items can be processed due to insufficient
54-
* provisioned throughput on all of the tables in the request, then
55-
* <code>BatchWriteItem</code> returns a
56-
* <code>ProvisionedThroughputExceededException</code>.</p>
53+
* <p>For tables and indexes with provisioned capacity, if none of the items can be
54+
* processed due to insufficient provisioned throughput on all of the tables in the
55+
* request, then <code>BatchWriteItem</code> returns a
56+
* <code>ProvisionedThroughputExceededException</code>. For all tables and indexes, if
57+
* none of the items can be processed due to other throttling scenarios (such as exceeding
58+
* partition level limits), then <code>BatchWriteItem</code> returns a
59+
* <code>ThrottlingException</code>.</p>
5760
* <important>
5861
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
5962
* those items. However, <i>we strongly recommend that you use an exponential

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

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,27 @@ export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyIn
2828
export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the resource-based policy attached to the resource, which can be a table or stream.</p>
31+
* <p>Deletes the resource-based policy attached to the resource, which can be a table or
32+
* stream.</p>
3233
* <p>
33-
* <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>
34+
* <code>DeleteResourcePolicy</code> is an idempotent operation; running it multiple
35+
* times on the same resource <i>doesn't</i> result in an error response,
36+
* unless you specify an <code>ExpectedRevisionId</code>, which will then return a
37+
* <code>PolicyNotFoundException</code>.</p>
3438
* <important>
35-
* <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.
36-
* </p>
39+
* <p>To make sure that you don't inadvertently lock yourself out of your own resources,
40+
* the root principal in your Amazon Web Services account can perform
41+
* <code>DeleteResourcePolicy</code> requests, even if your resource-based policy
42+
* explicitly denies the root principal's access. </p>
3743
* </important>
3844
* <note>
3945
* <p>
40-
* <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>
46+
* <code>DeleteResourcePolicy</code> is an asynchronous operation. If you issue a
47+
* <code>GetResourcePolicy</code> request immediately after running the
48+
* <code>DeleteResourcePolicy</code> request, DynamoDB might still return
49+
* the deleted policy. This is because the policy for your resource might not have been
50+
* deleted yet. Wait for a few seconds, and then try the <code>GetResourcePolicy</code>
51+
* request again.</p>
4152
* </note>
4253
* @example
4354
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
3737
* returns a <code>ResourceNotFoundException</code>. If table is already in the
3838
* <code>DELETING</code> state, no error is returned. </p>
3939
* <important>
40-
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
41-
* </p>
40+
* <p>For global tables, this operation only applies to
41+
* global tables using Version 2019.11.21 (Current version). </p>
4242
* </important>
4343
* <note>
4444
* <p>DynamoDB might continue to accept data read and write operations, such as
4545
* <code>GetItem</code> and <code>PutItem</code>, on a table in the
46-
* <code>DELETING</code> state until the table deletion is complete.</p>
46+
* <code>DELETING</code> state until the table deletion is complete. For the full
47+
* 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>
4748
* </note>
4849
* <p>When you delete a table, any indexes on that table are also deleted.</p>
4950
* <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest
2828
export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the regional endpoint information. For more information
32-
* 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>
31+
* <p>Returns the regional endpoint information. For more information on policy permissions,
32+
* 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>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
3131
* <p>Returns information about the table, including the current status of the table, when
3232
* it was created, the primary key schema, and any indexes on the table.</p>
3333
* <important>
34-
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
35-
* </p>
34+
* <p>For global tables, this operation only applies to global tables using Version
35+
* 2019.11.21 (Current version). </p>
3636
* </important>
3737
* <note>
3838
* <p>If you issue a <code>DescribeTable</code> request immediately after a

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ export interface DescribeTableReplicaAutoScalingCommandOutput
3535
/**
3636
* <p>Describes auto scaling settings across replicas of the global table at once.</p>
3737
* <important>
38-
* <p>For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).</p>
38+
* <p>For global tables, this operation only applies to global tables using Version
39+
* 2019.11.21 (Current version).</p>
3940
* </important>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface DisableKinesisStreamingDestinationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Stops replication from the DynamoDB table to the Kinesis data stream. This is done
37-
* without deleting either of the resources.</p>
36+
* <p>Stops replication from the DynamoDB table to the Kinesis data stream. This
37+
* is done without deleting either of the resources.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

0 commit comments

Comments
 (0)