@aws-sdk/client-timestream-write 3.379.1 → 3.385.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/models/models_0.d.ts +181 -0
- package/package.json +5 -5
|
@@ -30,26 +30,32 @@ export type BatchLoadDataFormat = (typeof BatchLoadDataFormat)[keyof typeof Batc
|
|
|
30
30
|
*/
|
|
31
31
|
export interface BatchLoadProgressReport {
|
|
32
32
|
/**
|
|
33
|
+
* @public
|
|
33
34
|
* <p></p>
|
|
34
35
|
*/
|
|
35
36
|
RecordsProcessed?: number;
|
|
36
37
|
/**
|
|
38
|
+
* @public
|
|
37
39
|
* <p></p>
|
|
38
40
|
*/
|
|
39
41
|
RecordsIngested?: number;
|
|
40
42
|
/**
|
|
43
|
+
* @public
|
|
41
44
|
* <p></p>
|
|
42
45
|
*/
|
|
43
46
|
ParseFailures?: number;
|
|
44
47
|
/**
|
|
48
|
+
* @public
|
|
45
49
|
* <p></p>
|
|
46
50
|
*/
|
|
47
51
|
RecordIngestionFailures?: number;
|
|
48
52
|
/**
|
|
53
|
+
* @public
|
|
49
54
|
* <p></p>
|
|
50
55
|
*/
|
|
51
56
|
FileFailures?: number;
|
|
52
57
|
/**
|
|
58
|
+
* @public
|
|
53
59
|
* <p></p>
|
|
54
60
|
*/
|
|
55
61
|
BytesMetered?: number;
|
|
@@ -76,30 +82,37 @@ export type BatchLoadStatus = (typeof BatchLoadStatus)[keyof typeof BatchLoadSta
|
|
|
76
82
|
*/
|
|
77
83
|
export interface BatchLoadTask {
|
|
78
84
|
/**
|
|
85
|
+
* @public
|
|
79
86
|
* <p>The ID of the batch load task.</p>
|
|
80
87
|
*/
|
|
81
88
|
TaskId?: string;
|
|
82
89
|
/**
|
|
90
|
+
* @public
|
|
83
91
|
* <p>Status of the batch load task.</p>
|
|
84
92
|
*/
|
|
85
93
|
TaskStatus?: BatchLoadStatus | string;
|
|
86
94
|
/**
|
|
95
|
+
* @public
|
|
87
96
|
* <p>Database name for the database into which a batch load task loads data.</p>
|
|
88
97
|
*/
|
|
89
98
|
DatabaseName?: string;
|
|
90
99
|
/**
|
|
100
|
+
* @public
|
|
91
101
|
* <p>Table name for the table into which a batch load task loads data.</p>
|
|
92
102
|
*/
|
|
93
103
|
TableName?: string;
|
|
94
104
|
/**
|
|
105
|
+
* @public
|
|
95
106
|
* <p>The time when the Timestream batch load task was created.</p>
|
|
96
107
|
*/
|
|
97
108
|
CreationTime?: Date;
|
|
98
109
|
/**
|
|
110
|
+
* @public
|
|
99
111
|
* <p>The time when the Timestream batch load task was last updated.</p>
|
|
100
112
|
*/
|
|
101
113
|
LastUpdatedTime?: Date;
|
|
102
114
|
/**
|
|
115
|
+
* @public
|
|
103
116
|
* <p>
|
|
104
117
|
* </p>
|
|
105
118
|
*/
|
|
@@ -111,10 +124,12 @@ export interface BatchLoadTask {
|
|
|
111
124
|
*/
|
|
112
125
|
export interface DimensionMapping {
|
|
113
126
|
/**
|
|
127
|
+
* @public
|
|
114
128
|
* <p></p>
|
|
115
129
|
*/
|
|
116
130
|
SourceColumn?: string;
|
|
117
131
|
/**
|
|
132
|
+
* @public
|
|
118
133
|
* <p>
|
|
119
134
|
* </p>
|
|
120
135
|
*/
|
|
@@ -157,14 +172,17 @@ export type ScalarMeasureValueType = (typeof ScalarMeasureValueType)[keyof typeo
|
|
|
157
172
|
*/
|
|
158
173
|
export interface MultiMeasureAttributeMapping {
|
|
159
174
|
/**
|
|
175
|
+
* @public
|
|
160
176
|
* <p></p>
|
|
161
177
|
*/
|
|
162
178
|
SourceColumn: string | undefined;
|
|
163
179
|
/**
|
|
180
|
+
* @public
|
|
164
181
|
* <p></p>
|
|
165
182
|
*/
|
|
166
183
|
TargetMultiMeasureAttributeName?: string;
|
|
167
184
|
/**
|
|
185
|
+
* @public
|
|
168
186
|
* <p></p>
|
|
169
187
|
*/
|
|
170
188
|
MeasureValueType?: ScalarMeasureValueType | string;
|
|
@@ -175,22 +193,27 @@ export interface MultiMeasureAttributeMapping {
|
|
|
175
193
|
*/
|
|
176
194
|
export interface MixedMeasureMapping {
|
|
177
195
|
/**
|
|
196
|
+
* @public
|
|
178
197
|
* <p></p>
|
|
179
198
|
*/
|
|
180
199
|
MeasureName?: string;
|
|
181
200
|
/**
|
|
201
|
+
* @public
|
|
182
202
|
* <p></p>
|
|
183
203
|
*/
|
|
184
204
|
SourceColumn?: string;
|
|
185
205
|
/**
|
|
206
|
+
* @public
|
|
186
207
|
* <p></p>
|
|
187
208
|
*/
|
|
188
209
|
TargetMeasureName?: string;
|
|
189
210
|
/**
|
|
211
|
+
* @public
|
|
190
212
|
* <p></p>
|
|
191
213
|
*/
|
|
192
214
|
MeasureValueType: MeasureValueType | string | undefined;
|
|
193
215
|
/**
|
|
216
|
+
* @public
|
|
194
217
|
* <p></p>
|
|
195
218
|
*/
|
|
196
219
|
MultiMeasureAttributeMappings?: MultiMeasureAttributeMapping[];
|
|
@@ -201,10 +224,12 @@ export interface MixedMeasureMapping {
|
|
|
201
224
|
*/
|
|
202
225
|
export interface MultiMeasureMappings {
|
|
203
226
|
/**
|
|
227
|
+
* @public
|
|
204
228
|
* <p></p>
|
|
205
229
|
*/
|
|
206
230
|
TargetMultiMeasureName?: string;
|
|
207
231
|
/**
|
|
232
|
+
* @public
|
|
208
233
|
* <p></p>
|
|
209
234
|
*/
|
|
210
235
|
MultiMeasureAttributeMappings: MultiMeasureAttributeMapping[] | undefined;
|
|
@@ -229,28 +254,34 @@ export type TimeUnit = (typeof TimeUnit)[keyof typeof TimeUnit];
|
|
|
229
254
|
*/
|
|
230
255
|
export interface DataModel {
|
|
231
256
|
/**
|
|
257
|
+
* @public
|
|
232
258
|
* <p>Source column to be mapped to time.</p>
|
|
233
259
|
*/
|
|
234
260
|
TimeColumn?: string;
|
|
235
261
|
/**
|
|
262
|
+
* @public
|
|
236
263
|
* <p> The granularity of the timestamp unit. It indicates if the time value is in seconds,
|
|
237
264
|
* milliseconds, nanoseconds, or other supported values. Default is <code>MILLISECONDS</code>.
|
|
238
265
|
* </p>
|
|
239
266
|
*/
|
|
240
267
|
TimeUnit?: TimeUnit | string;
|
|
241
268
|
/**
|
|
269
|
+
* @public
|
|
242
270
|
* <p>Source to target mappings for dimensions.</p>
|
|
243
271
|
*/
|
|
244
272
|
DimensionMappings: DimensionMapping[] | undefined;
|
|
245
273
|
/**
|
|
274
|
+
* @public
|
|
246
275
|
* <p>Source to target mappings for multi-measure records.</p>
|
|
247
276
|
*/
|
|
248
277
|
MultiMeasureMappings?: MultiMeasureMappings;
|
|
249
278
|
/**
|
|
279
|
+
* @public
|
|
250
280
|
* <p>Source to target mappings for measures.</p>
|
|
251
281
|
*/
|
|
252
282
|
MixedMeasureMappings?: MixedMeasureMapping[];
|
|
253
283
|
/**
|
|
284
|
+
* @public
|
|
254
285
|
* <p></p>
|
|
255
286
|
*/
|
|
256
287
|
MeasureNameColumn?: string;
|
|
@@ -261,10 +292,12 @@ export interface DataModel {
|
|
|
261
292
|
*/
|
|
262
293
|
export interface DataModelS3Configuration {
|
|
263
294
|
/**
|
|
295
|
+
* @public
|
|
264
296
|
* <p></p>
|
|
265
297
|
*/
|
|
266
298
|
BucketName?: string;
|
|
267
299
|
/**
|
|
300
|
+
* @public
|
|
268
301
|
* <p></p>
|
|
269
302
|
*/
|
|
270
303
|
ObjectKey?: string;
|
|
@@ -275,10 +308,12 @@ export interface DataModelS3Configuration {
|
|
|
275
308
|
*/
|
|
276
309
|
export interface DataModelConfiguration {
|
|
277
310
|
/**
|
|
311
|
+
* @public
|
|
278
312
|
* <p></p>
|
|
279
313
|
*/
|
|
280
314
|
DataModel?: DataModel;
|
|
281
315
|
/**
|
|
316
|
+
* @public
|
|
282
317
|
* <p></p>
|
|
283
318
|
*/
|
|
284
319
|
DataModelS3Configuration?: DataModelS3Configuration;
|
|
@@ -290,23 +325,28 @@ export interface DataModelConfiguration {
|
|
|
290
325
|
*/
|
|
291
326
|
export interface CsvConfiguration {
|
|
292
327
|
/**
|
|
328
|
+
* @public
|
|
293
329
|
* <p>Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or
|
|
294
330
|
* blank space (' '). </p>
|
|
295
331
|
*/
|
|
296
332
|
ColumnSeparator?: string;
|
|
297
333
|
/**
|
|
334
|
+
* @public
|
|
298
335
|
* <p>Escape character can be one of </p>
|
|
299
336
|
*/
|
|
300
337
|
EscapeChar?: string;
|
|
301
338
|
/**
|
|
339
|
+
* @public
|
|
302
340
|
* <p>Can be single quote (') or double quote (").</p>
|
|
303
341
|
*/
|
|
304
342
|
QuoteChar?: string;
|
|
305
343
|
/**
|
|
344
|
+
* @public
|
|
306
345
|
* <p>Can be blank space (' ').</p>
|
|
307
346
|
*/
|
|
308
347
|
NullValue?: string;
|
|
309
348
|
/**
|
|
349
|
+
* @public
|
|
310
350
|
* <p>Specifies to trim leading and trailing white space.</p>
|
|
311
351
|
*/
|
|
312
352
|
TrimWhiteSpace?: boolean;
|
|
@@ -318,10 +358,12 @@ export interface CsvConfiguration {
|
|
|
318
358
|
*/
|
|
319
359
|
export interface DataSourceS3Configuration {
|
|
320
360
|
/**
|
|
361
|
+
* @public
|
|
321
362
|
* <p>The bucket name of the customer S3 bucket.</p>
|
|
322
363
|
*/
|
|
323
364
|
BucketName: string | undefined;
|
|
324
365
|
/**
|
|
366
|
+
* @public
|
|
325
367
|
* <p>
|
|
326
368
|
* </p>
|
|
327
369
|
*/
|
|
@@ -333,15 +375,18 @@ export interface DataSourceS3Configuration {
|
|
|
333
375
|
*/
|
|
334
376
|
export interface DataSourceConfiguration {
|
|
335
377
|
/**
|
|
378
|
+
* @public
|
|
336
379
|
* <p>Configuration of an S3 location for a file which contains data to load.</p>
|
|
337
380
|
*/
|
|
338
381
|
DataSourceS3Configuration: DataSourceS3Configuration | undefined;
|
|
339
382
|
/**
|
|
383
|
+
* @public
|
|
340
384
|
* <p>A delimited data format where the column separator can be a comma and the record
|
|
341
385
|
* separator is a newline character.</p>
|
|
342
386
|
*/
|
|
343
387
|
CsvConfiguration?: CsvConfiguration;
|
|
344
388
|
/**
|
|
389
|
+
* @public
|
|
345
390
|
* <p>This is currently CSV.</p>
|
|
346
391
|
*/
|
|
347
392
|
DataFormat: BatchLoadDataFormat | string | undefined;
|
|
@@ -364,18 +409,22 @@ export type S3EncryptionOption = (typeof S3EncryptionOption)[keyof typeof S3Encr
|
|
|
364
409
|
*/
|
|
365
410
|
export interface ReportS3Configuration {
|
|
366
411
|
/**
|
|
412
|
+
* @public
|
|
367
413
|
* <p></p>
|
|
368
414
|
*/
|
|
369
415
|
BucketName: string | undefined;
|
|
370
416
|
/**
|
|
417
|
+
* @public
|
|
371
418
|
* <p></p>
|
|
372
419
|
*/
|
|
373
420
|
ObjectKeyPrefix?: string;
|
|
374
421
|
/**
|
|
422
|
+
* @public
|
|
375
423
|
* <p></p>
|
|
376
424
|
*/
|
|
377
425
|
EncryptionOption?: S3EncryptionOption | string;
|
|
378
426
|
/**
|
|
427
|
+
* @public
|
|
379
428
|
* <p></p>
|
|
380
429
|
*/
|
|
381
430
|
KmsKeyId?: string;
|
|
@@ -387,6 +436,7 @@ export interface ReportS3Configuration {
|
|
|
387
436
|
*/
|
|
388
437
|
export interface ReportConfiguration {
|
|
389
438
|
/**
|
|
439
|
+
* @public
|
|
390
440
|
* <p>Configuration of an S3 location to write error reports and events for a batch
|
|
391
441
|
* load.</p>
|
|
392
442
|
*/
|
|
@@ -398,56 +448,69 @@ export interface ReportConfiguration {
|
|
|
398
448
|
*/
|
|
399
449
|
export interface BatchLoadTaskDescription {
|
|
400
450
|
/**
|
|
451
|
+
* @public
|
|
401
452
|
* <p>The ID of the batch load task.</p>
|
|
402
453
|
*/
|
|
403
454
|
TaskId?: string;
|
|
404
455
|
/**
|
|
456
|
+
* @public
|
|
405
457
|
* <p></p>
|
|
406
458
|
*/
|
|
407
459
|
ErrorMessage?: string;
|
|
408
460
|
/**
|
|
461
|
+
* @public
|
|
409
462
|
* <p>Configuration details about the data source for a batch load task.</p>
|
|
410
463
|
*/
|
|
411
464
|
DataSourceConfiguration?: DataSourceConfiguration;
|
|
412
465
|
/**
|
|
466
|
+
* @public
|
|
413
467
|
* <p></p>
|
|
414
468
|
*/
|
|
415
469
|
ProgressReport?: BatchLoadProgressReport;
|
|
416
470
|
/**
|
|
471
|
+
* @public
|
|
417
472
|
* <p>Report configuration for a batch load task. This contains details about where error
|
|
418
473
|
* reports are stored.</p>
|
|
419
474
|
*/
|
|
420
475
|
ReportConfiguration?: ReportConfiguration;
|
|
421
476
|
/**
|
|
477
|
+
* @public
|
|
422
478
|
* <p>Data model configuration for a batch load task. This contains details about where a data
|
|
423
479
|
* model for a batch load task is stored.</p>
|
|
424
480
|
*/
|
|
425
481
|
DataModelConfiguration?: DataModelConfiguration;
|
|
426
482
|
/**
|
|
483
|
+
* @public
|
|
427
484
|
* <p></p>
|
|
428
485
|
*/
|
|
429
486
|
TargetDatabaseName?: string;
|
|
430
487
|
/**
|
|
488
|
+
* @public
|
|
431
489
|
* <p></p>
|
|
432
490
|
*/
|
|
433
491
|
TargetTableName?: string;
|
|
434
492
|
/**
|
|
493
|
+
* @public
|
|
435
494
|
* <p>Status of the batch load task.</p>
|
|
436
495
|
*/
|
|
437
496
|
TaskStatus?: BatchLoadStatus | string;
|
|
438
497
|
/**
|
|
498
|
+
* @public
|
|
439
499
|
* <p></p>
|
|
440
500
|
*/
|
|
441
501
|
RecordVersion?: number;
|
|
442
502
|
/**
|
|
503
|
+
* @public
|
|
443
504
|
* <p>The time when the Timestream batch load task was created.</p>
|
|
444
505
|
*/
|
|
445
506
|
CreationTime?: Date;
|
|
446
507
|
/**
|
|
508
|
+
* @public
|
|
447
509
|
* <p>The time when the Timestream batch load task was last updated.</p>
|
|
448
510
|
*/
|
|
449
511
|
LastUpdatedTime?: Date;
|
|
450
512
|
/**
|
|
513
|
+
* @public
|
|
451
514
|
* <p>
|
|
452
515
|
* </p>
|
|
453
516
|
*/
|
|
@@ -472,31 +535,38 @@ export declare class ConflictException extends __BaseException {
|
|
|
472
535
|
*/
|
|
473
536
|
export interface CreateBatchLoadTaskRequest {
|
|
474
537
|
/**
|
|
538
|
+
* @public
|
|
475
539
|
* <p></p>
|
|
476
540
|
*/
|
|
477
541
|
ClientToken?: string;
|
|
478
542
|
/**
|
|
543
|
+
* @public
|
|
479
544
|
* <p></p>
|
|
480
545
|
*/
|
|
481
546
|
DataModelConfiguration?: DataModelConfiguration;
|
|
482
547
|
/**
|
|
548
|
+
* @public
|
|
483
549
|
* <p>Defines configuration details about the data source for a batch load task.</p>
|
|
484
550
|
*/
|
|
485
551
|
DataSourceConfiguration: DataSourceConfiguration | undefined;
|
|
486
552
|
/**
|
|
553
|
+
* @public
|
|
487
554
|
* <p>Report configuration for a batch load task. This contains details about where error
|
|
488
555
|
* reports are stored.</p>
|
|
489
556
|
*/
|
|
490
557
|
ReportConfiguration: ReportConfiguration | undefined;
|
|
491
558
|
/**
|
|
559
|
+
* @public
|
|
492
560
|
* <p>Target Timestream database for a batch load task.</p>
|
|
493
561
|
*/
|
|
494
562
|
TargetDatabaseName: string | undefined;
|
|
495
563
|
/**
|
|
564
|
+
* @public
|
|
496
565
|
* <p>Target Timestream table for a batch load task.</p>
|
|
497
566
|
*/
|
|
498
567
|
TargetTableName: string | undefined;
|
|
499
568
|
/**
|
|
569
|
+
* @public
|
|
500
570
|
* <p></p>
|
|
501
571
|
*/
|
|
502
572
|
RecordVersion?: number;
|
|
@@ -506,6 +576,7 @@ export interface CreateBatchLoadTaskRequest {
|
|
|
506
576
|
*/
|
|
507
577
|
export interface CreateBatchLoadTaskResponse {
|
|
508
578
|
/**
|
|
579
|
+
* @public
|
|
509
580
|
* <p>The ID of the batch load task.</p>
|
|
510
581
|
*/
|
|
511
582
|
TaskId: string | undefined;
|
|
@@ -600,10 +671,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
600
671
|
*/
|
|
601
672
|
export interface Tag {
|
|
602
673
|
/**
|
|
674
|
+
* @public
|
|
603
675
|
* <p> The key of the tag. Tag keys are case sensitive. </p>
|
|
604
676
|
*/
|
|
605
677
|
Key: string | undefined;
|
|
606
678
|
/**
|
|
679
|
+
* @public
|
|
607
680
|
* <p> The value of the tag. Tag values are case-sensitive and can be null. </p>
|
|
608
681
|
*/
|
|
609
682
|
Value: string | undefined;
|
|
@@ -613,15 +686,18 @@ export interface Tag {
|
|
|
613
686
|
*/
|
|
614
687
|
export interface CreateDatabaseRequest {
|
|
615
688
|
/**
|
|
689
|
+
* @public
|
|
616
690
|
* <p>The name of the Timestream database.</p>
|
|
617
691
|
*/
|
|
618
692
|
DatabaseName: string | undefined;
|
|
619
693
|
/**
|
|
694
|
+
* @public
|
|
620
695
|
* <p>The KMS key for the database. If the KMS key is not
|
|
621
696
|
* specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed keys</a>.</p>
|
|
622
697
|
*/
|
|
623
698
|
KmsKeyId?: string;
|
|
624
699
|
/**
|
|
700
|
+
* @public
|
|
625
701
|
* <p> A list of key-value pairs to label the table. </p>
|
|
626
702
|
*/
|
|
627
703
|
Tags?: Tag[];
|
|
@@ -634,27 +710,33 @@ export interface CreateDatabaseRequest {
|
|
|
634
710
|
*/
|
|
635
711
|
export interface Database {
|
|
636
712
|
/**
|
|
713
|
+
* @public
|
|
637
714
|
* <p>The Amazon Resource Name that uniquely identifies this database.</p>
|
|
638
715
|
*/
|
|
639
716
|
Arn?: string;
|
|
640
717
|
/**
|
|
718
|
+
* @public
|
|
641
719
|
* <p>The name of the Timestream database.</p>
|
|
642
720
|
*/
|
|
643
721
|
DatabaseName?: string;
|
|
644
722
|
/**
|
|
723
|
+
* @public
|
|
645
724
|
* <p>The total number of tables found within a Timestream database. </p>
|
|
646
725
|
*/
|
|
647
726
|
TableCount?: number;
|
|
648
727
|
/**
|
|
728
|
+
* @public
|
|
649
729
|
* <p>The identifier of the KMS key used to encrypt the data stored in the
|
|
650
730
|
* database.</p>
|
|
651
731
|
*/
|
|
652
732
|
KmsKeyId?: string;
|
|
653
733
|
/**
|
|
734
|
+
* @public
|
|
654
735
|
* <p>The time when the database was created, calculated from the Unix epoch time.</p>
|
|
655
736
|
*/
|
|
656
737
|
CreationTime?: Date;
|
|
657
738
|
/**
|
|
739
|
+
* @public
|
|
658
740
|
* <p> The last time that this database was updated. </p>
|
|
659
741
|
*/
|
|
660
742
|
LastUpdatedTime?: Date;
|
|
@@ -664,6 +746,7 @@ export interface Database {
|
|
|
664
746
|
*/
|
|
665
747
|
export interface CreateDatabaseResponse {
|
|
666
748
|
/**
|
|
749
|
+
* @public
|
|
667
750
|
* <p>The newly created Timestream database.</p>
|
|
668
751
|
*/
|
|
669
752
|
Database?: Database;
|
|
@@ -674,19 +757,23 @@ export interface CreateDatabaseResponse {
|
|
|
674
757
|
*/
|
|
675
758
|
export interface S3Configuration {
|
|
676
759
|
/**
|
|
760
|
+
* @public
|
|
677
761
|
* <p>The bucket name of the customer S3 bucket.</p>
|
|
678
762
|
*/
|
|
679
763
|
BucketName?: string;
|
|
680
764
|
/**
|
|
765
|
+
* @public
|
|
681
766
|
* <p>The object key preview for the customer S3 location.</p>
|
|
682
767
|
*/
|
|
683
768
|
ObjectKeyPrefix?: string;
|
|
684
769
|
/**
|
|
770
|
+
* @public
|
|
685
771
|
* <p>The encryption option for the customer S3 location. Options are S3 server-side
|
|
686
772
|
* encryption with an S3 managed key or Amazon Web Services managed key.</p>
|
|
687
773
|
*/
|
|
688
774
|
EncryptionOption?: S3EncryptionOption | string;
|
|
689
775
|
/**
|
|
776
|
+
* @public
|
|
690
777
|
* <p>The KMS key ID for the customer S3 location when encrypting with an
|
|
691
778
|
* Amazon Web Services managed key.</p>
|
|
692
779
|
*/
|
|
@@ -699,6 +786,7 @@ export interface S3Configuration {
|
|
|
699
786
|
*/
|
|
700
787
|
export interface MagneticStoreRejectedDataLocation {
|
|
701
788
|
/**
|
|
789
|
+
* @public
|
|
702
790
|
* <p>Configuration of an S3 location to write error reports for records rejected,
|
|
703
791
|
* asynchronously, during magnetic store writes.</p>
|
|
704
792
|
*/
|
|
@@ -710,10 +798,12 @@ export interface MagneticStoreRejectedDataLocation {
|
|
|
710
798
|
*/
|
|
711
799
|
export interface MagneticStoreWriteProperties {
|
|
712
800
|
/**
|
|
801
|
+
* @public
|
|
713
802
|
* <p>A flag to enable magnetic store writes.</p>
|
|
714
803
|
*/
|
|
715
804
|
EnableMagneticStoreWrites: boolean | undefined;
|
|
716
805
|
/**
|
|
806
|
+
* @public
|
|
717
807
|
* <p>The location to write error reports for records rejected asynchronously during magnetic
|
|
718
808
|
* store writes.</p>
|
|
719
809
|
*/
|
|
@@ -726,10 +816,12 @@ export interface MagneticStoreWriteProperties {
|
|
|
726
816
|
*/
|
|
727
817
|
export interface RetentionProperties {
|
|
728
818
|
/**
|
|
819
|
+
* @public
|
|
729
820
|
* <p>The duration for which data must be stored in the memory store. </p>
|
|
730
821
|
*/
|
|
731
822
|
MemoryStoreRetentionPeriodInHours: number | undefined;
|
|
732
823
|
/**
|
|
824
|
+
* @public
|
|
733
825
|
* <p>The duration for which data must be stored in the magnetic store. </p>
|
|
734
826
|
*/
|
|
735
827
|
MagneticStoreRetentionPeriodInDays: number | undefined;
|
|
@@ -767,15 +859,18 @@ export type PartitionKeyType = (typeof PartitionKeyType)[keyof typeof PartitionK
|
|
|
767
859
|
*/
|
|
768
860
|
export interface PartitionKey {
|
|
769
861
|
/**
|
|
862
|
+
* @public
|
|
770
863
|
* <p> The type of the partition key. Options are DIMENSION (dimension key) and MEASURE
|
|
771
864
|
* (measure key). </p>
|
|
772
865
|
*/
|
|
773
866
|
Type: PartitionKeyType | string | undefined;
|
|
774
867
|
/**
|
|
868
|
+
* @public
|
|
775
869
|
* <p> The name of the attribute used for a dimension key. </p>
|
|
776
870
|
*/
|
|
777
871
|
Name?: string;
|
|
778
872
|
/**
|
|
873
|
+
* @public
|
|
779
874
|
* <p> The level of enforcement for the specification of a dimension key in ingested records.
|
|
780
875
|
* Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not
|
|
781
876
|
* have to be specified). </p>
|
|
@@ -788,6 +883,7 @@ export interface PartitionKey {
|
|
|
788
883
|
*/
|
|
789
884
|
export interface Schema {
|
|
790
885
|
/**
|
|
886
|
+
* @public
|
|
791
887
|
* <p>A non-empty list of partition keys defining the attributes used to partition the table
|
|
792
888
|
* data. The order of the list determines the partition hierarchy. The name and type of each
|
|
793
889
|
* partition key as well as the partition key order cannot be changed after the table is
|
|
@@ -800,27 +896,33 @@ export interface Schema {
|
|
|
800
896
|
*/
|
|
801
897
|
export interface CreateTableRequest {
|
|
802
898
|
/**
|
|
899
|
+
* @public
|
|
803
900
|
* <p>The name of the Timestream database.</p>
|
|
804
901
|
*/
|
|
805
902
|
DatabaseName: string | undefined;
|
|
806
903
|
/**
|
|
904
|
+
* @public
|
|
807
905
|
* <p>The name of the Timestream table.</p>
|
|
808
906
|
*/
|
|
809
907
|
TableName: string | undefined;
|
|
810
908
|
/**
|
|
909
|
+
* @public
|
|
811
910
|
* <p>The duration for which your time-series data must be stored in the memory store and the
|
|
812
911
|
* magnetic store.</p>
|
|
813
912
|
*/
|
|
814
913
|
RetentionProperties?: RetentionProperties;
|
|
815
914
|
/**
|
|
915
|
+
* @public
|
|
816
916
|
* <p> A list of key-value pairs to label the table. </p>
|
|
817
917
|
*/
|
|
818
918
|
Tags?: Tag[];
|
|
819
919
|
/**
|
|
920
|
+
* @public
|
|
820
921
|
* <p>Contains properties to set on the table when enabling magnetic store writes.</p>
|
|
821
922
|
*/
|
|
822
923
|
MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
|
|
823
924
|
/**
|
|
925
|
+
* @public
|
|
824
926
|
* <p> The schema of the table. </p>
|
|
825
927
|
*/
|
|
826
928
|
Schema?: Schema;
|
|
@@ -846,18 +948,22 @@ export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
|
|
|
846
948
|
*/
|
|
847
949
|
export interface Table {
|
|
848
950
|
/**
|
|
951
|
+
* @public
|
|
849
952
|
* <p>The Amazon Resource Name that uniquely identifies this table.</p>
|
|
850
953
|
*/
|
|
851
954
|
Arn?: string;
|
|
852
955
|
/**
|
|
956
|
+
* @public
|
|
853
957
|
* <p>The name of the Timestream table.</p>
|
|
854
958
|
*/
|
|
855
959
|
TableName?: string;
|
|
856
960
|
/**
|
|
961
|
+
* @public
|
|
857
962
|
* <p>The name of the Timestream database that contains this table.</p>
|
|
858
963
|
*/
|
|
859
964
|
DatabaseName?: string;
|
|
860
965
|
/**
|
|
966
|
+
* @public
|
|
861
967
|
* <p>The current state of the table:</p>
|
|
862
968
|
* <ul>
|
|
863
969
|
* <li>
|
|
@@ -872,22 +978,27 @@ export interface Table {
|
|
|
872
978
|
*/
|
|
873
979
|
TableStatus?: TableStatus | string;
|
|
874
980
|
/**
|
|
981
|
+
* @public
|
|
875
982
|
* <p>The retention duration for the memory store and magnetic store.</p>
|
|
876
983
|
*/
|
|
877
984
|
RetentionProperties?: RetentionProperties;
|
|
878
985
|
/**
|
|
986
|
+
* @public
|
|
879
987
|
* <p>The time when the Timestream table was created. </p>
|
|
880
988
|
*/
|
|
881
989
|
CreationTime?: Date;
|
|
882
990
|
/**
|
|
991
|
+
* @public
|
|
883
992
|
* <p>The time when the Timestream table was last updated.</p>
|
|
884
993
|
*/
|
|
885
994
|
LastUpdatedTime?: Date;
|
|
886
995
|
/**
|
|
996
|
+
* @public
|
|
887
997
|
* <p>Contains properties to set on the table when enabling magnetic store writes.</p>
|
|
888
998
|
*/
|
|
889
999
|
MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
|
|
890
1000
|
/**
|
|
1001
|
+
* @public
|
|
891
1002
|
* <p> The schema of the table. </p>
|
|
892
1003
|
*/
|
|
893
1004
|
Schema?: Schema;
|
|
@@ -897,6 +1008,7 @@ export interface Table {
|
|
|
897
1008
|
*/
|
|
898
1009
|
export interface CreateTableResponse {
|
|
899
1010
|
/**
|
|
1011
|
+
* @public
|
|
900
1012
|
* <p>The newly created Timestream table.</p>
|
|
901
1013
|
*/
|
|
902
1014
|
Table?: Table;
|
|
@@ -906,6 +1018,7 @@ export interface CreateTableResponse {
|
|
|
906
1018
|
*/
|
|
907
1019
|
export interface DeleteDatabaseRequest {
|
|
908
1020
|
/**
|
|
1021
|
+
* @public
|
|
909
1022
|
* <p>The name of the Timestream database to be deleted.</p>
|
|
910
1023
|
*/
|
|
911
1024
|
DatabaseName: string | undefined;
|
|
@@ -915,10 +1028,12 @@ export interface DeleteDatabaseRequest {
|
|
|
915
1028
|
*/
|
|
916
1029
|
export interface DeleteTableRequest {
|
|
917
1030
|
/**
|
|
1031
|
+
* @public
|
|
918
1032
|
* <p>The name of the database where the Timestream database is to be deleted.</p>
|
|
919
1033
|
*/
|
|
920
1034
|
DatabaseName: string | undefined;
|
|
921
1035
|
/**
|
|
1036
|
+
* @public
|
|
922
1037
|
* <p>The name of the Timestream table to be deleted.</p>
|
|
923
1038
|
*/
|
|
924
1039
|
TableName: string | undefined;
|
|
@@ -928,6 +1043,7 @@ export interface DeleteTableRequest {
|
|
|
928
1043
|
*/
|
|
929
1044
|
export interface DescribeBatchLoadTaskRequest {
|
|
930
1045
|
/**
|
|
1046
|
+
* @public
|
|
931
1047
|
* <p>The ID of the batch load task.</p>
|
|
932
1048
|
*/
|
|
933
1049
|
TaskId: string | undefined;
|
|
@@ -937,6 +1053,7 @@ export interface DescribeBatchLoadTaskRequest {
|
|
|
937
1053
|
*/
|
|
938
1054
|
export interface DescribeBatchLoadTaskResponse {
|
|
939
1055
|
/**
|
|
1056
|
+
* @public
|
|
940
1057
|
* <p>Description of the batch load task.</p>
|
|
941
1058
|
*/
|
|
942
1059
|
BatchLoadTaskDescription: BatchLoadTaskDescription | undefined;
|
|
@@ -946,6 +1063,7 @@ export interface DescribeBatchLoadTaskResponse {
|
|
|
946
1063
|
*/
|
|
947
1064
|
export interface DescribeDatabaseRequest {
|
|
948
1065
|
/**
|
|
1066
|
+
* @public
|
|
949
1067
|
* <p>The name of the Timestream database.</p>
|
|
950
1068
|
*/
|
|
951
1069
|
DatabaseName: string | undefined;
|
|
@@ -955,6 +1073,7 @@ export interface DescribeDatabaseRequest {
|
|
|
955
1073
|
*/
|
|
956
1074
|
export interface DescribeDatabaseResponse {
|
|
957
1075
|
/**
|
|
1076
|
+
* @public
|
|
958
1077
|
* <p>The name of the Timestream table.</p>
|
|
959
1078
|
*/
|
|
960
1079
|
Database?: Database;
|
|
@@ -971,10 +1090,12 @@ export interface DescribeEndpointsRequest {
|
|
|
971
1090
|
*/
|
|
972
1091
|
export interface Endpoint {
|
|
973
1092
|
/**
|
|
1093
|
+
* @public
|
|
974
1094
|
* <p>An endpoint address.</p>
|
|
975
1095
|
*/
|
|
976
1096
|
Address: string | undefined;
|
|
977
1097
|
/**
|
|
1098
|
+
* @public
|
|
978
1099
|
* <p>The TTL for the endpoint, in minutes.</p>
|
|
979
1100
|
*/
|
|
980
1101
|
CachePeriodInMinutes: number | undefined;
|
|
@@ -984,6 +1105,7 @@ export interface Endpoint {
|
|
|
984
1105
|
*/
|
|
985
1106
|
export interface DescribeEndpointsResponse {
|
|
986
1107
|
/**
|
|
1108
|
+
* @public
|
|
987
1109
|
* <p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>
|
|
988
1110
|
* request is made.</p>
|
|
989
1111
|
*/
|
|
@@ -994,10 +1116,12 @@ export interface DescribeEndpointsResponse {
|
|
|
994
1116
|
*/
|
|
995
1117
|
export interface DescribeTableRequest {
|
|
996
1118
|
/**
|
|
1119
|
+
* @public
|
|
997
1120
|
* <p>The name of the Timestream database.</p>
|
|
998
1121
|
*/
|
|
999
1122
|
DatabaseName: string | undefined;
|
|
1000
1123
|
/**
|
|
1124
|
+
* @public
|
|
1001
1125
|
* <p>The name of the Timestream table.</p>
|
|
1002
1126
|
*/
|
|
1003
1127
|
TableName: string | undefined;
|
|
@@ -1007,6 +1131,7 @@ export interface DescribeTableRequest {
|
|
|
1007
1131
|
*/
|
|
1008
1132
|
export interface DescribeTableResponse {
|
|
1009
1133
|
/**
|
|
1134
|
+
* @public
|
|
1010
1135
|
* <p>The Timestream table.</p>
|
|
1011
1136
|
*/
|
|
1012
1137
|
Table?: Table;
|
|
@@ -1030,6 +1155,7 @@ export type DimensionValueType = (typeof DimensionValueType)[keyof typeof Dimens
|
|
|
1030
1155
|
*/
|
|
1031
1156
|
export interface Dimension {
|
|
1032
1157
|
/**
|
|
1158
|
+
* @public
|
|
1033
1159
|
* <p> Dimension represents the metadata attributes of the time series. For example, the name
|
|
1034
1160
|
* and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine
|
|
1035
1161
|
* are dimensions. </p>
|
|
@@ -1038,10 +1164,12 @@ export interface Dimension {
|
|
|
1038
1164
|
*/
|
|
1039
1165
|
Name: string | undefined;
|
|
1040
1166
|
/**
|
|
1167
|
+
* @public
|
|
1041
1168
|
* <p>The value of the dimension.</p>
|
|
1042
1169
|
*/
|
|
1043
1170
|
Value: string | undefined;
|
|
1044
1171
|
/**
|
|
1172
|
+
* @public
|
|
1045
1173
|
* <p>The data type of the dimension for the time-series data point.</p>
|
|
1046
1174
|
*/
|
|
1047
1175
|
DimensionValueType?: DimensionValueType | string;
|
|
@@ -1051,11 +1179,13 @@ export interface Dimension {
|
|
|
1051
1179
|
*/
|
|
1052
1180
|
export interface ListBatchLoadTasksRequest {
|
|
1053
1181
|
/**
|
|
1182
|
+
* @public
|
|
1054
1183
|
* <p>A token to specify where to start paginating. This is the NextToken from a previously
|
|
1055
1184
|
* truncated response.</p>
|
|
1056
1185
|
*/
|
|
1057
1186
|
NextToken?: string;
|
|
1058
1187
|
/**
|
|
1188
|
+
* @public
|
|
1059
1189
|
* <p>The total number of items to return in the output. If the total number of items
|
|
1060
1190
|
* available is more than the value specified, a NextToken is provided in the output. To
|
|
1061
1191
|
* resume pagination, provide the NextToken value as argument of a subsequent API
|
|
@@ -1063,6 +1193,7 @@ export interface ListBatchLoadTasksRequest {
|
|
|
1063
1193
|
*/
|
|
1064
1194
|
MaxResults?: number;
|
|
1065
1195
|
/**
|
|
1196
|
+
* @public
|
|
1066
1197
|
* <p>Status of the batch load task.</p>
|
|
1067
1198
|
*/
|
|
1068
1199
|
TaskStatus?: BatchLoadStatus | string;
|
|
@@ -1072,11 +1203,13 @@ export interface ListBatchLoadTasksRequest {
|
|
|
1072
1203
|
*/
|
|
1073
1204
|
export interface ListBatchLoadTasksResponse {
|
|
1074
1205
|
/**
|
|
1206
|
+
* @public
|
|
1075
1207
|
* <p>A token to specify where to start paginating. Provide the next
|
|
1076
1208
|
* ListBatchLoadTasksRequest.</p>
|
|
1077
1209
|
*/
|
|
1078
1210
|
NextToken?: string;
|
|
1079
1211
|
/**
|
|
1212
|
+
* @public
|
|
1080
1213
|
* <p>A list of batch load task details.</p>
|
|
1081
1214
|
*/
|
|
1082
1215
|
BatchLoadTasks?: BatchLoadTask[];
|
|
@@ -1086,11 +1219,13 @@ export interface ListBatchLoadTasksResponse {
|
|
|
1086
1219
|
*/
|
|
1087
1220
|
export interface ListDatabasesRequest {
|
|
1088
1221
|
/**
|
|
1222
|
+
* @public
|
|
1089
1223
|
* <p>The pagination token. To resume pagination, provide the NextToken value as argument of a
|
|
1090
1224
|
* subsequent API invocation.</p>
|
|
1091
1225
|
*/
|
|
1092
1226
|
NextToken?: string;
|
|
1093
1227
|
/**
|
|
1228
|
+
* @public
|
|
1094
1229
|
* <p>The total number of items to return in the output. If the total number of items
|
|
1095
1230
|
* available is more than the value specified, a NextToken is provided in the output. To
|
|
1096
1231
|
* resume pagination, provide the NextToken value as argument of a subsequent API
|
|
@@ -1103,10 +1238,12 @@ export interface ListDatabasesRequest {
|
|
|
1103
1238
|
*/
|
|
1104
1239
|
export interface ListDatabasesResponse {
|
|
1105
1240
|
/**
|
|
1241
|
+
* @public
|
|
1106
1242
|
* <p>A list of database names.</p>
|
|
1107
1243
|
*/
|
|
1108
1244
|
Databases?: Database[];
|
|
1109
1245
|
/**
|
|
1246
|
+
* @public
|
|
1110
1247
|
* <p>The pagination token. This parameter is returned when the response is truncated.</p>
|
|
1111
1248
|
*/
|
|
1112
1249
|
NextToken?: string;
|
|
@@ -1116,15 +1253,18 @@ export interface ListDatabasesResponse {
|
|
|
1116
1253
|
*/
|
|
1117
1254
|
export interface ListTablesRequest {
|
|
1118
1255
|
/**
|
|
1256
|
+
* @public
|
|
1119
1257
|
* <p>The name of the Timestream database.</p>
|
|
1120
1258
|
*/
|
|
1121
1259
|
DatabaseName?: string;
|
|
1122
1260
|
/**
|
|
1261
|
+
* @public
|
|
1123
1262
|
* <p>The pagination token. To resume pagination, provide the NextToken value as argument of a
|
|
1124
1263
|
* subsequent API invocation.</p>
|
|
1125
1264
|
*/
|
|
1126
1265
|
NextToken?: string;
|
|
1127
1266
|
/**
|
|
1267
|
+
* @public
|
|
1128
1268
|
* <p>The total number of items to return in the output. If the total number of items
|
|
1129
1269
|
* available is more than the value specified, a NextToken is provided in the output. To
|
|
1130
1270
|
* resume pagination, provide the NextToken value as argument of a subsequent API
|
|
@@ -1137,10 +1277,12 @@ export interface ListTablesRequest {
|
|
|
1137
1277
|
*/
|
|
1138
1278
|
export interface ListTablesResponse {
|
|
1139
1279
|
/**
|
|
1280
|
+
* @public
|
|
1140
1281
|
* <p>A list of tables.</p>
|
|
1141
1282
|
*/
|
|
1142
1283
|
Tables?: Table[];
|
|
1143
1284
|
/**
|
|
1285
|
+
* @public
|
|
1144
1286
|
* <p>A token to specify where to start paginating. This is the NextToken from a previously
|
|
1145
1287
|
* truncated response.</p>
|
|
1146
1288
|
*/
|
|
@@ -1151,6 +1293,7 @@ export interface ListTablesResponse {
|
|
|
1151
1293
|
*/
|
|
1152
1294
|
export interface ListTagsForResourceRequest {
|
|
1153
1295
|
/**
|
|
1296
|
+
* @public
|
|
1154
1297
|
* <p> The Timestream resource with tags to be listed. This value is an Amazon
|
|
1155
1298
|
* Resource Name (ARN). </p>
|
|
1156
1299
|
*/
|
|
@@ -1161,6 +1304,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1161
1304
|
*/
|
|
1162
1305
|
export interface ListTagsForResourceResponse {
|
|
1163
1306
|
/**
|
|
1307
|
+
* @public
|
|
1164
1308
|
* <p> The tags currently associated with the Timestream resource. </p>
|
|
1165
1309
|
*/
|
|
1166
1310
|
Tags?: Tag[];
|
|
@@ -1176,16 +1320,19 @@ export interface ListTagsForResourceResponse {
|
|
|
1176
1320
|
*/
|
|
1177
1321
|
export interface MeasureValue {
|
|
1178
1322
|
/**
|
|
1323
|
+
* @public
|
|
1179
1324
|
* <p> The name of the MeasureValue. </p>
|
|
1180
1325
|
* <p> For constraints on MeasureValue names, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming"> Naming Constraints</a> in the Amazon Timestream Developer Guide.</p>
|
|
1181
1326
|
*/
|
|
1182
1327
|
Name: string | undefined;
|
|
1183
1328
|
/**
|
|
1329
|
+
* @public
|
|
1184
1330
|
* <p> The value for the MeasureValue. For information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types">Data
|
|
1185
1331
|
* types</a>.</p>
|
|
1186
1332
|
*/
|
|
1187
1333
|
Value: string | undefined;
|
|
1188
1334
|
/**
|
|
1335
|
+
* @public
|
|
1189
1336
|
* <p>Contains the data type of the MeasureValue for the time-series data point.</p>
|
|
1190
1337
|
*/
|
|
1191
1338
|
Type: MeasureValueType | string | undefined;
|
|
@@ -1209,25 +1356,30 @@ export interface MeasureValue {
|
|
|
1209
1356
|
*/
|
|
1210
1357
|
export interface _Record {
|
|
1211
1358
|
/**
|
|
1359
|
+
* @public
|
|
1212
1360
|
* <p>Contains the list of dimensions for time-series data points.</p>
|
|
1213
1361
|
*/
|
|
1214
1362
|
Dimensions?: Dimension[];
|
|
1215
1363
|
/**
|
|
1364
|
+
* @public
|
|
1216
1365
|
* <p>Measure represents the data attribute of the time series. For example, the CPU
|
|
1217
1366
|
* utilization of an EC2 instance or the RPM of a wind turbine are measures. </p>
|
|
1218
1367
|
*/
|
|
1219
1368
|
MeasureName?: string;
|
|
1220
1369
|
/**
|
|
1370
|
+
* @public
|
|
1221
1371
|
* <p> Contains the measure value for the time-series data point. </p>
|
|
1222
1372
|
*/
|
|
1223
1373
|
MeasureValue?: string;
|
|
1224
1374
|
/**
|
|
1375
|
+
* @public
|
|
1225
1376
|
* <p> Contains the data type of the measure value for the time-series data point. Default
|
|
1226
1377
|
* type is <code>DOUBLE</code>. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types">Data
|
|
1227
1378
|
* types</a>.</p>
|
|
1228
1379
|
*/
|
|
1229
1380
|
MeasureValueType?: MeasureValueType | string;
|
|
1230
1381
|
/**
|
|
1382
|
+
* @public
|
|
1231
1383
|
* <p> Contains the time at which the measure value for the data point was collected. The time
|
|
1232
1384
|
* value plus the unit provides the time elapsed since the epoch. For example, if the time
|
|
1233
1385
|
* value is <code>12345</code> and the unit is <code>ms</code>, then <code>12345 ms</code>
|
|
@@ -1235,12 +1387,14 @@ export interface _Record {
|
|
|
1235
1387
|
*/
|
|
1236
1388
|
Time?: string;
|
|
1237
1389
|
/**
|
|
1390
|
+
* @public
|
|
1238
1391
|
* <p> The granularity of the timestamp unit. It indicates if the time value is in seconds,
|
|
1239
1392
|
* milliseconds, nanoseconds, or other supported values. Default is <code>MILLISECONDS</code>.
|
|
1240
1393
|
* </p>
|
|
1241
1394
|
*/
|
|
1242
1395
|
TimeUnit?: TimeUnit | string;
|
|
1243
1396
|
/**
|
|
1397
|
+
* @public
|
|
1244
1398
|
* <p>64-bit attribute used for record updates. Write requests for duplicate data with a
|
|
1245
1399
|
* higher version number will update the existing measure value and version. In cases where
|
|
1246
1400
|
* the measure value is the same, <code>Version</code> will still be updated. Default value is
|
|
@@ -1253,6 +1407,7 @@ export interface _Record {
|
|
|
1253
1407
|
*/
|
|
1254
1408
|
Version?: number;
|
|
1255
1409
|
/**
|
|
1410
|
+
* @public
|
|
1256
1411
|
* <p> Contains the list of MeasureValue for time-series data points. </p>
|
|
1257
1412
|
* <p> This is only allowed for type <code>MULTI</code>. For scalar values, use
|
|
1258
1413
|
* <code>MeasureValue</code> attribute of the record directly. </p>
|
|
@@ -1265,14 +1420,17 @@ export interface _Record {
|
|
|
1265
1420
|
*/
|
|
1266
1421
|
export interface RecordsIngested {
|
|
1267
1422
|
/**
|
|
1423
|
+
* @public
|
|
1268
1424
|
* <p>Total count of successfully ingested records.</p>
|
|
1269
1425
|
*/
|
|
1270
1426
|
Total?: number;
|
|
1271
1427
|
/**
|
|
1428
|
+
* @public
|
|
1272
1429
|
* <p>Count of records ingested into the memory store.</p>
|
|
1273
1430
|
*/
|
|
1274
1431
|
MemoryStore?: number;
|
|
1275
1432
|
/**
|
|
1433
|
+
* @public
|
|
1276
1434
|
* <p>Count of records ingested into the magnetic store.</p>
|
|
1277
1435
|
*/
|
|
1278
1436
|
MagneticStore?: number;
|
|
@@ -1285,11 +1443,13 @@ export interface RecordsIngested {
|
|
|
1285
1443
|
*/
|
|
1286
1444
|
export interface RejectedRecord {
|
|
1287
1445
|
/**
|
|
1446
|
+
* @public
|
|
1288
1447
|
* <p> The index of the record in the input request for WriteRecords. Indexes begin with 0.
|
|
1289
1448
|
* </p>
|
|
1290
1449
|
*/
|
|
1291
1450
|
RecordIndex?: number;
|
|
1292
1451
|
/**
|
|
1452
|
+
* @public
|
|
1293
1453
|
* <p> The reason why a record was not successfully inserted into Timestream.
|
|
1294
1454
|
* Possible causes of failure include: </p>
|
|
1295
1455
|
* <ul>
|
|
@@ -1334,6 +1494,7 @@ export interface RejectedRecord {
|
|
|
1334
1494
|
*/
|
|
1335
1495
|
Reason?: string;
|
|
1336
1496
|
/**
|
|
1497
|
+
* @public
|
|
1337
1498
|
* <p>The existing version of the record. This value is populated in scenarios where an
|
|
1338
1499
|
* identical record exists with a higher version than the version in the write request.</p>
|
|
1339
1500
|
*/
|
|
@@ -1377,6 +1538,7 @@ export declare class RejectedRecordsException extends __BaseException {
|
|
|
1377
1538
|
readonly $fault: "client";
|
|
1378
1539
|
Message?: string;
|
|
1379
1540
|
/**
|
|
1541
|
+
* @public
|
|
1380
1542
|
* <p>
|
|
1381
1543
|
* </p>
|
|
1382
1544
|
*/
|
|
@@ -1391,6 +1553,7 @@ export declare class RejectedRecordsException extends __BaseException {
|
|
|
1391
1553
|
*/
|
|
1392
1554
|
export interface ResumeBatchLoadTaskRequest {
|
|
1393
1555
|
/**
|
|
1556
|
+
* @public
|
|
1394
1557
|
* <p>The ID of the batch load task to resume.</p>
|
|
1395
1558
|
*/
|
|
1396
1559
|
TaskId: string | undefined;
|
|
@@ -1405,11 +1568,13 @@ export interface ResumeBatchLoadTaskResponse {
|
|
|
1405
1568
|
*/
|
|
1406
1569
|
export interface TagResourceRequest {
|
|
1407
1570
|
/**
|
|
1571
|
+
* @public
|
|
1408
1572
|
* <p> Identifies the Timestream resource to which tags should be added. This value
|
|
1409
1573
|
* is an Amazon Resource Name (ARN). </p>
|
|
1410
1574
|
*/
|
|
1411
1575
|
ResourceARN: string | undefined;
|
|
1412
1576
|
/**
|
|
1577
|
+
* @public
|
|
1413
1578
|
* <p> The tags to be assigned to the Timestream resource. </p>
|
|
1414
1579
|
*/
|
|
1415
1580
|
Tags: Tag[] | undefined;
|
|
@@ -1424,11 +1589,13 @@ export interface TagResourceResponse {
|
|
|
1424
1589
|
*/
|
|
1425
1590
|
export interface UntagResourceRequest {
|
|
1426
1591
|
/**
|
|
1592
|
+
* @public
|
|
1427
1593
|
* <p> The Timestream resource that the tags will be removed from. This value is an
|
|
1428
1594
|
* Amazon Resource Name (ARN). </p>
|
|
1429
1595
|
*/
|
|
1430
1596
|
ResourceARN: string | undefined;
|
|
1431
1597
|
/**
|
|
1598
|
+
* @public
|
|
1432
1599
|
* <p> A list of tags keys. Existing tags of the resource whose keys are members of this list
|
|
1433
1600
|
* will be removed from the Timestream resource. </p>
|
|
1434
1601
|
*/
|
|
@@ -1444,10 +1611,12 @@ export interface UntagResourceResponse {
|
|
|
1444
1611
|
*/
|
|
1445
1612
|
export interface UpdateDatabaseRequest {
|
|
1446
1613
|
/**
|
|
1614
|
+
* @public
|
|
1447
1615
|
* <p> The name of the database. </p>
|
|
1448
1616
|
*/
|
|
1449
1617
|
DatabaseName: string | undefined;
|
|
1450
1618
|
/**
|
|
1619
|
+
* @public
|
|
1451
1620
|
* <p> The identifier of the new KMS key (<code>KmsKeyId</code>) to be used to
|
|
1452
1621
|
* encrypt the data stored in the database. If the <code>KmsKeyId</code> currently registered
|
|
1453
1622
|
* with the database is the same as the <code>KmsKeyId</code> in the request, there will not
|
|
@@ -1481,6 +1650,7 @@ export interface UpdateDatabaseRequest {
|
|
|
1481
1650
|
*/
|
|
1482
1651
|
export interface UpdateDatabaseResponse {
|
|
1483
1652
|
/**
|
|
1653
|
+
* @public
|
|
1484
1654
|
* <p>A top-level container for a table. Databases and tables are the fundamental management
|
|
1485
1655
|
* concepts in Amazon Timestream. All tables in a database are encrypted with the
|
|
1486
1656
|
* same KMS key.</p>
|
|
@@ -1492,22 +1662,27 @@ export interface UpdateDatabaseResponse {
|
|
|
1492
1662
|
*/
|
|
1493
1663
|
export interface UpdateTableRequest {
|
|
1494
1664
|
/**
|
|
1665
|
+
* @public
|
|
1495
1666
|
* <p>The name of the Timestream database.</p>
|
|
1496
1667
|
*/
|
|
1497
1668
|
DatabaseName: string | undefined;
|
|
1498
1669
|
/**
|
|
1670
|
+
* @public
|
|
1499
1671
|
* <p>The name of the Timestream table.</p>
|
|
1500
1672
|
*/
|
|
1501
1673
|
TableName: string | undefined;
|
|
1502
1674
|
/**
|
|
1675
|
+
* @public
|
|
1503
1676
|
* <p>The retention duration of the memory store and the magnetic store.</p>
|
|
1504
1677
|
*/
|
|
1505
1678
|
RetentionProperties?: RetentionProperties;
|
|
1506
1679
|
/**
|
|
1680
|
+
* @public
|
|
1507
1681
|
* <p>Contains properties to set on the table when enabling magnetic store writes.</p>
|
|
1508
1682
|
*/
|
|
1509
1683
|
MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
|
|
1510
1684
|
/**
|
|
1685
|
+
* @public
|
|
1511
1686
|
* <p> The schema of the table. </p>
|
|
1512
1687
|
*/
|
|
1513
1688
|
Schema?: Schema;
|
|
@@ -1517,6 +1692,7 @@ export interface UpdateTableRequest {
|
|
|
1517
1692
|
*/
|
|
1518
1693
|
export interface UpdateTableResponse {
|
|
1519
1694
|
/**
|
|
1695
|
+
* @public
|
|
1520
1696
|
* <p>The updated Timestream table.</p>
|
|
1521
1697
|
*/
|
|
1522
1698
|
Table?: Table;
|
|
@@ -1526,14 +1702,17 @@ export interface UpdateTableResponse {
|
|
|
1526
1702
|
*/
|
|
1527
1703
|
export interface WriteRecordsRequest {
|
|
1528
1704
|
/**
|
|
1705
|
+
* @public
|
|
1529
1706
|
* <p>The name of the Timestream database.</p>
|
|
1530
1707
|
*/
|
|
1531
1708
|
DatabaseName: string | undefined;
|
|
1532
1709
|
/**
|
|
1710
|
+
* @public
|
|
1533
1711
|
* <p>The name of the Timestream table.</p>
|
|
1534
1712
|
*/
|
|
1535
1713
|
TableName: string | undefined;
|
|
1536
1714
|
/**
|
|
1715
|
+
* @public
|
|
1537
1716
|
* <p>A record that contains the common measure, dimension, time, and version attributes
|
|
1538
1717
|
* shared across all the records in the request. The measure and dimension attributes
|
|
1539
1718
|
* specified will be merged with the measure and dimension attributes in the records object
|
|
@@ -1543,6 +1722,7 @@ export interface WriteRecordsRequest {
|
|
|
1543
1722
|
*/
|
|
1544
1723
|
CommonAttributes?: _Record;
|
|
1545
1724
|
/**
|
|
1725
|
+
* @public
|
|
1546
1726
|
* <p>An array of records that contain the unique measure, dimension, time, and version
|
|
1547
1727
|
* attributes for each time-series data point. </p>
|
|
1548
1728
|
*/
|
|
@@ -1553,6 +1733,7 @@ export interface WriteRecordsRequest {
|
|
|
1553
1733
|
*/
|
|
1554
1734
|
export interface WriteRecordsResponse {
|
|
1555
1735
|
/**
|
|
1736
|
+
* @public
|
|
1556
1737
|
* <p>Information on the records ingested by this request.</p>
|
|
1557
1738
|
*/
|
|
1558
1739
|
RecordsIngested?: RecordsIngested;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-timestream-write",
|
|
3
3
|
"description": "AWS SDK for JavaScript Timestream Write Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.385.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,16 +21,16 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-endpoint-discovery": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
30
30
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
31
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
32
32
|
"@aws-sdk/types": "3.378.0",
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
35
35
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
36
36
|
"@smithy/config-resolver": "^2.0.1",
|