@aws-sdk/client-dynamodb 3.321.1 → 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 +17 -17
|
@@ -41,6 +41,30 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new ExportTableToPointInTimeCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // ExportTableToPointInTimeOutput
|
|
45
|
+
* // ExportDescription: { // ExportDescription
|
|
46
|
+
* // ExportArn: "STRING_VALUE",
|
|
47
|
+
* // ExportStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED",
|
|
48
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // ExportManifest: "STRING_VALUE",
|
|
51
|
+
* // TableArn: "STRING_VALUE",
|
|
52
|
+
* // TableId: "STRING_VALUE",
|
|
53
|
+
* // ExportTime: new Date("TIMESTAMP"),
|
|
54
|
+
* // ClientToken: "STRING_VALUE",
|
|
55
|
+
* // S3Bucket: "STRING_VALUE",
|
|
56
|
+
* // S3BucketOwner: "STRING_VALUE",
|
|
57
|
+
* // S3Prefix: "STRING_VALUE",
|
|
58
|
+
* // S3SseAlgorithm: "AES256" || "KMS",
|
|
59
|
+
* // S3SseKmsKeyId: "STRING_VALUE",
|
|
60
|
+
* // FailureCode: "STRING_VALUE",
|
|
61
|
+
* // FailureMessage: "STRING_VALUE",
|
|
62
|
+
* // ExportFormat: "DYNAMODB_JSON" || "ION",
|
|
63
|
+
* // BilledSizeBytes: Number("long"),
|
|
64
|
+
* // ItemCount: Number("long"),
|
|
65
|
+
* // },
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
44
68
|
* ```
|
|
45
69
|
*
|
|
46
70
|
* @param ExportTableToPointInTimeCommandInput - {@link ExportTableToPointInTimeCommandInput}
|
|
@@ -79,6 +103,8 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin
|
|
|
79
103
|
* <p>A source table with the name <code>TableName</code> does not currently exist within
|
|
80
104
|
* the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
|
|
81
105
|
*
|
|
106
|
+
* @throws {@link DynamoDBServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
82
108
|
*
|
|
83
109
|
*/
|
|
84
110
|
export declare class ExportTableToPointInTimeCommand extends $Command<ExportTableToPointInTimeCommandInput, ExportTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -92,6 +92,79 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
|
|
|
92
92
|
* };
|
|
93
93
|
* const command = new GetItemCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
+
* // { // GetItemOutput
|
|
96
|
+
* // Item: { // AttributeMap
|
|
97
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
98
|
+
* // S: "STRING_VALUE",
|
|
99
|
+
* // N: "STRING_VALUE",
|
|
100
|
+
* // B: "BLOB_VALUE",
|
|
101
|
+
* // SS: [ // StringSetAttributeValue
|
|
102
|
+
* // "STRING_VALUE",
|
|
103
|
+
* // ],
|
|
104
|
+
* // NS: [ // NumberSetAttributeValue
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // BS: [ // BinarySetAttributeValue
|
|
108
|
+
* // "BLOB_VALUE",
|
|
109
|
+
* // ],
|
|
110
|
+
* // M: { // MapAttributeValue
|
|
111
|
+
* // "<keys>": {// Union: only one key present
|
|
112
|
+
* // S: "STRING_VALUE",
|
|
113
|
+
* // N: "STRING_VALUE",
|
|
114
|
+
* // B: "BLOB_VALUE",
|
|
115
|
+
* // SS: [
|
|
116
|
+
* // "STRING_VALUE",
|
|
117
|
+
* // ],
|
|
118
|
+
* // NS: [
|
|
119
|
+
* // "STRING_VALUE",
|
|
120
|
+
* // ],
|
|
121
|
+
* // BS: [
|
|
122
|
+
* // "BLOB_VALUE",
|
|
123
|
+
* // ],
|
|
124
|
+
* // M: {
|
|
125
|
+
* // "<keys>": "<AttributeValue>",
|
|
126
|
+
* // },
|
|
127
|
+
* // L: [ // ListAttributeValue
|
|
128
|
+
* // "<AttributeValue>",
|
|
129
|
+
* // ],
|
|
130
|
+
* // NULL: true || false,
|
|
131
|
+
* // BOOL: true || false,
|
|
132
|
+
* // },
|
|
133
|
+
* // },
|
|
134
|
+
* // L: [
|
|
135
|
+
* // "<AttributeValue>",
|
|
136
|
+
* // ],
|
|
137
|
+
* // NULL: true || false,
|
|
138
|
+
* // BOOL: true || false,
|
|
139
|
+
* // },
|
|
140
|
+
* // },
|
|
141
|
+
* // ConsumedCapacity: { // ConsumedCapacity
|
|
142
|
+
* // TableName: "STRING_VALUE",
|
|
143
|
+
* // CapacityUnits: Number("double"),
|
|
144
|
+
* // ReadCapacityUnits: Number("double"),
|
|
145
|
+
* // WriteCapacityUnits: Number("double"),
|
|
146
|
+
* // Table: { // Capacity
|
|
147
|
+
* // ReadCapacityUnits: Number("double"),
|
|
148
|
+
* // WriteCapacityUnits: Number("double"),
|
|
149
|
+
* // CapacityUnits: Number("double"),
|
|
150
|
+
* // },
|
|
151
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
152
|
+
* // "<keys>": {
|
|
153
|
+
* // ReadCapacityUnits: Number("double"),
|
|
154
|
+
* // WriteCapacityUnits: Number("double"),
|
|
155
|
+
* // CapacityUnits: Number("double"),
|
|
156
|
+
* // },
|
|
157
|
+
* // },
|
|
158
|
+
* // GlobalSecondaryIndexes: {
|
|
159
|
+
* // "<keys>": {
|
|
160
|
+
* // ReadCapacityUnits: Number("double"),
|
|
161
|
+
* // WriteCapacityUnits: Number("double"),
|
|
162
|
+
* // CapacityUnits: Number("double"),
|
|
163
|
+
* // },
|
|
164
|
+
* // },
|
|
165
|
+
* // },
|
|
166
|
+
* // };
|
|
167
|
+
*
|
|
95
168
|
* ```
|
|
96
169
|
*
|
|
97
170
|
* @param GetItemCommandInput - {@link GetItemCommandInput}
|
|
@@ -120,6 +193,8 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
|
|
|
120
193
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
121
194
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
122
195
|
*
|
|
196
|
+
* @throws {@link DynamoDBServiceException}
|
|
197
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
123
198
|
*
|
|
124
199
|
* @example To read an item from a table
|
|
125
200
|
* ```javascript
|
|
@@ -92,6 +92,86 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
|
|
|
92
92
|
* };
|
|
93
93
|
* const command = new ImportTableCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
+
* // { // ImportTableOutput
|
|
96
|
+
* // ImportTableDescription: { // ImportTableDescription
|
|
97
|
+
* // ImportArn: "STRING_VALUE",
|
|
98
|
+
* // ImportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELLING" || "CANCELLED" || "FAILED",
|
|
99
|
+
* // TableArn: "STRING_VALUE",
|
|
100
|
+
* // TableId: "STRING_VALUE",
|
|
101
|
+
* // ClientToken: "STRING_VALUE",
|
|
102
|
+
* // S3BucketSource: { // S3BucketSource
|
|
103
|
+
* // S3BucketOwner: "STRING_VALUE",
|
|
104
|
+
* // S3Bucket: "STRING_VALUE", // required
|
|
105
|
+
* // S3KeyPrefix: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // ErrorCount: Number("long"),
|
|
108
|
+
* // CloudWatchLogGroupArn: "STRING_VALUE",
|
|
109
|
+
* // InputFormat: "DYNAMODB_JSON" || "ION" || "CSV",
|
|
110
|
+
* // InputFormatOptions: { // InputFormatOptions
|
|
111
|
+
* // Csv: { // CsvOptions
|
|
112
|
+
* // Delimiter: "STRING_VALUE",
|
|
113
|
+
* // HeaderList: [ // CsvHeaderList
|
|
114
|
+
* // "STRING_VALUE",
|
|
115
|
+
* // ],
|
|
116
|
+
* // },
|
|
117
|
+
* // },
|
|
118
|
+
* // InputCompressionType: "GZIP" || "ZSTD" || "NONE",
|
|
119
|
+
* // TableCreationParameters: { // TableCreationParameters
|
|
120
|
+
* // TableName: "STRING_VALUE", // required
|
|
121
|
+
* // AttributeDefinitions: [ // AttributeDefinitions // required
|
|
122
|
+
* // { // AttributeDefinition
|
|
123
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
124
|
+
* // AttributeType: "S" || "N" || "B", // required
|
|
125
|
+
* // },
|
|
126
|
+
* // ],
|
|
127
|
+
* // KeySchema: [ // KeySchema // required
|
|
128
|
+
* // { // KeySchemaElement
|
|
129
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
130
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
131
|
+
* // },
|
|
132
|
+
* // ],
|
|
133
|
+
* // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
|
|
134
|
+
* // ProvisionedThroughput: { // ProvisionedThroughput
|
|
135
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
136
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
137
|
+
* // },
|
|
138
|
+
* // SSESpecification: { // SSESpecification
|
|
139
|
+
* // Enabled: true || false,
|
|
140
|
+
* // SSEType: "AES256" || "KMS",
|
|
141
|
+
* // KMSMasterKeyId: "STRING_VALUE",
|
|
142
|
+
* // },
|
|
143
|
+
* // GlobalSecondaryIndexes: [ // GlobalSecondaryIndexList
|
|
144
|
+
* // { // GlobalSecondaryIndex
|
|
145
|
+
* // IndexName: "STRING_VALUE", // required
|
|
146
|
+
* // KeySchema: [ // required
|
|
147
|
+
* // {
|
|
148
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
149
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
150
|
+
* // },
|
|
151
|
+
* // ],
|
|
152
|
+
* // Projection: { // Projection
|
|
153
|
+
* // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
|
|
154
|
+
* // NonKeyAttributes: [ // NonKeyAttributeNameList
|
|
155
|
+
* // "STRING_VALUE",
|
|
156
|
+
* // ],
|
|
157
|
+
* // },
|
|
158
|
+
* // ProvisionedThroughput: {
|
|
159
|
+
* // ReadCapacityUnits: Number("long"), // required
|
|
160
|
+
* // WriteCapacityUnits: Number("long"), // required
|
|
161
|
+
* // },
|
|
162
|
+
* // },
|
|
163
|
+
* // ],
|
|
164
|
+
* // },
|
|
165
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
166
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
167
|
+
* // ProcessedSizeBytes: Number("long"),
|
|
168
|
+
* // ProcessedItemCount: Number("long"),
|
|
169
|
+
* // ImportedItemCount: Number("long"),
|
|
170
|
+
* // FailureCode: "STRING_VALUE",
|
|
171
|
+
* // FailureMessage: "STRING_VALUE",
|
|
172
|
+
* // },
|
|
173
|
+
* // };
|
|
174
|
+
*
|
|
95
175
|
* ```
|
|
96
176
|
*
|
|
97
177
|
* @param ImportTableCommandInput - {@link ImportTableCommandInput}
|
|
@@ -125,6 +205,8 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
|
|
|
125
205
|
* attempted to recreate an existing table, or tried to delete a table currently in the
|
|
126
206
|
* <code>CREATING</code> state.</p>
|
|
127
207
|
*
|
|
208
|
+
* @throws {@link DynamoDBServiceException}
|
|
209
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
128
210
|
*
|
|
129
211
|
*/
|
|
130
212
|
export declare class ImportTableCommand extends $Command<ImportTableCommandInput, ImportTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -42,6 +42,24 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new ListBackupsCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // ListBackupsOutput
|
|
46
|
+
* // BackupSummaries: [ // BackupSummaries
|
|
47
|
+
* // { // BackupSummary
|
|
48
|
+
* // TableName: "STRING_VALUE",
|
|
49
|
+
* // TableId: "STRING_VALUE",
|
|
50
|
+
* // TableArn: "STRING_VALUE",
|
|
51
|
+
* // BackupArn: "STRING_VALUE",
|
|
52
|
+
* // BackupName: "STRING_VALUE",
|
|
53
|
+
* // BackupCreationDateTime: new Date("TIMESTAMP"),
|
|
54
|
+
* // BackupExpiryDateTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // BackupStatus: "CREATING" || "DELETED" || "AVAILABLE",
|
|
56
|
+
* // BackupType: "USER" || "SYSTEM" || "AWS_BACKUP",
|
|
57
|
+
* // BackupSizeBytes: Number("long"),
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // LastEvaluatedBackupArn: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
45
63
|
* ```
|
|
46
64
|
*
|
|
47
65
|
* @param ListBackupsCommandInput - {@link ListBackupsCommandInput}
|
|
@@ -55,6 +73,8 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
|
|
|
55
73
|
*
|
|
56
74
|
* @throws {@link InvalidEndpointException} (client fault)
|
|
57
75
|
*
|
|
76
|
+
* @throws {@link DynamoDBServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
58
78
|
*
|
|
59
79
|
*/
|
|
60
80
|
export declare class ListBackupsCommand extends $Command<ListBackupsCommandInput, ListBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -34,6 +34,17 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListContributorInsightsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListContributorInsightsOutput
|
|
38
|
+
* // ContributorInsightsSummaries: [ // ContributorInsightsSummaries
|
|
39
|
+
* // { // ContributorInsightsSummary
|
|
40
|
+
* // TableName: "STRING_VALUE",
|
|
41
|
+
* // IndexName: "STRING_VALUE",
|
|
42
|
+
* // ContributorInsightsStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "FAILED",
|
|
43
|
+
* // },
|
|
44
|
+
* // ],
|
|
45
|
+
* // NextToken: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
37
48
|
* ```
|
|
38
49
|
*
|
|
39
50
|
* @param ListContributorInsightsCommandInput - {@link ListContributorInsightsCommandInput}
|
|
@@ -49,6 +60,8 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
|
|
|
49
60
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
50
61
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
51
62
|
*
|
|
63
|
+
* @throws {@link DynamoDBServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
52
65
|
*
|
|
53
66
|
*/
|
|
54
67
|
export declare class ListContributorInsightsCommand extends $Command<ListContributorInsightsCommandInput, ListContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -33,6 +33,16 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListExportsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListExportsOutput
|
|
37
|
+
* // ExportSummaries: [ // ExportSummaries
|
|
38
|
+
* // { // ExportSummary
|
|
39
|
+
* // ExportArn: "STRING_VALUE",
|
|
40
|
+
* // ExportStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED",
|
|
41
|
+
* // },
|
|
42
|
+
* // ],
|
|
43
|
+
* // NextToken: "STRING_VALUE",
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
36
46
|
* ```
|
|
37
47
|
*
|
|
38
48
|
* @param ListExportsCommandInput - {@link ListExportsCommandInput}
|
|
@@ -57,6 +67,8 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
57
67
|
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
58
68
|
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
59
69
|
*
|
|
70
|
+
* @throws {@link DynamoDBServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
60
72
|
*
|
|
61
73
|
*/
|
|
62
74
|
export declare class ListExportsCommand extends $Command<ListExportsCommandInput, ListExportsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -45,6 +45,20 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new ListGlobalTablesCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // ListGlobalTablesOutput
|
|
49
|
+
* // GlobalTables: [ // GlobalTableList
|
|
50
|
+
* // { // GlobalTable
|
|
51
|
+
* // GlobalTableName: "STRING_VALUE",
|
|
52
|
+
* // ReplicationGroup: [ // ReplicaList
|
|
53
|
+
* // { // Replica
|
|
54
|
+
* // RegionName: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // LastEvaluatedGlobalTableName: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
48
62
|
* ```
|
|
49
63
|
*
|
|
50
64
|
* @param ListGlobalTablesCommandInput - {@link ListGlobalTablesCommandInput}
|
|
@@ -58,6 +72,8 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
|
|
|
58
72
|
*
|
|
59
73
|
* @throws {@link InvalidEndpointException} (client fault)
|
|
60
74
|
*
|
|
75
|
+
* @throws {@link DynamoDBServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
61
77
|
*
|
|
62
78
|
*/
|
|
63
79
|
export declare class ListGlobalTablesCommand extends $Command<ListGlobalTablesCommandInput, ListGlobalTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -33,6 +33,26 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListImportsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListImportsOutput
|
|
37
|
+
* // ImportSummaryList: [ // ImportSummaryList
|
|
38
|
+
* // { // ImportSummary
|
|
39
|
+
* // ImportArn: "STRING_VALUE",
|
|
40
|
+
* // ImportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELLING" || "CANCELLED" || "FAILED",
|
|
41
|
+
* // TableArn: "STRING_VALUE",
|
|
42
|
+
* // S3BucketSource: { // S3BucketSource
|
|
43
|
+
* // S3BucketOwner: "STRING_VALUE",
|
|
44
|
+
* // S3Bucket: "STRING_VALUE", // required
|
|
45
|
+
* // S3KeyPrefix: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // CloudWatchLogGroupArn: "STRING_VALUE",
|
|
48
|
+
* // InputFormat: "DYNAMODB_JSON" || "ION" || "CSV",
|
|
49
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // NextToken: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
36
56
|
* ```
|
|
37
57
|
*
|
|
38
58
|
* @param ListImportsCommandInput - {@link ListImportsCommandInput}
|
|
@@ -54,6 +74,8 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
|
|
|
54
74
|
* <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
|
|
55
75
|
* <p>There is a soft account quota of 2,500 tables.</p>
|
|
56
76
|
*
|
|
77
|
+
* @throws {@link DynamoDBServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
57
79
|
*
|
|
58
80
|
*/
|
|
59
81
|
export declare class ListImportsCommand extends $Command<ListImportsCommandInput, ListImportsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -34,6 +34,13 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListTablesCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListTablesOutput
|
|
38
|
+
* // TableNames: [ // TableNameList
|
|
39
|
+
* // "STRING_VALUE",
|
|
40
|
+
* // ],
|
|
41
|
+
* // LastEvaluatedTableName: "STRING_VALUE",
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
37
44
|
* ```
|
|
38
45
|
*
|
|
39
46
|
* @param ListTablesCommandInput - {@link ListTablesCommandInput}
|
|
@@ -47,6 +54,8 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
|
|
|
47
54
|
*
|
|
48
55
|
* @throws {@link InvalidEndpointException} (client fault)
|
|
49
56
|
*
|
|
57
|
+
* @throws {@link DynamoDBServiceException}
|
|
58
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
50
59
|
*
|
|
51
60
|
* @example To list tables
|
|
52
61
|
* ```javascript
|
|
@@ -35,6 +35,16 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new ListTagsOfResourceCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // ListTagsOfResourceOutput
|
|
39
|
+
* // Tags: [ // TagList
|
|
40
|
+
* // { // Tag
|
|
41
|
+
* // Key: "STRING_VALUE", // required
|
|
42
|
+
* // Value: "STRING_VALUE", // required
|
|
43
|
+
* // },
|
|
44
|
+
* // ],
|
|
45
|
+
* // NextToken: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
38
48
|
* ```
|
|
39
49
|
*
|
|
40
50
|
* @param ListTagsOfResourceCommandInput - {@link ListTagsOfResourceCommandInput}
|
|
@@ -52,6 +62,8 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
|
|
|
52
62
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
53
63
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
54
64
|
*
|
|
65
|
+
* @throws {@link DynamoDBServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
55
67
|
*
|
|
56
68
|
*/
|
|
57
69
|
export declare class ListTagsOfResourceCommand extends $Command<ListTagsOfResourceCommandInput, ListTagsOfResourceCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -118,6 +118,87 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
|
|
|
118
118
|
* };
|
|
119
119
|
* const command = new PutItemCommand(input);
|
|
120
120
|
* const response = await client.send(command);
|
|
121
|
+
* // { // PutItemOutput
|
|
122
|
+
* // Attributes: { // AttributeMap
|
|
123
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
124
|
+
* // S: "STRING_VALUE",
|
|
125
|
+
* // N: "STRING_VALUE",
|
|
126
|
+
* // B: "BLOB_VALUE",
|
|
127
|
+
* // SS: [ // StringSetAttributeValue
|
|
128
|
+
* // "STRING_VALUE",
|
|
129
|
+
* // ],
|
|
130
|
+
* // NS: [ // NumberSetAttributeValue
|
|
131
|
+
* // "STRING_VALUE",
|
|
132
|
+
* // ],
|
|
133
|
+
* // BS: [ // BinarySetAttributeValue
|
|
134
|
+
* // "BLOB_VALUE",
|
|
135
|
+
* // ],
|
|
136
|
+
* // M: { // MapAttributeValue
|
|
137
|
+
* // "<keys>": {// Union: only one key present
|
|
138
|
+
* // S: "STRING_VALUE",
|
|
139
|
+
* // N: "STRING_VALUE",
|
|
140
|
+
* // B: "BLOB_VALUE",
|
|
141
|
+
* // SS: [
|
|
142
|
+
* // "STRING_VALUE",
|
|
143
|
+
* // ],
|
|
144
|
+
* // NS: [
|
|
145
|
+
* // "STRING_VALUE",
|
|
146
|
+
* // ],
|
|
147
|
+
* // BS: [
|
|
148
|
+
* // "BLOB_VALUE",
|
|
149
|
+
* // ],
|
|
150
|
+
* // M: {
|
|
151
|
+
* // "<keys>": "<AttributeValue>",
|
|
152
|
+
* // },
|
|
153
|
+
* // L: [ // ListAttributeValue
|
|
154
|
+
* // "<AttributeValue>",
|
|
155
|
+
* // ],
|
|
156
|
+
* // NULL: true || false,
|
|
157
|
+
* // BOOL: true || false,
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // L: [
|
|
161
|
+
* // "<AttributeValue>",
|
|
162
|
+
* // ],
|
|
163
|
+
* // NULL: true || false,
|
|
164
|
+
* // BOOL: true || false,
|
|
165
|
+
* // },
|
|
166
|
+
* // },
|
|
167
|
+
* // ConsumedCapacity: { // ConsumedCapacity
|
|
168
|
+
* // TableName: "STRING_VALUE",
|
|
169
|
+
* // CapacityUnits: Number("double"),
|
|
170
|
+
* // ReadCapacityUnits: Number("double"),
|
|
171
|
+
* // WriteCapacityUnits: Number("double"),
|
|
172
|
+
* // Table: { // Capacity
|
|
173
|
+
* // ReadCapacityUnits: Number("double"),
|
|
174
|
+
* // WriteCapacityUnits: Number("double"),
|
|
175
|
+
* // CapacityUnits: Number("double"),
|
|
176
|
+
* // },
|
|
177
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
178
|
+
* // "<keys>": {
|
|
179
|
+
* // ReadCapacityUnits: Number("double"),
|
|
180
|
+
* // WriteCapacityUnits: Number("double"),
|
|
181
|
+
* // CapacityUnits: Number("double"),
|
|
182
|
+
* // },
|
|
183
|
+
* // },
|
|
184
|
+
* // GlobalSecondaryIndexes: {
|
|
185
|
+
* // "<keys>": {
|
|
186
|
+
* // ReadCapacityUnits: Number("double"),
|
|
187
|
+
* // WriteCapacityUnits: Number("double"),
|
|
188
|
+
* // CapacityUnits: Number("double"),
|
|
189
|
+
* // },
|
|
190
|
+
* // },
|
|
191
|
+
* // },
|
|
192
|
+
* // ItemCollectionMetrics: { // ItemCollectionMetrics
|
|
193
|
+
* // ItemCollectionKey: { // ItemCollectionKeyAttributeMap
|
|
194
|
+
* // "<keys>": "<AttributeValue>",
|
|
195
|
+
* // },
|
|
196
|
+
* // SizeEstimateRangeGB: [ // ItemCollectionSizeEstimateRange
|
|
197
|
+
* // Number("double"),
|
|
198
|
+
* // ],
|
|
199
|
+
* // },
|
|
200
|
+
* // };
|
|
201
|
+
*
|
|
121
202
|
* ```
|
|
122
203
|
*
|
|
123
204
|
* @param PutItemCommandInput - {@link PutItemCommandInput}
|
|
@@ -157,6 +238,8 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
|
|
|
157
238
|
* <p>Operation was rejected because there is an ongoing transaction for the
|
|
158
239
|
* item.</p>
|
|
159
240
|
*
|
|
241
|
+
* @throws {@link DynamoDBServiceException}
|
|
242
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
160
243
|
*
|
|
161
244
|
* @example To add an item to a table
|
|
162
245
|
* ```javascript
|
|
@@ -161,6 +161,86 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
|
|
|
161
161
|
* };
|
|
162
162
|
* const command = new QueryCommand(input);
|
|
163
163
|
* const response = await client.send(command);
|
|
164
|
+
* // { // QueryOutput
|
|
165
|
+
* // Items: [ // ItemList
|
|
166
|
+
* // { // AttributeMap
|
|
167
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
168
|
+
* // S: "STRING_VALUE",
|
|
169
|
+
* // N: "STRING_VALUE",
|
|
170
|
+
* // B: "BLOB_VALUE",
|
|
171
|
+
* // SS: [ // StringSetAttributeValue
|
|
172
|
+
* // "STRING_VALUE",
|
|
173
|
+
* // ],
|
|
174
|
+
* // NS: [ // NumberSetAttributeValue
|
|
175
|
+
* // "STRING_VALUE",
|
|
176
|
+
* // ],
|
|
177
|
+
* // BS: [ // BinarySetAttributeValue
|
|
178
|
+
* // "BLOB_VALUE",
|
|
179
|
+
* // ],
|
|
180
|
+
* // M: { // MapAttributeValue
|
|
181
|
+
* // "<keys>": {// Union: only one key present
|
|
182
|
+
* // S: "STRING_VALUE",
|
|
183
|
+
* // N: "STRING_VALUE",
|
|
184
|
+
* // B: "BLOB_VALUE",
|
|
185
|
+
* // SS: [
|
|
186
|
+
* // "STRING_VALUE",
|
|
187
|
+
* // ],
|
|
188
|
+
* // NS: [
|
|
189
|
+
* // "STRING_VALUE",
|
|
190
|
+
* // ],
|
|
191
|
+
* // BS: [
|
|
192
|
+
* // "BLOB_VALUE",
|
|
193
|
+
* // ],
|
|
194
|
+
* // M: {
|
|
195
|
+
* // "<keys>": "<AttributeValue>",
|
|
196
|
+
* // },
|
|
197
|
+
* // L: [ // ListAttributeValue
|
|
198
|
+
* // "<AttributeValue>",
|
|
199
|
+
* // ],
|
|
200
|
+
* // NULL: true || false,
|
|
201
|
+
* // BOOL: true || false,
|
|
202
|
+
* // },
|
|
203
|
+
* // },
|
|
204
|
+
* // L: [
|
|
205
|
+
* // "<AttributeValue>",
|
|
206
|
+
* // ],
|
|
207
|
+
* // NULL: true || false,
|
|
208
|
+
* // BOOL: true || false,
|
|
209
|
+
* // },
|
|
210
|
+
* // },
|
|
211
|
+
* // ],
|
|
212
|
+
* // Count: Number("int"),
|
|
213
|
+
* // ScannedCount: Number("int"),
|
|
214
|
+
* // LastEvaluatedKey: { // Key
|
|
215
|
+
* // "<keys>": "<AttributeValue>",
|
|
216
|
+
* // },
|
|
217
|
+
* // ConsumedCapacity: { // ConsumedCapacity
|
|
218
|
+
* // TableName: "STRING_VALUE",
|
|
219
|
+
* // CapacityUnits: Number("double"),
|
|
220
|
+
* // ReadCapacityUnits: Number("double"),
|
|
221
|
+
* // WriteCapacityUnits: Number("double"),
|
|
222
|
+
* // Table: { // Capacity
|
|
223
|
+
* // ReadCapacityUnits: Number("double"),
|
|
224
|
+
* // WriteCapacityUnits: Number("double"),
|
|
225
|
+
* // CapacityUnits: Number("double"),
|
|
226
|
+
* // },
|
|
227
|
+
* // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
|
|
228
|
+
* // "<keys>": {
|
|
229
|
+
* // ReadCapacityUnits: Number("double"),
|
|
230
|
+
* // WriteCapacityUnits: Number("double"),
|
|
231
|
+
* // CapacityUnits: Number("double"),
|
|
232
|
+
* // },
|
|
233
|
+
* // },
|
|
234
|
+
* // GlobalSecondaryIndexes: {
|
|
235
|
+
* // "<keys>": {
|
|
236
|
+
* // ReadCapacityUnits: Number("double"),
|
|
237
|
+
* // WriteCapacityUnits: Number("double"),
|
|
238
|
+
* // CapacityUnits: Number("double"),
|
|
239
|
+
* // },
|
|
240
|
+
* // },
|
|
241
|
+
* // },
|
|
242
|
+
* // };
|
|
243
|
+
*
|
|
164
244
|
* ```
|
|
165
245
|
*
|
|
166
246
|
* @param QueryCommandInput - {@link QueryCommandInput}
|
|
@@ -189,6 +269,8 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
|
|
|
189
269
|
* <p>The operation tried to access a nonexistent table or index. The resource might not
|
|
190
270
|
* be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
191
271
|
*
|
|
272
|
+
* @throws {@link DynamoDBServiceException}
|
|
273
|
+
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
|
|
192
274
|
*
|
|
193
275
|
* @example To query an item
|
|
194
276
|
* ```javascript
|