@aws-sdk/client-athena 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 +496 -0
- package/package.json +5 -5
|
@@ -21,6 +21,7 @@ export type S3AclOption = (typeof S3AclOption)[keyof typeof S3AclOption];
|
|
|
21
21
|
*/
|
|
22
22
|
export interface AclConfiguration {
|
|
23
23
|
/**
|
|
24
|
+
* @public
|
|
24
25
|
* <p>The Amazon S3 canned ACL that Athena should specify when storing
|
|
25
26
|
* query results. Currently the only supported canned ACL is
|
|
26
27
|
* <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the
|
|
@@ -36,6 +37,7 @@ export interface AclConfiguration {
|
|
|
36
37
|
*/
|
|
37
38
|
export interface BatchGetNamedQueryInput {
|
|
38
39
|
/**
|
|
40
|
+
* @public
|
|
39
41
|
* <p>An array of query IDs.</p>
|
|
40
42
|
*/
|
|
41
43
|
NamedQueryIds: string[] | undefined;
|
|
@@ -47,26 +49,32 @@ export interface BatchGetNamedQueryInput {
|
|
|
47
49
|
*/
|
|
48
50
|
export interface NamedQuery {
|
|
49
51
|
/**
|
|
52
|
+
* @public
|
|
50
53
|
* <p>The query name.</p>
|
|
51
54
|
*/
|
|
52
55
|
Name: string | undefined;
|
|
53
56
|
/**
|
|
57
|
+
* @public
|
|
54
58
|
* <p>The query description.</p>
|
|
55
59
|
*/
|
|
56
60
|
Description?: string;
|
|
57
61
|
/**
|
|
62
|
+
* @public
|
|
58
63
|
* <p>The database to which the query belongs.</p>
|
|
59
64
|
*/
|
|
60
65
|
Database: string | undefined;
|
|
61
66
|
/**
|
|
67
|
+
* @public
|
|
62
68
|
* <p>The SQL statements that make up the query.</p>
|
|
63
69
|
*/
|
|
64
70
|
QueryString: string | undefined;
|
|
65
71
|
/**
|
|
72
|
+
* @public
|
|
66
73
|
* <p>The unique identifier of the query.</p>
|
|
67
74
|
*/
|
|
68
75
|
NamedQueryId?: string;
|
|
69
76
|
/**
|
|
77
|
+
* @public
|
|
70
78
|
* <p>The name of the workgroup that contains the named query.</p>
|
|
71
79
|
*/
|
|
72
80
|
WorkGroup?: string;
|
|
@@ -77,15 +85,18 @@ export interface NamedQuery {
|
|
|
77
85
|
*/
|
|
78
86
|
export interface UnprocessedNamedQueryId {
|
|
79
87
|
/**
|
|
88
|
+
* @public
|
|
80
89
|
* <p>The unique identifier of the named query.</p>
|
|
81
90
|
*/
|
|
82
91
|
NamedQueryId?: string;
|
|
83
92
|
/**
|
|
93
|
+
* @public
|
|
84
94
|
* <p>The error code returned when the processing request for the named query failed, if
|
|
85
95
|
* applicable.</p>
|
|
86
96
|
*/
|
|
87
97
|
ErrorCode?: string;
|
|
88
98
|
/**
|
|
99
|
+
* @public
|
|
89
100
|
* <p>The error message returned when the processing request for the named query failed, if
|
|
90
101
|
* applicable.</p>
|
|
91
102
|
*/
|
|
@@ -96,10 +107,12 @@ export interface UnprocessedNamedQueryId {
|
|
|
96
107
|
*/
|
|
97
108
|
export interface BatchGetNamedQueryOutput {
|
|
98
109
|
/**
|
|
110
|
+
* @public
|
|
99
111
|
* <p>Information about the named query IDs submitted.</p>
|
|
100
112
|
*/
|
|
101
113
|
NamedQueries?: NamedQuery[];
|
|
102
114
|
/**
|
|
115
|
+
* @public
|
|
103
116
|
* <p>Information about provided query IDs.</p>
|
|
104
117
|
*/
|
|
105
118
|
UnprocessedNamedQueryIds?: UnprocessedNamedQueryId[];
|
|
@@ -127,6 +140,7 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
127
140
|
readonly name: "InvalidRequestException";
|
|
128
141
|
readonly $fault: "client";
|
|
129
142
|
/**
|
|
143
|
+
* @public
|
|
130
144
|
* <p>The error code returned when the query execution failed to process, or when the
|
|
131
145
|
* processing request for the named query failed.</p>
|
|
132
146
|
*/
|
|
@@ -142,10 +156,12 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
142
156
|
*/
|
|
143
157
|
export interface BatchGetPreparedStatementInput {
|
|
144
158
|
/**
|
|
159
|
+
* @public
|
|
145
160
|
* <p>A list of prepared statement names to return.</p>
|
|
146
161
|
*/
|
|
147
162
|
PreparedStatementNames: string[] | undefined;
|
|
148
163
|
/**
|
|
164
|
+
* @public
|
|
149
165
|
* <p>The name of the workgroup to which the prepared statements belong.</p>
|
|
150
166
|
*/
|
|
151
167
|
WorkGroup: string | undefined;
|
|
@@ -156,22 +172,27 @@ export interface BatchGetPreparedStatementInput {
|
|
|
156
172
|
*/
|
|
157
173
|
export interface PreparedStatement {
|
|
158
174
|
/**
|
|
175
|
+
* @public
|
|
159
176
|
* <p>The name of the prepared statement.</p>
|
|
160
177
|
*/
|
|
161
178
|
StatementName?: string;
|
|
162
179
|
/**
|
|
180
|
+
* @public
|
|
163
181
|
* <p>The query string for the prepared statement.</p>
|
|
164
182
|
*/
|
|
165
183
|
QueryStatement?: string;
|
|
166
184
|
/**
|
|
185
|
+
* @public
|
|
167
186
|
* <p>The name of the workgroup to which the prepared statement belongs.</p>
|
|
168
187
|
*/
|
|
169
188
|
WorkGroupName?: string;
|
|
170
189
|
/**
|
|
190
|
+
* @public
|
|
171
191
|
* <p>The description of the prepared statement.</p>
|
|
172
192
|
*/
|
|
173
193
|
Description?: string;
|
|
174
194
|
/**
|
|
195
|
+
* @public
|
|
175
196
|
* <p>The last modified time of the prepared statement.</p>
|
|
176
197
|
*/
|
|
177
198
|
LastModifiedTime?: Date;
|
|
@@ -182,14 +203,17 @@ export interface PreparedStatement {
|
|
|
182
203
|
*/
|
|
183
204
|
export interface UnprocessedPreparedStatementName {
|
|
184
205
|
/**
|
|
206
|
+
* @public
|
|
185
207
|
* <p>The name of a prepared statement that could not be returned due to an error.</p>
|
|
186
208
|
*/
|
|
187
209
|
StatementName?: string;
|
|
188
210
|
/**
|
|
211
|
+
* @public
|
|
189
212
|
* <p>The error code returned when the request for the prepared statement failed.</p>
|
|
190
213
|
*/
|
|
191
214
|
ErrorCode?: string;
|
|
192
215
|
/**
|
|
216
|
+
* @public
|
|
193
217
|
* <p>The error message containing the reason why the prepared statement could not be
|
|
194
218
|
* returned. The following error messages are possible:</p>
|
|
195
219
|
* <ul>
|
|
@@ -217,10 +241,12 @@ export interface UnprocessedPreparedStatementName {
|
|
|
217
241
|
*/
|
|
218
242
|
export interface BatchGetPreparedStatementOutput {
|
|
219
243
|
/**
|
|
244
|
+
* @public
|
|
220
245
|
* <p>The list of prepared statements returned.</p>
|
|
221
246
|
*/
|
|
222
247
|
PreparedStatements?: PreparedStatement[];
|
|
223
248
|
/**
|
|
249
|
+
* @public
|
|
224
250
|
* <p>A list of one or more prepared statements that were requested but could not be
|
|
225
251
|
* returned.</p>
|
|
226
252
|
*/
|
|
@@ -232,6 +258,7 @@ export interface BatchGetPreparedStatementOutput {
|
|
|
232
258
|
*/
|
|
233
259
|
export interface BatchGetQueryExecutionInput {
|
|
234
260
|
/**
|
|
261
|
+
* @public
|
|
235
262
|
* <p>An array of query execution IDs.</p>
|
|
236
263
|
*/
|
|
237
264
|
QueryExecutionIds: string[] | undefined;
|
|
@@ -243,11 +270,13 @@ export interface BatchGetQueryExecutionInput {
|
|
|
243
270
|
*/
|
|
244
271
|
export interface EngineVersion {
|
|
245
272
|
/**
|
|
273
|
+
* @public
|
|
246
274
|
* <p>The engine version requested by the user. Possible values are determined by the output
|
|
247
275
|
* of <code>ListEngineVersions</code>, including AUTO. The default is AUTO.</p>
|
|
248
276
|
*/
|
|
249
277
|
SelectedEngineVersion?: string;
|
|
250
278
|
/**
|
|
279
|
+
* @public
|
|
251
280
|
* <p>Read only. The engine version on which the query runs. If the user requests a valid
|
|
252
281
|
* engine version other than Auto, the effective engine version is the same as the engine
|
|
253
282
|
* version that the user requested. If the user requests Auto, the effective engine version
|
|
@@ -263,11 +292,13 @@ export interface EngineVersion {
|
|
|
263
292
|
*/
|
|
264
293
|
export interface QueryExecutionContext {
|
|
265
294
|
/**
|
|
295
|
+
* @public
|
|
266
296
|
* <p>The name of the database used in the query execution. The database must exist in the
|
|
267
297
|
* catalog.</p>
|
|
268
298
|
*/
|
|
269
299
|
Database?: string;
|
|
270
300
|
/**
|
|
301
|
+
* @public
|
|
271
302
|
* <p>The name of the data catalog used in the query execution.</p>
|
|
272
303
|
*/
|
|
273
304
|
Catalog?: string;
|
|
@@ -293,6 +324,7 @@ export type EncryptionOption = (typeof EncryptionOption)[keyof typeof Encryption
|
|
|
293
324
|
*/
|
|
294
325
|
export interface EncryptionConfiguration {
|
|
295
326
|
/**
|
|
327
|
+
* @public
|
|
296
328
|
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE_S3</code>), server-side encryption with KMS-managed keys
|
|
297
329
|
* (<code>SSE_KMS</code>), or client-side encryption with KMS-managed keys
|
|
298
330
|
* (<code>CSE_KMS</code>) is used.</p>
|
|
@@ -302,6 +334,7 @@ export interface EncryptionConfiguration {
|
|
|
302
334
|
*/
|
|
303
335
|
EncryptionOption: EncryptionOption | string | undefined;
|
|
304
336
|
/**
|
|
337
|
+
* @public
|
|
305
338
|
* <p>For <code>SSE_KMS</code> and <code>CSE_KMS</code>, this is the KMS key ARN or
|
|
306
339
|
* ID.</p>
|
|
307
340
|
*/
|
|
@@ -316,6 +349,7 @@ export interface EncryptionConfiguration {
|
|
|
316
349
|
*/
|
|
317
350
|
export interface ResultConfiguration {
|
|
318
351
|
/**
|
|
352
|
+
* @public
|
|
319
353
|
* <p>The location in Amazon S3 where your query and calculation results are stored, such as
|
|
320
354
|
* <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the
|
|
321
355
|
* query results location using one of the ways: either for individual queries using either
|
|
@@ -327,6 +361,7 @@ export interface ResultConfiguration {
|
|
|
327
361
|
*/
|
|
328
362
|
OutputLocation?: string;
|
|
329
363
|
/**
|
|
364
|
+
* @public
|
|
330
365
|
* <p>If query and calculation results are encrypted in Amazon S3, indicates the encryption option
|
|
331
366
|
* used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key information.
|
|
332
367
|
* This is a client-side setting. If workgroup settings override client-side settings, then
|
|
@@ -335,6 +370,7 @@ export interface ResultConfiguration {
|
|
|
335
370
|
*/
|
|
336
371
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
337
372
|
/**
|
|
373
|
+
* @public
|
|
338
374
|
* <p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.
|
|
339
375
|
* If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it
|
|
340
376
|
* makes Amazon S3 calls to your specified output location. If the
|
|
@@ -349,6 +385,7 @@ export interface ResultConfiguration {
|
|
|
349
385
|
*/
|
|
350
386
|
ExpectedBucketOwner?: string;
|
|
351
387
|
/**
|
|
388
|
+
* @public
|
|
352
389
|
* <p>Indicates that an Amazon S3 canned ACL should be set to control ownership of
|
|
353
390
|
* stored query results. Currently the only supported canned ACL is
|
|
354
391
|
* <code>BUCKET_OWNER_FULL_CONTROL</code>. This is a client-side setting. If workgroup
|
|
@@ -365,11 +402,13 @@ export interface ResultConfiguration {
|
|
|
365
402
|
*/
|
|
366
403
|
export interface ResultReuseByAgeConfiguration {
|
|
367
404
|
/**
|
|
405
|
+
* @public
|
|
368
406
|
* <p>True if previous query results can be reused when the query is run; otherwise, false.
|
|
369
407
|
* The default is false.</p>
|
|
370
408
|
*/
|
|
371
409
|
Enabled: boolean | undefined;
|
|
372
410
|
/**
|
|
411
|
+
* @public
|
|
373
412
|
* <p>Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.</p>
|
|
374
413
|
*/
|
|
375
414
|
MaxAgeInMinutes?: number;
|
|
@@ -380,6 +419,7 @@ export interface ResultReuseByAgeConfiguration {
|
|
|
380
419
|
*/
|
|
381
420
|
export interface ResultReuseConfiguration {
|
|
382
421
|
/**
|
|
422
|
+
* @public
|
|
383
423
|
* <p>Specifies whether previous query results are reused, and if so, their maximum
|
|
384
424
|
* age.</p>
|
|
385
425
|
*/
|
|
@@ -404,6 +444,7 @@ export type StatementType = (typeof StatementType)[keyof typeof StatementType];
|
|
|
404
444
|
*/
|
|
405
445
|
export interface ResultReuseInformation {
|
|
406
446
|
/**
|
|
447
|
+
* @public
|
|
407
448
|
* <p>True if a previous query result was reused; false if the result was generated from a
|
|
408
449
|
* new run of the query.</p>
|
|
409
450
|
*/
|
|
@@ -416,14 +457,17 @@ export interface ResultReuseInformation {
|
|
|
416
457
|
*/
|
|
417
458
|
export interface QueryExecutionStatistics {
|
|
418
459
|
/**
|
|
460
|
+
* @public
|
|
419
461
|
* <p>The number of milliseconds that the query took to execute.</p>
|
|
420
462
|
*/
|
|
421
463
|
EngineExecutionTimeInMillis?: number;
|
|
422
464
|
/**
|
|
465
|
+
* @public
|
|
423
466
|
* <p>The number of bytes in the data that was queried.</p>
|
|
424
467
|
*/
|
|
425
468
|
DataScannedInBytes?: number;
|
|
426
469
|
/**
|
|
470
|
+
* @public
|
|
427
471
|
* <p>The location and file name of a data manifest file. The manifest file is saved to the
|
|
428
472
|
* Athena query results location in Amazon S3. The manifest file
|
|
429
473
|
* tracks files that the query wrote to Amazon S3. If the query fails, the manifest
|
|
@@ -434,16 +478,19 @@ export interface QueryExecutionStatistics {
|
|
|
434
478
|
*/
|
|
435
479
|
DataManifestLocation?: string;
|
|
436
480
|
/**
|
|
481
|
+
* @public
|
|
437
482
|
* <p>The number of milliseconds that Athena took to run the query.</p>
|
|
438
483
|
*/
|
|
439
484
|
TotalExecutionTimeInMillis?: number;
|
|
440
485
|
/**
|
|
486
|
+
* @public
|
|
441
487
|
* <p>The number of milliseconds that the query was in your query queue waiting for
|
|
442
488
|
* resources. Note that if transient errors occur, Athena might automatically
|
|
443
489
|
* add the query back to the queue.</p>
|
|
444
490
|
*/
|
|
445
491
|
QueryQueueTimeInMillis?: number;
|
|
446
492
|
/**
|
|
493
|
+
* @public
|
|
447
494
|
* <p>The number of milliseconds that Athena took to plan the query processing
|
|
448
495
|
* flow. This includes the time spent retrieving table partitions from the data source.
|
|
449
496
|
* Note that because the query engine performs the query planning, query planning time is a
|
|
@@ -451,11 +498,13 @@ export interface QueryExecutionStatistics {
|
|
|
451
498
|
*/
|
|
452
499
|
QueryPlanningTimeInMillis?: number;
|
|
453
500
|
/**
|
|
501
|
+
* @public
|
|
454
502
|
* <p>The number of milliseconds that Athena took to finalize and publish the
|
|
455
503
|
* query results after the query engine finished running the query.</p>
|
|
456
504
|
*/
|
|
457
505
|
ServiceProcessingTimeInMillis?: number;
|
|
458
506
|
/**
|
|
507
|
+
* @public
|
|
459
508
|
* <p>Contains information about whether previous query results were reused for the
|
|
460
509
|
* query.</p>
|
|
461
510
|
*/
|
|
@@ -472,6 +521,7 @@ export interface QueryExecutionStatistics {
|
|
|
472
521
|
*/
|
|
473
522
|
export interface AthenaError {
|
|
474
523
|
/**
|
|
524
|
+
* @public
|
|
475
525
|
* <p>An integer value that specifies the category of a query failure error. The following
|
|
476
526
|
* list shows the category for each integer value.</p>
|
|
477
527
|
* <p>
|
|
@@ -483,16 +533,19 @@ export interface AthenaError {
|
|
|
483
533
|
*/
|
|
484
534
|
ErrorCategory?: number;
|
|
485
535
|
/**
|
|
536
|
+
* @public
|
|
486
537
|
* <p>An integer value that provides specific information about an Athena query
|
|
487
538
|
* error. For the meaning of specific values, see the <a href="https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference">Error Type Reference</a> in the <i>Amazon Athena User
|
|
488
539
|
* Guide</i>.</p>
|
|
489
540
|
*/
|
|
490
541
|
ErrorType?: number;
|
|
491
542
|
/**
|
|
543
|
+
* @public
|
|
492
544
|
* <p>True if the query might succeed if resubmitted.</p>
|
|
493
545
|
*/
|
|
494
546
|
Retryable?: boolean;
|
|
495
547
|
/**
|
|
548
|
+
* @public
|
|
496
549
|
* <p>Contains a short description of the error that occurred.</p>
|
|
497
550
|
*/
|
|
498
551
|
ErrorMessage?: string;
|
|
@@ -519,6 +572,7 @@ export type QueryExecutionState = (typeof QueryExecutionState)[keyof typeof Quer
|
|
|
519
572
|
*/
|
|
520
573
|
export interface QueryExecutionStatus {
|
|
521
574
|
/**
|
|
575
|
+
* @public
|
|
522
576
|
* <p>The state of query execution. <code>QUEUED</code> indicates that the query has been
|
|
523
577
|
* submitted to the service, and Athena will execute the query as soon as
|
|
524
578
|
* resources are available. <code>RUNNING</code> indicates that the query is in execution
|
|
@@ -534,18 +588,22 @@ export interface QueryExecutionStatus {
|
|
|
534
588
|
*/
|
|
535
589
|
State?: QueryExecutionState | string;
|
|
536
590
|
/**
|
|
591
|
+
* @public
|
|
537
592
|
* <p>Further detail about the status of the query.</p>
|
|
538
593
|
*/
|
|
539
594
|
StateChangeReason?: string;
|
|
540
595
|
/**
|
|
596
|
+
* @public
|
|
541
597
|
* <p>The date and time that the query was submitted.</p>
|
|
542
598
|
*/
|
|
543
599
|
SubmissionDateTime?: Date;
|
|
544
600
|
/**
|
|
601
|
+
* @public
|
|
545
602
|
* <p>The date and time that the query completed.</p>
|
|
546
603
|
*/
|
|
547
604
|
CompletionDateTime?: Date;
|
|
548
605
|
/**
|
|
606
|
+
* @public
|
|
549
607
|
* <p>Provides information about an Athena query error.</p>
|
|
550
608
|
*/
|
|
551
609
|
AthenaError?: AthenaError;
|
|
@@ -556,14 +614,17 @@ export interface QueryExecutionStatus {
|
|
|
556
614
|
*/
|
|
557
615
|
export interface QueryExecution {
|
|
558
616
|
/**
|
|
617
|
+
* @public
|
|
559
618
|
* <p>The unique identifier for each query execution.</p>
|
|
560
619
|
*/
|
|
561
620
|
QueryExecutionId?: string;
|
|
562
621
|
/**
|
|
622
|
+
* @public
|
|
563
623
|
* <p>The SQL query statements which the query execution ran.</p>
|
|
564
624
|
*/
|
|
565
625
|
Query?: string;
|
|
566
626
|
/**
|
|
627
|
+
* @public
|
|
567
628
|
* <p>The type of query statement that was run. <code>DDL</code> indicates DDL query
|
|
568
629
|
* statements. <code>DML</code> indicates DML (Data Manipulation Language) query
|
|
569
630
|
* statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates
|
|
@@ -572,6 +633,7 @@ export interface QueryExecution {
|
|
|
572
633
|
*/
|
|
573
634
|
StatementType?: StatementType | string;
|
|
574
635
|
/**
|
|
636
|
+
* @public
|
|
575
637
|
* <p>The location in Amazon S3 where query and calculation results are stored and the encryption
|
|
576
638
|
* option, if any, used for query results. These are known as "client-side settings". If
|
|
577
639
|
* workgroup settings override client-side settings, then the query uses the location for
|
|
@@ -580,37 +642,45 @@ export interface QueryExecution {
|
|
|
580
642
|
*/
|
|
581
643
|
ResultConfiguration?: ResultConfiguration;
|
|
582
644
|
/**
|
|
645
|
+
* @public
|
|
583
646
|
* <p>Specifies the query result reuse behavior that was used for the query.</p>
|
|
584
647
|
*/
|
|
585
648
|
ResultReuseConfiguration?: ResultReuseConfiguration;
|
|
586
649
|
/**
|
|
650
|
+
* @public
|
|
587
651
|
* <p>The database in which the query execution occurred.</p>
|
|
588
652
|
*/
|
|
589
653
|
QueryExecutionContext?: QueryExecutionContext;
|
|
590
654
|
/**
|
|
655
|
+
* @public
|
|
591
656
|
* <p>The completion date, current state, submission time, and state change reason (if
|
|
592
657
|
* applicable) for the query execution.</p>
|
|
593
658
|
*/
|
|
594
659
|
Status?: QueryExecutionStatus;
|
|
595
660
|
/**
|
|
661
|
+
* @public
|
|
596
662
|
* <p>Query execution statistics, such as the amount of data scanned, the amount of time
|
|
597
663
|
* that the query took to process, and the type of statement that was run.</p>
|
|
598
664
|
*/
|
|
599
665
|
Statistics?: QueryExecutionStatistics;
|
|
600
666
|
/**
|
|
667
|
+
* @public
|
|
601
668
|
* <p>The name of the workgroup in which the query ran.</p>
|
|
602
669
|
*/
|
|
603
670
|
WorkGroup?: string;
|
|
604
671
|
/**
|
|
672
|
+
* @public
|
|
605
673
|
* <p>The engine version that executed the query.</p>
|
|
606
674
|
*/
|
|
607
675
|
EngineVersion?: EngineVersion;
|
|
608
676
|
/**
|
|
677
|
+
* @public
|
|
609
678
|
* <p>A list of values for the parameters in a query. The values are applied sequentially to
|
|
610
679
|
* the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.</p>
|
|
611
680
|
*/
|
|
612
681
|
ExecutionParameters?: string[];
|
|
613
682
|
/**
|
|
683
|
+
* @public
|
|
614
684
|
* <p>The kind of query statement that was run.</p>
|
|
615
685
|
*/
|
|
616
686
|
SubstatementType?: string;
|
|
@@ -621,15 +691,18 @@ export interface QueryExecution {
|
|
|
621
691
|
*/
|
|
622
692
|
export interface UnprocessedQueryExecutionId {
|
|
623
693
|
/**
|
|
694
|
+
* @public
|
|
624
695
|
* <p>The unique identifier of the query execution.</p>
|
|
625
696
|
*/
|
|
626
697
|
QueryExecutionId?: string;
|
|
627
698
|
/**
|
|
699
|
+
* @public
|
|
628
700
|
* <p>The error code returned when the query execution failed to process, if
|
|
629
701
|
* applicable.</p>
|
|
630
702
|
*/
|
|
631
703
|
ErrorCode?: string;
|
|
632
704
|
/**
|
|
705
|
+
* @public
|
|
633
706
|
* <p>The error message returned when the query execution failed to process, if
|
|
634
707
|
* applicable.</p>
|
|
635
708
|
*/
|
|
@@ -640,10 +713,12 @@ export interface UnprocessedQueryExecutionId {
|
|
|
640
713
|
*/
|
|
641
714
|
export interface BatchGetQueryExecutionOutput {
|
|
642
715
|
/**
|
|
716
|
+
* @public
|
|
643
717
|
* <p>Information about a query execution.</p>
|
|
644
718
|
*/
|
|
645
719
|
QueryExecutions?: QueryExecution[];
|
|
646
720
|
/**
|
|
721
|
+
* @public
|
|
647
722
|
* <p>Information about the query executions that failed to run.</p>
|
|
648
723
|
*/
|
|
649
724
|
UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionId[];
|
|
@@ -653,6 +728,7 @@ export interface BatchGetQueryExecutionOutput {
|
|
|
653
728
|
*/
|
|
654
729
|
export interface CancelCapacityReservationInput {
|
|
655
730
|
/**
|
|
731
|
+
* @public
|
|
656
732
|
* <p>The name of the capacity reservation to cancel.</p>
|
|
657
733
|
*/
|
|
658
734
|
Name: string | undefined;
|
|
@@ -677,12 +753,14 @@ export interface CancelCapacityReservationOutput {
|
|
|
677
753
|
*/
|
|
678
754
|
export interface Tag {
|
|
679
755
|
/**
|
|
756
|
+
* @public
|
|
680
757
|
* <p>A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can
|
|
681
758
|
* use letters and numbers representable in UTF-8, and the following characters: + - = . _
|
|
682
759
|
* : / @. Tag keys are case-sensitive and must be unique per resource. </p>
|
|
683
760
|
*/
|
|
684
761
|
Key?: string;
|
|
685
762
|
/**
|
|
763
|
+
* @public
|
|
686
764
|
* <p>A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You
|
|
687
765
|
* can use letters and numbers representable in UTF-8, and the following characters: + - =
|
|
688
766
|
* . _ : / @. Tag values are case-sensitive. </p>
|
|
@@ -694,14 +772,17 @@ export interface Tag {
|
|
|
694
772
|
*/
|
|
695
773
|
export interface CreateCapacityReservationInput {
|
|
696
774
|
/**
|
|
775
|
+
* @public
|
|
697
776
|
* <p>The number of requested data processing units.</p>
|
|
698
777
|
*/
|
|
699
778
|
TargetDpus: number | undefined;
|
|
700
779
|
/**
|
|
780
|
+
* @public
|
|
701
781
|
* <p>The name of the capacity reservation to create.</p>
|
|
702
782
|
*/
|
|
703
783
|
Name: string | undefined;
|
|
704
784
|
/**
|
|
785
|
+
* @public
|
|
705
786
|
* <p>The tags for the capacity reservation.</p>
|
|
706
787
|
*/
|
|
707
788
|
Tags?: Tag[];
|
|
@@ -729,6 +810,7 @@ export type DataCatalogType = (typeof DataCatalogType)[keyof typeof DataCatalogT
|
|
|
729
810
|
*/
|
|
730
811
|
export interface CreateDataCatalogInput {
|
|
731
812
|
/**
|
|
813
|
+
* @public
|
|
732
814
|
* <p>The name of the data catalog to create. The catalog name must be unique for the
|
|
733
815
|
* Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at
|
|
734
816
|
* sign, or hyphen characters. The remainder of the length constraint of 256 is reserved
|
|
@@ -736,16 +818,19 @@ export interface CreateDataCatalogInput {
|
|
|
736
818
|
*/
|
|
737
819
|
Name: string | undefined;
|
|
738
820
|
/**
|
|
821
|
+
* @public
|
|
739
822
|
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
740
823
|
* <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
|
|
741
824
|
* Glue Data Catalog.</p>
|
|
742
825
|
*/
|
|
743
826
|
Type: DataCatalogType | string | undefined;
|
|
744
827
|
/**
|
|
828
|
+
* @public
|
|
745
829
|
* <p>A description of the data catalog to be created.</p>
|
|
746
830
|
*/
|
|
747
831
|
Description?: string;
|
|
748
832
|
/**
|
|
833
|
+
* @public
|
|
749
834
|
* <p>Specifies the Lambda function or functions to use for creating the data
|
|
750
835
|
* catalog. This is a mapping whose values depend on the catalog type. </p>
|
|
751
836
|
* <ul>
|
|
@@ -817,6 +902,7 @@ export interface CreateDataCatalogInput {
|
|
|
817
902
|
*/
|
|
818
903
|
Parameters?: Record<string, string>;
|
|
819
904
|
/**
|
|
905
|
+
* @public
|
|
820
906
|
* <p>A list of comma separated tags to add to the data catalog that is created.</p>
|
|
821
907
|
*/
|
|
822
908
|
Tags?: Tag[];
|
|
@@ -831,22 +917,27 @@ export interface CreateDataCatalogOutput {
|
|
|
831
917
|
*/
|
|
832
918
|
export interface CreateNamedQueryInput {
|
|
833
919
|
/**
|
|
920
|
+
* @public
|
|
834
921
|
* <p>The query name.</p>
|
|
835
922
|
*/
|
|
836
923
|
Name: string | undefined;
|
|
837
924
|
/**
|
|
925
|
+
* @public
|
|
838
926
|
* <p>The query description.</p>
|
|
839
927
|
*/
|
|
840
928
|
Description?: string;
|
|
841
929
|
/**
|
|
930
|
+
* @public
|
|
842
931
|
* <p>The database to which the query belongs.</p>
|
|
843
932
|
*/
|
|
844
933
|
Database: string | undefined;
|
|
845
934
|
/**
|
|
935
|
+
* @public
|
|
846
936
|
* <p>The contents of the query with all query statements.</p>
|
|
847
937
|
*/
|
|
848
938
|
QueryString: string | undefined;
|
|
849
939
|
/**
|
|
940
|
+
* @public
|
|
850
941
|
* <p>A unique case-sensitive string used to ensure the request to create the query is
|
|
851
942
|
* idempotent (executes only once). If another <code>CreateNamedQuery</code> request is
|
|
852
943
|
* received, the same response is returned and another query is not created. If a parameter
|
|
@@ -860,6 +951,7 @@ export interface CreateNamedQueryInput {
|
|
|
860
951
|
*/
|
|
861
952
|
ClientRequestToken?: string;
|
|
862
953
|
/**
|
|
954
|
+
* @public
|
|
863
955
|
* <p>The name of the workgroup in which the named query is being created.</p>
|
|
864
956
|
*/
|
|
865
957
|
WorkGroup?: string;
|
|
@@ -869,6 +961,7 @@ export interface CreateNamedQueryInput {
|
|
|
869
961
|
*/
|
|
870
962
|
export interface CreateNamedQueryOutput {
|
|
871
963
|
/**
|
|
964
|
+
* @public
|
|
872
965
|
* <p>The unique ID of the query.</p>
|
|
873
966
|
*/
|
|
874
967
|
NamedQueryId?: string;
|
|
@@ -878,15 +971,18 @@ export interface CreateNamedQueryOutput {
|
|
|
878
971
|
*/
|
|
879
972
|
export interface CreateNotebookInput {
|
|
880
973
|
/**
|
|
974
|
+
* @public
|
|
881
975
|
* <p>The name of the Spark enabled workgroup in which the notebook will be created.</p>
|
|
882
976
|
*/
|
|
883
977
|
WorkGroup: string | undefined;
|
|
884
978
|
/**
|
|
979
|
+
* @public
|
|
885
980
|
* <p>The name of the <code>ipynb</code> file to be created in the Spark workgroup, without
|
|
886
981
|
* the <code>.ipynb</code> extension.</p>
|
|
887
982
|
*/
|
|
888
983
|
Name: string | undefined;
|
|
889
984
|
/**
|
|
985
|
+
* @public
|
|
890
986
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
891
987
|
* idempotent (executes only once).</p>
|
|
892
988
|
* <important>
|
|
@@ -903,6 +999,7 @@ export interface CreateNotebookInput {
|
|
|
903
999
|
*/
|
|
904
1000
|
export interface CreateNotebookOutput {
|
|
905
1001
|
/**
|
|
1002
|
+
* @public
|
|
906
1003
|
* <p>A unique identifier for the notebook.</p>
|
|
907
1004
|
*/
|
|
908
1005
|
NotebookId?: string;
|
|
@@ -927,6 +1024,7 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
927
1024
|
readonly $fault: "client";
|
|
928
1025
|
Message?: string;
|
|
929
1026
|
/**
|
|
1027
|
+
* @public
|
|
930
1028
|
* <p>The reason for the query throttling, for example, when it exceeds the concurrent query
|
|
931
1029
|
* limit.</p>
|
|
932
1030
|
*/
|
|
@@ -941,18 +1039,22 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
941
1039
|
*/
|
|
942
1040
|
export interface CreatePreparedStatementInput {
|
|
943
1041
|
/**
|
|
1042
|
+
* @public
|
|
944
1043
|
* <p>The name of the prepared statement.</p>
|
|
945
1044
|
*/
|
|
946
1045
|
StatementName: string | undefined;
|
|
947
1046
|
/**
|
|
1047
|
+
* @public
|
|
948
1048
|
* <p>The name of the workgroup to which the prepared statement belongs.</p>
|
|
949
1049
|
*/
|
|
950
1050
|
WorkGroup: string | undefined;
|
|
951
1051
|
/**
|
|
1052
|
+
* @public
|
|
952
1053
|
* <p>The query string for the prepared statement.</p>
|
|
953
1054
|
*/
|
|
954
1055
|
QueryStatement: string | undefined;
|
|
955
1056
|
/**
|
|
1057
|
+
* @public
|
|
956
1058
|
* <p>The description of the prepared statement.</p>
|
|
957
1059
|
*/
|
|
958
1060
|
Description?: string;
|
|
@@ -967,6 +1069,7 @@ export interface CreatePreparedStatementOutput {
|
|
|
967
1069
|
*/
|
|
968
1070
|
export interface CreatePresignedNotebookUrlRequest {
|
|
969
1071
|
/**
|
|
1072
|
+
* @public
|
|
970
1073
|
* <p>The session ID.</p>
|
|
971
1074
|
*/
|
|
972
1075
|
SessionId: string | undefined;
|
|
@@ -976,15 +1079,18 @@ export interface CreatePresignedNotebookUrlRequest {
|
|
|
976
1079
|
*/
|
|
977
1080
|
export interface CreatePresignedNotebookUrlResponse {
|
|
978
1081
|
/**
|
|
1082
|
+
* @public
|
|
979
1083
|
* <p>The URL of the notebook. The URL includes the authentication token and notebook file
|
|
980
1084
|
* name and points directly to the opened notebook.</p>
|
|
981
1085
|
*/
|
|
982
1086
|
NotebookUrl: string | undefined;
|
|
983
1087
|
/**
|
|
1088
|
+
* @public
|
|
984
1089
|
* <p>The authentication token for the notebook.</p>
|
|
985
1090
|
*/
|
|
986
1091
|
AuthToken: string | undefined;
|
|
987
1092
|
/**
|
|
1093
|
+
* @public
|
|
988
1094
|
* <p>The UTC epoch time when the authentication token expires.</p>
|
|
989
1095
|
*/
|
|
990
1096
|
AuthTokenExpirationTime: number | undefined;
|
|
@@ -998,6 +1104,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
998
1104
|
readonly $fault: "client";
|
|
999
1105
|
Message?: string;
|
|
1000
1106
|
/**
|
|
1107
|
+
* @public
|
|
1001
1108
|
* <p>The name of the Amazon resource.</p>
|
|
1002
1109
|
*/
|
|
1003
1110
|
ResourceName?: string;
|
|
@@ -1012,6 +1119,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1012
1119
|
*/
|
|
1013
1120
|
export interface CustomerContentEncryptionConfiguration {
|
|
1014
1121
|
/**
|
|
1122
|
+
* @public
|
|
1015
1123
|
* <p>The KMS key that is used to encrypt the user's data stores in Athena.</p>
|
|
1016
1124
|
*/
|
|
1017
1125
|
KmsKey: string | undefined;
|
|
@@ -1028,6 +1136,7 @@ export interface CustomerContentEncryptionConfiguration {
|
|
|
1028
1136
|
*/
|
|
1029
1137
|
export interface WorkGroupConfiguration {
|
|
1030
1138
|
/**
|
|
1139
|
+
* @public
|
|
1031
1140
|
* <p>The configuration for the workgroup, which includes the location in Amazon S3
|
|
1032
1141
|
* where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the
|
|
1033
1142
|
* ways: either in the workgroup using this setting, or for individual queries
|
|
@@ -1037,20 +1146,24 @@ export interface WorkGroupConfiguration {
|
|
|
1037
1146
|
*/
|
|
1038
1147
|
ResultConfiguration?: ResultConfiguration;
|
|
1039
1148
|
/**
|
|
1149
|
+
* @public
|
|
1040
1150
|
* <p>If set to "true", the settings for the workgroup override client-side settings. If set
|
|
1041
1151
|
* to "false", client-side settings are used. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
1042
1152
|
*/
|
|
1043
1153
|
EnforceWorkGroupConfiguration?: boolean;
|
|
1044
1154
|
/**
|
|
1155
|
+
* @public
|
|
1045
1156
|
* <p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>
|
|
1046
1157
|
*/
|
|
1047
1158
|
PublishCloudWatchMetricsEnabled?: boolean;
|
|
1048
1159
|
/**
|
|
1160
|
+
* @public
|
|
1049
1161
|
* <p>The upper data usage limit (cutoff) for the amount of bytes a single query in a
|
|
1050
1162
|
* workgroup is allowed to scan.</p>
|
|
1051
1163
|
*/
|
|
1052
1164
|
BytesScannedCutoffPerQuery?: number;
|
|
1053
1165
|
/**
|
|
1166
|
+
* @public
|
|
1054
1167
|
* <p>If set to <code>true</code>, allows members assigned to a workgroup to reference
|
|
1055
1168
|
* Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>,
|
|
1056
1169
|
* workgroup members cannot query data from Requester Pays buckets, and queries that
|
|
@@ -1061,24 +1174,29 @@ export interface WorkGroupConfiguration {
|
|
|
1061
1174
|
*/
|
|
1062
1175
|
RequesterPaysEnabled?: boolean;
|
|
1063
1176
|
/**
|
|
1177
|
+
* @public
|
|
1064
1178
|
* <p>The engine version that all queries running on the workgroup use. Queries on the
|
|
1065
1179
|
* <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine
|
|
1066
1180
|
* regardless of this setting.</p>
|
|
1067
1181
|
*/
|
|
1068
1182
|
EngineVersion?: EngineVersion;
|
|
1069
1183
|
/**
|
|
1184
|
+
* @public
|
|
1070
1185
|
* <p>Specifies a user defined JSON string that is passed to the notebook engine.</p>
|
|
1071
1186
|
*/
|
|
1072
1187
|
AdditionalConfiguration?: string;
|
|
1073
1188
|
/**
|
|
1189
|
+
* @public
|
|
1074
1190
|
* <p>Role used in a session for accessing the user's resources.</p>
|
|
1075
1191
|
*/
|
|
1076
1192
|
ExecutionRole?: string;
|
|
1077
1193
|
/**
|
|
1194
|
+
* @public
|
|
1078
1195
|
* <p>Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.</p>
|
|
1079
1196
|
*/
|
|
1080
1197
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
1081
1198
|
/**
|
|
1199
|
+
* @public
|
|
1082
1200
|
* <p>Enforces a minimal level of encryption for the workgroup for query and calculation
|
|
1083
1201
|
* results that are written to Amazon S3. When enabled, workgroup users can set
|
|
1084
1202
|
* encryption only to the minimum level set by the administrator or higher when they submit queries.</p>
|
|
@@ -1091,10 +1209,12 @@ export interface WorkGroupConfiguration {
|
|
|
1091
1209
|
*/
|
|
1092
1210
|
export interface CreateWorkGroupInput {
|
|
1093
1211
|
/**
|
|
1212
|
+
* @public
|
|
1094
1213
|
* <p>The workgroup name.</p>
|
|
1095
1214
|
*/
|
|
1096
1215
|
Name: string | undefined;
|
|
1097
1216
|
/**
|
|
1217
|
+
* @public
|
|
1098
1218
|
* <p>Contains configuration information for creating an Athena SQL workgroup or
|
|
1099
1219
|
* Spark enabled Athena workgroup. Athena SQL workgroup
|
|
1100
1220
|
* configuration includes the location in Amazon S3 where query and calculation results are stored,
|
|
@@ -1106,10 +1226,12 @@ export interface CreateWorkGroupInput {
|
|
|
1106
1226
|
*/
|
|
1107
1227
|
Configuration?: WorkGroupConfiguration;
|
|
1108
1228
|
/**
|
|
1229
|
+
* @public
|
|
1109
1230
|
* <p>The workgroup description.</p>
|
|
1110
1231
|
*/
|
|
1111
1232
|
Description?: string;
|
|
1112
1233
|
/**
|
|
1234
|
+
* @public
|
|
1113
1235
|
* <p>A list of comma separated tags to add to the workgroup that is created.</p>
|
|
1114
1236
|
*/
|
|
1115
1237
|
Tags?: Tag[];
|
|
@@ -1124,6 +1246,7 @@ export interface CreateWorkGroupOutput {
|
|
|
1124
1246
|
*/
|
|
1125
1247
|
export interface DeleteCapacityReservationInput {
|
|
1126
1248
|
/**
|
|
1249
|
+
* @public
|
|
1127
1250
|
* <p>The name of the capacity reservation to delete.</p>
|
|
1128
1251
|
*/
|
|
1129
1252
|
Name: string | undefined;
|
|
@@ -1138,6 +1261,7 @@ export interface DeleteCapacityReservationOutput {
|
|
|
1138
1261
|
*/
|
|
1139
1262
|
export interface DeleteDataCatalogInput {
|
|
1140
1263
|
/**
|
|
1264
|
+
* @public
|
|
1141
1265
|
* <p>The name of the data catalog to delete.</p>
|
|
1142
1266
|
*/
|
|
1143
1267
|
Name: string | undefined;
|
|
@@ -1152,6 +1276,7 @@ export interface DeleteDataCatalogOutput {
|
|
|
1152
1276
|
*/
|
|
1153
1277
|
export interface DeleteNamedQueryInput {
|
|
1154
1278
|
/**
|
|
1279
|
+
* @public
|
|
1155
1280
|
* <p>The unique ID of the query to delete.</p>
|
|
1156
1281
|
*/
|
|
1157
1282
|
NamedQueryId?: string;
|
|
@@ -1166,6 +1291,7 @@ export interface DeleteNamedQueryOutput {
|
|
|
1166
1291
|
*/
|
|
1167
1292
|
export interface DeleteNotebookInput {
|
|
1168
1293
|
/**
|
|
1294
|
+
* @public
|
|
1169
1295
|
* <p>The ID of the notebook to delete.</p>
|
|
1170
1296
|
*/
|
|
1171
1297
|
NotebookId: string | undefined;
|
|
@@ -1180,10 +1306,12 @@ export interface DeleteNotebookOutput {
|
|
|
1180
1306
|
*/
|
|
1181
1307
|
export interface DeletePreparedStatementInput {
|
|
1182
1308
|
/**
|
|
1309
|
+
* @public
|
|
1183
1310
|
* <p>The name of the prepared statement to delete.</p>
|
|
1184
1311
|
*/
|
|
1185
1312
|
StatementName: string | undefined;
|
|
1186
1313
|
/**
|
|
1314
|
+
* @public
|
|
1187
1315
|
* <p>The workgroup to which the statement to be deleted belongs.</p>
|
|
1188
1316
|
*/
|
|
1189
1317
|
WorkGroup: string | undefined;
|
|
@@ -1198,10 +1326,12 @@ export interface DeletePreparedStatementOutput {
|
|
|
1198
1326
|
*/
|
|
1199
1327
|
export interface DeleteWorkGroupInput {
|
|
1200
1328
|
/**
|
|
1329
|
+
* @public
|
|
1201
1330
|
* <p>The unique name of the workgroup to delete.</p>
|
|
1202
1331
|
*/
|
|
1203
1332
|
WorkGroup: string | undefined;
|
|
1204
1333
|
/**
|
|
1334
|
+
* @public
|
|
1205
1335
|
* <p>The option to delete the workgroup and its contents even if the workgroup contains any
|
|
1206
1336
|
* named queries, query executions, or notebooks.</p>
|
|
1207
1337
|
*/
|
|
@@ -1217,6 +1347,7 @@ export interface DeleteWorkGroupOutput {
|
|
|
1217
1347
|
*/
|
|
1218
1348
|
export interface ExportNotebookInput {
|
|
1219
1349
|
/**
|
|
1350
|
+
* @public
|
|
1220
1351
|
* <p>The ID of the notebook to export.</p>
|
|
1221
1352
|
*/
|
|
1222
1353
|
NotebookId: string | undefined;
|
|
@@ -1239,26 +1370,32 @@ export type NotebookType = (typeof NotebookType)[keyof typeof NotebookType];
|
|
|
1239
1370
|
*/
|
|
1240
1371
|
export interface NotebookMetadata {
|
|
1241
1372
|
/**
|
|
1373
|
+
* @public
|
|
1242
1374
|
* <p>The notebook ID.</p>
|
|
1243
1375
|
*/
|
|
1244
1376
|
NotebookId?: string;
|
|
1245
1377
|
/**
|
|
1378
|
+
* @public
|
|
1246
1379
|
* <p>The name of the notebook.</p>
|
|
1247
1380
|
*/
|
|
1248
1381
|
Name?: string;
|
|
1249
1382
|
/**
|
|
1383
|
+
* @public
|
|
1250
1384
|
* <p>The name of the Spark enabled workgroup to which the notebook belongs.</p>
|
|
1251
1385
|
*/
|
|
1252
1386
|
WorkGroup?: string;
|
|
1253
1387
|
/**
|
|
1388
|
+
* @public
|
|
1254
1389
|
* <p>The time when the notebook was created.</p>
|
|
1255
1390
|
*/
|
|
1256
1391
|
CreationTime?: Date;
|
|
1257
1392
|
/**
|
|
1393
|
+
* @public
|
|
1258
1394
|
* <p>The type of notebook. Currently, the only valid type is <code>IPYNB</code>.</p>
|
|
1259
1395
|
*/
|
|
1260
1396
|
Type?: NotebookType | string;
|
|
1261
1397
|
/**
|
|
1398
|
+
* @public
|
|
1262
1399
|
* <p>The time when the notebook was last modified.</p>
|
|
1263
1400
|
*/
|
|
1264
1401
|
LastModifiedTime?: Date;
|
|
@@ -1268,11 +1405,13 @@ export interface NotebookMetadata {
|
|
|
1268
1405
|
*/
|
|
1269
1406
|
export interface ExportNotebookOutput {
|
|
1270
1407
|
/**
|
|
1408
|
+
* @public
|
|
1271
1409
|
* <p>The notebook metadata, including notebook ID, notebook name, and workgroup
|
|
1272
1410
|
* name.</p>
|
|
1273
1411
|
*/
|
|
1274
1412
|
NotebookMetadata?: NotebookMetadata;
|
|
1275
1413
|
/**
|
|
1414
|
+
* @public
|
|
1276
1415
|
* <p>The content of the exported notebook.</p>
|
|
1277
1416
|
*/
|
|
1278
1417
|
Payload?: string;
|
|
@@ -1282,6 +1421,7 @@ export interface ExportNotebookOutput {
|
|
|
1282
1421
|
*/
|
|
1283
1422
|
export interface GetCalculationExecutionRequest {
|
|
1284
1423
|
/**
|
|
1424
|
+
* @public
|
|
1285
1425
|
* <p>The calculation execution UUID.</p>
|
|
1286
1426
|
*/
|
|
1287
1427
|
CalculationExecutionId: string | undefined;
|
|
@@ -1292,19 +1432,23 @@ export interface GetCalculationExecutionRequest {
|
|
|
1292
1432
|
*/
|
|
1293
1433
|
export interface CalculationResult {
|
|
1294
1434
|
/**
|
|
1435
|
+
* @public
|
|
1295
1436
|
* <p>The Amazon S3 location of the <code>stdout</code> file for the calculation.</p>
|
|
1296
1437
|
*/
|
|
1297
1438
|
StdOutS3Uri?: string;
|
|
1298
1439
|
/**
|
|
1440
|
+
* @public
|
|
1299
1441
|
* <p>The Amazon S3 location of the <code>stderr</code> error messages file for the
|
|
1300
1442
|
* calculation.</p>
|
|
1301
1443
|
*/
|
|
1302
1444
|
StdErrorS3Uri?: string;
|
|
1303
1445
|
/**
|
|
1446
|
+
* @public
|
|
1304
1447
|
* <p>The Amazon S3 location of the folder for the calculation results.</p>
|
|
1305
1448
|
*/
|
|
1306
1449
|
ResultS3Uri?: string;
|
|
1307
1450
|
/**
|
|
1451
|
+
* @public
|
|
1308
1452
|
* <p>The data format of the calculation result.</p>
|
|
1309
1453
|
*/
|
|
1310
1454
|
ResultType?: string;
|
|
@@ -1315,10 +1459,12 @@ export interface CalculationResult {
|
|
|
1315
1459
|
*/
|
|
1316
1460
|
export interface CalculationStatistics {
|
|
1317
1461
|
/**
|
|
1462
|
+
* @public
|
|
1318
1463
|
* <p>The data processing unit execution time in milliseconds for the calculation.</p>
|
|
1319
1464
|
*/
|
|
1320
1465
|
DpuExecutionInMillis?: number;
|
|
1321
1466
|
/**
|
|
1467
|
+
* @public
|
|
1322
1468
|
* <p>The progress of the calculation.</p>
|
|
1323
1469
|
*/
|
|
1324
1470
|
Progress?: string;
|
|
@@ -1347,14 +1493,17 @@ export type CalculationExecutionState = (typeof CalculationExecutionState)[keyof
|
|
|
1347
1493
|
*/
|
|
1348
1494
|
export interface CalculationStatus {
|
|
1349
1495
|
/**
|
|
1496
|
+
* @public
|
|
1350
1497
|
* <p>The date and time the calculation was submitted for processing.</p>
|
|
1351
1498
|
*/
|
|
1352
1499
|
SubmissionDateTime?: Date;
|
|
1353
1500
|
/**
|
|
1501
|
+
* @public
|
|
1354
1502
|
* <p>The date and time the calculation completed processing.</p>
|
|
1355
1503
|
*/
|
|
1356
1504
|
CompletionDateTime?: Date;
|
|
1357
1505
|
/**
|
|
1506
|
+
* @public
|
|
1358
1507
|
* <p>The state of the calculation execution. A description of each state follows.</p>
|
|
1359
1508
|
* <p>
|
|
1360
1509
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
@@ -1377,6 +1526,7 @@ export interface CalculationStatus {
|
|
|
1377
1526
|
*/
|
|
1378
1527
|
State?: CalculationExecutionState | string;
|
|
1379
1528
|
/**
|
|
1529
|
+
* @public
|
|
1380
1530
|
* <p>The reason for the calculation state change (for example, the calculation was canceled
|
|
1381
1531
|
* because the session was terminated).</p>
|
|
1382
1532
|
*/
|
|
@@ -1387,31 +1537,38 @@ export interface CalculationStatus {
|
|
|
1387
1537
|
*/
|
|
1388
1538
|
export interface GetCalculationExecutionResponse {
|
|
1389
1539
|
/**
|
|
1540
|
+
* @public
|
|
1390
1541
|
* <p>The calculation execution UUID.</p>
|
|
1391
1542
|
*/
|
|
1392
1543
|
CalculationExecutionId?: string;
|
|
1393
1544
|
/**
|
|
1545
|
+
* @public
|
|
1394
1546
|
* <p>The session ID that the calculation ran in.</p>
|
|
1395
1547
|
*/
|
|
1396
1548
|
SessionId?: string;
|
|
1397
1549
|
/**
|
|
1550
|
+
* @public
|
|
1398
1551
|
* <p>The description of the calculation execution.</p>
|
|
1399
1552
|
*/
|
|
1400
1553
|
Description?: string;
|
|
1401
1554
|
/**
|
|
1555
|
+
* @public
|
|
1402
1556
|
* <p>The Amazon S3 location in which calculation results are stored.</p>
|
|
1403
1557
|
*/
|
|
1404
1558
|
WorkingDirectory?: string;
|
|
1405
1559
|
/**
|
|
1560
|
+
* @public
|
|
1406
1561
|
* <p>Contains information about the status of the calculation.</p>
|
|
1407
1562
|
*/
|
|
1408
1563
|
Status?: CalculationStatus;
|
|
1409
1564
|
/**
|
|
1565
|
+
* @public
|
|
1410
1566
|
* <p>Contains information about the data processing unit (DPU) execution time and progress.
|
|
1411
1567
|
* This field is populated only when statistics are available.</p>
|
|
1412
1568
|
*/
|
|
1413
1569
|
Statistics?: CalculationStatistics;
|
|
1414
1570
|
/**
|
|
1571
|
+
* @public
|
|
1415
1572
|
* <p>Contains result information. This field is populated only if the calculation is
|
|
1416
1573
|
* completed.</p>
|
|
1417
1574
|
*/
|
|
@@ -1422,6 +1579,7 @@ export interface GetCalculationExecutionResponse {
|
|
|
1422
1579
|
*/
|
|
1423
1580
|
export interface GetCalculationExecutionCodeRequest {
|
|
1424
1581
|
/**
|
|
1582
|
+
* @public
|
|
1425
1583
|
* <p>The calculation execution UUID.</p>
|
|
1426
1584
|
*/
|
|
1427
1585
|
CalculationExecutionId: string | undefined;
|
|
@@ -1431,6 +1589,7 @@ export interface GetCalculationExecutionCodeRequest {
|
|
|
1431
1589
|
*/
|
|
1432
1590
|
export interface GetCalculationExecutionCodeResponse {
|
|
1433
1591
|
/**
|
|
1592
|
+
* @public
|
|
1434
1593
|
* <p>The unencrypted code that was executed for the calculation.</p>
|
|
1435
1594
|
*/
|
|
1436
1595
|
CodeBlock?: string;
|
|
@@ -1440,6 +1599,7 @@ export interface GetCalculationExecutionCodeResponse {
|
|
|
1440
1599
|
*/
|
|
1441
1600
|
export interface GetCalculationExecutionStatusRequest {
|
|
1442
1601
|
/**
|
|
1602
|
+
* @public
|
|
1443
1603
|
* <p>The calculation execution UUID.</p>
|
|
1444
1604
|
*/
|
|
1445
1605
|
CalculationExecutionId: string | undefined;
|
|
@@ -1449,10 +1609,12 @@ export interface GetCalculationExecutionStatusRequest {
|
|
|
1449
1609
|
*/
|
|
1450
1610
|
export interface GetCalculationExecutionStatusResponse {
|
|
1451
1611
|
/**
|
|
1612
|
+
* @public
|
|
1452
1613
|
* <p>Contains information about the calculation execution status.</p>
|
|
1453
1614
|
*/
|
|
1454
1615
|
Status?: CalculationStatus;
|
|
1455
1616
|
/**
|
|
1617
|
+
* @public
|
|
1456
1618
|
* <p>Contains information about the DPU execution time and progress.</p>
|
|
1457
1619
|
*/
|
|
1458
1620
|
Statistics?: CalculationStatistics;
|
|
@@ -1462,6 +1624,7 @@ export interface GetCalculationExecutionStatusResponse {
|
|
|
1462
1624
|
*/
|
|
1463
1625
|
export interface GetCapacityAssignmentConfigurationInput {
|
|
1464
1626
|
/**
|
|
1627
|
+
* @public
|
|
1465
1628
|
* <p>The name of the capacity reservation to retrieve the capacity assignment configuration for.</p>
|
|
1466
1629
|
*/
|
|
1467
1630
|
CapacityReservationName: string | undefined;
|
|
@@ -1472,6 +1635,7 @@ export interface GetCapacityAssignmentConfigurationInput {
|
|
|
1472
1635
|
*/
|
|
1473
1636
|
export interface CapacityAssignment {
|
|
1474
1637
|
/**
|
|
1638
|
+
* @public
|
|
1475
1639
|
* <p>The list of workgroup names for the capacity assignment.</p>
|
|
1476
1640
|
*/
|
|
1477
1641
|
WorkGroupNames?: string[];
|
|
@@ -1482,10 +1646,12 @@ export interface CapacityAssignment {
|
|
|
1482
1646
|
*/
|
|
1483
1647
|
export interface CapacityAssignmentConfiguration {
|
|
1484
1648
|
/**
|
|
1649
|
+
* @public
|
|
1485
1650
|
* <p>The name of the reservation that the capacity assignment configuration is for.</p>
|
|
1486
1651
|
*/
|
|
1487
1652
|
CapacityReservationName?: string;
|
|
1488
1653
|
/**
|
|
1654
|
+
* @public
|
|
1489
1655
|
* <p>The list of assignments that make up the capacity assignment configuration.</p>
|
|
1490
1656
|
*/
|
|
1491
1657
|
CapacityAssignments?: CapacityAssignment[];
|
|
@@ -1495,6 +1661,7 @@ export interface CapacityAssignmentConfiguration {
|
|
|
1495
1661
|
*/
|
|
1496
1662
|
export interface GetCapacityAssignmentConfigurationOutput {
|
|
1497
1663
|
/**
|
|
1664
|
+
* @public
|
|
1498
1665
|
* <p>The requested capacity assignment configuration for the specified capacity reservation.</p>
|
|
1499
1666
|
*/
|
|
1500
1667
|
CapacityAssignmentConfiguration: CapacityAssignmentConfiguration | undefined;
|
|
@@ -1504,6 +1671,7 @@ export interface GetCapacityAssignmentConfigurationOutput {
|
|
|
1504
1671
|
*/
|
|
1505
1672
|
export interface GetCapacityReservationInput {
|
|
1506
1673
|
/**
|
|
1674
|
+
* @public
|
|
1507
1675
|
* <p>The name of the capacity reservation.</p>
|
|
1508
1676
|
*/
|
|
1509
1677
|
Name: string | undefined;
|
|
@@ -1527,18 +1695,22 @@ export type CapacityAllocationStatus = (typeof CapacityAllocationStatus)[keyof t
|
|
|
1527
1695
|
*/
|
|
1528
1696
|
export interface CapacityAllocation {
|
|
1529
1697
|
/**
|
|
1698
|
+
* @public
|
|
1530
1699
|
* <p>The status of the capacity allocation.</p>
|
|
1531
1700
|
*/
|
|
1532
1701
|
Status: CapacityAllocationStatus | string | undefined;
|
|
1533
1702
|
/**
|
|
1703
|
+
* @public
|
|
1534
1704
|
* <p>The status message of the capacity allocation.</p>
|
|
1535
1705
|
*/
|
|
1536
1706
|
StatusMessage?: string;
|
|
1537
1707
|
/**
|
|
1708
|
+
* @public
|
|
1538
1709
|
* <p>The time when the capacity allocation was requested.</p>
|
|
1539
1710
|
*/
|
|
1540
1711
|
RequestTime: Date | undefined;
|
|
1541
1712
|
/**
|
|
1713
|
+
* @public
|
|
1542
1714
|
* <p>The time when the capacity allocation request was completed.</p>
|
|
1543
1715
|
*/
|
|
1544
1716
|
RequestCompletionTime?: Date;
|
|
@@ -1565,30 +1737,37 @@ export type CapacityReservationStatus = (typeof CapacityReservationStatus)[keyof
|
|
|
1565
1737
|
*/
|
|
1566
1738
|
export interface CapacityReservation {
|
|
1567
1739
|
/**
|
|
1740
|
+
* @public
|
|
1568
1741
|
* <p>The name of the capacity reservation.</p>
|
|
1569
1742
|
*/
|
|
1570
1743
|
Name: string | undefined;
|
|
1571
1744
|
/**
|
|
1745
|
+
* @public
|
|
1572
1746
|
* <p>The status of the capacity reservation.</p>
|
|
1573
1747
|
*/
|
|
1574
1748
|
Status: CapacityReservationStatus | string | undefined;
|
|
1575
1749
|
/**
|
|
1750
|
+
* @public
|
|
1576
1751
|
* <p>The number of data processing units requested.</p>
|
|
1577
1752
|
*/
|
|
1578
1753
|
TargetDpus: number | undefined;
|
|
1579
1754
|
/**
|
|
1755
|
+
* @public
|
|
1580
1756
|
* <p>The number of data processing units currently allocated.</p>
|
|
1581
1757
|
*/
|
|
1582
1758
|
AllocatedDpus: number | undefined;
|
|
1583
1759
|
/**
|
|
1760
|
+
* @public
|
|
1584
1761
|
* <p>Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.</p>
|
|
1585
1762
|
*/
|
|
1586
1763
|
LastAllocation?: CapacityAllocation;
|
|
1587
1764
|
/**
|
|
1765
|
+
* @public
|
|
1588
1766
|
* <p>The time of the most recent capacity allocation that succeeded.</p>
|
|
1589
1767
|
*/
|
|
1590
1768
|
LastSuccessfulAllocationTime?: Date;
|
|
1591
1769
|
/**
|
|
1770
|
+
* @public
|
|
1592
1771
|
* <p>The time in UTC epoch millis when the capacity reservation was created.</p>
|
|
1593
1772
|
*/
|
|
1594
1773
|
CreationTime: Date | undefined;
|
|
@@ -1598,6 +1777,7 @@ export interface CapacityReservation {
|
|
|
1598
1777
|
*/
|
|
1599
1778
|
export interface GetCapacityReservationOutput {
|
|
1600
1779
|
/**
|
|
1780
|
+
* @public
|
|
1601
1781
|
* <p>The requested capacity reservation structure.</p>
|
|
1602
1782
|
*/
|
|
1603
1783
|
CapacityReservation: CapacityReservation | undefined;
|
|
@@ -1607,10 +1787,12 @@ export interface GetCapacityReservationOutput {
|
|
|
1607
1787
|
*/
|
|
1608
1788
|
export interface GetDatabaseInput {
|
|
1609
1789
|
/**
|
|
1790
|
+
* @public
|
|
1610
1791
|
* <p>The name of the data catalog that contains the database to return.</p>
|
|
1611
1792
|
*/
|
|
1612
1793
|
CatalogName: string | undefined;
|
|
1613
1794
|
/**
|
|
1795
|
+
* @public
|
|
1614
1796
|
* <p>The name of the database to return.</p>
|
|
1615
1797
|
*/
|
|
1616
1798
|
DatabaseName: string | undefined;
|
|
@@ -1621,14 +1803,17 @@ export interface GetDatabaseInput {
|
|
|
1621
1803
|
*/
|
|
1622
1804
|
export interface Database {
|
|
1623
1805
|
/**
|
|
1806
|
+
* @public
|
|
1624
1807
|
* <p>The name of the database.</p>
|
|
1625
1808
|
*/
|
|
1626
1809
|
Name: string | undefined;
|
|
1627
1810
|
/**
|
|
1811
|
+
* @public
|
|
1628
1812
|
* <p>An optional description of the database.</p>
|
|
1629
1813
|
*/
|
|
1630
1814
|
Description?: string;
|
|
1631
1815
|
/**
|
|
1816
|
+
* @public
|
|
1632
1817
|
* <p>A set of custom key/value pairs.</p>
|
|
1633
1818
|
*/
|
|
1634
1819
|
Parameters?: Record<string, string>;
|
|
@@ -1638,6 +1823,7 @@ export interface Database {
|
|
|
1638
1823
|
*/
|
|
1639
1824
|
export interface GetDatabaseOutput {
|
|
1640
1825
|
/**
|
|
1826
|
+
* @public
|
|
1641
1827
|
* <p>The database returned.</p>
|
|
1642
1828
|
*/
|
|
1643
1829
|
Database?: Database;
|
|
@@ -1665,6 +1851,7 @@ export declare class MetadataException extends __BaseException {
|
|
|
1665
1851
|
*/
|
|
1666
1852
|
export interface GetDataCatalogInput {
|
|
1667
1853
|
/**
|
|
1854
|
+
* @public
|
|
1668
1855
|
* <p>The name of the data catalog to return.</p>
|
|
1669
1856
|
*/
|
|
1670
1857
|
Name: string | undefined;
|
|
@@ -1679,22 +1866,26 @@ export interface GetDataCatalogInput {
|
|
|
1679
1866
|
*/
|
|
1680
1867
|
export interface DataCatalog {
|
|
1681
1868
|
/**
|
|
1869
|
+
* @public
|
|
1682
1870
|
* <p>The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,
|
|
1683
1871
|
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
1684
1872
|
* by Athena.</p>
|
|
1685
1873
|
*/
|
|
1686
1874
|
Name: string | undefined;
|
|
1687
1875
|
/**
|
|
1876
|
+
* @public
|
|
1688
1877
|
* <p>An optional description of the data catalog.</p>
|
|
1689
1878
|
*/
|
|
1690
1879
|
Description?: string;
|
|
1691
1880
|
/**
|
|
1881
|
+
* @public
|
|
1692
1882
|
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
1693
1883
|
* <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
|
|
1694
1884
|
* Glue Data Catalog.</p>
|
|
1695
1885
|
*/
|
|
1696
1886
|
Type: DataCatalogType | string | undefined;
|
|
1697
1887
|
/**
|
|
1888
|
+
* @public
|
|
1698
1889
|
* <p>Specifies the Lambda function or functions to use for the data catalog.
|
|
1699
1890
|
* This is a mapping whose values depend on the catalog type. </p>
|
|
1700
1891
|
* <ul>
|
|
@@ -1766,6 +1957,7 @@ export interface DataCatalog {
|
|
|
1766
1957
|
*/
|
|
1767
1958
|
export interface GetDataCatalogOutput {
|
|
1768
1959
|
/**
|
|
1960
|
+
* @public
|
|
1769
1961
|
* <p>The data catalog returned.</p>
|
|
1770
1962
|
*/
|
|
1771
1963
|
DataCatalog?: DataCatalog;
|
|
@@ -1775,6 +1967,7 @@ export interface GetDataCatalogOutput {
|
|
|
1775
1967
|
*/
|
|
1776
1968
|
export interface GetNamedQueryInput {
|
|
1777
1969
|
/**
|
|
1970
|
+
* @public
|
|
1778
1971
|
* <p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query
|
|
1779
1972
|
* IDs.</p>
|
|
1780
1973
|
*/
|
|
@@ -1785,6 +1978,7 @@ export interface GetNamedQueryInput {
|
|
|
1785
1978
|
*/
|
|
1786
1979
|
export interface GetNamedQueryOutput {
|
|
1787
1980
|
/**
|
|
1981
|
+
* @public
|
|
1788
1982
|
* <p>Information about the query.</p>
|
|
1789
1983
|
*/
|
|
1790
1984
|
NamedQuery?: NamedQuery;
|
|
@@ -1794,6 +1988,7 @@ export interface GetNamedQueryOutput {
|
|
|
1794
1988
|
*/
|
|
1795
1989
|
export interface GetNotebookMetadataInput {
|
|
1796
1990
|
/**
|
|
1991
|
+
* @public
|
|
1797
1992
|
* <p>The ID of the notebook whose metadata is to be retrieved.</p>
|
|
1798
1993
|
*/
|
|
1799
1994
|
NotebookId: string | undefined;
|
|
@@ -1803,6 +1998,7 @@ export interface GetNotebookMetadataInput {
|
|
|
1803
1998
|
*/
|
|
1804
1999
|
export interface GetNotebookMetadataOutput {
|
|
1805
2000
|
/**
|
|
2001
|
+
* @public
|
|
1806
2002
|
* <p>The metadata that is returned for the specified notebook ID.</p>
|
|
1807
2003
|
*/
|
|
1808
2004
|
NotebookMetadata?: NotebookMetadata;
|
|
@@ -1812,10 +2008,12 @@ export interface GetNotebookMetadataOutput {
|
|
|
1812
2008
|
*/
|
|
1813
2009
|
export interface GetPreparedStatementInput {
|
|
1814
2010
|
/**
|
|
2011
|
+
* @public
|
|
1815
2012
|
* <p>The name of the prepared statement to retrieve.</p>
|
|
1816
2013
|
*/
|
|
1817
2014
|
StatementName: string | undefined;
|
|
1818
2015
|
/**
|
|
2016
|
+
* @public
|
|
1819
2017
|
* <p>The workgroup to which the statement to be retrieved belongs.</p>
|
|
1820
2018
|
*/
|
|
1821
2019
|
WorkGroup: string | undefined;
|
|
@@ -1825,6 +2023,7 @@ export interface GetPreparedStatementInput {
|
|
|
1825
2023
|
*/
|
|
1826
2024
|
export interface GetPreparedStatementOutput {
|
|
1827
2025
|
/**
|
|
2026
|
+
* @public
|
|
1828
2027
|
* <p>The name of the prepared statement that was retrieved.</p>
|
|
1829
2028
|
*/
|
|
1830
2029
|
PreparedStatement?: PreparedStatement;
|
|
@@ -1834,6 +2033,7 @@ export interface GetPreparedStatementOutput {
|
|
|
1834
2033
|
*/
|
|
1835
2034
|
export interface GetQueryExecutionInput {
|
|
1836
2035
|
/**
|
|
2036
|
+
* @public
|
|
1837
2037
|
* <p>The unique ID of the query execution.</p>
|
|
1838
2038
|
*/
|
|
1839
2039
|
QueryExecutionId: string | undefined;
|
|
@@ -1843,6 +2043,7 @@ export interface GetQueryExecutionInput {
|
|
|
1843
2043
|
*/
|
|
1844
2044
|
export interface GetQueryExecutionOutput {
|
|
1845
2045
|
/**
|
|
2046
|
+
* @public
|
|
1846
2047
|
* <p>Information about the query execution.</p>
|
|
1847
2048
|
*/
|
|
1848
2049
|
QueryExecution?: QueryExecution;
|
|
@@ -1852,16 +2053,19 @@ export interface GetQueryExecutionOutput {
|
|
|
1852
2053
|
*/
|
|
1853
2054
|
export interface GetQueryResultsInput {
|
|
1854
2055
|
/**
|
|
2056
|
+
* @public
|
|
1855
2057
|
* <p>The unique ID of the query execution.</p>
|
|
1856
2058
|
*/
|
|
1857
2059
|
QueryExecutionId: string | undefined;
|
|
1858
2060
|
/**
|
|
2061
|
+
* @public
|
|
1859
2062
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
1860
2063
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
1861
2064
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
1862
2065
|
*/
|
|
1863
2066
|
NextToken?: string;
|
|
1864
2067
|
/**
|
|
2068
|
+
* @public
|
|
1865
2069
|
* <p>The maximum number of results (rows) to return in this request.</p>
|
|
1866
2070
|
*/
|
|
1867
2071
|
MaxResults?: number;
|
|
@@ -1885,44 +2089,54 @@ export type ColumnNullable = (typeof ColumnNullable)[keyof typeof ColumnNullable
|
|
|
1885
2089
|
*/
|
|
1886
2090
|
export interface ColumnInfo {
|
|
1887
2091
|
/**
|
|
2092
|
+
* @public
|
|
1888
2093
|
* <p>The catalog to which the query results belong.</p>
|
|
1889
2094
|
*/
|
|
1890
2095
|
CatalogName?: string;
|
|
1891
2096
|
/**
|
|
2097
|
+
* @public
|
|
1892
2098
|
* <p>The schema name (database name) to which the query results belong.</p>
|
|
1893
2099
|
*/
|
|
1894
2100
|
SchemaName?: string;
|
|
1895
2101
|
/**
|
|
2102
|
+
* @public
|
|
1896
2103
|
* <p>The table name for the query results.</p>
|
|
1897
2104
|
*/
|
|
1898
2105
|
TableName?: string;
|
|
1899
2106
|
/**
|
|
2107
|
+
* @public
|
|
1900
2108
|
* <p>The name of the column.</p>
|
|
1901
2109
|
*/
|
|
1902
2110
|
Name: string | undefined;
|
|
1903
2111
|
/**
|
|
2112
|
+
* @public
|
|
1904
2113
|
* <p>A column label.</p>
|
|
1905
2114
|
*/
|
|
1906
2115
|
Label?: string;
|
|
1907
2116
|
/**
|
|
2117
|
+
* @public
|
|
1908
2118
|
* <p>The data type of the column.</p>
|
|
1909
2119
|
*/
|
|
1910
2120
|
Type: string | undefined;
|
|
1911
2121
|
/**
|
|
2122
|
+
* @public
|
|
1912
2123
|
* <p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38.
|
|
1913
2124
|
* For performance reasons, we recommend up to 18 digits.</p>
|
|
1914
2125
|
*/
|
|
1915
2126
|
Precision?: number;
|
|
1916
2127
|
/**
|
|
2128
|
+
* @public
|
|
1917
2129
|
* <p>For <code>DECIMAL</code> data types, specifies the total number of digits in the
|
|
1918
2130
|
* fractional part of the value. Defaults to 0.</p>
|
|
1919
2131
|
*/
|
|
1920
2132
|
Scale?: number;
|
|
1921
2133
|
/**
|
|
2134
|
+
* @public
|
|
1922
2135
|
* <p>Indicates the column's nullable status.</p>
|
|
1923
2136
|
*/
|
|
1924
2137
|
Nullable?: ColumnNullable | string;
|
|
1925
2138
|
/**
|
|
2139
|
+
* @public
|
|
1926
2140
|
* <p>Indicates whether values in the column are case-sensitive.</p>
|
|
1927
2141
|
*/
|
|
1928
2142
|
CaseSensitive?: boolean;
|
|
@@ -1934,6 +2148,7 @@ export interface ColumnInfo {
|
|
|
1934
2148
|
*/
|
|
1935
2149
|
export interface ResultSetMetadata {
|
|
1936
2150
|
/**
|
|
2151
|
+
* @public
|
|
1937
2152
|
* <p>Information about the columns returned in a query result metadata.</p>
|
|
1938
2153
|
*/
|
|
1939
2154
|
ColumnInfo?: ColumnInfo[];
|
|
@@ -1944,6 +2159,7 @@ export interface ResultSetMetadata {
|
|
|
1944
2159
|
*/
|
|
1945
2160
|
export interface Datum {
|
|
1946
2161
|
/**
|
|
2162
|
+
* @public
|
|
1947
2163
|
* <p>The value of the datum.</p>
|
|
1948
2164
|
*/
|
|
1949
2165
|
VarCharValue?: string;
|
|
@@ -1954,6 +2170,7 @@ export interface Datum {
|
|
|
1954
2170
|
*/
|
|
1955
2171
|
export interface Row {
|
|
1956
2172
|
/**
|
|
2173
|
+
* @public
|
|
1957
2174
|
* <p>The data that populates a row in a query result table.</p>
|
|
1958
2175
|
*/
|
|
1959
2176
|
Data?: Datum[];
|
|
@@ -1965,10 +2182,12 @@ export interface Row {
|
|
|
1965
2182
|
*/
|
|
1966
2183
|
export interface ResultSet {
|
|
1967
2184
|
/**
|
|
2185
|
+
* @public
|
|
1968
2186
|
* <p>The rows in the table.</p>
|
|
1969
2187
|
*/
|
|
1970
2188
|
Rows?: Row[];
|
|
1971
2189
|
/**
|
|
2190
|
+
* @public
|
|
1972
2191
|
* <p>The metadata that describes the column structure and data types of a table of query
|
|
1973
2192
|
* results.</p>
|
|
1974
2193
|
*/
|
|
@@ -1979,15 +2198,18 @@ export interface ResultSet {
|
|
|
1979
2198
|
*/
|
|
1980
2199
|
export interface GetQueryResultsOutput {
|
|
1981
2200
|
/**
|
|
2201
|
+
* @public
|
|
1982
2202
|
* <p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement.
|
|
1983
2203
|
* </p>
|
|
1984
2204
|
*/
|
|
1985
2205
|
UpdateCount?: number;
|
|
1986
2206
|
/**
|
|
2207
|
+
* @public
|
|
1987
2208
|
* <p>The results of the query execution.</p>
|
|
1988
2209
|
*/
|
|
1989
2210
|
ResultSet?: ResultSet;
|
|
1990
2211
|
/**
|
|
2212
|
+
* @public
|
|
1991
2213
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
1992
2214
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
1993
2215
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -1999,6 +2221,7 @@ export interface GetQueryResultsOutput {
|
|
|
1999
2221
|
*/
|
|
2000
2222
|
export interface GetQueryRuntimeStatisticsInput {
|
|
2001
2223
|
/**
|
|
2224
|
+
* @public
|
|
2002
2225
|
* <p>The unique ID of the query execution.</p>
|
|
2003
2226
|
*/
|
|
2004
2227
|
QueryExecutionId: string | undefined;
|
|
@@ -2010,18 +2233,22 @@ export interface GetQueryRuntimeStatisticsInput {
|
|
|
2010
2233
|
*/
|
|
2011
2234
|
export interface QueryRuntimeStatisticsRows {
|
|
2012
2235
|
/**
|
|
2236
|
+
* @public
|
|
2013
2237
|
* <p>The number of rows read to execute the query.</p>
|
|
2014
2238
|
*/
|
|
2015
2239
|
InputRows?: number;
|
|
2016
2240
|
/**
|
|
2241
|
+
* @public
|
|
2017
2242
|
* <p>The number of bytes read to execute the query.</p>
|
|
2018
2243
|
*/
|
|
2019
2244
|
InputBytes?: number;
|
|
2020
2245
|
/**
|
|
2246
|
+
* @public
|
|
2021
2247
|
* <p>The number of bytes returned by the query.</p>
|
|
2022
2248
|
*/
|
|
2023
2249
|
OutputBytes?: number;
|
|
2024
2250
|
/**
|
|
2251
|
+
* @public
|
|
2025
2252
|
* <p>The number of rows returned by the query.</p>
|
|
2026
2253
|
*/
|
|
2027
2254
|
OutputRows?: number;
|
|
@@ -2033,12 +2260,14 @@ export interface QueryRuntimeStatisticsRows {
|
|
|
2033
2260
|
*/
|
|
2034
2261
|
export interface QueryRuntimeStatisticsTimeline {
|
|
2035
2262
|
/**
|
|
2263
|
+
* @public
|
|
2036
2264
|
* <p>The number of milliseconds that the query was in your query queue waiting for
|
|
2037
2265
|
* resources. Note that if transient errors occur, Athena might automatically
|
|
2038
2266
|
* add the query back to the queue.</p>
|
|
2039
2267
|
*/
|
|
2040
2268
|
QueryQueueTimeInMillis?: number;
|
|
2041
2269
|
/**
|
|
2270
|
+
* @public
|
|
2042
2271
|
* <p>The number of milliseconds that Athena took to plan the query processing
|
|
2043
2272
|
* flow. This includes the time spent retrieving table partitions from the data source.
|
|
2044
2273
|
* Note that because the query engine performs the query planning, query planning time is a
|
|
@@ -2046,15 +2275,18 @@ export interface QueryRuntimeStatisticsTimeline {
|
|
|
2046
2275
|
*/
|
|
2047
2276
|
QueryPlanningTimeInMillis?: number;
|
|
2048
2277
|
/**
|
|
2278
|
+
* @public
|
|
2049
2279
|
* <p>The number of milliseconds that the query took to execute.</p>
|
|
2050
2280
|
*/
|
|
2051
2281
|
EngineExecutionTimeInMillis?: number;
|
|
2052
2282
|
/**
|
|
2283
|
+
* @public
|
|
2053
2284
|
* <p>The number of milliseconds that Athena took to finalize and publish the
|
|
2054
2285
|
* query results after the query engine finished running the query.</p>
|
|
2055
2286
|
*/
|
|
2056
2287
|
ServiceProcessingTimeInMillis?: number;
|
|
2057
2288
|
/**
|
|
2289
|
+
* @public
|
|
2058
2290
|
* <p>The number of milliseconds that Athena took to run the query.</p>
|
|
2059
2291
|
*/
|
|
2060
2292
|
TotalExecutionTimeInMillis?: number;
|
|
@@ -2064,6 +2296,7 @@ export interface QueryRuntimeStatisticsTimeline {
|
|
|
2064
2296
|
*/
|
|
2065
2297
|
export interface GetSessionRequest {
|
|
2066
2298
|
/**
|
|
2299
|
+
* @public
|
|
2067
2300
|
* <p>The session ID.</p>
|
|
2068
2301
|
*/
|
|
2069
2302
|
SessionId: string | undefined;
|
|
@@ -2075,21 +2308,25 @@ export interface GetSessionRequest {
|
|
|
2075
2308
|
*/
|
|
2076
2309
|
export interface EngineConfiguration {
|
|
2077
2310
|
/**
|
|
2311
|
+
* @public
|
|
2078
2312
|
* <p>The number of DPUs to use for the coordinator. A coordinator is a special executor
|
|
2079
2313
|
* that orchestrates processing work and manages other executors in a notebook
|
|
2080
2314
|
* session. The default is 1.</p>
|
|
2081
2315
|
*/
|
|
2082
2316
|
CoordinatorDpuSize?: number;
|
|
2083
2317
|
/**
|
|
2318
|
+
* @public
|
|
2084
2319
|
* <p>The maximum number of DPUs that can run concurrently.</p>
|
|
2085
2320
|
*/
|
|
2086
2321
|
MaxConcurrentDpus: number | undefined;
|
|
2087
2322
|
/**
|
|
2323
|
+
* @public
|
|
2088
2324
|
* <p>The default number of DPUs to use for executors. An executor is the smallest unit of
|
|
2089
2325
|
* compute that a notebook session can request from Athena. The default is 1.</p>
|
|
2090
2326
|
*/
|
|
2091
2327
|
DefaultExecutorDpuSize?: number;
|
|
2092
2328
|
/**
|
|
2329
|
+
* @public
|
|
2093
2330
|
* <p>Contains additional notebook engine <code>MAP<string, string></code> parameter
|
|
2094
2331
|
* mappings in the form of key-value pairs. To specify an Athena notebook that
|
|
2095
2332
|
* the Jupyter server will download and serve, specify a value for the <a>StartSessionRequest$NotebookVersion</a> field, and then add a key named
|
|
@@ -2098,6 +2335,7 @@ export interface EngineConfiguration {
|
|
|
2098
2335
|
*/
|
|
2099
2336
|
AdditionalConfigs?: Record<string, string>;
|
|
2100
2337
|
/**
|
|
2338
|
+
* @public
|
|
2101
2339
|
* <p>Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.</p>
|
|
2102
2340
|
*/
|
|
2103
2341
|
SparkProperties?: Record<string, string>;
|
|
@@ -2108,18 +2346,22 @@ export interface EngineConfiguration {
|
|
|
2108
2346
|
*/
|
|
2109
2347
|
export interface SessionConfiguration {
|
|
2110
2348
|
/**
|
|
2349
|
+
* @public
|
|
2111
2350
|
* <p>The ARN of the execution role used for the session.</p>
|
|
2112
2351
|
*/
|
|
2113
2352
|
ExecutionRole?: string;
|
|
2114
2353
|
/**
|
|
2354
|
+
* @public
|
|
2115
2355
|
* <p>The Amazon S3 location that stores information for the notebook.</p>
|
|
2116
2356
|
*/
|
|
2117
2357
|
WorkingDirectory?: string;
|
|
2118
2358
|
/**
|
|
2359
|
+
* @public
|
|
2119
2360
|
* <p>The idle timeout in seconds for the session.</p>
|
|
2120
2361
|
*/
|
|
2121
2362
|
IdleTimeoutSeconds?: number;
|
|
2122
2363
|
/**
|
|
2364
|
+
* @public
|
|
2123
2365
|
* <p>If query and calculation results are encrypted in Amazon S3, indicates the encryption option
|
|
2124
2366
|
* used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key
|
|
2125
2367
|
* information.</p>
|
|
@@ -2132,6 +2374,7 @@ export interface SessionConfiguration {
|
|
|
2132
2374
|
*/
|
|
2133
2375
|
export interface SessionStatistics {
|
|
2134
2376
|
/**
|
|
2377
|
+
* @public
|
|
2135
2378
|
* <p>The data processing unit execution time for a session in milliseconds.</p>
|
|
2136
2379
|
*/
|
|
2137
2380
|
DpuExecutionInMillis?: number;
|
|
@@ -2160,23 +2403,28 @@ export type SessionState = (typeof SessionState)[keyof typeof SessionState];
|
|
|
2160
2403
|
*/
|
|
2161
2404
|
export interface SessionStatus {
|
|
2162
2405
|
/**
|
|
2406
|
+
* @public
|
|
2163
2407
|
* <p>The date and time that the session started.</p>
|
|
2164
2408
|
*/
|
|
2165
2409
|
StartDateTime?: Date;
|
|
2166
2410
|
/**
|
|
2411
|
+
* @public
|
|
2167
2412
|
* <p>The most recent date and time that the session was modified.</p>
|
|
2168
2413
|
*/
|
|
2169
2414
|
LastModifiedDateTime?: Date;
|
|
2170
2415
|
/**
|
|
2416
|
+
* @public
|
|
2171
2417
|
* <p>The date and time that the session ended.</p>
|
|
2172
2418
|
*/
|
|
2173
2419
|
EndDateTime?: Date;
|
|
2174
2420
|
/**
|
|
2421
|
+
* @public
|
|
2175
2422
|
* <p>The date and time starting at which the session became idle. Can be empty if the
|
|
2176
2423
|
* session is not currently idle.</p>
|
|
2177
2424
|
*/
|
|
2178
2425
|
IdleSinceDateTime?: Date;
|
|
2179
2426
|
/**
|
|
2427
|
+
* @public
|
|
2180
2428
|
* <p>The state of the session. A description of each state follows.</p>
|
|
2181
2429
|
* <p>
|
|
2182
2430
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -2200,6 +2448,7 @@ export interface SessionStatus {
|
|
|
2200
2448
|
*/
|
|
2201
2449
|
State?: SessionState | string;
|
|
2202
2450
|
/**
|
|
2451
|
+
* @public
|
|
2203
2452
|
* <p>The reason for the session state change (for example, canceled because the session was
|
|
2204
2453
|
* terminated).</p>
|
|
2205
2454
|
*/
|
|
@@ -2210,39 +2459,48 @@ export interface SessionStatus {
|
|
|
2210
2459
|
*/
|
|
2211
2460
|
export interface GetSessionResponse {
|
|
2212
2461
|
/**
|
|
2462
|
+
* @public
|
|
2213
2463
|
* <p>The session ID.</p>
|
|
2214
2464
|
*/
|
|
2215
2465
|
SessionId?: string;
|
|
2216
2466
|
/**
|
|
2467
|
+
* @public
|
|
2217
2468
|
* <p>The session description.</p>
|
|
2218
2469
|
*/
|
|
2219
2470
|
Description?: string;
|
|
2220
2471
|
/**
|
|
2472
|
+
* @public
|
|
2221
2473
|
* <p>The workgroup to which the session belongs.</p>
|
|
2222
2474
|
*/
|
|
2223
2475
|
WorkGroup?: string;
|
|
2224
2476
|
/**
|
|
2477
|
+
* @public
|
|
2225
2478
|
* <p>The engine version used by the session (for example, <code>PySpark engine version
|
|
2226
2479
|
* 3</code>). You can get a list of engine versions by calling <a>ListEngineVersions</a>.</p>
|
|
2227
2480
|
*/
|
|
2228
2481
|
EngineVersion?: string;
|
|
2229
2482
|
/**
|
|
2483
|
+
* @public
|
|
2230
2484
|
* <p>Contains engine configuration information like DPU usage.</p>
|
|
2231
2485
|
*/
|
|
2232
2486
|
EngineConfiguration?: EngineConfiguration;
|
|
2233
2487
|
/**
|
|
2488
|
+
* @public
|
|
2234
2489
|
* <p>The notebook version.</p>
|
|
2235
2490
|
*/
|
|
2236
2491
|
NotebookVersion?: string;
|
|
2237
2492
|
/**
|
|
2493
|
+
* @public
|
|
2238
2494
|
* <p>Contains the workgroup configuration information used by the session.</p>
|
|
2239
2495
|
*/
|
|
2240
2496
|
SessionConfiguration?: SessionConfiguration;
|
|
2241
2497
|
/**
|
|
2498
|
+
* @public
|
|
2242
2499
|
* <p>Contains information about the status of the session.</p>
|
|
2243
2500
|
*/
|
|
2244
2501
|
Status?: SessionStatus;
|
|
2245
2502
|
/**
|
|
2503
|
+
* @public
|
|
2246
2504
|
* <p>Contains the DPU execution time.</p>
|
|
2247
2505
|
*/
|
|
2248
2506
|
Statistics?: SessionStatistics;
|
|
@@ -2252,6 +2510,7 @@ export interface GetSessionResponse {
|
|
|
2252
2510
|
*/
|
|
2253
2511
|
export interface GetSessionStatusRequest {
|
|
2254
2512
|
/**
|
|
2513
|
+
* @public
|
|
2255
2514
|
* <p>The session ID.</p>
|
|
2256
2515
|
*/
|
|
2257
2516
|
SessionId: string | undefined;
|
|
@@ -2261,10 +2520,12 @@ export interface GetSessionStatusRequest {
|
|
|
2261
2520
|
*/
|
|
2262
2521
|
export interface GetSessionStatusResponse {
|
|
2263
2522
|
/**
|
|
2523
|
+
* @public
|
|
2264
2524
|
* <p>The session ID.</p>
|
|
2265
2525
|
*/
|
|
2266
2526
|
SessionId?: string;
|
|
2267
2527
|
/**
|
|
2528
|
+
* @public
|
|
2268
2529
|
* <p>Contains information about the status of the session.</p>
|
|
2269
2530
|
*/
|
|
2270
2531
|
Status?: SessionStatus;
|
|
@@ -2274,15 +2535,18 @@ export interface GetSessionStatusResponse {
|
|
|
2274
2535
|
*/
|
|
2275
2536
|
export interface GetTableMetadataInput {
|
|
2276
2537
|
/**
|
|
2538
|
+
* @public
|
|
2277
2539
|
* <p>The name of the data catalog that contains the database and table metadata to
|
|
2278
2540
|
* return.</p>
|
|
2279
2541
|
*/
|
|
2280
2542
|
CatalogName: string | undefined;
|
|
2281
2543
|
/**
|
|
2544
|
+
* @public
|
|
2282
2545
|
* <p>The name of the database that contains the table metadata to return.</p>
|
|
2283
2546
|
*/
|
|
2284
2547
|
DatabaseName: string | undefined;
|
|
2285
2548
|
/**
|
|
2549
|
+
* @public
|
|
2286
2550
|
* <p>The name of the table for which metadata is returned.</p>
|
|
2287
2551
|
*/
|
|
2288
2552
|
TableName: string | undefined;
|
|
@@ -2293,14 +2557,17 @@ export interface GetTableMetadataInput {
|
|
|
2293
2557
|
*/
|
|
2294
2558
|
export interface Column {
|
|
2295
2559
|
/**
|
|
2560
|
+
* @public
|
|
2296
2561
|
* <p>The name of the column.</p>
|
|
2297
2562
|
*/
|
|
2298
2563
|
Name: string | undefined;
|
|
2299
2564
|
/**
|
|
2565
|
+
* @public
|
|
2300
2566
|
* <p>The data type of the column.</p>
|
|
2301
2567
|
*/
|
|
2302
2568
|
Type?: string;
|
|
2303
2569
|
/**
|
|
2570
|
+
* @public
|
|
2304
2571
|
* <p>Optional information about the column.</p>
|
|
2305
2572
|
*/
|
|
2306
2573
|
Comment?: string;
|
|
@@ -2311,31 +2578,38 @@ export interface Column {
|
|
|
2311
2578
|
*/
|
|
2312
2579
|
export interface TableMetadata {
|
|
2313
2580
|
/**
|
|
2581
|
+
* @public
|
|
2314
2582
|
* <p>The name of the table.</p>
|
|
2315
2583
|
*/
|
|
2316
2584
|
Name: string | undefined;
|
|
2317
2585
|
/**
|
|
2586
|
+
* @public
|
|
2318
2587
|
* <p>The time that the table was created.</p>
|
|
2319
2588
|
*/
|
|
2320
2589
|
CreateTime?: Date;
|
|
2321
2590
|
/**
|
|
2591
|
+
* @public
|
|
2322
2592
|
* <p>The last time the table was accessed.</p>
|
|
2323
2593
|
*/
|
|
2324
2594
|
LastAccessTime?: Date;
|
|
2325
2595
|
/**
|
|
2596
|
+
* @public
|
|
2326
2597
|
* <p>The type of table. In Athena, only <code>EXTERNAL_TABLE</code> is
|
|
2327
2598
|
* supported.</p>
|
|
2328
2599
|
*/
|
|
2329
2600
|
TableType?: string;
|
|
2330
2601
|
/**
|
|
2602
|
+
* @public
|
|
2331
2603
|
* <p>A list of the columns in the table.</p>
|
|
2332
2604
|
*/
|
|
2333
2605
|
Columns?: Column[];
|
|
2334
2606
|
/**
|
|
2607
|
+
* @public
|
|
2335
2608
|
* <p>A list of the partition keys in the table.</p>
|
|
2336
2609
|
*/
|
|
2337
2610
|
PartitionKeys?: Column[];
|
|
2338
2611
|
/**
|
|
2612
|
+
* @public
|
|
2339
2613
|
* <p>A set of custom key/value pairs for table properties.</p>
|
|
2340
2614
|
*/
|
|
2341
2615
|
Parameters?: Record<string, string>;
|
|
@@ -2345,6 +2619,7 @@ export interface TableMetadata {
|
|
|
2345
2619
|
*/
|
|
2346
2620
|
export interface GetTableMetadataOutput {
|
|
2347
2621
|
/**
|
|
2622
|
+
* @public
|
|
2348
2623
|
* <p>An object that contains table metadata.</p>
|
|
2349
2624
|
*/
|
|
2350
2625
|
TableMetadata?: TableMetadata;
|
|
@@ -2354,6 +2629,7 @@ export interface GetTableMetadataOutput {
|
|
|
2354
2629
|
*/
|
|
2355
2630
|
export interface GetWorkGroupInput {
|
|
2356
2631
|
/**
|
|
2632
|
+
* @public
|
|
2357
2633
|
* <p>The name of the workgroup.</p>
|
|
2358
2634
|
*/
|
|
2359
2635
|
WorkGroup: string | undefined;
|
|
@@ -2383,14 +2659,17 @@ export type WorkGroupState = (typeof WorkGroupState)[keyof typeof WorkGroupState
|
|
|
2383
2659
|
*/
|
|
2384
2660
|
export interface WorkGroup {
|
|
2385
2661
|
/**
|
|
2662
|
+
* @public
|
|
2386
2663
|
* <p>The workgroup name.</p>
|
|
2387
2664
|
*/
|
|
2388
2665
|
Name: string | undefined;
|
|
2389
2666
|
/**
|
|
2667
|
+
* @public
|
|
2390
2668
|
* <p>The state of the workgroup: ENABLED or DISABLED.</p>
|
|
2391
2669
|
*/
|
|
2392
2670
|
State?: WorkGroupState | string;
|
|
2393
2671
|
/**
|
|
2672
|
+
* @public
|
|
2394
2673
|
* <p>The configuration of the workgroup, which includes the location in Amazon S3
|
|
2395
2674
|
* where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup;
|
|
2396
2675
|
* whether workgroup settings override client-side settings; and the data usage limits for
|
|
@@ -2400,10 +2679,12 @@ export interface WorkGroup {
|
|
|
2400
2679
|
*/
|
|
2401
2680
|
Configuration?: WorkGroupConfiguration;
|
|
2402
2681
|
/**
|
|
2682
|
+
* @public
|
|
2403
2683
|
* <p>The workgroup description.</p>
|
|
2404
2684
|
*/
|
|
2405
2685
|
Description?: string;
|
|
2406
2686
|
/**
|
|
2687
|
+
* @public
|
|
2407
2688
|
* <p>The date and time the workgroup was created.</p>
|
|
2408
2689
|
*/
|
|
2409
2690
|
CreationTime?: Date;
|
|
@@ -2413,6 +2694,7 @@ export interface WorkGroup {
|
|
|
2413
2694
|
*/
|
|
2414
2695
|
export interface GetWorkGroupOutput {
|
|
2415
2696
|
/**
|
|
2697
|
+
* @public
|
|
2416
2698
|
* <p>Information about the workgroup.</p>
|
|
2417
2699
|
*/
|
|
2418
2700
|
WorkGroup?: WorkGroup;
|
|
@@ -2422,23 +2704,28 @@ export interface GetWorkGroupOutput {
|
|
|
2422
2704
|
*/
|
|
2423
2705
|
export interface ImportNotebookInput {
|
|
2424
2706
|
/**
|
|
2707
|
+
* @public
|
|
2425
2708
|
* <p>The name of the Spark enabled workgroup to import the notebook to.</p>
|
|
2426
2709
|
*/
|
|
2427
2710
|
WorkGroup: string | undefined;
|
|
2428
2711
|
/**
|
|
2712
|
+
* @public
|
|
2429
2713
|
* <p>The name of the notebook to import.</p>
|
|
2430
2714
|
*/
|
|
2431
2715
|
Name: string | undefined;
|
|
2432
2716
|
/**
|
|
2717
|
+
* @public
|
|
2433
2718
|
* <p>The notebook content to be imported.</p>
|
|
2434
2719
|
*/
|
|
2435
2720
|
Payload: string | undefined;
|
|
2436
2721
|
/**
|
|
2722
|
+
* @public
|
|
2437
2723
|
* <p>The notebook content type. Currently, the only valid type is
|
|
2438
2724
|
* <code>IPYNB</code>.</p>
|
|
2439
2725
|
*/
|
|
2440
2726
|
Type: NotebookType | string | undefined;
|
|
2441
2727
|
/**
|
|
2728
|
+
* @public
|
|
2442
2729
|
* <p>A unique case-sensitive string used to ensure the request to import the notebook is
|
|
2443
2730
|
* idempotent (executes only once).</p>
|
|
2444
2731
|
* <important>
|
|
@@ -2455,6 +2742,7 @@ export interface ImportNotebookInput {
|
|
|
2455
2742
|
*/
|
|
2456
2743
|
export interface ImportNotebookOutput {
|
|
2457
2744
|
/**
|
|
2745
|
+
* @public
|
|
2458
2746
|
* <p>The ID assigned to the imported notebook.</p>
|
|
2459
2747
|
*/
|
|
2460
2748
|
NotebookId?: string;
|
|
@@ -2464,10 +2752,12 @@ export interface ImportNotebookOutput {
|
|
|
2464
2752
|
*/
|
|
2465
2753
|
export interface ListApplicationDPUSizesInput {
|
|
2466
2754
|
/**
|
|
2755
|
+
* @public
|
|
2467
2756
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2468
2757
|
*/
|
|
2469
2758
|
MaxResults?: number;
|
|
2470
2759
|
/**
|
|
2760
|
+
* @public
|
|
2471
2761
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2472
2762
|
* pagination if a previous request was truncated.</p>
|
|
2473
2763
|
*/
|
|
@@ -2479,11 +2769,13 @@ export interface ListApplicationDPUSizesInput {
|
|
|
2479
2769
|
*/
|
|
2480
2770
|
export interface ApplicationDPUSizes {
|
|
2481
2771
|
/**
|
|
2772
|
+
* @public
|
|
2482
2773
|
* <p>The name of the supported application runtime (for example, <code>Athena notebook
|
|
2483
2774
|
* version 1</code>).</p>
|
|
2484
2775
|
*/
|
|
2485
2776
|
ApplicationRuntimeId?: string;
|
|
2486
2777
|
/**
|
|
2778
|
+
* @public
|
|
2487
2779
|
* <p>A list of the supported DPU sizes that the application runtime supports.</p>
|
|
2488
2780
|
*/
|
|
2489
2781
|
SupportedDPUSizes?: number[];
|
|
@@ -2493,10 +2785,12 @@ export interface ApplicationDPUSizes {
|
|
|
2493
2785
|
*/
|
|
2494
2786
|
export interface ListApplicationDPUSizesOutput {
|
|
2495
2787
|
/**
|
|
2788
|
+
* @public
|
|
2496
2789
|
* <p>A list of the supported DPU sizes that the application runtime supports.</p>
|
|
2497
2790
|
*/
|
|
2498
2791
|
ApplicationDPUSizes?: ApplicationDPUSizes[];
|
|
2499
2792
|
/**
|
|
2793
|
+
* @public
|
|
2500
2794
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2501
2795
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2502
2796
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2508,10 +2802,12 @@ export interface ListApplicationDPUSizesOutput {
|
|
|
2508
2802
|
*/
|
|
2509
2803
|
export interface ListCalculationExecutionsRequest {
|
|
2510
2804
|
/**
|
|
2805
|
+
* @public
|
|
2511
2806
|
* <p>The session ID.</p>
|
|
2512
2807
|
*/
|
|
2513
2808
|
SessionId: string | undefined;
|
|
2514
2809
|
/**
|
|
2810
|
+
* @public
|
|
2515
2811
|
* <p>A filter for a specific calculation execution state. A description of each state
|
|
2516
2812
|
* follows.</p>
|
|
2517
2813
|
* <p>
|
|
@@ -2535,10 +2831,12 @@ export interface ListCalculationExecutionsRequest {
|
|
|
2535
2831
|
*/
|
|
2536
2832
|
StateFilter?: CalculationExecutionState | string;
|
|
2537
2833
|
/**
|
|
2834
|
+
* @public
|
|
2538
2835
|
* <p>The maximum number of calculation executions to return.</p>
|
|
2539
2836
|
*/
|
|
2540
2837
|
MaxResults?: number;
|
|
2541
2838
|
/**
|
|
2839
|
+
* @public
|
|
2542
2840
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2543
2841
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2544
2842
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2551,14 +2849,17 @@ export interface ListCalculationExecutionsRequest {
|
|
|
2551
2849
|
*/
|
|
2552
2850
|
export interface CalculationSummary {
|
|
2553
2851
|
/**
|
|
2852
|
+
* @public
|
|
2554
2853
|
* <p>The calculation execution UUID.</p>
|
|
2555
2854
|
*/
|
|
2556
2855
|
CalculationExecutionId?: string;
|
|
2557
2856
|
/**
|
|
2857
|
+
* @public
|
|
2558
2858
|
* <p>A description of the calculation.</p>
|
|
2559
2859
|
*/
|
|
2560
2860
|
Description?: string;
|
|
2561
2861
|
/**
|
|
2862
|
+
* @public
|
|
2562
2863
|
* <p>Contains information about the status of the calculation.</p>
|
|
2563
2864
|
*/
|
|
2564
2865
|
Status?: CalculationStatus;
|
|
@@ -2568,12 +2869,14 @@ export interface CalculationSummary {
|
|
|
2568
2869
|
*/
|
|
2569
2870
|
export interface ListCalculationExecutionsResponse {
|
|
2570
2871
|
/**
|
|
2872
|
+
* @public
|
|
2571
2873
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2572
2874
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2573
2875
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2574
2876
|
*/
|
|
2575
2877
|
NextToken?: string;
|
|
2576
2878
|
/**
|
|
2879
|
+
* @public
|
|
2577
2880
|
* <p>A list of <a>CalculationSummary</a> objects.</p>
|
|
2578
2881
|
*/
|
|
2579
2882
|
Calculations?: CalculationSummary[];
|
|
@@ -2583,11 +2886,13 @@ export interface ListCalculationExecutionsResponse {
|
|
|
2583
2886
|
*/
|
|
2584
2887
|
export interface ListCapacityReservationsInput {
|
|
2585
2888
|
/**
|
|
2889
|
+
* @public
|
|
2586
2890
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2587
2891
|
* pagination if a previous request was truncated.</p>
|
|
2588
2892
|
*/
|
|
2589
2893
|
NextToken?: string;
|
|
2590
2894
|
/**
|
|
2895
|
+
* @public
|
|
2591
2896
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2592
2897
|
*/
|
|
2593
2898
|
MaxResults?: number;
|
|
@@ -2597,12 +2902,14 @@ export interface ListCapacityReservationsInput {
|
|
|
2597
2902
|
*/
|
|
2598
2903
|
export interface ListCapacityReservationsOutput {
|
|
2599
2904
|
/**
|
|
2905
|
+
* @public
|
|
2600
2906
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2601
2907
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2602
2908
|
* the NextToken from the response object of the previous page call.</p>
|
|
2603
2909
|
*/
|
|
2604
2910
|
NextToken?: string;
|
|
2605
2911
|
/**
|
|
2912
|
+
* @public
|
|
2606
2913
|
* <p>The capacity reservations for the current account.</p>
|
|
2607
2914
|
*/
|
|
2608
2915
|
CapacityReservations: CapacityReservation[] | undefined;
|
|
@@ -2612,16 +2919,19 @@ export interface ListCapacityReservationsOutput {
|
|
|
2612
2919
|
*/
|
|
2613
2920
|
export interface ListDatabasesInput {
|
|
2614
2921
|
/**
|
|
2922
|
+
* @public
|
|
2615
2923
|
* <p>The name of the data catalog that contains the databases to return.</p>
|
|
2616
2924
|
*/
|
|
2617
2925
|
CatalogName: string | undefined;
|
|
2618
2926
|
/**
|
|
2927
|
+
* @public
|
|
2619
2928
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2620
2929
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2621
2930
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2622
2931
|
*/
|
|
2623
2932
|
NextToken?: string;
|
|
2624
2933
|
/**
|
|
2934
|
+
* @public
|
|
2625
2935
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2626
2936
|
*/
|
|
2627
2937
|
MaxResults?: number;
|
|
@@ -2631,10 +2941,12 @@ export interface ListDatabasesInput {
|
|
|
2631
2941
|
*/
|
|
2632
2942
|
export interface ListDatabasesOutput {
|
|
2633
2943
|
/**
|
|
2944
|
+
* @public
|
|
2634
2945
|
* <p>A list of databases from a data catalog.</p>
|
|
2635
2946
|
*/
|
|
2636
2947
|
DatabaseList?: Database[];
|
|
2637
2948
|
/**
|
|
2949
|
+
* @public
|
|
2638
2950
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2639
2951
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2640
2952
|
* the NextToken from the response object of the previous page call.</p>
|
|
@@ -2646,12 +2958,14 @@ export interface ListDatabasesOutput {
|
|
|
2646
2958
|
*/
|
|
2647
2959
|
export interface ListDataCatalogsInput {
|
|
2648
2960
|
/**
|
|
2961
|
+
* @public
|
|
2649
2962
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2650
2963
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2651
2964
|
* the NextToken from the response object of the previous page call.</p>
|
|
2652
2965
|
*/
|
|
2653
2966
|
NextToken?: string;
|
|
2654
2967
|
/**
|
|
2968
|
+
* @public
|
|
2655
2969
|
* <p>Specifies the maximum number of data catalogs to return.</p>
|
|
2656
2970
|
*/
|
|
2657
2971
|
MaxResults?: number;
|
|
@@ -2662,12 +2976,14 @@ export interface ListDataCatalogsInput {
|
|
|
2662
2976
|
*/
|
|
2663
2977
|
export interface DataCatalogSummary {
|
|
2664
2978
|
/**
|
|
2979
|
+
* @public
|
|
2665
2980
|
* <p>The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,
|
|
2666
2981
|
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
2667
2982
|
* by Athena.</p>
|
|
2668
2983
|
*/
|
|
2669
2984
|
CatalogName?: string;
|
|
2670
2985
|
/**
|
|
2986
|
+
* @public
|
|
2671
2987
|
* <p>The data catalog type.</p>
|
|
2672
2988
|
*/
|
|
2673
2989
|
Type?: DataCatalogType | string;
|
|
@@ -2677,10 +2993,12 @@ export interface DataCatalogSummary {
|
|
|
2677
2993
|
*/
|
|
2678
2994
|
export interface ListDataCatalogsOutput {
|
|
2679
2995
|
/**
|
|
2996
|
+
* @public
|
|
2680
2997
|
* <p>A summary list of data catalogs.</p>
|
|
2681
2998
|
*/
|
|
2682
2999
|
DataCatalogsSummary?: DataCatalogSummary[];
|
|
2683
3000
|
/**
|
|
3001
|
+
* @public
|
|
2684
3002
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2685
3003
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2686
3004
|
* the NextToken from the response object of the previous page call.</p>
|
|
@@ -2692,12 +3010,14 @@ export interface ListDataCatalogsOutput {
|
|
|
2692
3010
|
*/
|
|
2693
3011
|
export interface ListEngineVersionsInput {
|
|
2694
3012
|
/**
|
|
3013
|
+
* @public
|
|
2695
3014
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2696
3015
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2697
3016
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2698
3017
|
*/
|
|
2699
3018
|
NextToken?: string;
|
|
2700
3019
|
/**
|
|
3020
|
+
* @public
|
|
2701
3021
|
* <p>The maximum number of engine versions to return in this request.</p>
|
|
2702
3022
|
*/
|
|
2703
3023
|
MaxResults?: number;
|
|
@@ -2707,10 +3027,12 @@ export interface ListEngineVersionsInput {
|
|
|
2707
3027
|
*/
|
|
2708
3028
|
export interface ListEngineVersionsOutput {
|
|
2709
3029
|
/**
|
|
3030
|
+
* @public
|
|
2710
3031
|
* <p>A list of engine versions that are available to choose from.</p>
|
|
2711
3032
|
*/
|
|
2712
3033
|
EngineVersions?: EngineVersion[];
|
|
2713
3034
|
/**
|
|
3035
|
+
* @public
|
|
2714
3036
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2715
3037
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2716
3038
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2738,10 +3060,12 @@ export type ExecutorState = (typeof ExecutorState)[keyof typeof ExecutorState];
|
|
|
2738
3060
|
*/
|
|
2739
3061
|
export interface ListExecutorsRequest {
|
|
2740
3062
|
/**
|
|
3063
|
+
* @public
|
|
2741
3064
|
* <p>The session ID.</p>
|
|
2742
3065
|
*/
|
|
2743
3066
|
SessionId: string | undefined;
|
|
2744
3067
|
/**
|
|
3068
|
+
* @public
|
|
2745
3069
|
* <p>A filter for a specific executor state. A description of each state follows.</p>
|
|
2746
3070
|
* <p>
|
|
2747
3071
|
* <code>CREATING</code> - The executor is being started, including acquiring
|
|
@@ -2759,10 +3083,12 @@ export interface ListExecutorsRequest {
|
|
|
2759
3083
|
*/
|
|
2760
3084
|
ExecutorStateFilter?: ExecutorState | string;
|
|
2761
3085
|
/**
|
|
3086
|
+
* @public
|
|
2762
3087
|
* <p>The maximum number of executors to return.</p>
|
|
2763
3088
|
*/
|
|
2764
3089
|
MaxResults?: number;
|
|
2765
3090
|
/**
|
|
3091
|
+
* @public
|
|
2766
3092
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2767
3093
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2768
3094
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2788,23 +3114,28 @@ export type ExecutorType = (typeof ExecutorType)[keyof typeof ExecutorType];
|
|
|
2788
3114
|
*/
|
|
2789
3115
|
export interface ExecutorsSummary {
|
|
2790
3116
|
/**
|
|
3117
|
+
* @public
|
|
2791
3118
|
* <p>The UUID of the executor.</p>
|
|
2792
3119
|
*/
|
|
2793
3120
|
ExecutorId: string | undefined;
|
|
2794
3121
|
/**
|
|
3122
|
+
* @public
|
|
2795
3123
|
* <p>The type of executor used for the application (<code>COORDINATOR</code>,
|
|
2796
3124
|
* <code>GATEWAY</code>, or <code>WORKER</code>).</p>
|
|
2797
3125
|
*/
|
|
2798
3126
|
ExecutorType?: ExecutorType | string;
|
|
2799
3127
|
/**
|
|
3128
|
+
* @public
|
|
2800
3129
|
* <p>The date and time that the executor started.</p>
|
|
2801
3130
|
*/
|
|
2802
3131
|
StartDateTime?: number;
|
|
2803
3132
|
/**
|
|
3133
|
+
* @public
|
|
2804
3134
|
* <p>The date and time that the executor was terminated.</p>
|
|
2805
3135
|
*/
|
|
2806
3136
|
TerminationDateTime?: number;
|
|
2807
3137
|
/**
|
|
3138
|
+
* @public
|
|
2808
3139
|
* <p>The processing state of the executor. A description of each state follows.</p>
|
|
2809
3140
|
* <p>
|
|
2810
3141
|
* <code>CREATING</code> - The executor is being started, including acquiring
|
|
@@ -2822,6 +3153,7 @@ export interface ExecutorsSummary {
|
|
|
2822
3153
|
*/
|
|
2823
3154
|
ExecutorState?: ExecutorState | string;
|
|
2824
3155
|
/**
|
|
3156
|
+
* @public
|
|
2825
3157
|
* <p>The smallest unit of compute that a session can request from Athena. Size
|
|
2826
3158
|
* is measured in data processing unit (DPU) values, a relative measure of processing
|
|
2827
3159
|
* power.</p>
|
|
@@ -2833,16 +3165,19 @@ export interface ExecutorsSummary {
|
|
|
2833
3165
|
*/
|
|
2834
3166
|
export interface ListExecutorsResponse {
|
|
2835
3167
|
/**
|
|
3168
|
+
* @public
|
|
2836
3169
|
* <p>The session ID.</p>
|
|
2837
3170
|
*/
|
|
2838
3171
|
SessionId: string | undefined;
|
|
2839
3172
|
/**
|
|
3173
|
+
* @public
|
|
2840
3174
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2841
3175
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2842
3176
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2843
3177
|
*/
|
|
2844
3178
|
NextToken?: string;
|
|
2845
3179
|
/**
|
|
3180
|
+
* @public
|
|
2846
3181
|
* <p>Contains summary information about the executor.</p>
|
|
2847
3182
|
*/
|
|
2848
3183
|
ExecutorsSummary?: ExecutorsSummary[];
|
|
@@ -2852,16 +3187,19 @@ export interface ListExecutorsResponse {
|
|
|
2852
3187
|
*/
|
|
2853
3188
|
export interface ListNamedQueriesInput {
|
|
2854
3189
|
/**
|
|
3190
|
+
* @public
|
|
2855
3191
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2856
3192
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2857
3193
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2858
3194
|
*/
|
|
2859
3195
|
NextToken?: string;
|
|
2860
3196
|
/**
|
|
3197
|
+
* @public
|
|
2861
3198
|
* <p>The maximum number of queries to return in this request.</p>
|
|
2862
3199
|
*/
|
|
2863
3200
|
MaxResults?: number;
|
|
2864
3201
|
/**
|
|
3202
|
+
* @public
|
|
2865
3203
|
* <p>The name of the workgroup from which the named queries are being returned. If a
|
|
2866
3204
|
* workgroup is not specified, the saved queries for the primary workgroup are
|
|
2867
3205
|
* returned.</p>
|
|
@@ -2873,10 +3211,12 @@ export interface ListNamedQueriesInput {
|
|
|
2873
3211
|
*/
|
|
2874
3212
|
export interface ListNamedQueriesOutput {
|
|
2875
3213
|
/**
|
|
3214
|
+
* @public
|
|
2876
3215
|
* <p>The list of unique query IDs.</p>
|
|
2877
3216
|
*/
|
|
2878
3217
|
NamedQueryIds?: string[];
|
|
2879
3218
|
/**
|
|
3219
|
+
* @public
|
|
2880
3220
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2881
3221
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2882
3222
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2889,6 +3229,7 @@ export interface ListNamedQueriesOutput {
|
|
|
2889
3229
|
*/
|
|
2890
3230
|
export interface FilterDefinition {
|
|
2891
3231
|
/**
|
|
3232
|
+
* @public
|
|
2892
3233
|
* <p>The name of the notebook to search for.</p>
|
|
2893
3234
|
*/
|
|
2894
3235
|
Name?: string;
|
|
@@ -2898,19 +3239,23 @@ export interface FilterDefinition {
|
|
|
2898
3239
|
*/
|
|
2899
3240
|
export interface ListNotebookMetadataInput {
|
|
2900
3241
|
/**
|
|
3242
|
+
* @public
|
|
2901
3243
|
* <p>Search filter string.</p>
|
|
2902
3244
|
*/
|
|
2903
3245
|
Filters?: FilterDefinition;
|
|
2904
3246
|
/**
|
|
3247
|
+
* @public
|
|
2905
3248
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2906
3249
|
* pagination if a previous request was truncated.</p>
|
|
2907
3250
|
*/
|
|
2908
3251
|
NextToken?: string;
|
|
2909
3252
|
/**
|
|
3253
|
+
* @public
|
|
2910
3254
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2911
3255
|
*/
|
|
2912
3256
|
MaxResults?: number;
|
|
2913
3257
|
/**
|
|
3258
|
+
* @public
|
|
2914
3259
|
* <p>The name of the Spark enabled workgroup to retrieve notebook metadata for.</p>
|
|
2915
3260
|
*/
|
|
2916
3261
|
WorkGroup: string | undefined;
|
|
@@ -2920,12 +3265,14 @@ export interface ListNotebookMetadataInput {
|
|
|
2920
3265
|
*/
|
|
2921
3266
|
export interface ListNotebookMetadataOutput {
|
|
2922
3267
|
/**
|
|
3268
|
+
* @public
|
|
2923
3269
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2924
3270
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2925
3271
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2926
3272
|
*/
|
|
2927
3273
|
NextToken?: string;
|
|
2928
3274
|
/**
|
|
3275
|
+
* @public
|
|
2929
3276
|
* <p>The list of notebook metadata for the specified workgroup.</p>
|
|
2930
3277
|
*/
|
|
2931
3278
|
NotebookMetadataList?: NotebookMetadata[];
|
|
@@ -2935,14 +3282,17 @@ export interface ListNotebookMetadataOutput {
|
|
|
2935
3282
|
*/
|
|
2936
3283
|
export interface ListNotebookSessionsRequest {
|
|
2937
3284
|
/**
|
|
3285
|
+
* @public
|
|
2938
3286
|
* <p>The ID of the notebook to list sessions for.</p>
|
|
2939
3287
|
*/
|
|
2940
3288
|
NotebookId: string | undefined;
|
|
2941
3289
|
/**
|
|
3290
|
+
* @public
|
|
2942
3291
|
* <p>The maximum number of notebook sessions to return.</p>
|
|
2943
3292
|
*/
|
|
2944
3293
|
MaxResults?: number;
|
|
2945
3294
|
/**
|
|
3295
|
+
* @public
|
|
2946
3296
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2947
3297
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2948
3298
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2955,10 +3305,12 @@ export interface ListNotebookSessionsRequest {
|
|
|
2955
3305
|
*/
|
|
2956
3306
|
export interface NotebookSessionSummary {
|
|
2957
3307
|
/**
|
|
3308
|
+
* @public
|
|
2958
3309
|
* <p>The notebook session ID.</p>
|
|
2959
3310
|
*/
|
|
2960
3311
|
SessionId?: string;
|
|
2961
3312
|
/**
|
|
3313
|
+
* @public
|
|
2962
3314
|
* <p>The time when the notebook session was created.</p>
|
|
2963
3315
|
*/
|
|
2964
3316
|
CreationTime?: Date;
|
|
@@ -2968,10 +3320,12 @@ export interface NotebookSessionSummary {
|
|
|
2968
3320
|
*/
|
|
2969
3321
|
export interface ListNotebookSessionsResponse {
|
|
2970
3322
|
/**
|
|
3323
|
+
* @public
|
|
2971
3324
|
* <p>A list of the sessions belonging to the notebook.</p>
|
|
2972
3325
|
*/
|
|
2973
3326
|
NotebookSessionsList: NotebookSessionSummary[] | undefined;
|
|
2974
3327
|
/**
|
|
3328
|
+
* @public
|
|
2975
3329
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2976
3330
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2977
3331
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -2983,16 +3337,19 @@ export interface ListNotebookSessionsResponse {
|
|
|
2983
3337
|
*/
|
|
2984
3338
|
export interface ListPreparedStatementsInput {
|
|
2985
3339
|
/**
|
|
3340
|
+
* @public
|
|
2986
3341
|
* <p>The workgroup to list the prepared statements for.</p>
|
|
2987
3342
|
*/
|
|
2988
3343
|
WorkGroup: string | undefined;
|
|
2989
3344
|
/**
|
|
3345
|
+
* @public
|
|
2990
3346
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2991
3347
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2992
3348
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2993
3349
|
*/
|
|
2994
3350
|
NextToken?: string;
|
|
2995
3351
|
/**
|
|
3352
|
+
* @public
|
|
2996
3353
|
* <p>The maximum number of results to return in this request.</p>
|
|
2997
3354
|
*/
|
|
2998
3355
|
MaxResults?: number;
|
|
@@ -3003,10 +3360,12 @@ export interface ListPreparedStatementsInput {
|
|
|
3003
3360
|
*/
|
|
3004
3361
|
export interface PreparedStatementSummary {
|
|
3005
3362
|
/**
|
|
3363
|
+
* @public
|
|
3006
3364
|
* <p>The name of the prepared statement.</p>
|
|
3007
3365
|
*/
|
|
3008
3366
|
StatementName?: string;
|
|
3009
3367
|
/**
|
|
3368
|
+
* @public
|
|
3010
3369
|
* <p>The last modified time of the prepared statement.</p>
|
|
3011
3370
|
*/
|
|
3012
3371
|
LastModifiedTime?: Date;
|
|
@@ -3016,10 +3375,12 @@ export interface PreparedStatementSummary {
|
|
|
3016
3375
|
*/
|
|
3017
3376
|
export interface ListPreparedStatementsOutput {
|
|
3018
3377
|
/**
|
|
3378
|
+
* @public
|
|
3019
3379
|
* <p>The list of prepared statements for the workgroup.</p>
|
|
3020
3380
|
*/
|
|
3021
3381
|
PreparedStatements?: PreparedStatementSummary[];
|
|
3022
3382
|
/**
|
|
3383
|
+
* @public
|
|
3023
3384
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3024
3385
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3025
3386
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -3031,16 +3392,19 @@ export interface ListPreparedStatementsOutput {
|
|
|
3031
3392
|
*/
|
|
3032
3393
|
export interface ListQueryExecutionsInput {
|
|
3033
3394
|
/**
|
|
3395
|
+
* @public
|
|
3034
3396
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3035
3397
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3036
3398
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3037
3399
|
*/
|
|
3038
3400
|
NextToken?: string;
|
|
3039
3401
|
/**
|
|
3402
|
+
* @public
|
|
3040
3403
|
* <p>The maximum number of query executions to return in this request.</p>
|
|
3041
3404
|
*/
|
|
3042
3405
|
MaxResults?: number;
|
|
3043
3406
|
/**
|
|
3407
|
+
* @public
|
|
3044
3408
|
* <p>The name of the workgroup from which queries are being returned. If a workgroup is not
|
|
3045
3409
|
* specified, a list of available query execution IDs for the queries in the primary
|
|
3046
3410
|
* workgroup is returned.</p>
|
|
@@ -3052,10 +3416,12 @@ export interface ListQueryExecutionsInput {
|
|
|
3052
3416
|
*/
|
|
3053
3417
|
export interface ListQueryExecutionsOutput {
|
|
3054
3418
|
/**
|
|
3419
|
+
* @public
|
|
3055
3420
|
* <p>The unique IDs of each query execution as an array of strings.</p>
|
|
3056
3421
|
*/
|
|
3057
3422
|
QueryExecutionIds?: string[];
|
|
3058
3423
|
/**
|
|
3424
|
+
* @public
|
|
3059
3425
|
* <p>A token to be used by the next request if this request is truncated.</p>
|
|
3060
3426
|
*/
|
|
3061
3427
|
NextToken?: string;
|
|
@@ -3065,10 +3431,12 @@ export interface ListQueryExecutionsOutput {
|
|
|
3065
3431
|
*/
|
|
3066
3432
|
export interface ListSessionsRequest {
|
|
3067
3433
|
/**
|
|
3434
|
+
* @public
|
|
3068
3435
|
* <p>The workgroup to which the session belongs.</p>
|
|
3069
3436
|
*/
|
|
3070
3437
|
WorkGroup: string | undefined;
|
|
3071
3438
|
/**
|
|
3439
|
+
* @public
|
|
3072
3440
|
* <p>A filter for a specific session state. A description of each state follows.</p>
|
|
3073
3441
|
* <p>
|
|
3074
3442
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -3092,10 +3460,12 @@ export interface ListSessionsRequest {
|
|
|
3092
3460
|
*/
|
|
3093
3461
|
StateFilter?: SessionState | string;
|
|
3094
3462
|
/**
|
|
3463
|
+
* @public
|
|
3095
3464
|
* <p>The maximum number of sessions to return.</p>
|
|
3096
3465
|
*/
|
|
3097
3466
|
MaxResults?: number;
|
|
3098
3467
|
/**
|
|
3468
|
+
* @public
|
|
3099
3469
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3100
3470
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3101
3471
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -3108,23 +3478,28 @@ export interface ListSessionsRequest {
|
|
|
3108
3478
|
*/
|
|
3109
3479
|
export interface SessionSummary {
|
|
3110
3480
|
/**
|
|
3481
|
+
* @public
|
|
3111
3482
|
* <p>The session ID.</p>
|
|
3112
3483
|
*/
|
|
3113
3484
|
SessionId?: string;
|
|
3114
3485
|
/**
|
|
3486
|
+
* @public
|
|
3115
3487
|
* <p>The session description.</p>
|
|
3116
3488
|
*/
|
|
3117
3489
|
Description?: string;
|
|
3118
3490
|
/**
|
|
3491
|
+
* @public
|
|
3119
3492
|
* <p>The engine version used by the session (for example, <code>PySpark engine version
|
|
3120
3493
|
* 3</code>).</p>
|
|
3121
3494
|
*/
|
|
3122
3495
|
EngineVersion?: EngineVersion;
|
|
3123
3496
|
/**
|
|
3497
|
+
* @public
|
|
3124
3498
|
* <p>The notebook version.</p>
|
|
3125
3499
|
*/
|
|
3126
3500
|
NotebookVersion?: string;
|
|
3127
3501
|
/**
|
|
3502
|
+
* @public
|
|
3128
3503
|
* <p>Contains information about the session status.</p>
|
|
3129
3504
|
*/
|
|
3130
3505
|
Status?: SessionStatus;
|
|
@@ -3134,12 +3509,14 @@ export interface SessionSummary {
|
|
|
3134
3509
|
*/
|
|
3135
3510
|
export interface ListSessionsResponse {
|
|
3136
3511
|
/**
|
|
3512
|
+
* @public
|
|
3137
3513
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3138
3514
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3139
3515
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3140
3516
|
*/
|
|
3141
3517
|
NextToken?: string;
|
|
3142
3518
|
/**
|
|
3519
|
+
* @public
|
|
3143
3520
|
* <p>A list of sessions.</p>
|
|
3144
3521
|
*/
|
|
3145
3522
|
Sessions?: SessionSummary[];
|
|
@@ -3149,25 +3526,30 @@ export interface ListSessionsResponse {
|
|
|
3149
3526
|
*/
|
|
3150
3527
|
export interface ListTableMetadataInput {
|
|
3151
3528
|
/**
|
|
3529
|
+
* @public
|
|
3152
3530
|
* <p>The name of the data catalog for which table metadata should be returned.</p>
|
|
3153
3531
|
*/
|
|
3154
3532
|
CatalogName: string | undefined;
|
|
3155
3533
|
/**
|
|
3534
|
+
* @public
|
|
3156
3535
|
* <p>The name of the database for which table metadata should be returned.</p>
|
|
3157
3536
|
*/
|
|
3158
3537
|
DatabaseName: string | undefined;
|
|
3159
3538
|
/**
|
|
3539
|
+
* @public
|
|
3160
3540
|
* <p>A regex filter that pattern-matches table names. If no expression is supplied,
|
|
3161
3541
|
* metadata for all tables are listed.</p>
|
|
3162
3542
|
*/
|
|
3163
3543
|
Expression?: string;
|
|
3164
3544
|
/**
|
|
3545
|
+
* @public
|
|
3165
3546
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3166
3547
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3167
3548
|
* the NextToken from the response object of the previous page call.</p>
|
|
3168
3549
|
*/
|
|
3169
3550
|
NextToken?: string;
|
|
3170
3551
|
/**
|
|
3552
|
+
* @public
|
|
3171
3553
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3172
3554
|
*/
|
|
3173
3555
|
MaxResults?: number;
|
|
@@ -3177,10 +3559,12 @@ export interface ListTableMetadataInput {
|
|
|
3177
3559
|
*/
|
|
3178
3560
|
export interface ListTableMetadataOutput {
|
|
3179
3561
|
/**
|
|
3562
|
+
* @public
|
|
3180
3563
|
* <p>A list of table metadata.</p>
|
|
3181
3564
|
*/
|
|
3182
3565
|
TableMetadataList?: TableMetadata[];
|
|
3183
3566
|
/**
|
|
3567
|
+
* @public
|
|
3184
3568
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3185
3569
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3186
3570
|
* the NextToken from the response object of the previous page call.</p>
|
|
@@ -3192,16 +3576,19 @@ export interface ListTableMetadataOutput {
|
|
|
3192
3576
|
*/
|
|
3193
3577
|
export interface ListTagsForResourceInput {
|
|
3194
3578
|
/**
|
|
3579
|
+
* @public
|
|
3195
3580
|
* <p>Lists the tags for the resource with the specified ARN.</p>
|
|
3196
3581
|
*/
|
|
3197
3582
|
ResourceARN: string | undefined;
|
|
3198
3583
|
/**
|
|
3584
|
+
* @public
|
|
3199
3585
|
* <p>The token for the next set of results, or null if there are no additional results for
|
|
3200
3586
|
* this request, where the request lists the tags for the resource with the specified
|
|
3201
3587
|
* ARN.</p>
|
|
3202
3588
|
*/
|
|
3203
3589
|
NextToken?: string;
|
|
3204
3590
|
/**
|
|
3591
|
+
* @public
|
|
3205
3592
|
* <p>The maximum number of results to be returned per request that lists the tags for the
|
|
3206
3593
|
* resource.</p>
|
|
3207
3594
|
*/
|
|
@@ -3212,10 +3599,12 @@ export interface ListTagsForResourceInput {
|
|
|
3212
3599
|
*/
|
|
3213
3600
|
export interface ListTagsForResourceOutput {
|
|
3214
3601
|
/**
|
|
3602
|
+
* @public
|
|
3215
3603
|
* <p>The list of tags associated with the specified resource.</p>
|
|
3216
3604
|
*/
|
|
3217
3605
|
Tags?: Tag[];
|
|
3218
3606
|
/**
|
|
3607
|
+
* @public
|
|
3219
3608
|
* <p>A token to be used by the next request if this request is truncated.</p>
|
|
3220
3609
|
*/
|
|
3221
3610
|
NextToken?: string;
|
|
@@ -3225,12 +3614,14 @@ export interface ListTagsForResourceOutput {
|
|
|
3225
3614
|
*/
|
|
3226
3615
|
export interface ListWorkGroupsInput {
|
|
3227
3616
|
/**
|
|
3617
|
+
* @public
|
|
3228
3618
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3229
3619
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3230
3620
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3231
3621
|
*/
|
|
3232
3622
|
NextToken?: string;
|
|
3233
3623
|
/**
|
|
3624
|
+
* @public
|
|
3234
3625
|
* <p>The maximum number of workgroups to return in this request.</p>
|
|
3235
3626
|
*/
|
|
3236
3627
|
MaxResults?: number;
|
|
@@ -3242,22 +3633,27 @@ export interface ListWorkGroupsInput {
|
|
|
3242
3633
|
*/
|
|
3243
3634
|
export interface WorkGroupSummary {
|
|
3244
3635
|
/**
|
|
3636
|
+
* @public
|
|
3245
3637
|
* <p>The name of the workgroup.</p>
|
|
3246
3638
|
*/
|
|
3247
3639
|
Name?: string;
|
|
3248
3640
|
/**
|
|
3641
|
+
* @public
|
|
3249
3642
|
* <p>The state of the workgroup.</p>
|
|
3250
3643
|
*/
|
|
3251
3644
|
State?: WorkGroupState | string;
|
|
3252
3645
|
/**
|
|
3646
|
+
* @public
|
|
3253
3647
|
* <p>The workgroup description.</p>
|
|
3254
3648
|
*/
|
|
3255
3649
|
Description?: string;
|
|
3256
3650
|
/**
|
|
3651
|
+
* @public
|
|
3257
3652
|
* <p>The workgroup creation date and time.</p>
|
|
3258
3653
|
*/
|
|
3259
3654
|
CreationTime?: Date;
|
|
3260
3655
|
/**
|
|
3656
|
+
* @public
|
|
3261
3657
|
* <p>The engine version setting for all queries on the workgroup. Queries on the
|
|
3262
3658
|
* <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine
|
|
3263
3659
|
* regardless of this setting.</p>
|
|
@@ -3269,11 +3665,13 @@ export interface WorkGroupSummary {
|
|
|
3269
3665
|
*/
|
|
3270
3666
|
export interface ListWorkGroupsOutput {
|
|
3271
3667
|
/**
|
|
3668
|
+
* @public
|
|
3272
3669
|
* <p>A list of <a>WorkGroupSummary</a> objects that include the names,
|
|
3273
3670
|
* descriptions, creation times, and states for each workgroup.</p>
|
|
3274
3671
|
*/
|
|
3275
3672
|
WorkGroups?: WorkGroupSummary[];
|
|
3276
3673
|
/**
|
|
3674
|
+
* @public
|
|
3277
3675
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3278
3676
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3279
3677
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
@@ -3285,10 +3683,12 @@ export interface ListWorkGroupsOutput {
|
|
|
3285
3683
|
*/
|
|
3286
3684
|
export interface PutCapacityAssignmentConfigurationInput {
|
|
3287
3685
|
/**
|
|
3686
|
+
* @public
|
|
3288
3687
|
* <p>The name of the capacity reservation to put a capacity assignment configuration for.</p>
|
|
3289
3688
|
*/
|
|
3290
3689
|
CapacityReservationName: string | undefined;
|
|
3291
3690
|
/**
|
|
3691
|
+
* @public
|
|
3292
3692
|
* <p>The list of assignments for the capacity assignment configuration.</p>
|
|
3293
3693
|
*/
|
|
3294
3694
|
CapacityAssignments: CapacityAssignment[] | undefined;
|
|
@@ -3304,6 +3704,7 @@ export interface PutCapacityAssignmentConfigurationOutput {
|
|
|
3304
3704
|
*/
|
|
3305
3705
|
export interface CalculationConfiguration {
|
|
3306
3706
|
/**
|
|
3707
|
+
* @public
|
|
3307
3708
|
* <p>A string that contains the code for the calculation.</p>
|
|
3308
3709
|
*/
|
|
3309
3710
|
CodeBlock?: string;
|
|
@@ -3313,24 +3714,29 @@ export interface CalculationConfiguration {
|
|
|
3313
3714
|
*/
|
|
3314
3715
|
export interface StartCalculationExecutionRequest {
|
|
3315
3716
|
/**
|
|
3717
|
+
* @public
|
|
3316
3718
|
* <p>The session ID.</p>
|
|
3317
3719
|
*/
|
|
3318
3720
|
SessionId: string | undefined;
|
|
3319
3721
|
/**
|
|
3722
|
+
* @public
|
|
3320
3723
|
* <p>A description of the calculation.</p>
|
|
3321
3724
|
*/
|
|
3322
3725
|
Description?: string;
|
|
3323
3726
|
/**
|
|
3727
|
+
* @public
|
|
3324
3728
|
* @deprecated
|
|
3325
3729
|
*
|
|
3326
3730
|
* <p>Contains configuration information for the calculation.</p>
|
|
3327
3731
|
*/
|
|
3328
3732
|
CalculationConfiguration?: CalculationConfiguration;
|
|
3329
3733
|
/**
|
|
3734
|
+
* @public
|
|
3330
3735
|
* <p>A string that contains the code of the calculation.</p>
|
|
3331
3736
|
*/
|
|
3332
3737
|
CodeBlock?: string;
|
|
3333
3738
|
/**
|
|
3739
|
+
* @public
|
|
3334
3740
|
* <p>A unique case-sensitive string used to ensure the request to create the calculation is
|
|
3335
3741
|
* idempotent (executes only once). If another
|
|
3336
3742
|
* <code>StartCalculationExecutionRequest</code> is received, the same response is
|
|
@@ -3350,10 +3756,12 @@ export interface StartCalculationExecutionRequest {
|
|
|
3350
3756
|
*/
|
|
3351
3757
|
export interface StartCalculationExecutionResponse {
|
|
3352
3758
|
/**
|
|
3759
|
+
* @public
|
|
3353
3760
|
* <p>The calculation execution UUID.</p>
|
|
3354
3761
|
*/
|
|
3355
3762
|
CalculationExecutionId?: string;
|
|
3356
3763
|
/**
|
|
3764
|
+
* @public
|
|
3357
3765
|
* <p>
|
|
3358
3766
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
3359
3767
|
* <p>
|
|
@@ -3380,10 +3788,12 @@ export interface StartCalculationExecutionResponse {
|
|
|
3380
3788
|
*/
|
|
3381
3789
|
export interface StartQueryExecutionInput {
|
|
3382
3790
|
/**
|
|
3791
|
+
* @public
|
|
3383
3792
|
* <p>The SQL query statements to be executed.</p>
|
|
3384
3793
|
*/
|
|
3385
3794
|
QueryString: string | undefined;
|
|
3386
3795
|
/**
|
|
3796
|
+
* @public
|
|
3387
3797
|
* <p>A unique case-sensitive string used to ensure the request to create the query is
|
|
3388
3798
|
* idempotent (executes only once). If another <code>StartQueryExecution</code> request is
|
|
3389
3799
|
* received, the same response is returned and another query is not created. If a parameter
|
|
@@ -3397,10 +3807,12 @@ export interface StartQueryExecutionInput {
|
|
|
3397
3807
|
*/
|
|
3398
3808
|
ClientRequestToken?: string;
|
|
3399
3809
|
/**
|
|
3810
|
+
* @public
|
|
3400
3811
|
* <p>The database within which the query executes.</p>
|
|
3401
3812
|
*/
|
|
3402
3813
|
QueryExecutionContext?: QueryExecutionContext;
|
|
3403
3814
|
/**
|
|
3815
|
+
* @public
|
|
3404
3816
|
* <p>Specifies information about where and how to save the results of the query execution.
|
|
3405
3817
|
* If the query runs in a workgroup, then workgroup's settings may override query settings.
|
|
3406
3818
|
* This affects the query results location. The workgroup settings override is specified in
|
|
@@ -3408,15 +3820,18 @@ export interface StartQueryExecutionInput {
|
|
|
3408
3820
|
*/
|
|
3409
3821
|
ResultConfiguration?: ResultConfiguration;
|
|
3410
3822
|
/**
|
|
3823
|
+
* @public
|
|
3411
3824
|
* <p>The name of the workgroup in which the query is being started.</p>
|
|
3412
3825
|
*/
|
|
3413
3826
|
WorkGroup?: string;
|
|
3414
3827
|
/**
|
|
3828
|
+
* @public
|
|
3415
3829
|
* <p>A list of values for the parameters in a query. The values are applied sequentially to
|
|
3416
3830
|
* the parameters in the query in the order in which the parameters occur.</p>
|
|
3417
3831
|
*/
|
|
3418
3832
|
ExecutionParameters?: string[];
|
|
3419
3833
|
/**
|
|
3834
|
+
* @public
|
|
3420
3835
|
* <p>Specifies the query result reuse behavior for the query.</p>
|
|
3421
3836
|
*/
|
|
3422
3837
|
ResultReuseConfiguration?: ResultReuseConfiguration;
|
|
@@ -3426,6 +3841,7 @@ export interface StartQueryExecutionInput {
|
|
|
3426
3841
|
*/
|
|
3427
3842
|
export interface StartQueryExecutionOutput {
|
|
3428
3843
|
/**
|
|
3844
|
+
* @public
|
|
3429
3845
|
* <p>The unique ID of the query that ran as a result of this request.</p>
|
|
3430
3846
|
*/
|
|
3431
3847
|
QueryExecutionId?: string;
|
|
@@ -3448,27 +3864,33 @@ export declare class SessionAlreadyExistsException extends __BaseException {
|
|
|
3448
3864
|
*/
|
|
3449
3865
|
export interface StartSessionRequest {
|
|
3450
3866
|
/**
|
|
3867
|
+
* @public
|
|
3451
3868
|
* <p>The session description.</p>
|
|
3452
3869
|
*/
|
|
3453
3870
|
Description?: string;
|
|
3454
3871
|
/**
|
|
3872
|
+
* @public
|
|
3455
3873
|
* <p>The workgroup to which the session belongs.</p>
|
|
3456
3874
|
*/
|
|
3457
3875
|
WorkGroup: string | undefined;
|
|
3458
3876
|
/**
|
|
3877
|
+
* @public
|
|
3459
3878
|
* <p>Contains engine data processing unit (DPU) configuration settings and parameter
|
|
3460
3879
|
* mappings.</p>
|
|
3461
3880
|
*/
|
|
3462
3881
|
EngineConfiguration: EngineConfiguration | undefined;
|
|
3463
3882
|
/**
|
|
3883
|
+
* @public
|
|
3464
3884
|
* <p>The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is <code>Athena notebook version 1</code>. If you specify a value for <code>NotebookVersion</code>, you must also specify a value for <code>NotebookId</code>. See <a>EngineConfiguration$AdditionalConfigs</a>.</p>
|
|
3465
3885
|
*/
|
|
3466
3886
|
NotebookVersion?: string;
|
|
3467
3887
|
/**
|
|
3888
|
+
* @public
|
|
3468
3889
|
* <p>The idle timeout in minutes for the session.</p>
|
|
3469
3890
|
*/
|
|
3470
3891
|
SessionIdleTimeoutInMinutes?: number;
|
|
3471
3892
|
/**
|
|
3893
|
+
* @public
|
|
3472
3894
|
* <p>A unique case-sensitive string used to ensure the request to create the session is
|
|
3473
3895
|
* idempotent (executes only once). If another <code>StartSessionRequest</code> is
|
|
3474
3896
|
* received, the same response is returned and another session is not created. If a
|
|
@@ -3487,10 +3909,12 @@ export interface StartSessionRequest {
|
|
|
3487
3909
|
*/
|
|
3488
3910
|
export interface StartSessionResponse {
|
|
3489
3911
|
/**
|
|
3912
|
+
* @public
|
|
3490
3913
|
* <p>The session ID.</p>
|
|
3491
3914
|
*/
|
|
3492
3915
|
SessionId?: string;
|
|
3493
3916
|
/**
|
|
3917
|
+
* @public
|
|
3494
3918
|
* <p>The state of the session. A description of each state follows.</p>
|
|
3495
3919
|
* <p>
|
|
3496
3920
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -3519,6 +3943,7 @@ export interface StartSessionResponse {
|
|
|
3519
3943
|
*/
|
|
3520
3944
|
export interface StopCalculationExecutionRequest {
|
|
3521
3945
|
/**
|
|
3946
|
+
* @public
|
|
3522
3947
|
* <p>The calculation execution UUID.</p>
|
|
3523
3948
|
*/
|
|
3524
3949
|
CalculationExecutionId: string | undefined;
|
|
@@ -3528,6 +3953,7 @@ export interface StopCalculationExecutionRequest {
|
|
|
3528
3953
|
*/
|
|
3529
3954
|
export interface StopCalculationExecutionResponse {
|
|
3530
3955
|
/**
|
|
3956
|
+
* @public
|
|
3531
3957
|
* <p>
|
|
3532
3958
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
3533
3959
|
* <p>
|
|
@@ -3554,6 +3980,7 @@ export interface StopCalculationExecutionResponse {
|
|
|
3554
3980
|
*/
|
|
3555
3981
|
export interface StopQueryExecutionInput {
|
|
3556
3982
|
/**
|
|
3983
|
+
* @public
|
|
3557
3984
|
* <p>The unique ID of the query execution to stop.</p>
|
|
3558
3985
|
*/
|
|
3559
3986
|
QueryExecutionId?: string;
|
|
@@ -3568,11 +3995,13 @@ export interface StopQueryExecutionOutput {
|
|
|
3568
3995
|
*/
|
|
3569
3996
|
export interface TagResourceInput {
|
|
3570
3997
|
/**
|
|
3998
|
+
* @public
|
|
3571
3999
|
* <p>Specifies the ARN of the Athena resource to
|
|
3572
4000
|
* which tags are to be added.</p>
|
|
3573
4001
|
*/
|
|
3574
4002
|
ResourceARN: string | undefined;
|
|
3575
4003
|
/**
|
|
4004
|
+
* @public
|
|
3576
4005
|
* <p>A collection of one or more tags, separated by commas, to be added to an Athena resource.</p>
|
|
3577
4006
|
*/
|
|
3578
4007
|
Tags: Tag[] | undefined;
|
|
@@ -3587,6 +4016,7 @@ export interface TagResourceOutput {
|
|
|
3587
4016
|
*/
|
|
3588
4017
|
export interface TerminateSessionRequest {
|
|
3589
4018
|
/**
|
|
4019
|
+
* @public
|
|
3590
4020
|
* <p>The session ID.</p>
|
|
3591
4021
|
*/
|
|
3592
4022
|
SessionId: string | undefined;
|
|
@@ -3596,6 +4026,7 @@ export interface TerminateSessionRequest {
|
|
|
3596
4026
|
*/
|
|
3597
4027
|
export interface TerminateSessionResponse {
|
|
3598
4028
|
/**
|
|
4029
|
+
* @public
|
|
3599
4030
|
* <p>The state of the session. A description of each state follows.</p>
|
|
3600
4031
|
* <p>
|
|
3601
4032
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -3624,10 +4055,12 @@ export interface TerminateSessionResponse {
|
|
|
3624
4055
|
*/
|
|
3625
4056
|
export interface UntagResourceInput {
|
|
3626
4057
|
/**
|
|
4058
|
+
* @public
|
|
3627
4059
|
* <p>Specifies the ARN of the resource from which tags are to be removed.</p>
|
|
3628
4060
|
*/
|
|
3629
4061
|
ResourceARN: string | undefined;
|
|
3630
4062
|
/**
|
|
4063
|
+
* @public
|
|
3631
4064
|
* <p>A comma-separated list of one or more tag keys whose tags are to be removed from the
|
|
3632
4065
|
* specified resource.</p>
|
|
3633
4066
|
*/
|
|
@@ -3643,10 +4076,12 @@ export interface UntagResourceOutput {
|
|
|
3643
4076
|
*/
|
|
3644
4077
|
export interface UpdateCapacityReservationInput {
|
|
3645
4078
|
/**
|
|
4079
|
+
* @public
|
|
3646
4080
|
* <p>The new number of requested data processing units.</p>
|
|
3647
4081
|
*/
|
|
3648
4082
|
TargetDpus: number | undefined;
|
|
3649
4083
|
/**
|
|
4084
|
+
* @public
|
|
3650
4085
|
* <p>The name of the capacity reservation.</p>
|
|
3651
4086
|
*/
|
|
3652
4087
|
Name: string | undefined;
|
|
@@ -3661,6 +4096,7 @@ export interface UpdateCapacityReservationOutput {
|
|
|
3661
4096
|
*/
|
|
3662
4097
|
export interface UpdateDataCatalogInput {
|
|
3663
4098
|
/**
|
|
4099
|
+
* @public
|
|
3664
4100
|
* <p>The name of the data catalog to update. The catalog name must be unique for the
|
|
3665
4101
|
* Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at
|
|
3666
4102
|
* sign, or hyphen characters. The remainder of the length constraint of 256 is reserved
|
|
@@ -3668,16 +4104,19 @@ export interface UpdateDataCatalogInput {
|
|
|
3668
4104
|
*/
|
|
3669
4105
|
Name: string | undefined;
|
|
3670
4106
|
/**
|
|
4107
|
+
* @public
|
|
3671
4108
|
* <p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a
|
|
3672
4109
|
* federated catalog, <code>HIVE</code> for an external hive metastore, or
|
|
3673
4110
|
* <code>GLUE</code> for an Glue Data Catalog.</p>
|
|
3674
4111
|
*/
|
|
3675
4112
|
Type: DataCatalogType | string | undefined;
|
|
3676
4113
|
/**
|
|
4114
|
+
* @public
|
|
3677
4115
|
* <p>New or modified text that describes the data catalog.</p>
|
|
3678
4116
|
*/
|
|
3679
4117
|
Description?: string;
|
|
3680
4118
|
/**
|
|
4119
|
+
* @public
|
|
3681
4120
|
* <p>Specifies the Lambda function or functions to use for updating the data
|
|
3682
4121
|
* catalog. This is a mapping whose values depend on the catalog type. </p>
|
|
3683
4122
|
* <ul>
|
|
@@ -3730,18 +4169,22 @@ export interface UpdateDataCatalogOutput {
|
|
|
3730
4169
|
*/
|
|
3731
4170
|
export interface UpdateNamedQueryInput {
|
|
3732
4171
|
/**
|
|
4172
|
+
* @public
|
|
3733
4173
|
* <p>The unique identifier (UUID) of the query.</p>
|
|
3734
4174
|
*/
|
|
3735
4175
|
NamedQueryId: string | undefined;
|
|
3736
4176
|
/**
|
|
4177
|
+
* @public
|
|
3737
4178
|
* <p>The name of the query.</p>
|
|
3738
4179
|
*/
|
|
3739
4180
|
Name: string | undefined;
|
|
3740
4181
|
/**
|
|
4182
|
+
* @public
|
|
3741
4183
|
* <p>The query description.</p>
|
|
3742
4184
|
*/
|
|
3743
4185
|
Description?: string;
|
|
3744
4186
|
/**
|
|
4187
|
+
* @public
|
|
3745
4188
|
* <p>The contents of the query with all query statements.</p>
|
|
3746
4189
|
*/
|
|
3747
4190
|
QueryString: string | undefined;
|
|
@@ -3756,23 +4199,28 @@ export interface UpdateNamedQueryOutput {
|
|
|
3756
4199
|
*/
|
|
3757
4200
|
export interface UpdateNotebookInput {
|
|
3758
4201
|
/**
|
|
4202
|
+
* @public
|
|
3759
4203
|
* <p>The ID of the notebook to update.</p>
|
|
3760
4204
|
*/
|
|
3761
4205
|
NotebookId: string | undefined;
|
|
3762
4206
|
/**
|
|
4207
|
+
* @public
|
|
3763
4208
|
* <p>The updated content for the notebook.</p>
|
|
3764
4209
|
*/
|
|
3765
4210
|
Payload: string | undefined;
|
|
3766
4211
|
/**
|
|
4212
|
+
* @public
|
|
3767
4213
|
* <p>The notebook content type. Currently, the only valid type is
|
|
3768
4214
|
* <code>IPYNB</code>.</p>
|
|
3769
4215
|
*/
|
|
3770
4216
|
Type: NotebookType | string | undefined;
|
|
3771
4217
|
/**
|
|
4218
|
+
* @public
|
|
3772
4219
|
* <p>The active notebook session ID. Required if the notebook has an active session.</p>
|
|
3773
4220
|
*/
|
|
3774
4221
|
SessionId?: string;
|
|
3775
4222
|
/**
|
|
4223
|
+
* @public
|
|
3776
4224
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
3777
4225
|
* idempotent (executes only once).</p>
|
|
3778
4226
|
* <important>
|
|
@@ -3794,10 +4242,12 @@ export interface UpdateNotebookOutput {
|
|
|
3794
4242
|
*/
|
|
3795
4243
|
export interface UpdateNotebookMetadataInput {
|
|
3796
4244
|
/**
|
|
4245
|
+
* @public
|
|
3797
4246
|
* <p>The ID of the notebook to update the metadata for.</p>
|
|
3798
4247
|
*/
|
|
3799
4248
|
NotebookId: string | undefined;
|
|
3800
4249
|
/**
|
|
4250
|
+
* @public
|
|
3801
4251
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
3802
4252
|
* idempotent (executes only once).</p>
|
|
3803
4253
|
* <important>
|
|
@@ -3809,6 +4259,7 @@ export interface UpdateNotebookMetadataInput {
|
|
|
3809
4259
|
*/
|
|
3810
4260
|
ClientRequestToken?: string;
|
|
3811
4261
|
/**
|
|
4262
|
+
* @public
|
|
3812
4263
|
* <p>The name to update the notebook to.</p>
|
|
3813
4264
|
*/
|
|
3814
4265
|
Name: string | undefined;
|
|
@@ -3823,18 +4274,22 @@ export interface UpdateNotebookMetadataOutput {
|
|
|
3823
4274
|
*/
|
|
3824
4275
|
export interface UpdatePreparedStatementInput {
|
|
3825
4276
|
/**
|
|
4277
|
+
* @public
|
|
3826
4278
|
* <p>The name of the prepared statement.</p>
|
|
3827
4279
|
*/
|
|
3828
4280
|
StatementName: string | undefined;
|
|
3829
4281
|
/**
|
|
4282
|
+
* @public
|
|
3830
4283
|
* <p>The workgroup for the prepared statement.</p>
|
|
3831
4284
|
*/
|
|
3832
4285
|
WorkGroup: string | undefined;
|
|
3833
4286
|
/**
|
|
4287
|
+
* @public
|
|
3834
4288
|
* <p>The query string for the prepared statement.</p>
|
|
3835
4289
|
*/
|
|
3836
4290
|
QueryStatement: string | undefined;
|
|
3837
4291
|
/**
|
|
4292
|
+
* @public
|
|
3838
4293
|
* <p>The description of the prepared statement.</p>
|
|
3839
4294
|
*/
|
|
3840
4295
|
Description?: string;
|
|
@@ -3851,6 +4306,7 @@ export interface UpdatePreparedStatementOutput {
|
|
|
3851
4306
|
*/
|
|
3852
4307
|
export interface ResultConfigurationUpdates {
|
|
3853
4308
|
/**
|
|
4309
|
+
* @public
|
|
3854
4310
|
* <p>The location in Amazon S3 where your query and calculation results are stored, such as
|
|
3855
4311
|
* <code>s3://path/to/query/bucket/</code>. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query
|
|
3856
4312
|
* results, recent queries, and output files</a>. If workgroup settings override
|
|
@@ -3861,6 +4317,7 @@ export interface ResultConfigurationUpdates {
|
|
|
3861
4317
|
*/
|
|
3862
4318
|
OutputLocation?: string;
|
|
3863
4319
|
/**
|
|
4320
|
+
* @public
|
|
3864
4321
|
* <p>If set to "true", indicates that the previously-specified query results location (also
|
|
3865
4322
|
* known as a client-side setting) for queries in this workgroup should be ignored and set
|
|
3866
4323
|
* to null. If set to "false" or not set, and a value is present in the
|
|
@@ -3872,10 +4329,12 @@ export interface ResultConfigurationUpdates {
|
|
|
3872
4329
|
*/
|
|
3873
4330
|
RemoveOutputLocation?: boolean;
|
|
3874
4331
|
/**
|
|
4332
|
+
* @public
|
|
3875
4333
|
* <p>The encryption configuration for query and calculation results.</p>
|
|
3876
4334
|
*/
|
|
3877
4335
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
3878
4336
|
/**
|
|
4337
|
+
* @public
|
|
3879
4338
|
* <p>If set to "true", indicates that the previously-specified encryption configuration
|
|
3880
4339
|
* (also known as the client-side setting) for queries in this workgroup should be ignored
|
|
3881
4340
|
* and set to null. If set to "false" or not set, and a value is present in the
|
|
@@ -3887,6 +4346,7 @@ export interface ResultConfigurationUpdates {
|
|
|
3887
4346
|
*/
|
|
3888
4347
|
RemoveEncryptionConfiguration?: boolean;
|
|
3889
4348
|
/**
|
|
4349
|
+
* @public
|
|
3890
4350
|
* <p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.
|
|
3891
4351
|
* If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it
|
|
3892
4352
|
* makes Amazon S3 calls to your specified output location. If the
|
|
@@ -3899,6 +4359,7 @@ export interface ResultConfigurationUpdates {
|
|
|
3899
4359
|
*/
|
|
3900
4360
|
ExpectedBucketOwner?: string;
|
|
3901
4361
|
/**
|
|
4362
|
+
* @public
|
|
3902
4363
|
* <p>If set to "true", removes the Amazon Web Services account ID previously specified for
|
|
3903
4364
|
* <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to "false" or not
|
|
3904
4365
|
* set, and a value is present in the <code>ExpectedBucketOwner</code> in
|
|
@@ -3909,10 +4370,12 @@ export interface ResultConfigurationUpdates {
|
|
|
3909
4370
|
*/
|
|
3910
4371
|
RemoveExpectedBucketOwner?: boolean;
|
|
3911
4372
|
/**
|
|
4373
|
+
* @public
|
|
3912
4374
|
* <p>The ACL configuration for the query results.</p>
|
|
3913
4375
|
*/
|
|
3914
4376
|
AclConfiguration?: AclConfiguration;
|
|
3915
4377
|
/**
|
|
4378
|
+
* @public
|
|
3916
4379
|
* <p>If set to <code>true</code>, indicates that the previously-specified ACL configuration
|
|
3917
4380
|
* for queries in this workgroup should be ignored and set to null. If set to
|
|
3918
4381
|
* <code>false</code> or not set, and a value is present in the
|
|
@@ -3934,31 +4397,37 @@ export interface ResultConfigurationUpdates {
|
|
|
3934
4397
|
*/
|
|
3935
4398
|
export interface WorkGroupConfigurationUpdates {
|
|
3936
4399
|
/**
|
|
4400
|
+
* @public
|
|
3937
4401
|
* <p>If set to "true", the settings for the workgroup override client-side settings. If set
|
|
3938
4402
|
* to "false" client-side settings are used. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
3939
4403
|
*/
|
|
3940
4404
|
EnforceWorkGroupConfiguration?: boolean;
|
|
3941
4405
|
/**
|
|
4406
|
+
* @public
|
|
3942
4407
|
* <p>The result configuration information about the queries in this workgroup that will be
|
|
3943
4408
|
* updated. Includes the updated results location and an updated option for encrypting
|
|
3944
4409
|
* query results.</p>
|
|
3945
4410
|
*/
|
|
3946
4411
|
ResultConfigurationUpdates?: ResultConfigurationUpdates;
|
|
3947
4412
|
/**
|
|
4413
|
+
* @public
|
|
3948
4414
|
* <p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>
|
|
3949
4415
|
*/
|
|
3950
4416
|
PublishCloudWatchMetricsEnabled?: boolean;
|
|
3951
4417
|
/**
|
|
4418
|
+
* @public
|
|
3952
4419
|
* <p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is
|
|
3953
4420
|
* allowed to scan.</p>
|
|
3954
4421
|
*/
|
|
3955
4422
|
BytesScannedCutoffPerQuery?: number;
|
|
3956
4423
|
/**
|
|
4424
|
+
* @public
|
|
3957
4425
|
* <p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a>
|
|
3958
4426
|
* </p>
|
|
3959
4427
|
*/
|
|
3960
4428
|
RemoveBytesScannedCutoffPerQuery?: boolean;
|
|
3961
4429
|
/**
|
|
4430
|
+
* @public
|
|
3962
4431
|
* <p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup
|
|
3963
4432
|
* members cannot query data from Requester Pays buckets, and queries that retrieve data
|
|
3964
4433
|
* from Requester Pays buckets cause an error. The default is <code>false</code>. For more
|
|
@@ -3967,6 +4436,7 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
3967
4436
|
*/
|
|
3968
4437
|
RequesterPaysEnabled?: boolean;
|
|
3969
4438
|
/**
|
|
4439
|
+
* @public
|
|
3970
4440
|
* <p>The engine version requested when a workgroup is updated. After the update, all
|
|
3971
4441
|
* queries on the workgroup run on the requested engine version. If no value was previously
|
|
3972
4442
|
* set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code>
|
|
@@ -3974,22 +4444,27 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
3974
4444
|
*/
|
|
3975
4445
|
EngineVersion?: EngineVersion;
|
|
3976
4446
|
/**
|
|
4447
|
+
* @public
|
|
3977
4448
|
* <p>Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.</p>
|
|
3978
4449
|
*/
|
|
3979
4450
|
RemoveCustomerContentEncryptionConfiguration?: boolean;
|
|
3980
4451
|
/**
|
|
4452
|
+
* @public
|
|
3981
4453
|
* <p>Contains a user defined string in JSON format for a Spark-enabled workgroup.</p>
|
|
3982
4454
|
*/
|
|
3983
4455
|
AdditionalConfiguration?: string;
|
|
3984
4456
|
/**
|
|
4457
|
+
* @public
|
|
3985
4458
|
* <p>Contains the ARN of the execution role for the workgroup</p>
|
|
3986
4459
|
*/
|
|
3987
4460
|
ExecutionRole?: string;
|
|
3988
4461
|
/**
|
|
4462
|
+
* @public
|
|
3989
4463
|
* <p>Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.</p>
|
|
3990
4464
|
*/
|
|
3991
4465
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
3992
4466
|
/**
|
|
4467
|
+
* @public
|
|
3993
4468
|
* <p>Enforces a minimal level of encryption for the workgroup for query and calculation
|
|
3994
4469
|
* results that are written to Amazon S3. When enabled, workgroup users can set
|
|
3995
4470
|
* encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.</p>
|
|
@@ -4002,18 +4477,22 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
4002
4477
|
*/
|
|
4003
4478
|
export interface UpdateWorkGroupInput {
|
|
4004
4479
|
/**
|
|
4480
|
+
* @public
|
|
4005
4481
|
* <p>The specified workgroup that will be updated.</p>
|
|
4006
4482
|
*/
|
|
4007
4483
|
WorkGroup: string | undefined;
|
|
4008
4484
|
/**
|
|
4485
|
+
* @public
|
|
4009
4486
|
* <p>The workgroup description.</p>
|
|
4010
4487
|
*/
|
|
4011
4488
|
Description?: string;
|
|
4012
4489
|
/**
|
|
4490
|
+
* @public
|
|
4013
4491
|
* <p>Contains configuration updates for an Athena SQL workgroup.</p>
|
|
4014
4492
|
*/
|
|
4015
4493
|
ConfigurationUpdates?: WorkGroupConfigurationUpdates;
|
|
4016
4494
|
/**
|
|
4495
|
+
* @public
|
|
4017
4496
|
* <p>The workgroup state that will be updated for the given workgroup.</p>
|
|
4018
4497
|
*/
|
|
4019
4498
|
State?: WorkGroupState | string;
|
|
@@ -4029,20 +4508,24 @@ export interface UpdateWorkGroupOutput {
|
|
|
4029
4508
|
*/
|
|
4030
4509
|
export interface QueryStagePlanNode {
|
|
4031
4510
|
/**
|
|
4511
|
+
* @public
|
|
4032
4512
|
* <p>Name of the query stage plan that describes the operation this stage is performing as
|
|
4033
4513
|
* part of query execution.</p>
|
|
4034
4514
|
*/
|
|
4035
4515
|
Name?: string;
|
|
4036
4516
|
/**
|
|
4517
|
+
* @public
|
|
4037
4518
|
* <p>Information about the operation this query stage plan node is performing.</p>
|
|
4038
4519
|
*/
|
|
4039
4520
|
Identifier?: string;
|
|
4040
4521
|
/**
|
|
4522
|
+
* @public
|
|
4041
4523
|
* <p>Stage plan information such as name, identifier, sub plans, and remote sources of
|
|
4042
4524
|
* child plan nodes/</p>
|
|
4043
4525
|
*/
|
|
4044
4526
|
Children?: QueryStagePlanNode[];
|
|
4045
4527
|
/**
|
|
4528
|
+
* @public
|
|
4046
4529
|
* <p>Source plan node IDs.</p>
|
|
4047
4530
|
*/
|
|
4048
4531
|
RemoteSources?: string[];
|
|
@@ -4054,38 +4537,47 @@ export interface QueryStagePlanNode {
|
|
|
4054
4537
|
*/
|
|
4055
4538
|
export interface QueryStage {
|
|
4056
4539
|
/**
|
|
4540
|
+
* @public
|
|
4057
4541
|
* <p>The identifier for a stage.</p>
|
|
4058
4542
|
*/
|
|
4059
4543
|
StageId?: number;
|
|
4060
4544
|
/**
|
|
4545
|
+
* @public
|
|
4061
4546
|
* <p>State of the stage after query execution.</p>
|
|
4062
4547
|
*/
|
|
4063
4548
|
State?: string;
|
|
4064
4549
|
/**
|
|
4550
|
+
* @public
|
|
4065
4551
|
* <p>The number of bytes output from the stage after execution.</p>
|
|
4066
4552
|
*/
|
|
4067
4553
|
OutputBytes?: number;
|
|
4068
4554
|
/**
|
|
4555
|
+
* @public
|
|
4069
4556
|
* <p>The number of rows output from the stage after execution.</p>
|
|
4070
4557
|
*/
|
|
4071
4558
|
OutputRows?: number;
|
|
4072
4559
|
/**
|
|
4560
|
+
* @public
|
|
4073
4561
|
* <p>The number of bytes input into the stage for execution.</p>
|
|
4074
4562
|
*/
|
|
4075
4563
|
InputBytes?: number;
|
|
4076
4564
|
/**
|
|
4565
|
+
* @public
|
|
4077
4566
|
* <p>The number of rows input into the stage for execution.</p>
|
|
4078
4567
|
*/
|
|
4079
4568
|
InputRows?: number;
|
|
4080
4569
|
/**
|
|
4570
|
+
* @public
|
|
4081
4571
|
* <p>Time taken to execute this stage.</p>
|
|
4082
4572
|
*/
|
|
4083
4573
|
ExecutionTime?: number;
|
|
4084
4574
|
/**
|
|
4575
|
+
* @public
|
|
4085
4576
|
* <p>Stage plan information such as name, identifier, sub plans, and source stages.</p>
|
|
4086
4577
|
*/
|
|
4087
4578
|
QueryStagePlan?: QueryStagePlanNode;
|
|
4088
4579
|
/**
|
|
4580
|
+
* @public
|
|
4089
4581
|
* <p>List of sub query stages that form this stage execution plan.</p>
|
|
4090
4582
|
*/
|
|
4091
4583
|
SubStages?: QueryStage[];
|
|
@@ -4097,16 +4589,19 @@ export interface QueryStage {
|
|
|
4097
4589
|
*/
|
|
4098
4590
|
export interface QueryRuntimeStatistics {
|
|
4099
4591
|
/**
|
|
4592
|
+
* @public
|
|
4100
4593
|
* <p>Timeline statistics such as query queue time, planning time, execution time, service
|
|
4101
4594
|
* processing time, and total execution time.</p>
|
|
4102
4595
|
*/
|
|
4103
4596
|
Timeline?: QueryRuntimeStatisticsTimeline;
|
|
4104
4597
|
/**
|
|
4598
|
+
* @public
|
|
4105
4599
|
* <p>Statistics such as input rows and bytes read by the query, rows and bytes output by
|
|
4106
4600
|
* the query, and the number of rows written by the query.</p>
|
|
4107
4601
|
*/
|
|
4108
4602
|
Rows?: QueryRuntimeStatisticsRows;
|
|
4109
4603
|
/**
|
|
4604
|
+
* @public
|
|
4110
4605
|
* <p>Stage statistics such as input and output rows and bytes, execution time, and stage
|
|
4111
4606
|
* state. This information also includes substages and the query stage plan.</p>
|
|
4112
4607
|
*/
|
|
@@ -4117,6 +4612,7 @@ export interface QueryRuntimeStatistics {
|
|
|
4117
4612
|
*/
|
|
4118
4613
|
export interface GetQueryRuntimeStatisticsOutput {
|
|
4119
4614
|
/**
|
|
4615
|
+
* @public
|
|
4120
4616
|
* <p>Runtime statistics about the query execution.</p>
|
|
4121
4617
|
*/
|
|
4122
4618
|
QueryRuntimeStatistics?: QueryRuntimeStatistics;
|