@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
|
@@ -41,6 +41,15 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
41
41
|
* @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link InternalServerError} (server fault)
|
|
45
|
+
* <p>An error occurred on the server side.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
48
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
49
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
50
|
+
* quota increase.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
44
53
|
*/
|
|
45
54
|
export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
55
|
readonly input: BatchExecuteStatementCommandInput;
|
|
@@ -75,6 +75,91 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
75
75
|
* @see {@link BatchGetItemCommandOutput} for command's `response` shape.
|
|
76
76
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
77
77
|
*
|
|
78
|
+
* @throws {@link InternalServerError} (server fault)
|
|
79
|
+
* <p>An error occurred on the server side.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
84
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
85
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
86
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
87
|
+
* 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>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
90
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
91
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
92
|
+
* quota increase.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
95
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
96
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @example To retrieve multiple items from a table
|
|
100
|
+
* ```javascript
|
|
101
|
+
* // This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.
|
|
102
|
+
* const input = {
|
|
103
|
+
* "RequestItems": {
|
|
104
|
+
* "Music": {
|
|
105
|
+
* "Keys": [
|
|
106
|
+
* {
|
|
107
|
+
* "Artist": {
|
|
108
|
+
* "S": "No One You Know"
|
|
109
|
+
* },
|
|
110
|
+
* "SongTitle": {
|
|
111
|
+
* "S": "Call Me Today"
|
|
112
|
+
* }
|
|
113
|
+
* },
|
|
114
|
+
* {
|
|
115
|
+
* "Artist": {
|
|
116
|
+
* "S": "Acme Band"
|
|
117
|
+
* },
|
|
118
|
+
* "SongTitle": {
|
|
119
|
+
* "S": "Happy Day"
|
|
120
|
+
* }
|
|
121
|
+
* },
|
|
122
|
+
* {
|
|
123
|
+
* "Artist": {
|
|
124
|
+
* "S": "No One You Know"
|
|
125
|
+
* },
|
|
126
|
+
* "SongTitle": {
|
|
127
|
+
* "S": "Scared of My Shadow"
|
|
128
|
+
* }
|
|
129
|
+
* }
|
|
130
|
+
* ],
|
|
131
|
+
* "ProjectionExpression": "AlbumTitle"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* };
|
|
135
|
+
* const command = new BatchGetItemCommand(input);
|
|
136
|
+
* const response = await client.send(command);
|
|
137
|
+
* /* response ==
|
|
138
|
+
* {
|
|
139
|
+
* "Responses": {
|
|
140
|
+
* "Music": [
|
|
141
|
+
* {
|
|
142
|
+
* "AlbumTitle": {
|
|
143
|
+
* "S": "Somewhat Famous"
|
|
144
|
+
* }
|
|
145
|
+
* },
|
|
146
|
+
* {
|
|
147
|
+
* "AlbumTitle": {
|
|
148
|
+
* "S": "Blue Sky Blues"
|
|
149
|
+
* }
|
|
150
|
+
* },
|
|
151
|
+
* {
|
|
152
|
+
* "AlbumTitle": {
|
|
153
|
+
* "S": "Louder Than Ever"
|
|
154
|
+
* }
|
|
155
|
+
* }
|
|
156
|
+
* ]
|
|
157
|
+
* }
|
|
158
|
+
* }
|
|
159
|
+
* *\/
|
|
160
|
+
* // example id: to-retrieve-multiple-items-from-a-table-1476118438992
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
78
163
|
*/
|
|
79
164
|
export declare class BatchGetItemCommand extends $Command<BatchGetItemCommandInput, BatchGetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
80
165
|
readonly input: BatchGetItemCommandInput;
|
|
@@ -110,6 +110,90 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
110
110
|
* @see {@link BatchWriteItemCommandOutput} for command's `response` shape.
|
|
111
111
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
112
112
|
*
|
|
113
|
+
* @throws {@link InternalServerError} (server fault)
|
|
114
|
+
* <p>An error occurred on the server side.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
|
|
119
|
+
* <p>An item collection is too large. This exception is only returned for tables that
|
|
120
|
+
* have one or more local secondary indexes.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
123
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
124
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
125
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
126
|
+
* 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>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
129
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
130
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
131
|
+
* quota increase.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
134
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
135
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
136
|
+
*
|
|
137
|
+
*
|
|
138
|
+
* @example To add multiple items to a table
|
|
139
|
+
* ```javascript
|
|
140
|
+
* // This example adds three new items to the Music table using a batch of three PutItem requests.
|
|
141
|
+
* const input = {
|
|
142
|
+
* "RequestItems": {
|
|
143
|
+
* "Music": [
|
|
144
|
+
* {
|
|
145
|
+
* "PutRequest": {
|
|
146
|
+
* "Item": {
|
|
147
|
+
* "AlbumTitle": {
|
|
148
|
+
* "S": "Somewhat Famous"
|
|
149
|
+
* },
|
|
150
|
+
* "Artist": {
|
|
151
|
+
* "S": "No One You Know"
|
|
152
|
+
* },
|
|
153
|
+
* "SongTitle": {
|
|
154
|
+
* "S": "Call Me Today"
|
|
155
|
+
* }
|
|
156
|
+
* }
|
|
157
|
+
* }
|
|
158
|
+
* },
|
|
159
|
+
* {
|
|
160
|
+
* "PutRequest": {
|
|
161
|
+
* "Item": {
|
|
162
|
+
* "AlbumTitle": {
|
|
163
|
+
* "S": "Songs About Life"
|
|
164
|
+
* },
|
|
165
|
+
* "Artist": {
|
|
166
|
+
* "S": "Acme Band"
|
|
167
|
+
* },
|
|
168
|
+
* "SongTitle": {
|
|
169
|
+
* "S": "Happy Day"
|
|
170
|
+
* }
|
|
171
|
+
* }
|
|
172
|
+
* }
|
|
173
|
+
* },
|
|
174
|
+
* {
|
|
175
|
+
* "PutRequest": {
|
|
176
|
+
* "Item": {
|
|
177
|
+
* "AlbumTitle": {
|
|
178
|
+
* "S": "Blue Sky Blues"
|
|
179
|
+
* },
|
|
180
|
+
* "Artist": {
|
|
181
|
+
* "S": "No One You Know"
|
|
182
|
+
* },
|
|
183
|
+
* "SongTitle": {
|
|
184
|
+
* "S": "Scared of My Shadow"
|
|
185
|
+
* }
|
|
186
|
+
* }
|
|
187
|
+
* }
|
|
188
|
+
* }
|
|
189
|
+
* ]
|
|
190
|
+
* }
|
|
191
|
+
* };
|
|
192
|
+
* const command = new BatchWriteItemCommand(input);
|
|
193
|
+
* await client.send(command);
|
|
194
|
+
* // example id: to-add-multiple-items-to-a-table-1476118519747
|
|
195
|
+
* ```
|
|
196
|
+
*
|
|
113
197
|
*/
|
|
114
198
|
export declare class BatchWriteItemCommand extends $Command<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
115
199
|
readonly input: BatchWriteItemCommandInput;
|
|
@@ -58,6 +58,40 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
58
58
|
* @see {@link CreateBackupCommandOutput} for command's `response` shape.
|
|
59
59
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
60
60
|
*
|
|
61
|
+
* @throws {@link BackupInUseException} (client fault)
|
|
62
|
+
* <p>There is another ongoing conflicting backup control plane operation on the table.
|
|
63
|
+
* The backup is either being created, deleted or restored to a table.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ContinuousBackupsUnavailableException} (client fault)
|
|
66
|
+
* <p>Backups have not yet been enabled for this table.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
* <p>An error occurred on the server side.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
74
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
75
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
76
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
77
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
78
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
79
|
+
* <p>When you are creating a table with one or more secondary
|
|
80
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
81
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
82
|
+
* of concurrent operations.</p>
|
|
83
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
84
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link TableInUseException} (client fault)
|
|
87
|
+
* <p>A target table with the specified name is either being created or deleted.
|
|
88
|
+
* </p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
91
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
92
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
93
|
+
*
|
|
94
|
+
*
|
|
61
95
|
*/
|
|
62
96
|
export declare class CreateBackupCommand extends $Command<CreateBackupCommandInput, CreateBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
63
97
|
readonly input: CreateBackupCommandInput;
|
|
@@ -91,6 +91,32 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
91
91
|
* @see {@link CreateGlobalTableCommandOutput} for command's `response` shape.
|
|
92
92
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
93
93
|
*
|
|
94
|
+
* @throws {@link GlobalTableAlreadyExistsException} (client fault)
|
|
95
|
+
* <p>The specified global table already exists.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link InternalServerError} (server fault)
|
|
98
|
+
* <p>An error occurred on the server side.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
103
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
104
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
105
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
106
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
107
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
108
|
+
* <p>When you are creating a table with one or more secondary
|
|
109
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
110
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
111
|
+
* of concurrent operations.</p>
|
|
112
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
113
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
116
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
117
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
118
|
+
*
|
|
119
|
+
*
|
|
94
120
|
*/
|
|
95
121
|
export declare class CreateGlobalTableCommand extends $Command<CreateGlobalTableCommandInput, CreateGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
96
122
|
readonly input: CreateGlobalTableCommandInput;
|
|
@@ -41,6 +41,100 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
41
41
|
* @see {@link CreateTableCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link InternalServerError} (server fault)
|
|
45
|
+
* <p>An error occurred on the server side.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
50
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
51
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
52
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
53
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
54
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
55
|
+
* <p>When you are creating a table with one or more secondary
|
|
56
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
57
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
58
|
+
* of concurrent operations.</p>
|
|
59
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
60
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
63
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
64
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
65
|
+
* <code>CREATING</code> state.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
68
|
+
* @example To create a table
|
|
69
|
+
* ```javascript
|
|
70
|
+
* // This example creates a table named Music.
|
|
71
|
+
* const input = {
|
|
72
|
+
* "AttributeDefinitions": [
|
|
73
|
+
* {
|
|
74
|
+
* "AttributeName": "Artist",
|
|
75
|
+
* "AttributeType": "S"
|
|
76
|
+
* },
|
|
77
|
+
* {
|
|
78
|
+
* "AttributeName": "SongTitle",
|
|
79
|
+
* "AttributeType": "S"
|
|
80
|
+
* }
|
|
81
|
+
* ],
|
|
82
|
+
* "KeySchema": [
|
|
83
|
+
* {
|
|
84
|
+
* "AttributeName": "Artist",
|
|
85
|
+
* "KeyType": "HASH"
|
|
86
|
+
* },
|
|
87
|
+
* {
|
|
88
|
+
* "AttributeName": "SongTitle",
|
|
89
|
+
* "KeyType": "RANGE"
|
|
90
|
+
* }
|
|
91
|
+
* ],
|
|
92
|
+
* "ProvisionedThroughput": {
|
|
93
|
+
* "ReadCapacityUnits": 5,
|
|
94
|
+
* "WriteCapacityUnits": 5
|
|
95
|
+
* },
|
|
96
|
+
* "TableName": "Music"
|
|
97
|
+
* };
|
|
98
|
+
* const command = new CreateTableCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response ==
|
|
101
|
+
* {
|
|
102
|
+
* "TableDescription": {
|
|
103
|
+
* "AttributeDefinitions": [
|
|
104
|
+
* {
|
|
105
|
+
* "AttributeName": "Artist",
|
|
106
|
+
* "AttributeType": "S"
|
|
107
|
+
* },
|
|
108
|
+
* {
|
|
109
|
+
* "AttributeName": "SongTitle",
|
|
110
|
+
* "AttributeType": "S"
|
|
111
|
+
* }
|
|
112
|
+
* ],
|
|
113
|
+
* "CreationDateTime": "1421866952.062",
|
|
114
|
+
* "ItemCount": 0,
|
|
115
|
+
* "KeySchema": [
|
|
116
|
+
* {
|
|
117
|
+
* "AttributeName": "Artist",
|
|
118
|
+
* "KeyType": "HASH"
|
|
119
|
+
* },
|
|
120
|
+
* {
|
|
121
|
+
* "AttributeName": "SongTitle",
|
|
122
|
+
* "KeyType": "RANGE"
|
|
123
|
+
* }
|
|
124
|
+
* ],
|
|
125
|
+
* "ProvisionedThroughput": {
|
|
126
|
+
* "ReadCapacityUnits": 5,
|
|
127
|
+
* "WriteCapacityUnits": 5
|
|
128
|
+
* },
|
|
129
|
+
* "TableName": "Music",
|
|
130
|
+
* "TableSizeBytes": 0,
|
|
131
|
+
* "TableStatus": "CREATING"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* // example id: to-create-a-table-1476116291743
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
44
138
|
*/
|
|
45
139
|
export declare class CreateTableCommand extends $Command<CreateTableCommandInput, CreateTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
140
|
readonly input: CreateTableCommandInput;
|
|
@@ -31,6 +31,32 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
31
31
|
* @see {@link DeleteBackupCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link BackupInUseException} (client fault)
|
|
35
|
+
* <p>There is another ongoing conflicting backup control plane operation on the table.
|
|
36
|
+
* The backup is either being created, deleted or restored to a table.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link BackupNotFoundException} (client fault)
|
|
39
|
+
* <p>Backup not found for the given BackupARN. </p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InternalServerError} (server fault)
|
|
42
|
+
* <p>An error occurred on the server side.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
47
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
48
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
49
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
50
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
51
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
52
|
+
* <p>When you are creating a table with one or more secondary
|
|
53
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
54
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
55
|
+
* of concurrent operations.</p>
|
|
56
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
57
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
58
|
+
*
|
|
59
|
+
*
|
|
34
60
|
*/
|
|
35
61
|
export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
62
|
readonly input: DeleteBackupCommandInput;
|
|
@@ -39,6 +39,65 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
|
|
|
39
39
|
* @see {@link DeleteItemCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @throws {@link ConditionalCheckFailedException} (client fault)
|
|
43
|
+
* <p>A condition specified in the operation could not be evaluated.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link InternalServerError} (server fault)
|
|
46
|
+
* <p>An error occurred on the server side.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
|
|
51
|
+
* <p>An item collection is too large. This exception is only returned for tables that
|
|
52
|
+
* have one or more local secondary indexes.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
55
|
+
* <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
|
|
56
|
+
* automatically retry requests that receive this exception. Your request is eventually
|
|
57
|
+
* successful, unless your retry queue is too large to finish. Reduce the frequency of
|
|
58
|
+
* 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>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link RequestLimitExceeded} (client fault)
|
|
61
|
+
* <p>Throughput exceeds the current throughput quota for your account. Please contact
|
|
62
|
+
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
63
|
+
* quota increase.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
67
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link TransactionConflictException} (client fault)
|
|
70
|
+
* <p>Operation was rejected because there is an ongoing transaction for the
|
|
71
|
+
* item.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* @example To delete an item
|
|
75
|
+
* ```javascript
|
|
76
|
+
* // This example deletes an item from the Music table.
|
|
77
|
+
* const input = {
|
|
78
|
+
* "Key": {
|
|
79
|
+
* "Artist": {
|
|
80
|
+
* "S": "No One You Know"
|
|
81
|
+
* },
|
|
82
|
+
* "SongTitle": {
|
|
83
|
+
* "S": "Scared of My Shadow"
|
|
84
|
+
* }
|
|
85
|
+
* },
|
|
86
|
+
* "TableName": "Music"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new DeleteItemCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response ==
|
|
91
|
+
* {
|
|
92
|
+
* "ConsumedCapacity": {
|
|
93
|
+
* "CapacityUnits": 1,
|
|
94
|
+
* "TableName": "Music"
|
|
95
|
+
* }
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* // example id: to-delete-an-item-1475884573758
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
42
101
|
*/
|
|
43
102
|
export declare class DeleteItemCommand extends $Command<DeleteItemCommandInput, DeleteItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
44
103
|
readonly input: DeleteItemCommandInput;
|
|
@@ -51,6 +51,60 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
51
51
|
* @see {@link DeleteTableCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @throws {@link InternalServerError} (server fault)
|
|
55
|
+
* <p>An error occurred on the server side.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
60
|
+
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
61
|
+
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
62
|
+
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
63
|
+
* <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
|
|
64
|
+
* <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
|
|
65
|
+
* <p>When you are creating a table with one or more secondary
|
|
66
|
+
* indexes, you can have up to 250 such requests running at a time. However, if the table or
|
|
67
|
+
* index specifications are complex, then DynamoDB might temporarily reduce the number
|
|
68
|
+
* of concurrent operations.</p>
|
|
69
|
+
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
70
|
+
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
73
|
+
* <p>The operation conflicts with the resource's availability. For example, you
|
|
74
|
+
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
75
|
+
* <code>CREATING</code> state.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
79
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @example To delete a table
|
|
83
|
+
* ```javascript
|
|
84
|
+
* // This example deletes the Music table.
|
|
85
|
+
* const input = {
|
|
86
|
+
* "TableName": "Music"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new DeleteTableCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response ==
|
|
91
|
+
* {
|
|
92
|
+
* "TableDescription": {
|
|
93
|
+
* "ItemCount": 0,
|
|
94
|
+
* "ProvisionedThroughput": {
|
|
95
|
+
* "NumberOfDecreasesToday": 1,
|
|
96
|
+
* "ReadCapacityUnits": 5,
|
|
97
|
+
* "WriteCapacityUnits": 5
|
|
98
|
+
* },
|
|
99
|
+
* "TableName": "Music",
|
|
100
|
+
* "TableSizeBytes": 0,
|
|
101
|
+
* "TableStatus": "DELETING"
|
|
102
|
+
* }
|
|
103
|
+
* }
|
|
104
|
+
* *\/
|
|
105
|
+
* // example id: to-delete-a-table-1475884368755
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
54
108
|
*/
|
|
55
109
|
export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
56
110
|
readonly input: DeleteTableCommandInput;
|
|
@@ -31,6 +31,15 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
|
|
|
31
31
|
* @see {@link DescribeBackupCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link BackupNotFoundException} (client fault)
|
|
35
|
+
* <p>Backup not found for the given BackupARN. </p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InternalServerError} (server fault)
|
|
38
|
+
* <p>An error occurred on the server side.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
41
|
+
*
|
|
42
|
+
*
|
|
34
43
|
*/
|
|
35
44
|
export declare class DescribeBackupCommand extends $Command<DescribeBackupCommandInput, DescribeBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
45
|
readonly input: DescribeBackupCommandInput;
|
|
@@ -40,6 +40,16 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
|
|
|
40
40
|
* @see {@link DescribeContinuousBackupsCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @throws {@link InternalServerError} (server fault)
|
|
44
|
+
* <p>An error occurred on the server side.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link TableNotFoundException} (client fault)
|
|
49
|
+
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
50
|
+
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
43
53
|
*/
|
|
44
54
|
export declare class DescribeContinuousBackupsCommand extends $Command<DescribeContinuousBackupsCommandInput, DescribeContinuousBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
45
55
|
readonly input: DescribeContinuousBackupsCommandInput;
|
|
@@ -30,6 +30,14 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri
|
|
|
30
30
|
* @see {@link DescribeContributorInsightsCommandOutput} 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 ResourceNotFoundException} (client fault)
|
|
37
|
+
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
38
|
+
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
39
|
+
*
|
|
40
|
+
*
|
|
33
41
|
*/
|
|
34
42
|
export declare class DescribeContributorInsightsCommand extends $Command<DescribeContributorInsightsCommandInput, DescribeContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
35
43
|
readonly input: DescribeContributorInsightsCommandInput;
|
|
@@ -31,6 +31,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
|
|
|
31
31
|
* @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
*
|
|
34
35
|
*/
|
|
35
36
|
export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
36
37
|
readonly input: DescribeEndpointsCommandInput;
|
|
@@ -29,6 +29,26 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met
|
|
|
29
29
|
* @see {@link DescribeExportCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ExportNotFoundException} (client fault)
|
|
33
|
+
* <p>The specified export was not found.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>An error occurred on the server side.</p>
|
|
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
|
+
*
|
|
32
52
|
*/
|
|
33
53
|
export declare class DescribeExportCommand extends $Command<DescribeExportCommandInput, DescribeExportCommandOutput, DynamoDBClientResolvedConfig> {
|
|
34
54
|
readonly input: DescribeExportCommandInput;
|
|
@@ -41,6 +41,15 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
|
|
|
41
41
|
* @see {@link DescribeGlobalTableCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link GlobalTableNotFoundException} (client fault)
|
|
45
|
+
* <p>The specified global table does not exist.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InternalServerError} (server fault)
|
|
48
|
+
* <p>An error occurred on the server side.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
51
|
+
*
|
|
52
|
+
*
|
|
44
53
|
*/
|
|
45
54
|
export declare class DescribeGlobalTableCommand extends $Command<DescribeGlobalTableCommandInput, DescribeGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
55
|
readonly input: DescribeGlobalTableCommandInput;
|
|
@@ -41,6 +41,15 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
|
|
|
41
41
|
* @see {@link DescribeGlobalTableSettingsCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link GlobalTableNotFoundException} (client fault)
|
|
45
|
+
* <p>The specified global table does not exist.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InternalServerError} (server fault)
|
|
48
|
+
* <p>An error occurred on the server side.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidEndpointException} (client fault)
|
|
51
|
+
*
|
|
52
|
+
*
|
|
44
53
|
*/
|
|
45
54
|
export declare class DescribeGlobalTableSettingsCommand extends $Command<DescribeGlobalTableSettingsCommandInput, DescribeGlobalTableSettingsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
46
55
|
readonly input: DescribeGlobalTableSettingsCommandInput;
|