@aws-sdk/client-dynamodb 3.325.0 → 3.326.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 +86 -0
- package/dist-types/commands/BatchGetItemCommand.d.ts +98 -0
- package/dist-types/commands/BatchWriteItemCommand.d.ts +102 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +14 -0
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +36 -0
- package/dist-types/commands/CreateTableCommand.d.ts +140 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +89 -0
- package/dist-types/commands/DeleteItemCommand.d.ts +83 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +140 -0
- package/dist-types/commands/DescribeBackupCommand.d.ts +89 -0
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +11 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +26 -0
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +36 -0
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +98 -0
- package/dist-types/commands/DescribeImportCommand.d.ts +82 -0
- package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +13 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeTableCommand.d.ts +140 -0
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +89 -0
- package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +9 -0
- package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +8 -0
- package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +8 -0
- package/dist-types/commands/ExecuteStatementCommand.d.ts +81 -0
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +81 -0
- package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +26 -0
- package/dist-types/commands/GetItemCommand.d.ts +75 -0
- package/dist-types/commands/ImportTableCommand.d.ts +82 -0
- package/dist-types/commands/ListBackupsCommand.d.ts +20 -0
- package/dist-types/commands/ListContributorInsightsCommand.d.ts +13 -0
- package/dist-types/commands/ListExportsCommand.d.ts +12 -0
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +16 -0
- package/dist-types/commands/ListImportsCommand.d.ts +22 -0
- package/dist-types/commands/ListTablesCommand.d.ts +9 -0
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +12 -0
- package/dist-types/commands/PutItemCommand.d.ts +83 -0
- package/dist-types/commands/QueryCommand.d.ts +82 -0
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +140 -0
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +140 -0
- package/dist-types/commands/ScanCommand.d.ts +82 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/TransactGetItemsCommand.d.ts +81 -0
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +86 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -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 +36 -0
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +98 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +83 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +140 -0
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +89 -0
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +9 -0
- package/package.json +4 -4
|
@@ -94,6 +94,90 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
94
94
|
* };
|
|
95
95
|
* const command = new BatchExecuteStatementCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
+
* // { // BatchExecuteStatementOutput
|
|
98
|
+
* // Responses: [ // PartiQLBatchResponse
|
|
99
|
+
* // { // BatchStatementResponse
|
|
100
|
+
* // Error: { // BatchStatementError
|
|
101
|
+
* // Code: "ConditionalCheckFailed" || "ItemCollectionSizeLimitExceeded" || "RequestLimitExceeded" || "ValidationError" || "ProvisionedThroughputExceeded" || "TransactionConflict" || "ThrottlingError" || "InternalServerError" || "ResourceNotFound" || "AccessDenied" || "DuplicateItem",
|
|
102
|
+
* // Message: "STRING_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // TableName: "STRING_VALUE",
|
|
105
|
+
* // Item: { // AttributeMap
|
|
106
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
107
|
+
* // S: "STRING_VALUE",
|
|
108
|
+
* // N: "STRING_VALUE",
|
|
109
|
+
* // B: "BLOB_VALUE",
|
|
110
|
+
* // SS: [ // StringSetAttributeValue
|
|
111
|
+
* // "STRING_VALUE",
|
|
112
|
+
* // ],
|
|
113
|
+
* // NS: [ // NumberSetAttributeValue
|
|
114
|
+
* // "STRING_VALUE",
|
|
115
|
+
* // ],
|
|
116
|
+
* // BS: [ // BinarySetAttributeValue
|
|
117
|
+
* // "BLOB_VALUE",
|
|
118
|
+
* // ],
|
|
119
|
+
* // M: { // MapAttributeValue
|
|
120
|
+
* // "<keys>": {// Union: only one key present
|
|
121
|
+
* // S: "STRING_VALUE",
|
|
122
|
+
* // N: "STRING_VALUE",
|
|
123
|
+
* // B: "BLOB_VALUE",
|
|
124
|
+
* // SS: [
|
|
125
|
+
* // "STRING_VALUE",
|
|
126
|
+
* // ],
|
|
127
|
+
* // NS: [
|
|
128
|
+
* // "STRING_VALUE",
|
|
129
|
+
* // ],
|
|
130
|
+
* // BS: [
|
|
131
|
+
* // "BLOB_VALUE",
|
|
132
|
+
* // ],
|
|
133
|
+
* // M: {
|
|
134
|
+
* // "<keys>": "<AttributeValue>",
|
|
135
|
+
* // },
|
|
136
|
+
* // L: [ // ListAttributeValue
|
|
137
|
+
* // "<AttributeValue>",
|
|
138
|
+
* // ],
|
|
139
|
+
* // NULL: true || false,
|
|
140
|
+
* // BOOL: true || false,
|
|
141
|
+
* // },
|
|
142
|
+
* // },
|
|
143
|
+
* // L: [
|
|
144
|
+
* // "<AttributeValue>",
|
|
145
|
+
* // ],
|
|
146
|
+
* // NULL: true || false,
|
|
147
|
+
* // BOOL: true || false,
|
|
148
|
+
* // },
|
|
149
|
+
* // },
|
|
150
|
+
* // },
|
|
151
|
+
* // ],
|
|
152
|
+
* // ConsumedCapacity: [ // ConsumedCapacityMultiple
|
|
153
|
+
* // { // ConsumedCapacity
|
|
154
|
+
* // TableName: "STRING_VALUE",
|
|
155
|
+
* // CapacityUnits: Number("double"),
|
|
156
|
+
* // ReadCapacityUnits: Number("double"),
|
|
157
|
+
* // WriteCapacityUnits: Number("double"),
|
|
158
|
+
* // Table: { // Capacity
|
|
159
|
+
* // ReadCapacityUnits: Number("double"),
|
|
160
|
+
* // WriteCapacityUnits: Number("double"),
|
|
161
|
+
* // CapacityUnits: Number("double"),
|
|
162
|
+
* // },
|
|
163
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
164
|
+
* // "<keys>": {
|
|
165
|
+
* // ReadCapacityUnits: Number("double"),
|
|
166
|
+
* // WriteCapacityUnits: Number("double"),
|
|
167
|
+
* // CapacityUnits: Number("double"),
|
|
168
|
+
* // },
|
|
169
|
+
* // },
|
|
170
|
+
* // GlobalSecondaryIndexes: {
|
|
171
|
+
* // "<keys>": {
|
|
172
|
+
* // ReadCapacityUnits: Number("double"),
|
|
173
|
+
* // WriteCapacityUnits: Number("double"),
|
|
174
|
+
* // CapacityUnits: Number("double"),
|
|
175
|
+
* // },
|
|
176
|
+
* // },
|
|
177
|
+
* // },
|
|
178
|
+
* // ],
|
|
179
|
+
* // };
|
|
180
|
+
*
|
|
97
181
|
* ```
|
|
98
182
|
*
|
|
99
183
|
* @param BatchExecuteStatementCommandInput - {@link BatchExecuteStatementCommandInput}
|
|
@@ -110,6 +194,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
110
194
|
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
|
|
111
195
|
* quota increase.</p>
|
|
112
196
|
*
|
|
197
|
+
* @throws {@link DynamoDBServiceException}
|
|
198
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
113
199
|
*
|
|
114
200
|
*/
|
|
115
201
|
export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -136,6 +136,102 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
136
136
|
* };
|
|
137
137
|
* const command = new BatchGetItemCommand(input);
|
|
138
138
|
* const response = await client.send(command);
|
|
139
|
+
* // { // BatchGetItemOutput
|
|
140
|
+
* // Responses: { // BatchGetResponseMap
|
|
141
|
+
* // "<keys>": [ // ItemList
|
|
142
|
+
* // { // AttributeMap
|
|
143
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
144
|
+
* // S: "STRING_VALUE",
|
|
145
|
+
* // N: "STRING_VALUE",
|
|
146
|
+
* // B: "BLOB_VALUE",
|
|
147
|
+
* // SS: [ // StringSetAttributeValue
|
|
148
|
+
* // "STRING_VALUE",
|
|
149
|
+
* // ],
|
|
150
|
+
* // NS: [ // NumberSetAttributeValue
|
|
151
|
+
* // "STRING_VALUE",
|
|
152
|
+
* // ],
|
|
153
|
+
* // BS: [ // BinarySetAttributeValue
|
|
154
|
+
* // "BLOB_VALUE",
|
|
155
|
+
* // ],
|
|
156
|
+
* // M: { // MapAttributeValue
|
|
157
|
+
* // "<keys>": {// Union: only one key present
|
|
158
|
+
* // S: "STRING_VALUE",
|
|
159
|
+
* // N: "STRING_VALUE",
|
|
160
|
+
* // B: "BLOB_VALUE",
|
|
161
|
+
* // SS: [
|
|
162
|
+
* // "STRING_VALUE",
|
|
163
|
+
* // ],
|
|
164
|
+
* // NS: [
|
|
165
|
+
* // "STRING_VALUE",
|
|
166
|
+
* // ],
|
|
167
|
+
* // BS: [
|
|
168
|
+
* // "BLOB_VALUE",
|
|
169
|
+
* // ],
|
|
170
|
+
* // M: {
|
|
171
|
+
* // "<keys>": "<AttributeValue>",
|
|
172
|
+
* // },
|
|
173
|
+
* // L: [ // ListAttributeValue
|
|
174
|
+
* // "<AttributeValue>",
|
|
175
|
+
* // ],
|
|
176
|
+
* // NULL: true || false,
|
|
177
|
+
* // BOOL: true || false,
|
|
178
|
+
* // },
|
|
179
|
+
* // },
|
|
180
|
+
* // L: [
|
|
181
|
+
* // "<AttributeValue>",
|
|
182
|
+
* // ],
|
|
183
|
+
* // NULL: true || false,
|
|
184
|
+
* // BOOL: true || false,
|
|
185
|
+
* // },
|
|
186
|
+
* // },
|
|
187
|
+
* // ],
|
|
188
|
+
* // },
|
|
189
|
+
* // UnprocessedKeys: { // BatchGetRequestMap
|
|
190
|
+
* // "<keys>": { // KeysAndAttributes
|
|
191
|
+
* // Keys: [ // KeyList // required
|
|
192
|
+
* // { // Key
|
|
193
|
+
* // "<keys>": "<AttributeValue>",
|
|
194
|
+
* // },
|
|
195
|
+
* // ],
|
|
196
|
+
* // AttributesToGet: [ // AttributeNameList
|
|
197
|
+
* // "STRING_VALUE",
|
|
198
|
+
* // ],
|
|
199
|
+
* // ConsistentRead: true || false,
|
|
200
|
+
* // ProjectionExpression: "STRING_VALUE",
|
|
201
|
+
* // ExpressionAttributeNames: { // ExpressionAttributeNameMap
|
|
202
|
+
* // "<keys>": "STRING_VALUE",
|
|
203
|
+
* // },
|
|
204
|
+
* // },
|
|
205
|
+
* // },
|
|
206
|
+
* // ConsumedCapacity: [ // ConsumedCapacityMultiple
|
|
207
|
+
* // { // ConsumedCapacity
|
|
208
|
+
* // TableName: "STRING_VALUE",
|
|
209
|
+
* // CapacityUnits: Number("double"),
|
|
210
|
+
* // ReadCapacityUnits: Number("double"),
|
|
211
|
+
* // WriteCapacityUnits: Number("double"),
|
|
212
|
+
* // Table: { // Capacity
|
|
213
|
+
* // ReadCapacityUnits: Number("double"),
|
|
214
|
+
* // WriteCapacityUnits: Number("double"),
|
|
215
|
+
* // CapacityUnits: Number("double"),
|
|
216
|
+
* // },
|
|
217
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
218
|
+
* // "<keys>": {
|
|
219
|
+
* // ReadCapacityUnits: Number("double"),
|
|
220
|
+
* // WriteCapacityUnits: Number("double"),
|
|
221
|
+
* // CapacityUnits: Number("double"),
|
|
222
|
+
* // },
|
|
223
|
+
* // },
|
|
224
|
+
* // GlobalSecondaryIndexes: {
|
|
225
|
+
* // "<keys>": {
|
|
226
|
+
* // ReadCapacityUnits: Number("double"),
|
|
227
|
+
* // WriteCapacityUnits: Number("double"),
|
|
228
|
+
* // CapacityUnits: Number("double"),
|
|
229
|
+
* // },
|
|
230
|
+
* // },
|
|
231
|
+
* // },
|
|
232
|
+
* // ],
|
|
233
|
+
* // };
|
|
234
|
+
*
|
|
139
235
|
* ```
|
|
140
236
|
*
|
|
141
237
|
* @param BatchGetItemCommandInput - {@link BatchGetItemCommandInput}
|
|
@@ -164,6 +260,8 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
164
260
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
165
261
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
166
262
|
*
|
|
263
|
+
* @throws {@link DynamoDBServiceException}
|
|
264
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
167
265
|
*
|
|
168
266
|
* @example To retrieve multiple items from a table
|
|
169
267
|
* ```javascript
|
|
@@ -171,6 +171,106 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
171
171
|
* };
|
|
172
172
|
* const command = new BatchWriteItemCommand(input);
|
|
173
173
|
* const response = await client.send(command);
|
|
174
|
+
* // { // BatchWriteItemOutput
|
|
175
|
+
* // UnprocessedItems: { // BatchWriteItemRequestMap
|
|
176
|
+
* // "<keys>": [ // WriteRequests
|
|
177
|
+
* // { // WriteRequest
|
|
178
|
+
* // PutRequest: { // PutRequest
|
|
179
|
+
* // Item: { // PutItemInputAttributeMap // required
|
|
180
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
181
|
+
* // S: "STRING_VALUE",
|
|
182
|
+
* // N: "STRING_VALUE",
|
|
183
|
+
* // B: "BLOB_VALUE",
|
|
184
|
+
* // SS: [ // StringSetAttributeValue
|
|
185
|
+
* // "STRING_VALUE",
|
|
186
|
+
* // ],
|
|
187
|
+
* // NS: [ // NumberSetAttributeValue
|
|
188
|
+
* // "STRING_VALUE",
|
|
189
|
+
* // ],
|
|
190
|
+
* // BS: [ // BinarySetAttributeValue
|
|
191
|
+
* // "BLOB_VALUE",
|
|
192
|
+
* // ],
|
|
193
|
+
* // M: { // MapAttributeValue
|
|
194
|
+
* // "<keys>": {// Union: only one key present
|
|
195
|
+
* // S: "STRING_VALUE",
|
|
196
|
+
* // N: "STRING_VALUE",
|
|
197
|
+
* // B: "BLOB_VALUE",
|
|
198
|
+
* // SS: [
|
|
199
|
+
* // "STRING_VALUE",
|
|
200
|
+
* // ],
|
|
201
|
+
* // NS: [
|
|
202
|
+
* // "STRING_VALUE",
|
|
203
|
+
* // ],
|
|
204
|
+
* // BS: [
|
|
205
|
+
* // "BLOB_VALUE",
|
|
206
|
+
* // ],
|
|
207
|
+
* // M: {
|
|
208
|
+
* // "<keys>": "<AttributeValue>",
|
|
209
|
+
* // },
|
|
210
|
+
* // L: [ // ListAttributeValue
|
|
211
|
+
* // "<AttributeValue>",
|
|
212
|
+
* // ],
|
|
213
|
+
* // NULL: true || false,
|
|
214
|
+
* // BOOL: true || false,
|
|
215
|
+
* // },
|
|
216
|
+
* // },
|
|
217
|
+
* // L: [
|
|
218
|
+
* // "<AttributeValue>",
|
|
219
|
+
* // ],
|
|
220
|
+
* // NULL: true || false,
|
|
221
|
+
* // BOOL: true || false,
|
|
222
|
+
* // },
|
|
223
|
+
* // },
|
|
224
|
+
* // },
|
|
225
|
+
* // DeleteRequest: { // DeleteRequest
|
|
226
|
+
* // Key: { // Key // required
|
|
227
|
+
* // "<keys>": "<AttributeValue>",
|
|
228
|
+
* // },
|
|
229
|
+
* // },
|
|
230
|
+
* // },
|
|
231
|
+
* // ],
|
|
232
|
+
* // },
|
|
233
|
+
* // ItemCollectionMetrics: { // ItemCollectionMetricsPerTable
|
|
234
|
+
* // "<keys>": [ // ItemCollectionMetricsMultiple
|
|
235
|
+
* // { // ItemCollectionMetrics
|
|
236
|
+
* // ItemCollectionKey: { // ItemCollectionKeyAttributeMap
|
|
237
|
+
* // "<keys>": "<AttributeValue>",
|
|
238
|
+
* // },
|
|
239
|
+
* // SizeEstimateRangeGB: [ // ItemCollectionSizeEstimateRange
|
|
240
|
+
* // Number("double"),
|
|
241
|
+
* // ],
|
|
242
|
+
* // },
|
|
243
|
+
* // ],
|
|
244
|
+
* // },
|
|
245
|
+
* // ConsumedCapacity: [ // ConsumedCapacityMultiple
|
|
246
|
+
* // { // ConsumedCapacity
|
|
247
|
+
* // TableName: "STRING_VALUE",
|
|
248
|
+
* // CapacityUnits: Number("double"),
|
|
249
|
+
* // ReadCapacityUnits: Number("double"),
|
|
250
|
+
* // WriteCapacityUnits: Number("double"),
|
|
251
|
+
* // Table: { // Capacity
|
|
252
|
+
* // ReadCapacityUnits: Number("double"),
|
|
253
|
+
* // WriteCapacityUnits: Number("double"),
|
|
254
|
+
* // CapacityUnits: Number("double"),
|
|
255
|
+
* // },
|
|
256
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
257
|
+
* // "<keys>": {
|
|
258
|
+
* // ReadCapacityUnits: Number("double"),
|
|
259
|
+
* // WriteCapacityUnits: Number("double"),
|
|
260
|
+
* // CapacityUnits: Number("double"),
|
|
261
|
+
* // },
|
|
262
|
+
* // },
|
|
263
|
+
* // GlobalSecondaryIndexes: {
|
|
264
|
+
* // "<keys>": {
|
|
265
|
+
* // ReadCapacityUnits: Number("double"),
|
|
266
|
+
* // WriteCapacityUnits: Number("double"),
|
|
267
|
+
* // CapacityUnits: Number("double"),
|
|
268
|
+
* // },
|
|
269
|
+
* // },
|
|
270
|
+
* // },
|
|
271
|
+
* // ],
|
|
272
|
+
* // };
|
|
273
|
+
*
|
|
174
274
|
* ```
|
|
175
275
|
*
|
|
176
276
|
* @param BatchWriteItemCommandInput - {@link BatchWriteItemCommandInput}
|
|
@@ -203,6 +303,8 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
203
303
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
204
304
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
205
305
|
*
|
|
306
|
+
* @throws {@link DynamoDBServiceException}
|
|
307
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
206
308
|
*
|
|
207
309
|
* @example To add multiple items to a table
|
|
208
310
|
* ```javascript
|
|
@@ -61,6 +61,18 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
61
61
|
* };
|
|
62
62
|
* const command = new CreateBackupCommand(input);
|
|
63
63
|
* const response = await client.send(command);
|
|
64
|
+
* // { // CreateBackupOutput
|
|
65
|
+
* // BackupDetails: { // BackupDetails
|
|
66
|
+
* // BackupArn: "STRING_VALUE", // required
|
|
67
|
+
* // BackupName: "STRING_VALUE", // required
|
|
68
|
+
* // BackupSizeBytes: Number("long"),
|
|
69
|
+
* // BackupStatus: "CREATING" || "DELETED" || "AVAILABLE", // required
|
|
70
|
+
* // BackupType: "USER" || "SYSTEM" || "AWS_BACKUP", // required
|
|
71
|
+
* // BackupCreationDateTime: new Date("TIMESTAMP"), // required
|
|
72
|
+
* // BackupExpiryDateTime: new Date("TIMESTAMP"),
|
|
73
|
+
* // },
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
64
76
|
* ```
|
|
65
77
|
*
|
|
66
78
|
* @param CreateBackupCommandInput - {@link CreateBackupCommandInput}
|
|
@@ -102,6 +114,8 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
102
114
|
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
103
115
|
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
104
116
|
*
|
|
117
|
+
* @throws {@link DynamoDBServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
105
119
|
*
|
|
106
120
|
*/
|
|
107
121
|
export declare class CreateBackupCommand extends $Command<CreateBackupCommandInput, CreateBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -98,6 +98,40 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
98
98
|
* };
|
|
99
99
|
* const command = new CreateGlobalTableCommand(input);
|
|
100
100
|
* const response = await client.send(command);
|
|
101
|
+
* // { // CreateGlobalTableOutput
|
|
102
|
+
* // GlobalTableDescription: { // GlobalTableDescription
|
|
103
|
+
* // ReplicationGroup: [ // ReplicaDescriptionList
|
|
104
|
+
* // { // ReplicaDescription
|
|
105
|
+
* // RegionName: "STRING_VALUE",
|
|
106
|
+
* // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
|
|
107
|
+
* // ReplicaStatusDescription: "STRING_VALUE",
|
|
108
|
+
* // ReplicaStatusPercentProgress: "STRING_VALUE",
|
|
109
|
+
* // KMSMasterKeyId: "STRING_VALUE",
|
|
110
|
+
* // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
|
|
111
|
+
* // ReadCapacityUnits: Number("long"),
|
|
112
|
+
* // },
|
|
113
|
+
* // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
|
|
114
|
+
* // { // ReplicaGlobalSecondaryIndexDescription
|
|
115
|
+
* // IndexName: "STRING_VALUE",
|
|
116
|
+
* // ProvisionedThroughputOverride: {
|
|
117
|
+
* // ReadCapacityUnits: Number("long"),
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
|
|
122
|
+
* // ReplicaTableClassSummary: { // TableClassSummary
|
|
123
|
+
* // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
124
|
+
* // LastUpdateDateTime: new Date("TIMESTAMP"),
|
|
125
|
+
* // },
|
|
126
|
+
* // },
|
|
127
|
+
* // ],
|
|
128
|
+
* // GlobalTableArn: "STRING_VALUE",
|
|
129
|
+
* // CreationDateTime: new Date("TIMESTAMP"),
|
|
130
|
+
* // GlobalTableStatus: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING",
|
|
131
|
+
* // GlobalTableName: "STRING_VALUE",
|
|
132
|
+
* // },
|
|
133
|
+
* // };
|
|
134
|
+
*
|
|
101
135
|
* ```
|
|
102
136
|
*
|
|
103
137
|
* @param CreateGlobalTableCommandInput - {@link CreateGlobalTableCommandInput}
|
|
@@ -131,6 +165,8 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
131
165
|
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
132
166
|
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
133
167
|
*
|
|
168
|
+
* @throws {@link DynamoDBServiceException}
|
|
169
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
134
170
|
*
|
|
135
171
|
*/
|
|
136
172
|
export declare class CreateGlobalTableCommand extends $Command<CreateGlobalTableCommandInput, CreateGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -115,6 +115,144 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
115
115
|
* };
|
|
116
116
|
* const command = new CreateTableCommand(input);
|
|
117
117
|
* const response = await client.send(command);
|
|
118
|
+
* // { // CreateTableOutput
|
|
119
|
+
* // TableDescription: { // TableDescription
|
|
120
|
+
* // AttributeDefinitions: [ // AttributeDefinitions
|
|
121
|
+
* // { // AttributeDefinition
|
|
122
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
123
|
+
* // AttributeType: "S" || "N" || "B", // required
|
|
124
|
+
* // },
|
|
125
|
+
* // ],
|
|
126
|
+
* // TableName: "STRING_VALUE",
|
|
127
|
+
* // KeySchema: [ // KeySchema
|
|
128
|
+
* // { // KeySchemaElement
|
|
129
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
130
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
131
|
+
* // },
|
|
132
|
+
* // ],
|
|
133
|
+
* // TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
|
|
134
|
+
* // CreationDateTime: new Date("TIMESTAMP"),
|
|
135
|
+
* // ProvisionedThroughput: { // ProvisionedThroughputDescription
|
|
136
|
+
* // LastIncreaseDateTime: new Date("TIMESTAMP"),
|
|
137
|
+
* // LastDecreaseDateTime: new Date("TIMESTAMP"),
|
|
138
|
+
* // NumberOfDecreasesToday: Number("long"),
|
|
139
|
+
* // ReadCapacityUnits: Number("long"),
|
|
140
|
+
* // WriteCapacityUnits: Number("long"),
|
|
141
|
+
* // },
|
|
142
|
+
* // TableSizeBytes: Number("long"),
|
|
143
|
+
* // ItemCount: Number("long"),
|
|
144
|
+
* // TableArn: "STRING_VALUE",
|
|
145
|
+
* // TableId: "STRING_VALUE",
|
|
146
|
+
* // BillingModeSummary: { // BillingModeSummary
|
|
147
|
+
* // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
148
|
+
* // LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
|
|
149
|
+
* // },
|
|
150
|
+
* // LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
|
|
151
|
+
* // { // LocalSecondaryIndexDescription
|
|
152
|
+
* // IndexName: "STRING_VALUE",
|
|
153
|
+
* // KeySchema: [
|
|
154
|
+
* // {
|
|
155
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
156
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
157
|
+
* // },
|
|
158
|
+
* // ],
|
|
159
|
+
* // Projection: { // Projection
|
|
160
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
161
|
+
* // NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
162
|
+
* // "STRING_VALUE",
|
|
163
|
+
* // ],
|
|
164
|
+
* // },
|
|
165
|
+
* // IndexSizeBytes: Number("long"),
|
|
166
|
+
* // ItemCount: Number("long"),
|
|
167
|
+
* // IndexArn: "STRING_VALUE",
|
|
168
|
+
* // },
|
|
169
|
+
* // ],
|
|
170
|
+
* // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
|
|
171
|
+
* // { // GlobalSecondaryIndexDescription
|
|
172
|
+
* // IndexName: "STRING_VALUE",
|
|
173
|
+
* // KeySchema: [
|
|
174
|
+
* // {
|
|
175
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
176
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
177
|
+
* // },
|
|
178
|
+
* // ],
|
|
179
|
+
* // Projection: {
|
|
180
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
181
|
+
* // NonKeyAttributes: [
|
|
182
|
+
* // "STRING_VALUE",
|
|
183
|
+
* // ],
|
|
184
|
+
* // },
|
|
185
|
+
* // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
|
|
186
|
+
* // Backfilling: true || false,
|
|
187
|
+
* // ProvisionedThroughput: {
|
|
188
|
+
* // LastIncreaseDateTime: new Date("TIMESTAMP"),
|
|
189
|
+
* // LastDecreaseDateTime: new Date("TIMESTAMP"),
|
|
190
|
+
* // NumberOfDecreasesToday: Number("long"),
|
|
191
|
+
* // ReadCapacityUnits: Number("long"),
|
|
192
|
+
* // WriteCapacityUnits: Number("long"),
|
|
193
|
+
* // },
|
|
194
|
+
* // IndexSizeBytes: Number("long"),
|
|
195
|
+
* // ItemCount: Number("long"),
|
|
196
|
+
* // IndexArn: "STRING_VALUE",
|
|
197
|
+
* // },
|
|
198
|
+
* // ],
|
|
199
|
+
* // StreamSpecification: { // StreamSpecification
|
|
200
|
+
* // StreamEnabled: true || false, // required
|
|
201
|
+
* // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
202
|
+
* // },
|
|
203
|
+
* // LatestStreamLabel: "STRING_VALUE",
|
|
204
|
+
* // LatestStreamArn: "STRING_VALUE",
|
|
205
|
+
* // GlobalTableVersion: "STRING_VALUE",
|
|
206
|
+
* // Replicas: [ // ReplicaDescriptionList
|
|
207
|
+
* // { // ReplicaDescription
|
|
208
|
+
* // RegionName: "STRING_VALUE",
|
|
209
|
+
* // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
|
|
210
|
+
* // ReplicaStatusDescription: "STRING_VALUE",
|
|
211
|
+
* // ReplicaStatusPercentProgress: "STRING_VALUE",
|
|
212
|
+
* // KMSMasterKeyId: "STRING_VALUE",
|
|
213
|
+
* // ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
|
|
214
|
+
* // ReadCapacityUnits: Number("long"),
|
|
215
|
+
* // },
|
|
216
|
+
* // GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
|
|
217
|
+
* // { // ReplicaGlobalSecondaryIndexDescription
|
|
218
|
+
* // IndexName: "STRING_VALUE",
|
|
219
|
+
* // ProvisionedThroughputOverride: {
|
|
220
|
+
* // ReadCapacityUnits: Number("long"),
|
|
221
|
+
* // },
|
|
222
|
+
* // },
|
|
223
|
+
* // ],
|
|
224
|
+
* // ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
|
|
225
|
+
* // ReplicaTableClassSummary: { // TableClassSummary
|
|
226
|
+
* // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
227
|
+
* // LastUpdateDateTime: new Date("TIMESTAMP"),
|
|
228
|
+
* // },
|
|
229
|
+
* // },
|
|
230
|
+
* // ],
|
|
231
|
+
* // RestoreSummary: { // RestoreSummary
|
|
232
|
+
* // SourceBackupArn: "STRING_VALUE",
|
|
233
|
+
* // SourceTableArn: "STRING_VALUE",
|
|
234
|
+
* // RestoreDateTime: new Date("TIMESTAMP"), // required
|
|
235
|
+
* // RestoreInProgress: true || false, // required
|
|
236
|
+
* // },
|
|
237
|
+
* // SSEDescription: { // SSEDescription
|
|
238
|
+
* // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
|
|
239
|
+
* // SSEType: "AES256" || "KMS",
|
|
240
|
+
* // KMSMasterKeyArn: "STRING_VALUE",
|
|
241
|
+
* // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
|
|
242
|
+
* // },
|
|
243
|
+
* // ArchivalSummary: { // ArchivalSummary
|
|
244
|
+
* // ArchivalDateTime: new Date("TIMESTAMP"),
|
|
245
|
+
* // ArchivalReason: "STRING_VALUE",
|
|
246
|
+
* // ArchivalBackupArn: "STRING_VALUE",
|
|
247
|
+
* // },
|
|
248
|
+
* // TableClassSummary: {
|
|
249
|
+
* // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
|
|
250
|
+
* // LastUpdateDateTime: new Date("TIMESTAMP"),
|
|
251
|
+
* // },
|
|
252
|
+
* // DeletionProtectionEnabled: true || false,
|
|
253
|
+
* // },
|
|
254
|
+
* // };
|
|
255
|
+
*
|
|
118
256
|
* ```
|
|
119
257
|
*
|
|
120
258
|
* @param CreateTableCommandInput - {@link CreateTableCommandInput}
|
|
@@ -146,6 +284,8 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
146
284
|
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
147
285
|
* <code>CREATING</code> state.</p>
|
|
148
286
|
*
|
|
287
|
+
* @throws {@link DynamoDBServiceException}
|
|
288
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
149
289
|
*
|
|
150
290
|
* @example To create a table
|
|
151
291
|
* ```javascript
|
|
@@ -33,6 +33,93 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DeleteBackupCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // DeleteBackupOutput
|
|
37
|
+
* // BackupDescription: { // BackupDescription
|
|
38
|
+
* // BackupDetails: { // BackupDetails
|
|
39
|
+
* // BackupArn: "STRING_VALUE", // required
|
|
40
|
+
* // BackupName: "STRING_VALUE", // required
|
|
41
|
+
* // BackupSizeBytes: Number("long"),
|
|
42
|
+
* // BackupStatus: "CREATING" || "DELETED" || "AVAILABLE", // required
|
|
43
|
+
* // BackupType: "USER" || "SYSTEM" || "AWS_BACKUP", // required
|
|
44
|
+
* // BackupCreationDateTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // BackupExpiryDateTime: new Date("TIMESTAMP"),
|
|
46
|
+
* // },
|
|
47
|
+
* // SourceTableDetails: { // SourceTableDetails
|
|
48
|
+
* // TableName: "STRING_VALUE", // required
|
|
49
|
+
* // TableId: "STRING_VALUE", // required
|
|
50
|
+
* // TableArn: "STRING_VALUE",
|
|
51
|
+
* // TableSizeBytes: Number("long"),
|
|
52
|
+
* // KeySchema: [ // KeySchema // required
|
|
53
|
+
* // { // KeySchemaElement
|
|
54
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
55
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // TableCreationDateTime: new Date("TIMESTAMP"), // required
|
|
59
|
+
* // ProvisionedThroughput: { // ProvisionedThroughput
|
|
60
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
61
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ItemCount: Number("long"),
|
|
64
|
+
* // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
65
|
+
* // },
|
|
66
|
+
* // SourceTableFeatureDetails: { // SourceTableFeatureDetails
|
|
67
|
+
* // LocalSecondaryIndexes: [ // LocalSecondaryIndexes
|
|
68
|
+
* // { // LocalSecondaryIndexInfo
|
|
69
|
+
* // IndexName: "STRING_VALUE",
|
|
70
|
+
* // KeySchema: [
|
|
71
|
+
* // {
|
|
72
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
73
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // Projection: { // Projection
|
|
77
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
78
|
+
* // NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
79
|
+
* // "STRING_VALUE",
|
|
80
|
+
* // ],
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexes
|
|
85
|
+
* // { // GlobalSecondaryIndexInfo
|
|
86
|
+
* // IndexName: "STRING_VALUE",
|
|
87
|
+
* // KeySchema: [
|
|
88
|
+
* // {
|
|
89
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
90
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // Projection: {
|
|
94
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
95
|
+
* // NonKeyAttributes: [
|
|
96
|
+
* // "STRING_VALUE",
|
|
97
|
+
* // ],
|
|
98
|
+
* // },
|
|
99
|
+
* // ProvisionedThroughput: {
|
|
100
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
101
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
102
|
+
* // },
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // StreamDescription: { // StreamSpecification
|
|
106
|
+
* // StreamEnabled: true || false, // required
|
|
107
|
+
* // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
108
|
+
* // },
|
|
109
|
+
* // TimeToLiveDescription: { // TimeToLiveDescription
|
|
110
|
+
* // TimeToLiveStatus: "ENABLING" || "DISABLING" || "ENABLED" || "DISABLED",
|
|
111
|
+
* // AttributeName: "STRING_VALUE",
|
|
112
|
+
* // },
|
|
113
|
+
* // SSEDescription: { // SSEDescription
|
|
114
|
+
* // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
|
|
115
|
+
* // SSEType: "AES256" || "KMS",
|
|
116
|
+
* // KMSMasterKeyArn: "STRING_VALUE",
|
|
117
|
+
* // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // },
|
|
121
|
+
* // };
|
|
122
|
+
*
|
|
36
123
|
* ```
|
|
37
124
|
*
|
|
38
125
|
* @param DeleteBackupCommandInput - {@link DeleteBackupCommandInput}
|
|
@@ -66,6 +153,8 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
66
153
|
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
67
154
|
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
68
155
|
*
|
|
156
|
+
* @throws {@link DynamoDBServiceException}
|
|
157
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
69
158
|
*
|
|
70
159
|
*/
|
|
71
160
|
export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, DynamoDBClientResolvedConfig> {
|