@aws-sdk/client-dynamodb 3.616.0 → 3.619.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetItemCommand.d.ts +4 -4
- package/dist-types/commands/BatchWriteItemCommand.d.ts +11 -8
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -5
- package/dist-types/commands/DeleteTableCommand.d.ts +4 -3
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTableCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +2 -1
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +2 -2
- package/dist-types/commands/ExecuteStatementCommand.d.ts +2 -2
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +25 -7
- package/dist-types/commands/ListBackupsCommand.d.ts +8 -6
- package/dist-types/commands/PutItemCommand.d.ts +1 -2
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -3
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +2 -2
- package/dist-types/commands/ScanCommand.d.ts +28 -27
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +5 -8
- package/dist-types/commands/UpdateTableCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +155 -87
- package/package.json +1 -1
|
@@ -30,7 +30,8 @@ declare const BatchExecuteStatementCommand_base: {
|
|
|
30
30
|
* <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
|
|
31
31
|
* using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
|
|
32
32
|
* an equality condition on all key attributes. This enforces that each <code>SELECT</code>
|
|
33
|
-
* statement in a batch returns at most a single item
|
|
33
|
+
* 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
|
|
34
|
+
* </a>.</p>
|
|
34
35
|
* <note>
|
|
35
36
|
* <p>The entire batch must consist of either read statements or write statements, you
|
|
36
37
|
* cannot mix both in one batch.</p>
|
|
@@ -31,10 +31,10 @@ declare const BatchGetItemCommand_base: {
|
|
|
31
31
|
* from one or more tables. You identify requested items by primary key.</p>
|
|
32
32
|
* <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
|
|
33
33
|
* items. <code>BatchGetItem</code> returns a partial result if the response size limit is
|
|
34
|
-
* exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is
|
|
35
|
-
* or an internal processing failure occurs. If a partial result is returned,
|
|
36
|
-
*
|
|
37
|
-
* with the next item to get.</p>
|
|
34
|
+
* exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is
|
|
35
|
+
* requested, or an internal processing failure occurs. If a partial result is returned,
|
|
36
|
+
* the operation returns a value for <code>UnprocessedKeys</code>. You can use this value
|
|
37
|
+
* to retry the operation starting with the next item to get.</p>
|
|
38
38
|
* <important>
|
|
39
39
|
* <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
|
|
40
40
|
* <code>ValidationException</code> with the message "Too many items requested for
|
|
@@ -35,10 +35,10 @@ declare const BatchWriteItemCommand_base: {
|
|
|
35
35
|
* 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>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>
|
|
38
|
-
* <code>BatchWriteItem</code> cannot update items. If you perform a
|
|
39
|
-
*
|
|
40
|
-
* operation and it will appear like it was updated. To
|
|
41
|
-
* use the <code>UpdateItem</code> action.</p>
|
|
38
|
+
* <code>BatchWriteItem</code> cannot update items. If you perform a
|
|
39
|
+
* <code>BatchWriteItem</code> operation on an existing item, that item's values
|
|
40
|
+
* will be overwritten by the operation and it will appear like it was updated. To
|
|
41
|
+
* update items, we recommend you use the <code>UpdateItem</code> action.</p>
|
|
42
42
|
* </note>
|
|
43
43
|
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
|
|
44
44
|
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
|
|
@@ -49,10 +49,13 @@ declare const BatchWriteItemCommand_base: {
|
|
|
49
49
|
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
|
|
50
50
|
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
|
|
51
51
|
* until all items have been processed.</p>
|
|
52
|
-
* <p>
|
|
53
|
-
* provisioned throughput on all of the tables in the
|
|
54
|
-
*
|
|
55
|
-
* <code>ProvisionedThroughputExceededException</code
|
|
52
|
+
* <p>For tables and indexes with provisioned capacity, if none of the items can be
|
|
53
|
+
* processed due to insufficient provisioned throughput on all of the tables in the
|
|
54
|
+
* request, then <code>BatchWriteItem</code> returns a
|
|
55
|
+
* <code>ProvisionedThroughputExceededException</code>. For all tables and indexes, if
|
|
56
|
+
* none of the items can be processed due to other throttling scenarios (such as exceeding
|
|
57
|
+
* partition level limits), then <code>BatchWriteItem</code> returns a
|
|
58
|
+
* <code>ThrottlingException</code>.</p>
|
|
56
59
|
* <important>
|
|
57
60
|
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
58
61
|
* those items. However, <i>we strongly recommend that you use an exponential
|
|
@@ -27,16 +27,27 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the resource-based policy attached to the resource, which can be a table or
|
|
30
|
+
* <p>Deletes the resource-based policy attached to the resource, which can be a table or
|
|
31
|
+
* stream.</p>
|
|
31
32
|
* <p>
|
|
32
|
-
* <code>DeleteResourcePolicy</code> is an idempotent operation; running it multiple
|
|
33
|
+
* <code>DeleteResourcePolicy</code> is an idempotent operation; running it multiple
|
|
34
|
+
* times on the same resource <i>doesn't</i> result in an error response,
|
|
35
|
+
* unless you specify an <code>ExpectedRevisionId</code>, which will then return a
|
|
36
|
+
* <code>PolicyNotFoundException</code>.</p>
|
|
33
37
|
* <important>
|
|
34
|
-
* <p>To make sure that you don't inadvertently lock yourself out of your own resources,
|
|
35
|
-
*
|
|
38
|
+
* <p>To make sure that you don't inadvertently lock yourself out of your own resources,
|
|
39
|
+
* the root principal in your Amazon Web Services account can perform
|
|
40
|
+
* <code>DeleteResourcePolicy</code> requests, even if your resource-based policy
|
|
41
|
+
* explicitly denies the root principal's access. </p>
|
|
36
42
|
* </important>
|
|
37
43
|
* <note>
|
|
38
44
|
* <p>
|
|
39
|
-
* <code>DeleteResourcePolicy</code> is an asynchronous operation. If you issue a
|
|
45
|
+
* <code>DeleteResourcePolicy</code> is an asynchronous operation. If you issue a
|
|
46
|
+
* <code>GetResourcePolicy</code> request immediately after running the
|
|
47
|
+
* <code>DeleteResourcePolicy</code> request, DynamoDB might still return
|
|
48
|
+
* the deleted policy. This is because the policy for your resource might not have been
|
|
49
|
+
* deleted yet. Wait for a few seconds, and then try the <code>GetResourcePolicy</code>
|
|
50
|
+
* request again.</p>
|
|
40
51
|
* </note>
|
|
41
52
|
* @example
|
|
42
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -36,13 +36,14 @@ declare const DeleteTableCommand_base: {
|
|
|
36
36
|
* returns a <code>ResourceNotFoundException</code>. If table is already in the
|
|
37
37
|
* <code>DELETING</code> state, no error is returned. </p>
|
|
38
38
|
* <important>
|
|
39
|
-
* <p>For global tables, this operation only applies to
|
|
40
|
-
*
|
|
39
|
+
* <p>For global tables, this operation only applies to
|
|
40
|
+
* global tables using Version 2019.11.21 (Current version). </p>
|
|
41
41
|
* </important>
|
|
42
42
|
* <note>
|
|
43
43
|
* <p>DynamoDB might continue to accept data read and write operations, such as
|
|
44
44
|
* <code>GetItem</code> and <code>PutItem</code>, on a table in the
|
|
45
|
-
* <code>DELETING</code> state until the table deletion is complete
|
|
45
|
+
* <code>DELETING</code> state until the table deletion is complete. For the full
|
|
46
|
+
* 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>
|
|
46
47
|
* </note>
|
|
47
48
|
* <p>When you delete a table, any indexes on that table are also deleted.</p>
|
|
48
49
|
* <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on
|
|
@@ -27,8 +27,8 @@ declare const DescribeEndpointsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the regional endpoint information. For more information
|
|
31
|
-
*
|
|
30
|
+
* <p>Returns the regional endpoint information. For more information on policy permissions,
|
|
31
|
+
* 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>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -30,8 +30,8 @@ declare const DescribeTableCommand_base: {
|
|
|
30
30
|
* <p>Returns information about the table, including the current status of the table, when
|
|
31
31
|
* it was created, the primary key schema, and any indexes on the table.</p>
|
|
32
32
|
* <important>
|
|
33
|
-
* <p>For global tables, this operation only applies to global tables using Version
|
|
34
|
-
*
|
|
33
|
+
* <p>For global tables, this operation only applies to global tables using Version
|
|
34
|
+
* 2019.11.21 (Current version). </p>
|
|
35
35
|
* </important>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>If you issue a <code>DescribeTable</code> request immediately after a
|
|
@@ -29,7 +29,8 @@ declare const DescribeTableReplicaAutoScalingCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Describes auto scaling settings across replicas of the global table at once.</p>
|
|
31
31
|
* <important>
|
|
32
|
-
* <p>For global tables, this operation only applies to global tables using Version
|
|
32
|
+
* <p>For global tables, this operation only applies to global tables using Version
|
|
33
|
+
* 2019.11.21 (Current version).</p>
|
|
33
34
|
* </important>
|
|
34
35
|
* @example
|
|
35
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,8 +27,8 @@ declare const DisableKinesisStreamingDestinationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stops replication from the DynamoDB table to the Kinesis data stream. This
|
|
31
|
-
* without deleting either of the resources.</p>
|
|
30
|
+
* <p>Stops replication from the DynamoDB table to the Kinesis data stream. This
|
|
31
|
+
* is done without deleting either of the resources.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -38,8 +38,8 @@ declare const ExecuteStatementCommand_base: {
|
|
|
38
38
|
* items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
|
|
39
39
|
* filtering to the results using <code>WHERE</code> clause). If
|
|
40
40
|
* <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
|
|
41
|
-
* result set. If <code>NextToken</code> is present, you need to paginate the result set
|
|
42
|
-
* <code>NextToken</code>.</p>
|
|
41
|
+
* result set. If <code>NextToken</code> is present, you need to paginate the result set
|
|
42
|
+
* and include <code>NextToken</code>.</p>
|
|
43
43
|
* @example
|
|
44
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
45
|
* ```javascript
|
|
@@ -27,24 +27,42 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the resource-based policy document attached to the resource, which can be a
|
|
30
|
+
* <p>Returns the resource-based policy document attached to the resource, which can be a
|
|
31
|
+
* table or stream, in JSON format.</p>
|
|
31
32
|
* <p>
|
|
32
33
|
* <code>GetResourcePolicy</code> follows an <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
33
34
|
* <i>eventually consistent</i>
|
|
34
|
-
* </a> model. The following list
|
|
35
|
+
* </a> model. The following list
|
|
36
|
+
* describes the outcomes when you issue the <code>GetResourcePolicy</code> request
|
|
37
|
+
* immediately after issuing another request:</p>
|
|
35
38
|
* <ul>
|
|
36
39
|
* <li>
|
|
37
|
-
* <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
|
|
40
|
+
* <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
|
|
41
|
+
* <code>PutResourcePolicy</code> request, DynamoDB might return a
|
|
42
|
+
* <code>PolicyNotFoundException</code>.</p>
|
|
38
43
|
* </li>
|
|
39
44
|
* <li>
|
|
40
|
-
* <p>If you issue a <code>GetResourcePolicy</code>request immediately after a
|
|
45
|
+
* <p>If you issue a <code>GetResourcePolicy</code>request immediately after a
|
|
46
|
+
* <code>DeleteResourcePolicy</code> request, DynamoDB might return
|
|
47
|
+
* the policy that was present before the deletion request.</p>
|
|
41
48
|
* </li>
|
|
42
49
|
* <li>
|
|
43
|
-
* <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
|
|
50
|
+
* <p>If you issue a <code>GetResourcePolicy</code> request immediately after a
|
|
51
|
+
* <code>CreateTable</code> request, which includes a resource-based policy,
|
|
52
|
+
* DynamoDB might return a <code>ResourceNotFoundException</code> or
|
|
53
|
+
* a <code>PolicyNotFoundException</code>.</p>
|
|
44
54
|
* </li>
|
|
45
55
|
* </ul>
|
|
46
|
-
* <p>Because <code>GetResourcePolicy</code> uses an <i>eventually
|
|
47
|
-
*
|
|
56
|
+
* <p>Because <code>GetResourcePolicy</code> uses an <i>eventually
|
|
57
|
+
* consistent</i> query, the metadata for your policy or table might not be
|
|
58
|
+
* available at that moment. Wait for a few seconds, and then retry the
|
|
59
|
+
* <code>GetResourcePolicy</code> request.</p>
|
|
60
|
+
* <p>After a <code>GetResourcePolicy</code> request returns a policy created using the
|
|
61
|
+
* <code>PutResourcePolicy</code> request, the policy will be applied in the
|
|
62
|
+
* authorization of requests to the resource. Because this process is eventually
|
|
63
|
+
* consistent, it will take some time to apply the policy to all requests to a resource.
|
|
64
|
+
* Policies that you attach while creating a table using the <code>CreateTable</code>
|
|
65
|
+
* request will always be applied to all requests for that table.</p>
|
|
48
66
|
* @example
|
|
49
67
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
68
|
* ```javascript
|
|
@@ -27,15 +27,17 @@ declare const ListBackupsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>List DynamoDB backups that are associated with an Amazon Web Services account and
|
|
31
|
-
* To list these backups for a given table,
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>List DynamoDB backups that are associated with an Amazon Web Services account and
|
|
31
|
+
* weren't made with Amazon Web Services Backup. To list these backups for a given table,
|
|
32
|
+
* specify <code>TableName</code>. <code>ListBackups</code> returns a paginated list of
|
|
33
|
+
* results with at most 1 MB worth of items in a page. You can also specify a maximum
|
|
34
|
+
* number of entries to be returned in a page.</p>
|
|
34
35
|
* <p>In the request, start time is inclusive, but end time is exclusive. Note that these
|
|
35
36
|
* boundaries are for the time at which the original backup was requested.</p>
|
|
36
37
|
* <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
|
|
37
|
-
* <p>If you want to retrieve the complete list of backups made with Amazon Web Services
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html">Amazon Web Services Backup
|
|
38
|
+
* <p>If you want to retrieve the complete list of backups made with Amazon Web Services
|
|
39
|
+
* Backup, use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html">Amazon Web Services Backup
|
|
40
|
+
* list API.</a>
|
|
39
41
|
* </p>
|
|
40
42
|
* @example
|
|
41
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,8 +33,7 @@ declare const PutItemCommand_base: {
|
|
|
33
33
|
* a new item if one with the specified primary key doesn't exist), or replace an existing
|
|
34
34
|
* item if it has certain attribute values. You can return the item's attribute values in
|
|
35
35
|
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
36
|
-
* <p>When you add an item, the primary key attributes are the only required attributes.
|
|
37
|
-
* </p>
|
|
36
|
+
* <p>When you add an item, the primary key attributes are the only required attributes. </p>
|
|
38
37
|
* <p>Empty String and Binary attribute values are allowed. Attribute values of type String
|
|
39
38
|
* and Binary must have a length greater than zero if the attribute is used as a key
|
|
40
39
|
* attribute for a table or index. Set type attributes cannot be empty. </p>
|
|
@@ -27,14 +27,27 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Attaches a resource-based policy document to the resource, which can be a table or
|
|
30
|
+
* <p>Attaches a resource-based policy document to the resource, which can be a table or
|
|
31
|
+
* stream. When you attach a resource-based policy using this API, the policy application
|
|
32
|
+
* is <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
31
33
|
* <i>eventually consistent</i>
|
|
32
34
|
* </a>.</p>
|
|
33
35
|
* <p>
|
|
34
|
-
* <code>PutResourcePolicy</code> is an idempotent operation; running it multiple times
|
|
36
|
+
* <code>PutResourcePolicy</code> is an idempotent operation; running it multiple times
|
|
37
|
+
* on the same resource using the same policy document will return the same revision ID. If
|
|
38
|
+
* you specify an <code>ExpectedRevisionId</code> that doesn't match the current policy's
|
|
39
|
+
* <code>RevisionId</code>, the <code>PolicyNotFoundException</code> will be
|
|
40
|
+
* returned.</p>
|
|
35
41
|
* <note>
|
|
36
42
|
* <p>
|
|
37
|
-
* <code>PutResourcePolicy</code> is an asynchronous operation. If you issue a
|
|
43
|
+
* <code>PutResourcePolicy</code> is an asynchronous operation. If you issue a
|
|
44
|
+
* <code>GetResourcePolicy</code> request immediately after a
|
|
45
|
+
* <code>PutResourcePolicy</code> request, DynamoDB might return your
|
|
46
|
+
* previous policy, if there was one, or return the
|
|
47
|
+
* <code>PolicyNotFoundException</code>. This is because
|
|
48
|
+
* <code>GetResourcePolicy</code> uses an eventually consistent query, and the
|
|
49
|
+
* metadata for your policy or table might not be available at that moment. Wait for a
|
|
50
|
+
* few seconds, and then try the <code>GetResourcePolicy</code> request again.</p>
|
|
38
51
|
* </note>
|
|
39
52
|
* @example
|
|
40
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,8 +33,8 @@ declare const RestoreTableToPointInTimeCommand_base: {
|
|
|
33
33
|
* users can execute up to 50 concurrent restores (any type of restore) in a given account. </p>
|
|
34
34
|
* <p>When you restore using point in time recovery, DynamoDB restores your table data to
|
|
35
35
|
* the state based on the selected date and time (day:hour:minute:second) to a new table. </p>
|
|
36
|
-
* <p>Along with data, the following are also included on the new restored table using
|
|
37
|
-
*
|
|
36
|
+
* <p>Along with data, the following are also included on the new restored table using point
|
|
37
|
+
* in time recovery: </p>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
40
40
|
* <p>Global secondary indexes (GSIs)</p>
|
|
@@ -30,26 +30,26 @@ declare const ScanCommand_base: {
|
|
|
30
30
|
* <p>The <code>Scan</code> operation returns one or more items and item attributes by
|
|
31
31
|
* accessing every item in a table or a secondary index. To have DynamoDB return fewer
|
|
32
32
|
* items, you can provide a <code>FilterExpression</code> operation.</p>
|
|
33
|
-
* <p>If the total size of scanned items exceeds the maximum dataset size limit of 1 MB,
|
|
34
|
-
*
|
|
35
|
-
* value is also returned and the requestor can use the <code>LastEvaluatedKey</code> to
|
|
36
|
-
* the scan in a subsequent operation. Each scan response also includes number of
|
|
37
|
-
* scanned (ScannedCount) as part of the request. If using a
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
33
|
+
* <p>If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the
|
|
34
|
+
* scan completes and results are returned to the user. The <code>LastEvaluatedKey</code>
|
|
35
|
+
* value is also returned and the requestor can use the <code>LastEvaluatedKey</code> to
|
|
36
|
+
* continue the scan in a subsequent operation. Each scan response also includes number of
|
|
37
|
+
* items that were scanned (ScannedCount) as part of the request. If using a
|
|
38
|
+
* <code>FilterExpression</code>, a scan result can result in no items meeting the
|
|
39
|
+
* criteria and the <code>Count</code> will result in zero. If you did not use a
|
|
40
|
+
* <code>FilterExpression</code> in the scan request, then <code>Count</code> is the
|
|
41
|
+
* same as <code>ScannedCount</code>.</p>
|
|
41
42
|
* <note>
|
|
42
43
|
* <p>
|
|
43
|
-
* <code>Count</code> and <code>ScannedCount</code> only return the count of items
|
|
44
|
-
* single scan request and, unless the table is less than 1MB, do not
|
|
45
|
-
* of items in the table.
|
|
46
|
-
* </p>
|
|
44
|
+
* <code>Count</code> and <code>ScannedCount</code> only return the count of items
|
|
45
|
+
* specific to a single scan request and, unless the table is less than 1MB, do not
|
|
46
|
+
* represent the total number of items in the table. </p>
|
|
47
47
|
* </note>
|
|
48
|
-
* <p>A single <code>Scan</code> operation first reads up to the maximum number of items set
|
|
49
|
-
* using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then
|
|
50
|
-
* filtering to the results if a <code>FilterExpression</code> is provided. If
|
|
51
|
-
* <code>LastEvaluatedKey</code> is present in the response, pagination is required to
|
|
52
|
-
* full table scan. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
|
|
48
|
+
* <p>A single <code>Scan</code> operation first reads up to the maximum number of items set
|
|
49
|
+
* (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then
|
|
50
|
+
* applies any filtering to the results if a <code>FilterExpression</code> is provided. If
|
|
51
|
+
* <code>LastEvaluatedKey</code> is present in the response, pagination is required to
|
|
52
|
+
* complete the full table scan. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
|
|
53
53
|
* Results</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
54
54
|
* <p>
|
|
55
55
|
* <code>Scan</code> operations proceed sequentially; however, for faster performance on
|
|
@@ -57,17 +57,18 @@ declare const ScanCommand_base: {
|
|
|
57
57
|
* operation by providing the <code>Segment</code> and <code>TotalSegments</code>
|
|
58
58
|
* parameters. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan">Parallel
|
|
59
59
|
* Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
60
|
-
* <p>By default, a <code>Scan</code> uses eventually consistent reads when accessing the
|
|
61
|
-
* Therefore, the results from an eventually consistent <code>Scan</code>
|
|
62
|
-
* changes at the time the scan iterates through each item
|
|
63
|
-
*
|
|
64
|
-
*
|
|
60
|
+
* <p>By default, a <code>Scan</code> uses eventually consistent reads when accessing the
|
|
61
|
+
* items in a table. Therefore, the results from an eventually consistent <code>Scan</code>
|
|
62
|
+
* may not include the latest item changes at the time the scan iterates through each item
|
|
63
|
+
* in the table. If you require a strongly consistent read of each item as the scan
|
|
64
|
+
* iterates through the items in the table, you can set the <code>ConsistentRead</code>
|
|
65
|
+
* parameter to true. Strong consistency only relates to the consistency of the read at the
|
|
66
|
+
* item level.</p>
|
|
65
67
|
* <note>
|
|
66
|
-
* <p>
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
* </p>
|
|
68
|
+
* <p> DynamoDB does not provide snapshot isolation for a scan operation when the
|
|
69
|
+
* <code>ConsistentRead</code> parameter is set to true. Thus, a DynamoDB scan
|
|
70
|
+
* operation does not guarantee that all reads in a scan see a consistent snapshot of
|
|
71
|
+
* the table when the scan operation was requested. </p>
|
|
71
72
|
* </note>
|
|
72
73
|
* @example
|
|
73
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -36,15 +36,12 @@ declare const UpdateGlobalTableCommand_base: {
|
|
|
36
36
|
* <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
|
|
37
37
|
* </important>
|
|
38
38
|
* <note>
|
|
39
|
-
* <p>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* <p>
|
|
44
|
-
* Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
39
|
+
* <p> For global tables, this operation only applies to global tables using Version
|
|
40
|
+
* 2019.11.21 (Current version). If you are using global tables <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Version
|
|
41
|
+
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html">UpdateTable</a> instead. </p>
|
|
42
|
+
* <p> Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
45
43
|
* replicas in a single request, for simplicity we recommend that you issue separate
|
|
46
|
-
* requests for adding or removing replicas.
|
|
47
|
-
* </p>
|
|
44
|
+
* requests for adding or removing replicas. </p>
|
|
48
45
|
* </note>
|
|
49
46
|
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
50
47
|
* met: </p>
|
|
@@ -30,8 +30,8 @@ declare const UpdateTableCommand_base: {
|
|
|
30
30
|
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
|
|
31
31
|
* Streams settings for a given table.</p>
|
|
32
32
|
* <important>
|
|
33
|
-
* <p>For global tables, this operation only applies to global tables using Version
|
|
34
|
-
*
|
|
33
|
+
* <p>For global tables, this operation only applies to global tables using Version
|
|
34
|
+
* 2019.11.21 (Current version). </p>
|
|
35
35
|
* </important>
|
|
36
36
|
* <p>You can only perform one of the following operations at once:</p>
|
|
37
37
|
* <ul>
|
|
@@ -29,8 +29,8 @@ declare const UpdateTableReplicaAutoScalingCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates auto scaling settings on your global tables at once.</p>
|
|
31
31
|
* <important>
|
|
32
|
-
* <p>For global tables, this operation only applies to global tables using Version
|
|
33
|
-
*
|
|
32
|
+
* <p>For global tables, this operation only applies to global tables using Version
|
|
33
|
+
* 2019.11.21 (Current version). </p>
|
|
34
34
|
* </important>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -1464,7 +1464,8 @@ export interface ContributorInsightsSummary {
|
|
|
1464
1464
|
*/
|
|
1465
1465
|
export interface CreateBackupInput {
|
|
1466
1466
|
/**
|
|
1467
|
-
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
1467
|
+
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
1468
|
+
* parameter.</p>
|
|
1468
1469
|
* @public
|
|
1469
1470
|
*/
|
|
1470
1471
|
TableName: string | undefined;
|
|
@@ -2125,7 +2126,8 @@ export interface CreateTableInput {
|
|
|
2125
2126
|
*/
|
|
2126
2127
|
AttributeDefinitions: AttributeDefinition[] | undefined;
|
|
2127
2128
|
/**
|
|
2128
|
-
* <p>The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
2129
|
+
* <p>The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
2130
|
+
* this parameter.</p>
|
|
2129
2131
|
* @public
|
|
2130
2132
|
*/
|
|
2131
2133
|
TableName: string | undefined;
|
|
@@ -2391,22 +2393,33 @@ export interface CreateTableInput {
|
|
|
2391
2393
|
*/
|
|
2392
2394
|
TableClass?: TableClass;
|
|
2393
2395
|
/**
|
|
2394
|
-
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on
|
|
2396
|
+
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on
|
|
2397
|
+
* the table.</p>
|
|
2395
2398
|
* @public
|
|
2396
2399
|
*/
|
|
2397
2400
|
DeletionProtectionEnabled?: boolean;
|
|
2398
2401
|
/**
|
|
2399
|
-
* <p>An Amazon Web Services resource-based policy document in JSON format that will be
|
|
2400
|
-
*
|
|
2401
|
-
* <p>
|
|
2402
|
+
* <p>An Amazon Web Services resource-based policy document in JSON format that will be
|
|
2403
|
+
* attached to the table.</p>
|
|
2404
|
+
* <p>When you attach a resource-based policy while creating a table, the policy application
|
|
2405
|
+
* is <i>strongly consistent</i>.</p>
|
|
2406
|
+
* <p>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
|
|
2407
|
+
* limit. For a full list of all considerations that apply for resource-based policies, see
|
|
2408
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html">Resource-based
|
|
2409
|
+
* policy considerations</a>.</p>
|
|
2402
2410
|
* <note>
|
|
2403
|
-
* <p>You need to specify the <code>CreateTable</code> and
|
|
2411
|
+
* <p>You need to specify the <code>CreateTable</code> and
|
|
2412
|
+
* <code>PutResourcePolicy</code>
|
|
2413
|
+
* IAM actions for authorizing a user to create a table with a
|
|
2414
|
+
* resource-based policy.</p>
|
|
2404
2415
|
* </note>
|
|
2405
2416
|
* @public
|
|
2406
2417
|
*/
|
|
2407
2418
|
ResourcePolicy?: string;
|
|
2408
2419
|
/**
|
|
2409
|
-
* <p>Sets the maximum number of read and write units for the specified table in on-demand
|
|
2420
|
+
* <p>Sets the maximum number of read and write units for the specified table in on-demand
|
|
2421
|
+
* capacity mode. If you use this parameter, you must specify
|
|
2422
|
+
* <code>MaxReadRequestUnits</code>, <code>MaxWriteRequestUnits</code>, or both.</p>
|
|
2410
2423
|
* @public
|
|
2411
2424
|
*/
|
|
2412
2425
|
OnDemandThroughput?: OnDemandThroughput;
|
|
@@ -3229,12 +3242,19 @@ export interface DeleteReplicationGroupMemberAction {
|
|
|
3229
3242
|
*/
|
|
3230
3243
|
export interface DeleteResourcePolicyInput {
|
|
3231
3244
|
/**
|
|
3232
|
-
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be
|
|
3245
|
+
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be
|
|
3246
|
+
* removed. The resources you can specify include tables and streams. If you remove the
|
|
3247
|
+
* policy of a table, it will also remove the permissions for the table's indexes defined
|
|
3248
|
+
* in that policy document. This is because index permissions are defined in the table's
|
|
3249
|
+
* policy.</p>
|
|
3233
3250
|
* @public
|
|
3234
3251
|
*/
|
|
3235
3252
|
ResourceArn: string | undefined;
|
|
3236
3253
|
/**
|
|
3237
|
-
* <p>A string value that you can use to conditionally delete your policy. When you provide
|
|
3254
|
+
* <p>A string value that you can use to conditionally delete your policy. When you provide
|
|
3255
|
+
* an expected revision ID, if the revision ID of the existing policy on the resource
|
|
3256
|
+
* doesn't match or if there's no policy attached to the resource, the request will fail
|
|
3257
|
+
* and return a <code>PolicyNotFoundException</code>.</p>
|
|
3238
3258
|
* @public
|
|
3239
3259
|
*/
|
|
3240
3260
|
ExpectedRevisionId?: string;
|
|
@@ -3245,7 +3265,8 @@ export interface DeleteResourcePolicyInput {
|
|
|
3245
3265
|
export interface DeleteResourcePolicyOutput {
|
|
3246
3266
|
/**
|
|
3247
3267
|
* <p>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.</p>
|
|
3248
|
-
* <p>This value will be empty if you make a request against a resource without a
|
|
3268
|
+
* <p>This value will be empty if you make a request against a resource without a
|
|
3269
|
+
* policy.</p>
|
|
3249
3270
|
* @public
|
|
3250
3271
|
*/
|
|
3251
3272
|
RevisionId?: string;
|
|
@@ -3269,7 +3290,8 @@ export declare class PolicyNotFoundException extends __BaseException {
|
|
|
3269
3290
|
*/
|
|
3270
3291
|
export interface DeleteTableInput {
|
|
3271
3292
|
/**
|
|
3272
|
-
* <p>The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
3293
|
+
* <p>The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
3294
|
+
* this parameter.</p>
|
|
3273
3295
|
* @public
|
|
3274
3296
|
*/
|
|
3275
3297
|
TableName: string | undefined;
|
|
@@ -3333,7 +3355,8 @@ export interface DescribeContinuousBackupsOutput {
|
|
|
3333
3355
|
*/
|
|
3334
3356
|
export interface DescribeContributorInsightsInput {
|
|
3335
3357
|
/**
|
|
3336
|
-
* <p>The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
3358
|
+
* <p>The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
3359
|
+
* this parameter.</p>
|
|
3337
3360
|
* @public
|
|
3338
3361
|
*/
|
|
3339
3362
|
TableName: string | undefined;
|
|
@@ -4164,7 +4187,8 @@ export declare class ImportNotFoundException extends __BaseException {
|
|
|
4164
4187
|
*/
|
|
4165
4188
|
export interface DescribeKinesisStreamingDestinationInput {
|
|
4166
4189
|
/**
|
|
4167
|
-
* <p>The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table
|
|
4190
|
+
* <p>The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table
|
|
4191
|
+
* in this parameter.</p>
|
|
4168
4192
|
* @public
|
|
4169
4193
|
*/
|
|
4170
4194
|
TableName: string | undefined;
|
|
@@ -4271,7 +4295,8 @@ export interface DescribeLimitsOutput {
|
|
|
4271
4295
|
*/
|
|
4272
4296
|
export interface DescribeTableInput {
|
|
4273
4297
|
/**
|
|
4274
|
-
* <p>The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
4298
|
+
* <p>The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in
|
|
4299
|
+
* this parameter.</p>
|
|
4275
4300
|
* @public
|
|
4276
4301
|
*/
|
|
4277
4302
|
TableName: string | undefined;
|
|
@@ -4292,7 +4317,8 @@ export interface DescribeTableOutput {
|
|
|
4292
4317
|
*/
|
|
4293
4318
|
export interface DescribeTableReplicaAutoScalingInput {
|
|
4294
4319
|
/**
|
|
4295
|
-
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
4320
|
+
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
4321
|
+
* parameter.</p>
|
|
4296
4322
|
* @public
|
|
4297
4323
|
*/
|
|
4298
4324
|
TableName: string | undefined;
|
|
@@ -4451,7 +4477,8 @@ export interface DescribeTableReplicaAutoScalingOutput {
|
|
|
4451
4477
|
*/
|
|
4452
4478
|
export interface DescribeTimeToLiveInput {
|
|
4453
4479
|
/**
|
|
4454
|
-
* <p>The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table
|
|
4480
|
+
* <p>The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table
|
|
4481
|
+
* in this parameter.</p>
|
|
4455
4482
|
* @public
|
|
4456
4483
|
*/
|
|
4457
4484
|
TableName: string | undefined;
|
|
@@ -4482,7 +4509,8 @@ export interface EnableKinesisStreamingConfiguration {
|
|
|
4482
4509
|
*/
|
|
4483
4510
|
export interface KinesisStreamingDestinationInput {
|
|
4484
4511
|
/**
|
|
4485
|
-
* <p>The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the
|
|
4512
|
+
* <p>The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the
|
|
4513
|
+
* table in this parameter.</p>
|
|
4486
4514
|
* @public
|
|
4487
4515
|
*/
|
|
4488
4516
|
TableName: string | undefined;
|
|
@@ -4675,7 +4703,8 @@ export interface ExportTableToPointInTimeInput {
|
|
|
4675
4703
|
* <p>The ID of the Amazon Web Services account that owns the bucket the export will be
|
|
4676
4704
|
* stored in.</p>
|
|
4677
4705
|
* <note>
|
|
4678
|
-
* <p>S3BucketOwner is a required parameter when exporting to a S3 bucket in another
|
|
4706
|
+
* <p>S3BucketOwner is a required parameter when exporting to a S3 bucket in another
|
|
4707
|
+
* account.</p>
|
|
4679
4708
|
* </note>
|
|
4680
4709
|
* @public
|
|
4681
4710
|
*/
|
|
@@ -4717,7 +4746,10 @@ export interface ExportTableToPointInTimeInput {
|
|
|
4717
4746
|
*/
|
|
4718
4747
|
ExportFormat?: ExportFormat;
|
|
4719
4748
|
/**
|
|
4720
|
-
* <p>Choice of whether to execute as a full export or incremental export. Valid values are
|
|
4749
|
+
* <p>Choice of whether to execute as a full export or incremental export. Valid values are
|
|
4750
|
+
* FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If
|
|
4751
|
+
* INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be
|
|
4752
|
+
* used.</p>
|
|
4721
4753
|
* @public
|
|
4722
4754
|
*/
|
|
4723
4755
|
ExportType?: ExportType;
|
|
@@ -4767,7 +4799,8 @@ export declare class PointInTimeRecoveryUnavailableException extends __BaseExcep
|
|
|
4767
4799
|
*/
|
|
4768
4800
|
export interface GetResourcePolicyInput {
|
|
4769
4801
|
/**
|
|
4770
|
-
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The
|
|
4802
|
+
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The
|
|
4803
|
+
* resources you can specify include tables and streams.</p>
|
|
4771
4804
|
* @public
|
|
4772
4805
|
*/
|
|
4773
4806
|
ResourceArn: string | undefined;
|
|
@@ -4777,7 +4810,8 @@ export interface GetResourcePolicyInput {
|
|
|
4777
4810
|
*/
|
|
4778
4811
|
export interface GetResourcePolicyOutput {
|
|
4779
4812
|
/**
|
|
4780
|
-
* <p>The resource-based policy document attached to the resource, which can be a table or
|
|
4813
|
+
* <p>The resource-based policy document attached to the resource, which can be a table or
|
|
4814
|
+
* stream, in JSON format.</p>
|
|
4781
4815
|
* @public
|
|
4782
4816
|
*/
|
|
4783
4817
|
Policy?: string;
|
|
@@ -4865,7 +4899,8 @@ export interface ImportTableOutput {
|
|
|
4865
4899
|
*/
|
|
4866
4900
|
export interface ListBackupsInput {
|
|
4867
4901
|
/**
|
|
4868
|
-
* <p>Lists the backups from the table specified in <code>TableName</code>. You can also
|
|
4902
|
+
* <p>Lists the backups from the table specified in <code>TableName</code>. You can also
|
|
4903
|
+
* provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
4869
4904
|
* @public
|
|
4870
4905
|
*/
|
|
4871
4906
|
TableName?: string;
|
|
@@ -4946,7 +4981,8 @@ export interface ListBackupsOutput {
|
|
|
4946
4981
|
*/
|
|
4947
4982
|
export interface ListContributorInsightsInput {
|
|
4948
4983
|
/**
|
|
4949
|
-
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
4984
|
+
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
4985
|
+
* parameter.</p>
|
|
4950
4986
|
* @public
|
|
4951
4987
|
*/
|
|
4952
4988
|
TableName?: string;
|
|
@@ -5267,7 +5303,8 @@ export interface ListTagsOfResourceOutput {
|
|
|
5267
5303
|
*/
|
|
5268
5304
|
export interface PutResourcePolicyInput {
|
|
5269
5305
|
/**
|
|
5270
|
-
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.
|
|
5306
|
+
* <p>The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.
|
|
5307
|
+
* The resources you can specify include tables and streams.</p>
|
|
5271
5308
|
* <p>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 <code>Resource</code> field of a given <code>Statement</code> in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple <code>Statement</code> fields in your policy document.</p>
|
|
5272
5309
|
* @public
|
|
5273
5310
|
*/
|
|
@@ -5276,27 +5313,40 @@ export interface PutResourcePolicyInput {
|
|
|
5276
5313
|
* <p>An Amazon Web Services resource-based policy document in JSON format.</p>
|
|
5277
5314
|
* <ul>
|
|
5278
5315
|
* <li>
|
|
5279
|
-
* <p>The maximum size supported for a resource-based policy document is 20 KB.
|
|
5316
|
+
* <p>The maximum size supported for a resource-based policy document is 20 KB.
|
|
5317
|
+
* DynamoDB counts whitespaces when calculating the size of a policy
|
|
5318
|
+
* against this limit.</p>
|
|
5280
5319
|
* </li>
|
|
5281
5320
|
* <li>
|
|
5282
|
-
* <p>Within a resource-based policy, if the action for a DynamoDB
|
|
5321
|
+
* <p>Within a resource-based policy, if the action for a DynamoDB
|
|
5322
|
+
* service-linked role (SLR) to replicate data for a global table is denied, adding
|
|
5323
|
+
* or deleting a replica will fail with an error.</p>
|
|
5283
5324
|
* </li>
|
|
5284
5325
|
* </ul>
|
|
5285
|
-
* <p>For a full list of all considerations that apply while attaching a resource-based
|
|
5326
|
+
* <p>For a full list of all considerations that apply while attaching a resource-based
|
|
5327
|
+
* policy, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html">Resource-based
|
|
5328
|
+
* policy considerations</a>.</p>
|
|
5286
5329
|
* @public
|
|
5287
5330
|
*/
|
|
5288
5331
|
Policy: string | undefined;
|
|
5289
5332
|
/**
|
|
5290
|
-
* <p>A string value that you can use to conditionally update your policy. You can provide
|
|
5333
|
+
* <p>A string value that you can use to conditionally update your policy. You can provide
|
|
5334
|
+
* the revision ID of your existing policy to make mutating requests against that
|
|
5335
|
+
* policy.</p>
|
|
5291
5336
|
* <note>
|
|
5292
|
-
* <p>When you provide an expected revision ID, if the revision ID of the existing
|
|
5337
|
+
* <p>When you provide an expected revision ID, if the revision ID of the existing
|
|
5338
|
+
* policy on the resource doesn't match or if there's no policy attached to the
|
|
5339
|
+
* resource, your request will be rejected with a
|
|
5340
|
+
* <code>PolicyNotFoundException</code>.</p>
|
|
5293
5341
|
* </note>
|
|
5294
|
-
* <p>To conditionally attach a policy when no policy exists for the resource, specify
|
|
5342
|
+
* <p>To conditionally attach a policy when no policy exists for the resource, specify
|
|
5343
|
+
* <code>NO_POLICY</code> for the revision ID.</p>
|
|
5295
5344
|
* @public
|
|
5296
5345
|
*/
|
|
5297
5346
|
ExpectedRevisionId?: string;
|
|
5298
5347
|
/**
|
|
5299
|
-
* <p>Set this parameter to <code>true</code> to confirm that you want to remove your
|
|
5348
|
+
* <p>Set this parameter to <code>true</code> to confirm that you want to remove your
|
|
5349
|
+
* permissions to change the policy of this resource in the future.</p>
|
|
5300
5350
|
* @public
|
|
5301
5351
|
*/
|
|
5302
5352
|
ConfirmRemoveSelfResourceAccess?: boolean;
|
|
@@ -5535,7 +5585,8 @@ export interface PointInTimeRecoverySpecification {
|
|
|
5535
5585
|
*/
|
|
5536
5586
|
export interface UpdateContinuousBackupsInput {
|
|
5537
5587
|
/**
|
|
5538
|
-
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
5588
|
+
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
5589
|
+
* parameter.</p>
|
|
5539
5590
|
* @public
|
|
5540
5591
|
*/
|
|
5541
5592
|
TableName: string | undefined;
|
|
@@ -5561,7 +5612,8 @@ export interface UpdateContinuousBackupsOutput {
|
|
|
5561
5612
|
*/
|
|
5562
5613
|
export interface UpdateContributorInsightsInput {
|
|
5563
5614
|
/**
|
|
5564
|
-
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
5615
|
+
* <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this
|
|
5616
|
+
* parameter.</p>
|
|
5565
5617
|
* @public
|
|
5566
5618
|
*/
|
|
5567
5619
|
TableName: string | undefined;
|
|
@@ -5856,7 +5908,8 @@ export interface UpdateKinesisStreamingConfiguration {
|
|
|
5856
5908
|
*/
|
|
5857
5909
|
export interface UpdateKinesisStreamingDestinationInput {
|
|
5858
5910
|
/**
|
|
5859
|
-
* <p>The table name for the Kinesis streaming destination input. You can also provide the
|
|
5911
|
+
* <p>The table name for the Kinesis streaming destination input. You can also provide the
|
|
5912
|
+
* ARN of the table in this parameter.</p>
|
|
5860
5913
|
* @public
|
|
5861
5914
|
*/
|
|
5862
5915
|
TableName: string | undefined;
|
|
@@ -6081,7 +6134,8 @@ export interface UpdateTableInput {
|
|
|
6081
6134
|
*/
|
|
6082
6135
|
AttributeDefinitions?: AttributeDefinition[];
|
|
6083
6136
|
/**
|
|
6084
|
-
* <p>The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table
|
|
6137
|
+
* <p>The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table
|
|
6138
|
+
* in this parameter.</p>
|
|
6085
6139
|
* @public
|
|
6086
6140
|
*/
|
|
6087
6141
|
TableName: string | undefined;
|
|
@@ -6156,8 +6210,8 @@ export interface UpdateTableInput {
|
|
|
6156
6210
|
/**
|
|
6157
6211
|
* <p>A list of replica update actions (create, delete, or update) for the table.</p>
|
|
6158
6212
|
* <note>
|
|
6159
|
-
* <p>For global tables, this property only applies to global tables using Version
|
|
6160
|
-
*
|
|
6213
|
+
* <p>For global tables, this property only applies to global tables using Version
|
|
6214
|
+
* 2019.11.21 (Current version). </p>
|
|
6161
6215
|
* </note>
|
|
6162
6216
|
* @public
|
|
6163
6217
|
*/
|
|
@@ -6169,12 +6223,15 @@ export interface UpdateTableInput {
|
|
|
6169
6223
|
*/
|
|
6170
6224
|
TableClass?: TableClass;
|
|
6171
6225
|
/**
|
|
6172
|
-
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on
|
|
6226
|
+
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on
|
|
6227
|
+
* the table.</p>
|
|
6173
6228
|
* @public
|
|
6174
6229
|
*/
|
|
6175
6230
|
DeletionProtectionEnabled?: boolean;
|
|
6176
6231
|
/**
|
|
6177
|
-
* <p>Updates the maximum number of read and write units for the specified table in
|
|
6232
|
+
* <p>Updates the maximum number of read and write units for the specified table in
|
|
6233
|
+
* on-demand capacity mode. If you use this parameter, you must specify
|
|
6234
|
+
* <code>MaxReadRequestUnits</code>, <code>MaxWriteRequestUnits</code>, or both.</p>
|
|
6178
6235
|
* @public
|
|
6179
6236
|
*/
|
|
6180
6237
|
OnDemandThroughput?: OnDemandThroughput;
|
|
@@ -6260,7 +6317,8 @@ export interface UpdateTableReplicaAutoScalingInput {
|
|
|
6260
6317
|
*/
|
|
6261
6318
|
GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexAutoScalingUpdate[];
|
|
6262
6319
|
/**
|
|
6263
|
-
* <p>The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the
|
|
6320
|
+
* <p>The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the
|
|
6321
|
+
* table in this parameter.</p>
|
|
6264
6322
|
* @public
|
|
6265
6323
|
*/
|
|
6266
6324
|
TableName: string | undefined;
|
|
@@ -6311,7 +6369,8 @@ export interface TimeToLiveSpecification {
|
|
|
6311
6369
|
*/
|
|
6312
6370
|
export interface UpdateTimeToLiveInput {
|
|
6313
6371
|
/**
|
|
6314
|
-
* <p>The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the
|
|
6372
|
+
* <p>The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the
|
|
6373
|
+
* table in this parameter.</p>
|
|
6315
6374
|
* @public
|
|
6316
6375
|
*/
|
|
6317
6376
|
TableName: string | undefined;
|
|
@@ -7105,7 +7164,7 @@ export interface ExecuteStatementInput {
|
|
|
7105
7164
|
Limit?: number;
|
|
7106
7165
|
/**
|
|
7107
7166
|
* <p>An optional parameter that returns the item attributes for an
|
|
7108
|
-
*
|
|
7167
|
+
* <code>ExecuteStatement</code> operation that failed a condition check.</p>
|
|
7109
7168
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
7110
7169
|
* small network and processing overhead of receiving a larger response. No read capacity
|
|
7111
7170
|
* units are consumed.</p>
|
|
@@ -7151,7 +7210,8 @@ export interface Get {
|
|
|
7151
7210
|
*/
|
|
7152
7211
|
export interface GetItemInput {
|
|
7153
7212
|
/**
|
|
7154
|
-
* <p>The name of the table containing the requested item. You can also provide the
|
|
7213
|
+
* <p>The name of the table containing the requested item. You can also provide the
|
|
7214
|
+
* Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
7155
7215
|
* @public
|
|
7156
7216
|
*/
|
|
7157
7217
|
TableName: string | undefined;
|
|
@@ -7291,8 +7351,8 @@ export interface GetItemOutput {
|
|
|
7291
7351
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
7292
7352
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
7293
7353
|
* returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For more
|
|
7294
|
-
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the <i>Amazon
|
|
7295
|
-
* Guide</i>.</p>
|
|
7354
|
+
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the <i>Amazon
|
|
7355
|
+
* DynamoDB Developer Guide</i>.</p>
|
|
7296
7356
|
* @public
|
|
7297
7357
|
*/
|
|
7298
7358
|
ConsumedCapacity?: ConsumedCapacity;
|
|
@@ -7848,9 +7908,9 @@ export declare class TransactionCanceledException extends __BaseException {
|
|
|
7848
7908
|
*/
|
|
7849
7909
|
export interface BatchGetItemInput {
|
|
7850
7910
|
/**
|
|
7851
|
-
* <p>A map of one or more table names or table ARNs and, for each table, a map that
|
|
7852
|
-
* items to retrieve from that table. Each table name or ARN can be
|
|
7853
|
-
*
|
|
7911
|
+
* <p>A map of one or more table names or table ARNs and, for each table, a map that
|
|
7912
|
+
* describes one or more items to retrieve from that table. Each table name or ARN can be
|
|
7913
|
+
* used only once per <code>BatchGetItem</code> request.</p>
|
|
7854
7914
|
* <p>Each element in the map of items to retrieve consists of the following:</p>
|
|
7855
7915
|
* <ul>
|
|
7856
7916
|
* <li>
|
|
@@ -8605,8 +8665,8 @@ export interface PutItemOutput {
|
|
|
8605
8665
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
8606
8666
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
8607
8667
|
* returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For more
|
|
8608
|
-
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption">Capacity unity consumption for write operations</a> in the <i>Amazon
|
|
8609
|
-
* Guide</i>.</p>
|
|
8668
|
+
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption">Capacity unity consumption for write operations</a> in the <i>Amazon
|
|
8669
|
+
* DynamoDB Developer Guide</i>.</p>
|
|
8610
8670
|
* @public
|
|
8611
8671
|
*/
|
|
8612
8672
|
ConsumedCapacity?: ConsumedCapacity;
|
|
@@ -8663,7 +8723,7 @@ export interface QueryOutput {
|
|
|
8663
8723
|
/**
|
|
8664
8724
|
* <p>The number of items evaluated, before any <code>QueryFilter</code> is applied. A high
|
|
8665
8725
|
* <code>ScannedCount</code> value with few, or no, <code>Count</code> results
|
|
8666
|
-
* indicates an inefficient <code>Query</code> operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/
|
|
8726
|
+
* indicates an inefficient <code>Query</code> operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Count">Count and
|
|
8667
8727
|
* ScannedCount</a> in the <i>Amazon DynamoDB Developer
|
|
8668
8728
|
* Guide</i>.</p>
|
|
8669
8729
|
* <p>If you did not use a filter in the request, then <code>ScannedCount</code> is the same
|
|
@@ -8688,8 +8748,8 @@ export interface QueryOutput {
|
|
|
8688
8748
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
8689
8749
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
8690
8750
|
* returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For more
|
|
8691
|
-
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the <i>Amazon
|
|
8692
|
-
* Guide</i>.</p>
|
|
8751
|
+
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the <i>Amazon
|
|
8752
|
+
* DynamoDB Developer Guide</i>.</p>
|
|
8693
8753
|
* @public
|
|
8694
8754
|
*/
|
|
8695
8755
|
ConsumedCapacity?: ConsumedCapacity;
|
|
@@ -8743,8 +8803,8 @@ export interface ScanOutput {
|
|
|
8743
8803
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
8744
8804
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
8745
8805
|
* returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For more
|
|
8746
|
-
* information, see
|
|
8747
|
-
*
|
|
8806
|
+
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the <i>Amazon
|
|
8807
|
+
* DynamoDB Developer Guide</i>.</p>
|
|
8748
8808
|
* @public
|
|
8749
8809
|
*/
|
|
8750
8810
|
ConsumedCapacity?: ConsumedCapacity;
|
|
@@ -8757,9 +8817,9 @@ export interface UpdateItemOutput {
|
|
|
8757
8817
|
/**
|
|
8758
8818
|
* <p>A map of attribute values as they appear before or after the <code>UpdateItem</code>
|
|
8759
8819
|
* operation, as determined by the <code>ReturnValues</code> parameter.</p>
|
|
8760
|
-
* <p>The <code>Attributes</code> map is only present if the update was successful and
|
|
8761
|
-
*
|
|
8762
|
-
* represents one attribute.</p>
|
|
8820
|
+
* <p>The <code>Attributes</code> map is only present if the update was successful and
|
|
8821
|
+
* <code>ReturnValues</code> was specified as something other than <code>NONE</code> in
|
|
8822
|
+
* the request. Each element represents one attribute.</p>
|
|
8763
8823
|
* @public
|
|
8764
8824
|
*/
|
|
8765
8825
|
Attributes?: Record<string, AttributeValue>;
|
|
@@ -8768,8 +8828,8 @@ export interface UpdateItemOutput {
|
|
|
8768
8828
|
* returned includes the total provisioned throughput consumed, along with statistics for
|
|
8769
8829
|
* the table and any indexes involved in the operation. <code>ConsumedCapacity</code> is
|
|
8770
8830
|
* only returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For
|
|
8771
|
-
* more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption">Capacity unity consumption for write operations</a> in the <i>Amazon
|
|
8772
|
-
* Guide</i>.</p>
|
|
8831
|
+
* more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption">Capacity unity consumption for write operations</a> in the <i>Amazon
|
|
8832
|
+
* DynamoDB Developer Guide</i>.</p>
|
|
8773
8833
|
* @public
|
|
8774
8834
|
*/
|
|
8775
8835
|
ConsumedCapacity?: ConsumedCapacity;
|
|
@@ -8844,9 +8904,9 @@ export interface BatchExecuteStatementOutput {
|
|
|
8844
8904
|
*/
|
|
8845
8905
|
export interface BatchGetItemOutput {
|
|
8846
8906
|
/**
|
|
8847
|
-
* <p>A map of table name or table ARN to a list of items. Each object in
|
|
8848
|
-
*
|
|
8849
|
-
* attribute value.</p>
|
|
8907
|
+
* <p>A map of table name or table ARN to a list of items. Each object in
|
|
8908
|
+
* <code>Responses</code> consists of a table name or ARN, along with a map of
|
|
8909
|
+
* attribute data consisting of the data type and attribute value.</p>
|
|
8850
8910
|
* @public
|
|
8851
8911
|
*/
|
|
8852
8912
|
Responses?: Record<string, Record<string, AttributeValue>[]>;
|
|
@@ -8907,7 +8967,7 @@ export interface BatchGetItemOutput {
|
|
|
8907
8967
|
export interface ScanInput {
|
|
8908
8968
|
/**
|
|
8909
8969
|
* <p>The name of the table containing the requested items or if you provide
|
|
8910
|
-
*
|
|
8970
|
+
* <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
|
8911
8971
|
* <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
8912
8972
|
* @public
|
|
8913
8973
|
*/
|
|
@@ -8963,8 +9023,9 @@ export interface ScanInput {
|
|
|
8963
9023
|
* <li>
|
|
8964
9024
|
* <p>
|
|
8965
9025
|
* <code>COUNT</code> - Returns the number of matching items, rather than the
|
|
8966
|
-
* matching items themselves. Note that this uses the same quantity of read
|
|
8967
|
-
* as getting the items, and is subject to the same item size
|
|
9026
|
+
* matching items themselves. Note that this uses the same quantity of read
|
|
9027
|
+
* capacity units as getting the items, and is subject to the same item size
|
|
9028
|
+
* calculations.</p>
|
|
8968
9029
|
* </li>
|
|
8969
9030
|
* <li>
|
|
8970
9031
|
* <p>
|
|
@@ -9103,8 +9164,9 @@ export interface ScanInput {
|
|
|
9103
9164
|
* <p>A <code>FilterExpression</code> is applied after the items have already been read;
|
|
9104
9165
|
* the process of filtering does not consume any additional read capacity units.</p>
|
|
9105
9166
|
* </note>
|
|
9106
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter
|
|
9107
|
-
*
|
|
9167
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter
|
|
9168
|
+
* Expressions</a> in the <i>Amazon DynamoDB Developer
|
|
9169
|
+
* Guide</i>.</p>
|
|
9108
9170
|
* @public
|
|
9109
9171
|
*/
|
|
9110
9172
|
FilterExpression?: string;
|
|
@@ -9215,9 +9277,9 @@ export interface ScanInput {
|
|
|
9215
9277
|
*/
|
|
9216
9278
|
export interface BatchWriteItemInput {
|
|
9217
9279
|
/**
|
|
9218
|
-
* <p>A map of one or more table names or table ARNs and, for each table, a list of
|
|
9219
|
-
* performed (<code>DeleteRequest</code> or <code>PutRequest</code>). Each
|
|
9220
|
-
* map consists of the following:</p>
|
|
9280
|
+
* <p>A map of one or more table names or table ARNs and, for each table, a list of
|
|
9281
|
+
* operations to be performed (<code>DeleteRequest</code> or <code>PutRequest</code>). Each
|
|
9282
|
+
* element in the map consists of the following:</p>
|
|
9221
9283
|
* <ul>
|
|
9222
9284
|
* <li>
|
|
9223
9285
|
* <p>
|
|
@@ -9305,7 +9367,8 @@ export interface BatchWriteItemInput {
|
|
|
9305
9367
|
*/
|
|
9306
9368
|
export interface DeleteItemInput {
|
|
9307
9369
|
/**
|
|
9308
|
-
* <p>The name of the table from which to delete the item. You can also provide the
|
|
9370
|
+
* <p>The name of the table from which to delete the item. You can also provide the
|
|
9371
|
+
* Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
9309
9372
|
* @public
|
|
9310
9373
|
*/
|
|
9311
9374
|
TableName: string | undefined;
|
|
@@ -9517,7 +9580,8 @@ export interface DeleteItemInput {
|
|
|
9517
9580
|
*/
|
|
9518
9581
|
export interface PutItemInput {
|
|
9519
9582
|
/**
|
|
9520
|
-
* <p>The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
|
|
9583
|
+
* <p>The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
|
|
9584
|
+
* table in this parameter.</p>
|
|
9521
9585
|
* @public
|
|
9522
9586
|
*/
|
|
9523
9587
|
TableName: string | undefined;
|
|
@@ -9743,7 +9807,8 @@ export interface PutItemInput {
|
|
|
9743
9807
|
*/
|
|
9744
9808
|
export interface QueryInput {
|
|
9745
9809
|
/**
|
|
9746
|
-
* <p>The name of the table containing the requested items. You can also provide the
|
|
9810
|
+
* <p>The name of the table containing the requested items. You can also provide the
|
|
9811
|
+
* Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
9747
9812
|
* @public
|
|
9748
9813
|
*/
|
|
9749
9814
|
TableName: string | undefined;
|
|
@@ -9779,8 +9844,9 @@ export interface QueryInput {
|
|
|
9779
9844
|
* <li>
|
|
9780
9845
|
* <p>
|
|
9781
9846
|
* <code>COUNT</code> - Returns the number of matching items, rather than the
|
|
9782
|
-
* matching items themselves. Note that this uses the same quantity of read
|
|
9783
|
-
* as getting the items, and is subject to the same item size
|
|
9847
|
+
* matching items themselves. Note that this uses the same quantity of read
|
|
9848
|
+
* capacity units as getting the items, and is subject to the same item size
|
|
9849
|
+
* calculations.</p>
|
|
9784
9850
|
* </li>
|
|
9785
9851
|
* <li>
|
|
9786
9852
|
* <p>
|
|
@@ -9937,8 +10003,9 @@ export interface QueryInput {
|
|
|
9937
10003
|
* <p>A <code>FilterExpression</code> is applied after the items have already been read;
|
|
9938
10004
|
* the process of filtering does not consume any additional read capacity units.</p>
|
|
9939
10005
|
* </note>
|
|
9940
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html">Filter
|
|
9941
|
-
*
|
|
10006
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html">Filter
|
|
10007
|
+
* Expressions</a> in the <i>Amazon DynamoDB Developer
|
|
10008
|
+
* Guide</i>.</p>
|
|
9942
10009
|
* @public
|
|
9943
10010
|
*/
|
|
9944
10011
|
FilterExpression?: string;
|
|
@@ -10149,9 +10216,9 @@ export interface BatchWriteItemOutput {
|
|
|
10149
10216
|
* <code>RequestItems</code>, so you can provide this value directly to a subsequent
|
|
10150
10217
|
* <code>BatchWriteItem</code> operation. For more information, see
|
|
10151
10218
|
* <code>RequestItems</code> in the Request Parameters section.</p>
|
|
10152
|
-
* <p>Each <code>UnprocessedItems</code> entry consists of a table name or table ARN
|
|
10153
|
-
* a list of operations to perform (<code>DeleteRequest</code> or
|
|
10154
|
-
*
|
|
10219
|
+
* <p>Each <code>UnprocessedItems</code> entry consists of a table name or table ARN
|
|
10220
|
+
* and, for that table, a list of operations to perform (<code>DeleteRequest</code> or
|
|
10221
|
+
* <code>PutRequest</code>).</p>
|
|
10155
10222
|
* <ul>
|
|
10156
10223
|
* <li>
|
|
10157
10224
|
* <p>
|
|
@@ -10244,7 +10311,8 @@ export interface BatchWriteItemOutput {
|
|
|
10244
10311
|
*/
|
|
10245
10312
|
export interface UpdateItemInput {
|
|
10246
10313
|
/**
|
|
10247
|
-
* <p>The name of the table containing the item to update. You can also provide the
|
|
10314
|
+
* <p>The name of the table containing the item to update. You can also provide the
|
|
10315
|
+
* Amazon Resource Name (ARN) of the table in this parameter.</p>
|
|
10248
10316
|
* @public
|
|
10249
10317
|
*/
|
|
10250
10318
|
TableName: string | undefined;
|
|
@@ -10281,8 +10349,8 @@ export interface UpdateItemInput {
|
|
|
10281
10349
|
ConditionalOperator?: ConditionalOperator;
|
|
10282
10350
|
/**
|
|
10283
10351
|
* <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear
|
|
10284
|
-
* before or after they are successfully updated. For <code>UpdateItem</code>, the valid
|
|
10285
|
-
* are:</p>
|
|
10352
|
+
* before or after they are successfully updated. For <code>UpdateItem</code>, the valid
|
|
10353
|
+
* values are:</p>
|
|
10286
10354
|
* <ul>
|
|
10287
10355
|
* <li>
|
|
10288
10356
|
* <p>
|
|
@@ -10567,8 +10635,8 @@ export interface UpdateItemInput {
|
|
|
10567
10635
|
*/
|
|
10568
10636
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
10569
10637
|
/**
|
|
10570
|
-
* <p>An optional parameter that returns the item attributes for an <code>UpdateItem</code>
|
|
10571
|
-
* condition check.</p>
|
|
10638
|
+
* <p>An optional parameter that returns the item attributes for an <code>UpdateItem</code>
|
|
10639
|
+
* operation that failed a condition check.</p>
|
|
10572
10640
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
10573
10641
|
* small network and processing overhead of receiving a larger response. No read capacity
|
|
10574
10642
|
* units are consumed.</p>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-dynamodb",
|
|
3
3
|
"description": "AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.619.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-dynamodb",
|