@aws-sdk/client-athena 3.295.0 → 3.297.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/Athena.d.ts +61 -0
- package/dist-types/AthenaClient.d.ts +24 -4
- package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +16 -0
- package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +16 -0
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +16 -0
- package/dist-types/commands/CreateDataCatalogCommand.d.ts +16 -0
- package/dist-types/commands/CreateNamedQueryCommand.d.ts +16 -0
- package/dist-types/commands/CreateNotebookCommand.d.ts +16 -0
- package/dist-types/commands/CreatePreparedStatementCommand.d.ts +16 -0
- package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +16 -0
- package/dist-types/commands/CreateWorkGroupCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDataCatalogCommand.d.ts +16 -0
- package/dist-types/commands/DeleteNamedQueryCommand.d.ts +16 -0
- package/dist-types/commands/DeleteNotebookCommand.d.ts +16 -0
- package/dist-types/commands/DeletePreparedStatementCommand.d.ts +16 -0
- package/dist-types/commands/DeleteWorkGroupCommand.d.ts +16 -0
- package/dist-types/commands/ExportNotebookCommand.d.ts +16 -0
- package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +16 -0
- package/dist-types/commands/GetCalculationExecutionCommand.d.ts +16 -0
- package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetDataCatalogCommand.d.ts +16 -0
- package/dist-types/commands/GetDatabaseCommand.d.ts +16 -0
- package/dist-types/commands/GetNamedQueryCommand.d.ts +16 -0
- package/dist-types/commands/GetNotebookMetadataCommand.d.ts +16 -0
- package/dist-types/commands/GetPreparedStatementCommand.d.ts +16 -0
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +16 -0
- package/dist-types/commands/GetQueryResultsCommand.d.ts +16 -0
- package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +16 -0
- package/dist-types/commands/GetSessionCommand.d.ts +16 -0
- package/dist-types/commands/GetSessionStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetTableMetadataCommand.d.ts +16 -0
- package/dist-types/commands/GetWorkGroupCommand.d.ts +16 -0
- package/dist-types/commands/ImportNotebookCommand.d.ts +16 -0
- package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +16 -0
- package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +16 -0
- package/dist-types/commands/ListDataCatalogsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatabasesCommand.d.ts +16 -0
- package/dist-types/commands/ListEngineVersionsCommand.d.ts +16 -0
- package/dist-types/commands/ListExecutorsCommand.d.ts +16 -0
- package/dist-types/commands/ListNamedQueriesCommand.d.ts +16 -0
- package/dist-types/commands/ListNotebookMetadataCommand.d.ts +16 -0
- package/dist-types/commands/ListNotebookSessionsCommand.d.ts +16 -0
- package/dist-types/commands/ListPreparedStatementsCommand.d.ts +16 -0
- package/dist-types/commands/ListQueryExecutionsCommand.d.ts +16 -0
- package/dist-types/commands/ListSessionsCommand.d.ts +16 -0
- package/dist-types/commands/ListTableMetadataCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListWorkGroupsCommand.d.ts +16 -0
- package/dist-types/commands/StartCalculationExecutionCommand.d.ts +16 -0
- package/dist-types/commands/StartQueryExecutionCommand.d.ts +16 -0
- package/dist-types/commands/StartSessionCommand.d.ts +16 -0
- package/dist-types/commands/StopCalculationExecutionCommand.d.ts +16 -0
- package/dist-types/commands/StopQueryExecutionCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/TerminateSessionCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataCatalogCommand.d.ts +16 -0
- package/dist-types/commands/UpdateNamedQueryCommand.d.ts +16 -0
- package/dist-types/commands/UpdateNotebookCommand.d.ts +16 -0
- package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +16 -0
- package/dist-types/commands/UpdateWorkGroupCommand.d.ts +16 -0
- package/dist-types/models/AthenaServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +456 -0
- package/dist-types/pagination/GetQueryResultsPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListApplicationDPUSizesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListCalculationExecutionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDataCatalogsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatabasesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListEngineVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListExecutorsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListNamedQueriesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPreparedStatementsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListQueryExecutionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSessionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListTableMetadataPaginator.d.ts +3 -0
- package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
- package/dist-types/pagination/ListWorkGroupsPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { AthenaServiceException as __BaseException } from "./AthenaServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
3
6
|
export declare enum S3AclOption {
|
|
4
7
|
BUCKET_OWNER_FULL_CONTROL = "BUCKET_OWNER_FULL_CONTROL"
|
|
5
8
|
}
|
|
6
9
|
/**
|
|
10
|
+
* @public
|
|
7
11
|
* <p>Indicates that an Amazon S3 canned ACL should be set to control ownership of
|
|
8
12
|
* stored query results. When Athena stores query results in Amazon S3,
|
|
9
13
|
* the canned ACL is set with the <code>x-amz-acl</code> request header. For more
|
|
@@ -22,6 +26,7 @@ export interface AclConfiguration {
|
|
|
22
26
|
S3AclOption: S3AclOption | string | undefined;
|
|
23
27
|
}
|
|
24
28
|
/**
|
|
29
|
+
* @public
|
|
25
30
|
* <p>Contains an array of named query IDs.</p>
|
|
26
31
|
*/
|
|
27
32
|
export interface BatchGetNamedQueryInput {
|
|
@@ -31,6 +36,7 @@ export interface BatchGetNamedQueryInput {
|
|
|
31
36
|
NamedQueryIds: string[] | undefined;
|
|
32
37
|
}
|
|
33
38
|
/**
|
|
39
|
+
* @public
|
|
34
40
|
* <p>A query, where <code>QueryString</code> contains the SQL statements that make up the
|
|
35
41
|
* query.</p>
|
|
36
42
|
*/
|
|
@@ -61,6 +67,7 @@ export interface NamedQuery {
|
|
|
61
67
|
WorkGroup?: string;
|
|
62
68
|
}
|
|
63
69
|
/**
|
|
70
|
+
* @public
|
|
64
71
|
* <p>Information about a named query ID that could not be processed.</p>
|
|
65
72
|
*/
|
|
66
73
|
export interface UnprocessedNamedQueryId {
|
|
@@ -79,6 +86,9 @@ export interface UnprocessedNamedQueryId {
|
|
|
79
86
|
*/
|
|
80
87
|
ErrorMessage?: string;
|
|
81
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
82
92
|
export interface BatchGetNamedQueryOutput {
|
|
83
93
|
/**
|
|
84
94
|
* <p>Information about the named query IDs submitted.</p>
|
|
@@ -90,6 +100,7 @@ export interface BatchGetNamedQueryOutput {
|
|
|
90
100
|
UnprocessedNamedQueryIds?: UnprocessedNamedQueryId[];
|
|
91
101
|
}
|
|
92
102
|
/**
|
|
103
|
+
* @public
|
|
93
104
|
* <p>Indicates a platform issue, which may be due to a transient condition or
|
|
94
105
|
* outage.</p>
|
|
95
106
|
*/
|
|
@@ -103,6 +114,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
103
114
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
104
115
|
}
|
|
105
116
|
/**
|
|
117
|
+
* @public
|
|
106
118
|
* <p>Indicates that something is wrong with the input to the request. For example, a
|
|
107
119
|
* required parameter may be missing or out of range.</p>
|
|
108
120
|
*/
|
|
@@ -120,6 +132,9 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
120
132
|
*/
|
|
121
133
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
122
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
123
138
|
export interface BatchGetPreparedStatementInput {
|
|
124
139
|
/**
|
|
125
140
|
* <p>A list of prepared statement names to return.</p>
|
|
@@ -131,6 +146,7 @@ export interface BatchGetPreparedStatementInput {
|
|
|
131
146
|
WorkGroup: string | undefined;
|
|
132
147
|
}
|
|
133
148
|
/**
|
|
149
|
+
* @public
|
|
134
150
|
* <p>A prepared SQL statement for use with Athena.</p>
|
|
135
151
|
*/
|
|
136
152
|
export interface PreparedStatement {
|
|
@@ -156,6 +172,7 @@ export interface PreparedStatement {
|
|
|
156
172
|
LastModifiedTime?: Date;
|
|
157
173
|
}
|
|
158
174
|
/**
|
|
175
|
+
* @public
|
|
159
176
|
* <p>The name of a prepared statement that could not be returned.</p>
|
|
160
177
|
*/
|
|
161
178
|
export interface UnprocessedPreparedStatementName {
|
|
@@ -190,6 +207,9 @@ export interface UnprocessedPreparedStatementName {
|
|
|
190
207
|
*/
|
|
191
208
|
ErrorMessage?: string;
|
|
192
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
193
213
|
export interface BatchGetPreparedStatementOutput {
|
|
194
214
|
/**
|
|
195
215
|
* <p>The list of prepared statements returned.</p>
|
|
@@ -202,6 +222,7 @@ export interface BatchGetPreparedStatementOutput {
|
|
|
202
222
|
UnprocessedPreparedStatementNames?: UnprocessedPreparedStatementName[];
|
|
203
223
|
}
|
|
204
224
|
/**
|
|
225
|
+
* @public
|
|
205
226
|
* <p>Contains an array of query execution IDs.</p>
|
|
206
227
|
*/
|
|
207
228
|
export interface BatchGetQueryExecutionInput {
|
|
@@ -211,6 +232,7 @@ export interface BatchGetQueryExecutionInput {
|
|
|
211
232
|
QueryExecutionIds: string[] | undefined;
|
|
212
233
|
}
|
|
213
234
|
/**
|
|
235
|
+
* @public
|
|
214
236
|
* <p>The Athena engine version for running queries, or the PySpark engine
|
|
215
237
|
* version for running sessions.</p>
|
|
216
238
|
*/
|
|
@@ -231,6 +253,7 @@ export interface EngineVersion {
|
|
|
231
253
|
EffectiveEngineVersion?: string;
|
|
232
254
|
}
|
|
233
255
|
/**
|
|
256
|
+
* @public
|
|
234
257
|
* <p>The database and data catalog context in which the query execution occurs.</p>
|
|
235
258
|
*/
|
|
236
259
|
export interface QueryExecutionContext {
|
|
@@ -244,12 +267,16 @@ export interface QueryExecutionContext {
|
|
|
244
267
|
*/
|
|
245
268
|
Catalog?: string;
|
|
246
269
|
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
247
273
|
export declare enum EncryptionOption {
|
|
248
274
|
CSE_KMS = "CSE_KMS",
|
|
249
275
|
SSE_KMS = "SSE_KMS",
|
|
250
276
|
SSE_S3 = "SSE_S3"
|
|
251
277
|
}
|
|
252
278
|
/**
|
|
279
|
+
* @public
|
|
253
280
|
* <p>If query results are encrypted in Amazon S3, indicates the encryption option
|
|
254
281
|
* used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key
|
|
255
282
|
* information.</p>
|
|
@@ -271,6 +298,7 @@ export interface EncryptionConfiguration {
|
|
|
271
298
|
KmsKey?: string;
|
|
272
299
|
}
|
|
273
300
|
/**
|
|
301
|
+
* @public
|
|
274
302
|
* <p>The location in Amazon S3 where query results are stored and the encryption
|
|
275
303
|
* option, if any, used for query results. These are known as "client-side settings". If
|
|
276
304
|
* workgroup settings override client-side settings, then the query uses the workgroup
|
|
@@ -320,6 +348,7 @@ export interface ResultConfiguration {
|
|
|
320
348
|
AclConfiguration?: AclConfiguration;
|
|
321
349
|
}
|
|
322
350
|
/**
|
|
351
|
+
* @public
|
|
323
352
|
* <p>Specifies whether previous query results are reused, and if so, their maximum age.</p>
|
|
324
353
|
*/
|
|
325
354
|
export interface ResultReuseByAgeConfiguration {
|
|
@@ -333,6 +362,7 @@ export interface ResultReuseByAgeConfiguration {
|
|
|
333
362
|
MaxAgeInMinutes?: number;
|
|
334
363
|
}
|
|
335
364
|
/**
|
|
365
|
+
* @public
|
|
336
366
|
* <p>Specifies the query result reuse behavior for the query.</p>
|
|
337
367
|
*/
|
|
338
368
|
export interface ResultReuseConfiguration {
|
|
@@ -341,12 +371,16 @@ export interface ResultReuseConfiguration {
|
|
|
341
371
|
*/
|
|
342
372
|
ResultReuseByAgeConfiguration?: ResultReuseByAgeConfiguration;
|
|
343
373
|
}
|
|
374
|
+
/**
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
344
377
|
export declare enum StatementType {
|
|
345
378
|
DDL = "DDL",
|
|
346
379
|
DML = "DML",
|
|
347
380
|
UTILITY = "UTILITY"
|
|
348
381
|
}
|
|
349
382
|
/**
|
|
383
|
+
* @public
|
|
350
384
|
* <p>Contains information about whether the result of a previous query was reused.</p>
|
|
351
385
|
*/
|
|
352
386
|
export interface ResultReuseInformation {
|
|
@@ -356,6 +390,7 @@ export interface ResultReuseInformation {
|
|
|
356
390
|
ReusedPreviousResult: boolean | undefined;
|
|
357
391
|
}
|
|
358
392
|
/**
|
|
393
|
+
* @public
|
|
359
394
|
* <p>The amount of data scanned during the query execution and the amount of time that it
|
|
360
395
|
* took to execute, and the type of statement that was run.</p>
|
|
361
396
|
*/
|
|
@@ -406,6 +441,7 @@ export interface QueryExecutionStatistics {
|
|
|
406
441
|
ResultReuseInformation?: ResultReuseInformation;
|
|
407
442
|
}
|
|
408
443
|
/**
|
|
444
|
+
* @public
|
|
409
445
|
* <p>Provides information about an Athena query error. The
|
|
410
446
|
* <code>AthenaError</code> feature provides standardized error information to help you
|
|
411
447
|
* understand failed queries and take steps after a query failure occurs.
|
|
@@ -440,6 +476,9 @@ export interface AthenaError {
|
|
|
440
476
|
*/
|
|
441
477
|
ErrorMessage?: string;
|
|
442
478
|
}
|
|
479
|
+
/**
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
443
482
|
export declare enum QueryExecutionState {
|
|
444
483
|
CANCELLED = "CANCELLED",
|
|
445
484
|
FAILED = "FAILED",
|
|
@@ -448,6 +487,7 @@ export declare enum QueryExecutionState {
|
|
|
448
487
|
SUCCEEDED = "SUCCEEDED"
|
|
449
488
|
}
|
|
450
489
|
/**
|
|
490
|
+
* @public
|
|
451
491
|
* <p>The completion date, current state, submission time, and state change reason (if
|
|
452
492
|
* applicable) for the query execution.</p>
|
|
453
493
|
*/
|
|
@@ -485,6 +525,7 @@ export interface QueryExecutionStatus {
|
|
|
485
525
|
AthenaError?: AthenaError;
|
|
486
526
|
}
|
|
487
527
|
/**
|
|
528
|
+
* @public
|
|
488
529
|
* <p>Information about a single instance of a query execution.</p>
|
|
489
530
|
*/
|
|
490
531
|
export interface QueryExecution {
|
|
@@ -549,6 +590,7 @@ export interface QueryExecution {
|
|
|
549
590
|
SubstatementType?: string;
|
|
550
591
|
}
|
|
551
592
|
/**
|
|
593
|
+
* @public
|
|
552
594
|
* <p>Describes a query execution that failed to process.</p>
|
|
553
595
|
*/
|
|
554
596
|
export interface UnprocessedQueryExecutionId {
|
|
@@ -567,6 +609,9 @@ export interface UnprocessedQueryExecutionId {
|
|
|
567
609
|
*/
|
|
568
610
|
ErrorMessage?: string;
|
|
569
611
|
}
|
|
612
|
+
/**
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
570
615
|
export interface BatchGetQueryExecutionOutput {
|
|
571
616
|
/**
|
|
572
617
|
* <p>Information about a query execution.</p>
|
|
@@ -578,6 +623,7 @@ export interface BatchGetQueryExecutionOutput {
|
|
|
578
623
|
UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionId[];
|
|
579
624
|
}
|
|
580
625
|
/**
|
|
626
|
+
* @public
|
|
581
627
|
* <p>A label that you assign to a resource. In Athena, a resource can be a
|
|
582
628
|
* workgroup or data catalog. Each tag consists of a key and an optional value, both of
|
|
583
629
|
* which you define. For example, you can use tags to categorize Athena
|
|
@@ -603,11 +649,17 @@ export interface Tag {
|
|
|
603
649
|
*/
|
|
604
650
|
Value?: string;
|
|
605
651
|
}
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
*/
|
|
606
655
|
export declare enum DataCatalogType {
|
|
607
656
|
GLUE = "GLUE",
|
|
608
657
|
HIVE = "HIVE",
|
|
609
658
|
LAMBDA = "LAMBDA"
|
|
610
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
611
663
|
export interface CreateDataCatalogInput {
|
|
612
664
|
/**
|
|
613
665
|
* <p>The name of the data catalog to create. The catalog name must be unique for the
|
|
@@ -702,8 +754,14 @@ export interface CreateDataCatalogInput {
|
|
|
702
754
|
*/
|
|
703
755
|
Tags?: Tag[];
|
|
704
756
|
}
|
|
757
|
+
/**
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
705
760
|
export interface CreateDataCatalogOutput {
|
|
706
761
|
}
|
|
762
|
+
/**
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
707
765
|
export interface CreateNamedQueryInput {
|
|
708
766
|
/**
|
|
709
767
|
* <p>The query name.</p>
|
|
@@ -739,12 +797,18 @@ export interface CreateNamedQueryInput {
|
|
|
739
797
|
*/
|
|
740
798
|
WorkGroup?: string;
|
|
741
799
|
}
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
*/
|
|
742
803
|
export interface CreateNamedQueryOutput {
|
|
743
804
|
/**
|
|
744
805
|
* <p>The unique ID of the query.</p>
|
|
745
806
|
*/
|
|
746
807
|
NamedQueryId?: string;
|
|
747
808
|
}
|
|
809
|
+
/**
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
748
812
|
export interface CreateNotebookInput {
|
|
749
813
|
/**
|
|
750
814
|
* <p>The name of the Spark enabled workgroup in which the notebook will be created.</p>
|
|
@@ -767,16 +831,23 @@ export interface CreateNotebookInput {
|
|
|
767
831
|
*/
|
|
768
832
|
ClientRequestToken?: string;
|
|
769
833
|
}
|
|
834
|
+
/**
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
770
837
|
export interface CreateNotebookOutput {
|
|
771
838
|
/**
|
|
772
839
|
* <p>A unique identifier for the notebook.</p>
|
|
773
840
|
*/
|
|
774
841
|
NotebookId?: string;
|
|
775
842
|
}
|
|
843
|
+
/**
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
776
846
|
export declare enum ThrottleReason {
|
|
777
847
|
CONCURRENT_QUERY_LIMIT_EXCEEDED = "CONCURRENT_QUERY_LIMIT_EXCEEDED"
|
|
778
848
|
}
|
|
779
849
|
/**
|
|
850
|
+
* @public
|
|
780
851
|
* <p>Indicates that the request was throttled.</p>
|
|
781
852
|
*/
|
|
782
853
|
export declare class TooManyRequestsException extends __BaseException {
|
|
@@ -793,6 +864,9 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
793
864
|
*/
|
|
794
865
|
constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
|
|
795
866
|
}
|
|
867
|
+
/**
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
796
870
|
export interface CreatePreparedStatementInput {
|
|
797
871
|
/**
|
|
798
872
|
* <p>The name of the prepared statement.</p>
|
|
@@ -811,14 +885,23 @@ export interface CreatePreparedStatementInput {
|
|
|
811
885
|
*/
|
|
812
886
|
Description?: string;
|
|
813
887
|
}
|
|
888
|
+
/**
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
814
891
|
export interface CreatePreparedStatementOutput {
|
|
815
892
|
}
|
|
893
|
+
/**
|
|
894
|
+
* @public
|
|
895
|
+
*/
|
|
816
896
|
export interface CreatePresignedNotebookUrlRequest {
|
|
817
897
|
/**
|
|
818
898
|
* <p>The session ID.</p>
|
|
819
899
|
*/
|
|
820
900
|
SessionId: string | undefined;
|
|
821
901
|
}
|
|
902
|
+
/**
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
822
905
|
export interface CreatePresignedNotebookUrlResponse {
|
|
823
906
|
/**
|
|
824
907
|
* <p>The URL of the notebook. The URL includes the authentication token and notebook file
|
|
@@ -835,6 +918,7 @@ export interface CreatePresignedNotebookUrlResponse {
|
|
|
835
918
|
AuthTokenExpirationTime: number | undefined;
|
|
836
919
|
}
|
|
837
920
|
/**
|
|
921
|
+
* @public
|
|
838
922
|
* <p>A resource, such as a workgroup, was not found.</p>
|
|
839
923
|
*/
|
|
840
924
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -851,6 +935,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
851
935
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
852
936
|
}
|
|
853
937
|
/**
|
|
938
|
+
* @public
|
|
854
939
|
* <p>Specifies the KMS key that is used to encrypt the user's data stores in Athena.</p>
|
|
855
940
|
*/
|
|
856
941
|
export interface CustomerContentEncryptionConfiguration {
|
|
@@ -860,6 +945,7 @@ export interface CustomerContentEncryptionConfiguration {
|
|
|
860
945
|
KmsKey: string | undefined;
|
|
861
946
|
}
|
|
862
947
|
/**
|
|
948
|
+
* @public
|
|
863
949
|
* <p>The configuration of the workgroup, which includes the location in Amazon S3
|
|
864
950
|
* where query results are stored, the encryption option, if any, used for query results,
|
|
865
951
|
* whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether
|
|
@@ -922,6 +1008,9 @@ export interface WorkGroupConfiguration {
|
|
|
922
1008
|
*/
|
|
923
1009
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
924
1010
|
}
|
|
1011
|
+
/**
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
925
1014
|
export interface CreateWorkGroupInput {
|
|
926
1015
|
/**
|
|
927
1016
|
* <p>The workgroup name.</p>
|
|
@@ -945,32 +1034,56 @@ export interface CreateWorkGroupInput {
|
|
|
945
1034
|
*/
|
|
946
1035
|
Tags?: Tag[];
|
|
947
1036
|
}
|
|
1037
|
+
/**
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
948
1040
|
export interface CreateWorkGroupOutput {
|
|
949
1041
|
}
|
|
1042
|
+
/**
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
950
1045
|
export interface DeleteDataCatalogInput {
|
|
951
1046
|
/**
|
|
952
1047
|
* <p>The name of the data catalog to delete.</p>
|
|
953
1048
|
*/
|
|
954
1049
|
Name: string | undefined;
|
|
955
1050
|
}
|
|
1051
|
+
/**
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
956
1054
|
export interface DeleteDataCatalogOutput {
|
|
957
1055
|
}
|
|
1056
|
+
/**
|
|
1057
|
+
* @public
|
|
1058
|
+
*/
|
|
958
1059
|
export interface DeleteNamedQueryInput {
|
|
959
1060
|
/**
|
|
960
1061
|
* <p>The unique ID of the query to delete.</p>
|
|
961
1062
|
*/
|
|
962
1063
|
NamedQueryId?: string;
|
|
963
1064
|
}
|
|
1065
|
+
/**
|
|
1066
|
+
* @public
|
|
1067
|
+
*/
|
|
964
1068
|
export interface DeleteNamedQueryOutput {
|
|
965
1069
|
}
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
*/
|
|
966
1073
|
export interface DeleteNotebookInput {
|
|
967
1074
|
/**
|
|
968
1075
|
* <p>The ID of the notebook to delete.</p>
|
|
969
1076
|
*/
|
|
970
1077
|
NotebookId: string | undefined;
|
|
971
1078
|
}
|
|
1079
|
+
/**
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
972
1082
|
export interface DeleteNotebookOutput {
|
|
973
1083
|
}
|
|
1084
|
+
/**
|
|
1085
|
+
* @public
|
|
1086
|
+
*/
|
|
974
1087
|
export interface DeletePreparedStatementInput {
|
|
975
1088
|
/**
|
|
976
1089
|
* <p>The name of the prepared statement to delete.</p>
|
|
@@ -981,8 +1094,14 @@ export interface DeletePreparedStatementInput {
|
|
|
981
1094
|
*/
|
|
982
1095
|
WorkGroup: string | undefined;
|
|
983
1096
|
}
|
|
1097
|
+
/**
|
|
1098
|
+
* @public
|
|
1099
|
+
*/
|
|
984
1100
|
export interface DeletePreparedStatementOutput {
|
|
985
1101
|
}
|
|
1102
|
+
/**
|
|
1103
|
+
* @public
|
|
1104
|
+
*/
|
|
986
1105
|
export interface DeleteWorkGroupInput {
|
|
987
1106
|
/**
|
|
988
1107
|
* <p>The unique name of the workgroup to delete.</p>
|
|
@@ -994,18 +1113,28 @@ export interface DeleteWorkGroupInput {
|
|
|
994
1113
|
*/
|
|
995
1114
|
RecursiveDeleteOption?: boolean;
|
|
996
1115
|
}
|
|
1116
|
+
/**
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
997
1119
|
export interface DeleteWorkGroupOutput {
|
|
998
1120
|
}
|
|
1121
|
+
/**
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
999
1124
|
export interface ExportNotebookInput {
|
|
1000
1125
|
/**
|
|
1001
1126
|
* <p>The ID of the notebook to export.</p>
|
|
1002
1127
|
*/
|
|
1003
1128
|
NotebookId: string | undefined;
|
|
1004
1129
|
}
|
|
1130
|
+
/**
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1005
1133
|
export declare enum NotebookType {
|
|
1006
1134
|
IPYNB = "IPYNB"
|
|
1007
1135
|
}
|
|
1008
1136
|
/**
|
|
1137
|
+
* @public
|
|
1009
1138
|
* <p>Contains metadata for notebook, including the notebook name, ID, workgroup, and time
|
|
1010
1139
|
* created.</p>
|
|
1011
1140
|
*/
|
|
@@ -1035,6 +1164,9 @@ export interface NotebookMetadata {
|
|
|
1035
1164
|
*/
|
|
1036
1165
|
LastModifiedTime?: Date;
|
|
1037
1166
|
}
|
|
1167
|
+
/**
|
|
1168
|
+
* @public
|
|
1169
|
+
*/
|
|
1038
1170
|
export interface ExportNotebookOutput {
|
|
1039
1171
|
/**
|
|
1040
1172
|
* <p>The notebook metadata, including notebook ID, notebook name, and workgroup
|
|
@@ -1046,6 +1178,9 @@ export interface ExportNotebookOutput {
|
|
|
1046
1178
|
*/
|
|
1047
1179
|
Payload?: string;
|
|
1048
1180
|
}
|
|
1181
|
+
/**
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1049
1184
|
export interface GetCalculationExecutionRequest {
|
|
1050
1185
|
/**
|
|
1051
1186
|
* <p>The calculation execution UUID.</p>
|
|
@@ -1053,6 +1188,7 @@ export interface GetCalculationExecutionRequest {
|
|
|
1053
1188
|
CalculationExecutionId: string | undefined;
|
|
1054
1189
|
}
|
|
1055
1190
|
/**
|
|
1191
|
+
* @public
|
|
1056
1192
|
* <p>Contains information about an application-specific calculation result.</p>
|
|
1057
1193
|
*/
|
|
1058
1194
|
export interface CalculationResult {
|
|
@@ -1075,6 +1211,7 @@ export interface CalculationResult {
|
|
|
1075
1211
|
ResultType?: string;
|
|
1076
1212
|
}
|
|
1077
1213
|
/**
|
|
1214
|
+
* @public
|
|
1078
1215
|
* <p>Contains statistics for a notebook calculation.</p>
|
|
1079
1216
|
*/
|
|
1080
1217
|
export interface CalculationStatistics {
|
|
@@ -1087,6 +1224,9 @@ export interface CalculationStatistics {
|
|
|
1087
1224
|
*/
|
|
1088
1225
|
Progress?: string;
|
|
1089
1226
|
}
|
|
1227
|
+
/**
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1090
1230
|
export declare enum CalculationExecutionState {
|
|
1091
1231
|
CANCELED = "CANCELED",
|
|
1092
1232
|
CANCELING = "CANCELING",
|
|
@@ -1098,6 +1238,7 @@ export declare enum CalculationExecutionState {
|
|
|
1098
1238
|
RUNNING = "RUNNING"
|
|
1099
1239
|
}
|
|
1100
1240
|
/**
|
|
1241
|
+
* @public
|
|
1101
1242
|
* <p>Contains information about the status of a notebook calculation.</p>
|
|
1102
1243
|
*/
|
|
1103
1244
|
export interface CalculationStatus {
|
|
@@ -1137,6 +1278,9 @@ export interface CalculationStatus {
|
|
|
1137
1278
|
*/
|
|
1138
1279
|
StateChangeReason?: string;
|
|
1139
1280
|
}
|
|
1281
|
+
/**
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1140
1284
|
export interface GetCalculationExecutionResponse {
|
|
1141
1285
|
/**
|
|
1142
1286
|
* <p>The calculation execution UUID.</p>
|
|
@@ -1169,24 +1313,36 @@ export interface GetCalculationExecutionResponse {
|
|
|
1169
1313
|
*/
|
|
1170
1314
|
Result?: CalculationResult;
|
|
1171
1315
|
}
|
|
1316
|
+
/**
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1172
1319
|
export interface GetCalculationExecutionCodeRequest {
|
|
1173
1320
|
/**
|
|
1174
1321
|
* <p>The calculation execution UUID.</p>
|
|
1175
1322
|
*/
|
|
1176
1323
|
CalculationExecutionId: string | undefined;
|
|
1177
1324
|
}
|
|
1325
|
+
/**
|
|
1326
|
+
* @public
|
|
1327
|
+
*/
|
|
1178
1328
|
export interface GetCalculationExecutionCodeResponse {
|
|
1179
1329
|
/**
|
|
1180
1330
|
* <p>A pre-signed URL to the code that executed the calculation.</p>
|
|
1181
1331
|
*/
|
|
1182
1332
|
CodeBlock?: string;
|
|
1183
1333
|
}
|
|
1334
|
+
/**
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1184
1337
|
export interface GetCalculationExecutionStatusRequest {
|
|
1185
1338
|
/**
|
|
1186
1339
|
* <p>The calculation execution UUID.</p>
|
|
1187
1340
|
*/
|
|
1188
1341
|
CalculationExecutionId: string | undefined;
|
|
1189
1342
|
}
|
|
1343
|
+
/**
|
|
1344
|
+
* @public
|
|
1345
|
+
*/
|
|
1190
1346
|
export interface GetCalculationExecutionStatusResponse {
|
|
1191
1347
|
/**
|
|
1192
1348
|
* <p>Contains information about the calculation execution status.</p>
|
|
@@ -1197,6 +1353,9 @@ export interface GetCalculationExecutionStatusResponse {
|
|
|
1197
1353
|
*/
|
|
1198
1354
|
Statistics?: CalculationStatistics;
|
|
1199
1355
|
}
|
|
1356
|
+
/**
|
|
1357
|
+
* @public
|
|
1358
|
+
*/
|
|
1200
1359
|
export interface GetDatabaseInput {
|
|
1201
1360
|
/**
|
|
1202
1361
|
* <p>The name of the data catalog that contains the database to return.</p>
|
|
@@ -1208,6 +1367,7 @@ export interface GetDatabaseInput {
|
|
|
1208
1367
|
DatabaseName: string | undefined;
|
|
1209
1368
|
}
|
|
1210
1369
|
/**
|
|
1370
|
+
* @public
|
|
1211
1371
|
* <p>Contains metadata information for a database in a data catalog.</p>
|
|
1212
1372
|
*/
|
|
1213
1373
|
export interface Database {
|
|
@@ -1224,6 +1384,9 @@ export interface Database {
|
|
|
1224
1384
|
*/
|
|
1225
1385
|
Parameters?: Record<string, string>;
|
|
1226
1386
|
}
|
|
1387
|
+
/**
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1227
1390
|
export interface GetDatabaseOutput {
|
|
1228
1391
|
/**
|
|
1229
1392
|
* <p>The database returned.</p>
|
|
@@ -1231,6 +1394,7 @@ export interface GetDatabaseOutput {
|
|
|
1231
1394
|
Database?: Database;
|
|
1232
1395
|
}
|
|
1233
1396
|
/**
|
|
1397
|
+
* @public
|
|
1234
1398
|
* <p>An exception that Athena received when it called a custom metastore.
|
|
1235
1399
|
* Occurs if the error is not caused by user input (<code>InvalidRequestException</code>)
|
|
1236
1400
|
* or from the Athena platform (<code>InternalServerException</code>). For
|
|
@@ -1247,6 +1411,9 @@ export declare class MetadataException extends __BaseException {
|
|
|
1247
1411
|
*/
|
|
1248
1412
|
constructor(opts: __ExceptionOptionType<MetadataException, __BaseException>);
|
|
1249
1413
|
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1250
1417
|
export interface GetDataCatalogInput {
|
|
1251
1418
|
/**
|
|
1252
1419
|
* <p>The name of the data catalog to return.</p>
|
|
@@ -1254,6 +1421,7 @@ export interface GetDataCatalogInput {
|
|
|
1254
1421
|
Name: string | undefined;
|
|
1255
1422
|
}
|
|
1256
1423
|
/**
|
|
1424
|
+
* @public
|
|
1257
1425
|
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1258
1426
|
* <note>
|
|
1259
1427
|
* <p>In the Athena console, data catalogs are listed as "data sources" on the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
@@ -1343,12 +1511,18 @@ export interface DataCatalog {
|
|
|
1343
1511
|
*/
|
|
1344
1512
|
Parameters?: Record<string, string>;
|
|
1345
1513
|
}
|
|
1514
|
+
/**
|
|
1515
|
+
* @public
|
|
1516
|
+
*/
|
|
1346
1517
|
export interface GetDataCatalogOutput {
|
|
1347
1518
|
/**
|
|
1348
1519
|
* <p>The data catalog returned.</p>
|
|
1349
1520
|
*/
|
|
1350
1521
|
DataCatalog?: DataCatalog;
|
|
1351
1522
|
}
|
|
1523
|
+
/**
|
|
1524
|
+
* @public
|
|
1525
|
+
*/
|
|
1352
1526
|
export interface GetNamedQueryInput {
|
|
1353
1527
|
/**
|
|
1354
1528
|
* <p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query
|
|
@@ -1356,24 +1530,36 @@ export interface GetNamedQueryInput {
|
|
|
1356
1530
|
*/
|
|
1357
1531
|
NamedQueryId: string | undefined;
|
|
1358
1532
|
}
|
|
1533
|
+
/**
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1359
1536
|
export interface GetNamedQueryOutput {
|
|
1360
1537
|
/**
|
|
1361
1538
|
* <p>Information about the query.</p>
|
|
1362
1539
|
*/
|
|
1363
1540
|
NamedQuery?: NamedQuery;
|
|
1364
1541
|
}
|
|
1542
|
+
/**
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1365
1545
|
export interface GetNotebookMetadataInput {
|
|
1366
1546
|
/**
|
|
1367
1547
|
* <p>The ID of the notebook whose metadata is to be retrieved.</p>
|
|
1368
1548
|
*/
|
|
1369
1549
|
NotebookId: string | undefined;
|
|
1370
1550
|
}
|
|
1551
|
+
/**
|
|
1552
|
+
* @public
|
|
1553
|
+
*/
|
|
1371
1554
|
export interface GetNotebookMetadataOutput {
|
|
1372
1555
|
/**
|
|
1373
1556
|
* <p>The metadata that is returned for the specified notebook ID.</p>
|
|
1374
1557
|
*/
|
|
1375
1558
|
NotebookMetadata?: NotebookMetadata;
|
|
1376
1559
|
}
|
|
1560
|
+
/**
|
|
1561
|
+
* @public
|
|
1562
|
+
*/
|
|
1377
1563
|
export interface GetPreparedStatementInput {
|
|
1378
1564
|
/**
|
|
1379
1565
|
* <p>The name of the prepared statement to retrieve.</p>
|
|
@@ -1384,24 +1570,36 @@ export interface GetPreparedStatementInput {
|
|
|
1384
1570
|
*/
|
|
1385
1571
|
WorkGroup: string | undefined;
|
|
1386
1572
|
}
|
|
1573
|
+
/**
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1387
1576
|
export interface GetPreparedStatementOutput {
|
|
1388
1577
|
/**
|
|
1389
1578
|
* <p>The name of the prepared statement that was retrieved.</p>
|
|
1390
1579
|
*/
|
|
1391
1580
|
PreparedStatement?: PreparedStatement;
|
|
1392
1581
|
}
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
*/
|
|
1393
1585
|
export interface GetQueryExecutionInput {
|
|
1394
1586
|
/**
|
|
1395
1587
|
* <p>The unique ID of the query execution.</p>
|
|
1396
1588
|
*/
|
|
1397
1589
|
QueryExecutionId: string | undefined;
|
|
1398
1590
|
}
|
|
1591
|
+
/**
|
|
1592
|
+
* @public
|
|
1593
|
+
*/
|
|
1399
1594
|
export interface GetQueryExecutionOutput {
|
|
1400
1595
|
/**
|
|
1401
1596
|
* <p>Information about the query execution.</p>
|
|
1402
1597
|
*/
|
|
1403
1598
|
QueryExecution?: QueryExecution;
|
|
1404
1599
|
}
|
|
1600
|
+
/**
|
|
1601
|
+
* @public
|
|
1602
|
+
*/
|
|
1405
1603
|
export interface GetQueryResultsInput {
|
|
1406
1604
|
/**
|
|
1407
1605
|
* <p>The unique ID of the query execution.</p>
|
|
@@ -1418,12 +1616,16 @@ export interface GetQueryResultsInput {
|
|
|
1418
1616
|
*/
|
|
1419
1617
|
MaxResults?: number;
|
|
1420
1618
|
}
|
|
1619
|
+
/**
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1421
1622
|
export declare enum ColumnNullable {
|
|
1422
1623
|
NOT_NULL = "NOT_NULL",
|
|
1423
1624
|
NULLABLE = "NULLABLE",
|
|
1424
1625
|
UNKNOWN = "UNKNOWN"
|
|
1425
1626
|
}
|
|
1426
1627
|
/**
|
|
1628
|
+
* @public
|
|
1427
1629
|
* <p>Information about the columns in a query execution result.</p>
|
|
1428
1630
|
*/
|
|
1429
1631
|
export interface ColumnInfo {
|
|
@@ -1471,6 +1673,7 @@ export interface ColumnInfo {
|
|
|
1471
1673
|
CaseSensitive?: boolean;
|
|
1472
1674
|
}
|
|
1473
1675
|
/**
|
|
1676
|
+
* @public
|
|
1474
1677
|
* <p>The metadata that describes the column structure and data types of a table of query
|
|
1475
1678
|
* results. To return a <code>ResultSetMetadata</code> object, use <a>GetQueryResults</a>.</p>
|
|
1476
1679
|
*/
|
|
@@ -1481,6 +1684,7 @@ export interface ResultSetMetadata {
|
|
|
1481
1684
|
ColumnInfo?: ColumnInfo[];
|
|
1482
1685
|
}
|
|
1483
1686
|
/**
|
|
1687
|
+
* @public
|
|
1484
1688
|
* <p>A piece of data (a field in the table).</p>
|
|
1485
1689
|
*/
|
|
1486
1690
|
export interface Datum {
|
|
@@ -1490,6 +1694,7 @@ export interface Datum {
|
|
|
1490
1694
|
VarCharValue?: string;
|
|
1491
1695
|
}
|
|
1492
1696
|
/**
|
|
1697
|
+
* @public
|
|
1493
1698
|
* <p>The rows that make up a query result table.</p>
|
|
1494
1699
|
*/
|
|
1495
1700
|
export interface Row {
|
|
@@ -1499,6 +1704,7 @@ export interface Row {
|
|
|
1499
1704
|
Data?: Datum[];
|
|
1500
1705
|
}
|
|
1501
1706
|
/**
|
|
1707
|
+
* @public
|
|
1502
1708
|
* <p>The metadata and rows that make up a query result set. The metadata describes the
|
|
1503
1709
|
* column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>
|
|
1504
1710
|
*/
|
|
@@ -1513,6 +1719,9 @@ export interface ResultSet {
|
|
|
1513
1719
|
*/
|
|
1514
1720
|
ResultSetMetadata?: ResultSetMetadata;
|
|
1515
1721
|
}
|
|
1722
|
+
/**
|
|
1723
|
+
* @public
|
|
1724
|
+
*/
|
|
1516
1725
|
export interface GetQueryResultsOutput {
|
|
1517
1726
|
/**
|
|
1518
1727
|
* <p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement.
|
|
@@ -1530,6 +1739,9 @@ export interface GetQueryResultsOutput {
|
|
|
1530
1739
|
*/
|
|
1531
1740
|
NextToken?: string;
|
|
1532
1741
|
}
|
|
1742
|
+
/**
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1533
1745
|
export interface GetQueryRuntimeStatisticsInput {
|
|
1534
1746
|
/**
|
|
1535
1747
|
* <p>The unique ID of the query execution.</p>
|
|
@@ -1537,6 +1749,7 @@ export interface GetQueryRuntimeStatisticsInput {
|
|
|
1537
1749
|
QueryExecutionId: string | undefined;
|
|
1538
1750
|
}
|
|
1539
1751
|
/**
|
|
1752
|
+
* @public
|
|
1540
1753
|
* <p>Statistics such as input rows and bytes read by the query, rows and bytes output by
|
|
1541
1754
|
* the query, and the number of rows written by the query.</p>
|
|
1542
1755
|
*/
|
|
@@ -1559,6 +1772,7 @@ export interface QueryRuntimeStatisticsRows {
|
|
|
1559
1772
|
OutputRows?: number;
|
|
1560
1773
|
}
|
|
1561
1774
|
/**
|
|
1775
|
+
* @public
|
|
1562
1776
|
* <p>Timeline statistics such as query queue time, planning time, execution time, service
|
|
1563
1777
|
* processing time, and total execution time.</p>
|
|
1564
1778
|
*/
|
|
@@ -1590,6 +1804,9 @@ export interface QueryRuntimeStatisticsTimeline {
|
|
|
1590
1804
|
*/
|
|
1591
1805
|
TotalExecutionTimeInMillis?: number;
|
|
1592
1806
|
}
|
|
1807
|
+
/**
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1593
1810
|
export interface GetSessionRequest {
|
|
1594
1811
|
/**
|
|
1595
1812
|
* <p>The session ID.</p>
|
|
@@ -1597,6 +1814,7 @@ export interface GetSessionRequest {
|
|
|
1597
1814
|
SessionId: string | undefined;
|
|
1598
1815
|
}
|
|
1599
1816
|
/**
|
|
1817
|
+
* @public
|
|
1600
1818
|
* <p>Contains data processing unit (DPU) configuration settings and parameter mappings for
|
|
1601
1819
|
* a notebook engine.</p>
|
|
1602
1820
|
*/
|
|
@@ -1626,6 +1844,7 @@ export interface EngineConfiguration {
|
|
|
1626
1844
|
AdditionalConfigs?: Record<string, string>;
|
|
1627
1845
|
}
|
|
1628
1846
|
/**
|
|
1847
|
+
* @public
|
|
1629
1848
|
* <p>Contains session configuration information.</p>
|
|
1630
1849
|
*/
|
|
1631
1850
|
export interface SessionConfiguration {
|
|
@@ -1649,6 +1868,7 @@ export interface SessionConfiguration {
|
|
|
1649
1868
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
1650
1869
|
}
|
|
1651
1870
|
/**
|
|
1871
|
+
* @public
|
|
1652
1872
|
* <p>Contains statistics for a notebook session.</p>
|
|
1653
1873
|
*/
|
|
1654
1874
|
export interface SessionStatistics {
|
|
@@ -1657,6 +1877,9 @@ export interface SessionStatistics {
|
|
|
1657
1877
|
*/
|
|
1658
1878
|
DpuExecutionInMillis?: number;
|
|
1659
1879
|
}
|
|
1880
|
+
/**
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1660
1883
|
export declare enum SessionState {
|
|
1661
1884
|
BUSY = "BUSY",
|
|
1662
1885
|
CREATED = "CREATED",
|
|
@@ -1668,6 +1891,7 @@ export declare enum SessionState {
|
|
|
1668
1891
|
TERMINATING = "TERMINATING"
|
|
1669
1892
|
}
|
|
1670
1893
|
/**
|
|
1894
|
+
* @public
|
|
1671
1895
|
* <p>Contains information about the status of a notebook session.</p>
|
|
1672
1896
|
*/
|
|
1673
1897
|
export interface SessionStatus {
|
|
@@ -1717,6 +1941,9 @@ export interface SessionStatus {
|
|
|
1717
1941
|
*/
|
|
1718
1942
|
StateChangeReason?: string;
|
|
1719
1943
|
}
|
|
1944
|
+
/**
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1720
1947
|
export interface GetSessionResponse {
|
|
1721
1948
|
/**
|
|
1722
1949
|
* <p>The session ID.</p>
|
|
@@ -1756,12 +1983,18 @@ export interface GetSessionResponse {
|
|
|
1756
1983
|
*/
|
|
1757
1984
|
Statistics?: SessionStatistics;
|
|
1758
1985
|
}
|
|
1986
|
+
/**
|
|
1987
|
+
* @public
|
|
1988
|
+
*/
|
|
1759
1989
|
export interface GetSessionStatusRequest {
|
|
1760
1990
|
/**
|
|
1761
1991
|
* <p>The session ID.</p>
|
|
1762
1992
|
*/
|
|
1763
1993
|
SessionId: string | undefined;
|
|
1764
1994
|
}
|
|
1995
|
+
/**
|
|
1996
|
+
* @public
|
|
1997
|
+
*/
|
|
1765
1998
|
export interface GetSessionStatusResponse {
|
|
1766
1999
|
/**
|
|
1767
2000
|
* <p>The session ID.</p>
|
|
@@ -1772,6 +2005,9 @@ export interface GetSessionStatusResponse {
|
|
|
1772
2005
|
*/
|
|
1773
2006
|
Status?: SessionStatus;
|
|
1774
2007
|
}
|
|
2008
|
+
/**
|
|
2009
|
+
* @public
|
|
2010
|
+
*/
|
|
1775
2011
|
export interface GetTableMetadataInput {
|
|
1776
2012
|
/**
|
|
1777
2013
|
* <p>The name of the data catalog that contains the database and table metadata to
|
|
@@ -1788,6 +2024,7 @@ export interface GetTableMetadataInput {
|
|
|
1788
2024
|
TableName: string | undefined;
|
|
1789
2025
|
}
|
|
1790
2026
|
/**
|
|
2027
|
+
* @public
|
|
1791
2028
|
* <p>Contains metadata for a column in a table.</p>
|
|
1792
2029
|
*/
|
|
1793
2030
|
export interface Column {
|
|
@@ -1805,6 +2042,7 @@ export interface Column {
|
|
|
1805
2042
|
Comment?: string;
|
|
1806
2043
|
}
|
|
1807
2044
|
/**
|
|
2045
|
+
* @public
|
|
1808
2046
|
* <p>Contains metadata for a table.</p>
|
|
1809
2047
|
*/
|
|
1810
2048
|
export interface TableMetadata {
|
|
@@ -1838,23 +2076,33 @@ export interface TableMetadata {
|
|
|
1838
2076
|
*/
|
|
1839
2077
|
Parameters?: Record<string, string>;
|
|
1840
2078
|
}
|
|
2079
|
+
/**
|
|
2080
|
+
* @public
|
|
2081
|
+
*/
|
|
1841
2082
|
export interface GetTableMetadataOutput {
|
|
1842
2083
|
/**
|
|
1843
2084
|
* <p>An object that contains table metadata.</p>
|
|
1844
2085
|
*/
|
|
1845
2086
|
TableMetadata?: TableMetadata;
|
|
1846
2087
|
}
|
|
2088
|
+
/**
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
1847
2091
|
export interface GetWorkGroupInput {
|
|
1848
2092
|
/**
|
|
1849
2093
|
* <p>The name of the workgroup.</p>
|
|
1850
2094
|
*/
|
|
1851
2095
|
WorkGroup: string | undefined;
|
|
1852
2096
|
}
|
|
2097
|
+
/**
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
1853
2100
|
export declare enum WorkGroupState {
|
|
1854
2101
|
DISABLED = "DISABLED",
|
|
1855
2102
|
ENABLED = "ENABLED"
|
|
1856
2103
|
}
|
|
1857
2104
|
/**
|
|
2105
|
+
* @public
|
|
1858
2106
|
* <p>A workgroup, which contains a name, description, creation time, state, and other
|
|
1859
2107
|
* configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup
|
|
1860
2108
|
* enables you to isolate queries for you or your group of users from other queries in the
|
|
@@ -1892,12 +2140,18 @@ export interface WorkGroup {
|
|
|
1892
2140
|
*/
|
|
1893
2141
|
CreationTime?: Date;
|
|
1894
2142
|
}
|
|
2143
|
+
/**
|
|
2144
|
+
* @public
|
|
2145
|
+
*/
|
|
1895
2146
|
export interface GetWorkGroupOutput {
|
|
1896
2147
|
/**
|
|
1897
2148
|
* <p>Information about the workgroup.</p>
|
|
1898
2149
|
*/
|
|
1899
2150
|
WorkGroup?: WorkGroup;
|
|
1900
2151
|
}
|
|
2152
|
+
/**
|
|
2153
|
+
* @public
|
|
2154
|
+
*/
|
|
1901
2155
|
export interface ImportNotebookInput {
|
|
1902
2156
|
/**
|
|
1903
2157
|
* <p>The name of the Spark enabled workgroup to import the notebook to.</p>
|
|
@@ -1928,12 +2182,18 @@ export interface ImportNotebookInput {
|
|
|
1928
2182
|
*/
|
|
1929
2183
|
ClientRequestToken?: string;
|
|
1930
2184
|
}
|
|
2185
|
+
/**
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
1931
2188
|
export interface ImportNotebookOutput {
|
|
1932
2189
|
/**
|
|
1933
2190
|
* <p>The ID of the notebook to import.</p>
|
|
1934
2191
|
*/
|
|
1935
2192
|
NotebookId?: string;
|
|
1936
2193
|
}
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
*/
|
|
1937
2197
|
export interface ListApplicationDPUSizesInput {
|
|
1938
2198
|
/**
|
|
1939
2199
|
* <p>Specifies the maximum number of results to return.</p>
|
|
@@ -1946,6 +2206,7 @@ export interface ListApplicationDPUSizesInput {
|
|
|
1946
2206
|
NextToken?: string;
|
|
1947
2207
|
}
|
|
1948
2208
|
/**
|
|
2209
|
+
* @public
|
|
1949
2210
|
* <p>Contains the application runtime IDs and their supported DPU sizes.</p>
|
|
1950
2211
|
*/
|
|
1951
2212
|
export interface ApplicationDPUSizes {
|
|
@@ -1959,6 +2220,9 @@ export interface ApplicationDPUSizes {
|
|
|
1959
2220
|
*/
|
|
1960
2221
|
SupportedDPUSizes?: number[];
|
|
1961
2222
|
}
|
|
2223
|
+
/**
|
|
2224
|
+
* @public
|
|
2225
|
+
*/
|
|
1962
2226
|
export interface ListApplicationDPUSizesOutput {
|
|
1963
2227
|
/**
|
|
1964
2228
|
* <p>A list of the supported DPU sizes that the application runtime supports.</p>
|
|
@@ -1971,6 +2235,9 @@ export interface ListApplicationDPUSizesOutput {
|
|
|
1971
2235
|
*/
|
|
1972
2236
|
NextToken?: string;
|
|
1973
2237
|
}
|
|
2238
|
+
/**
|
|
2239
|
+
* @public
|
|
2240
|
+
*/
|
|
1974
2241
|
export interface ListCalculationExecutionsRequest {
|
|
1975
2242
|
/**
|
|
1976
2243
|
* <p>The session ID.</p>
|
|
@@ -2011,6 +2278,7 @@ export interface ListCalculationExecutionsRequest {
|
|
|
2011
2278
|
NextToken?: string;
|
|
2012
2279
|
}
|
|
2013
2280
|
/**
|
|
2281
|
+
* @public
|
|
2014
2282
|
* <p>Summary information for a notebook calculation.</p>
|
|
2015
2283
|
*/
|
|
2016
2284
|
export interface CalculationSummary {
|
|
@@ -2027,6 +2295,9 @@ export interface CalculationSummary {
|
|
|
2027
2295
|
*/
|
|
2028
2296
|
Status?: CalculationStatus;
|
|
2029
2297
|
}
|
|
2298
|
+
/**
|
|
2299
|
+
* @public
|
|
2300
|
+
*/
|
|
2030
2301
|
export interface ListCalculationExecutionsResponse {
|
|
2031
2302
|
/**
|
|
2032
2303
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2039,6 +2310,9 @@ export interface ListCalculationExecutionsResponse {
|
|
|
2039
2310
|
*/
|
|
2040
2311
|
Calculations?: CalculationSummary[];
|
|
2041
2312
|
}
|
|
2313
|
+
/**
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2042
2316
|
export interface ListDatabasesInput {
|
|
2043
2317
|
/**
|
|
2044
2318
|
* <p>The name of the data catalog that contains the databases to return.</p>
|
|
@@ -2055,6 +2329,9 @@ export interface ListDatabasesInput {
|
|
|
2055
2329
|
*/
|
|
2056
2330
|
MaxResults?: number;
|
|
2057
2331
|
}
|
|
2332
|
+
/**
|
|
2333
|
+
* @public
|
|
2334
|
+
*/
|
|
2058
2335
|
export interface ListDatabasesOutput {
|
|
2059
2336
|
/**
|
|
2060
2337
|
* <p>A list of databases from a data catalog.</p>
|
|
@@ -2067,6 +2344,9 @@ export interface ListDatabasesOutput {
|
|
|
2067
2344
|
*/
|
|
2068
2345
|
NextToken?: string;
|
|
2069
2346
|
}
|
|
2347
|
+
/**
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2070
2350
|
export interface ListDataCatalogsInput {
|
|
2071
2351
|
/**
|
|
2072
2352
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2080,6 +2360,7 @@ export interface ListDataCatalogsInput {
|
|
|
2080
2360
|
MaxResults?: number;
|
|
2081
2361
|
}
|
|
2082
2362
|
/**
|
|
2363
|
+
* @public
|
|
2083
2364
|
* <p>The summary information for the data catalog, which includes its name and type.</p>
|
|
2084
2365
|
*/
|
|
2085
2366
|
export interface DataCatalogSummary {
|
|
@@ -2094,6 +2375,9 @@ export interface DataCatalogSummary {
|
|
|
2094
2375
|
*/
|
|
2095
2376
|
Type?: DataCatalogType | string;
|
|
2096
2377
|
}
|
|
2378
|
+
/**
|
|
2379
|
+
* @public
|
|
2380
|
+
*/
|
|
2097
2381
|
export interface ListDataCatalogsOutput {
|
|
2098
2382
|
/**
|
|
2099
2383
|
* <p>A summary list of data catalogs.</p>
|
|
@@ -2106,6 +2390,9 @@ export interface ListDataCatalogsOutput {
|
|
|
2106
2390
|
*/
|
|
2107
2391
|
NextToken?: string;
|
|
2108
2392
|
}
|
|
2393
|
+
/**
|
|
2394
|
+
* @public
|
|
2395
|
+
*/
|
|
2109
2396
|
export interface ListEngineVersionsInput {
|
|
2110
2397
|
/**
|
|
2111
2398
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2118,6 +2405,9 @@ export interface ListEngineVersionsInput {
|
|
|
2118
2405
|
*/
|
|
2119
2406
|
MaxResults?: number;
|
|
2120
2407
|
}
|
|
2408
|
+
/**
|
|
2409
|
+
* @public
|
|
2410
|
+
*/
|
|
2121
2411
|
export interface ListEngineVersionsOutput {
|
|
2122
2412
|
/**
|
|
2123
2413
|
* <p>A list of engine versions that are available to choose from.</p>
|
|
@@ -2130,6 +2420,9 @@ export interface ListEngineVersionsOutput {
|
|
|
2130
2420
|
*/
|
|
2131
2421
|
NextToken?: string;
|
|
2132
2422
|
}
|
|
2423
|
+
/**
|
|
2424
|
+
* @public
|
|
2425
|
+
*/
|
|
2133
2426
|
export declare enum ExecutorState {
|
|
2134
2427
|
CREATED = "CREATED",
|
|
2135
2428
|
CREATING = "CREATING",
|
|
@@ -2138,6 +2431,9 @@ export declare enum ExecutorState {
|
|
|
2138
2431
|
TERMINATED = "TERMINATED",
|
|
2139
2432
|
TERMINATING = "TERMINATING"
|
|
2140
2433
|
}
|
|
2434
|
+
/**
|
|
2435
|
+
* @public
|
|
2436
|
+
*/
|
|
2141
2437
|
export interface ListExecutorsRequest {
|
|
2142
2438
|
/**
|
|
2143
2439
|
* <p>The session ID.</p>
|
|
@@ -2171,12 +2467,16 @@ export interface ListExecutorsRequest {
|
|
|
2171
2467
|
*/
|
|
2172
2468
|
NextToken?: string;
|
|
2173
2469
|
}
|
|
2470
|
+
/**
|
|
2471
|
+
* @public
|
|
2472
|
+
*/
|
|
2174
2473
|
export declare enum ExecutorType {
|
|
2175
2474
|
COORDINATOR = "COORDINATOR",
|
|
2176
2475
|
GATEWAY = "GATEWAY",
|
|
2177
2476
|
WORKER = "WORKER"
|
|
2178
2477
|
}
|
|
2179
2478
|
/**
|
|
2479
|
+
* @public
|
|
2180
2480
|
* <p>Contains summary information about an executor.</p>
|
|
2181
2481
|
*/
|
|
2182
2482
|
export interface ExecutorsSummary {
|
|
@@ -2221,6 +2521,9 @@ export interface ExecutorsSummary {
|
|
|
2221
2521
|
*/
|
|
2222
2522
|
ExecutorSize?: number;
|
|
2223
2523
|
}
|
|
2524
|
+
/**
|
|
2525
|
+
* @public
|
|
2526
|
+
*/
|
|
2224
2527
|
export interface ListExecutorsResponse {
|
|
2225
2528
|
/**
|
|
2226
2529
|
* <p>The session ID.</p>
|
|
@@ -2237,6 +2540,9 @@ export interface ListExecutorsResponse {
|
|
|
2237
2540
|
*/
|
|
2238
2541
|
ExecutorsSummary?: ExecutorsSummary[];
|
|
2239
2542
|
}
|
|
2543
|
+
/**
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2240
2546
|
export interface ListNamedQueriesInput {
|
|
2241
2547
|
/**
|
|
2242
2548
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2255,6 +2561,9 @@ export interface ListNamedQueriesInput {
|
|
|
2255
2561
|
*/
|
|
2256
2562
|
WorkGroup?: string;
|
|
2257
2563
|
}
|
|
2564
|
+
/**
|
|
2565
|
+
* @public
|
|
2566
|
+
*/
|
|
2258
2567
|
export interface ListNamedQueriesOutput {
|
|
2259
2568
|
/**
|
|
2260
2569
|
* <p>The list of unique query IDs.</p>
|
|
@@ -2268,6 +2577,7 @@ export interface ListNamedQueriesOutput {
|
|
|
2268
2577
|
NextToken?: string;
|
|
2269
2578
|
}
|
|
2270
2579
|
/**
|
|
2580
|
+
* @public
|
|
2271
2581
|
* <p>A string for searching notebook names.</p>
|
|
2272
2582
|
*/
|
|
2273
2583
|
export interface FilterDefinition {
|
|
@@ -2276,6 +2586,9 @@ export interface FilterDefinition {
|
|
|
2276
2586
|
*/
|
|
2277
2587
|
Name?: string;
|
|
2278
2588
|
}
|
|
2589
|
+
/**
|
|
2590
|
+
* @public
|
|
2591
|
+
*/
|
|
2279
2592
|
export interface ListNotebookMetadataInput {
|
|
2280
2593
|
/**
|
|
2281
2594
|
* <p>Search filter string.</p>
|
|
@@ -2295,6 +2608,9 @@ export interface ListNotebookMetadataInput {
|
|
|
2295
2608
|
*/
|
|
2296
2609
|
WorkGroup: string | undefined;
|
|
2297
2610
|
}
|
|
2611
|
+
/**
|
|
2612
|
+
* @public
|
|
2613
|
+
*/
|
|
2298
2614
|
export interface ListNotebookMetadataOutput {
|
|
2299
2615
|
/**
|
|
2300
2616
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2307,6 +2623,9 @@ export interface ListNotebookMetadataOutput {
|
|
|
2307
2623
|
*/
|
|
2308
2624
|
NotebookMetadataList?: NotebookMetadata[];
|
|
2309
2625
|
}
|
|
2626
|
+
/**
|
|
2627
|
+
* @public
|
|
2628
|
+
*/
|
|
2310
2629
|
export interface ListNotebookSessionsRequest {
|
|
2311
2630
|
/**
|
|
2312
2631
|
* <p>The ID of the notebook to list sessions for.</p>
|
|
@@ -2324,6 +2643,7 @@ export interface ListNotebookSessionsRequest {
|
|
|
2324
2643
|
NextToken?: string;
|
|
2325
2644
|
}
|
|
2326
2645
|
/**
|
|
2646
|
+
* @public
|
|
2327
2647
|
* <p>Contains the notebook session ID and notebook session creation time.</p>
|
|
2328
2648
|
*/
|
|
2329
2649
|
export interface NotebookSessionSummary {
|
|
@@ -2336,6 +2656,9 @@ export interface NotebookSessionSummary {
|
|
|
2336
2656
|
*/
|
|
2337
2657
|
CreationTime?: Date;
|
|
2338
2658
|
}
|
|
2659
|
+
/**
|
|
2660
|
+
* @public
|
|
2661
|
+
*/
|
|
2339
2662
|
export interface ListNotebookSessionsResponse {
|
|
2340
2663
|
/**
|
|
2341
2664
|
* <p>A list of the sessions belonging to the notebook.</p>
|
|
@@ -2348,6 +2671,9 @@ export interface ListNotebookSessionsResponse {
|
|
|
2348
2671
|
*/
|
|
2349
2672
|
NextToken?: string;
|
|
2350
2673
|
}
|
|
2674
|
+
/**
|
|
2675
|
+
* @public
|
|
2676
|
+
*/
|
|
2351
2677
|
export interface ListPreparedStatementsInput {
|
|
2352
2678
|
/**
|
|
2353
2679
|
* <p>The workgroup to list the prepared statements for.</p>
|
|
@@ -2365,6 +2691,7 @@ export interface ListPreparedStatementsInput {
|
|
|
2365
2691
|
MaxResults?: number;
|
|
2366
2692
|
}
|
|
2367
2693
|
/**
|
|
2694
|
+
* @public
|
|
2368
2695
|
* <p>The name and last modified time of the prepared statement.</p>
|
|
2369
2696
|
*/
|
|
2370
2697
|
export interface PreparedStatementSummary {
|
|
@@ -2377,6 +2704,9 @@ export interface PreparedStatementSummary {
|
|
|
2377
2704
|
*/
|
|
2378
2705
|
LastModifiedTime?: Date;
|
|
2379
2706
|
}
|
|
2707
|
+
/**
|
|
2708
|
+
* @public
|
|
2709
|
+
*/
|
|
2380
2710
|
export interface ListPreparedStatementsOutput {
|
|
2381
2711
|
/**
|
|
2382
2712
|
* <p>The list of prepared statements for the workgroup.</p>
|
|
@@ -2389,6 +2719,9 @@ export interface ListPreparedStatementsOutput {
|
|
|
2389
2719
|
*/
|
|
2390
2720
|
NextToken?: string;
|
|
2391
2721
|
}
|
|
2722
|
+
/**
|
|
2723
|
+
* @public
|
|
2724
|
+
*/
|
|
2392
2725
|
export interface ListQueryExecutionsInput {
|
|
2393
2726
|
/**
|
|
2394
2727
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2407,6 +2740,9 @@ export interface ListQueryExecutionsInput {
|
|
|
2407
2740
|
*/
|
|
2408
2741
|
WorkGroup?: string;
|
|
2409
2742
|
}
|
|
2743
|
+
/**
|
|
2744
|
+
* @public
|
|
2745
|
+
*/
|
|
2410
2746
|
export interface ListQueryExecutionsOutput {
|
|
2411
2747
|
/**
|
|
2412
2748
|
* <p>The unique IDs of each query execution as an array of strings.</p>
|
|
@@ -2417,6 +2753,9 @@ export interface ListQueryExecutionsOutput {
|
|
|
2417
2753
|
*/
|
|
2418
2754
|
NextToken?: string;
|
|
2419
2755
|
}
|
|
2756
|
+
/**
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2420
2759
|
export interface ListSessionsRequest {
|
|
2421
2760
|
/**
|
|
2422
2761
|
* <p>The workgroup to which the session belongs.</p>
|
|
@@ -2457,6 +2796,7 @@ export interface ListSessionsRequest {
|
|
|
2457
2796
|
NextToken?: string;
|
|
2458
2797
|
}
|
|
2459
2798
|
/**
|
|
2799
|
+
* @public
|
|
2460
2800
|
* <p>Contains summary information about a notebook session.</p>
|
|
2461
2801
|
*/
|
|
2462
2802
|
export interface SessionSummary {
|
|
@@ -2482,6 +2822,9 @@ export interface SessionSummary {
|
|
|
2482
2822
|
*/
|
|
2483
2823
|
Status?: SessionStatus;
|
|
2484
2824
|
}
|
|
2825
|
+
/**
|
|
2826
|
+
* @public
|
|
2827
|
+
*/
|
|
2485
2828
|
export interface ListSessionsResponse {
|
|
2486
2829
|
/**
|
|
2487
2830
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2494,6 +2837,9 @@ export interface ListSessionsResponse {
|
|
|
2494
2837
|
*/
|
|
2495
2838
|
Sessions?: SessionSummary[];
|
|
2496
2839
|
}
|
|
2840
|
+
/**
|
|
2841
|
+
* @public
|
|
2842
|
+
*/
|
|
2497
2843
|
export interface ListTableMetadataInput {
|
|
2498
2844
|
/**
|
|
2499
2845
|
* <p>The name of the data catalog for which table metadata should be returned.</p>
|
|
@@ -2519,6 +2865,9 @@ export interface ListTableMetadataInput {
|
|
|
2519
2865
|
*/
|
|
2520
2866
|
MaxResults?: number;
|
|
2521
2867
|
}
|
|
2868
|
+
/**
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2522
2871
|
export interface ListTableMetadataOutput {
|
|
2523
2872
|
/**
|
|
2524
2873
|
* <p>A list of table metadata.</p>
|
|
@@ -2531,6 +2880,9 @@ export interface ListTableMetadataOutput {
|
|
|
2531
2880
|
*/
|
|
2532
2881
|
NextToken?: string;
|
|
2533
2882
|
}
|
|
2883
|
+
/**
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2534
2886
|
export interface ListTagsForResourceInput {
|
|
2535
2887
|
/**
|
|
2536
2888
|
* <p>Lists the tags for the resource with the specified ARN.</p>
|
|
@@ -2548,6 +2900,9 @@ export interface ListTagsForResourceInput {
|
|
|
2548
2900
|
*/
|
|
2549
2901
|
MaxResults?: number;
|
|
2550
2902
|
}
|
|
2903
|
+
/**
|
|
2904
|
+
* @public
|
|
2905
|
+
*/
|
|
2551
2906
|
export interface ListTagsForResourceOutput {
|
|
2552
2907
|
/**
|
|
2553
2908
|
* <p>The list of tags associated with the specified resource.</p>
|
|
@@ -2558,6 +2913,9 @@ export interface ListTagsForResourceOutput {
|
|
|
2558
2913
|
*/
|
|
2559
2914
|
NextToken?: string;
|
|
2560
2915
|
}
|
|
2916
|
+
/**
|
|
2917
|
+
* @public
|
|
2918
|
+
*/
|
|
2561
2919
|
export interface ListWorkGroupsInput {
|
|
2562
2920
|
/**
|
|
2563
2921
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
@@ -2571,6 +2929,7 @@ export interface ListWorkGroupsInput {
|
|
|
2571
2929
|
MaxResults?: number;
|
|
2572
2930
|
}
|
|
2573
2931
|
/**
|
|
2932
|
+
* @public
|
|
2574
2933
|
* <p>The summary information for the workgroup, which includes its name, state,
|
|
2575
2934
|
* description, and the date and time it was created.</p>
|
|
2576
2935
|
*/
|
|
@@ -2598,6 +2957,9 @@ export interface WorkGroupSummary {
|
|
|
2598
2957
|
*/
|
|
2599
2958
|
EngineVersion?: EngineVersion;
|
|
2600
2959
|
}
|
|
2960
|
+
/**
|
|
2961
|
+
* @public
|
|
2962
|
+
*/
|
|
2601
2963
|
export interface ListWorkGroupsOutput {
|
|
2602
2964
|
/**
|
|
2603
2965
|
* <p>A list of <a>WorkGroupSummary</a> objects that include the names,
|
|
@@ -2612,6 +2974,7 @@ export interface ListWorkGroupsOutput {
|
|
|
2612
2974
|
NextToken?: string;
|
|
2613
2975
|
}
|
|
2614
2976
|
/**
|
|
2977
|
+
* @public
|
|
2615
2978
|
* <p>Contains configuration information for the calculation.</p>
|
|
2616
2979
|
*/
|
|
2617
2980
|
export interface CalculationConfiguration {
|
|
@@ -2620,6 +2983,9 @@ export interface CalculationConfiguration {
|
|
|
2620
2983
|
*/
|
|
2621
2984
|
CodeBlock?: string;
|
|
2622
2985
|
}
|
|
2986
|
+
/**
|
|
2987
|
+
* @public
|
|
2988
|
+
*/
|
|
2623
2989
|
export interface StartCalculationExecutionRequest {
|
|
2624
2990
|
/**
|
|
2625
2991
|
* <p>The session ID.</p>
|
|
@@ -2654,6 +3020,9 @@ export interface StartCalculationExecutionRequest {
|
|
|
2654
3020
|
*/
|
|
2655
3021
|
ClientRequestToken?: string;
|
|
2656
3022
|
}
|
|
3023
|
+
/**
|
|
3024
|
+
* @public
|
|
3025
|
+
*/
|
|
2657
3026
|
export interface StartCalculationExecutionResponse {
|
|
2658
3027
|
/**
|
|
2659
3028
|
* <p>The calculation execution UUID.</p>
|
|
@@ -2681,6 +3050,9 @@ export interface StartCalculationExecutionResponse {
|
|
|
2681
3050
|
*/
|
|
2682
3051
|
State?: CalculationExecutionState | string;
|
|
2683
3052
|
}
|
|
3053
|
+
/**
|
|
3054
|
+
* @public
|
|
3055
|
+
*/
|
|
2684
3056
|
export interface StartQueryExecutionInput {
|
|
2685
3057
|
/**
|
|
2686
3058
|
* <p>The SQL query statements to be executed.</p>
|
|
@@ -2724,6 +3096,9 @@ export interface StartQueryExecutionInput {
|
|
|
2724
3096
|
*/
|
|
2725
3097
|
ResultReuseConfiguration?: ResultReuseConfiguration;
|
|
2726
3098
|
}
|
|
3099
|
+
/**
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
2727
3102
|
export interface StartQueryExecutionOutput {
|
|
2728
3103
|
/**
|
|
2729
3104
|
* <p>The unique ID of the query that ran as a result of this request.</p>
|
|
@@ -2731,6 +3106,7 @@ export interface StartQueryExecutionOutput {
|
|
|
2731
3106
|
QueryExecutionId?: string;
|
|
2732
3107
|
}
|
|
2733
3108
|
/**
|
|
3109
|
+
* @public
|
|
2734
3110
|
* <p>The specified session already exists.</p>
|
|
2735
3111
|
*/
|
|
2736
3112
|
export declare class SessionAlreadyExistsException extends __BaseException {
|
|
@@ -2742,6 +3118,9 @@ export declare class SessionAlreadyExistsException extends __BaseException {
|
|
|
2742
3118
|
*/
|
|
2743
3119
|
constructor(opts: __ExceptionOptionType<SessionAlreadyExistsException, __BaseException>);
|
|
2744
3120
|
}
|
|
3121
|
+
/**
|
|
3122
|
+
* @public
|
|
3123
|
+
*/
|
|
2745
3124
|
export interface StartSessionRequest {
|
|
2746
3125
|
/**
|
|
2747
3126
|
* <p>The session description.</p>
|
|
@@ -2780,6 +3159,9 @@ export interface StartSessionRequest {
|
|
|
2780
3159
|
*/
|
|
2781
3160
|
ClientRequestToken?: string;
|
|
2782
3161
|
}
|
|
3162
|
+
/**
|
|
3163
|
+
* @public
|
|
3164
|
+
*/
|
|
2783
3165
|
export interface StartSessionResponse {
|
|
2784
3166
|
/**
|
|
2785
3167
|
* <p>The session ID.</p>
|
|
@@ -2809,12 +3191,18 @@ export interface StartSessionResponse {
|
|
|
2809
3191
|
*/
|
|
2810
3192
|
State?: SessionState | string;
|
|
2811
3193
|
}
|
|
3194
|
+
/**
|
|
3195
|
+
* @public
|
|
3196
|
+
*/
|
|
2812
3197
|
export interface StopCalculationExecutionRequest {
|
|
2813
3198
|
/**
|
|
2814
3199
|
* <p>The calculation execution UUID.</p>
|
|
2815
3200
|
*/
|
|
2816
3201
|
CalculationExecutionId: string | undefined;
|
|
2817
3202
|
}
|
|
3203
|
+
/**
|
|
3204
|
+
* @public
|
|
3205
|
+
*/
|
|
2818
3206
|
export interface StopCalculationExecutionResponse {
|
|
2819
3207
|
/**
|
|
2820
3208
|
* <p>
|
|
@@ -2838,14 +3226,23 @@ export interface StopCalculationExecutionResponse {
|
|
|
2838
3226
|
*/
|
|
2839
3227
|
State?: CalculationExecutionState | string;
|
|
2840
3228
|
}
|
|
3229
|
+
/**
|
|
3230
|
+
* @public
|
|
3231
|
+
*/
|
|
2841
3232
|
export interface StopQueryExecutionInput {
|
|
2842
3233
|
/**
|
|
2843
3234
|
* <p>The unique ID of the query execution to stop.</p>
|
|
2844
3235
|
*/
|
|
2845
3236
|
QueryExecutionId?: string;
|
|
2846
3237
|
}
|
|
3238
|
+
/**
|
|
3239
|
+
* @public
|
|
3240
|
+
*/
|
|
2847
3241
|
export interface StopQueryExecutionOutput {
|
|
2848
3242
|
}
|
|
3243
|
+
/**
|
|
3244
|
+
* @public
|
|
3245
|
+
*/
|
|
2849
3246
|
export interface TagResourceInput {
|
|
2850
3247
|
/**
|
|
2851
3248
|
* <p>Specifies the ARN of the Athena resource (workgroup or data catalog) to
|
|
@@ -2857,14 +3254,23 @@ export interface TagResourceInput {
|
|
|
2857
3254
|
*/
|
|
2858
3255
|
Tags: Tag[] | undefined;
|
|
2859
3256
|
}
|
|
3257
|
+
/**
|
|
3258
|
+
* @public
|
|
3259
|
+
*/
|
|
2860
3260
|
export interface TagResourceOutput {
|
|
2861
3261
|
}
|
|
3262
|
+
/**
|
|
3263
|
+
* @public
|
|
3264
|
+
*/
|
|
2862
3265
|
export interface TerminateSessionRequest {
|
|
2863
3266
|
/**
|
|
2864
3267
|
* <p>The session ID.</p>
|
|
2865
3268
|
*/
|
|
2866
3269
|
SessionId: string | undefined;
|
|
2867
3270
|
}
|
|
3271
|
+
/**
|
|
3272
|
+
* @public
|
|
3273
|
+
*/
|
|
2868
3274
|
export interface TerminateSessionResponse {
|
|
2869
3275
|
/**
|
|
2870
3276
|
* <p>The state of the session. A description of each state follows.</p>
|
|
@@ -2890,6 +3296,9 @@ export interface TerminateSessionResponse {
|
|
|
2890
3296
|
*/
|
|
2891
3297
|
State?: SessionState | string;
|
|
2892
3298
|
}
|
|
3299
|
+
/**
|
|
3300
|
+
* @public
|
|
3301
|
+
*/
|
|
2893
3302
|
export interface UntagResourceInput {
|
|
2894
3303
|
/**
|
|
2895
3304
|
* <p>Specifies the ARN of the resource from which tags are to be removed.</p>
|
|
@@ -2901,8 +3310,14 @@ export interface UntagResourceInput {
|
|
|
2901
3310
|
*/
|
|
2902
3311
|
TagKeys: string[] | undefined;
|
|
2903
3312
|
}
|
|
3313
|
+
/**
|
|
3314
|
+
* @public
|
|
3315
|
+
*/
|
|
2904
3316
|
export interface UntagResourceOutput {
|
|
2905
3317
|
}
|
|
3318
|
+
/**
|
|
3319
|
+
* @public
|
|
3320
|
+
*/
|
|
2906
3321
|
export interface UpdateDataCatalogInput {
|
|
2907
3322
|
/**
|
|
2908
3323
|
* <p>The name of the data catalog to update. The catalog name must be unique for the
|
|
@@ -2964,8 +3379,14 @@ export interface UpdateDataCatalogInput {
|
|
|
2964
3379
|
*/
|
|
2965
3380
|
Parameters?: Record<string, string>;
|
|
2966
3381
|
}
|
|
3382
|
+
/**
|
|
3383
|
+
* @public
|
|
3384
|
+
*/
|
|
2967
3385
|
export interface UpdateDataCatalogOutput {
|
|
2968
3386
|
}
|
|
3387
|
+
/**
|
|
3388
|
+
* @public
|
|
3389
|
+
*/
|
|
2969
3390
|
export interface UpdateNamedQueryInput {
|
|
2970
3391
|
/**
|
|
2971
3392
|
* <p>The unique identifier (UUID) of the query.</p>
|
|
@@ -2984,8 +3405,14 @@ export interface UpdateNamedQueryInput {
|
|
|
2984
3405
|
*/
|
|
2985
3406
|
QueryString: string | undefined;
|
|
2986
3407
|
}
|
|
3408
|
+
/**
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
2987
3411
|
export interface UpdateNamedQueryOutput {
|
|
2988
3412
|
}
|
|
3413
|
+
/**
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
2989
3416
|
export interface UpdateNotebookInput {
|
|
2990
3417
|
/**
|
|
2991
3418
|
* <p>The ID of the notebook to update.</p>
|
|
@@ -3016,8 +3443,14 @@ export interface UpdateNotebookInput {
|
|
|
3016
3443
|
*/
|
|
3017
3444
|
ClientRequestToken?: string;
|
|
3018
3445
|
}
|
|
3446
|
+
/**
|
|
3447
|
+
* @public
|
|
3448
|
+
*/
|
|
3019
3449
|
export interface UpdateNotebookOutput {
|
|
3020
3450
|
}
|
|
3451
|
+
/**
|
|
3452
|
+
* @public
|
|
3453
|
+
*/
|
|
3021
3454
|
export interface UpdateNotebookMetadataInput {
|
|
3022
3455
|
/**
|
|
3023
3456
|
* <p>The ID of the notebook to update the metadata for.</p>
|
|
@@ -3039,8 +3472,14 @@ export interface UpdateNotebookMetadataInput {
|
|
|
3039
3472
|
*/
|
|
3040
3473
|
Name: string | undefined;
|
|
3041
3474
|
}
|
|
3475
|
+
/**
|
|
3476
|
+
* @public
|
|
3477
|
+
*/
|
|
3042
3478
|
export interface UpdateNotebookMetadataOutput {
|
|
3043
3479
|
}
|
|
3480
|
+
/**
|
|
3481
|
+
* @public
|
|
3482
|
+
*/
|
|
3044
3483
|
export interface UpdatePreparedStatementInput {
|
|
3045
3484
|
/**
|
|
3046
3485
|
* <p>The name of the prepared statement.</p>
|
|
@@ -3059,9 +3498,13 @@ export interface UpdatePreparedStatementInput {
|
|
|
3059
3498
|
*/
|
|
3060
3499
|
Description?: string;
|
|
3061
3500
|
}
|
|
3501
|
+
/**
|
|
3502
|
+
* @public
|
|
3503
|
+
*/
|
|
3062
3504
|
export interface UpdatePreparedStatementOutput {
|
|
3063
3505
|
}
|
|
3064
3506
|
/**
|
|
3507
|
+
* @public
|
|
3065
3508
|
* <p>The information about the updates in the query results, such as output location and
|
|
3066
3509
|
* encryption configuration for the query results.</p>
|
|
3067
3510
|
*/
|
|
@@ -3140,6 +3583,7 @@ export interface ResultConfigurationUpdates {
|
|
|
3140
3583
|
RemoveAclConfiguration?: boolean;
|
|
3141
3584
|
}
|
|
3142
3585
|
/**
|
|
3586
|
+
* @public
|
|
3143
3587
|
* <p>The configuration information that will be updated for this workgroup, which includes
|
|
3144
3588
|
* the location in Amazon S3 where query results are stored, the encryption option,
|
|
3145
3589
|
* if any, used for query results, whether the Amazon CloudWatch Metrics are enabled
|
|
@@ -3205,6 +3649,9 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
3205
3649
|
*/
|
|
3206
3650
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
3207
3651
|
}
|
|
3652
|
+
/**
|
|
3653
|
+
* @public
|
|
3654
|
+
*/
|
|
3208
3655
|
export interface UpdateWorkGroupInput {
|
|
3209
3656
|
/**
|
|
3210
3657
|
* <p>The specified workgroup that will be updated.</p>
|
|
@@ -3223,9 +3670,13 @@ export interface UpdateWorkGroupInput {
|
|
|
3223
3670
|
*/
|
|
3224
3671
|
State?: WorkGroupState | string;
|
|
3225
3672
|
}
|
|
3673
|
+
/**
|
|
3674
|
+
* @public
|
|
3675
|
+
*/
|
|
3226
3676
|
export interface UpdateWorkGroupOutput {
|
|
3227
3677
|
}
|
|
3228
3678
|
/**
|
|
3679
|
+
* @public
|
|
3229
3680
|
* <p>Stage plan information such as name, identifier, sub plans, and remote sources.</p>
|
|
3230
3681
|
*/
|
|
3231
3682
|
export interface QueryStagePlanNode {
|
|
@@ -3249,6 +3700,7 @@ export interface QueryStagePlanNode {
|
|
|
3249
3700
|
RemoteSources?: string[];
|
|
3250
3701
|
}
|
|
3251
3702
|
/**
|
|
3703
|
+
* @public
|
|
3252
3704
|
* <p>Stage statistics such as input and output rows and bytes, execution time and stage
|
|
3253
3705
|
* state. This information also includes substages and the query stage plan.</p>
|
|
3254
3706
|
*/
|
|
@@ -3291,6 +3743,7 @@ export interface QueryStage {
|
|
|
3291
3743
|
SubStages?: QueryStage[];
|
|
3292
3744
|
}
|
|
3293
3745
|
/**
|
|
3746
|
+
* @public
|
|
3294
3747
|
* <p>The query execution timeline, statistics on input and output rows and bytes, and the
|
|
3295
3748
|
* different query stages that form the query execution plan.</p>
|
|
3296
3749
|
*/
|
|
@@ -3311,6 +3764,9 @@ export interface QueryRuntimeStatistics {
|
|
|
3311
3764
|
*/
|
|
3312
3765
|
OutputStage?: QueryStage;
|
|
3313
3766
|
}
|
|
3767
|
+
/**
|
|
3768
|
+
* @public
|
|
3769
|
+
*/
|
|
3314
3770
|
export interface GetQueryRuntimeStatisticsOutput {
|
|
3315
3771
|
/**
|
|
3316
3772
|
* <p>Runtime statistics about the query execution.</p>
|