@aws-lite/dynamodb-types 0.2.2
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 +380 -0
- package/package.json +13 -0
- package/readme.md +58 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,380 @@
|
|
|
1
|
+
import {
|
|
2
|
+
/* ! Do not remove IMPORTS_START / IMPORTS_END ! */
|
|
3
|
+
// $IMPORTS_START
|
|
4
|
+
BatchExecuteStatementCommandOutput as BatchExecuteStatementResponse,
|
|
5
|
+
BatchGetItemCommandOutput as BatchGetItemResponse,
|
|
6
|
+
BatchWriteItemCommandOutput as BatchWriteItemResponse,
|
|
7
|
+
CreateBackupCommandOutput as CreateBackupResponse,
|
|
8
|
+
CreateGlobalTableCommandOutput as CreateGlobalTableResponse,
|
|
9
|
+
CreateTableCommandOutput as CreateTableResponse,
|
|
10
|
+
DeleteBackupCommandOutput as DeleteBackupResponse,
|
|
11
|
+
DeleteItemCommandOutput as DeleteItemResponse,
|
|
12
|
+
DeleteTableCommandOutput as DeleteTableResponse,
|
|
13
|
+
DescribeBackupCommandOutput as DescribeBackupResponse,
|
|
14
|
+
DescribeContinuousBackupsCommandOutput as DescribeContinuousBackupsResponse,
|
|
15
|
+
DescribeContributorInsightsCommandOutput as DescribeContributorInsightsResponse,
|
|
16
|
+
DescribeEndpointsCommandOutput as DescribeEndpointsResponse,
|
|
17
|
+
DescribeExportCommandOutput as DescribeExportResponse,
|
|
18
|
+
DescribeGlobalTableCommandOutput as DescribeGlobalTableResponse,
|
|
19
|
+
DescribeGlobalTableSettingsCommandOutput as DescribeGlobalTableSettingsResponse,
|
|
20
|
+
DescribeImportCommandOutput as DescribeImportResponse,
|
|
21
|
+
DescribeKinesisStreamingDestinationCommandOutput as DescribeKinesisStreamingDestinationResponse,
|
|
22
|
+
DescribeLimitsCommandOutput as DescribeLimitsResponse,
|
|
23
|
+
DescribeTableCommandOutput as DescribeTableResponse,
|
|
24
|
+
DescribeTableReplicaAutoScalingCommandOutput as DescribeTableReplicaAutoScalingResponse,
|
|
25
|
+
DescribeTimeToLiveCommandOutput as DescribeTimeToLiveResponse,
|
|
26
|
+
DisableKinesisStreamingDestinationCommandOutput as DisableKinesisStreamingDestinationResponse,
|
|
27
|
+
EnableKinesisStreamingDestinationCommandOutput as EnableKinesisStreamingDestinationResponse,
|
|
28
|
+
ExecuteStatementCommandOutput as ExecuteStatementResponse,
|
|
29
|
+
ExecuteTransactionCommandOutput as ExecuteTransactionResponse,
|
|
30
|
+
ExportTableToPointInTimeCommandOutput as ExportTableToPointInTimeResponse,
|
|
31
|
+
GetItemCommandOutput as GetItemResponse,
|
|
32
|
+
ImportTableCommandOutput as ImportTableResponse,
|
|
33
|
+
ListBackupsCommandOutput as ListBackupsResponse,
|
|
34
|
+
ListContributorInsightsCommandOutput as ListContributorInsightsResponse,
|
|
35
|
+
ListExportsCommandOutput as ListExportsResponse,
|
|
36
|
+
ListGlobalTablesCommandOutput as ListGlobalTablesResponse,
|
|
37
|
+
ListImportsCommandOutput as ListImportsResponse,
|
|
38
|
+
ListTablesCommandOutput as ListTablesResponse,
|
|
39
|
+
ListTagsOfResourceCommandOutput as ListTagsOfResourceResponse,
|
|
40
|
+
PutItemCommandOutput as PutItemResponse,
|
|
41
|
+
QueryCommandOutput as QueryResponse,
|
|
42
|
+
RestoreTableFromBackupCommandOutput as RestoreTableFromBackupResponse,
|
|
43
|
+
RestoreTableToPointInTimeCommandOutput as RestoreTableToPointInTimeResponse,
|
|
44
|
+
ScanCommandOutput as ScanResponse,
|
|
45
|
+
TagResourceCommandOutput as TagResourceResponse,
|
|
46
|
+
TransactGetItemsCommandOutput as TransactGetItemsResponse,
|
|
47
|
+
TransactWriteItemsCommandOutput as TransactWriteItemsResponse,
|
|
48
|
+
UntagResourceCommandOutput as UntagResourceResponse,
|
|
49
|
+
UpdateContinuousBackupsCommandOutput as UpdateContinuousBackupsResponse,
|
|
50
|
+
UpdateContributorInsightsCommandOutput as UpdateContributorInsightsResponse,
|
|
51
|
+
UpdateGlobalTableCommandOutput as UpdateGlobalTableResponse,
|
|
52
|
+
UpdateGlobalTableSettingsCommandOutput as UpdateGlobalTableSettingsResponse,
|
|
53
|
+
UpdateItemCommandOutput as UpdateItemResponse,
|
|
54
|
+
UpdateTableCommandOutput as UpdateTableResponse,
|
|
55
|
+
UpdateTableReplicaAutoScalingCommandOutput as UpdateTableReplicaAutoScalingResponse,
|
|
56
|
+
UpdateTimeToLiveCommandOutput as UpdateTimeToLiveResponse,
|
|
57
|
+
// $IMPORTS_END
|
|
58
|
+
} from "@aws-sdk/client-dynamodb";
|
|
59
|
+
|
|
60
|
+
declare interface AwsLiteDynamoDB {
|
|
61
|
+
/* ! Do not remove METHODS_START / METHODS_END ! */
|
|
62
|
+
// $METHODS_START
|
|
63
|
+
/**
|
|
64
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchExecuteStatement DynamoDB: BatchExecuteStatement}
|
|
67
|
+
*/
|
|
68
|
+
BatchExecuteStatement: (input: { Statements: any[], ReturnConsumedCapacity?: string }) => Promise<BatchExecuteStatementResponse>
|
|
69
|
+
/**
|
|
70
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchGetItem DynamoDB: BatchGetItem}
|
|
73
|
+
*/
|
|
74
|
+
BatchGetItem: (input: { RequestItems: Record<string, any>, ReturnConsumedCapacity?: string }) => Promise<BatchGetItemResponse>
|
|
75
|
+
/**
|
|
76
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#BatchWriteItem DynamoDB: BatchWriteItem}
|
|
79
|
+
*/
|
|
80
|
+
BatchWriteItem: (input: { RequestItems: Record<string, any>, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string }) => Promise<BatchWriteItemResponse>
|
|
81
|
+
/**
|
|
82
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateBackup DynamoDB: CreateBackup}
|
|
85
|
+
*/
|
|
86
|
+
CreateBackup: (input: { TableName: string, BackupName: string }) => Promise<CreateBackupResponse>
|
|
87
|
+
/**
|
|
88
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateGlobalTable DynamoDB: CreateGlobalTable}
|
|
91
|
+
*/
|
|
92
|
+
CreateGlobalTable: (input: { GlobalTableName: string, ReplicationGroup: any[] }) => Promise<CreateGlobalTableResponse>
|
|
93
|
+
/**
|
|
94
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#CreateTable DynamoDB: CreateTable}
|
|
97
|
+
*/
|
|
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
|
+
/**
|
|
100
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteBackup DynamoDB: DeleteBackup}
|
|
103
|
+
*/
|
|
104
|
+
DeleteBackup: (input: { BackupArn: string }) => Promise<DeleteBackupResponse>
|
|
105
|
+
/**
|
|
106
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteItem DynamoDB: DeleteItem}
|
|
109
|
+
*/
|
|
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
|
+
/**
|
|
112
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DeleteTable DynamoDB: DeleteTable}
|
|
115
|
+
*/
|
|
116
|
+
DeleteTable: (input: { TableName: string }) => Promise<DeleteTableResponse>
|
|
117
|
+
/**
|
|
118
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeBackup DynamoDB: DescribeBackup}
|
|
121
|
+
*/
|
|
122
|
+
DescribeBackup: (input: { BackupArn: string }) => Promise<DescribeBackupResponse>
|
|
123
|
+
/**
|
|
124
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeContinuousBackups DynamoDB: DescribeContinuousBackups}
|
|
127
|
+
*/
|
|
128
|
+
DescribeContinuousBackups: (input: { TableName: string }) => Promise<DescribeContinuousBackupsResponse>
|
|
129
|
+
/**
|
|
130
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeContributorInsights DynamoDB: DescribeContributorInsights}
|
|
133
|
+
*/
|
|
134
|
+
DescribeContributorInsights: (input: { TableName: string, IndexName?: string }) => Promise<DescribeContributorInsightsResponse>
|
|
135
|
+
/** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeEndpoints DynamoDB: DescribeEndpoints} */
|
|
136
|
+
DescribeEndpoints: () => Promise<DescribeEndpointsResponse>
|
|
137
|
+
/**
|
|
138
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeExport DynamoDB: DescribeExport}
|
|
141
|
+
*/
|
|
142
|
+
DescribeExport: (input: { ExportArn: string }) => Promise<DescribeExportResponse>
|
|
143
|
+
/**
|
|
144
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeGlobalTable DynamoDB: DescribeGlobalTable}
|
|
147
|
+
*/
|
|
148
|
+
DescribeGlobalTable: (input: { GlobalTableName: string }) => Promise<DescribeGlobalTableResponse>
|
|
149
|
+
/**
|
|
150
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeGlobalTableSettings DynamoDB: DescribeGlobalTableSettings}
|
|
153
|
+
*/
|
|
154
|
+
DescribeGlobalTableSettings: (input: { GlobalTableName: string }) => Promise<DescribeGlobalTableSettingsResponse>
|
|
155
|
+
/**
|
|
156
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeImport DynamoDB: DescribeImport}
|
|
159
|
+
*/
|
|
160
|
+
DescribeImport: (input: { ImportArn: string }) => Promise<DescribeImportResponse>
|
|
161
|
+
/**
|
|
162
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeKinesisStreamingDestination DynamoDB: DescribeKinesisStreamingDestination}
|
|
165
|
+
*/
|
|
166
|
+
DescribeKinesisStreamingDestination: (input: { TableName: string }) => Promise<DescribeKinesisStreamingDestinationResponse>
|
|
167
|
+
/** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeLimits DynamoDB: DescribeLimits} */
|
|
168
|
+
DescribeLimits: () => Promise<DescribeLimitsResponse>
|
|
169
|
+
/**
|
|
170
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTable DynamoDB: DescribeTable}
|
|
173
|
+
*/
|
|
174
|
+
DescribeTable: (input: { TableName: string }) => Promise<DescribeTableResponse>
|
|
175
|
+
/**
|
|
176
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTableReplicaAutoScaling DynamoDB: DescribeTableReplicaAutoScaling}
|
|
179
|
+
*/
|
|
180
|
+
DescribeTableReplicaAutoScaling: (input: { TableName: string }) => Promise<DescribeTableReplicaAutoScalingResponse>
|
|
181
|
+
/**
|
|
182
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DescribeTimeToLive DynamoDB: DescribeTimeToLive}
|
|
185
|
+
*/
|
|
186
|
+
DescribeTimeToLive: (input: { TableName: string }) => Promise<DescribeTimeToLiveResponse>
|
|
187
|
+
/**
|
|
188
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#DisableKinesisStreamingDestination DynamoDB: DisableKinesisStreamingDestination}
|
|
191
|
+
*/
|
|
192
|
+
DisableKinesisStreamingDestination: (input: { TableName: string, StreamArn: string }) => Promise<DisableKinesisStreamingDestinationResponse>
|
|
193
|
+
/**
|
|
194
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#EnableKinesisStreamingDestination DynamoDB: EnableKinesisStreamingDestination}
|
|
197
|
+
*/
|
|
198
|
+
EnableKinesisStreamingDestination: (input: { TableName: string, StreamArn: string }) => Promise<EnableKinesisStreamingDestinationResponse>
|
|
199
|
+
/**
|
|
200
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ExecuteStatement DynamoDB: ExecuteStatement}
|
|
203
|
+
*/
|
|
204
|
+
ExecuteStatement: (input: { TableName: string, Statement: string, ConsistentRead?: boolean, Limit?: number, NextToken?: string, Parameters?: Record<string, any>, ReturnConsumedCapacity?: string, ReturnValuesOnConditionCheckFailure?: string }) => Promise<ExecuteStatementResponse>
|
|
205
|
+
/**
|
|
206
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ExecuteTransaction DynamoDB: ExecuteTransaction}
|
|
209
|
+
*/
|
|
210
|
+
ExecuteTransaction: (input: { TableName: string, TransactStatements: any[], ClientRequestToken?: string, ReturnConsumedCapacity?: string }) => Promise<ExecuteTransactionResponse>
|
|
211
|
+
/**
|
|
212
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ExportTableToPointInTime DynamoDB: ExportTableToPointInTime}
|
|
215
|
+
*/
|
|
216
|
+
ExportTableToPointInTime: (input: { S3Bucket: string, TableArn: string, ClientToken?: string, ExportFormat?: string, ExportTime?: number, S3BucketOwner?: string, S3Prefix?: string, S3SseAlgorithm?: string, S3SseKmsKeyId?: string }) => Promise<ExportTableToPointInTimeResponse>
|
|
217
|
+
/**
|
|
218
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#GetItem DynamoDB: GetItem}
|
|
221
|
+
*/
|
|
222
|
+
GetItem: (input: { TableName: string, Key: Record<string, any>, AttributesToGet?: any[], ConsistentRead?: boolean, ExpressionAttributeNames?: Record<string, any>, ProjectionExpression?: string, ReturnConsumedCapacity?: string }) => Promise<GetItemResponse>
|
|
223
|
+
/**
|
|
224
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ImportTable DynamoDB: ImportTable}
|
|
227
|
+
*/
|
|
228
|
+
ImportTable: (input: { InputFormat: string, S3BucketSource: Record<string, any>, TableCreationParameters: Record<string, any>, ClientToken?: string, InputCompressionType?: string, InputFormatOptions?: Record<string, any> }) => Promise<ImportTableResponse>
|
|
229
|
+
/**
|
|
230
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListBackups DynamoDB: ListBackups}
|
|
233
|
+
*/
|
|
234
|
+
ListBackups: (input: { BackupType?: string, ExclusiveStartBackupArn?: string, Limit?: number, TableName?: string, TimeRangeLowerBound?: number, TimeRangeUpperBound?: number }) => Promise<ListBackupsResponse>
|
|
235
|
+
/**
|
|
236
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListContributorInsights DynamoDB: ListContributorInsights}
|
|
239
|
+
*/
|
|
240
|
+
ListContributorInsights: (input: { MaxResults?: number, NextToken?: string, TableName?: string }) => Promise<ListContributorInsightsResponse>
|
|
241
|
+
/**
|
|
242
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListExports DynamoDB: ListExports}
|
|
245
|
+
*/
|
|
246
|
+
ListExports: (input: { MaxResults?: number, NextToken?: string, TableArn?: string }) => Promise<ListExportsResponse>
|
|
247
|
+
/**
|
|
248
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListGlobalTables DynamoDB: ListGlobalTables}
|
|
251
|
+
*/
|
|
252
|
+
ListGlobalTables: (input: { ExclusiveStartGlobalTableName?: string, Limit?: number, RegionName?: string }) => Promise<ListGlobalTablesResponse>
|
|
253
|
+
/**
|
|
254
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListImports DynamoDB: ListImports}
|
|
257
|
+
*/
|
|
258
|
+
ListImports: (input: { NextToken?: string, PageSize?: number, TableArn?: string }) => Promise<ListImportsResponse>
|
|
259
|
+
/**
|
|
260
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListTables DynamoDB: ListTables}
|
|
263
|
+
*/
|
|
264
|
+
ListTables: (input: { ExclusiveStartTableName?: string, Limit?: number }) => Promise<ListTablesResponse>
|
|
265
|
+
/**
|
|
266
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#ListTagsOfResource DynamoDB: ListTagsOfResource}
|
|
269
|
+
*/
|
|
270
|
+
ListTagsOfResource: (input: { NextToken?: string, ResourceArn: string }) => Promise<ListTagsOfResourceResponse>
|
|
271
|
+
/**
|
|
272
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#PutItem DynamoDB: PutItem}
|
|
275
|
+
*/
|
|
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
|
+
/**
|
|
278
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#Query DynamoDB: Query}
|
|
281
|
+
*/
|
|
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 }) => Promise<QueryResponse>
|
|
283
|
+
/**
|
|
284
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#RestoreTableFromBackup DynamoDB: RestoreTableFromBackup}
|
|
287
|
+
*/
|
|
288
|
+
RestoreTableFromBackup: (input: { BackupArn: string, TargetTableName: string, BillingModeOverride?: string, GlobalSecondaryIndexOverride?: any[], LocalSecondaryIndexOverride?: any[], ProvisionedThroughputOverride?: Record<string, any>, SSESpecificationOverride?: Record<string, any> }) => Promise<RestoreTableFromBackupResponse>
|
|
289
|
+
/**
|
|
290
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#RestoreTableToPointInTime DynamoDB: RestoreTableToPointInTime}
|
|
293
|
+
*/
|
|
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
|
+
/**
|
|
296
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#Scan DynamoDB: Scan}
|
|
299
|
+
*/
|
|
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 }) => Promise<ScanResponse>
|
|
301
|
+
/**
|
|
302
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#TagResource DynamoDB: TagResource}
|
|
305
|
+
*/
|
|
306
|
+
TagResource: (input: { ResourceArn: string, Tags: any[] }) => Promise<TagResourceResponse>
|
|
307
|
+
/**
|
|
308
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#TransactGetItems DynamoDB: TransactGetItems}
|
|
311
|
+
*/
|
|
312
|
+
TransactGetItems: (input: { TransactItems: any[], ReturnConsumedCapacity?: string }) => Promise<TransactGetItemsResponse>
|
|
313
|
+
/**
|
|
314
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#TransactWriteItems DynamoDB: TransactWriteItems}
|
|
317
|
+
*/
|
|
318
|
+
TransactWriteItems: (input: { TransactItems: any[], ClientRequestToken?: string, ReturnConsumedCapacity?: string, ReturnItemCollectionMetrics?: string }) => Promise<TransactWriteItemsResponse>
|
|
319
|
+
/**
|
|
320
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UntagResource DynamoDB: UntagResource}
|
|
323
|
+
*/
|
|
324
|
+
UntagResource: (input: { ResourceArn: string, TagKeys: any[] }) => Promise<UntagResourceResponse>
|
|
325
|
+
/**
|
|
326
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateContinuousBackups DynamoDB: UpdateContinuousBackups}
|
|
329
|
+
*/
|
|
330
|
+
UpdateContinuousBackups: (input: { TableName: string, PointInTimeRecoverySpecification?: Record<string, any> }) => Promise<UpdateContinuousBackupsResponse>
|
|
331
|
+
/**
|
|
332
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateContributorInsights DynamoDB: UpdateContributorInsights}
|
|
335
|
+
*/
|
|
336
|
+
UpdateContributorInsights: (input: { TableName: string, ContributorInsightsAction?: string, IndexName?: string }) => Promise<UpdateContributorInsightsResponse>
|
|
337
|
+
/**
|
|
338
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateGlobalTable DynamoDB: UpdateGlobalTable}
|
|
341
|
+
*/
|
|
342
|
+
UpdateGlobalTable: (input: { GlobalTableName: string, ReplicaUpdates?: any[] }) => Promise<UpdateGlobalTableResponse>
|
|
343
|
+
/**
|
|
344
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateGlobalTableSettings DynamoDB: UpdateGlobalTableSettings}
|
|
347
|
+
*/
|
|
348
|
+
UpdateGlobalTableSettings: (input: { GlobalTableName: string, GlobalTableBillingMode?: string, GlobalTableGlobalSecondaryIndexSettingsUpdate?: any[], GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate?: Record<string, any>, GlobalTableProvisionedWriteCapacityUnits?: number, ReplicaSettingsUpdate?: any[] }) => Promise<UpdateGlobalTableSettingsResponse>
|
|
349
|
+
/**
|
|
350
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateItem DynamoDB: UpdateItem}
|
|
353
|
+
*/
|
|
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
|
+
/**
|
|
356
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTable DynamoDB: UpdateTable}
|
|
359
|
+
*/
|
|
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
|
+
/**
|
|
362
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTableReplicaAutoScaling DynamoDB: UpdateTableReplicaAutoScaling}
|
|
365
|
+
*/
|
|
366
|
+
UpdateTableReplicaAutoScaling: (input: { TableName: string, GlobalSecondaryIndexUpdates?: any[], ProvisionedWriteCapacityAutoScalingUpdate?: Record<string, any>, ReplicaUpdates?: any[] }) => Promise<UpdateTableReplicaAutoScalingResponse>
|
|
367
|
+
/**
|
|
368
|
+
* @description
|
|
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/architect/aws-lite/blob/main/plugins/dynamodb/readme.md#UpdateTimeToLive DynamoDB: UpdateTimeToLive}
|
|
371
|
+
*/
|
|
372
|
+
UpdateTimeToLive: (input: { TableName: string, TimeToLiveSpecification?: Record<string, any> }) => Promise<UpdateTimeToLiveResponse>
|
|
373
|
+
// $METHODS_END
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
declare module "@aws-lite/client" {
|
|
377
|
+
interface AwsLiteClient {
|
|
378
|
+
DynamoDB: AwsLiteDynamoDB;
|
|
379
|
+
}
|
|
380
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@aws-lite/dynamodb-types",
|
|
3
|
+
"description": "Type definitions for the @aws-lite/dynamodb plugin",
|
|
4
|
+
"version": "0.2.2",
|
|
5
|
+
"main": "",
|
|
6
|
+
"types": "index.d.ts",
|
|
7
|
+
"files": [
|
|
8
|
+
"index.d.ts"
|
|
9
|
+
],
|
|
10
|
+
"dependencies": {
|
|
11
|
+
"@aws-sdk/client-dynamodb": "3"
|
|
12
|
+
}
|
|
13
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
## Install
|
|
2
|
+
|
|
3
|
+
Add to `devDependencies` in `package.json`:
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm i -D @aws-lite/dynamodb-types
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
<small>Be sure you also have `@aws-lite/dynamodb` installed.</small>
|
|
10
|
+
|
|
11
|
+
## Usage and Config
|
|
12
|
+
|
|
13
|
+
### Javascript VSCode Intellisense
|
|
14
|
+
|
|
15
|
+
In a Javascript project, the ambient types will be automatically loaded.
|
|
16
|
+
|
|
17
|
+
```js
|
|
18
|
+
import awsLite from '@aws-lite/client';
|
|
19
|
+
|
|
20
|
+
const client = await awsLite({ region: 'us-east-1' });
|
|
21
|
+
const { Item: myArticle } = await client.dynamodb.GetItem({
|
|
22
|
+
TableName: 'articles',
|
|
23
|
+
Key: { articleID: '123-ABC' },
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
`client.dynamodb.GetItem` and the `myArticle` result will have Intellisense.
|
|
28
|
+
|
|
29
|
+
### TypeScript `tsconfig`
|
|
30
|
+
|
|
31
|
+
#### Add this package to `compilerOptions.types`
|
|
32
|
+
|
|
33
|
+
Example:
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"extends": "@tsconfig/node-lts/tsconfig.json",
|
|
38
|
+
"compilerOptions": {
|
|
39
|
+
"types": [
|
|
40
|
+
"@aws-lite/dynamodb-types"
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Or use reference types
|
|
47
|
+
|
|
48
|
+
Either in individual files or in an `index.d.ts` file.
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
/// <reference types="@aws-lite/dynamodb-types" />
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
ymmv
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
/// <reference path="./node_modules/@aws-lite/dynamodb-types/index.d.ts" />
|
|
58
|
+
```
|