@depup/aws-sdk__client-dynamodb 3.1005.0-depup.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/LICENSE +201 -0
- package/README.md +31 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
- package/dist-cjs/endpoint/endpointResolver.js +27 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +1667 -0
- package/dist-cjs/models/DynamoDBServiceException.js +12 -0
- package/dist-cjs/models/errors.js +478 -0
- package/dist-cjs/runtimeConfig.browser.js +41 -0
- package/dist-cjs/runtimeConfig.js +57 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +46 -0
- package/dist-cjs/schemas/schemas_0.js +2390 -0
- package/dist-es/DynamoDB.js +149 -0
- package/dist-es/DynamoDBClient.js +55 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commands/BatchExecuteStatementCommand.js +16 -0
- package/dist-es/commands/BatchGetItemCommand.js +19 -0
- package/dist-es/commands/BatchWriteItemCommand.js +19 -0
- package/dist-es/commands/CreateBackupCommand.js +19 -0
- package/dist-es/commands/CreateGlobalTableCommand.js +19 -0
- package/dist-es/commands/CreateTableCommand.js +19 -0
- package/dist-es/commands/DeleteBackupCommand.js +19 -0
- package/dist-es/commands/DeleteItemCommand.js +19 -0
- package/dist-es/commands/DeleteResourcePolicyCommand.js +19 -0
- package/dist-es/commands/DeleteTableCommand.js +19 -0
- package/dist-es/commands/DescribeBackupCommand.js +19 -0
- package/dist-es/commands/DescribeContinuousBackupsCommand.js +19 -0
- package/dist-es/commands/DescribeContributorInsightsCommand.js +19 -0
- package/dist-es/commands/DescribeEndpointsCommand.js +16 -0
- package/dist-es/commands/DescribeExportCommand.js +19 -0
- package/dist-es/commands/DescribeGlobalTableCommand.js +19 -0
- package/dist-es/commands/DescribeGlobalTableSettingsCommand.js +19 -0
- package/dist-es/commands/DescribeImportCommand.js +19 -0
- package/dist-es/commands/DescribeKinesisStreamingDestinationCommand.js +19 -0
- package/dist-es/commands/DescribeLimitsCommand.js +16 -0
- package/dist-es/commands/DescribeTableCommand.js +19 -0
- package/dist-es/commands/DescribeTableReplicaAutoScalingCommand.js +19 -0
- package/dist-es/commands/DescribeTimeToLiveCommand.js +19 -0
- package/dist-es/commands/DisableKinesisStreamingDestinationCommand.js +19 -0
- package/dist-es/commands/EnableKinesisStreamingDestinationCommand.js +19 -0
- package/dist-es/commands/ExecuteStatementCommand.js +16 -0
- package/dist-es/commands/ExecuteTransactionCommand.js +16 -0
- package/dist-es/commands/ExportTableToPointInTimeCommand.js +19 -0
- package/dist-es/commands/GetItemCommand.js +19 -0
- package/dist-es/commands/GetResourcePolicyCommand.js +19 -0
- package/dist-es/commands/ImportTableCommand.js +19 -0
- package/dist-es/commands/ListBackupsCommand.js +19 -0
- package/dist-es/commands/ListContributorInsightsCommand.js +19 -0
- package/dist-es/commands/ListExportsCommand.js +19 -0
- package/dist-es/commands/ListGlobalTablesCommand.js +16 -0
- package/dist-es/commands/ListImportsCommand.js +19 -0
- package/dist-es/commands/ListTablesCommand.js +16 -0
- package/dist-es/commands/ListTagsOfResourceCommand.js +19 -0
- package/dist-es/commands/PutItemCommand.js +19 -0
- package/dist-es/commands/PutResourcePolicyCommand.js +19 -0
- package/dist-es/commands/QueryCommand.js +19 -0
- package/dist-es/commands/RestoreTableFromBackupCommand.js +19 -0
- package/dist-es/commands/RestoreTableToPointInTimeCommand.js +19 -0
- package/dist-es/commands/ScanCommand.js +19 -0
- package/dist-es/commands/TagResourceCommand.js +19 -0
- package/dist-es/commands/TransactGetItemsCommand.js +19 -0
- package/dist-es/commands/TransactWriteItemsCommand.js +19 -0
- package/dist-es/commands/UntagResourceCommand.js +19 -0
- package/dist-es/commands/UpdateContinuousBackupsCommand.js +19 -0
- package/dist-es/commands/UpdateContributorInsightsCommand.js +19 -0
- package/dist-es/commands/UpdateGlobalTableCommand.js +19 -0
- package/dist-es/commands/UpdateGlobalTableSettingsCommand.js +19 -0
- package/dist-es/commands/UpdateItemCommand.js +19 -0
- package/dist-es/commands/UpdateKinesisStreamingDestinationCommand.js +19 -0
- package/dist-es/commands/UpdateTableCommand.js +19 -0
- package/dist-es/commands/UpdateTableReplicaAutoScalingCommand.js +19 -0
- package/dist-es/commands/UpdateTimeToLiveCommand.js +19 -0
- package/dist-es/commands/index.js +57 -0
- package/dist-es/endpoint/EndpointParameters.js +15 -0
- package/dist-es/endpoint/endpointResolver.js +23 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +10 -0
- package/dist-es/models/DynamoDBServiceException.js +8 -0
- package/dist-es/models/enums.js +245 -0
- package/dist-es/models/errors.js +440 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListContributorInsightsPaginator.js +4 -0
- package/dist-es/pagination/ListExportsPaginator.js +4 -0
- package/dist-es/pagination/ListImportsPaginator.js +4 -0
- package/dist-es/pagination/ListTablesPaginator.js +4 -0
- package/dist-es/pagination/QueryPaginator.js +4 -0
- package/dist-es/pagination/ScanPaginator.js +4 -0
- package/dist-es/pagination/index.js +7 -0
- package/dist-es/runtimeConfig.browser.js +36 -0
- package/dist-es/runtimeConfig.js +52 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +42 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +2381 -0
- package/dist-es/waiters/index.js +6 -0
- package/dist-es/waiters/waitForContributorInsightsEnabled.js +40 -0
- package/dist-es/waiters/waitForExportCompleted.js +40 -0
- package/dist-es/waiters/waitForImportCompleted.js +49 -0
- package/dist-es/waiters/waitForKinesisStreamingDestinationActive.js +49 -0
- package/dist-es/waiters/waitForTableExists.js +34 -0
- package/dist-es/waiters/waitForTableNotExists.js +25 -0
- package/dist-types/DynamoDB.d.ts +512 -0
- package/dist-types/DynamoDBClient.d.ts +272 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +234 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +366 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +414 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +151 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +211 -0
- package/dist-types/commands/CreateTableCommand.d.ts +394 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +197 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +296 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +145 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +338 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +175 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +104 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +94 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +78 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +124 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +133 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +178 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +165 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +91 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +165 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +269 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +164 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +86 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +128 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +130 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +251 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +534 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +152 -0
- package/dist-types/commands/GetItemCommand.d.ts +264 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +124 -0
- package/dist-types/commands/ImportTableCommand.d.ts +275 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +109 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +92 -0
- package/dist-types/commands/ListExportsCommand.d.ts +104 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +95 -0
- package/dist-types/commands/ListImportsCommand.d.ts +110 -0
- package/dist-types/commands/ListTablesCommand.d.ts +103 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +93 -0
- package/dist-types/commands/PutItemCommand.d.ts +315 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +147 -0
- package/dist-types/commands/QueryCommand.d.ts +338 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +373 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +407 -0
- package/dist-types/commands/ScanCommand.d.ts +337 -0
- package/dist-types/commands/TagResourceCommand.d.ts +145 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +496 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +659 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +140 -0
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +111 -0
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +93 -0
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +179 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +286 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +323 -0
- package/dist-types/commands/UpdateKinesisStreamingDestinationCommand.d.ts +127 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +458 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +246 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +149 -0
- package/dist-types/commands/index.d.ts +57 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +64 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +34 -0
- package/dist-types/models/DynamoDBServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +589 -0
- package/dist-types/models/errors.d.ts +803 -0
- package/dist-types/models/models_0.d.ts +10010 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListContributorInsightsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListExportsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListImportsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTablesPaginator.d.ts +7 -0
- package/dist-types/pagination/QueryPaginator.d.ts +7 -0
- package/dist-types/pagination/ScanPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +7 -0
- package/dist-types/runtimeConfig.browser.d.ts +60 -0
- package/dist-types/runtimeConfig.d.ts +60 -0
- package/dist-types/runtimeConfig.native.d.ts +59 -0
- package/dist-types/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +325 -0
- package/dist-types/ts3.4/DynamoDB.d.ts +1102 -0
- package/dist-types/ts3.4/DynamoDBClient.d.ts +472 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchExecuteStatementCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchGetItemCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchWriteItemCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateBackupCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateGlobalTableCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateTableCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBackupCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteItemCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteTableCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeBackupCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeContinuousBackupsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeContributorInsightsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeEndpointsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeExportCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeGlobalTableCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeGlobalTableSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeImportCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeKinesisStreamingDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeLimitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeTableCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeTableReplicaAutoScalingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeTimeToLiveCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisableKinesisStreamingDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/EnableKinesisStreamingDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ExecuteStatementCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ExecuteTransactionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ExportTableToPointInTimeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetItemCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ImportTableCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListBackupsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListContributorInsightsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListExportsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListGlobalTablesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListImportsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTablesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTagsOfResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutItemCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/QueryCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/RestoreTableFromBackupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RestoreTableToPointInTimeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ScanCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/TransactGetItemsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/TransactWriteItemsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UpdateContinuousBackupsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateContributorInsightsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateGlobalTableCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateGlobalTableSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateItemCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateKinesisStreamingDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateTableCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateTableReplicaAutoScalingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateTimeToLiveCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +57 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +65 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +13 -0
- package/dist-types/ts3.4/models/DynamoDBServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +313 -0
- package/dist-types/ts3.4/models/errors.d.ts +286 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1557 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListContributorInsightsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListExportsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListImportsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTablesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/QueryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ScanPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/index.d.ts +7 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +114 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +111 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +118 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +325 -0
- package/dist-types/ts3.4/waiters/index.d.ts +6 -0
- package/dist-types/ts3.4/waiters/waitForContributorInsightsEnabled.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForExportCompleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForImportCompleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForKinesisStreamingDestinationActive.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForTableExists.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForTableNotExists.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +6 -0
- package/dist-types/waiters/waitForContributorInsightsEnabled.d.ts +14 -0
- package/dist-types/waiters/waitForExportCompleted.d.ts +14 -0
- package/dist-types/waiters/waitForImportCompleted.d.ts +14 -0
- package/dist-types/waiters/waitForKinesisStreamingDestinationActive.d.ts +14 -0
- package/dist-types/waiters/waitForTableExists.d.ts +14 -0
- package/dist-types/waiters/waitForTableNotExists.d.ts +14 -0
- package/package.json +130 -0
|
@@ -0,0 +1,414 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
|
|
4
|
+
import type { BatchWriteItemInput, BatchWriteItemOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link BatchWriteItemCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchWriteItemCommandInput extends BatchWriteItemInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchWriteItemCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchWriteItemCommand_base: {
|
|
25
|
+
new (input: BatchWriteItemCommandInput): import("@smithy/smithy-client").CommandImpl<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: BatchWriteItemCommandInput): import("@smithy/smithy-client").CommandImpl<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or
|
|
31
|
+
* more tables. A single call to <code>BatchWriteItem</code> can transmit up to 16MB of
|
|
32
|
+
* data over the network, consisting of up to 25 item put or delete operations. While
|
|
33
|
+
* individual items can be up to 400 KB once stored, it's important to note that an item's
|
|
34
|
+
* representation might be greater than 400KB while being sent in DynamoDB's JSON format
|
|
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
|
+
* <note>
|
|
37
|
+
* <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
|
+
* </note>
|
|
43
|
+
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
|
|
44
|
+
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
|
|
45
|
+
* whole is not. If any requested operations fail because the table's provisioned
|
|
46
|
+
* throughput is exceeded or an internal processing failure occurs, the failed operations
|
|
47
|
+
* are returned in the <code>UnprocessedItems</code> response parameter. You can
|
|
48
|
+
* investigate and optionally resend the requests. Typically, you would call
|
|
49
|
+
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
|
|
50
|
+
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
|
|
51
|
+
* until all items have been processed.</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>
|
|
59
|
+
* <important>
|
|
60
|
+
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
61
|
+
* those items. However, <i>we strongly recommend that you use an exponential
|
|
62
|
+
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
63
|
+
* underlying read or write requests can still fail due to throttling on the individual
|
|
64
|
+
* tables. If you delay the batch operation using exponential backoff, the individual
|
|
65
|
+
* requests in the batch are much more likely to succeed.</p>
|
|
66
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB
|
|
67
|
+
* Developer Guide</i>.</p>
|
|
68
|
+
* </important>
|
|
69
|
+
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
70
|
+
* data, such as from Amazon EMR, or copy data from another database into DynamoDB. In
|
|
71
|
+
* order to improve performance with these large-scale operations,
|
|
72
|
+
* <code>BatchWriteItem</code> does not behave in the same way as individual
|
|
73
|
+
* <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
|
|
74
|
+
* cannot specify conditions on individual put and delete requests, and
|
|
75
|
+
* <code>BatchWriteItem</code> does not return deleted items in the response.</p>
|
|
76
|
+
* <p>If you use a programming language that supports concurrency, you can use threads to
|
|
77
|
+
* write items in parallel. Your application must include the necessary logic to manage the
|
|
78
|
+
* threads. With languages that don't support threading, you must update or delete the
|
|
79
|
+
* specified items one at a time. In both situations, <code>BatchWriteItem</code> performs
|
|
80
|
+
* the specified put and delete operations in parallel, giving you the power of the thread
|
|
81
|
+
* pool approach without having to introduce complexity into your application.</p>
|
|
82
|
+
* <p>Parallel processing reduces latency, but each specified put and delete request
|
|
83
|
+
* consumes the same number of write capacity units whether it is processed in parallel or
|
|
84
|
+
* not. Delete operations on nonexistent items consume one write capacity unit.</p>
|
|
85
|
+
* <p>If one or more of the following is true, DynamoDB rejects the entire batch write
|
|
86
|
+
* operation:</p>
|
|
87
|
+
* <ul>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>One or more tables specified in the <code>BatchWriteItem</code> request does
|
|
90
|
+
* not exist.</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>Primary key attributes specified on an item in the request do not match those
|
|
94
|
+
* in the corresponding table's primary key schema.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>You try to perform multiple operations on the same item in the same
|
|
98
|
+
* <code>BatchWriteItem</code> request. For example, you cannot put and delete
|
|
99
|
+
* the same item in the same <code>BatchWriteItem</code> request. </p>
|
|
100
|
+
* </li>
|
|
101
|
+
* <li>
|
|
102
|
+
* <p> Your request contains at least two items with identical hash and range keys
|
|
103
|
+
* (which essentially is two put operations). </p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>There are more than 25 requests in the batch.</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>Any individual item in a batch exceeds 400 KB.</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>The total request size exceeds 16 MB.</p>
|
|
113
|
+
* </li>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p>Any individual items with keys exceeding the key length limits. For a
|
|
116
|
+
* partition key, the limit is 2048 bytes and for a sort key, the limit is 1024
|
|
117
|
+
* bytes.</p>
|
|
118
|
+
* </li>
|
|
119
|
+
* </ul>
|
|
120
|
+
* @example
|
|
121
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
122
|
+
* ```javascript
|
|
123
|
+
* import { DynamoDBClient, BatchWriteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
124
|
+
* // const { DynamoDBClient, BatchWriteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
125
|
+
* // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
|
|
126
|
+
* const config = {}; // type is DynamoDBClientConfig
|
|
127
|
+
* const client = new DynamoDBClient(config);
|
|
128
|
+
* const input = { // BatchWriteItemInput
|
|
129
|
+
* RequestItems: { // BatchWriteItemRequestMap // required
|
|
130
|
+
* "<keys>": [ // WriteRequests
|
|
131
|
+
* { // WriteRequest
|
|
132
|
+
* PutRequest: { // PutRequest
|
|
133
|
+
* Item: { // PutItemInputAttributeMap // required
|
|
134
|
+
* "<keys>": { // AttributeValue Union: only one key present
|
|
135
|
+
* S: "STRING_VALUE",
|
|
136
|
+
* N: "STRING_VALUE",
|
|
137
|
+
* B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
138
|
+
* SS: [ // StringSetAttributeValue
|
|
139
|
+
* "STRING_VALUE",
|
|
140
|
+
* ],
|
|
141
|
+
* NS: [ // NumberSetAttributeValue
|
|
142
|
+
* "STRING_VALUE",
|
|
143
|
+
* ],
|
|
144
|
+
* BS: [ // BinarySetAttributeValue
|
|
145
|
+
* new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
146
|
+
* ],
|
|
147
|
+
* M: { // MapAttributeValue
|
|
148
|
+
* "<keys>": {// Union: only one key present
|
|
149
|
+
* S: "STRING_VALUE",
|
|
150
|
+
* N: "STRING_VALUE",
|
|
151
|
+
* B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
152
|
+
* SS: [
|
|
153
|
+
* "STRING_VALUE",
|
|
154
|
+
* ],
|
|
155
|
+
* NS: [
|
|
156
|
+
* "STRING_VALUE",
|
|
157
|
+
* ],
|
|
158
|
+
* BS: [
|
|
159
|
+
* new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
160
|
+
* ],
|
|
161
|
+
* M: {
|
|
162
|
+
* "<keys>": "<AttributeValue>",
|
|
163
|
+
* },
|
|
164
|
+
* L: [ // ListAttributeValue
|
|
165
|
+
* "<AttributeValue>",
|
|
166
|
+
* ],
|
|
167
|
+
* NULL: true || false,
|
|
168
|
+
* BOOL: true || false,
|
|
169
|
+
* },
|
|
170
|
+
* },
|
|
171
|
+
* L: [
|
|
172
|
+
* "<AttributeValue>",
|
|
173
|
+
* ],
|
|
174
|
+
* NULL: true || false,
|
|
175
|
+
* BOOL: true || false,
|
|
176
|
+
* },
|
|
177
|
+
* },
|
|
178
|
+
* },
|
|
179
|
+
* DeleteRequest: { // DeleteRequest
|
|
180
|
+
* Key: { // Key // required
|
|
181
|
+
* "<keys>": "<AttributeValue>",
|
|
182
|
+
* },
|
|
183
|
+
* },
|
|
184
|
+
* },
|
|
185
|
+
* ],
|
|
186
|
+
* },
|
|
187
|
+
* ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
|
|
188
|
+
* ReturnItemCollectionMetrics: "SIZE" || "NONE",
|
|
189
|
+
* };
|
|
190
|
+
* const command = new BatchWriteItemCommand(input);
|
|
191
|
+
* const response = await client.send(command);
|
|
192
|
+
* // { // BatchWriteItemOutput
|
|
193
|
+
* // UnprocessedItems: { // BatchWriteItemRequestMap
|
|
194
|
+
* // "<keys>": [ // WriteRequests
|
|
195
|
+
* // { // WriteRequest
|
|
196
|
+
* // PutRequest: { // PutRequest
|
|
197
|
+
* // Item: { // PutItemInputAttributeMap // required
|
|
198
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
199
|
+
* // S: "STRING_VALUE",
|
|
200
|
+
* // N: "STRING_VALUE",
|
|
201
|
+
* // B: new Uint8Array(),
|
|
202
|
+
* // SS: [ // StringSetAttributeValue
|
|
203
|
+
* // "STRING_VALUE",
|
|
204
|
+
* // ],
|
|
205
|
+
* // NS: [ // NumberSetAttributeValue
|
|
206
|
+
* // "STRING_VALUE",
|
|
207
|
+
* // ],
|
|
208
|
+
* // BS: [ // BinarySetAttributeValue
|
|
209
|
+
* // new Uint8Array(),
|
|
210
|
+
* // ],
|
|
211
|
+
* // M: { // MapAttributeValue
|
|
212
|
+
* // "<keys>": {// Union: only one key present
|
|
213
|
+
* // S: "STRING_VALUE",
|
|
214
|
+
* // N: "STRING_VALUE",
|
|
215
|
+
* // B: new Uint8Array(),
|
|
216
|
+
* // SS: [
|
|
217
|
+
* // "STRING_VALUE",
|
|
218
|
+
* // ],
|
|
219
|
+
* // NS: [
|
|
220
|
+
* // "STRING_VALUE",
|
|
221
|
+
* // ],
|
|
222
|
+
* // BS: [
|
|
223
|
+
* // new Uint8Array(),
|
|
224
|
+
* // ],
|
|
225
|
+
* // M: {
|
|
226
|
+
* // "<keys>": "<AttributeValue>",
|
|
227
|
+
* // },
|
|
228
|
+
* // L: [ // ListAttributeValue
|
|
229
|
+
* // "<AttributeValue>",
|
|
230
|
+
* // ],
|
|
231
|
+
* // NULL: true || false,
|
|
232
|
+
* // BOOL: true || false,
|
|
233
|
+
* // },
|
|
234
|
+
* // },
|
|
235
|
+
* // L: [
|
|
236
|
+
* // "<AttributeValue>",
|
|
237
|
+
* // ],
|
|
238
|
+
* // NULL: true || false,
|
|
239
|
+
* // BOOL: true || false,
|
|
240
|
+
* // },
|
|
241
|
+
* // },
|
|
242
|
+
* // },
|
|
243
|
+
* // DeleteRequest: { // DeleteRequest
|
|
244
|
+
* // Key: { // Key // required
|
|
245
|
+
* // "<keys>": "<AttributeValue>",
|
|
246
|
+
* // },
|
|
247
|
+
* // },
|
|
248
|
+
* // },
|
|
249
|
+
* // ],
|
|
250
|
+
* // },
|
|
251
|
+
* // ItemCollectionMetrics: { // ItemCollectionMetricsPerTable
|
|
252
|
+
* // "<keys>": [ // ItemCollectionMetricsMultiple
|
|
253
|
+
* // { // ItemCollectionMetrics
|
|
254
|
+
* // ItemCollectionKey: { // ItemCollectionKeyAttributeMap
|
|
255
|
+
* // "<keys>": "<AttributeValue>",
|
|
256
|
+
* // },
|
|
257
|
+
* // SizeEstimateRangeGB: [ // ItemCollectionSizeEstimateRange
|
|
258
|
+
* // Number("double"),
|
|
259
|
+
* // ],
|
|
260
|
+
* // },
|
|
261
|
+
* // ],
|
|
262
|
+
* // },
|
|
263
|
+
* // ConsumedCapacity: [ // ConsumedCapacityMultiple
|
|
264
|
+
* // { // ConsumedCapacity
|
|
265
|
+
* // TableName: "STRING_VALUE",
|
|
266
|
+
* // CapacityUnits: Number("double"),
|
|
267
|
+
* // ReadCapacityUnits: Number("double"),
|
|
268
|
+
* // WriteCapacityUnits: Number("double"),
|
|
269
|
+
* // Table: { // Capacity
|
|
270
|
+
* // ReadCapacityUnits: Number("double"),
|
|
271
|
+
* // WriteCapacityUnits: Number("double"),
|
|
272
|
+
* // CapacityUnits: Number("double"),
|
|
273
|
+
* // },
|
|
274
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
275
|
+
* // "<keys>": {
|
|
276
|
+
* // ReadCapacityUnits: Number("double"),
|
|
277
|
+
* // WriteCapacityUnits: Number("double"),
|
|
278
|
+
* // CapacityUnits: Number("double"),
|
|
279
|
+
* // },
|
|
280
|
+
* // },
|
|
281
|
+
* // GlobalSecondaryIndexes: {
|
|
282
|
+
* // "<keys>": {
|
|
283
|
+
* // ReadCapacityUnits: Number("double"),
|
|
284
|
+
* // WriteCapacityUnits: Number("double"),
|
|
285
|
+
* // CapacityUnits: Number("double"),
|
|
286
|
+
* // },
|
|
287
|
+
* // },
|
|
288
|
+
* // },
|
|
289
|
+
* // ],
|
|
290
|
+
* // };
|
|
291
|
+
*
|
|
292
|
+
* ```
|
|
293
|
+
*
|
|
294
|
+
* @param BatchWriteItemCommandInput - {@link BatchWriteItemCommandInput}
|
|
295
|
+
* @returns {@link BatchWriteItemCommandOutput}
|
|
296
|
+
* @see {@link BatchWriteItemCommandInput} for command's `input` shape.
|
|
297
|
+
* @see {@link BatchWriteItemCommandOutput} for command's `response` shape.
|
|
298
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
299
|
+
*
|
|
300
|
+
* @throws {@link InternalServerError} (server fault)
|
|
301
|
+
* <p>An error occurred on the server side.</p>
|
|
302
|
+
*
|
|
303
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
304
|
+
*
|
|
305
|
+
* @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
|
|
306
|
+
* <p>An item collection is too large. This exception is only returned for tables that
|
|
307
|
+
* have one or more local secondary indexes.</p>
|
|
308
|
+
*
|
|
309
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
310
|
+
* <p>The request was denied due to request throttling. For detailed information about
|
|
311
|
+
* why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. The Amazon Web Services
|
|
312
|
+
* SDKs for DynamoDB automatically retry requests that receive this exception.
|
|
313
|
+
* Your request is eventually successful, unless your retry queue is too large to finish.
|
|
314
|
+
* Reduce the frequency of requests and use exponential backoff. For more information, go
|
|
315
|
+
* to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
316
|
+
*
|
|
317
|
+
* @throws {@link ReplicatedWriteConflictException} (client fault)
|
|
318
|
+
* <p>The request was rejected because one or more items in the request are being modified
|
|
319
|
+
* by a request in another Region. </p>
|
|
320
|
+
*
|
|
321
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
322
|
+
* <p>Throughput exceeds the current throughput quota for your account. For detailed
|
|
323
|
+
* information about why the request was throttled and the ARN of the impacted resource,
|
|
324
|
+
* find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. Contact <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a quota
|
|
325
|
+
* increase.</p>
|
|
326
|
+
*
|
|
327
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
328
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
329
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
330
|
+
*
|
|
331
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
332
|
+
* <p>The request was denied due to request throttling. For detailed information about why
|
|
333
|
+
* the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception.</p>
|
|
334
|
+
*
|
|
335
|
+
* @throws {@link DynamoDBServiceException}
|
|
336
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
337
|
+
*
|
|
338
|
+
*
|
|
339
|
+
* @example To add multiple items to a table
|
|
340
|
+
* ```javascript
|
|
341
|
+
* // This example adds three new items to the Music table using a batch of three PutItem requests.
|
|
342
|
+
* const input = {
|
|
343
|
+
* RequestItems: {
|
|
344
|
+
* Music: [
|
|
345
|
+
* {
|
|
346
|
+
* PutRequest: {
|
|
347
|
+
* Item: {
|
|
348
|
+
* AlbumTitle: {
|
|
349
|
+
* S: "Somewhat Famous"
|
|
350
|
+
* },
|
|
351
|
+
* Artist: {
|
|
352
|
+
* S: "No One You Know"
|
|
353
|
+
* },
|
|
354
|
+
* SongTitle: {
|
|
355
|
+
* S: "Call Me Today"
|
|
356
|
+
* }
|
|
357
|
+
* }
|
|
358
|
+
* }
|
|
359
|
+
* },
|
|
360
|
+
* {
|
|
361
|
+
* PutRequest: {
|
|
362
|
+
* Item: {
|
|
363
|
+
* AlbumTitle: {
|
|
364
|
+
* S: "Songs About Life"
|
|
365
|
+
* },
|
|
366
|
+
* Artist: {
|
|
367
|
+
* S: "Acme Band"
|
|
368
|
+
* },
|
|
369
|
+
* SongTitle: {
|
|
370
|
+
* S: "Happy Day"
|
|
371
|
+
* }
|
|
372
|
+
* }
|
|
373
|
+
* }
|
|
374
|
+
* },
|
|
375
|
+
* {
|
|
376
|
+
* PutRequest: {
|
|
377
|
+
* Item: {
|
|
378
|
+
* AlbumTitle: {
|
|
379
|
+
* S: "Blue Sky Blues"
|
|
380
|
+
* },
|
|
381
|
+
* Artist: {
|
|
382
|
+
* S: "No One You Know"
|
|
383
|
+
* },
|
|
384
|
+
* SongTitle: {
|
|
385
|
+
* S: "Scared of My Shadow"
|
|
386
|
+
* }
|
|
387
|
+
* }
|
|
388
|
+
* }
|
|
389
|
+
* }
|
|
390
|
+
* ]
|
|
391
|
+
* }
|
|
392
|
+
* };
|
|
393
|
+
* const command = new BatchWriteItemCommand(input);
|
|
394
|
+
* const response = await client.send(command);
|
|
395
|
+
* /* response is
|
|
396
|
+
* { /* empty *\/ }
|
|
397
|
+
* *\/
|
|
398
|
+
* ```
|
|
399
|
+
*
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
export declare class BatchWriteItemCommand extends BatchWriteItemCommand_base {
|
|
403
|
+
/** @internal type navigation helper, not in runtime. */
|
|
404
|
+
protected static __types: {
|
|
405
|
+
api: {
|
|
406
|
+
input: BatchWriteItemInput;
|
|
407
|
+
output: BatchWriteItemOutput;
|
|
408
|
+
};
|
|
409
|
+
sdk: {
|
|
410
|
+
input: BatchWriteItemCommandInput;
|
|
411
|
+
output: BatchWriteItemCommandOutput;
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
|
|
4
|
+
import type { CreateBackupInput, CreateBackupOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateBackupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateBackupCommandInput extends CreateBackupInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateBackupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateBackupCommandOutput extends CreateBackupOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateBackupCommand_base: {
|
|
25
|
+
new (input: CreateBackupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBackupCommandInput, CreateBackupCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateBackupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBackupCommandInput, CreateBackupCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a backup for an existing table.</p>
|
|
31
|
+
* <p> Each time you create an on-demand backup, the entire table data is backed up. There
|
|
32
|
+
* is no limit to the number of on-demand backups that can be taken. </p>
|
|
33
|
+
* <p> When you create an on-demand backup, a time marker of the request is cataloged, and
|
|
34
|
+
* the backup is created asynchronously, by applying all changes until the time of the
|
|
35
|
+
* request to the last full table snapshot. Backup requests are processed instantaneously
|
|
36
|
+
* and become available for restore within minutes. </p>
|
|
37
|
+
* <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per
|
|
38
|
+
* second.</p>
|
|
39
|
+
* <p>All backups in DynamoDB work without consuming any provisioned throughput on the
|
|
40
|
+
* table.</p>
|
|
41
|
+
* <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to
|
|
42
|
+
* contain all data committed to the table up to 14:24:00, and data committed after
|
|
43
|
+
* 14:26:00 will not be. The backup might contain data modifications made between 14:24:00
|
|
44
|
+
* and 14:26:00. On-demand backup does not support causal consistency. </p>
|
|
45
|
+
* <p> Along with data, the following are also included on the backups: </p>
|
|
46
|
+
* <ul>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>Streams</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>Provisioned read and write capacity</p>
|
|
58
|
+
* </li>
|
|
59
|
+
* </ul>
|
|
60
|
+
* @example
|
|
61
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
62
|
+
* ```javascript
|
|
63
|
+
* import { DynamoDBClient, CreateBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
|
|
64
|
+
* // const { DynamoDBClient, CreateBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
|
|
65
|
+
* // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
|
|
66
|
+
* const config = {}; // type is DynamoDBClientConfig
|
|
67
|
+
* const client = new DynamoDBClient(config);
|
|
68
|
+
* const input = { // CreateBackupInput
|
|
69
|
+
* TableName: "STRING_VALUE", // required
|
|
70
|
+
* BackupName: "STRING_VALUE", // required
|
|
71
|
+
* };
|
|
72
|
+
* const command = new CreateBackupCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* // { // CreateBackupOutput
|
|
75
|
+
* // BackupDetails: { // BackupDetails
|
|
76
|
+
* // BackupArn: "STRING_VALUE", // required
|
|
77
|
+
* // BackupName: "STRING_VALUE", // required
|
|
78
|
+
* // BackupSizeBytes: Number("long"),
|
|
79
|
+
* // BackupStatus: "CREATING" || "DELETED" || "AVAILABLE", // required
|
|
80
|
+
* // BackupType: "USER" || "SYSTEM" || "AWS_BACKUP", // required
|
|
81
|
+
* // BackupCreationDateTime: new Date("TIMESTAMP"), // required
|
|
82
|
+
* // BackupExpiryDateTime: new Date("TIMESTAMP"),
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param CreateBackupCommandInput - {@link CreateBackupCommandInput}
|
|
89
|
+
* @returns {@link CreateBackupCommandOutput}
|
|
90
|
+
* @see {@link CreateBackupCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link CreateBackupCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link BackupInUseException} (client fault)
|
|
95
|
+
* <p>There is another ongoing conflicting backup control plane operation on the table.
|
|
96
|
+
* The backup is either being created, deleted or restored to a table.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ContinuousBackupsUnavailableException} (client fault)
|
|
99
|
+
* <p>Backups have not yet been enabled for this table.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link InternalServerError} (server fault)
|
|
102
|
+
* <p>An error occurred on the server side.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
107
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
108
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account.
|
|
109
|
+
* These operations include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
110
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
111
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
112
|
+
* <p>When you are creating a table with one or more secondary indexes, you can have up
|
|
113
|
+
* to 250 such requests running at a time. However, if the table or index specifications
|
|
114
|
+
* are complex, then DynamoDB might temporarily reduce the number of concurrent
|
|
115
|
+
* operations.</p>
|
|
116
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are
|
|
117
|
+
* allowed per account.</p>
|
|
118
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
119
|
+
* <p>GetRecords was called with a value of more than 1000 for the limit request
|
|
120
|
+
* parameter.</p>
|
|
121
|
+
* <p>More than 2 processes are reading from the same streams shard at the same time.
|
|
122
|
+
* Exceeding this limit may result in request throttling.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link TableInUseException} (client fault)
|
|
125
|
+
* <p>A target table with the specified name is either being created or deleted.
|
|
126
|
+
* </p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
129
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
130
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services
|
|
131
|
+
* Region.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link DynamoDBServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class CreateBackupCommand extends CreateBackupCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: CreateBackupInput;
|
|
144
|
+
output: CreateBackupOutput;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: CreateBackupCommandInput;
|
|
148
|
+
output: CreateBackupCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|