@aws-lite/dynamodb-types 0.3.8 → 0.3.9
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/index.d.ts +53 -53
- package/package.json +3 -3
package/index.d.ts
CHANGED
|
@@ -63,311 +63,311 @@ declare interface AwsLiteDynamoDB {
|
|
|
63
63
|
/**
|
|
64
64
|
* @description
|
|
65
65
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchExecuteStatement.html DynamoDB: BatchExecuteStatement}
|
|
66
|
-
* - aws-lite docs: {@link https://github.com/
|
|
66
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchExecuteStatement DynamoDB: BatchExecuteStatement}
|
|
67
67
|
*/
|
|
68
68
|
BatchExecuteStatement: (input: { Statements: any[], ReturnConsumedCapacity?: string }) => Promise<BatchExecuteStatementResponse>
|
|
69
69
|
/**
|
|
70
70
|
* @description
|
|
71
71
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchGetItem.html DynamoDB: BatchGetItem}
|
|
72
|
-
* - aws-lite docs: {@link https://github.com/
|
|
72
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchGetItem DynamoDB: BatchGetItem}
|
|
73
73
|
*/
|
|
74
74
|
BatchGetItem: (input: { RequestItems: Record<string, any>, ReturnConsumedCapacity?: string }) => Promise<BatchGetItemResponse>
|
|
75
75
|
/**
|
|
76
76
|
* @description
|
|
77
77
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html DynamoDB: BatchWriteItem}
|
|
78
|
-
* - aws-lite docs: {@link https://github.com/
|
|
78
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchWriteItem DynamoDB: BatchWriteItem}
|
|
79
79
|
*/
|
|
80
80
|
BatchWriteItem: (input: { RequestItems: Record<string, any>, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string }) => Promise<BatchWriteItemResponse>
|
|
81
81
|
/**
|
|
82
82
|
* @description
|
|
83
83
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateBackup.html DynamoDB: CreateBackup}
|
|
84
|
-
* - aws-lite docs: {@link https://github.com/
|
|
84
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateBackup DynamoDB: CreateBackup}
|
|
85
85
|
*/
|
|
86
86
|
CreateBackup: (input: { TableName: string, BackupName: string }) => Promise<CreateBackupResponse>
|
|
87
87
|
/**
|
|
88
88
|
* @description
|
|
89
89
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateGlobalTable.html DynamoDB: CreateGlobalTable}
|
|
90
|
-
* - aws-lite docs: {@link https://github.com/
|
|
90
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateGlobalTable DynamoDB: CreateGlobalTable}
|
|
91
91
|
*/
|
|
92
92
|
CreateGlobalTable: (input: { GlobalTableName: string, ReplicationGroup: any[] }) => Promise<CreateGlobalTableResponse>
|
|
93
93
|
/**
|
|
94
94
|
* @description
|
|
95
95
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html DynamoDB: CreateTable}
|
|
96
|
-
* - aws-lite docs: {@link https://github.com/
|
|
96
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateTable DynamoDB: CreateTable}
|
|
97
97
|
*/
|
|
98
98
|
CreateTable: (input: { TableName: string, AttributeDefinitions: any[], KeySchema: any[], BillingMode?: string, DeletionProtectionEnabled?: boolean, GlobalSecondaryIndexes?: any[], LocalSecondaryIndexes?: any[], ProvisionedThroughput?: Record<string, any>, SSESpecification?: Record<string, any>, StreamSpecification?: Record<string, any>, TableClass?: string, Tags?: any[] }) => Promise<CreateTableResponse>
|
|
99
99
|
/**
|
|
100
100
|
* @description
|
|
101
101
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteBackup.html DynamoDB: DeleteBackup}
|
|
102
|
-
* - aws-lite docs: {@link https://github.com/
|
|
102
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteBackup DynamoDB: DeleteBackup}
|
|
103
103
|
*/
|
|
104
104
|
DeleteBackup: (input: { BackupArn: string }) => Promise<DeleteBackupResponse>
|
|
105
105
|
/**
|
|
106
106
|
* @description
|
|
107
107
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html DynamoDB: DeleteItem}
|
|
108
|
-
* - aws-lite docs: {@link https://github.com/
|
|
108
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteItem DynamoDB: DeleteItem}
|
|
109
109
|
*/
|
|
110
110
|
DeleteItem: (input: { TableName: string, Key: Record<string, any>, ConditionalOperator?: string, ConditionExpression?: string, Expected?: Record<string, any>, ExpressionAttributeNames?: Record<string, any>, ExpressionAttributeValues?: Record<string, any>, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string, ReturnValues?: string, ReturnValuesOnConditionCheckFailure?: string }) => Promise<DeleteItemResponse>
|
|
111
111
|
/**
|
|
112
112
|
* @description
|
|
113
113
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html DynamoDB: DeleteTable}
|
|
114
|
-
* - aws-lite docs: {@link https://github.com/
|
|
114
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteTable DynamoDB: DeleteTable}
|
|
115
115
|
*/
|
|
116
116
|
DeleteTable: (input: { TableName: string }) => Promise<DeleteTableResponse>
|
|
117
117
|
/**
|
|
118
118
|
* @description
|
|
119
119
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeBackup.html DynamoDB: DescribeBackup}
|
|
120
|
-
* - aws-lite docs: {@link https://github.com/
|
|
120
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeBackup DynamoDB: DescribeBackup}
|
|
121
121
|
*/
|
|
122
122
|
DescribeBackup: (input: { BackupArn: string }) => Promise<DescribeBackupResponse>
|
|
123
123
|
/**
|
|
124
124
|
* @description
|
|
125
125
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeContinuousBackups.html DynamoDB: DescribeContinuousBackups}
|
|
126
|
-
* - aws-lite docs: {@link https://github.com/
|
|
126
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeContinuousBackups DynamoDB: DescribeContinuousBackups}
|
|
127
127
|
*/
|
|
128
128
|
DescribeContinuousBackups: (input: { TableName: string }) => Promise<DescribeContinuousBackupsResponse>
|
|
129
129
|
/**
|
|
130
130
|
* @description
|
|
131
131
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeContributorInsights.html DynamoDB: DescribeContributorInsights}
|
|
132
|
-
* - aws-lite docs: {@link https://github.com/
|
|
132
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeContributorInsights DynamoDB: DescribeContributorInsights}
|
|
133
133
|
*/
|
|
134
134
|
DescribeContributorInsights: (input: { TableName: string, IndexName?: string }) => Promise<DescribeContributorInsightsResponse>
|
|
135
|
-
/** @description aws-lite docs: {@link https://github.com/
|
|
135
|
+
/** @description aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeEndpoints DynamoDB: DescribeEndpoints} */
|
|
136
136
|
DescribeEndpoints: () => Promise<DescribeEndpointsResponse>
|
|
137
137
|
/**
|
|
138
138
|
* @description
|
|
139
139
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeExport.html DynamoDB: DescribeExport}
|
|
140
|
-
* - aws-lite docs: {@link https://github.com/
|
|
140
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeExport DynamoDB: DescribeExport}
|
|
141
141
|
*/
|
|
142
142
|
DescribeExport: (input: { ExportArn: string }) => Promise<DescribeExportResponse>
|
|
143
143
|
/**
|
|
144
144
|
* @description
|
|
145
145
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeGlobalTable.html DynamoDB: DescribeGlobalTable}
|
|
146
|
-
* - aws-lite docs: {@link https://github.com/
|
|
146
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeGlobalTable DynamoDB: DescribeGlobalTable}
|
|
147
147
|
*/
|
|
148
148
|
DescribeGlobalTable: (input: { GlobalTableName: string }) => Promise<DescribeGlobalTableResponse>
|
|
149
149
|
/**
|
|
150
150
|
* @description
|
|
151
151
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeGlobalTableSettings.html DynamoDB: DescribeGlobalTableSettings}
|
|
152
|
-
* - aws-lite docs: {@link https://github.com/
|
|
152
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeGlobalTableSettings DynamoDB: DescribeGlobalTableSettings}
|
|
153
153
|
*/
|
|
154
154
|
DescribeGlobalTableSettings: (input: { GlobalTableName: string }) => Promise<DescribeGlobalTableSettingsResponse>
|
|
155
155
|
/**
|
|
156
156
|
* @description
|
|
157
157
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeImport.html DynamoDB: DescribeImport}
|
|
158
|
-
* - aws-lite docs: {@link https://github.com/
|
|
158
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeImport DynamoDB: DescribeImport}
|
|
159
159
|
*/
|
|
160
160
|
DescribeImport: (input: { ImportArn: string }) => Promise<DescribeImportResponse>
|
|
161
161
|
/**
|
|
162
162
|
* @description
|
|
163
163
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeKinesisStreamingDestination.html DynamoDB: DescribeKinesisStreamingDestination}
|
|
164
|
-
* - aws-lite docs: {@link https://github.com/
|
|
164
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeKinesisStreamingDestination DynamoDB: DescribeKinesisStreamingDestination}
|
|
165
165
|
*/
|
|
166
166
|
DescribeKinesisStreamingDestination: (input: { TableName: string }) => Promise<DescribeKinesisStreamingDestinationResponse>
|
|
167
|
-
/** @description aws-lite docs: {@link https://github.com/
|
|
167
|
+
/** @description aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeLimits DynamoDB: DescribeLimits} */
|
|
168
168
|
DescribeLimits: () => Promise<DescribeLimitsResponse>
|
|
169
169
|
/**
|
|
170
170
|
* @description
|
|
171
171
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html DynamoDB: DescribeTable}
|
|
172
|
-
* - aws-lite docs: {@link https://github.com/
|
|
172
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTable DynamoDB: DescribeTable}
|
|
173
173
|
*/
|
|
174
174
|
DescribeTable: (input: { TableName: string }) => Promise<DescribeTableResponse>
|
|
175
175
|
/**
|
|
176
176
|
* @description
|
|
177
177
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTableReplicaAutoScaling.html DynamoDB: DescribeTableReplicaAutoScaling}
|
|
178
|
-
* - aws-lite docs: {@link https://github.com/
|
|
178
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTableReplicaAutoScaling DynamoDB: DescribeTableReplicaAutoScaling}
|
|
179
179
|
*/
|
|
180
180
|
DescribeTableReplicaAutoScaling: (input: { TableName: string }) => Promise<DescribeTableReplicaAutoScalingResponse>
|
|
181
181
|
/**
|
|
182
182
|
* @description
|
|
183
183
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTimeToLive.html DynamoDB: DescribeTimeToLive}
|
|
184
|
-
* - aws-lite docs: {@link https://github.com/
|
|
184
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTimeToLive DynamoDB: DescribeTimeToLive}
|
|
185
185
|
*/
|
|
186
186
|
DescribeTimeToLive: (input: { TableName: string }) => Promise<DescribeTimeToLiveResponse>
|
|
187
187
|
/**
|
|
188
188
|
* @description
|
|
189
189
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DisableKinesisStreamingDestination.html DynamoDB: DisableKinesisStreamingDestination}
|
|
190
|
-
* - aws-lite docs: {@link https://github.com/
|
|
190
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#DisableKinesisStreamingDestination DynamoDB: DisableKinesisStreamingDestination}
|
|
191
191
|
*/
|
|
192
192
|
DisableKinesisStreamingDestination: (input: { TableName: string, StreamArn: string }) => Promise<DisableKinesisStreamingDestinationResponse>
|
|
193
193
|
/**
|
|
194
194
|
* @description
|
|
195
195
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_EnableKinesisStreamingDestination.html DynamoDB: EnableKinesisStreamingDestination}
|
|
196
|
-
* - aws-lite docs: {@link https://github.com/
|
|
196
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#EnableKinesisStreamingDestination DynamoDB: EnableKinesisStreamingDestination}
|
|
197
197
|
*/
|
|
198
198
|
EnableKinesisStreamingDestination: (input: { TableName: string, StreamArn: string }) => Promise<EnableKinesisStreamingDestinationResponse>
|
|
199
199
|
/**
|
|
200
200
|
* @description
|
|
201
201
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ExecuteStatement.html DynamoDB: ExecuteStatement}
|
|
202
|
-
* - aws-lite docs: {@link https://github.com/
|
|
202
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ExecuteStatement DynamoDB: ExecuteStatement}
|
|
203
203
|
*/
|
|
204
204
|
ExecuteStatement: (input: { TableName: string, Statement: string, ConsistentRead?: boolean, Limit?: number, NextToken?: string, Parameters?: any[], ReturnConsumedCapacity?: string, ReturnValuesOnConditionCheckFailure?: string }) => Promise<ExecuteStatementResponse>
|
|
205
205
|
/**
|
|
206
206
|
* @description
|
|
207
207
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ExecuteTransaction.html DynamoDB: ExecuteTransaction}
|
|
208
|
-
* - aws-lite docs: {@link https://github.com/
|
|
208
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ExecuteTransaction DynamoDB: ExecuteTransaction}
|
|
209
209
|
*/
|
|
210
210
|
ExecuteTransaction: (input: { TableName: string, TransactStatements: any[], ClientRequestToken?: string, ReturnConsumedCapacity?: string }) => Promise<ExecuteTransactionResponse>
|
|
211
211
|
/**
|
|
212
212
|
* @description
|
|
213
213
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ExportTableToPointInTime.html DynamoDB: ExportTableToPointInTime}
|
|
214
|
-
* - aws-lite docs: {@link https://github.com/
|
|
214
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ExportTableToPointInTime DynamoDB: ExportTableToPointInTime}
|
|
215
215
|
*/
|
|
216
216
|
ExportTableToPointInTime: (input: { S3Bucket: string, TableArn: string, ClientToken?: string, ExportFormat?: string, ExportTime?: number, S3BucketOwner?: string, S3Prefix?: string, S3SseAlgorithm?: string, S3SseKmsKeyId?: string }) => Promise<ExportTableToPointInTimeResponse>
|
|
217
217
|
/**
|
|
218
218
|
* @description
|
|
219
219
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html DynamoDB: GetItem}
|
|
220
|
-
* - aws-lite docs: {@link https://github.com/
|
|
220
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#GetItem DynamoDB: GetItem}
|
|
221
221
|
*/
|
|
222
222
|
GetItem: (input: { TableName: string, Key: Record<string, any>, AttributesToGet?: any[], ConsistentRead?: boolean, ExpressionAttributeNames?: Record<string, any>, ProjectionExpression?: string, ReturnConsumedCapacity?: string }) => Promise<GetItemResponse>
|
|
223
223
|
/**
|
|
224
224
|
* @description
|
|
225
225
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ImportTable.html DynamoDB: ImportTable}
|
|
226
|
-
* - aws-lite docs: {@link https://github.com/
|
|
226
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ImportTable DynamoDB: ImportTable}
|
|
227
227
|
*/
|
|
228
228
|
ImportTable: (input: { InputFormat: string, S3BucketSource: Record<string, any>, TableCreationParameters: Record<string, any>, ClientToken?: string, InputCompressionType?: string, InputFormatOptions?: Record<string, any> }) => Promise<ImportTableResponse>
|
|
229
229
|
/**
|
|
230
230
|
* @description
|
|
231
231
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListBackups.html DynamoDB: ListBackups}
|
|
232
|
-
* - aws-lite docs: {@link https://github.com/
|
|
232
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListBackups DynamoDB: ListBackups}
|
|
233
233
|
*/
|
|
234
234
|
ListBackups: (input: { BackupType?: string, ExclusiveStartBackupArn?: string, Limit?: number, TableName?: string, TimeRangeLowerBound?: number, TimeRangeUpperBound?: number }) => Promise<ListBackupsResponse>
|
|
235
235
|
/**
|
|
236
236
|
* @description
|
|
237
237
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListContributorInsights.html DynamoDB: ListContributorInsights}
|
|
238
|
-
* - aws-lite docs: {@link https://github.com/
|
|
238
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListContributorInsights DynamoDB: ListContributorInsights}
|
|
239
239
|
*/
|
|
240
240
|
ListContributorInsights: (input: { MaxResults?: number, NextToken?: string, TableName?: string }) => Promise<ListContributorInsightsResponse>
|
|
241
241
|
/**
|
|
242
242
|
* @description
|
|
243
243
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListExports.html DynamoDB: ListExports}
|
|
244
|
-
* - aws-lite docs: {@link https://github.com/
|
|
244
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListExports DynamoDB: ListExports}
|
|
245
245
|
*/
|
|
246
246
|
ListExports: (input: { MaxResults?: number, NextToken?: string, TableArn?: string }) => Promise<ListExportsResponse>
|
|
247
247
|
/**
|
|
248
248
|
* @description
|
|
249
249
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListGlobalTables.html DynamoDB: ListGlobalTables}
|
|
250
|
-
* - aws-lite docs: {@link https://github.com/
|
|
250
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListGlobalTables DynamoDB: ListGlobalTables}
|
|
251
251
|
*/
|
|
252
252
|
ListGlobalTables: (input: { ExclusiveStartGlobalTableName?: string, Limit?: number, RegionName?: string }) => Promise<ListGlobalTablesResponse>
|
|
253
253
|
/**
|
|
254
254
|
* @description
|
|
255
255
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListImports.html DynamoDB: ListImports}
|
|
256
|
-
* - aws-lite docs: {@link https://github.com/
|
|
256
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListImports DynamoDB: ListImports}
|
|
257
257
|
*/
|
|
258
258
|
ListImports: (input: { NextToken?: string, PageSize?: number, TableArn?: string }) => Promise<ListImportsResponse>
|
|
259
259
|
/**
|
|
260
260
|
* @description
|
|
261
261
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTables.html DynamoDB: ListTables}
|
|
262
|
-
* - aws-lite docs: {@link https://github.com/
|
|
262
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListTables DynamoDB: ListTables}
|
|
263
263
|
*/
|
|
264
264
|
ListTables: (input: { ExclusiveStartTableName?: string, Limit?: number }) => Promise<ListTablesResponse>
|
|
265
265
|
/**
|
|
266
266
|
* @description
|
|
267
267
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTagsOfResource.html DynamoDB: ListTagsOfResource}
|
|
268
|
-
* - aws-lite docs: {@link https://github.com/
|
|
268
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#ListTagsOfResource DynamoDB: ListTagsOfResource}
|
|
269
269
|
*/
|
|
270
270
|
ListTagsOfResource: (input: { NextToken?: string, ResourceArn: string }) => Promise<ListTagsOfResourceResponse>
|
|
271
271
|
/**
|
|
272
272
|
* @description
|
|
273
273
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html DynamoDB: PutItem}
|
|
274
|
-
* - aws-lite docs: {@link https://github.com/
|
|
274
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#PutItem DynamoDB: PutItem}
|
|
275
275
|
*/
|
|
276
276
|
PutItem: (input: { TableName: string, Item: Record<string, any>, ConditionalOperator?: string, ConditionExpression?: string, Expected?: Record<string, any>, ExpressionAttributeNames?: Record<string, any>, ExpressionAttributeValues?: Record<string, any>, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string, ReturnValues?: string, ReturnValuesOnConditionCheckFailure?: string }) => Promise<PutItemResponse>
|
|
277
277
|
/**
|
|
278
278
|
* @description
|
|
279
279
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html DynamoDB: Query}
|
|
280
|
-
* - aws-lite docs: {@link https://github.com/
|
|
280
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#Query DynamoDB: Query}
|
|
281
281
|
*/
|
|
282
282
|
Query: (input: { TableName: string, AttributesToGet?: any[], ConditionalOperator?: string, ConsistentRead?: boolean, ExclusiveStartKey?: Record<string, any>, ExpressionAttributeNames?: Record<string, any>, ExpressionAttributeValues?: Record<string, any>, FilterExpression?: string, IndexName?: string, KeyConditionExpression?: string, KeyConditions?: Record<string, any>, Limit?: number, ProjectionExpression?: string, QueryFilter?: Record<string, any>, ReturnConsumedCapacity?: string, ScanIndexForward?: boolean, Select?: string, paginate?: boolean | string }) => Promise<QueryResponse>
|
|
283
283
|
/**
|
|
284
284
|
* @description
|
|
285
285
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_RestoreTableFromBackup.html DynamoDB: RestoreTableFromBackup}
|
|
286
|
-
* - aws-lite docs: {@link https://github.com/
|
|
286
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#RestoreTableFromBackup DynamoDB: RestoreTableFromBackup}
|
|
287
287
|
*/
|
|
288
288
|
RestoreTableFromBackup: (input: { BackupArn: string, TargetTableName: string, BillingModeOverride?: string, GlobalSecondaryIndexOverride?: any[], LocalSecondaryIndexOverride?: any[], ProvisionedThroughputOverride?: Record<string, any>, SSESpecificationOverride?: Record<string, any> }) => Promise<RestoreTableFromBackupResponse>
|
|
289
289
|
/**
|
|
290
290
|
* @description
|
|
291
291
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_RestoreTableToPointInTime.html DynamoDB: RestoreTableToPointInTime}
|
|
292
|
-
* - aws-lite docs: {@link https://github.com/
|
|
292
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#RestoreTableToPointInTime DynamoDB: RestoreTableToPointInTime}
|
|
293
293
|
*/
|
|
294
294
|
RestoreTableToPointInTime: (input: { TargetTableName: string, BillingModeOverride?: string, GlobalSecondaryIndexOverride?: any[], LocalSecondaryIndexOverride?: any[], ProvisionedThroughputOverride?: Record<string, any>, RestoreDateTime?: number, SourceTableArn?: string, SourceTableName?: string, SSESpecificationOverride?: Record<string, any>, UseLatestRestorableTime?: boolean }) => Promise<RestoreTableToPointInTimeResponse>
|
|
295
295
|
/**
|
|
296
296
|
* @description
|
|
297
297
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html DynamoDB: Scan}
|
|
298
|
-
* - aws-lite docs: {@link https://github.com/
|
|
298
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#Scan DynamoDB: Scan}
|
|
299
299
|
*/
|
|
300
300
|
Scan: (input: { TableName: string, AttributesToGet?: any[], ConditionalOperator?: string, ConsistentRead?: boolean, ExclusiveStartKey?: Record<string, any>, ExpressionAttributeNames?: Record<string, any>, ExpressionAttributeValues?: Record<string, any>, FilterExpression?: string, IndexName?: string, Limit?: number, ProjectionExpression?: string, ReturnConsumedCapacity?: string, ScanFilter?: Record<string, any>, Segment?: number, Select?: string, TotalSegments?: number, paginate?: boolean | string }) => Promise<ScanResponse>
|
|
301
301
|
/**
|
|
302
302
|
* @description
|
|
303
303
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TagResource.html DynamoDB: TagResource}
|
|
304
|
-
* - aws-lite docs: {@link https://github.com/
|
|
304
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#TagResource DynamoDB: TagResource}
|
|
305
305
|
*/
|
|
306
306
|
TagResource: (input: { ResourceArn: string, Tags: any[] }) => Promise<TagResourceResponse>
|
|
307
307
|
/**
|
|
308
308
|
* @description
|
|
309
309
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html DynamoDB: TransactGetItems}
|
|
310
|
-
* - aws-lite docs: {@link https://github.com/
|
|
310
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#TransactGetItems DynamoDB: TransactGetItems}
|
|
311
311
|
*/
|
|
312
312
|
TransactGetItems: (input: { TransactItems: any[], ReturnConsumedCapacity?: string }) => Promise<TransactGetItemsResponse>
|
|
313
313
|
/**
|
|
314
314
|
* @description
|
|
315
315
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html DynamoDB: TransactWriteItems}
|
|
316
|
-
* - aws-lite docs: {@link https://github.com/
|
|
316
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#TransactWriteItems DynamoDB: TransactWriteItems}
|
|
317
317
|
*/
|
|
318
318
|
TransactWriteItems: (input: { TransactItems: any[], ClientRequestToken?: string, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string }) => Promise<TransactWriteItemsResponse>
|
|
319
319
|
/**
|
|
320
320
|
* @description
|
|
321
321
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UntagResource.html DynamoDB: UntagResource}
|
|
322
|
-
* - aws-lite docs: {@link https://github.com/
|
|
322
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UntagResource DynamoDB: UntagResource}
|
|
323
323
|
*/
|
|
324
324
|
UntagResource: (input: { ResourceArn: string, TagKeys: any[] }) => Promise<UntagResourceResponse>
|
|
325
325
|
/**
|
|
326
326
|
* @description
|
|
327
327
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateContinuousBackups.html DynamoDB: UpdateContinuousBackups}
|
|
328
|
-
* - aws-lite docs: {@link https://github.com/
|
|
328
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateContinuousBackups DynamoDB: UpdateContinuousBackups}
|
|
329
329
|
*/
|
|
330
330
|
UpdateContinuousBackups: (input: { TableName: string, PointInTimeRecoverySpecification?: Record<string, any> }) => Promise<UpdateContinuousBackupsResponse>
|
|
331
331
|
/**
|
|
332
332
|
* @description
|
|
333
333
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateContributorInsights.html DynamoDB: UpdateContributorInsights}
|
|
334
|
-
* - aws-lite docs: {@link https://github.com/
|
|
334
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateContributorInsights DynamoDB: UpdateContributorInsights}
|
|
335
335
|
*/
|
|
336
336
|
UpdateContributorInsights: (input: { TableName: string, ContributorInsightsAction?: string, IndexName?: string }) => Promise<UpdateContributorInsightsResponse>
|
|
337
337
|
/**
|
|
338
338
|
* @description
|
|
339
339
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateGlobalTable.html DynamoDB: UpdateGlobalTable}
|
|
340
|
-
* - aws-lite docs: {@link https://github.com/
|
|
340
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateGlobalTable DynamoDB: UpdateGlobalTable}
|
|
341
341
|
*/
|
|
342
342
|
UpdateGlobalTable: (input: { GlobalTableName: string, ReplicaUpdates?: any[] }) => Promise<UpdateGlobalTableResponse>
|
|
343
343
|
/**
|
|
344
344
|
* @description
|
|
345
345
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateGlobalTableSettings.html DynamoDB: UpdateGlobalTableSettings}
|
|
346
|
-
* - aws-lite docs: {@link https://github.com/
|
|
346
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateGlobalTableSettings DynamoDB: UpdateGlobalTableSettings}
|
|
347
347
|
*/
|
|
348
348
|
UpdateGlobalTableSettings: (input: { GlobalTableName: string, GlobalTableBillingMode?: string, GlobalTableGlobalSecondaryIndexSettingsUpdate?: any[], GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate?: Record<string, any>, GlobalTableProvisionedWriteCapacityUnits?: number, ReplicaSettingsUpdate?: any[] }) => Promise<UpdateGlobalTableSettingsResponse>
|
|
349
349
|
/**
|
|
350
350
|
* @description
|
|
351
351
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html DynamoDB: UpdateItem}
|
|
352
|
-
* - aws-lite docs: {@link https://github.com/
|
|
352
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateItem DynamoDB: UpdateItem}
|
|
353
353
|
*/
|
|
354
354
|
UpdateItem: (input: { Key: Record<string, any>, TableName: string, AttributeUpdates?: Record<string, any>, ConditionalOperator?: string, ConditionExpression?: string, Expected?: Record<string, any>, ExpressionAttributeNames?: Record<string, any>, ExpressionAttributeValues?: Record<string, any>, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string, ReturnValues?: string, ReturnValuesOnConditionCheckFailure?: string, UpdateExpression?: string }) => Promise<UpdateItemResponse>
|
|
355
355
|
/**
|
|
356
356
|
* @description
|
|
357
357
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html DynamoDB: UpdateTable}
|
|
358
|
-
* - aws-lite docs: {@link https://github.com/
|
|
358
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTable DynamoDB: UpdateTable}
|
|
359
359
|
*/
|
|
360
360
|
UpdateTable: (input: { TableName: string, AttributeDefinitions?: any[], BillingMode?: string, DeletionProtectionEnabled?: boolean, GlobalSecondaryIndexUpdates?: any[], ProvisionedThroughput?: Record<string, any>, ReplicaUpdates?: any[], SSESpecification?: Record<string, any>, StreamSpecification?: Record<string, any>, TableClass?: string }) => Promise<UpdateTableResponse>
|
|
361
361
|
/**
|
|
362
362
|
* @description
|
|
363
363
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTableReplicaAutoScaling.html DynamoDB: UpdateTableReplicaAutoScaling}
|
|
364
|
-
* - aws-lite docs: {@link https://github.com/
|
|
364
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTableReplicaAutoScaling DynamoDB: UpdateTableReplicaAutoScaling}
|
|
365
365
|
*/
|
|
366
366
|
UpdateTableReplicaAutoScaling: (input: { TableName: string, GlobalSecondaryIndexUpdates?: any[], ProvisionedWriteCapacityAutoScalingUpdate?: Record<string, any>, ReplicaUpdates?: any[] }) => Promise<UpdateTableReplicaAutoScalingResponse>
|
|
367
367
|
/**
|
|
368
368
|
* @description
|
|
369
369
|
* - AWS docs: {@link https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTimeToLive.html DynamoDB: UpdateTimeToLive}
|
|
370
|
-
* - aws-lite docs: {@link https://github.com/
|
|
370
|
+
* - aws-lite docs: {@link https://github.com/aws-lite/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTimeToLive DynamoDB: UpdateTimeToLive}
|
|
371
371
|
*/
|
|
372
372
|
UpdateTimeToLive: (input: { TableName: string, TimeToLiveSpecification?: Record<string, any> }) => Promise<UpdateTimeToLiveResponse>
|
|
373
373
|
// $METHODS_END
|
package/package.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-lite/dynamodb-types",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.9",
|
|
4
4
|
"description": "Type definitions for the `@aws-lite/dynamodb` plugin",
|
|
5
5
|
"homepage": "https://aws-lite.org/services/dynamodb",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "git+https://github.com/
|
|
8
|
+
"url": "git+https://github.com/aws-lite/aws-lite.git",
|
|
9
9
|
"directory": "plugins/dynamodb/types"
|
|
10
10
|
},
|
|
11
|
-
"bugs": "https://github.com/
|
|
11
|
+
"bugs": "https://github.com/aws-lite/aws-lite/issues",
|
|
12
12
|
"main": "",
|
|
13
13
|
"engines": {
|
|
14
14
|
"node": ">=16"
|