@aws-sdk/client-dynamodb 3.288.0 → 3.290.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 +9 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +85 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +84 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +34 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +26 -0
- package/dist-types/commands/CreateTableCommand.d.ts +94 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +26 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +59 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +54 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +9 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +20 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +9 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +6 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +10 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +23 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +57 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +8 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +10 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +28 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +28 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +34 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +321 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +31 -0
- package/dist-types/commands/GetItemCommand.d.ts +55 -0
- package/dist-types/commands/ImportTableCommand.d.ts +26 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +6 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/ListExportsCommand.d.ts +17 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +6 -0
- package/dist-types/commands/ListImportsCommand.d.ts +14 -0
- package/dist-types/commands/ListTablesCommand.d.ts +25 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +10 -0
- package/dist-types/commands/PutItemCommand.d.ts +63 -0
- package/dist-types/commands/QueryCommand.d.ts +53 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +33 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +37 -0
- package/dist-types/commands/ScanCommand.d.ts +68 -0
- package/dist-types/commands/TagResourceCommand.d.ts +28 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +254 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +323 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +28 -0
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +13 -0
- package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +8 -0
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +19 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +33 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +83 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +80 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +26 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +28 -0
- package/package.json +31 -31
|
@@ -29,6 +29,12 @@ export interface DescribeImportCommandOutput extends DescribeImportOutput, __Met
|
|
|
29
29
|
* @see {@link DescribeImportCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ImportNotFoundException} (client fault)
|
|
33
|
+
* <p>
|
|
34
|
+
* The specified import was not found.
|
|
35
|
+
* </p>
|
|
36
|
+
*
|
|
37
|
+
*
|
|
32
38
|
*/
|
|
33
39
|
export declare class DescribeImportCommand extends $Command<DescribeImportCommandInput, DescribeImportCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
40
|
readonly input: DescribeImportCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface DescribeKinesisStreamingDestinationCommandOutput extends Descri
|
|
|
29
29
|
* @see {@link DescribeKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InternalServerError} (server fault)
|
|
33
|
+
* <p>An error occurred on the server side.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
38
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
39
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class DescribeKinesisStreamingDestinationCommand extends $Command<DescribeKinesisStreamingDestinationCommandInput, DescribeKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
44
|
readonly input: DescribeKinesisStreamingDestinationCommandInput;
|
|
@@ -98,6 +98,29 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
98
98
|
* @see {@link DescribeLimitsCommandOutput} for command's `response` shape.
|
|
99
99
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
100
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
|
+
*
|
|
107
|
+
* @example To determine capacity limits per table and account, in the current AWS region
|
|
108
|
+
* ```javascript
|
|
109
|
+
* // The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.
|
|
110
|
+
* const input = {};
|
|
111
|
+
* const command = new DescribeLimitsCommand(input);
|
|
112
|
+
* const response = await client.send(command);
|
|
113
|
+
* /* response ==
|
|
114
|
+
* {
|
|
115
|
+
* "AccountMaxReadCapacityUnits": 20000,
|
|
116
|
+
* "AccountMaxWriteCapacityUnits": 20000,
|
|
117
|
+
* "TableMaxReadCapacityUnits": 10000,
|
|
118
|
+
* "TableMaxWriteCapacityUnits": 10000
|
|
119
|
+
* }
|
|
120
|
+
* *\/
|
|
121
|
+
* // example id: to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
101
124
|
*/
|
|
102
125
|
export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
103
126
|
readonly input: DescribeLimitsCommandInput;
|
|
@@ -43,6 +43,63 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
|
|
|
43
43
|
* @see {@link DescribeTableCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @throws {@link InternalServerError} (server fault)
|
|
47
|
+
* <p>An error occurred on the server side.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
52
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
53
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
54
|
+
*
|
|
55
|
+
*
|
|
56
|
+
* @example To describe a table
|
|
57
|
+
* ```javascript
|
|
58
|
+
* // This example describes the Music table.
|
|
59
|
+
* const input = {
|
|
60
|
+
* "TableName": "Music"
|
|
61
|
+
* };
|
|
62
|
+
* const command = new DescribeTableCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* /* response ==
|
|
65
|
+
* {
|
|
66
|
+
* "Table": {
|
|
67
|
+
* "AttributeDefinitions": [
|
|
68
|
+
* {
|
|
69
|
+
* "AttributeName": "Artist",
|
|
70
|
+
* "AttributeType": "S"
|
|
71
|
+
* },
|
|
72
|
+
* {
|
|
73
|
+
* "AttributeName": "SongTitle",
|
|
74
|
+
* "AttributeType": "S"
|
|
75
|
+
* }
|
|
76
|
+
* ],
|
|
77
|
+
* "CreationDateTime": "1421866952.062",
|
|
78
|
+
* "ItemCount": 0,
|
|
79
|
+
* "KeySchema": [
|
|
80
|
+
* {
|
|
81
|
+
* "AttributeName": "Artist",
|
|
82
|
+
* "KeyType": "HASH"
|
|
83
|
+
* },
|
|
84
|
+
* {
|
|
85
|
+
* "AttributeName": "SongTitle",
|
|
86
|
+
* "KeyType": "RANGE"
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "ProvisionedThroughput": {
|
|
90
|
+
* "NumberOfDecreasesToday": 1,
|
|
91
|
+
* "ReadCapacityUnits": 5,
|
|
92
|
+
* "WriteCapacityUnits": 5
|
|
93
|
+
* },
|
|
94
|
+
* "TableName": "Music",
|
|
95
|
+
* "TableSizeBytes": 0,
|
|
96
|
+
* "TableStatus": "ACTIVE"
|
|
97
|
+
* }
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* // example id: to-describe-a-table-1475884440502
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
46
103
|
*/
|
|
47
104
|
export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
48
105
|
readonly input: DescribeTableCommandInput;
|
|
@@ -33,6 +33,14 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
|
|
|
33
33
|
* @see {@link DescribeTableReplicaAutoScalingCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link InternalServerError} (server fault)
|
|
37
|
+
* <p>An error occurred on the server side.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
40
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
41
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
36
44
|
*/
|
|
37
45
|
export declare class DescribeTableReplicaAutoScalingCommand extends $Command<DescribeTableReplicaAutoScalingCommandInput, DescribeTableReplicaAutoScalingCommandOutput, DynamoDBClientResolvedConfig> {
|
|
38
46
|
readonly input: DescribeTableReplicaAutoScalingCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface DescribeTimeToLiveCommandOutput extends DescribeTimeToLiveOutpu
|
|
|
29
29
|
* @see {@link DescribeTimeToLiveCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InternalServerError} (server fault)
|
|
33
|
+
* <p>An error occurred on the server side.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
38
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
39
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class DescribeTimeToLiveCommand extends $Command<DescribeTimeToLiveCommandInput, DescribeTimeToLiveCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
44
|
readonly input: DescribeTimeToLiveCommandInput;
|
|
@@ -30,6 +30,34 @@ export interface DisableKinesisStreamingDestinationCommandOutput extends Kinesis
|
|
|
30
30
|
* @see {@link DisableKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link InternalServerError} (server fault)
|
|
34
|
+
* <p>An error occurred on the server side.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
39
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
40
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
41
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
42
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
43
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
44
|
+
* <p>When you are creating a table with one or more secondary
|
|
45
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
46
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
47
|
+
* of concurrent operations.</p>
|
|
48
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
49
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
52
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
53
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
54
|
+
* <code>CREATING</code> state.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
58
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
33
61
|
*/
|
|
34
62
|
export declare class DisableKinesisStreamingDestinationCommand extends $Command<DisableKinesisStreamingDestinationCommandInput, DisableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
35
63
|
readonly input: DisableKinesisStreamingDestinationCommandInput;
|
|
@@ -32,6 +32,34 @@ export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisS
|
|
|
32
32
|
* @see {@link EnableKinesisStreamingDestinationCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>An error occurred on the server side.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
41
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
42
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
43
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
44
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
45
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
46
|
+
* <p>When you are creating a table with one or more secondary
|
|
47
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
48
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
49
|
+
* of concurrent operations.</p>
|
|
50
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
51
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
54
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
55
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
56
|
+
* <code>CREATING</code> state.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
60
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
61
|
+
*
|
|
62
|
+
*
|
|
35
63
|
*/
|
|
36
64
|
export declare class EnableKinesisStreamingDestinationCommand extends $Command<EnableKinesisStreamingDestinationCommandInput, EnableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig> {
|
|
37
65
|
readonly input: EnableKinesisStreamingDestinationCommandInput;
|
|
@@ -41,6 +41,40 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
|
|
|
41
41
|
* @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link ConditionalCheckFailedException} (client fault)
|
|
45
|
+
* <p>A condition specified in the operation could not be evaluated.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link DuplicateItemException} (client fault)
|
|
48
|
+
* <p> There was an attempt to insert an item with the same primary key as an item that
|
|
49
|
+
* already exists in the DynamoDB table.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link InternalServerError} (server fault)
|
|
52
|
+
* <p>An error occurred on the server side.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
|
|
55
|
+
* <p>An item collection is too large. This exception is only returned for tables that
|
|
56
|
+
* have one or more local secondary indexes.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
59
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
60
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
61
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
62
|
+
* requests and use exponential backoff. For more information, go 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>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
65
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
66
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
67
|
+
* quota increase.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
71
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link TransactionConflictException} (client fault)
|
|
74
|
+
* <p>Operation was rejected because there is an ongoing transaction for the
|
|
75
|
+
* item.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
44
78
|
*/
|
|
45
79
|
export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
80
|
readonly input: ExecuteStatementCommandInput;
|
|
@@ -36,6 +36,327 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
|
|
|
36
36
|
* @see {@link ExecuteTransactionCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link IdempotentParameterMismatchException} (client fault)
|
|
40
|
+
* <p>DynamoDB rejected the request because you retried a request with a
|
|
41
|
+
* different payload but with an idempotent token that was already used.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InternalServerError} (server fault)
|
|
44
|
+
* <p>An error occurred on the server side.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
47
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
48
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
49
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
50
|
+
* requests and use exponential backoff. For more information, go 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>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
53
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
54
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
55
|
+
* quota increase.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
58
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
59
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link TransactionCanceledException} (client fault)
|
|
62
|
+
* <p>The entire transaction request was canceled.</p>
|
|
63
|
+
* <p>DynamoDB cancels a <code>TransactWriteItems</code> request under the following
|
|
64
|
+
* circumstances:</p>
|
|
65
|
+
* <ul>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>A condition in one of the condition expressions is not met.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>A table in the <code>TransactWriteItems</code> request is in a different
|
|
71
|
+
* account or region.</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>More than one action in the <code>TransactWriteItems</code> operation
|
|
75
|
+
* targets the same item.</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
79
|
+
* completed.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>An item size becomes too large (larger than 400 KB), or a local secondary
|
|
83
|
+
* index (LSI) becomes too large, or a similar validation error occurs because of
|
|
84
|
+
* changes made by the transaction.</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* </ul>
|
|
90
|
+
* <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
|
|
91
|
+
* following circumstances:</p>
|
|
92
|
+
* <ul>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>There is an ongoing <code>TransactGetItems</code> operation that conflicts
|
|
95
|
+
* with a concurrent <code>PutItem</code>, <code>UpdateItem</code>,
|
|
96
|
+
* <code>DeleteItem</code> or <code>TransactWriteItems</code> request. In this
|
|
97
|
+
* case the <code>TransactGetItems</code> operation fails with a
|
|
98
|
+
* <code>TransactionCanceledException</code>.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>A table in the <code>TransactGetItems</code> request is in a different
|
|
102
|
+
* account or region.</p>
|
|
103
|
+
* </li>
|
|
104
|
+
* <li>
|
|
105
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
106
|
+
* completed.</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* </ul>
|
|
112
|
+
* <note>
|
|
113
|
+
* <p>If using Java, DynamoDB lists the cancellation reasons on the
|
|
114
|
+
* <code>CancellationReasons</code> property. This property is not set for other
|
|
115
|
+
* languages. Transaction cancellation reasons are ordered in the order of requested
|
|
116
|
+
* items, if an item has no error it will have <code>None</code> code and
|
|
117
|
+
* <code>Null</code> message.</p>
|
|
118
|
+
* </note>
|
|
119
|
+
* <p>Cancellation reason codes and possible error messages:</p>
|
|
120
|
+
* <ul>
|
|
121
|
+
* <li>
|
|
122
|
+
* <p>No Errors:</p>
|
|
123
|
+
* <ul>
|
|
124
|
+
* <li>
|
|
125
|
+
* <p>Code: <code>None</code>
|
|
126
|
+
* </p>
|
|
127
|
+
* </li>
|
|
128
|
+
* <li>
|
|
129
|
+
* <p>Message: <code>null</code>
|
|
130
|
+
* </p>
|
|
131
|
+
* </li>
|
|
132
|
+
* </ul>
|
|
133
|
+
* </li>
|
|
134
|
+
* <li>
|
|
135
|
+
* <p>Conditional Check Failed:</p>
|
|
136
|
+
* <ul>
|
|
137
|
+
* <li>
|
|
138
|
+
* <p>Code: <code>ConditionalCheckFailed</code>
|
|
139
|
+
* </p>
|
|
140
|
+
* </li>
|
|
141
|
+
* <li>
|
|
142
|
+
* <p>Message: The conditional request failed. </p>
|
|
143
|
+
* </li>
|
|
144
|
+
* </ul>
|
|
145
|
+
* </li>
|
|
146
|
+
* <li>
|
|
147
|
+
* <p>Item Collection Size Limit Exceeded:</p>
|
|
148
|
+
* <ul>
|
|
149
|
+
* <li>
|
|
150
|
+
* <p>Code: <code>ItemCollectionSizeLimitExceeded</code>
|
|
151
|
+
* </p>
|
|
152
|
+
* </li>
|
|
153
|
+
* <li>
|
|
154
|
+
* <p>Message: Collection size exceeded.</p>
|
|
155
|
+
* </li>
|
|
156
|
+
* </ul>
|
|
157
|
+
* </li>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>Transaction Conflict:</p>
|
|
160
|
+
* <ul>
|
|
161
|
+
* <li>
|
|
162
|
+
* <p>Code: <code>TransactionConflict</code>
|
|
163
|
+
* </p>
|
|
164
|
+
* </li>
|
|
165
|
+
* <li>
|
|
166
|
+
* <p>Message: Transaction is ongoing for the item.</p>
|
|
167
|
+
* </li>
|
|
168
|
+
* </ul>
|
|
169
|
+
* </li>
|
|
170
|
+
* <li>
|
|
171
|
+
* <p>Provisioned Throughput Exceeded:</p>
|
|
172
|
+
* <ul>
|
|
173
|
+
* <li>
|
|
174
|
+
* <p>Code: <code>ProvisionedThroughputExceeded</code>
|
|
175
|
+
* </p>
|
|
176
|
+
* </li>
|
|
177
|
+
* <li>
|
|
178
|
+
* <p>Messages:</p>
|
|
179
|
+
* <ul>
|
|
180
|
+
* <li>
|
|
181
|
+
* <p>The level of configured provisioned throughput for the
|
|
182
|
+
* table was exceeded. Consider increasing your provisioning level
|
|
183
|
+
* with the UpdateTable API.</p>
|
|
184
|
+
* <note>
|
|
185
|
+
* <p>This Message is received when provisioned throughput is
|
|
186
|
+
* exceeded is on a provisioned DynamoDB
|
|
187
|
+
* table.</p>
|
|
188
|
+
* </note>
|
|
189
|
+
* </li>
|
|
190
|
+
* <li>
|
|
191
|
+
* <p>The level of configured provisioned throughput for one or
|
|
192
|
+
* more global secondary indexes of the table was exceeded.
|
|
193
|
+
* Consider increasing your provisioning level for the
|
|
194
|
+
* under-provisioned global secondary indexes with the UpdateTable
|
|
195
|
+
* API.</p>
|
|
196
|
+
* <note>
|
|
197
|
+
* <p>This message is returned when provisioned throughput is
|
|
198
|
+
* exceeded is on a provisioned GSI.</p>
|
|
199
|
+
* </note>
|
|
200
|
+
* </li>
|
|
201
|
+
* </ul>
|
|
202
|
+
* </li>
|
|
203
|
+
* </ul>
|
|
204
|
+
* </li>
|
|
205
|
+
* <li>
|
|
206
|
+
* <p>Throttling Error:</p>
|
|
207
|
+
* <ul>
|
|
208
|
+
* <li>
|
|
209
|
+
* <p>Code: <code>ThrottlingError</code>
|
|
210
|
+
* </p>
|
|
211
|
+
* </li>
|
|
212
|
+
* <li>
|
|
213
|
+
* <p>Messages: </p>
|
|
214
|
+
* <ul>
|
|
215
|
+
* <li>
|
|
216
|
+
* <p>Throughput exceeds the current capacity of your table or
|
|
217
|
+
* index. DynamoDB is automatically scaling your table or
|
|
218
|
+
* index so please try again shortly. If exceptions persist, check
|
|
219
|
+
* if you have a hot key:
|
|
220
|
+
* https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.</p>
|
|
221
|
+
* <note>
|
|
222
|
+
* <p>This message is returned when writes get throttled on an
|
|
223
|
+
* On-Demand table as DynamoDB is automatically
|
|
224
|
+
* scaling the table.</p>
|
|
225
|
+
* </note>
|
|
226
|
+
* </li>
|
|
227
|
+
* <li>
|
|
228
|
+
* <p>Throughput exceeds the current capacity for one or more
|
|
229
|
+
* global secondary indexes. DynamoDB is automatically
|
|
230
|
+
* scaling your index so please try again shortly.</p>
|
|
231
|
+
* <note>
|
|
232
|
+
* <p>This message is returned when writes get throttled on
|
|
233
|
+
* an On-Demand GSI as DynamoDB is automatically
|
|
234
|
+
* scaling the GSI.</p>
|
|
235
|
+
* </note>
|
|
236
|
+
* </li>
|
|
237
|
+
* </ul>
|
|
238
|
+
* </li>
|
|
239
|
+
* </ul>
|
|
240
|
+
* </li>
|
|
241
|
+
* <li>
|
|
242
|
+
* <p>Validation Error:</p>
|
|
243
|
+
* <ul>
|
|
244
|
+
* <li>
|
|
245
|
+
* <p>Code: <code>ValidationError</code>
|
|
246
|
+
* </p>
|
|
247
|
+
* </li>
|
|
248
|
+
* <li>
|
|
249
|
+
* <p>Messages: </p>
|
|
250
|
+
* <ul>
|
|
251
|
+
* <li>
|
|
252
|
+
* <p>One or more parameter values were invalid.</p>
|
|
253
|
+
* </li>
|
|
254
|
+
* <li>
|
|
255
|
+
* <p>The update expression attempted to update the secondary
|
|
256
|
+
* index key beyond allowed size limits.</p>
|
|
257
|
+
* </li>
|
|
258
|
+
* <li>
|
|
259
|
+
* <p>The update expression attempted to update the secondary
|
|
260
|
+
* index key to unsupported type.</p>
|
|
261
|
+
* </li>
|
|
262
|
+
* <li>
|
|
263
|
+
* <p>An operand in the update expression has an incorrect data
|
|
264
|
+
* type.</p>
|
|
265
|
+
* </li>
|
|
266
|
+
* <li>
|
|
267
|
+
* <p>Item size to update has exceeded the maximum allowed
|
|
268
|
+
* size.</p>
|
|
269
|
+
* </li>
|
|
270
|
+
* <li>
|
|
271
|
+
* <p>Number overflow. Attempting to store a number with
|
|
272
|
+
* magnitude larger than supported range.</p>
|
|
273
|
+
* </li>
|
|
274
|
+
* <li>
|
|
275
|
+
* <p>Type mismatch for attribute to update.</p>
|
|
276
|
+
* </li>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>Nesting Levels have exceeded supported limits.</p>
|
|
279
|
+
* </li>
|
|
280
|
+
* <li>
|
|
281
|
+
* <p>The document path provided in the update expression is
|
|
282
|
+
* invalid for update.</p>
|
|
283
|
+
* </li>
|
|
284
|
+
* <li>
|
|
285
|
+
* <p>The provided expression refers to an attribute that does
|
|
286
|
+
* not exist in the item.</p>
|
|
287
|
+
* </li>
|
|
288
|
+
* </ul>
|
|
289
|
+
* </li>
|
|
290
|
+
* </ul>
|
|
291
|
+
* </li>
|
|
292
|
+
* </ul>
|
|
293
|
+
*
|
|
294
|
+
* @throws {@link TransactionInProgressException} (client fault)
|
|
295
|
+
* <p>The transaction with the given request token is already in progress.</p>
|
|
296
|
+
* <p>
|
|
297
|
+
* Recommended Settings
|
|
298
|
+
* </p>
|
|
299
|
+
* <note>
|
|
300
|
+
* <p>
|
|
301
|
+
* This is a general recommendation for handling the <code>TransactionInProgressException</code>. These settings help
|
|
302
|
+
* ensure that the client retries will trigger completion of the ongoing <code>TransactWriteItems</code> request.
|
|
303
|
+
* </p>
|
|
304
|
+
* </note>
|
|
305
|
+
* <ul>
|
|
306
|
+
* <li>
|
|
307
|
+
* <p>
|
|
308
|
+
* Set <code>clientExecutionTimeout</code> to a value that allows at least one retry to be processed after 5
|
|
309
|
+
* seconds have elapsed since the first attempt for the <code>TransactWriteItems</code> operation.
|
|
310
|
+
* </p>
|
|
311
|
+
* </li>
|
|
312
|
+
* <li>
|
|
313
|
+
* <p>
|
|
314
|
+
* Set <code>socketTimeout</code> to a value a little lower than the <code>requestTimeout</code> setting.
|
|
315
|
+
* </p>
|
|
316
|
+
* </li>
|
|
317
|
+
* <li>
|
|
318
|
+
* <p>
|
|
319
|
+
* <code>requestTimeout</code> should be set based on the time taken for the individual retries of a single
|
|
320
|
+
* HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of
|
|
321
|
+
* retries and <code>TransactionInProgressException</code> errors.
|
|
322
|
+
* </p>
|
|
323
|
+
* </li>
|
|
324
|
+
* <li>
|
|
325
|
+
* <p>
|
|
326
|
+
* Use exponential backoff when retrying and tune backoff if needed.
|
|
327
|
+
* </p>
|
|
328
|
+
* </li>
|
|
329
|
+
* </ul>
|
|
330
|
+
* <p>
|
|
331
|
+
* Assuming <a href="https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97">default retry policy</a>,
|
|
332
|
+
* example timeout settings based on the guidelines above are as follows:
|
|
333
|
+
* </p>
|
|
334
|
+
* <p>Example timeline:</p>
|
|
335
|
+
* <ul>
|
|
336
|
+
* <li>
|
|
337
|
+
* <p>0-1000 first attempt</p>
|
|
338
|
+
* </li>
|
|
339
|
+
* <li>
|
|
340
|
+
* <p>1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)</p>
|
|
341
|
+
* </li>
|
|
342
|
+
* <li>
|
|
343
|
+
* <p>1500-2500 second attempt</p>
|
|
344
|
+
* </li>
|
|
345
|
+
* <li>
|
|
346
|
+
* <p>2500-3500 second sleep/delay (500 * 2, exponential backoff)</p>
|
|
347
|
+
* </li>
|
|
348
|
+
* <li>
|
|
349
|
+
* <p>3500-4500 third attempt</p>
|
|
350
|
+
* </li>
|
|
351
|
+
* <li>
|
|
352
|
+
* <p>4500-6500 third sleep/delay (500 * 2^2)</p>
|
|
353
|
+
* </li>
|
|
354
|
+
* <li>
|
|
355
|
+
* <p>6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)</p>
|
|
356
|
+
* </li>
|
|
357
|
+
* </ul>
|
|
358
|
+
*
|
|
359
|
+
*
|
|
39
360
|
*/
|
|
40
361
|
export declare class ExecuteTransactionCommand extends $Command<ExecuteTransactionCommandInput, ExecuteTransactionCommandOutput, DynamoDBClientResolvedConfig> {
|
|
41
362
|
readonly input: ExecuteTransactionCommandInput;
|
|
@@ -31,6 +31,37 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin
|
|
|
31
31
|
* @see {@link ExportTableToPointInTimeCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link ExportConflictException} (client fault)
|
|
35
|
+
* <p>There was a conflict when writing to the specified S3 bucket.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InternalServerError} (server fault)
|
|
38
|
+
* <p>An error occurred on the server side.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidExportTimeException} (client fault)
|
|
41
|
+
* <p>The specified <code>ExportTime</code> is outside of the point in time recovery
|
|
42
|
+
* window.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
45
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
46
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
47
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
48
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
49
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
50
|
+
* <p>When you are creating a table with one or more secondary
|
|
51
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
52
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
53
|
+
* of concurrent operations.</p>
|
|
54
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
55
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link PointInTimeRecoveryUnavailableException} (client fault)
|
|
58
|
+
* <p>Point in time recovery has not yet been enabled for this source table.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
61
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
62
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
34
65
|
*/
|
|
35
66
|
export declare class ExportTableToPointInTimeCommand extends $Command<ExportTableToPointInTimeCommandInput, ExportTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
67
|
readonly input: ExportTableToPointInTimeCommandInput;
|