@aws-sdk/client-timestream-query 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.
@@ -18,6 +18,7 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface CancelQueryRequest {
20
20
  /**
21
+ * @public
21
22
  * <p> The ID of the query that needs to be cancelled. <code>QueryID</code> is returned as
22
23
  * part of the query result. </p>
23
24
  */
@@ -28,6 +29,7 @@ export interface CancelQueryRequest {
28
29
  */
29
30
  export interface CancelQueryResponse {
30
31
  /**
32
+ * @public
31
33
  * <p> A <code>CancellationMessage</code> is returned when a <code>CancelQuery</code>
32
34
  * request for the query specified by <code>QueryId</code> has already been issued. </p>
33
35
  */
@@ -139,15 +141,18 @@ export type S3EncryptionOption = (typeof S3EncryptionOption)[keyof typeof S3Encr
139
141
  */
140
142
  export interface S3Configuration {
141
143
  /**
144
+ * @public
142
145
  * <p> Name of the S3 bucket under which error reports will be created.</p>
143
146
  */
144
147
  BucketName: string | undefined;
145
148
  /**
149
+ * @public
146
150
  * <p> Prefix for the error report key. Timestream by default adds the following prefix to
147
151
  * the error report path. </p>
148
152
  */
149
153
  ObjectKeyPrefix?: string;
150
154
  /**
155
+ * @public
151
156
  * <p> Encryption at rest options for the error reports. If no encryption option is
152
157
  * specified, Timestream will choose SSE_S3 as default. </p>
153
158
  */
@@ -159,6 +164,7 @@ export interface S3Configuration {
159
164
  */
160
165
  export interface ErrorReportConfiguration {
161
166
  /**
167
+ * @public
162
168
  * <p>The S3 configuration for the error reports.</p>
163
169
  */
164
170
  S3Configuration: S3Configuration | undefined;
@@ -169,6 +175,7 @@ export interface ErrorReportConfiguration {
169
175
  */
170
176
  export interface SnsConfiguration {
171
177
  /**
178
+ * @public
172
179
  * <p>SNS topic ARN that the scheduled query status notifications will be sent to.</p>
173
180
  */
174
181
  TopicArn: string | undefined;
@@ -180,6 +187,7 @@ export interface SnsConfiguration {
180
187
  */
181
188
  export interface NotificationConfiguration {
182
189
  /**
190
+ * @public
183
191
  * <p>Details on SNS configuration. </p>
184
192
  */
185
193
  SnsConfiguration: SnsConfiguration | undefined;
@@ -190,6 +198,7 @@ export interface NotificationConfiguration {
190
198
  */
191
199
  export interface ScheduleConfiguration {
192
200
  /**
201
+ * @public
193
202
  * <p>An expression that denotes when to trigger the scheduled query run. This can be a cron
194
203
  * expression or a rate expression. </p>
195
204
  */
@@ -204,10 +213,12 @@ export interface ScheduleConfiguration {
204
213
  */
205
214
  export interface Tag {
206
215
  /**
216
+ * @public
207
217
  * <p>The key of the tag. Tag keys are case sensitive. </p>
208
218
  */
209
219
  Key: string | undefined;
210
220
  /**
221
+ * @public
211
222
  * <p>The value of the tag. Tag values are case sensitive and can be null. </p>
212
223
  */
213
224
  Value: string | undefined;
@@ -230,10 +241,12 @@ export type DimensionValueType = (typeof DimensionValueType)[keyof typeof Dimens
230
241
  */
231
242
  export interface DimensionMapping {
232
243
  /**
244
+ * @public
233
245
  * <p>Column name from query result.</p>
234
246
  */
235
247
  Name: string | undefined;
236
248
  /**
249
+ * @public
237
250
  * <p>Type for the dimension. </p>
238
251
  */
239
252
  DimensionValueType: DimensionValueType | string | undefined;
@@ -274,15 +287,18 @@ export type ScalarMeasureValueType = (typeof ScalarMeasureValueType)[keyof typeo
274
287
  */
275
288
  export interface MultiMeasureAttributeMapping {
276
289
  /**
290
+ * @public
277
291
  * <p>Source column from where the attribute value is to be read.</p>
278
292
  */
279
293
  SourceColumn: string | undefined;
280
294
  /**
295
+ * @public
281
296
  * <p>Custom name to be used for attribute name in derived table. If not provided, source
282
297
  * column name would be used.</p>
283
298
  */
284
299
  TargetMultiMeasureAttributeName?: string;
285
300
  /**
301
+ * @public
286
302
  * <p>Type of the attribute to be read from the source column.</p>
287
303
  */
288
304
  MeasureValueType: ScalarMeasureValueType | string | undefined;
@@ -294,26 +310,31 @@ export interface MultiMeasureAttributeMapping {
294
310
  */
295
311
  export interface MixedMeasureMapping {
296
312
  /**
313
+ * @public
297
314
  * <p>Refers to the value of measure_name in a result row. This field is required if
298
315
  * MeasureNameColumn is provided.</p>
299
316
  */
300
317
  MeasureName?: string;
301
318
  /**
319
+ * @public
302
320
  * <p>This field refers to the source column from which measure-value is to be read for
303
321
  * result materialization.</p>
304
322
  */
305
323
  SourceColumn?: string;
306
324
  /**
325
+ * @public
307
326
  * <p>Target measure name to be used. If not provided, the target measure name by default
308
327
  * would be measure-name if provided, or sourceColumn otherwise. </p>
309
328
  */
310
329
  TargetMeasureName?: string;
311
330
  /**
331
+ * @public
312
332
  * <p>Type of the value that is to be read from sourceColumn. If the mapping is for MULTI,
313
333
  * use MeasureValueType.MULTI.</p>
314
334
  */
315
335
  MeasureValueType: MeasureValueType | string | undefined;
316
336
  /**
337
+ * @public
317
338
  * <p>Required when measureValueType is MULTI. Attribute mappings for MULTI value
318
339
  * measures.</p>
319
340
  */
@@ -327,12 +348,14 @@ export interface MixedMeasureMapping {
327
348
  */
328
349
  export interface MultiMeasureMappings {
329
350
  /**
351
+ * @public
330
352
  * <p>The name of the target multi-measure name in the derived table. This input is required
331
353
  * when measureNameColumn is not provided. If MeasureNameColumn is provided, then value
332
354
  * from that column will be used as multi-measure name.</p>
333
355
  */
334
356
  TargetMultiMeasureName?: string;
335
357
  /**
358
+ * @public
336
359
  * <p>Required. Attribute mappings to be used for mapping query results to ingest data for
337
360
  * multi-measure attributes.</p>
338
361
  */
@@ -346,33 +369,40 @@ export interface MultiMeasureMappings {
346
369
  */
347
370
  export interface TimestreamConfiguration {
348
371
  /**
372
+ * @public
349
373
  * <p>Name of Timestream database to which the query result will be written.</p>
350
374
  */
351
375
  DatabaseName: string | undefined;
352
376
  /**
377
+ * @public
353
378
  * <p>Name of Timestream table that the query result will be written to. The table should
354
379
  * be within the same database that is provided in Timestream configuration.</p>
355
380
  */
356
381
  TableName: string | undefined;
357
382
  /**
383
+ * @public
358
384
  * <p>Column from query result that should be used as the time column in destination table.
359
385
  * Column type for this should be TIMESTAMP.</p>
360
386
  */
361
387
  TimeColumn: string | undefined;
362
388
  /**
389
+ * @public
363
390
  * <p> This is to allow mapping column(s) from the query result to the dimension in the
364
391
  * destination table. </p>
365
392
  */
366
393
  DimensionMappings: DimensionMapping[] | undefined;
367
394
  /**
395
+ * @public
368
396
  * <p>Multi-measure mappings.</p>
369
397
  */
370
398
  MultiMeasureMappings?: MultiMeasureMappings;
371
399
  /**
400
+ * @public
372
401
  * <p>Specifies how to map measures to multi-measure records.</p>
373
402
  */
374
403
  MixedMeasureMappings?: MixedMeasureMapping[];
375
404
  /**
405
+ * @public
376
406
  * <p>Name of the measure column.</p>
377
407
  */
378
408
  MeasureNameColumn?: string;
@@ -383,6 +413,7 @@ export interface TimestreamConfiguration {
383
413
  */
384
414
  export interface TargetConfiguration {
385
415
  /**
416
+ * @public
386
417
  * <p>Configuration needed to write data into the Timestream database and table.</p>
387
418
  */
388
419
  TimestreamConfiguration: TimestreamConfiguration | undefined;
@@ -392,10 +423,12 @@ export interface TargetConfiguration {
392
423
  */
393
424
  export interface CreateScheduledQueryRequest {
394
425
  /**
426
+ * @public
395
427
  * <p>Name of the scheduled query.</p>
396
428
  */
397
429
  Name: string | undefined;
398
430
  /**
431
+ * @public
399
432
  * <p>The query string to run. Parameter
400
433
  * names can be specified in the query string <code>@</code> character followed by an
401
434
  * identifier. The named Parameter <code>@scheduled_runtime</code> is reserved and can be used in the query to get the time at which the query is scheduled to run.</p>
@@ -405,19 +438,23 @@ export interface CreateScheduledQueryRequest {
405
438
  */
406
439
  QueryString: string | undefined;
407
440
  /**
441
+ * @public
408
442
  * <p>The schedule configuration for the query.</p>
409
443
  */
410
444
  ScheduleConfiguration: ScheduleConfiguration | undefined;
411
445
  /**
446
+ * @public
412
447
  * <p>Notification configuration for the scheduled query. A notification is sent by
413
448
  * Timestream when a query run finishes, when the state is updated or when you delete it. </p>
414
449
  */
415
450
  NotificationConfiguration: NotificationConfiguration | undefined;
416
451
  /**
452
+ * @public
417
453
  * <p>Configuration used for writing the result of a query.</p>
418
454
  */
419
455
  TargetConfiguration?: TargetConfiguration;
420
456
  /**
457
+ * @public
421
458
  * <p>Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making
422
459
  * multiple identical CreateScheduledQuery requests has the same effect as making a single request.
423
460
  *
@@ -435,14 +472,17 @@ export interface CreateScheduledQueryRequest {
435
472
  */
436
473
  ClientToken?: string;
437
474
  /**
475
+ * @public
438
476
  * <p>The ARN for the IAM role that Timestream will assume when running the scheduled query. </p>
439
477
  */
440
478
  ScheduledQueryExecutionRoleArn: string | undefined;
441
479
  /**
480
+ * @public
442
481
  * <p>A list of key-value pairs to label the scheduled query.</p>
443
482
  */
444
483
  Tags?: Tag[];
445
484
  /**
485
+ * @public
446
486
  * <p>The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS
447
487
  * key is not specified, the scheduled query resource will be encrypted with a Timestream
448
488
  * owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias
@@ -452,6 +492,7 @@ export interface CreateScheduledQueryRequest {
452
492
  */
453
493
  KmsKeyId?: string;
454
494
  /**
495
+ * @public
455
496
  * <p>Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results. </p>
456
497
  */
457
498
  ErrorReportConfiguration: ErrorReportConfiguration | undefined;
@@ -461,6 +502,7 @@ export interface CreateScheduledQueryRequest {
461
502
  */
462
503
  export interface CreateScheduledQueryResponse {
463
504
  /**
505
+ * @public
464
506
  * <p>ARN for the created scheduled query.</p>
465
507
  */
466
508
  Arn: string | undefined;
@@ -483,6 +525,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
483
525
  */
484
526
  export interface DeleteScheduledQueryRequest {
485
527
  /**
528
+ * @public
486
529
  * <p>The ARN of the scheduled query. </p>
487
530
  */
488
531
  ScheduledQueryArn: string | undefined;
@@ -496,6 +539,7 @@ export declare class ResourceNotFoundException extends __BaseException {
496
539
  readonly $fault: "client";
497
540
  Message?: string;
498
541
  /**
542
+ * @public
499
543
  * <p>The ARN of the scheduled query.</p>
500
544
  */
501
545
  ScheduledQueryArn?: string;
@@ -516,10 +560,12 @@ export interface DescribeEndpointsRequest {
516
560
  */
517
561
  export interface Endpoint {
518
562
  /**
563
+ * @public
519
564
  * <p>An endpoint address.</p>
520
565
  */
521
566
  Address: string | undefined;
522
567
  /**
568
+ * @public
523
569
  * <p>The TTL for the endpoint, in minutes.</p>
524
570
  */
525
571
  CachePeriodInMinutes: number | undefined;
@@ -529,6 +575,7 @@ export interface Endpoint {
529
575
  */
530
576
  export interface DescribeEndpointsResponse {
531
577
  /**
578
+ * @public
532
579
  * <p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>
533
580
  * request is made.</p>
534
581
  */
@@ -539,6 +586,7 @@ export interface DescribeEndpointsResponse {
539
586
  */
540
587
  export interface DescribeScheduledQueryRequest {
541
588
  /**
589
+ * @public
542
590
  * <p>The ARN of the scheduled query.</p>
543
591
  */
544
592
  ScheduledQueryArn: string | undefined;
@@ -549,10 +597,12 @@ export interface DescribeScheduledQueryRequest {
549
597
  */
550
598
  export interface S3ReportLocation {
551
599
  /**
600
+ * @public
552
601
  * <p> S3 bucket name. </p>
553
602
  */
554
603
  BucketName?: string;
555
604
  /**
605
+ * @public
556
606
  * <p>S3 key. </p>
557
607
  */
558
608
  ObjectKey?: string;
@@ -564,6 +614,7 @@ export interface S3ReportLocation {
564
614
  */
565
615
  export interface ErrorReportLocation {
566
616
  /**
617
+ * @public
567
618
  * <p>The S3 location where error reports are written.</p>
568
619
  */
569
620
  S3ReportLocation?: S3ReportLocation;
@@ -574,22 +625,27 @@ export interface ErrorReportLocation {
574
625
  */
575
626
  export interface ExecutionStats {
576
627
  /**
628
+ * @public
577
629
  * <p>Total time, measured in milliseconds, that was needed for the scheduled query run to complete.</p>
578
630
  */
579
631
  ExecutionTimeInMillis?: number;
580
632
  /**
633
+ * @public
581
634
  * <p>Data writes metered for records ingested in a single scheduled query run.</p>
582
635
  */
583
636
  DataWrites?: number;
584
637
  /**
638
+ * @public
585
639
  * <p>Bytes metered for a single scheduled query run.</p>
586
640
  */
587
641
  BytesMetered?: number;
588
642
  /**
643
+ * @public
589
644
  * <p>The number of records ingested for a single scheduled query run. </p>
590
645
  */
591
646
  RecordsIngested?: number;
592
647
  /**
648
+ * @public
593
649
  * <p>Number of rows present in the output from running a query before ingestion to
594
650
  * destination data source.</p>
595
651
  */
@@ -615,27 +671,33 @@ export type ScheduledQueryRunStatus = (typeof ScheduledQueryRunStatus)[keyof typ
615
671
  */
616
672
  export interface ScheduledQueryRunSummary {
617
673
  /**
674
+ * @public
618
675
  * <p>InvocationTime for this run. This is the time at which the query is scheduled to run.
619
676
  * Parameter <code>@scheduled_runtime</code> can be used in the query to get the value. </p>
620
677
  */
621
678
  InvocationTime?: Date;
622
679
  /**
680
+ * @public
623
681
  * <p>The actual time when the query was run.</p>
624
682
  */
625
683
  TriggerTime?: Date;
626
684
  /**
685
+ * @public
627
686
  * <p>The status of a scheduled query run.</p>
628
687
  */
629
688
  RunStatus?: ScheduledQueryRunStatus | string;
630
689
  /**
690
+ * @public
631
691
  * <p>Runtime statistics for a scheduled run.</p>
632
692
  */
633
693
  ExecutionStats?: ExecutionStats;
634
694
  /**
695
+ * @public
635
696
  * <p>S3 location for error report.</p>
636
697
  */
637
698
  ErrorReportLocation?: ErrorReportLocation;
638
699
  /**
700
+ * @public
639
701
  * <p>Error message for the scheduled query in case of failure. You might have to look at
640
702
  * the error report to get more detailed error reasons. </p>
641
703
  */
@@ -659,62 +721,77 @@ export type ScheduledQueryState = (typeof ScheduledQueryState)[keyof typeof Sche
659
721
  */
660
722
  export interface ScheduledQueryDescription {
661
723
  /**
724
+ * @public
662
725
  * <p>Scheduled query ARN.</p>
663
726
  */
664
727
  Arn: string | undefined;
665
728
  /**
729
+ * @public
666
730
  * <p>Name of the scheduled query.</p>
667
731
  */
668
732
  Name: string | undefined;
669
733
  /**
734
+ * @public
670
735
  * <p>The query to be run.</p>
671
736
  */
672
737
  QueryString: string | undefined;
673
738
  /**
739
+ * @public
674
740
  * <p>Creation time of the scheduled query.</p>
675
741
  */
676
742
  CreationTime?: Date;
677
743
  /**
744
+ * @public
678
745
  * <p>State of the scheduled query. </p>
679
746
  */
680
747
  State: ScheduledQueryState | string | undefined;
681
748
  /**
749
+ * @public
682
750
  * <p>Last time the query was run.</p>
683
751
  */
684
752
  PreviousInvocationTime?: Date;
685
753
  /**
754
+ * @public
686
755
  * <p>The next time the scheduled query is scheduled to run.</p>
687
756
  */
688
757
  NextInvocationTime?: Date;
689
758
  /**
759
+ * @public
690
760
  * <p>Schedule configuration.</p>
691
761
  */
692
762
  ScheduleConfiguration: ScheduleConfiguration | undefined;
693
763
  /**
764
+ * @public
694
765
  * <p>Notification configuration.</p>
695
766
  */
696
767
  NotificationConfiguration: NotificationConfiguration | undefined;
697
768
  /**
769
+ * @public
698
770
  * <p>Scheduled query target store configuration.</p>
699
771
  */
700
772
  TargetConfiguration?: TargetConfiguration;
701
773
  /**
774
+ * @public
702
775
  * <p>IAM role that Timestream uses to run the schedule query.</p>
703
776
  */
704
777
  ScheduledQueryExecutionRoleArn?: string;
705
778
  /**
779
+ * @public
706
780
  * <p>A customer provided KMS key used to encrypt the scheduled query resource.</p>
707
781
  */
708
782
  KmsKeyId?: string;
709
783
  /**
784
+ * @public
710
785
  * <p>Error-reporting configuration for the scheduled query.</p>
711
786
  */
712
787
  ErrorReportConfiguration?: ErrorReportConfiguration;
713
788
  /**
789
+ * @public
714
790
  * <p>Runtime summary for the last scheduled query run. </p>
715
791
  */
716
792
  LastRunSummary?: ScheduledQueryRunSummary;
717
793
  /**
794
+ * @public
718
795
  * <p>Runtime summary for the last five failed scheduled query runs.</p>
719
796
  */
720
797
  RecentlyFailedRuns?: ScheduledQueryRunSummary[];
@@ -724,6 +801,7 @@ export interface ScheduledQueryDescription {
724
801
  */
725
802
  export interface DescribeScheduledQueryResponse {
726
803
  /**
804
+ * @public
727
805
  * <p>The scheduled query.</p>
728
806
  */
729
807
  ScheduledQuery: ScheduledQueryDescription | undefined;
@@ -733,14 +811,17 @@ export interface DescribeScheduledQueryResponse {
733
811
  */
734
812
  export interface ExecuteScheduledQueryRequest {
735
813
  /**
814
+ * @public
736
815
  * <p>ARN of the scheduled query.</p>
737
816
  */
738
817
  ScheduledQueryArn: string | undefined;
739
818
  /**
819
+ * @public
740
820
  * <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp. </p>
741
821
  */
742
822
  InvocationTime: Date | undefined;
743
823
  /**
824
+ * @public
744
825
  * <p>Not used. </p>
745
826
  */
746
827
  ClientToken?: string;
@@ -750,6 +831,7 @@ export interface ExecuteScheduledQueryRequest {
750
831
  */
751
832
  export interface ListScheduledQueriesRequest {
752
833
  /**
834
+ * @public
753
835
  * <p>The maximum number of items to return in the output. If the total number of items
754
836
  * available is more than the value specified, a <code>NextToken</code> is provided in the
755
837
  * output. To resume pagination, provide the <code>NextToken</code> value as the argument
@@ -757,6 +839,7 @@ export interface ListScheduledQueriesRequest {
757
839
  */
758
840
  MaxResults?: number;
759
841
  /**
842
+ * @public
760
843
  * <p> A pagination token to resume pagination.</p>
761
844
  */
762
845
  NextToken?: string;
@@ -767,10 +850,12 @@ export interface ListScheduledQueriesRequest {
767
850
  */
768
851
  export interface TimestreamDestination {
769
852
  /**
853
+ * @public
770
854
  * <p>Timestream database name. </p>
771
855
  */
772
856
  DatabaseName?: string;
773
857
  /**
858
+ * @public
774
859
  * <p>Timestream table name. </p>
775
860
  */
776
861
  TableName?: string;
@@ -782,6 +867,7 @@ export interface TimestreamDestination {
782
867
  */
783
868
  export interface TargetDestination {
784
869
  /**
870
+ * @public
785
871
  * <p>Query result destination details for Timestream data source.</p>
786
872
  */
787
873
  TimestreamDestination?: TimestreamDestination;
@@ -792,38 +878,47 @@ export interface TargetDestination {
792
878
  */
793
879
  export interface ScheduledQuery {
794
880
  /**
881
+ * @public
795
882
  * <p>The Amazon Resource Name.</p>
796
883
  */
797
884
  Arn: string | undefined;
798
885
  /**
886
+ * @public
799
887
  * <p>The name of the scheduled query.</p>
800
888
  */
801
889
  Name: string | undefined;
802
890
  /**
891
+ * @public
803
892
  * <p>The creation time of the scheduled query.</p>
804
893
  */
805
894
  CreationTime?: Date;
806
895
  /**
896
+ * @public
807
897
  * <p>State of scheduled query. </p>
808
898
  */
809
899
  State: ScheduledQueryState | string | undefined;
810
900
  /**
901
+ * @public
811
902
  * <p>The last time the scheduled query was run.</p>
812
903
  */
813
904
  PreviousInvocationTime?: Date;
814
905
  /**
906
+ * @public
815
907
  * <p>The next time the scheduled query is to be run.</p>
816
908
  */
817
909
  NextInvocationTime?: Date;
818
910
  /**
911
+ * @public
819
912
  * <p>Configuration for scheduled query error reporting.</p>
820
913
  */
821
914
  ErrorReportConfiguration?: ErrorReportConfiguration;
822
915
  /**
916
+ * @public
823
917
  * <p>Target data source where final scheduled query result will be written.</p>
824
918
  */
825
919
  TargetDestination?: TargetDestination;
826
920
  /**
921
+ * @public
827
922
  * <p>Status of the last scheduled query run.</p>
828
923
  */
829
924
  LastRunStatus?: ScheduledQueryRunStatus | string;
@@ -833,10 +928,12 @@ export interface ScheduledQuery {
833
928
  */
834
929
  export interface ListScheduledQueriesResponse {
835
930
  /**
931
+ * @public
836
932
  * <p>A list of scheduled queries.</p>
837
933
  */
838
934
  ScheduledQueries: ScheduledQuery[] | undefined;
839
935
  /**
936
+ * @public
840
937
  * <p>A token to specify where to start paginating. This is the NextToken from a previously
841
938
  * truncated response.</p>
842
939
  */
@@ -847,15 +944,18 @@ export interface ListScheduledQueriesResponse {
847
944
  */
848
945
  export interface ListTagsForResourceRequest {
849
946
  /**
947
+ * @public
850
948
  * <p>The Timestream resource with tags to be listed. This value is an Amazon Resource Name
851
949
  * (ARN).</p>
852
950
  */
853
951
  ResourceARN: string | undefined;
854
952
  /**
953
+ * @public
855
954
  * <p>The maximum number of tags to return.</p>
856
955
  */
857
956
  MaxResults?: number;
858
957
  /**
958
+ * @public
859
959
  * <p>A pagination token to resume pagination.</p>
860
960
  */
861
961
  NextToken?: string;
@@ -865,10 +965,12 @@ export interface ListTagsForResourceRequest {
865
965
  */
866
966
  export interface ListTagsForResourceResponse {
867
967
  /**
968
+ * @public
868
969
  * <p>The tags currently associated with the Timestream resource. </p>
869
970
  */
870
971
  Tags: Tag[] | undefined;
871
972
  /**
973
+ * @public
872
974
  * <p>A pagination token to resume pagination with a subsequent call to
873
975
  * <code>ListTagsForResourceResponse</code>.</p>
874
976
  */
@@ -879,12 +981,14 @@ export interface ListTagsForResourceResponse {
879
981
  */
880
982
  export interface PrepareQueryRequest {
881
983
  /**
984
+ * @public
882
985
  * <p>The Timestream query string that you want to use as a prepared statement. Parameter
883
986
  * names can be specified in the query string <code>@</code> character followed by an
884
987
  * identifier. </p>
885
988
  */
886
989
  QueryString: string | undefined;
887
990
  /**
991
+ * @public
888
992
  * <p>By setting this value to <code>true</code>, Timestream will only validate that the
889
993
  * query string is a valid Timestream query, and not store the prepared query for later
890
994
  * use.</p>
@@ -910,10 +1014,12 @@ export declare class QueryExecutionException extends __BaseException {
910
1014
  */
911
1015
  export interface QueryRequest {
912
1016
  /**
1017
+ * @public
913
1018
  * <p> The query to be run by Timestream. </p>
914
1019
  */
915
1020
  QueryString: string | undefined;
916
1021
  /**
1022
+ * @public
917
1023
  * <p> Unique, case-sensitive string of up to 64 ASCII characters specified when a
918
1024
  * <code>Query</code> request is made. Providing a <code>ClientToken</code> makes the
919
1025
  * call to <code>Query</code>
@@ -944,6 +1050,7 @@ export interface QueryRequest {
944
1050
  */
945
1051
  ClientToken?: string;
946
1052
  /**
1053
+ * @public
947
1054
  * <p> A pagination token used to return a set of results. When the <code>Query</code> API
948
1055
  * is invoked using <code>NextToken</code>, that particular invocation is assumed to be a
949
1056
  * subsequent invocation of a prior call to <code>Query</code>, and a result set is
@@ -986,6 +1093,7 @@ export interface QueryRequest {
986
1093
  */
987
1094
  NextToken?: string;
988
1095
  /**
1096
+ * @public
989
1097
  * <p> The total number of rows to be returned in the <code>Query</code> output. The initial
990
1098
  * run of <code>Query</code> with a <code>MaxRows</code> value specified will return the
991
1099
  * result set of the query in two cases: </p>
@@ -1016,15 +1124,18 @@ export interface QueryRequest {
1016
1124
  */
1017
1125
  export interface QueryStatus {
1018
1126
  /**
1127
+ * @public
1019
1128
  * <p>The progress of the query, expressed as a percentage.</p>
1020
1129
  */
1021
1130
  ProgressPercentage?: number;
1022
1131
  /**
1132
+ * @public
1023
1133
  * <p>The amount of data scanned by the query in bytes. This is a cumulative sum and
1024
1134
  * represents the total amount of bytes scanned since the query was started. </p>
1025
1135
  */
1026
1136
  CumulativeBytesScanned?: number;
1027
1137
  /**
1138
+ * @public
1028
1139
  * <p>The amount of data scanned by the query in bytes that you will be charged for. This is
1029
1140
  * a cumulative sum and represents the total amount of data that you will be charged for
1030
1141
  * since the query was started. The charge is applied only once and is either applied when
@@ -1037,11 +1148,13 @@ export interface QueryStatus {
1037
1148
  */
1038
1149
  export interface TagResourceRequest {
1039
1150
  /**
1151
+ * @public
1040
1152
  * <p>Identifies the Timestream resource to which tags should be added. This value is an
1041
1153
  * Amazon Resource Name (ARN).</p>
1042
1154
  */
1043
1155
  ResourceARN: string | undefined;
1044
1156
  /**
1157
+ * @public
1045
1158
  * <p>The tags to be assigned to the Timestream resource.</p>
1046
1159
  */
1047
1160
  Tags: Tag[] | undefined;
@@ -1056,11 +1169,13 @@ export interface TagResourceResponse {
1056
1169
  */
1057
1170
  export interface UntagResourceRequest {
1058
1171
  /**
1172
+ * @public
1059
1173
  * <p>The Timestream resource that the tags will be removed from. This value is an Amazon
1060
1174
  * Resource Name (ARN). </p>
1061
1175
  */
1062
1176
  ResourceARN: string | undefined;
1063
1177
  /**
1178
+ * @public
1064
1179
  * <p>A list of tags keys. Existing tags of the resource whose keys are members of this list
1065
1180
  * will be removed from the Timestream resource. </p>
1066
1181
  */
@@ -1076,10 +1191,12 @@ export interface UntagResourceResponse {
1076
1191
  */
1077
1192
  export interface UpdateScheduledQueryRequest {
1078
1193
  /**
1194
+ * @public
1079
1195
  * <p>ARN of the scheuled query.</p>
1080
1196
  */
1081
1197
  ScheduledQueryArn: string | undefined;
1082
1198
  /**
1199
+ * @public
1083
1200
  * <p>State of the scheduled query. </p>
1084
1201
  */
1085
1202
  State: ScheduledQueryState | string | undefined;
@@ -1091,11 +1208,13 @@ export interface UpdateScheduledQueryRequest {
1091
1208
  */
1092
1209
  export interface ColumnInfo {
1093
1210
  /**
1211
+ * @public
1094
1212
  * <p> The name of the result set column. The name of the result set is available for
1095
1213
  * columns of all data types except for arrays. </p>
1096
1214
  */
1097
1215
  Name?: string;
1098
1216
  /**
1217
+ * @public
1099
1218
  * <p>The data type of the result set column. The data type can be a scalar or complex.
1100
1219
  * Scalar data types are integers, strings, doubles, Booleans, and others. Complex data
1101
1220
  * types are types such as arrays, rows, and others. </p>
@@ -1111,19 +1230,23 @@ export interface ColumnInfo {
1111
1230
  */
1112
1231
  export interface Type {
1113
1232
  /**
1233
+ * @public
1114
1234
  * <p>Indicates if the column is of type string, integer, Boolean, double, timestamp, date,
1115
1235
  * time. </p>
1116
1236
  */
1117
1237
  ScalarType?: ScalarType | string;
1118
1238
  /**
1239
+ * @public
1119
1240
  * <p>Indicates if the column is an array.</p>
1120
1241
  */
1121
1242
  ArrayColumnInfo?: ColumnInfo;
1122
1243
  /**
1244
+ * @public
1123
1245
  * <p>Indicates if the column is a timeseries data type.</p>
1124
1246
  */
1125
1247
  TimeSeriesMeasureValueColumnInfo?: ColumnInfo;
1126
1248
  /**
1249
+ * @public
1127
1250
  * <p>Indicates if the column is a row.</p>
1128
1251
  */
1129
1252
  RowColumnInfo?: ColumnInfo[];
@@ -1134,23 +1257,28 @@ export interface Type {
1134
1257
  */
1135
1258
  export interface Datum {
1136
1259
  /**
1260
+ * @public
1137
1261
  * <p> Indicates if the data point is a scalar value such as integer, string, double, or
1138
1262
  * Boolean. </p>
1139
1263
  */
1140
1264
  ScalarValue?: string;
1141
1265
  /**
1266
+ * @public
1142
1267
  * <p> Indicates if the data point is a timeseries data type. </p>
1143
1268
  */
1144
1269
  TimeSeriesValue?: TimeSeriesDataPoint[];
1145
1270
  /**
1271
+ * @public
1146
1272
  * <p> Indicates if the data point is an array. </p>
1147
1273
  */
1148
1274
  ArrayValue?: Datum[];
1149
1275
  /**
1276
+ * @public
1150
1277
  * <p> Indicates if the data point is a row. </p>
1151
1278
  */
1152
1279
  RowValue?: Row;
1153
1280
  /**
1281
+ * @public
1154
1282
  * <p> Indicates if the data point is null. </p>
1155
1283
  */
1156
1284
  NullValue?: boolean;
@@ -1161,10 +1289,12 @@ export interface Datum {
1161
1289
  */
1162
1290
  export interface ParameterMapping {
1163
1291
  /**
1292
+ * @public
1164
1293
  * <p>Parameter name.</p>
1165
1294
  */
1166
1295
  Name: string | undefined;
1167
1296
  /**
1297
+ * @public
1168
1298
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
1169
1299
  * or complex. The supported scalar data types are integers, Boolean, string, double,
1170
1300
  * timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
@@ -1178,10 +1308,12 @@ export interface ParameterMapping {
1178
1308
  */
1179
1309
  export interface SelectColumn {
1180
1310
  /**
1311
+ * @public
1181
1312
  * <p>Name of the column.</p>
1182
1313
  */
1183
1314
  Name?: string;
1184
1315
  /**
1316
+ * @public
1185
1317
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
1186
1318
  * or complex. The supported scalar data types are integers, Boolean, string, double,
1187
1319
  * timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
@@ -1189,14 +1321,17 @@ export interface SelectColumn {
1189
1321
  */
1190
1322
  Type?: Type;
1191
1323
  /**
1324
+ * @public
1192
1325
  * <p> Database that has this column.</p>
1193
1326
  */
1194
1327
  DatabaseName?: string;
1195
1328
  /**
1329
+ * @public
1196
1330
  * <p>Table within the database that has this column. </p>
1197
1331
  */
1198
1332
  TableName?: string;
1199
1333
  /**
1334
+ * @public
1200
1335
  * <p>True, if the column name was aliased by the query. False otherwise.</p>
1201
1336
  */
1202
1337
  Aliased?: boolean;
@@ -1210,10 +1345,12 @@ export interface SelectColumn {
1210
1345
  */
1211
1346
  export interface TimeSeriesDataPoint {
1212
1347
  /**
1348
+ * @public
1213
1349
  * <p>The timestamp when the measure value was collected.</p>
1214
1350
  */
1215
1351
  Time: string | undefined;
1216
1352
  /**
1353
+ * @public
1217
1354
  * <p>The measure value for the data point.</p>
1218
1355
  */
1219
1356
  Value: Datum | undefined;
@@ -1224,6 +1361,7 @@ export interface TimeSeriesDataPoint {
1224
1361
  */
1225
1362
  export interface Row {
1226
1363
  /**
1364
+ * @public
1227
1365
  * <p>List of data points in a single row of the result set.</p>
1228
1366
  */
1229
1367
  Data: Datum[] | undefined;
@@ -1233,23 +1371,28 @@ export interface Row {
1233
1371
  */
1234
1372
  export interface QueryResponse {
1235
1373
  /**
1374
+ * @public
1236
1375
  * <p> A unique ID for the given query. </p>
1237
1376
  */
1238
1377
  QueryId: string | undefined;
1239
1378
  /**
1379
+ * @public
1240
1380
  * <p> A pagination token that can be used again on a <code>Query</code> call to get the
1241
1381
  * next set of results. </p>
1242
1382
  */
1243
1383
  NextToken?: string;
1244
1384
  /**
1385
+ * @public
1245
1386
  * <p> The result set rows returned by the query. </p>
1246
1387
  */
1247
1388
  Rows: Row[] | undefined;
1248
1389
  /**
1390
+ * @public
1249
1391
  * <p> The column data types of the returned result set. </p>
1250
1392
  */
1251
1393
  ColumnInfo: ColumnInfo[] | undefined;
1252
1394
  /**
1395
+ * @public
1253
1396
  * <p>Information about the status of the query, including progress and bytes
1254
1397
  * scanned.</p>
1255
1398
  */
@@ -1260,14 +1403,17 @@ export interface QueryResponse {
1260
1403
  */
1261
1404
  export interface PrepareQueryResponse {
1262
1405
  /**
1406
+ * @public
1263
1407
  * <p>The query string that you want prepare.</p>
1264
1408
  */
1265
1409
  QueryString: string | undefined;
1266
1410
  /**
1411
+ * @public
1267
1412
  * <p>A list of SELECT clause columns of the submitted query string. </p>
1268
1413
  */
1269
1414
  Columns: SelectColumn[] | undefined;
1270
1415
  /**
1416
+ * @public
1271
1417
  * <p>A list of parameters used in the submitted query string. </p>
1272
1418
  */
1273
1419
  Parameters: ParameterMapping[] | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-timestream-query",
3
3
  "description": "AWS SDK for JavaScript Timestream Query Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
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.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
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.379.1",
31
+ "@aws-sdk/middleware-user-agent": "3.382.0",
32
32
  "@aws-sdk/types": "3.378.0",
33
- "@aws-sdk/util-endpoints": "3.378.0",
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",