@aws-sdk/client-timestream-query 3.529.1 → 3.535.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.
Files changed (39) hide show
  1. package/dist-types/TimestreamQuery.d.ts +3 -1
  2. package/dist-types/TimestreamQueryClient.d.ts +1 -1
  3. package/dist-types/commands/CancelQueryCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateScheduledQueryCommand.d.ts +2 -1
  5. package/dist-types/commands/DeleteScheduledQueryCommand.d.ts +2 -1
  6. package/dist-types/commands/DescribeEndpointsCommand.d.ts +2 -1
  7. package/dist-types/commands/DescribeScheduledQueryCommand.d.ts +2 -1
  8. package/dist-types/commands/ExecuteScheduledQueryCommand.d.ts +2 -1
  9. package/dist-types/commands/ListScheduledQueriesCommand.d.ts +2 -1
  10. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  11. package/dist-types/commands/PrepareQueryCommand.d.ts +2 -1
  12. package/dist-types/commands/QueryCommand.d.ts +2 -1
  13. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  14. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  15. package/dist-types/commands/UpdateScheduledQueryCommand.d.ts +2 -1
  16. package/dist-types/models/models_0.d.ts +184 -184
  17. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  18. package/dist-types/runtimeConfig.d.ts +2 -2
  19. package/dist-types/runtimeConfig.native.d.ts +2 -2
  20. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  21. package/dist-types/ts3.4/TimestreamQuery.d.ts +2 -0
  22. package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/CreateScheduledQueryCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/DeleteScheduledQueryCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DescribeEndpointsCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/DescribeScheduledQueryCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/ExecuteScheduledQueryCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/ListScheduledQueriesCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/PrepareQueryCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/QueryCommand.d.ts +7 -0
  32. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/UpdateScheduledQueryCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  36. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  37. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  38. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  39. package/package.json +41 -41
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { TimestreamQueryServiceException as __BaseException } from "./TimestreamQueryServiceException";
3
3
  /**
4
- * @public
5
4
  * <p> You are not authorized to perform this action. </p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -18,9 +18,9 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface CancelQueryRequest {
20
20
  /**
21
- * @public
22
21
  * <p> The ID of the query that needs to be cancelled. <code>QueryID</code> is returned as
23
22
  * part of the query result. </p>
23
+ * @public
24
24
  */
25
25
  QueryId: string | undefined;
26
26
  }
@@ -29,17 +29,17 @@ export interface CancelQueryRequest {
29
29
  */
30
30
  export interface CancelQueryResponse {
31
31
  /**
32
- * @public
33
32
  * <p> A <code>CancellationMessage</code> is returned when a <code>CancelQuery</code>
34
33
  * request for the query specified by <code>QueryId</code> has already been issued. </p>
34
+ * @public
35
35
  */
36
36
  CancellationMessage?: string;
37
37
  }
38
38
  /**
39
- * @public
40
39
  * <p>
41
40
  * Timestream was unable to fully process this request because of an internal
42
41
  * server error. </p>
42
+ * @public
43
43
  */
44
44
  export declare class InternalServerException extends __BaseException {
45
45
  readonly name: "InternalServerException";
@@ -51,8 +51,8 @@ export declare class InternalServerException extends __BaseException {
51
51
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
52
52
  }
53
53
  /**
54
- * @public
55
54
  * <p>The requested endpoint was not valid.</p>
55
+ * @public
56
56
  */
57
57
  export declare class InvalidEndpointException extends __BaseException {
58
58
  readonly name: "InvalidEndpointException";
@@ -64,8 +64,8 @@ export declare class InvalidEndpointException extends __BaseException {
64
64
  constructor(opts: __ExceptionOptionType<InvalidEndpointException, __BaseException>);
65
65
  }
66
66
  /**
67
- * @public
68
67
  * <p>The request was denied due to request throttling.</p>
68
+ * @public
69
69
  */
70
70
  export declare class ThrottlingException extends __BaseException {
71
71
  readonly name: "ThrottlingException";
@@ -77,8 +77,8 @@ export declare class ThrottlingException extends __BaseException {
77
77
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
78
78
  }
79
79
  /**
80
- * @public
81
80
  * <p> Invalid or malformed request. </p>
81
+ * @public
82
82
  */
83
83
  export declare class ValidationException extends __BaseException {
84
84
  readonly name: "ValidationException";
@@ -111,8 +111,8 @@ export declare const ScalarType: {
111
111
  */
112
112
  export type ScalarType = (typeof ScalarType)[keyof typeof ScalarType];
113
113
  /**
114
- * @public
115
114
  * <p> Unable to poll results for a cancelled query. </p>
115
+ * @public
116
116
  */
117
117
  export declare class ConflictException extends __BaseException {
118
118
  readonly name: "ConflictException";
@@ -136,90 +136,90 @@ export declare const S3EncryptionOption: {
136
136
  */
137
137
  export type S3EncryptionOption = (typeof S3EncryptionOption)[keyof typeof S3EncryptionOption];
138
138
  /**
139
- * @public
140
139
  * <p>Details on S3 location for error reports that result from running a query. </p>
140
+ * @public
141
141
  */
142
142
  export interface S3Configuration {
143
143
  /**
144
- * @public
145
144
  * <p> Name of the S3 bucket under which error reports will be created.</p>
145
+ * @public
146
146
  */
147
147
  BucketName: string | undefined;
148
148
  /**
149
- * @public
150
149
  * <p> Prefix for the error report key. Timestream by default adds the following prefix to
151
150
  * the error report path. </p>
151
+ * @public
152
152
  */
153
153
  ObjectKeyPrefix?: string;
154
154
  /**
155
- * @public
156
155
  * <p> Encryption at rest options for the error reports. If no encryption option is
157
156
  * specified, Timestream will choose SSE_S3 as default. </p>
157
+ * @public
158
158
  */
159
159
  EncryptionOption?: S3EncryptionOption;
160
160
  }
161
161
  /**
162
- * @public
163
162
  * <p>Configuration required for error reporting.</p>
163
+ * @public
164
164
  */
165
165
  export interface ErrorReportConfiguration {
166
166
  /**
167
- * @public
168
167
  * <p>The S3 configuration for the error reports.</p>
168
+ * @public
169
169
  */
170
170
  S3Configuration: S3Configuration | undefined;
171
171
  }
172
172
  /**
173
- * @public
174
173
  * <p>Details on SNS that are required to send the notification.</p>
174
+ * @public
175
175
  */
176
176
  export interface SnsConfiguration {
177
177
  /**
178
- * @public
179
178
  * <p>SNS topic ARN that the scheduled query status notifications will be sent to.</p>
179
+ * @public
180
180
  */
181
181
  TopicArn: string | undefined;
182
182
  }
183
183
  /**
184
- * @public
185
184
  * <p>Notification configuration for a scheduled query. A notification is sent by
186
185
  * Timestream when a scheduled query is created, its state is updated or when it is deleted. </p>
186
+ * @public
187
187
  */
188
188
  export interface NotificationConfiguration {
189
189
  /**
190
- * @public
191
190
  * <p>Details on SNS configuration. </p>
191
+ * @public
192
192
  */
193
193
  SnsConfiguration: SnsConfiguration | undefined;
194
194
  }
195
195
  /**
196
- * @public
197
196
  * <p>Configuration of the schedule of the query.</p>
197
+ * @public
198
198
  */
199
199
  export interface ScheduleConfiguration {
200
200
  /**
201
- * @public
202
201
  * <p>An expression that denotes when to trigger the scheduled query run. This can be a cron
203
202
  * expression or a rate expression. </p>
203
+ * @public
204
204
  */
205
205
  ScheduleExpression: string | undefined;
206
206
  }
207
207
  /**
208
- * @public
209
208
  * <p>A tag is a label that you assign to a Timestream database and/or table. Each tag
210
209
  * consists of a key and an optional value, both of which you define. Tags enable you to
211
210
  * categorize databases and/or tables, for example, by purpose, owner, or environment.
212
211
  * </p>
212
+ * @public
213
213
  */
214
214
  export interface Tag {
215
215
  /**
216
- * @public
217
216
  * <p>The key of the tag. Tag keys are case sensitive. </p>
217
+ * @public
218
218
  */
219
219
  Key: string | undefined;
220
220
  /**
221
- * @public
222
221
  * <p>The value of the tag. Tag values are case sensitive and can be null. </p>
222
+ * @public
223
223
  */
224
224
  Value: string | undefined;
225
225
  }
@@ -235,19 +235,19 @@ export declare const DimensionValueType: {
235
235
  */
236
236
  export type DimensionValueType = (typeof DimensionValueType)[keyof typeof DimensionValueType];
237
237
  /**
238
- * @public
239
238
  * <p>This type is used to map column(s) from the query result to a dimension in the
240
239
  * destination table.</p>
240
+ * @public
241
241
  */
242
242
  export interface DimensionMapping {
243
243
  /**
244
- * @public
245
244
  * <p>Column name from query result.</p>
245
+ * @public
246
246
  */
247
247
  Name: string | undefined;
248
248
  /**
249
- * @public
250
249
  * <p>Type for the dimension. </p>
250
+ * @public
251
251
  */
252
252
  DimensionValueType: DimensionValueType | undefined;
253
253
  }
@@ -282,139 +282,139 @@ export declare const ScalarMeasureValueType: {
282
282
  */
283
283
  export type ScalarMeasureValueType = (typeof ScalarMeasureValueType)[keyof typeof ScalarMeasureValueType];
284
284
  /**
285
- * @public
286
285
  * <p>Attribute mapping for MULTI value measures.</p>
286
+ * @public
287
287
  */
288
288
  export interface MultiMeasureAttributeMapping {
289
289
  /**
290
- * @public
291
290
  * <p>Source column from where the attribute value is to be read.</p>
291
+ * @public
292
292
  */
293
293
  SourceColumn: string | undefined;
294
294
  /**
295
- * @public
296
295
  * <p>Custom name to be used for attribute name in derived table. If not provided, source
297
296
  * column name would be used.</p>
297
+ * @public
298
298
  */
299
299
  TargetMultiMeasureAttributeName?: string;
300
300
  /**
301
- * @public
302
301
  * <p>Type of the attribute to be read from the source column.</p>
302
+ * @public
303
303
  */
304
304
  MeasureValueType: ScalarMeasureValueType | undefined;
305
305
  }
306
306
  /**
307
- * @public
308
307
  * <p>MixedMeasureMappings are mappings that can be used to ingest data into a mixture of
309
308
  * narrow and multi measures in the derived table.</p>
309
+ * @public
310
310
  */
311
311
  export interface MixedMeasureMapping {
312
312
  /**
313
- * @public
314
313
  * <p>Refers to the value of measure_name in a result row. This field is required if
315
314
  * MeasureNameColumn is provided.</p>
315
+ * @public
316
316
  */
317
317
  MeasureName?: string;
318
318
  /**
319
- * @public
320
319
  * <p>This field refers to the source column from which measure-value is to be read for
321
320
  * result materialization.</p>
321
+ * @public
322
322
  */
323
323
  SourceColumn?: string;
324
324
  /**
325
- * @public
326
325
  * <p>Target measure name to be used. If not provided, the target measure name by default
327
326
  * would be measure-name if provided, or sourceColumn otherwise. </p>
327
+ * @public
328
328
  */
329
329
  TargetMeasureName?: string;
330
330
  /**
331
- * @public
332
331
  * <p>Type of the value that is to be read from sourceColumn. If the mapping is for MULTI,
333
332
  * use MeasureValueType.MULTI.</p>
333
+ * @public
334
334
  */
335
335
  MeasureValueType: MeasureValueType | undefined;
336
336
  /**
337
- * @public
338
337
  * <p>Required when measureValueType is MULTI. Attribute mappings for MULTI value
339
338
  * measures.</p>
339
+ * @public
340
340
  */
341
341
  MultiMeasureAttributeMappings?: MultiMeasureAttributeMapping[];
342
342
  }
343
343
  /**
344
- * @public
345
344
  * <p>Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided.
346
345
  * MultiMeasureMappings can be used to ingest data as multi measures in the derived
347
346
  * table.</p>
347
+ * @public
348
348
  */
349
349
  export interface MultiMeasureMappings {
350
350
  /**
351
- * @public
352
351
  * <p>The name of the target multi-measure name in the derived table. This input is required
353
352
  * when measureNameColumn is not provided. If MeasureNameColumn is provided, then value
354
353
  * from that column will be used as multi-measure name.</p>
354
+ * @public
355
355
  */
356
356
  TargetMultiMeasureName?: string;
357
357
  /**
358
- * @public
359
358
  * <p>Required. Attribute mappings to be used for mapping query results to ingest data for
360
359
  * multi-measure attributes.</p>
360
+ * @public
361
361
  */
362
362
  MultiMeasureAttributeMappings: MultiMeasureAttributeMapping[] | undefined;
363
363
  }
364
364
  /**
365
- * @public
366
365
  * <p> Configuration to write data into Timestream database and table. This configuration
367
366
  * allows the user to map the query result select columns into the destination table
368
367
  * columns. </p>
368
+ * @public
369
369
  */
370
370
  export interface TimestreamConfiguration {
371
371
  /**
372
- * @public
373
372
  * <p>Name of Timestream database to which the query result will be written.</p>
373
+ * @public
374
374
  */
375
375
  DatabaseName: string | undefined;
376
376
  /**
377
- * @public
378
377
  * <p>Name of Timestream table that the query result will be written to. The table should
379
378
  * be within the same database that is provided in Timestream configuration.</p>
379
+ * @public
380
380
  */
381
381
  TableName: string | undefined;
382
382
  /**
383
- * @public
384
383
  * <p>Column from query result that should be used as the time column in destination table.
385
384
  * Column type for this should be TIMESTAMP.</p>
385
+ * @public
386
386
  */
387
387
  TimeColumn: string | undefined;
388
388
  /**
389
- * @public
390
389
  * <p> This is to allow mapping column(s) from the query result to the dimension in the
391
390
  * destination table. </p>
391
+ * @public
392
392
  */
393
393
  DimensionMappings: DimensionMapping[] | undefined;
394
394
  /**
395
- * @public
396
395
  * <p>Multi-measure mappings.</p>
396
+ * @public
397
397
  */
398
398
  MultiMeasureMappings?: MultiMeasureMappings;
399
399
  /**
400
- * @public
401
400
  * <p>Specifies how to map measures to multi-measure records.</p>
401
+ * @public
402
402
  */
403
403
  MixedMeasureMappings?: MixedMeasureMapping[];
404
404
  /**
405
- * @public
406
405
  * <p>Name of the measure column.</p>
406
+ * @public
407
407
  */
408
408
  MeasureNameColumn?: string;
409
409
  }
410
410
  /**
411
- * @public
412
411
  * <p>Configuration used for writing the output of a query.</p>
412
+ * @public
413
413
  */
414
414
  export interface TargetConfiguration {
415
415
  /**
416
- * @public
417
416
  * <p>Configuration needed to write data into the Timestream database and table.</p>
417
+ * @public
418
418
  */
419
419
  TimestreamConfiguration: TimestreamConfiguration | undefined;
420
420
  }
@@ -423,38 +423,37 @@ export interface TargetConfiguration {
423
423
  */
424
424
  export interface CreateScheduledQueryRequest {
425
425
  /**
426
- * @public
427
426
  * <p>Name of the scheduled query.</p>
427
+ * @public
428
428
  */
429
429
  Name: string | undefined;
430
430
  /**
431
- * @public
432
431
  * <p>The query string to run. Parameter
433
432
  * names can be specified in the query string <code>@</code> character followed by an
434
433
  * 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>
435
434
  * <p>The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of <code>@scheduled_runtime</code> paramater for each query run.
436
435
  * For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the <code>@scheduled_runtime</code> parameter is
437
436
  * initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.</p>
437
+ * @public
438
438
  */
439
439
  QueryString: string | undefined;
440
440
  /**
441
- * @public
442
441
  * <p>The schedule configuration for the query.</p>
442
+ * @public
443
443
  */
444
444
  ScheduleConfiguration: ScheduleConfiguration | undefined;
445
445
  /**
446
- * @public
447
446
  * <p>Notification configuration for the scheduled query. A notification is sent by
448
447
  * Timestream when a query run finishes, when the state is updated or when you delete it. </p>
448
+ * @public
449
449
  */
450
450
  NotificationConfiguration: NotificationConfiguration | undefined;
451
451
  /**
452
- * @public
453
452
  * <p>Configuration used for writing the result of a query.</p>
453
+ * @public
454
454
  */
455
455
  TargetConfiguration?: TargetConfiguration;
456
456
  /**
457
- * @public
458
457
  * <p>Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making
459
458
  * multiple identical CreateScheduledQuery requests has the same effect as making a single request.
460
459
  *
@@ -469,31 +468,32 @@ export interface CreateScheduledQueryRequest {
469
468
  * as a new request. </p>
470
469
  * </li>
471
470
  * </ul>
471
+ * @public
472
472
  */
473
473
  ClientToken?: string;
474
474
  /**
475
- * @public
476
475
  * <p>The ARN for the IAM role that Timestream will assume when running the scheduled query. </p>
476
+ * @public
477
477
  */
478
478
  ScheduledQueryExecutionRoleArn: string | undefined;
479
479
  /**
480
- * @public
481
480
  * <p>A list of key-value pairs to label the scheduled query.</p>
481
+ * @public
482
482
  */
483
483
  Tags?: Tag[];
484
484
  /**
485
- * @public
486
485
  * <p>The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS
487
486
  * key is not specified, the scheduled query resource will be encrypted with a Timestream
488
487
  * owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias
489
488
  * ARN. When using an alias name, prefix the name with <i>alias/</i>
490
489
  * </p>
491
490
  * <p>If ErrorReportConfiguration uses <code>SSE_KMS</code> as encryption type, the same KmsKeyId is used to encrypt the error report at rest.</p>
491
+ * @public
492
492
  */
493
493
  KmsKeyId?: string;
494
494
  /**
495
- * @public
496
495
  * <p>Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results. </p>
496
+ * @public
497
497
  */
498
498
  ErrorReportConfiguration: ErrorReportConfiguration | undefined;
499
499
  }
@@ -502,14 +502,14 @@ export interface CreateScheduledQueryRequest {
502
502
  */
503
503
  export interface CreateScheduledQueryResponse {
504
504
  /**
505
- * @public
506
505
  * <p>ARN for the created scheduled query.</p>
506
+ * @public
507
507
  */
508
508
  Arn: string | undefined;
509
509
  }
510
510
  /**
511
- * @public
512
511
  * <p>You have exceeded the service quota.</p>
512
+ * @public
513
513
  */
514
514
  export declare class ServiceQuotaExceededException extends __BaseException {
515
515
  readonly name: "ServiceQuotaExceededException";
@@ -525,22 +525,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
525
525
  */
526
526
  export interface DeleteScheduledQueryRequest {
527
527
  /**
528
- * @public
529
528
  * <p>The ARN of the scheduled query. </p>
529
+ * @public
530
530
  */
531
531
  ScheduledQueryArn: string | undefined;
532
532
  }
533
533
  /**
534
- * @public
535
534
  * <p>The requested resource could not be found.</p>
535
+ * @public
536
536
  */
537
537
  export declare class ResourceNotFoundException extends __BaseException {
538
538
  readonly name: "ResourceNotFoundException";
539
539
  readonly $fault: "client";
540
540
  Message?: string;
541
541
  /**
542
- * @public
543
542
  * <p>The ARN of the scheduled query.</p>
543
+ * @public
544
544
  */
545
545
  ScheduledQueryArn?: string;
546
546
  /**
@@ -554,19 +554,19 @@ export declare class ResourceNotFoundException extends __BaseException {
554
554
  export interface DescribeEndpointsRequest {
555
555
  }
556
556
  /**
557
- * @public
558
557
  * <p>Represents an available endpoint against which to make API calls against, as well as
559
558
  * the TTL for that endpoint.</p>
559
+ * @public
560
560
  */
561
561
  export interface Endpoint {
562
562
  /**
563
- * @public
564
563
  * <p>An endpoint address.</p>
564
+ * @public
565
565
  */
566
566
  Address: string | undefined;
567
567
  /**
568
- * @public
569
568
  * <p>The TTL for the endpoint, in minutes.</p>
569
+ * @public
570
570
  */
571
571
  CachePeriodInMinutes: number | undefined;
572
572
  }
@@ -575,9 +575,9 @@ export interface Endpoint {
575
575
  */
576
576
  export interface DescribeEndpointsResponse {
577
577
  /**
578
- * @public
579
578
  * <p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>
580
579
  * request is made.</p>
580
+ * @public
581
581
  */
582
582
  Endpoints: Endpoint[] | undefined;
583
583
  }
@@ -586,68 +586,68 @@ export interface DescribeEndpointsResponse {
586
586
  */
587
587
  export interface DescribeScheduledQueryRequest {
588
588
  /**
589
- * @public
590
589
  * <p>The ARN of the scheduled query.</p>
590
+ * @public
591
591
  */
592
592
  ScheduledQueryArn: string | undefined;
593
593
  }
594
594
  /**
595
- * @public
596
595
  * <p> S3 report location for the scheduled query run.</p>
596
+ * @public
597
597
  */
598
598
  export interface S3ReportLocation {
599
599
  /**
600
- * @public
601
600
  * <p> S3 bucket name. </p>
601
+ * @public
602
602
  */
603
603
  BucketName?: string;
604
604
  /**
605
- * @public
606
605
  * <p>S3 key. </p>
606
+ * @public
607
607
  */
608
608
  ObjectKey?: string;
609
609
  }
610
610
  /**
611
- * @public
612
611
  * <p>This contains the location of the error report for a single scheduled query call.
613
612
  * </p>
613
+ * @public
614
614
  */
615
615
  export interface ErrorReportLocation {
616
616
  /**
617
- * @public
618
617
  * <p>The S3 location where error reports are written.</p>
618
+ * @public
619
619
  */
620
620
  S3ReportLocation?: S3ReportLocation;
621
621
  }
622
622
  /**
623
- * @public
624
623
  * <p>Statistics for a single scheduled query run.</p>
624
+ * @public
625
625
  */
626
626
  export interface ExecutionStats {
627
627
  /**
628
- * @public
629
628
  * <p>Total time, measured in milliseconds, that was needed for the scheduled query run to complete.</p>
629
+ * @public
630
630
  */
631
631
  ExecutionTimeInMillis?: number;
632
632
  /**
633
- * @public
634
633
  * <p>Data writes metered for records ingested in a single scheduled query run.</p>
634
+ * @public
635
635
  */
636
636
  DataWrites?: number;
637
637
  /**
638
- * @public
639
638
  * <p>Bytes metered for a single scheduled query run.</p>
639
+ * @public
640
640
  */
641
641
  BytesMetered?: number;
642
642
  /**
643
- * @public
644
643
  * <p>The number of records ingested for a single scheduled query run. </p>
644
+ * @public
645
645
  */
646
646
  RecordsIngested?: number;
647
647
  /**
648
- * @public
649
648
  * <p>Number of rows present in the output from running a query before ingestion to
650
649
  * destination data source.</p>
650
+ * @public
651
651
  */
652
652
  QueryResultRows?: number;
653
653
  }
@@ -666,40 +666,40 @@ export declare const ScheduledQueryRunStatus: {
666
666
  */
667
667
  export type ScheduledQueryRunStatus = (typeof ScheduledQueryRunStatus)[keyof typeof ScheduledQueryRunStatus];
668
668
  /**
669
- * @public
670
669
  * <p>Run summary for the scheduled query</p>
670
+ * @public
671
671
  */
672
672
  export interface ScheduledQueryRunSummary {
673
673
  /**
674
- * @public
675
674
  * <p>InvocationTime for this run. This is the time at which the query is scheduled to run.
676
675
  * Parameter <code>@scheduled_runtime</code> can be used in the query to get the value. </p>
676
+ * @public
677
677
  */
678
678
  InvocationTime?: Date;
679
679
  /**
680
- * @public
681
680
  * <p>The actual time when the query was run.</p>
681
+ * @public
682
682
  */
683
683
  TriggerTime?: Date;
684
684
  /**
685
- * @public
686
685
  * <p>The status of a scheduled query run.</p>
686
+ * @public
687
687
  */
688
688
  RunStatus?: ScheduledQueryRunStatus;
689
689
  /**
690
- * @public
691
690
  * <p>Runtime statistics for a scheduled run.</p>
691
+ * @public
692
692
  */
693
693
  ExecutionStats?: ExecutionStats;
694
694
  /**
695
- * @public
696
695
  * <p>S3 location for error report.</p>
696
+ * @public
697
697
  */
698
698
  ErrorReportLocation?: ErrorReportLocation;
699
699
  /**
700
- * @public
701
700
  * <p>Error message for the scheduled query in case of failure. You might have to look at
702
701
  * the error report to get more detailed error reasons. </p>
702
+ * @public
703
703
  */
704
704
  FailureReason?: string;
705
705
  }
@@ -716,83 +716,83 @@ export declare const ScheduledQueryState: {
716
716
  */
717
717
  export type ScheduledQueryState = (typeof ScheduledQueryState)[keyof typeof ScheduledQueryState];
718
718
  /**
719
- * @public
720
719
  * <p>Structure that describes scheduled query.</p>
720
+ * @public
721
721
  */
722
722
  export interface ScheduledQueryDescription {
723
723
  /**
724
- * @public
725
724
  * <p>Scheduled query ARN.</p>
725
+ * @public
726
726
  */
727
727
  Arn: string | undefined;
728
728
  /**
729
- * @public
730
729
  * <p>Name of the scheduled query.</p>
730
+ * @public
731
731
  */
732
732
  Name: string | undefined;
733
733
  /**
734
- * @public
735
734
  * <p>The query to be run.</p>
735
+ * @public
736
736
  */
737
737
  QueryString: string | undefined;
738
738
  /**
739
- * @public
740
739
  * <p>Creation time of the scheduled query.</p>
740
+ * @public
741
741
  */
742
742
  CreationTime?: Date;
743
743
  /**
744
- * @public
745
744
  * <p>State of the scheduled query. </p>
745
+ * @public
746
746
  */
747
747
  State: ScheduledQueryState | undefined;
748
748
  /**
749
- * @public
750
749
  * <p>Last time the query was run.</p>
750
+ * @public
751
751
  */
752
752
  PreviousInvocationTime?: Date;
753
753
  /**
754
- * @public
755
754
  * <p>The next time the scheduled query is scheduled to run.</p>
755
+ * @public
756
756
  */
757
757
  NextInvocationTime?: Date;
758
758
  /**
759
- * @public
760
759
  * <p>Schedule configuration.</p>
760
+ * @public
761
761
  */
762
762
  ScheduleConfiguration: ScheduleConfiguration | undefined;
763
763
  /**
764
- * @public
765
764
  * <p>Notification configuration.</p>
765
+ * @public
766
766
  */
767
767
  NotificationConfiguration: NotificationConfiguration | undefined;
768
768
  /**
769
- * @public
770
769
  * <p>Scheduled query target store configuration.</p>
770
+ * @public
771
771
  */
772
772
  TargetConfiguration?: TargetConfiguration;
773
773
  /**
774
- * @public
775
774
  * <p>IAM role that Timestream uses to run the schedule query.</p>
775
+ * @public
776
776
  */
777
777
  ScheduledQueryExecutionRoleArn?: string;
778
778
  /**
779
- * @public
780
779
  * <p>A customer provided KMS key used to encrypt the scheduled query resource.</p>
780
+ * @public
781
781
  */
782
782
  KmsKeyId?: string;
783
783
  /**
784
- * @public
785
784
  * <p>Error-reporting configuration for the scheduled query.</p>
785
+ * @public
786
786
  */
787
787
  ErrorReportConfiguration?: ErrorReportConfiguration;
788
788
  /**
789
- * @public
790
789
  * <p>Runtime summary for the last scheduled query run. </p>
790
+ * @public
791
791
  */
792
792
  LastRunSummary?: ScheduledQueryRunSummary;
793
793
  /**
794
- * @public
795
794
  * <p>Runtime summary for the last five failed scheduled query runs.</p>
795
+ * @public
796
796
  */
797
797
  RecentlyFailedRuns?: ScheduledQueryRunSummary[];
798
798
  }
@@ -801,8 +801,8 @@ export interface ScheduledQueryDescription {
801
801
  */
802
802
  export interface DescribeScheduledQueryResponse {
803
803
  /**
804
- * @public
805
804
  * <p>The scheduled query.</p>
805
+ * @public
806
806
  */
807
807
  ScheduledQuery: ScheduledQueryDescription | undefined;
808
808
  }
@@ -811,18 +811,18 @@ export interface DescribeScheduledQueryResponse {
811
811
  */
812
812
  export interface ExecuteScheduledQueryRequest {
813
813
  /**
814
- * @public
815
814
  * <p>ARN of the scheduled query.</p>
815
+ * @public
816
816
  */
817
817
  ScheduledQueryArn: string | undefined;
818
818
  /**
819
- * @public
820
819
  * <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp. </p>
820
+ * @public
821
821
  */
822
822
  InvocationTime: Date | undefined;
823
823
  /**
824
- * @public
825
824
  * <p>Not used. </p>
825
+ * @public
826
826
  */
827
827
  ClientToken?: string;
828
828
  }
@@ -831,95 +831,95 @@ export interface ExecuteScheduledQueryRequest {
831
831
  */
832
832
  export interface ListScheduledQueriesRequest {
833
833
  /**
834
- * @public
835
834
  * <p>The maximum number of items to return in the output. If the total number of items
836
835
  * available is more than the value specified, a <code>NextToken</code> is provided in the
837
836
  * output. To resume pagination, provide the <code>NextToken</code> value as the argument
838
837
  * to the subsequent call to <code>ListScheduledQueriesRequest</code>.</p>
838
+ * @public
839
839
  */
840
840
  MaxResults?: number;
841
841
  /**
842
- * @public
843
842
  * <p> A pagination token to resume pagination.</p>
843
+ * @public
844
844
  */
845
845
  NextToken?: string;
846
846
  }
847
847
  /**
848
- * @public
849
848
  * <p>Destination for scheduled query.</p>
849
+ * @public
850
850
  */
851
851
  export interface TimestreamDestination {
852
852
  /**
853
- * @public
854
853
  * <p>Timestream database name. </p>
854
+ * @public
855
855
  */
856
856
  DatabaseName?: string;
857
857
  /**
858
- * @public
859
858
  * <p>Timestream table name. </p>
859
+ * @public
860
860
  */
861
861
  TableName?: string;
862
862
  }
863
863
  /**
864
- * @public
865
864
  * <p>Destination details to write data for a target data source. Current supported data
866
865
  * source is Timestream.</p>
866
+ * @public
867
867
  */
868
868
  export interface TargetDestination {
869
869
  /**
870
- * @public
871
870
  * <p>Query result destination details for Timestream data source.</p>
871
+ * @public
872
872
  */
873
873
  TimestreamDestination?: TimestreamDestination;
874
874
  }
875
875
  /**
876
- * @public
877
876
  * <p>Scheduled Query</p>
877
+ * @public
878
878
  */
879
879
  export interface ScheduledQuery {
880
880
  /**
881
- * @public
882
881
  * <p>The Amazon Resource Name.</p>
882
+ * @public
883
883
  */
884
884
  Arn: string | undefined;
885
885
  /**
886
- * @public
887
886
  * <p>The name of the scheduled query.</p>
887
+ * @public
888
888
  */
889
889
  Name: string | undefined;
890
890
  /**
891
- * @public
892
891
  * <p>The creation time of the scheduled query.</p>
892
+ * @public
893
893
  */
894
894
  CreationTime?: Date;
895
895
  /**
896
- * @public
897
896
  * <p>State of scheduled query. </p>
897
+ * @public
898
898
  */
899
899
  State: ScheduledQueryState | undefined;
900
900
  /**
901
- * @public
902
901
  * <p>The last time the scheduled query was run.</p>
902
+ * @public
903
903
  */
904
904
  PreviousInvocationTime?: Date;
905
905
  /**
906
- * @public
907
906
  * <p>The next time the scheduled query is to be run.</p>
907
+ * @public
908
908
  */
909
909
  NextInvocationTime?: Date;
910
910
  /**
911
- * @public
912
911
  * <p>Configuration for scheduled query error reporting.</p>
912
+ * @public
913
913
  */
914
914
  ErrorReportConfiguration?: ErrorReportConfiguration;
915
915
  /**
916
- * @public
917
916
  * <p>Target data source where final scheduled query result will be written.</p>
917
+ * @public
918
918
  */
919
919
  TargetDestination?: TargetDestination;
920
920
  /**
921
- * @public
922
921
  * <p>Status of the last scheduled query run.</p>
922
+ * @public
923
923
  */
924
924
  LastRunStatus?: ScheduledQueryRunStatus;
925
925
  }
@@ -928,14 +928,14 @@ export interface ScheduledQuery {
928
928
  */
929
929
  export interface ListScheduledQueriesResponse {
930
930
  /**
931
- * @public
932
931
  * <p>A list of scheduled queries.</p>
932
+ * @public
933
933
  */
934
934
  ScheduledQueries: ScheduledQuery[] | undefined;
935
935
  /**
936
- * @public
937
936
  * <p>A token to specify where to start paginating. This is the NextToken from a previously
938
937
  * truncated response.</p>
938
+ * @public
939
939
  */
940
940
  NextToken?: string;
941
941
  }
@@ -944,19 +944,19 @@ export interface ListScheduledQueriesResponse {
944
944
  */
945
945
  export interface ListTagsForResourceRequest {
946
946
  /**
947
- * @public
948
947
  * <p>The Timestream resource with tags to be listed. This value is an Amazon Resource Name
949
948
  * (ARN).</p>
949
+ * @public
950
950
  */
951
951
  ResourceARN: string | undefined;
952
952
  /**
953
- * @public
954
953
  * <p>The maximum number of tags to return.</p>
954
+ * @public
955
955
  */
956
956
  MaxResults?: number;
957
957
  /**
958
- * @public
959
958
  * <p>A pagination token to resume pagination.</p>
959
+ * @public
960
960
  */
961
961
  NextToken?: string;
962
962
  }
@@ -965,14 +965,14 @@ export interface ListTagsForResourceRequest {
965
965
  */
966
966
  export interface ListTagsForResourceResponse {
967
967
  /**
968
- * @public
969
968
  * <p>The tags currently associated with the Timestream resource. </p>
969
+ * @public
970
970
  */
971
971
  Tags: Tag[] | undefined;
972
972
  /**
973
- * @public
974
973
  * <p>A pagination token to resume pagination with a subsequent call to
975
974
  * <code>ListTagsForResourceResponse</code>.</p>
975
+ * @public
976
976
  */
977
977
  NextToken?: string;
978
978
  }
@@ -981,24 +981,24 @@ export interface ListTagsForResourceResponse {
981
981
  */
982
982
  export interface PrepareQueryRequest {
983
983
  /**
984
- * @public
985
984
  * <p>The Timestream query string that you want to use as a prepared statement. Parameter
986
985
  * names can be specified in the query string <code>@</code> character followed by an
987
986
  * identifier. </p>
987
+ * @public
988
988
  */
989
989
  QueryString: string | undefined;
990
990
  /**
991
- * @public
992
991
  * <p>By setting this value to <code>true</code>, Timestream will only validate that the
993
992
  * query string is a valid Timestream query, and not store the prepared query for later
994
993
  * use.</p>
994
+ * @public
995
995
  */
996
996
  ValidateOnly?: boolean;
997
997
  }
998
998
  /**
999
- * @public
1000
999
  * <p>
1001
1000
  * Timestream was unable to run the query successfully. </p>
1001
+ * @public
1002
1002
  */
1003
1003
  export declare class QueryExecutionException extends __BaseException {
1004
1004
  readonly name: "QueryExecutionException";
@@ -1014,12 +1014,11 @@ export declare class QueryExecutionException extends __BaseException {
1014
1014
  */
1015
1015
  export interface QueryRequest {
1016
1016
  /**
1017
- * @public
1018
1017
  * <p> The query to be run by Timestream. </p>
1018
+ * @public
1019
1019
  */
1020
1020
  QueryString: string | undefined;
1021
1021
  /**
1022
- * @public
1023
1022
  * <p> Unique, case-sensitive string of up to 64 ASCII characters specified when a
1024
1023
  * <code>Query</code> request is made. Providing a <code>ClientToken</code> makes the
1025
1024
  * call to <code>Query</code>
@@ -1047,10 +1046,10 @@ export interface QueryRequest {
1047
1046
  * as a new request. </p>
1048
1047
  * </li>
1049
1048
  * </ul>
1049
+ * @public
1050
1050
  */
1051
1051
  ClientToken?: string;
1052
1052
  /**
1053
- * @public
1054
1053
  * <p> A pagination token used to return a set of results. When the <code>Query</code> API
1055
1054
  * is invoked using <code>NextToken</code>, that particular invocation is assumed to be a
1056
1055
  * subsequent invocation of a prior call to <code>Query</code>, and a result set is
@@ -1090,10 +1089,10 @@ export interface QueryRequest {
1090
1089
  * pagination token</code> error. </p>
1091
1090
  * </li>
1092
1091
  * </ul>
1092
+ * @public
1093
1093
  */
1094
1094
  NextToken?: string;
1095
1095
  /**
1096
- * @public
1097
1096
  * <p> The total number of rows to be returned in the <code>Query</code> output. The initial
1098
1097
  * run of <code>Query</code> with a <code>MaxRows</code> value specified will return the
1099
1098
  * result set of the query in two cases: </p>
@@ -1114,32 +1113,33 @@ export interface QueryRequest {
1114
1113
  * fewer rows to keep the response size from exceeding the 1 MB limit. If
1115
1114
  * <code>MaxRows</code> is not provided, Timestream will send the necessary
1116
1115
  * number of rows to meet the 1 MB limit.</p>
1116
+ * @public
1117
1117
  */
1118
1118
  MaxRows?: number;
1119
1119
  }
1120
1120
  /**
1121
- * @public
1122
1121
  * <p>Information about the status of the query, including progress and bytes
1123
1122
  * scanned.</p>
1123
+ * @public
1124
1124
  */
1125
1125
  export interface QueryStatus {
1126
1126
  /**
1127
- * @public
1128
1127
  * <p>The progress of the query, expressed as a percentage.</p>
1128
+ * @public
1129
1129
  */
1130
1130
  ProgressPercentage?: number;
1131
1131
  /**
1132
- * @public
1133
1132
  * <p>The amount of data scanned by the query in bytes. This is a cumulative sum and
1134
1133
  * represents the total amount of bytes scanned since the query was started. </p>
1134
+ * @public
1135
1135
  */
1136
1136
  CumulativeBytesScanned?: number;
1137
1137
  /**
1138
- * @public
1139
1138
  * <p>The amount of data scanned by the query in bytes that you will be charged for. This is
1140
1139
  * a cumulative sum and represents the total amount of data that you will be charged for
1141
1140
  * since the query was started. The charge is applied only once and is either applied when
1142
1141
  * the query completes running or when the query is cancelled. </p>
1142
+ * @public
1143
1143
  */
1144
1144
  CumulativeBytesMetered?: number;
1145
1145
  }
@@ -1148,14 +1148,14 @@ export interface QueryStatus {
1148
1148
  */
1149
1149
  export interface TagResourceRequest {
1150
1150
  /**
1151
- * @public
1152
1151
  * <p>Identifies the Timestream resource to which tags should be added. This value is an
1153
1152
  * Amazon Resource Name (ARN).</p>
1153
+ * @public
1154
1154
  */
1155
1155
  ResourceARN: string | undefined;
1156
1156
  /**
1157
- * @public
1158
1157
  * <p>The tags to be assigned to the Timestream resource.</p>
1158
+ * @public
1159
1159
  */
1160
1160
  Tags: Tag[] | undefined;
1161
1161
  }
@@ -1169,15 +1169,15 @@ export interface TagResourceResponse {
1169
1169
  */
1170
1170
  export interface UntagResourceRequest {
1171
1171
  /**
1172
- * @public
1173
1172
  * <p>The Timestream resource that the tags will be removed from. This value is an Amazon
1174
1173
  * Resource Name (ARN). </p>
1174
+ * @public
1175
1175
  */
1176
1176
  ResourceARN: string | undefined;
1177
1177
  /**
1178
- * @public
1179
1178
  * <p>A list of tags keys. Existing tags of the resource whose keys are members of this list
1180
1179
  * will be removed from the Timestream resource. </p>
1180
+ * @public
1181
1181
  */
1182
1182
  TagKeys: string[] | undefined;
1183
1183
  }
@@ -1191,178 +1191,178 @@ export interface UntagResourceResponse {
1191
1191
  */
1192
1192
  export interface UpdateScheduledQueryRequest {
1193
1193
  /**
1194
- * @public
1195
1194
  * <p>ARN of the scheuled query.</p>
1195
+ * @public
1196
1196
  */
1197
1197
  ScheduledQueryArn: string | undefined;
1198
1198
  /**
1199
- * @public
1200
1199
  * <p>State of the scheduled query. </p>
1200
+ * @public
1201
1201
  */
1202
1202
  State: ScheduledQueryState | undefined;
1203
1203
  }
1204
1204
  /**
1205
- * @public
1206
1205
  * <p> Contains the metadata for query results such as the column names, data types, and
1207
1206
  * other attributes. </p>
1207
+ * @public
1208
1208
  */
1209
1209
  export interface ColumnInfo {
1210
1210
  /**
1211
- * @public
1212
1211
  * <p> The name of the result set column. The name of the result set is available for
1213
1212
  * columns of all data types except for arrays. </p>
1213
+ * @public
1214
1214
  */
1215
1215
  Name?: string;
1216
1216
  /**
1217
- * @public
1218
1217
  * <p>The data type of the result set column. The data type can be a scalar or complex.
1219
1218
  * Scalar data types are integers, strings, doubles, Booleans, and others. Complex data
1220
1219
  * types are types such as arrays, rows, and others. </p>
1220
+ * @public
1221
1221
  */
1222
1222
  Type: Type | undefined;
1223
1223
  }
1224
1224
  /**
1225
- * @public
1226
1225
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
1227
1226
  * or complex. The supported scalar data types are integers, Boolean, string, double,
1228
1227
  * timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
1229
1228
  * and timeseries.</p>
1229
+ * @public
1230
1230
  */
1231
1231
  export interface Type {
1232
1232
  /**
1233
- * @public
1234
1233
  * <p>Indicates if the column is of type string, integer, Boolean, double, timestamp, date,
1235
1234
  * time. </p>
1235
+ * @public
1236
1236
  */
1237
1237
  ScalarType?: ScalarType;
1238
1238
  /**
1239
- * @public
1240
1239
  * <p>Indicates if the column is an array.</p>
1240
+ * @public
1241
1241
  */
1242
1242
  ArrayColumnInfo?: ColumnInfo;
1243
1243
  /**
1244
- * @public
1245
1244
  * <p>Indicates if the column is a timeseries data type.</p>
1245
+ * @public
1246
1246
  */
1247
1247
  TimeSeriesMeasureValueColumnInfo?: ColumnInfo;
1248
1248
  /**
1249
- * @public
1250
1249
  * <p>Indicates if the column is a row.</p>
1250
+ * @public
1251
1251
  */
1252
1252
  RowColumnInfo?: ColumnInfo[];
1253
1253
  }
1254
1254
  /**
1255
- * @public
1256
1255
  * <p> Datum represents a single data point in a query result. </p>
1256
+ * @public
1257
1257
  */
1258
1258
  export interface Datum {
1259
1259
  /**
1260
- * @public
1261
1260
  * <p> Indicates if the data point is a scalar value such as integer, string, double, or
1262
1261
  * Boolean. </p>
1262
+ * @public
1263
1263
  */
1264
1264
  ScalarValue?: string;
1265
1265
  /**
1266
- * @public
1267
1266
  * <p> Indicates if the data point is a timeseries data type. </p>
1267
+ * @public
1268
1268
  */
1269
1269
  TimeSeriesValue?: TimeSeriesDataPoint[];
1270
1270
  /**
1271
- * @public
1272
1271
  * <p> Indicates if the data point is an array. </p>
1272
+ * @public
1273
1273
  */
1274
1274
  ArrayValue?: Datum[];
1275
1275
  /**
1276
- * @public
1277
1276
  * <p> Indicates if the data point is a row. </p>
1277
+ * @public
1278
1278
  */
1279
1279
  RowValue?: Row;
1280
1280
  /**
1281
- * @public
1282
1281
  * <p> Indicates if the data point is null. </p>
1282
+ * @public
1283
1283
  */
1284
1284
  NullValue?: boolean;
1285
1285
  }
1286
1286
  /**
1287
- * @public
1288
1287
  * <p>Mapping for named parameters.</p>
1288
+ * @public
1289
1289
  */
1290
1290
  export interface ParameterMapping {
1291
1291
  /**
1292
- * @public
1293
1292
  * <p>Parameter name.</p>
1293
+ * @public
1294
1294
  */
1295
1295
  Name: string | undefined;
1296
1296
  /**
1297
- * @public
1298
1297
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
1299
1298
  * or complex. The supported scalar data types are integers, Boolean, string, double,
1300
1299
  * timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
1301
1300
  * and timeseries.</p>
1301
+ * @public
1302
1302
  */
1303
1303
  Type: Type | undefined;
1304
1304
  }
1305
1305
  /**
1306
- * @public
1307
1306
  * <p>Details of the column that is returned by the query. </p>
1307
+ * @public
1308
1308
  */
1309
1309
  export interface SelectColumn {
1310
1310
  /**
1311
- * @public
1312
1311
  * <p>Name of the column.</p>
1312
+ * @public
1313
1313
  */
1314
1314
  Name?: string;
1315
1315
  /**
1316
- * @public
1317
1316
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
1318
1317
  * or complex. The supported scalar data types are integers, Boolean, string, double,
1319
1318
  * timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
1320
1319
  * and timeseries.</p>
1320
+ * @public
1321
1321
  */
1322
1322
  Type?: Type;
1323
1323
  /**
1324
- * @public
1325
1324
  * <p> Database that has this column.</p>
1325
+ * @public
1326
1326
  */
1327
1327
  DatabaseName?: string;
1328
1328
  /**
1329
- * @public
1330
1329
  * <p>Table within the database that has this column. </p>
1330
+ * @public
1331
1331
  */
1332
1332
  TableName?: string;
1333
1333
  /**
1334
- * @public
1335
1334
  * <p>True, if the column name was aliased by the query. False otherwise.</p>
1335
+ * @public
1336
1336
  */
1337
1337
  Aliased?: boolean;
1338
1338
  }
1339
1339
  /**
1340
- * @public
1341
1340
  * <p>The timeseries data type represents the values of a measure over time. A time series
1342
1341
  * is an array of rows of timestamps and measure values, with rows sorted in ascending
1343
1342
  * order of time. A TimeSeriesDataPoint is a single data point in the time series. It
1344
1343
  * represents a tuple of (time, measure value) in a time series. </p>
1344
+ * @public
1345
1345
  */
1346
1346
  export interface TimeSeriesDataPoint {
1347
1347
  /**
1348
- * @public
1349
1348
  * <p>The timestamp when the measure value was collected.</p>
1349
+ * @public
1350
1350
  */
1351
1351
  Time: string | undefined;
1352
1352
  /**
1353
- * @public
1354
1353
  * <p>The measure value for the data point.</p>
1354
+ * @public
1355
1355
  */
1356
1356
  Value: Datum | undefined;
1357
1357
  }
1358
1358
  /**
1359
- * @public
1360
1359
  * <p>Represents a single row in the query results.</p>
1360
+ * @public
1361
1361
  */
1362
1362
  export interface Row {
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>List of data points in a single row of the result set.</p>
1365
+ * @public
1366
1366
  */
1367
1367
  Data: Datum[] | undefined;
1368
1368
  }
@@ -1371,30 +1371,30 @@ export interface Row {
1371
1371
  */
1372
1372
  export interface QueryResponse {
1373
1373
  /**
1374
- * @public
1375
1374
  * <p> A unique ID for the given query. </p>
1375
+ * @public
1376
1376
  */
1377
1377
  QueryId: string | undefined;
1378
1378
  /**
1379
- * @public
1380
1379
  * <p> A pagination token that can be used again on a <code>Query</code> call to get the
1381
1380
  * next set of results. </p>
1381
+ * @public
1382
1382
  */
1383
1383
  NextToken?: string;
1384
1384
  /**
1385
- * @public
1386
1385
  * <p> The result set rows returned by the query. </p>
1386
+ * @public
1387
1387
  */
1388
1388
  Rows: Row[] | undefined;
1389
1389
  /**
1390
- * @public
1391
1390
  * <p> The column data types of the returned result set. </p>
1391
+ * @public
1392
1392
  */
1393
1393
  ColumnInfo: ColumnInfo[] | undefined;
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>Information about the status of the query, including progress and bytes
1397
1396
  * scanned.</p>
1397
+ * @public
1398
1398
  */
1399
1399
  QueryStatus?: QueryStatus;
1400
1400
  }
@@ -1403,18 +1403,18 @@ export interface QueryResponse {
1403
1403
  */
1404
1404
  export interface PrepareQueryResponse {
1405
1405
  /**
1406
- * @public
1407
1406
  * <p>The query string that you want prepare.</p>
1407
+ * @public
1408
1408
  */
1409
1409
  QueryString: string | undefined;
1410
1410
  /**
1411
- * @public
1412
1411
  * <p>A list of SELECT clause columns of the submitted query string. </p>
1412
+ * @public
1413
1413
  */
1414
1414
  Columns: SelectColumn[] | undefined;
1415
1415
  /**
1416
- * @public
1417
1416
  * <p>A list of parameters used in the submitted query string. </p>
1417
+ * @public
1418
1418
  */
1419
1419
  Parameters: ParameterMapping[] | undefined;
1420
1420
  }