@aws-sdk/client-dynamodb 3.614.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.
Files changed (31) hide show
  1. package/dist-cjs/index.js +5 -5
  2. package/dist-es/DynamoDBClient.js +5 -5
  3. package/dist-types/DynamoDBClient.d.ts +2 -2
  4. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +2 -1
  5. package/dist-types/commands/BatchGetItemCommand.d.ts +4 -4
  6. package/dist-types/commands/BatchWriteItemCommand.d.ts +11 -8
  7. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -5
  8. package/dist-types/commands/DeleteTableCommand.d.ts +4 -3
  9. package/dist-types/commands/DescribeEndpointsCommand.d.ts +2 -2
  10. package/dist-types/commands/DescribeTableCommand.d.ts +2 -2
  11. package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +2 -1
  12. package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +2 -2
  13. package/dist-types/commands/ExecuteStatementCommand.d.ts +2 -2
  14. package/dist-types/commands/GetResourcePolicyCommand.d.ts +25 -7
  15. package/dist-types/commands/ListBackupsCommand.d.ts +8 -6
  16. package/dist-types/commands/PutItemCommand.d.ts +1 -2
  17. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -3
  18. package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +2 -2
  19. package/dist-types/commands/ScanCommand.d.ts +28 -27
  20. package/dist-types/commands/UpdateGlobalTableCommand.d.ts +5 -8
  21. package/dist-types/commands/UpdateTableCommand.d.ts +2 -2
  22. package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +2 -2
  23. package/dist-types/models/models_0.d.ts +155 -87
  24. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  25. package/dist-types/runtimeConfig.d.ts +1 -1
  26. package/dist-types/runtimeConfig.native.d.ts +1 -1
  27. package/dist-types/ts3.4/DynamoDBClient.d.ts +2 -2
  28. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  29. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  30. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  31. package/package.json +18 -18
package/dist-cjs/index.js CHANGED
@@ -4131,9 +4131,9 @@ var _DynamoDBClient = class _DynamoDBClient extends import_smithy_client.Client
4131
4131
  const _config_1 = resolveClientEndpointParameters(_config_0);
4132
4132
  const _config_2 = (0, import_config_resolver.resolveRegionConfig)(_config_1);
4133
4133
  const _config_3 = (0, import_middleware_endpoint.resolveEndpointConfig)(_config_2);
4134
- const _config_4 = (0, import_middleware_retry.resolveRetryConfig)(_config_3);
4135
- const _config_5 = (0, import_middleware_host_header.resolveHostHeaderConfig)(_config_4);
4136
- const _config_6 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_5);
4134
+ const _config_4 = (0, import_middleware_host_header.resolveHostHeaderConfig)(_config_3);
4135
+ const _config_5 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_4);
4136
+ const _config_6 = (0, import_middleware_retry.resolveRetryConfig)(_config_5);
4137
4137
  const _config_7 = (0, import_httpAuthSchemeProvider.resolveHttpAuthSchemeConfig)(_config_6);
4138
4138
  const _config_8 = (0, import_middleware_endpoint_discovery.resolveEndpointDiscoveryConfig)(_config_7, {
4139
4139
  endpointDiscoveryCommandCtor: DescribeEndpointsCommand
@@ -4141,12 +4141,12 @@ var _DynamoDBClient = class _DynamoDBClient extends import_smithy_client.Client
4141
4141
  const _config_9 = resolveRuntimeExtensions(_config_8, (configuration == null ? void 0 : configuration.extensions) || []);
4142
4142
  super(_config_9);
4143
4143
  this.config = _config_9;
4144
- this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
4145
- this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
4146
4144
  this.middlewareStack.use((0, import_middleware_host_header.getHostHeaderPlugin)(this.config));
4147
4145
  this.middlewareStack.use((0, import_middleware_logger.getLoggerPlugin)(this.config));
4148
4146
  this.middlewareStack.use((0, import_middleware_recursion_detection.getRecursionDetectionPlugin)(this.config));
4149
4147
  this.middlewareStack.use((0, import_middleware_user_agent.getUserAgentPlugin)(this.config));
4148
+ this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
4149
+ this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
4150
4150
  this.middlewareStack.use(
4151
4151
  (0, import_core2.getHttpAuthSchemeEndpointRuleSetPlugin)(this.config, {
4152
4152
  httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
@@ -21,9 +21,9 @@ export class DynamoDBClient extends __Client {
21
21
  const _config_1 = resolveClientEndpointParameters(_config_0);
22
22
  const _config_2 = resolveRegionConfig(_config_1);
23
23
  const _config_3 = resolveEndpointConfig(_config_2);
24
- const _config_4 = resolveRetryConfig(_config_3);
25
- const _config_5 = resolveHostHeaderConfig(_config_4);
26
- const _config_6 = resolveUserAgentConfig(_config_5);
24
+ const _config_4 = resolveHostHeaderConfig(_config_3);
25
+ const _config_5 = resolveUserAgentConfig(_config_4);
26
+ const _config_6 = resolveRetryConfig(_config_5);
27
27
  const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
28
28
  const _config_8 = resolveEndpointDiscoveryConfig(_config_7, {
29
29
  endpointDiscoveryCommandCtor: DescribeEndpointsCommand,
@@ -31,12 +31,12 @@ export class DynamoDBClient extends __Client {
31
31
  const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
32
32
  super(_config_9);
33
33
  this.config = _config_9;
34
- this.middlewareStack.use(getRetryPlugin(this.config));
35
- this.middlewareStack.use(getContentLengthPlugin(this.config));
36
34
  this.middlewareStack.use(getHostHeaderPlugin(this.config));
37
35
  this.middlewareStack.use(getLoggerPlugin(this.config));
38
36
  this.middlewareStack.use(getRecursionDetectionPlugin(this.config));
39
37
  this.middlewareStack.use(getUserAgentPlugin(this.config));
38
+ this.middlewareStack.use(getRetryPlugin(this.config));
39
+ this.middlewareStack.use(getContentLengthPlugin(this.config));
40
40
  this.middlewareStack.use(getHttpAuthSchemeEndpointRuleSetPlugin(this.config, {
41
41
  httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
42
42
  identityProviderConfigProvider: this.getIdentityProviderConfigProvider(),
@@ -195,7 +195,7 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
195
195
  /**
196
196
  * @public
197
197
  */
198
- export type DynamoDBClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & HttpAuthSchemeInputConfig & EndpointDiscoveryInputConfig & ClientInputEndpointParameters;
198
+ export type DynamoDBClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & HostHeaderInputConfig & UserAgentInputConfig & RetryInputConfig & HttpAuthSchemeInputConfig & EndpointDiscoveryInputConfig & ClientInputEndpointParameters;
199
199
  /**
200
200
  * @public
201
201
  *
@@ -206,7 +206,7 @@ export interface DynamoDBClientConfig extends DynamoDBClientConfigType {
206
206
  /**
207
207
  * @public
208
208
  */
209
- export type DynamoDBClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & HttpAuthSchemeResolvedConfig & EndpointDiscoveryResolvedConfig & ClientResolvedEndpointParameters;
209
+ export type DynamoDBClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HostHeaderResolvedConfig & UserAgentResolvedConfig & RetryResolvedConfig & HttpAuthSchemeResolvedConfig & EndpointDiscoveryResolvedConfig & ClientResolvedEndpointParameters;
210
210
  /**
211
211
  * @public
212
212
  *
@@ -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.</p>
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 requested,
35
- * or an internal processing failure occurs. If a partial result is returned, the operation returns a value for
36
- * <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
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 <code>BatchWriteItem</code>
39
- * operation on an existing item, that item's values will be overwritten by the
40
- * operation and it will appear like it was updated. To update items, we recommend you
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>If <i>none</i> of the items can be processed due to insufficient
53
- * provisioned throughput on all of the tables in the request, then
54
- * <code>BatchWriteItem</code> returns a
55
- * <code>ProvisionedThroughputExceededException</code>.</p>
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 stream.</p>
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 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>
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, 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.
35
- * </p>
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 <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>
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 global tables using Version 2019.11.21 (Current version).
40
- * </p>
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.</p>
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
- * 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>
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 2019.11.21 (Current version).
34
- * </p>
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 2019.11.21 (Current version).</p>
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 is done
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 and include
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 table or stream, in JSON format.</p>
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 describes the outcomes when you issue the <code>GetResourcePolicy</code> request immediately after issuing another request:</p>
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 <code>PutResourcePolicy</code> request, DynamoDB might return a <code>PolicyNotFoundException</code>.</p>
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 <code>DeleteResourcePolicy</code> request, DynamoDB might return the policy that was present before the deletion request.</p>
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 <code>CreateTable</code> request, which includes a resource-based policy, DynamoDB might return a <code>ResourceNotFoundException</code> or a <code>PolicyNotFoundException</code>.</p>
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 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>
47
- * <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>
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 weren't made with Amazon Web Services Backup.
31
- * To list these backups for a given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
32
- * paginated list of results with at most 1 MB worth of items in a page. You can also
33
- * specify a maximum number of entries to be returned in a page.</p>
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 Backup, use the
38
- * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html">Amazon Web Services Backup list API.</a>
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 stream. When you attach a resource-based policy using this API, the policy application is <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
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 on the same resource using the same policy document will return the same revision ID. If you specify an <code>ExpectedRevisionId</code> that doesn't match the current policy's <code>RevisionId</code>, the <code>PolicyNotFoundException</code> will be returned.</p>
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 <code>GetResourcePolicy</code> request immediately after a <code>PutResourcePolicy</code> request, DynamoDB might return your previous policy, if there was one, or return the <code>PolicyNotFoundException</code>. This is because <code>GetResourcePolicy</code> uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the <code>GetResourcePolicy</code> request again.</p>
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
- * point in time recovery: </p>
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
- * the 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 continue
36
- * the scan in a subsequent operation. Each scan response also includes number of items that were
37
- * scanned (ScannedCount) as part of the request. If using a <code>FilterExpression</code>, a scan result
38
- * can result in no items meeting the criteria and the <code>Count</code> will result in zero. If
39
- * you did not use a <code>FilterExpression</code> in the scan request, then <code>Count</code> is
40
- * the same as <code>ScannedCount</code>.</p>
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 specific to a
44
- * single scan request and, unless the table is less than 1MB, do not represent the total number
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 (if
49
- * using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then applies any
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 complete the
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 items in a table.
61
- * Therefore, the results from an eventually consistent <code>Scan</code> may not include the latest item
62
- * changes at the time the scan iterates through each item in the table. If you require a strongly consistent
63
- * read of each item as the scan iterates through the items in the table, you can set the <code>ConsistentRead</code>
64
- * parameter to true. Strong consistency only relates to the consistency of the read at the item level.</p>
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
- * DynamoDB does not provide snapshot isolation for a scan operation when the <code>ConsistentRead</code>
68
- * parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan
69
- * see a consistent snapshot of the table when the scan operation was requested.
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
- * For global tables, this operation only applies to global tables using Version 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.
42
- * </p>
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 2019.11.21 (Current version).
34
- * </p>
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 2019.11.21 (Current version).
33
- * </p>
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.