@aws-sdk/client-athena 3.529.1 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/Athena.d.ts +8 -1
- package/dist-types/AthenaClient.d.ts +1 -1
- package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +2 -1
- package/dist-types/commands/CancelCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/CreateCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataCatalogCommand.d.ts +2 -1
- package/dist-types/commands/CreateNamedQueryCommand.d.ts +2 -1
- package/dist-types/commands/CreateNotebookCommand.d.ts +2 -1
- package/dist-types/commands/CreatePreparedStatementCommand.d.ts +2 -1
- package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataCatalogCommand.d.ts +2 -1
- package/dist-types/commands/DeleteNamedQueryCommand.d.ts +2 -1
- package/dist-types/commands/DeleteNotebookCommand.d.ts +2 -1
- package/dist-types/commands/DeletePreparedStatementCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkGroupCommand.d.ts +2 -1
- package/dist-types/commands/ExportNotebookCommand.d.ts +2 -1
- package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +2 -1
- package/dist-types/commands/GetCalculationExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetCapacityAssignmentConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/GetDataCatalogCommand.d.ts +2 -1
- package/dist-types/commands/GetDatabaseCommand.d.ts +2 -1
- package/dist-types/commands/GetNamedQueryCommand.d.ts +2 -1
- package/dist-types/commands/GetNotebookMetadataCommand.d.ts +2 -1
- package/dist-types/commands/GetPreparedStatementCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryResultsCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetTableMetadataCommand.d.ts +2 -1
- package/dist-types/commands/GetWorkGroupCommand.d.ts +2 -1
- package/dist-types/commands/ImportNotebookCommand.d.ts +2 -1
- package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +2 -1
- package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListCapacityReservationsCommand.d.ts +2 -1
- package/dist-types/commands/ListDataCatalogsCommand.d.ts +2 -1
- package/dist-types/commands/ListDatabasesCommand.d.ts +2 -1
- package/dist-types/commands/ListEngineVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListExecutorsCommand.d.ts +2 -1
- package/dist-types/commands/ListNamedQueriesCommand.d.ts +2 -1
- package/dist-types/commands/ListNotebookMetadataCommand.d.ts +2 -1
- package/dist-types/commands/ListNotebookSessionsCommand.d.ts +2 -1
- package/dist-types/commands/ListPreparedStatementsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueryExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListSessionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTableMetadataCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListWorkGroupsCommand.d.ts +2 -1
- package/dist-types/commands/PutCapacityAssignmentConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/StartCalculationExecutionCommand.d.ts +2 -1
- package/dist-types/commands/StartQueryExecutionCommand.d.ts +2 -1
- package/dist-types/commands/StartSessionCommand.d.ts +2 -1
- package/dist-types/commands/StopCalculationExecutionCommand.d.ts +2 -1
- package/dist-types/commands/StopQueryExecutionCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDataCatalogCommand.d.ts +2 -1
- package/dist-types/commands/UpdateNamedQueryCommand.d.ts +2 -1
- package/dist-types/commands/UpdateNotebookCommand.d.ts +2 -1
- package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkGroupCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +585 -585
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/Athena.d.ts +7 -0
- package/dist-types/ts3.4/commands/BatchGetNamedQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetPreparedStatementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetQueryExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelCapacityReservationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCapacityReservationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateNamedQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateNotebookCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePreparedStatementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePresignedNotebookUrlCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCapacityReservationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDataCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteNamedQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteNotebookCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePreparedStatementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ExportNotebookCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCalculationExecutionCodeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCalculationExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCalculationExecutionStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCapacityAssignmentConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCapacityReservationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDatabaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetNamedQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetNotebookMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPreparedStatementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryResultsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryRuntimeStatisticsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSessionStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTableMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetWorkGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportNotebookCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListApplicationDPUSizesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCalculationExecutionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCapacityReservationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDataCatalogsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDatabasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEngineVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListExecutorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListNamedQueriesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListNotebookMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListNotebookSessionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPreparedStatementsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueryExecutionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTableMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListWorkGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutCapacityAssignmentConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartCalculationExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartQueryExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopCalculationExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopQueryExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TerminateSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCapacityReservationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDataCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateNamedQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateNotebookCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateNotebookMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePreparedStatementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -12,93 +12,93 @@ export declare const S3AclOption: {
|
|
|
12
12
|
*/
|
|
13
13
|
export type S3AclOption = (typeof S3AclOption)[keyof typeof S3AclOption];
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p>Indicates that an Amazon S3 canned ACL should be set to control ownership of
|
|
17
16
|
* stored query results. When Athena stores query results in Amazon S3,
|
|
18
17
|
* the canned ACL is set with the <code>x-amz-acl</code> request header. For more
|
|
19
18
|
* information about S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview">Object Ownership settings</a> in the <i>Amazon S3 User
|
|
20
19
|
* Guide</i>.</p>
|
|
20
|
+
* @public
|
|
21
21
|
*/
|
|
22
22
|
export interface AclConfiguration {
|
|
23
23
|
/**
|
|
24
|
-
* @public
|
|
25
24
|
* <p>The Amazon S3 canned ACL that Athena should specify when storing
|
|
26
25
|
* query results. Currently the only supported canned ACL is
|
|
27
26
|
* <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the
|
|
28
27
|
* workgroup overrides client-side settings, then the Amazon S3 canned ACL
|
|
29
28
|
* specified in the workgroup's settings is used for all queries that run in the workgroup.
|
|
30
29
|
* For more information about Amazon S3 canned ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
30
|
+
* @public
|
|
31
31
|
*/
|
|
32
32
|
S3AclOption: S3AclOption | undefined;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>Contains an array of named query IDs.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
export interface BatchGetNamedQueryInput {
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>An array of query IDs.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
NamedQueryIds: string[] | undefined;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>A query, where <code>QueryString</code> contains the SQL statements that make up the
|
|
48
47
|
* query.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
export interface NamedQuery {
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>The query name.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
Name: string | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The query description.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
Description?: string;
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>The database to which the query belongs.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
Database: string | undefined;
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>The SQL statements that make up the query.</p>
|
|
68
|
+
* @public
|
|
69
69
|
*/
|
|
70
70
|
QueryString: string | undefined;
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>The unique identifier of the query.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
NamedQueryId?: string;
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The name of the workgroup that contains the named query.</p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
WorkGroup?: string;
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>Information about a named query ID that could not be processed.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
export interface UnprocessedNamedQueryId {
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>The unique identifier of the named query.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
NamedQueryId?: string;
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>The error code returned when the processing request for the named query failed, if
|
|
95
94
|
* applicable.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
ErrorCode?: string;
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The error message returned when the processing request for the named query failed, if
|
|
101
100
|
* applicable.</p>
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
ErrorMessage?: string;
|
|
104
104
|
}
|
|
@@ -107,20 +107,20 @@ export interface UnprocessedNamedQueryId {
|
|
|
107
107
|
*/
|
|
108
108
|
export interface BatchGetNamedQueryOutput {
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>Information about the named query IDs submitted.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
NamedQueries?: NamedQuery[];
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>Information about provided query IDs.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
UnprocessedNamedQueryIds?: UnprocessedNamedQueryId[];
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
* @public
|
|
122
121
|
* <p>Indicates a platform issue, which may be due to a transient condition or
|
|
123
122
|
* outage.</p>
|
|
123
|
+
* @public
|
|
124
124
|
*/
|
|
125
125
|
export declare class InternalServerException extends __BaseException {
|
|
126
126
|
readonly name: "InternalServerException";
|
|
@@ -132,17 +132,17 @@ export declare class InternalServerException extends __BaseException {
|
|
|
132
132
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p>Indicates that something is wrong with the input to the request. For example, a
|
|
137
136
|
* required parameter may be missing or out of range.</p>
|
|
137
|
+
* @public
|
|
138
138
|
*/
|
|
139
139
|
export declare class InvalidRequestException extends __BaseException {
|
|
140
140
|
readonly name: "InvalidRequestException";
|
|
141
141
|
readonly $fault: "client";
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>The error code returned when the query execution failed to process, or when the
|
|
145
144
|
* processing request for the named query failed.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
AthenaErrorCode?: string;
|
|
148
148
|
Message?: string;
|
|
@@ -156,64 +156,63 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
156
156
|
*/
|
|
157
157
|
export interface BatchGetPreparedStatementInput {
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>A list of prepared statement names to return.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
PreparedStatementNames: string[] | undefined;
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>The name of the workgroup to which the prepared statements belong.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
WorkGroup: string | undefined;
|
|
168
168
|
}
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p>A prepared SQL statement for use with Athena.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
export interface PreparedStatement {
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The name of the prepared statement.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
StatementName?: string;
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The query string for the prepared statement.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
QueryStatement?: string;
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The name of the workgroup to which the prepared statement belongs.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
WorkGroupName?: string;
|
|
189
189
|
/**
|
|
190
|
-
* @public
|
|
191
190
|
* <p>The description of the prepared statement.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
Description?: string;
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>The last modified time of the prepared statement.</p>
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
LastModifiedTime?: Date;
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* @public
|
|
202
201
|
* <p>The name of a prepared statement that could not be returned.</p>
|
|
202
|
+
* @public
|
|
203
203
|
*/
|
|
204
204
|
export interface UnprocessedPreparedStatementName {
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>The name of a prepared statement that could not be returned due to an error.</p>
|
|
207
|
+
* @public
|
|
208
208
|
*/
|
|
209
209
|
StatementName?: string;
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p>The error code returned when the request for the prepared statement failed.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
ErrorCode?: string;
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The error message containing the reason why the prepared statement could not be
|
|
218
217
|
* returned. The following error messages are possible:</p>
|
|
219
218
|
* <ul>
|
|
@@ -233,6 +232,7 @@ export interface UnprocessedPreparedStatementName {
|
|
|
233
232
|
* the workgroup that contains the prepared statement.</p>
|
|
234
233
|
* </li>
|
|
235
234
|
* </ul>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
ErrorMessage?: string;
|
|
238
238
|
}
|
|
@@ -241,65 +241,65 @@ export interface UnprocessedPreparedStatementName {
|
|
|
241
241
|
*/
|
|
242
242
|
export interface BatchGetPreparedStatementOutput {
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The list of prepared statements returned.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
PreparedStatements?: PreparedStatement[];
|
|
248
248
|
/**
|
|
249
|
-
* @public
|
|
250
249
|
* <p>A list of one or more prepared statements that were requested but could not be
|
|
251
250
|
* returned.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
UnprocessedPreparedStatementNames?: UnprocessedPreparedStatementName[];
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>Contains an array of query execution IDs.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
export interface BatchGetQueryExecutionInput {
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>An array of query execution IDs.</p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
QueryExecutionIds: string[] | undefined;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The Athena engine version for running queries, or the PySpark engine
|
|
269
268
|
* version for running sessions.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
export interface EngineVersion {
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The engine version requested by the user. Possible values are determined by the output
|
|
275
274
|
* of <code>ListEngineVersions</code>, including AUTO. The default is AUTO.</p>
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
SelectedEngineVersion?: string;
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>Read only. The engine version on which the query runs. If the user requests a valid
|
|
281
280
|
* engine version other than Auto, the effective engine version is the same as the engine
|
|
282
281
|
* version that the user requested. If the user requests Auto, the effective engine version
|
|
283
282
|
* is chosen by Athena. When a request to update the engine version is made by
|
|
284
283
|
* a <code>CreateWorkGroup</code> or <code>UpdateWorkGroup</code> operation, the
|
|
285
284
|
* <code>EffectiveEngineVersion</code> field is ignored.</p>
|
|
285
|
+
* @public
|
|
286
286
|
*/
|
|
287
287
|
EffectiveEngineVersion?: string;
|
|
288
288
|
}
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>The database and data catalog context in which the query execution occurs.</p>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
export interface QueryExecutionContext {
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>The name of the database used in the query execution. The database must exist in the
|
|
297
296
|
* catalog.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
Database?: string;
|
|
300
300
|
/**
|
|
301
|
-
* @public
|
|
302
301
|
* <p>The name of the data catalog used in the query execution.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
Catalog?: string;
|
|
305
305
|
}
|
|
@@ -315,27 +315,27 @@ export declare const AuthenticationType: {
|
|
|
315
315
|
*/
|
|
316
316
|
export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
320
319
|
* results.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
export interface QueryResultsS3AccessGrantsConfiguration {
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
326
325
|
* results.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
EnableS3AccessGrants: boolean | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>When enabled, appends the user ID as an Amazon S3 path prefix to the query
|
|
332
331
|
* result output location.</p>
|
|
332
|
+
* @public
|
|
333
333
|
*/
|
|
334
334
|
CreateUserLevelPrefix?: boolean;
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>The authentication type used for Amazon S3 access grants. Currently, only
|
|
338
337
|
* <code>DIRECTORY_IDENTITY</code> is supported.</p>
|
|
338
|
+
* @public
|
|
339
339
|
*/
|
|
340
340
|
AuthenticationType: AuthenticationType | undefined;
|
|
341
341
|
}
|
|
@@ -353,39 +353,38 @@ export declare const EncryptionOption: {
|
|
|
353
353
|
*/
|
|
354
354
|
export type EncryptionOption = (typeof EncryptionOption)[keyof typeof EncryptionOption];
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>If query and calculation results are encrypted in Amazon S3, indicates the
|
|
358
357
|
* encryption option used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and
|
|
359
358
|
* key information.</p>
|
|
359
|
+
* @public
|
|
360
360
|
*/
|
|
361
361
|
export interface EncryptionConfiguration {
|
|
362
362
|
/**
|
|
363
|
-
* @public
|
|
364
363
|
* <p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE_S3</code>), server-side encryption with KMS-managed keys
|
|
365
364
|
* (<code>SSE_KMS</code>), or client-side encryption with KMS-managed keys
|
|
366
365
|
* (<code>CSE_KMS</code>) is used.</p>
|
|
367
366
|
* <p>If a query runs in a workgroup and the workgroup overrides client-side settings, then
|
|
368
367
|
* the workgroup's setting for encryption is used. It specifies whether query results must
|
|
369
368
|
* be encrypted, for all queries that run in this workgroup. </p>
|
|
369
|
+
* @public
|
|
370
370
|
*/
|
|
371
371
|
EncryptionOption: EncryptionOption | undefined;
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>For <code>SSE_KMS</code> and <code>CSE_KMS</code>, this is the KMS key ARN or
|
|
375
374
|
* ID.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
KmsKey?: string;
|
|
378
378
|
}
|
|
379
379
|
/**
|
|
380
|
-
* @public
|
|
381
380
|
* <p>The location in Amazon S3 where query and calculation results are stored and
|
|
382
381
|
* the encryption option, if any, used for query and calculation results. These are known
|
|
383
382
|
* as "client-side settings". If workgroup settings override client-side settings, then the
|
|
384
383
|
* query uses the workgroup settings.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
export interface ResultConfiguration {
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The location in Amazon S3 where your query and calculation results are stored,
|
|
390
389
|
* such as <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the
|
|
391
390
|
* query results location using one of the ways: either for individual queries using either
|
|
@@ -394,10 +393,10 @@ export interface ResultConfiguration {
|
|
|
394
393
|
* results, recent queries, and output files</a>. If workgroup settings override
|
|
395
394
|
* client-side settings, then the query uses the settings specified for the workgroup. See
|
|
396
395
|
* <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
OutputLocation?: string;
|
|
399
399
|
/**
|
|
400
|
-
* @public
|
|
401
400
|
* <p>If query and calculation results are encrypted in Amazon S3, indicates the
|
|
402
401
|
* encryption option used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and
|
|
403
402
|
* key information. This is a client-side setting. If workgroup settings override
|
|
@@ -405,10 +404,10 @@ export interface ResultConfiguration {
|
|
|
405
404
|
* for the workgroup, and also uses the location for storing query results specified in the
|
|
406
405
|
* workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>
|
|
407
406
|
* and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
407
|
+
* @public
|
|
408
408
|
*/
|
|
409
409
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
410
410
|
/**
|
|
411
|
-
* @public
|
|
412
411
|
* <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>.
|
|
413
412
|
* If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it
|
|
414
413
|
* makes Amazon S3 calls to your specified output location. If the
|
|
@@ -420,46 +419,47 @@ export interface ResultConfiguration {
|
|
|
420
419
|
* the workgroup, and also uses the location for storing query results specified in the
|
|
421
420
|
* workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>
|
|
422
421
|
* and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
ExpectedBucketOwner?: string;
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>Indicates that an Amazon S3 canned ACL should be set to control ownership of
|
|
428
427
|
* stored query results. Currently the only supported canned ACL is
|
|
429
428
|
* <code>BUCKET_OWNER_FULL_CONTROL</code>. This is a client-side setting. If workgroup
|
|
430
429
|
* settings override client-side settings, then the query uses the ACL configuration that
|
|
431
430
|
* is specified for the workgroup, and also uses the location for storing query results
|
|
432
431
|
* specified in the workgroup. For more information, see <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
AclConfiguration?: AclConfiguration;
|
|
435
435
|
}
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>Specifies whether previous query results are reused, and if so, their maximum
|
|
439
438
|
* age.</p>
|
|
439
|
+
* @public
|
|
440
440
|
*/
|
|
441
441
|
export interface ResultReuseByAgeConfiguration {
|
|
442
442
|
/**
|
|
443
|
-
* @public
|
|
444
443
|
* <p>True if previous query results can be reused when the query is run; otherwise, false.
|
|
445
444
|
* The default is false.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
Enabled: boolean | undefined;
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
MaxAgeInMinutes?: number;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>Specifies the query result reuse behavior for the query.</p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
export interface ResultReuseConfiguration {
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>Specifies whether previous query results are reused, and if so, their maximum
|
|
462
461
|
* age.</p>
|
|
462
|
+
* @public
|
|
463
463
|
*/
|
|
464
464
|
ResultReuseByAgeConfiguration?: ResultReuseByAgeConfiguration;
|
|
465
465
|
}
|
|
@@ -477,35 +477,34 @@ export declare const StatementType: {
|
|
|
477
477
|
*/
|
|
478
478
|
export type StatementType = (typeof StatementType)[keyof typeof StatementType];
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>Contains information about whether the result of a previous query was reused.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
export interface ResultReuseInformation {
|
|
484
484
|
/**
|
|
485
|
-
* @public
|
|
486
485
|
* <p>True if a previous query result was reused; false if the result was generated from a
|
|
487
486
|
* new run of the query.</p>
|
|
487
|
+
* @public
|
|
488
488
|
*/
|
|
489
489
|
ReusedPreviousResult: boolean | undefined;
|
|
490
490
|
}
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>The amount of data scanned during the query execution and the amount of time that it
|
|
494
493
|
* took to execute, and the type of statement that was run.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
export interface QueryExecutionStatistics {
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>The number of milliseconds that the query took to execute.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
EngineExecutionTimeInMillis?: number;
|
|
502
502
|
/**
|
|
503
|
-
* @public
|
|
504
503
|
* <p>The number of bytes in the data that was queried.</p>
|
|
504
|
+
* @public
|
|
505
505
|
*/
|
|
506
506
|
DataScannedInBytes?: number;
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>The location and file name of a data manifest file. The manifest file is saved to the
|
|
510
509
|
* Athena query results location in Amazon S3. The manifest file
|
|
511
510
|
* tracks files that the query wrote to Amazon S3. If the query fails, the manifest
|
|
@@ -513,59 +512,59 @@ export interface QueryExecutionStatistics {
|
|
|
513
512
|
* identifying orphaned files resulting from a failed query. For more information, see
|
|
514
513
|
* <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with Query
|
|
515
514
|
* Results, Output Files, and Query History</a> in the <i>Amazon Athena User Guide</i>.</p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
DataManifestLocation?: string;
|
|
518
518
|
/**
|
|
519
|
-
* @public
|
|
520
519
|
* <p>The number of milliseconds that Athena took to run the query.</p>
|
|
520
|
+
* @public
|
|
521
521
|
*/
|
|
522
522
|
TotalExecutionTimeInMillis?: number;
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>The number of milliseconds that the query was in your query queue waiting for
|
|
526
525
|
* resources. Note that if transient errors occur, Athena might automatically
|
|
527
526
|
* add the query back to the queue.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
QueryQueueTimeInMillis?: number;
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>The number of milliseconds that Athena took to preprocess the query before
|
|
533
532
|
* submitting the query to the query engine.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
ServicePreProcessingTimeInMillis?: number;
|
|
536
536
|
/**
|
|
537
|
-
* @public
|
|
538
537
|
* <p>The number of milliseconds that Athena took to plan the query processing
|
|
539
538
|
* flow. This includes the time spent retrieving table partitions from the data source.
|
|
540
539
|
* Note that because the query engine performs the query planning, query planning time is a
|
|
541
540
|
* subset of engine processing time.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
QueryPlanningTimeInMillis?: number;
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>The number of milliseconds that Athena took to finalize and publish the
|
|
547
546
|
* query results after the query engine finished running the query.</p>
|
|
547
|
+
* @public
|
|
548
548
|
*/
|
|
549
549
|
ServiceProcessingTimeInMillis?: number;
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>Contains information about whether previous query results were reused for the
|
|
553
552
|
* query.</p>
|
|
553
|
+
* @public
|
|
554
554
|
*/
|
|
555
555
|
ResultReuseInformation?: ResultReuseInformation;
|
|
556
556
|
}
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* <p>Provides information about an Athena query error. The
|
|
560
559
|
* <code>AthenaError</code> feature provides standardized error information to help you
|
|
561
560
|
* understand failed queries and take steps after a query failure occurs.
|
|
562
561
|
* <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies
|
|
563
562
|
* whether the cause of the failed query is due to system error, user error, or other
|
|
564
563
|
* error.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
export interface AthenaError {
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <p>An integer value that specifies the category of a query failure error. The following
|
|
570
569
|
* list shows the category for each integer value.</p>
|
|
571
570
|
* <p>
|
|
@@ -574,23 +573,24 @@ export interface AthenaError {
|
|
|
574
573
|
* <b>2</b> - User</p>
|
|
575
574
|
* <p>
|
|
576
575
|
* <b>3</b> - Other</p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
ErrorCategory?: number;
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>An integer value that provides specific information about an Athena query
|
|
582
581
|
* 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
|
|
583
582
|
* Guide</i>.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
ErrorType?: number;
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>True if the query might succeed if resubmitted.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
Retryable?: boolean;
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>Contains a short description of the error that occurred.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
ErrorMessage?: string;
|
|
596
596
|
}
|
|
@@ -610,13 +610,12 @@ export declare const QueryExecutionState: {
|
|
|
610
610
|
*/
|
|
611
611
|
export type QueryExecutionState = (typeof QueryExecutionState)[keyof typeof QueryExecutionState];
|
|
612
612
|
/**
|
|
613
|
-
* @public
|
|
614
613
|
* <p>The completion date, current state, submission time, and state change reason (if
|
|
615
614
|
* applicable) for the query execution.</p>
|
|
615
|
+
* @public
|
|
616
616
|
*/
|
|
617
617
|
export interface QueryExecutionStatus {
|
|
618
618
|
/**
|
|
619
|
-
* @public
|
|
620
619
|
* <p>The state of query execution. <code>QUEUED</code> indicates that the query has been
|
|
621
620
|
* submitted to the service, and Athena will execute the query as soon as
|
|
622
621
|
* resources are available. <code>RUNNING</code> indicates that the query is in execution
|
|
@@ -629,133 +628,134 @@ export interface QueryExecutionStatus {
|
|
|
629
628
|
* transient errors. As a result, you may see the query state transition from
|
|
630
629
|
* <code>RUNNING</code> or <code>FAILED</code> to <code>QUEUED</code>. </p>
|
|
631
630
|
* </note>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
State?: QueryExecutionState;
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>Further detail about the status of the query.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
StateChangeReason?: string;
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The date and time that the query was submitted.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
SubmissionDateTime?: Date;
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>The date and time that the query completed.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
CompletionDateTime?: Date;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>Provides information about an Athena query error.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
AthenaError?: AthenaError;
|
|
654
654
|
}
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>Information about a single instance of a query execution.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
export interface QueryExecution {
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>The unique identifier for each query execution.</p>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
QueryExecutionId?: string;
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>The SQL query statements which the query execution ran.</p>
|
|
667
|
+
* @public
|
|
668
668
|
*/
|
|
669
669
|
Query?: string;
|
|
670
670
|
/**
|
|
671
|
-
* @public
|
|
672
671
|
* <p>The type of query statement that was run. <code>DDL</code> indicates DDL query
|
|
673
672
|
* statements. <code>DML</code> indicates DML (Data Manipulation Language) query
|
|
674
673
|
* statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates
|
|
675
674
|
* query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or
|
|
676
675
|
* <code>DESCRIBE TABLE</code>.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
StatementType?: StatementType;
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <p>The location in Amazon S3 where query and calculation results are stored and
|
|
682
681
|
* the encryption option, if any, used for query results. These are known as "client-side
|
|
683
682
|
* settings". If workgroup settings override client-side settings, then the query uses the
|
|
684
683
|
* location for the query results and the encryption configuration that are specified for
|
|
685
684
|
* the workgroup.</p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
ResultConfiguration?: ResultConfiguration;
|
|
688
688
|
/**
|
|
689
|
-
* @public
|
|
690
689
|
* <p>Specifies the query result reuse behavior that was used for the query.</p>
|
|
690
|
+
* @public
|
|
691
691
|
*/
|
|
692
692
|
ResultReuseConfiguration?: ResultReuseConfiguration;
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>The database in which the query execution occurred.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
QueryExecutionContext?: QueryExecutionContext;
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>The completion date, current state, submission time, and state change reason (if
|
|
701
700
|
* applicable) for the query execution.</p>
|
|
701
|
+
* @public
|
|
702
702
|
*/
|
|
703
703
|
Status?: QueryExecutionStatus;
|
|
704
704
|
/**
|
|
705
|
-
* @public
|
|
706
705
|
* <p>Query execution statistics, such as the amount of data scanned, the amount of time
|
|
707
706
|
* that the query took to process, and the type of statement that was run.</p>
|
|
707
|
+
* @public
|
|
708
708
|
*/
|
|
709
709
|
Statistics?: QueryExecutionStatistics;
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>The name of the workgroup in which the query ran.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
WorkGroup?: string;
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>The engine version that executed the query.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
EngineVersion?: EngineVersion;
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>A list of values for the parameters in a query. The values are applied sequentially to
|
|
723
722
|
* the parameters in the query in the order in which the parameters occur. The list of
|
|
724
723
|
* parameters is not returned in the response.</p>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
ExecutionParameters?: string[];
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>The kind of query statement that was run.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
SubstatementType?: string;
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
735
734
|
* results.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
738
738
|
}
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>Describes a query execution that failed to process.</p>
|
|
741
|
+
* @public
|
|
742
742
|
*/
|
|
743
743
|
export interface UnprocessedQueryExecutionId {
|
|
744
744
|
/**
|
|
745
|
-
* @public
|
|
746
745
|
* <p>The unique identifier of the query execution.</p>
|
|
746
|
+
* @public
|
|
747
747
|
*/
|
|
748
748
|
QueryExecutionId?: string;
|
|
749
749
|
/**
|
|
750
|
-
* @public
|
|
751
750
|
* <p>The error code returned when the query execution failed to process, if
|
|
752
751
|
* applicable.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
ErrorCode?: string;
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The error message returned when the query execution failed to process, if
|
|
758
757
|
* applicable.</p>
|
|
758
|
+
* @public
|
|
759
759
|
*/
|
|
760
760
|
ErrorMessage?: string;
|
|
761
761
|
}
|
|
@@ -764,13 +764,13 @@ export interface UnprocessedQueryExecutionId {
|
|
|
764
764
|
*/
|
|
765
765
|
export interface BatchGetQueryExecutionOutput {
|
|
766
766
|
/**
|
|
767
|
-
* @public
|
|
768
767
|
* <p>Information about a query execution.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
QueryExecutions?: QueryExecution[];
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Information about the query executions that failed to run.</p>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionId[];
|
|
776
776
|
}
|
|
@@ -779,8 +779,8 @@ export interface BatchGetQueryExecutionOutput {
|
|
|
779
779
|
*/
|
|
780
780
|
export interface CancelCapacityReservationInput {
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The name of the capacity reservation to cancel.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
Name: string | undefined;
|
|
786
786
|
}
|
|
@@ -790,7 +790,6 @@ export interface CancelCapacityReservationInput {
|
|
|
790
790
|
export interface CancelCapacityReservationOutput {
|
|
791
791
|
}
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>A label that you assign to a resource. Athena resources include
|
|
795
794
|
* workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an
|
|
796
795
|
* optional value, both of which you define. For example, you can use tags to categorize
|
|
@@ -802,20 +801,21 @@ export interface CancelCapacityReservationOutput {
|
|
|
802
801
|
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys
|
|
803
802
|
* and values are case-sensitive. Tag keys must be unique per resource. If you specify more
|
|
804
803
|
* than one tag, separate them by commas. </p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
export interface Tag {
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can
|
|
810
809
|
* use letters and numbers representable in UTF-8, and the following characters: + - = . _
|
|
811
810
|
* : / @. Tag keys are case-sensitive and must be unique per resource. </p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
Key?: string;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You
|
|
817
816
|
* can use letters and numbers representable in UTF-8, and the following characters: + - =
|
|
818
817
|
* . _ : / @. Tag values are case-sensitive. </p>
|
|
818
|
+
* @public
|
|
819
819
|
*/
|
|
820
820
|
Value?: string;
|
|
821
821
|
}
|
|
@@ -824,18 +824,18 @@ export interface Tag {
|
|
|
824
824
|
*/
|
|
825
825
|
export interface CreateCapacityReservationInput {
|
|
826
826
|
/**
|
|
827
|
-
* @public
|
|
828
827
|
* <p>The number of requested data processing units.</p>
|
|
828
|
+
* @public
|
|
829
829
|
*/
|
|
830
830
|
TargetDpus: number | undefined;
|
|
831
831
|
/**
|
|
832
|
-
* @public
|
|
833
832
|
* <p>The name of the capacity reservation to create.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
Name: string | undefined;
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>The tags for the capacity reservation.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
Tags?: Tag[];
|
|
841
841
|
}
|
|
@@ -862,27 +862,26 @@ export type DataCatalogType = (typeof DataCatalogType)[keyof typeof DataCatalogT
|
|
|
862
862
|
*/
|
|
863
863
|
export interface CreateDataCatalogInput {
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>The name of the data catalog to create. The catalog name must be unique for the
|
|
867
866
|
* Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at
|
|
868
867
|
* sign, or hyphen characters. The remainder of the length constraint of 256 is reserved
|
|
869
868
|
* for use by Athena.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
Name: string | undefined;
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
875
874
|
* <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
|
|
876
875
|
* Glue Data Catalog.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
Type: DataCatalogType | undefined;
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <p>A description of the data catalog to be created.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
Description?: string;
|
|
884
884
|
/**
|
|
885
|
-
* @public
|
|
886
885
|
* <p>Specifies the Lambda function or functions to use for creating the data
|
|
887
886
|
* catalog. This is a mapping whose values depend on the catalog type. </p>
|
|
888
887
|
* <ul>
|
|
@@ -941,11 +940,12 @@ export interface CreateDataCatalogInput {
|
|
|
941
940
|
* </ul>
|
|
942
941
|
* </li>
|
|
943
942
|
* </ul>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
Parameters?: Record<string, string>;
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>A list of comma separated tags to add to the data catalog that is created.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
Tags?: Tag[];
|
|
951
951
|
}
|
|
@@ -959,27 +959,26 @@ export interface CreateDataCatalogOutput {
|
|
|
959
959
|
*/
|
|
960
960
|
export interface CreateNamedQueryInput {
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The query name.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
Name: string | undefined;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>The query description.</p>
|
|
968
|
+
* @public
|
|
969
969
|
*/
|
|
970
970
|
Description?: string;
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The database to which the query belongs.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
Database: string | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The contents of the query with all query statements.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
QueryString: string | undefined;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>A unique case-sensitive string used to ensure the request to create the query is
|
|
984
983
|
* idempotent (executes only once). If another <code>CreateNamedQuery</code> request is
|
|
985
984
|
* received, the same response is returned and another query is not created. If a parameter
|
|
@@ -990,11 +989,12 @@ export interface CreateNamedQueryInput {
|
|
|
990
989
|
* not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
991
990
|
* this token or the action will fail.</p>
|
|
992
991
|
* </important>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
ClientRequestToken?: string;
|
|
995
995
|
/**
|
|
996
|
-
* @public
|
|
997
996
|
* <p>The name of the workgroup in which the named query is being created.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
WorkGroup?: string;
|
|
1000
1000
|
}
|
|
@@ -1003,8 +1003,8 @@ export interface CreateNamedQueryInput {
|
|
|
1003
1003
|
*/
|
|
1004
1004
|
export interface CreateNamedQueryOutput {
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>The unique ID of the query.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
NamedQueryId?: string;
|
|
1010
1010
|
}
|
|
@@ -1013,18 +1013,17 @@ export interface CreateNamedQueryOutput {
|
|
|
1013
1013
|
*/
|
|
1014
1014
|
export interface CreateNotebookInput {
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The name of the Spark enabled workgroup in which the notebook will be created.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
WorkGroup: string | undefined;
|
|
1020
1020
|
/**
|
|
1021
|
-
* @public
|
|
1022
1021
|
* <p>The name of the <code>ipynb</code> file to be created in the Spark workgroup, without
|
|
1023
1022
|
* the <code>.ipynb</code> extension.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
Name: string | undefined;
|
|
1026
1026
|
/**
|
|
1027
|
-
* @public
|
|
1028
1027
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
1029
1028
|
* idempotent (executes only once).</p>
|
|
1030
1029
|
* <important>
|
|
@@ -1033,6 +1032,7 @@ export interface CreateNotebookInput {
|
|
|
1033
1032
|
* using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
1034
1033
|
* this token or the action will fail.</p>
|
|
1035
1034
|
* </important>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
ClientRequestToken?: string;
|
|
1038
1038
|
}
|
|
@@ -1041,8 +1041,8 @@ export interface CreateNotebookInput {
|
|
|
1041
1041
|
*/
|
|
1042
1042
|
export interface CreateNotebookOutput {
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>A unique identifier for the notebook.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
NotebookId?: string;
|
|
1048
1048
|
}
|
|
@@ -1058,17 +1058,17 @@ export declare const ThrottleReason: {
|
|
|
1058
1058
|
*/
|
|
1059
1059
|
export type ThrottleReason = (typeof ThrottleReason)[keyof typeof ThrottleReason];
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>Indicates that the request was throttled.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
export declare class TooManyRequestsException extends __BaseException {
|
|
1065
1065
|
readonly name: "TooManyRequestsException";
|
|
1066
1066
|
readonly $fault: "client";
|
|
1067
1067
|
Message?: string;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>The reason for the query throttling, for example, when it exceeds the concurrent query
|
|
1071
1070
|
* limit.</p>
|
|
1071
|
+
* @public
|
|
1072
1072
|
*/
|
|
1073
1073
|
Reason?: ThrottleReason;
|
|
1074
1074
|
/**
|
|
@@ -1081,23 +1081,23 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
1081
1081
|
*/
|
|
1082
1082
|
export interface CreatePreparedStatementInput {
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>The name of the prepared statement.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
StatementName: string | undefined;
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>The name of the workgroup to which the prepared statement belongs.</p>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
WorkGroup: string | undefined;
|
|
1093
1093
|
/**
|
|
1094
|
-
* @public
|
|
1095
1094
|
* <p>The query string for the prepared statement.</p>
|
|
1095
|
+
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
QueryStatement: string | undefined;
|
|
1098
1098
|
/**
|
|
1099
|
-
* @public
|
|
1100
1099
|
* <p>The description of the prepared statement.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
Description?: string;
|
|
1103
1103
|
}
|
|
@@ -1111,8 +1111,8 @@ export interface CreatePreparedStatementOutput {
|
|
|
1111
1111
|
*/
|
|
1112
1112
|
export interface CreatePresignedNotebookUrlRequest {
|
|
1113
1113
|
/**
|
|
1114
|
-
* @public
|
|
1115
1114
|
* <p>The session ID.</p>
|
|
1115
|
+
* @public
|
|
1116
1116
|
*/
|
|
1117
1117
|
SessionId: string | undefined;
|
|
1118
1118
|
}
|
|
@@ -1121,33 +1121,33 @@ export interface CreatePresignedNotebookUrlRequest {
|
|
|
1121
1121
|
*/
|
|
1122
1122
|
export interface CreatePresignedNotebookUrlResponse {
|
|
1123
1123
|
/**
|
|
1124
|
-
* @public
|
|
1125
1124
|
* <p>The URL of the notebook. The URL includes the authentication token and notebook file
|
|
1126
1125
|
* name and points directly to the opened notebook.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
NotebookUrl: string | undefined;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>The authentication token for the notebook.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
AuthToken: string | undefined;
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <p>The UTC epoch time when the authentication token expires.</p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
AuthTokenExpirationTime: number | undefined;
|
|
1139
1139
|
}
|
|
1140
1140
|
/**
|
|
1141
|
-
* @public
|
|
1142
1141
|
* <p>A resource, such as a workgroup, was not found.</p>
|
|
1142
|
+
* @public
|
|
1143
1143
|
*/
|
|
1144
1144
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1145
1145
|
readonly name: "ResourceNotFoundException";
|
|
1146
1146
|
readonly $fault: "client";
|
|
1147
1147
|
Message?: string;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The name of the Amazon resource.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
ResourceName?: string;
|
|
1153
1153
|
/**
|
|
@@ -1156,36 +1156,35 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1156
1156
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1157
1157
|
}
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>Specifies the customer managed KMS key that is used to encrypt the user's data stores
|
|
1161
1160
|
* in Athena. When an Amazon Web Services managed key is used, this value is
|
|
1162
1161
|
* null. This setting does not apply to Athena SQL workgroups.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
export interface CustomerContentEncryptionConfiguration {
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>The customer managed KMS key that is used to encrypt the user's data stores in Athena.</p>
|
|
1167
|
+
* @public
|
|
1168
1168
|
*/
|
|
1169
1169
|
KmsKey: string | undefined;
|
|
1170
1170
|
}
|
|
1171
1171
|
/**
|
|
1172
|
-
* @public
|
|
1173
1172
|
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1173
|
+
* @public
|
|
1174
1174
|
*/
|
|
1175
1175
|
export interface IdentityCenterConfiguration {
|
|
1176
1176
|
/**
|
|
1177
|
-
* @public
|
|
1178
1177
|
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1178
|
+
* @public
|
|
1179
1179
|
*/
|
|
1180
1180
|
EnableIdentityCenter?: boolean;
|
|
1181
1181
|
/**
|
|
1182
|
-
* @public
|
|
1183
1182
|
* <p>The IAM Identity Center instance ARN that the workgroup associates to.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
IdentityCenterInstanceArn?: string;
|
|
1186
1186
|
}
|
|
1187
1187
|
/**
|
|
1188
|
-
* @public
|
|
1189
1188
|
* <p>The configuration of the workgroup, which includes the location in Amazon S3
|
|
1190
1189
|
* where query and calculation results are stored, the encryption option, if any, used for
|
|
1191
1190
|
* query and calculation results, whether the Amazon CloudWatch Metrics are enabled for
|
|
@@ -1193,37 +1192,37 @@ export interface IdentityCenterConfiguration {
|
|
|
1193
1192
|
* limits for the amount of data scanned per query or per workgroup. The workgroup settings
|
|
1194
1193
|
* override is specified in <code>EnforceWorkGroupConfiguration</code> (true/false) in the
|
|
1195
1194
|
* <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>. </p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
export interface WorkGroupConfiguration {
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>The configuration for the workgroup, which includes the location in Amazon S3
|
|
1201
1200
|
* where query and calculation results are stored and the encryption option, if any, used
|
|
1202
1201
|
* for query and calculation results. To run the query, you must specify the query results
|
|
1203
1202
|
* location using one of the ways: either in the workgroup using this setting, or for
|
|
1204
1203
|
* individual queries (client-side), using <a>ResultConfiguration$OutputLocation</a>. If none of them is set, Athena issues an error that no output location is provided. For more
|
|
1205
1204
|
* information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and output files</a>.</p>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
ResultConfiguration?: ResultConfiguration;
|
|
1208
1208
|
/**
|
|
1209
|
-
* @public
|
|
1210
1209
|
* <p>If set to "true", the settings for the workgroup override client-side settings. If set
|
|
1211
1210
|
* 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>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
EnforceWorkGroupConfiguration?: boolean;
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
PublishCloudWatchMetricsEnabled?: boolean;
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>The upper data usage limit (cutoff) for the amount of bytes a single query in a
|
|
1222
1221
|
* workgroup is allowed to scan.</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
BytesScannedCutoffPerQuery?: number;
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>If set to <code>true</code>, allows members assigned to a workgroup to reference
|
|
1228
1227
|
* Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>,
|
|
1229
1228
|
* workgroup members cannot query data from Requester Pays buckets, and queries that
|
|
@@ -1231,35 +1230,35 @@ export interface WorkGroupConfiguration {
|
|
|
1231
1230
|
* <code>false</code>. For more information about Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester
|
|
1232
1231
|
* Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer
|
|
1233
1232
|
* Guide</i>.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
RequesterPaysEnabled?: boolean;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The engine version that all queries running on the workgroup use. Queries on the
|
|
1239
1238
|
* <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine
|
|
1240
1239
|
* regardless of this setting.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
EngineVersion?: EngineVersion;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>Specifies a user defined JSON string that is passed to the notebook engine.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
AdditionalConfiguration?: string;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The ARN of the execution role used to access user resources for Spark sessions and
|
|
1251
1250
|
* IAM Identity Center enabled workgroups. This property applies only to Spark enabled
|
|
1252
1251
|
* workgroups and IAM Identity Center enabled workgroups. The property is required for
|
|
1253
1252
|
* IAM Identity Center enabled workgroups.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
ExecutionRole?: string;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <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>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
1261
1261
|
/**
|
|
1262
|
-
* @public
|
|
1263
1262
|
* <p>Enforces a minimal level of encryption for the workgroup for query and calculation
|
|
1264
1263
|
* results that are written to Amazon S3. When enabled, workgroup users can set
|
|
1265
1264
|
* encryption only to the minimum level set by the administrator or higher when they submit
|
|
@@ -1269,17 +1268,18 @@ export interface WorkGroupConfiguration {
|
|
|
1269
1268
|
* <code>EnforceWorkGroupConfiguration</code> is true, the
|
|
1270
1269
|
* <code>EnableMinimumEncryptionConfiguration</code> flag is ignored, and the workgroup
|
|
1271
1270
|
* configuration for encryption is used.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
IdentityCenterConfiguration?: IdentityCenterConfiguration;
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
1282
1281
|
* results.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
1285
1285
|
}
|
|
@@ -1288,12 +1288,11 @@ export interface WorkGroupConfiguration {
|
|
|
1288
1288
|
*/
|
|
1289
1289
|
export interface CreateWorkGroupInput {
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>The workgroup name.</p>
|
|
1292
|
+
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
Name: string | undefined;
|
|
1295
1295
|
/**
|
|
1296
|
-
* @public
|
|
1297
1296
|
* <p>Contains configuration information for creating an Athena SQL workgroup or
|
|
1298
1297
|
* Spark enabled Athena workgroup. Athena SQL workgroup
|
|
1299
1298
|
* configuration includes the location in Amazon S3 where query and calculation
|
|
@@ -1302,16 +1301,17 @@ export interface CreateWorkGroupInput {
|
|
|
1302
1301
|
* limit for the amount of bytes scanned (cutoff) per query, if it is specified, and
|
|
1303
1302
|
* whether workgroup's settings (specified with <code>EnforceWorkGroupConfiguration</code>)
|
|
1304
1303
|
* in the <code>WorkGroupConfiguration</code> override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
Configuration?: WorkGroupConfiguration;
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>The workgroup description.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
Description?: string;
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>A list of comma separated tags to add to the workgroup that is created.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
Tags?: Tag[];
|
|
1317
1317
|
}
|
|
@@ -1325,8 +1325,8 @@ export interface CreateWorkGroupOutput {
|
|
|
1325
1325
|
*/
|
|
1326
1326
|
export interface DeleteCapacityReservationInput {
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>The name of the capacity reservation to delete.</p>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
Name: string | undefined;
|
|
1332
1332
|
}
|
|
@@ -1340,8 +1340,8 @@ export interface DeleteCapacityReservationOutput {
|
|
|
1340
1340
|
*/
|
|
1341
1341
|
export interface DeleteDataCatalogInput {
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The name of the data catalog to delete.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
Name: string | undefined;
|
|
1347
1347
|
}
|
|
@@ -1355,8 +1355,8 @@ export interface DeleteDataCatalogOutput {
|
|
|
1355
1355
|
*/
|
|
1356
1356
|
export interface DeleteNamedQueryInput {
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>The unique ID of the query to delete.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
NamedQueryId?: string;
|
|
1362
1362
|
}
|
|
@@ -1370,8 +1370,8 @@ export interface DeleteNamedQueryOutput {
|
|
|
1370
1370
|
*/
|
|
1371
1371
|
export interface DeleteNotebookInput {
|
|
1372
1372
|
/**
|
|
1373
|
-
* @public
|
|
1374
1373
|
* <p>The ID of the notebook to delete.</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
NotebookId: string | undefined;
|
|
1377
1377
|
}
|
|
@@ -1385,13 +1385,13 @@ export interface DeleteNotebookOutput {
|
|
|
1385
1385
|
*/
|
|
1386
1386
|
export interface DeletePreparedStatementInput {
|
|
1387
1387
|
/**
|
|
1388
|
-
* @public
|
|
1389
1388
|
* <p>The name of the prepared statement to delete.</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
StatementName: string | undefined;
|
|
1392
1392
|
/**
|
|
1393
|
-
* @public
|
|
1394
1393
|
* <p>The workgroup to which the statement to be deleted belongs.</p>
|
|
1394
|
+
* @public
|
|
1395
1395
|
*/
|
|
1396
1396
|
WorkGroup: string | undefined;
|
|
1397
1397
|
}
|
|
@@ -1405,14 +1405,14 @@ export interface DeletePreparedStatementOutput {
|
|
|
1405
1405
|
*/
|
|
1406
1406
|
export interface DeleteWorkGroupInput {
|
|
1407
1407
|
/**
|
|
1408
|
-
* @public
|
|
1409
1408
|
* <p>The unique name of the workgroup to delete.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
WorkGroup: string | undefined;
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>The option to delete the workgroup and its contents even if the workgroup contains any
|
|
1415
1414
|
* named queries, query executions, or notebooks.</p>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
RecursiveDeleteOption?: boolean;
|
|
1418
1418
|
}
|
|
@@ -1426,8 +1426,8 @@ export interface DeleteWorkGroupOutput {
|
|
|
1426
1426
|
*/
|
|
1427
1427
|
export interface ExportNotebookInput {
|
|
1428
1428
|
/**
|
|
1429
|
-
* @public
|
|
1430
1429
|
* <p>The ID of the notebook to export.</p>
|
|
1430
|
+
* @public
|
|
1431
1431
|
*/
|
|
1432
1432
|
NotebookId: string | undefined;
|
|
1433
1433
|
}
|
|
@@ -1443,39 +1443,39 @@ export declare const NotebookType: {
|
|
|
1443
1443
|
*/
|
|
1444
1444
|
export type NotebookType = (typeof NotebookType)[keyof typeof NotebookType];
|
|
1445
1445
|
/**
|
|
1446
|
-
* @public
|
|
1447
1446
|
* <p>Contains metadata for notebook, including the notebook name, ID, workgroup, and time
|
|
1448
1447
|
* created.</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
export interface NotebookMetadata {
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>The notebook ID.</p>
|
|
1453
|
+
* @public
|
|
1454
1454
|
*/
|
|
1455
1455
|
NotebookId?: string;
|
|
1456
1456
|
/**
|
|
1457
|
-
* @public
|
|
1458
1457
|
* <p>The name of the notebook.</p>
|
|
1458
|
+
* @public
|
|
1459
1459
|
*/
|
|
1460
1460
|
Name?: string;
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The name of the Spark enabled workgroup to which the notebook belongs.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
WorkGroup?: string;
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>The time when the notebook was created.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
CreationTime?: Date;
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>The type of notebook. Currently, the only valid type is <code>IPYNB</code>.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
Type?: NotebookType;
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>The time when the notebook was last modified.</p>
|
|
1478
|
+
* @public
|
|
1479
1479
|
*/
|
|
1480
1480
|
LastModifiedTime?: Date;
|
|
1481
1481
|
}
|
|
@@ -1484,14 +1484,14 @@ export interface NotebookMetadata {
|
|
|
1484
1484
|
*/
|
|
1485
1485
|
export interface ExportNotebookOutput {
|
|
1486
1486
|
/**
|
|
1487
|
-
* @public
|
|
1488
1487
|
* <p>The notebook metadata, including notebook ID, notebook name, and workgroup
|
|
1489
1488
|
* name.</p>
|
|
1489
|
+
* @public
|
|
1490
1490
|
*/
|
|
1491
1491
|
NotebookMetadata?: NotebookMetadata;
|
|
1492
1492
|
/**
|
|
1493
|
-
* @public
|
|
1494
1493
|
* <p>The content of the exported notebook.</p>
|
|
1494
|
+
* @public
|
|
1495
1495
|
*/
|
|
1496
1496
|
Payload?: string;
|
|
1497
1497
|
}
|
|
@@ -1500,51 +1500,51 @@ export interface ExportNotebookOutput {
|
|
|
1500
1500
|
*/
|
|
1501
1501
|
export interface GetCalculationExecutionRequest {
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>The calculation execution UUID.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
CalculationExecutionId: string | undefined;
|
|
1507
1507
|
}
|
|
1508
1508
|
/**
|
|
1509
|
-
* @public
|
|
1510
1509
|
* <p>Contains information about an application-specific calculation result.</p>
|
|
1510
|
+
* @public
|
|
1511
1511
|
*/
|
|
1512
1512
|
export interface CalculationResult {
|
|
1513
1513
|
/**
|
|
1514
|
-
* @public
|
|
1515
1514
|
* <p>The Amazon S3 location of the <code>stdout</code> file for the calculation.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
StdOutS3Uri?: string;
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>The Amazon S3 location of the <code>stderr</code> error messages file for the
|
|
1521
1520
|
* calculation.</p>
|
|
1521
|
+
* @public
|
|
1522
1522
|
*/
|
|
1523
1523
|
StdErrorS3Uri?: string;
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>The Amazon S3 location of the folder for the calculation results.</p>
|
|
1526
|
+
* @public
|
|
1527
1527
|
*/
|
|
1528
1528
|
ResultS3Uri?: string;
|
|
1529
1529
|
/**
|
|
1530
|
-
* @public
|
|
1531
1530
|
* <p>The data format of the calculation result.</p>
|
|
1531
|
+
* @public
|
|
1532
1532
|
*/
|
|
1533
1533
|
ResultType?: string;
|
|
1534
1534
|
}
|
|
1535
1535
|
/**
|
|
1536
|
-
* @public
|
|
1537
1536
|
* <p>Contains statistics for a notebook calculation.</p>
|
|
1537
|
+
* @public
|
|
1538
1538
|
*/
|
|
1539
1539
|
export interface CalculationStatistics {
|
|
1540
1540
|
/**
|
|
1541
|
-
* @public
|
|
1542
1541
|
* <p>The data processing unit execution time in milliseconds for the calculation.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
DpuExecutionInMillis?: number;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>The progress of the calculation.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
Progress?: string;
|
|
1550
1550
|
}
|
|
@@ -1567,22 +1567,21 @@ export declare const CalculationExecutionState: {
|
|
|
1567
1567
|
*/
|
|
1568
1568
|
export type CalculationExecutionState = (typeof CalculationExecutionState)[keyof typeof CalculationExecutionState];
|
|
1569
1569
|
/**
|
|
1570
|
-
* @public
|
|
1571
1570
|
* <p>Contains information about the status of a notebook calculation.</p>
|
|
1571
|
+
* @public
|
|
1572
1572
|
*/
|
|
1573
1573
|
export interface CalculationStatus {
|
|
1574
1574
|
/**
|
|
1575
|
-
* @public
|
|
1576
1575
|
* <p>The date and time the calculation was submitted for processing.</p>
|
|
1576
|
+
* @public
|
|
1577
1577
|
*/
|
|
1578
1578
|
SubmissionDateTime?: Date;
|
|
1579
1579
|
/**
|
|
1580
|
-
* @public
|
|
1581
1580
|
* <p>The date and time the calculation completed processing.</p>
|
|
1581
|
+
* @public
|
|
1582
1582
|
*/
|
|
1583
1583
|
CompletionDateTime?: Date;
|
|
1584
1584
|
/**
|
|
1585
|
-
* @public
|
|
1586
1585
|
* <p>The state of the calculation execution. A description of each state follows.</p>
|
|
1587
1586
|
* <p>
|
|
1588
1587
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
@@ -1602,12 +1601,13 @@ export interface CalculationStatus {
|
|
|
1602
1601
|
* <code>COMPLETED</code> - The calculation has completed without error.</p>
|
|
1603
1602
|
* <p>
|
|
1604
1603
|
* <code>FAILED</code> - The calculation failed and is no longer running.</p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
State?: CalculationExecutionState;
|
|
1607
1607
|
/**
|
|
1608
|
-
* @public
|
|
1609
1608
|
* <p>The reason for the calculation state change (for example, the calculation was canceled
|
|
1610
1609
|
* because the session was terminated).</p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
StateChangeReason?: string;
|
|
1613
1613
|
}
|
|
@@ -1616,40 +1616,40 @@ export interface CalculationStatus {
|
|
|
1616
1616
|
*/
|
|
1617
1617
|
export interface GetCalculationExecutionResponse {
|
|
1618
1618
|
/**
|
|
1619
|
-
* @public
|
|
1620
1619
|
* <p>The calculation execution UUID.</p>
|
|
1620
|
+
* @public
|
|
1621
1621
|
*/
|
|
1622
1622
|
CalculationExecutionId?: string;
|
|
1623
1623
|
/**
|
|
1624
|
-
* @public
|
|
1625
1624
|
* <p>The session ID that the calculation ran in.</p>
|
|
1625
|
+
* @public
|
|
1626
1626
|
*/
|
|
1627
1627
|
SessionId?: string;
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>The description of the calculation execution.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
Description?: string;
|
|
1633
1633
|
/**
|
|
1634
|
-
* @public
|
|
1635
1634
|
* <p>The Amazon S3 location in which calculation results are stored.</p>
|
|
1635
|
+
* @public
|
|
1636
1636
|
*/
|
|
1637
1637
|
WorkingDirectory?: string;
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>Contains information about the status of the calculation.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
Status?: CalculationStatus;
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p>Contains information about the data processing unit (DPU) execution time and progress.
|
|
1646
1645
|
* This field is populated only when statistics are available.</p>
|
|
1646
|
+
* @public
|
|
1647
1647
|
*/
|
|
1648
1648
|
Statistics?: CalculationStatistics;
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>Contains result information. This field is populated only if the calculation is
|
|
1652
1651
|
* completed.</p>
|
|
1652
|
+
* @public
|
|
1653
1653
|
*/
|
|
1654
1654
|
Result?: CalculationResult;
|
|
1655
1655
|
}
|
|
@@ -1658,8 +1658,8 @@ export interface GetCalculationExecutionResponse {
|
|
|
1658
1658
|
*/
|
|
1659
1659
|
export interface GetCalculationExecutionCodeRequest {
|
|
1660
1660
|
/**
|
|
1661
|
-
* @public
|
|
1662
1661
|
* <p>The calculation execution UUID.</p>
|
|
1662
|
+
* @public
|
|
1663
1663
|
*/
|
|
1664
1664
|
CalculationExecutionId: string | undefined;
|
|
1665
1665
|
}
|
|
@@ -1668,8 +1668,8 @@ export interface GetCalculationExecutionCodeRequest {
|
|
|
1668
1668
|
*/
|
|
1669
1669
|
export interface GetCalculationExecutionCodeResponse {
|
|
1670
1670
|
/**
|
|
1671
|
-
* @public
|
|
1672
1671
|
* <p>The unencrypted code that was executed for the calculation.</p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
CodeBlock?: string;
|
|
1675
1675
|
}
|
|
@@ -1678,8 +1678,8 @@ export interface GetCalculationExecutionCodeResponse {
|
|
|
1678
1678
|
*/
|
|
1679
1679
|
export interface GetCalculationExecutionStatusRequest {
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>The calculation execution UUID.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
CalculationExecutionId: string | undefined;
|
|
1685
1685
|
}
|
|
@@ -1688,13 +1688,13 @@ export interface GetCalculationExecutionStatusRequest {
|
|
|
1688
1688
|
*/
|
|
1689
1689
|
export interface GetCalculationExecutionStatusResponse {
|
|
1690
1690
|
/**
|
|
1691
|
-
* @public
|
|
1692
1691
|
* <p>Contains information about the calculation execution status.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
Status?: CalculationStatus;
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Contains information about the DPU execution time and progress.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
Statistics?: CalculationStatistics;
|
|
1700
1700
|
}
|
|
@@ -1703,40 +1703,40 @@ export interface GetCalculationExecutionStatusResponse {
|
|
|
1703
1703
|
*/
|
|
1704
1704
|
export interface GetCapacityAssignmentConfigurationInput {
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>The name of the capacity reservation to retrieve the capacity assignment configuration
|
|
1708
1707
|
* for.</p>
|
|
1708
|
+
* @public
|
|
1709
1709
|
*/
|
|
1710
1710
|
CapacityReservationName: string | undefined;
|
|
1711
1711
|
}
|
|
1712
1712
|
/**
|
|
1713
|
-
* @public
|
|
1714
1713
|
* <p>A mapping between one or more workgroups and a capacity reservation.</p>
|
|
1714
|
+
* @public
|
|
1715
1715
|
*/
|
|
1716
1716
|
export interface CapacityAssignment {
|
|
1717
1717
|
/**
|
|
1718
|
-
* @public
|
|
1719
1718
|
* <p>The list of workgroup names for the capacity assignment.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
WorkGroupNames?: string[];
|
|
1722
1722
|
}
|
|
1723
1723
|
/**
|
|
1724
|
-
* @public
|
|
1725
1724
|
* <p>Assigns Athena workgroups (and hence their queries) to capacity
|
|
1726
1725
|
* reservations. A capacity reservation can have only one capacity assignment
|
|
1727
1726
|
* configuration, but the capacity assignment configuration can be made up of multiple
|
|
1728
1727
|
* individual assignments. Each assignment specifies how Athena queries can
|
|
1729
1728
|
* consume capacity from the capacity reservation that their workgroup is mapped to.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
export interface CapacityAssignmentConfiguration {
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The name of the reservation that the capacity assignment configuration is for.</p>
|
|
1734
|
+
* @public
|
|
1735
1735
|
*/
|
|
1736
1736
|
CapacityReservationName?: string;
|
|
1737
1737
|
/**
|
|
1738
|
-
* @public
|
|
1739
1738
|
* <p>The list of assignments that make up the capacity assignment configuration.</p>
|
|
1739
|
+
* @public
|
|
1740
1740
|
*/
|
|
1741
1741
|
CapacityAssignments?: CapacityAssignment[];
|
|
1742
1742
|
}
|
|
@@ -1745,9 +1745,9 @@ export interface CapacityAssignmentConfiguration {
|
|
|
1745
1745
|
*/
|
|
1746
1746
|
export interface GetCapacityAssignmentConfigurationOutput {
|
|
1747
1747
|
/**
|
|
1748
|
-
* @public
|
|
1749
1748
|
* <p>The requested capacity assignment configuration for the specified capacity
|
|
1750
1749
|
* reservation.</p>
|
|
1750
|
+
* @public
|
|
1751
1751
|
*/
|
|
1752
1752
|
CapacityAssignmentConfiguration: CapacityAssignmentConfiguration | undefined;
|
|
1753
1753
|
}
|
|
@@ -1756,8 +1756,8 @@ export interface GetCapacityAssignmentConfigurationOutput {
|
|
|
1756
1756
|
*/
|
|
1757
1757
|
export interface GetCapacityReservationInput {
|
|
1758
1758
|
/**
|
|
1759
|
-
* @public
|
|
1760
1759
|
* <p>The name of the capacity reservation.</p>
|
|
1760
|
+
* @public
|
|
1761
1761
|
*/
|
|
1762
1762
|
Name: string | undefined;
|
|
1763
1763
|
}
|
|
@@ -1775,29 +1775,29 @@ export declare const CapacityAllocationStatus: {
|
|
|
1775
1775
|
*/
|
|
1776
1776
|
export type CapacityAllocationStatus = (typeof CapacityAllocationStatus)[keyof typeof CapacityAllocationStatus];
|
|
1777
1777
|
/**
|
|
1778
|
-
* @public
|
|
1779
1778
|
* <p>Contains the submission time of a single allocation request for a capacity reservation
|
|
1780
1779
|
* and the most recent status of the attempted allocation.</p>
|
|
1780
|
+
* @public
|
|
1781
1781
|
*/
|
|
1782
1782
|
export interface CapacityAllocation {
|
|
1783
1783
|
/**
|
|
1784
|
-
* @public
|
|
1785
1784
|
* <p>The status of the capacity allocation.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
Status: CapacityAllocationStatus | undefined;
|
|
1788
1788
|
/**
|
|
1789
|
-
* @public
|
|
1790
1789
|
* <p>The status message of the capacity allocation.</p>
|
|
1790
|
+
* @public
|
|
1791
1791
|
*/
|
|
1792
1792
|
StatusMessage?: string;
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>The time when the capacity allocation was requested.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
RequestTime: Date | undefined;
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p>The time when the capacity allocation request was completed.</p>
|
|
1800
|
+
* @public
|
|
1801
1801
|
*/
|
|
1802
1802
|
RequestCompletionTime?: Date;
|
|
1803
1803
|
}
|
|
@@ -1818,46 +1818,46 @@ export declare const CapacityReservationStatus: {
|
|
|
1818
1818
|
*/
|
|
1819
1819
|
export type CapacityReservationStatus = (typeof CapacityReservationStatus)[keyof typeof CapacityReservationStatus];
|
|
1820
1820
|
/**
|
|
1821
|
-
* @public
|
|
1822
1821
|
* <p>A reservation for a specified number of data processing units (DPUs). When a
|
|
1823
1822
|
* reservation is initially created, it has no DPUs. Athena allocates DPUs
|
|
1824
1823
|
* until the allocated amount equals the requested amount.</p>
|
|
1824
|
+
* @public
|
|
1825
1825
|
*/
|
|
1826
1826
|
export interface CapacityReservation {
|
|
1827
1827
|
/**
|
|
1828
|
-
* @public
|
|
1829
1828
|
* <p>The name of the capacity reservation.</p>
|
|
1829
|
+
* @public
|
|
1830
1830
|
*/
|
|
1831
1831
|
Name: string | undefined;
|
|
1832
1832
|
/**
|
|
1833
|
-
* @public
|
|
1834
1833
|
* <p>The status of the capacity reservation.</p>
|
|
1834
|
+
* @public
|
|
1835
1835
|
*/
|
|
1836
1836
|
Status: CapacityReservationStatus | undefined;
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>The number of data processing units requested.</p>
|
|
1839
|
+
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
TargetDpus: number | undefined;
|
|
1842
1842
|
/**
|
|
1843
|
-
* @public
|
|
1844
1843
|
* <p>The number of data processing units currently allocated.</p>
|
|
1844
|
+
* @public
|
|
1845
1845
|
*/
|
|
1846
1846
|
AllocatedDpus: number | undefined;
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>Contains the submission time of a single allocation request for a capacity reservation
|
|
1850
1849
|
* and the most recent status of the attempted allocation.</p>
|
|
1850
|
+
* @public
|
|
1851
1851
|
*/
|
|
1852
1852
|
LastAllocation?: CapacityAllocation;
|
|
1853
1853
|
/**
|
|
1854
|
-
* @public
|
|
1855
1854
|
* <p>The time of the most recent capacity allocation that succeeded.</p>
|
|
1855
|
+
* @public
|
|
1856
1856
|
*/
|
|
1857
1857
|
LastSuccessfulAllocationTime?: Date;
|
|
1858
1858
|
/**
|
|
1859
|
-
* @public
|
|
1860
1859
|
* <p>The time in UTC epoch millis when the capacity reservation was created.</p>
|
|
1860
|
+
* @public
|
|
1861
1861
|
*/
|
|
1862
1862
|
CreationTime: Date | undefined;
|
|
1863
1863
|
}
|
|
@@ -1866,8 +1866,8 @@ export interface CapacityReservation {
|
|
|
1866
1866
|
*/
|
|
1867
1867
|
export interface GetCapacityReservationOutput {
|
|
1868
1868
|
/**
|
|
1869
|
-
* @public
|
|
1870
1869
|
* <p>The requested capacity reservation structure.</p>
|
|
1870
|
+
* @public
|
|
1871
1871
|
*/
|
|
1872
1872
|
CapacityReservation: CapacityReservation | undefined;
|
|
1873
1873
|
}
|
|
@@ -1876,40 +1876,40 @@ export interface GetCapacityReservationOutput {
|
|
|
1876
1876
|
*/
|
|
1877
1877
|
export interface GetDatabaseInput {
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>The name of the data catalog that contains the database to return.</p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
CatalogName: string | undefined;
|
|
1883
1883
|
/**
|
|
1884
|
-
* @public
|
|
1885
1884
|
* <p>The name of the database to return.</p>
|
|
1885
|
+
* @public
|
|
1886
1886
|
*/
|
|
1887
1887
|
DatabaseName: string | undefined;
|
|
1888
1888
|
/**
|
|
1889
|
-
* @public
|
|
1890
1889
|
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
1891
1890
|
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
WorkGroup?: string;
|
|
1894
1894
|
}
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>Contains metadata information for a database in a data catalog.</p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
export interface Database {
|
|
1900
1900
|
/**
|
|
1901
|
-
* @public
|
|
1902
1901
|
* <p>The name of the database.</p>
|
|
1902
|
+
* @public
|
|
1903
1903
|
*/
|
|
1904
1904
|
Name: string | undefined;
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>An optional description of the database.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
Description?: string;
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>A set of custom key/value pairs.</p>
|
|
1912
|
+
* @public
|
|
1913
1913
|
*/
|
|
1914
1914
|
Parameters?: Record<string, string>;
|
|
1915
1915
|
}
|
|
@@ -1918,19 +1918,19 @@ export interface Database {
|
|
|
1918
1918
|
*/
|
|
1919
1919
|
export interface GetDatabaseOutput {
|
|
1920
1920
|
/**
|
|
1921
|
-
* @public
|
|
1922
1921
|
* <p>The database returned.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
Database?: Database;
|
|
1925
1925
|
}
|
|
1926
1926
|
/**
|
|
1927
|
-
* @public
|
|
1928
1927
|
* <p>An exception that Athena received when it called a custom metastore.
|
|
1929
1928
|
* Occurs if the error is not caused by user input (<code>InvalidRequestException</code>)
|
|
1930
1929
|
* or from the Athena platform (<code>InternalServerException</code>). For
|
|
1931
1930
|
* example, if a user-created Lambda function is missing permissions, the
|
|
1932
1931
|
* Lambda
|
|
1933
1932
|
* <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>
|
|
1933
|
+
* @public
|
|
1934
1934
|
*/
|
|
1935
1935
|
export declare class MetadataException extends __BaseException {
|
|
1936
1936
|
readonly name: "MetadataException";
|
|
@@ -1946,46 +1946,45 @@ export declare class MetadataException extends __BaseException {
|
|
|
1946
1946
|
*/
|
|
1947
1947
|
export interface GetDataCatalogInput {
|
|
1948
1948
|
/**
|
|
1949
|
-
* @public
|
|
1950
1949
|
* <p>The name of the data catalog to return.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
Name: string | undefined;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The name of the workgroup. Required if making an IAM Identity Center request.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
WorkGroup?: string;
|
|
1958
1958
|
}
|
|
1959
1959
|
/**
|
|
1960
|
-
* @public
|
|
1961
1960
|
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1962
1961
|
* <note>
|
|
1963
1962
|
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
1964
1963
|
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
1965
1964
|
* </note>
|
|
1965
|
+
* @public
|
|
1966
1966
|
*/
|
|
1967
1967
|
export interface DataCatalog {
|
|
1968
1968
|
/**
|
|
1969
|
-
* @public
|
|
1970
1969
|
* <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,
|
|
1971
1970
|
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
1972
1971
|
* by Athena.</p>
|
|
1972
|
+
* @public
|
|
1973
1973
|
*/
|
|
1974
1974
|
Name: string | undefined;
|
|
1975
1975
|
/**
|
|
1976
|
-
* @public
|
|
1977
1976
|
* <p>An optional description of the data catalog.</p>
|
|
1977
|
+
* @public
|
|
1978
1978
|
*/
|
|
1979
1979
|
Description?: string;
|
|
1980
1980
|
/**
|
|
1981
|
-
* @public
|
|
1982
1981
|
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
1983
1982
|
* <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
|
|
1984
1983
|
* Glue Data Catalog.</p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
Type: DataCatalogType | undefined;
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>Specifies the Lambda function or functions to use for the data catalog.
|
|
1990
1989
|
* This is a mapping whose values depend on the catalog type. </p>
|
|
1991
1990
|
* <ul>
|
|
@@ -2044,6 +2043,7 @@ export interface DataCatalog {
|
|
|
2044
2043
|
* </ul>
|
|
2045
2044
|
* </li>
|
|
2046
2045
|
* </ul>
|
|
2046
|
+
* @public
|
|
2047
2047
|
*/
|
|
2048
2048
|
Parameters?: Record<string, string>;
|
|
2049
2049
|
}
|
|
@@ -2052,8 +2052,8 @@ export interface DataCatalog {
|
|
|
2052
2052
|
*/
|
|
2053
2053
|
export interface GetDataCatalogOutput {
|
|
2054
2054
|
/**
|
|
2055
|
-
* @public
|
|
2056
2055
|
* <p>The data catalog returned.</p>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
DataCatalog?: DataCatalog;
|
|
2059
2059
|
}
|
|
@@ -2062,9 +2062,9 @@ export interface GetDataCatalogOutput {
|
|
|
2062
2062
|
*/
|
|
2063
2063
|
export interface GetNamedQueryInput {
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query
|
|
2067
2066
|
* IDs.</p>
|
|
2067
|
+
* @public
|
|
2068
2068
|
*/
|
|
2069
2069
|
NamedQueryId: string | undefined;
|
|
2070
2070
|
}
|
|
@@ -2073,8 +2073,8 @@ export interface GetNamedQueryInput {
|
|
|
2073
2073
|
*/
|
|
2074
2074
|
export interface GetNamedQueryOutput {
|
|
2075
2075
|
/**
|
|
2076
|
-
* @public
|
|
2077
2076
|
* <p>Information about the query.</p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
NamedQuery?: NamedQuery;
|
|
2080
2080
|
}
|
|
@@ -2083,8 +2083,8 @@ export interface GetNamedQueryOutput {
|
|
|
2083
2083
|
*/
|
|
2084
2084
|
export interface GetNotebookMetadataInput {
|
|
2085
2085
|
/**
|
|
2086
|
-
* @public
|
|
2087
2086
|
* <p>The ID of the notebook whose metadata is to be retrieved.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
NotebookId: string | undefined;
|
|
2090
2090
|
}
|
|
@@ -2093,8 +2093,8 @@ export interface GetNotebookMetadataInput {
|
|
|
2093
2093
|
*/
|
|
2094
2094
|
export interface GetNotebookMetadataOutput {
|
|
2095
2095
|
/**
|
|
2096
|
-
* @public
|
|
2097
2096
|
* <p>The metadata that is returned for the specified notebook ID.</p>
|
|
2097
|
+
* @public
|
|
2098
2098
|
*/
|
|
2099
2099
|
NotebookMetadata?: NotebookMetadata;
|
|
2100
2100
|
}
|
|
@@ -2103,13 +2103,13 @@ export interface GetNotebookMetadataOutput {
|
|
|
2103
2103
|
*/
|
|
2104
2104
|
export interface GetPreparedStatementInput {
|
|
2105
2105
|
/**
|
|
2106
|
-
* @public
|
|
2107
2106
|
* <p>The name of the prepared statement to retrieve.</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
StatementName: string | undefined;
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The workgroup to which the statement to be retrieved belongs.</p>
|
|
2112
|
+
* @public
|
|
2113
2113
|
*/
|
|
2114
2114
|
WorkGroup: string | undefined;
|
|
2115
2115
|
}
|
|
@@ -2118,8 +2118,8 @@ export interface GetPreparedStatementInput {
|
|
|
2118
2118
|
*/
|
|
2119
2119
|
export interface GetPreparedStatementOutput {
|
|
2120
2120
|
/**
|
|
2121
|
-
* @public
|
|
2122
2121
|
* <p>The name of the prepared statement that was retrieved.</p>
|
|
2122
|
+
* @public
|
|
2123
2123
|
*/
|
|
2124
2124
|
PreparedStatement?: PreparedStatement;
|
|
2125
2125
|
}
|
|
@@ -2128,8 +2128,8 @@ export interface GetPreparedStatementOutput {
|
|
|
2128
2128
|
*/
|
|
2129
2129
|
export interface GetQueryExecutionInput {
|
|
2130
2130
|
/**
|
|
2131
|
-
* @public
|
|
2132
2131
|
* <p>The unique ID of the query execution.</p>
|
|
2132
|
+
* @public
|
|
2133
2133
|
*/
|
|
2134
2134
|
QueryExecutionId: string | undefined;
|
|
2135
2135
|
}
|
|
@@ -2138,8 +2138,8 @@ export interface GetQueryExecutionInput {
|
|
|
2138
2138
|
*/
|
|
2139
2139
|
export interface GetQueryExecutionOutput {
|
|
2140
2140
|
/**
|
|
2141
|
-
* @public
|
|
2142
2141
|
* <p>Information about the query execution.</p>
|
|
2142
|
+
* @public
|
|
2143
2143
|
*/
|
|
2144
2144
|
QueryExecution?: QueryExecution;
|
|
2145
2145
|
}
|
|
@@ -2148,20 +2148,20 @@ export interface GetQueryExecutionOutput {
|
|
|
2148
2148
|
*/
|
|
2149
2149
|
export interface GetQueryResultsInput {
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>The unique ID of the query execution.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
QueryExecutionId: string | undefined;
|
|
2155
2155
|
/**
|
|
2156
|
-
* @public
|
|
2157
2156
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2158
2157
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2159
2158
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2159
|
+
* @public
|
|
2160
2160
|
*/
|
|
2161
2161
|
NextToken?: string;
|
|
2162
2162
|
/**
|
|
2163
|
-
* @public
|
|
2164
2163
|
* <p>The maximum number of results (rows) to return in this request.</p>
|
|
2164
|
+
* @public
|
|
2165
2165
|
*/
|
|
2166
2166
|
MaxResults?: number;
|
|
2167
2167
|
}
|
|
@@ -2179,112 +2179,112 @@ export declare const ColumnNullable: {
|
|
|
2179
2179
|
*/
|
|
2180
2180
|
export type ColumnNullable = (typeof ColumnNullable)[keyof typeof ColumnNullable];
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>Information about the columns in a query execution result.</p>
|
|
2183
|
+
* @public
|
|
2184
2184
|
*/
|
|
2185
2185
|
export interface ColumnInfo {
|
|
2186
2186
|
/**
|
|
2187
|
-
* @public
|
|
2188
2187
|
* <p>The catalog to which the query results belong.</p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
CatalogName?: string;
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p>The schema name (database name) to which the query results belong.</p>
|
|
2193
|
+
* @public
|
|
2194
2194
|
*/
|
|
2195
2195
|
SchemaName?: string;
|
|
2196
2196
|
/**
|
|
2197
|
-
* @public
|
|
2198
2197
|
* <p>The table name for the query results.</p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
TableName?: string;
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>The name of the column.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
Name: string | undefined;
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>A column label.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
Label?: string;
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>The data type of the column.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
Type: string | undefined;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38.
|
|
2219
2218
|
* For performance reasons, we recommend up to 18 digits.</p>
|
|
2219
|
+
* @public
|
|
2220
2220
|
*/
|
|
2221
2221
|
Precision?: number;
|
|
2222
2222
|
/**
|
|
2223
|
-
* @public
|
|
2224
2223
|
* <p>For <code>DECIMAL</code> data types, specifies the total number of digits in the
|
|
2225
2224
|
* fractional part of the value. Defaults to 0.</p>
|
|
2225
|
+
* @public
|
|
2226
2226
|
*/
|
|
2227
2227
|
Scale?: number;
|
|
2228
2228
|
/**
|
|
2229
|
-
* @public
|
|
2230
2229
|
* <p>Unsupported constraint. This value always shows as <code>UNKNOWN</code>.</p>
|
|
2230
|
+
* @public
|
|
2231
2231
|
*/
|
|
2232
2232
|
Nullable?: ColumnNullable;
|
|
2233
2233
|
/**
|
|
2234
|
-
* @public
|
|
2235
2234
|
* <p>Indicates whether values in the column are case-sensitive.</p>
|
|
2235
|
+
* @public
|
|
2236
2236
|
*/
|
|
2237
2237
|
CaseSensitive?: boolean;
|
|
2238
2238
|
}
|
|
2239
2239
|
/**
|
|
2240
|
-
* @public
|
|
2241
2240
|
* <p>The metadata that describes the column structure and data types of a table of query
|
|
2242
2241
|
* results. To return a <code>ResultSetMetadata</code> object, use <a>GetQueryResults</a>.</p>
|
|
2242
|
+
* @public
|
|
2243
2243
|
*/
|
|
2244
2244
|
export interface ResultSetMetadata {
|
|
2245
2245
|
/**
|
|
2246
|
-
* @public
|
|
2247
2246
|
* <p>Information about the columns returned in a query result metadata.</p>
|
|
2247
|
+
* @public
|
|
2248
2248
|
*/
|
|
2249
2249
|
ColumnInfo?: ColumnInfo[];
|
|
2250
2250
|
}
|
|
2251
2251
|
/**
|
|
2252
|
-
* @public
|
|
2253
2252
|
* <p>A piece of data (a field in the table).</p>
|
|
2253
|
+
* @public
|
|
2254
2254
|
*/
|
|
2255
2255
|
export interface Datum {
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>The value of the datum.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
VarCharValue?: string;
|
|
2261
2261
|
}
|
|
2262
2262
|
/**
|
|
2263
|
-
* @public
|
|
2264
2263
|
* <p>The rows that make up a query result table.</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
export interface Row {
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The data that populates a row in a query result table.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
Data?: Datum[];
|
|
2272
2272
|
}
|
|
2273
2273
|
/**
|
|
2274
|
-
* @public
|
|
2275
2274
|
* <p>The metadata and rows that make up a query result set. The metadata describes the
|
|
2276
2275
|
* column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>
|
|
2276
|
+
* @public
|
|
2277
2277
|
*/
|
|
2278
2278
|
export interface ResultSet {
|
|
2279
2279
|
/**
|
|
2280
|
-
* @public
|
|
2281
2280
|
* <p>The rows in the table.</p>
|
|
2281
|
+
* @public
|
|
2282
2282
|
*/
|
|
2283
2283
|
Rows?: Row[];
|
|
2284
2284
|
/**
|
|
2285
|
-
* @public
|
|
2286
2285
|
* <p>The metadata that describes the column structure and data types of a table of query
|
|
2287
2286
|
* results.</p>
|
|
2287
|
+
* @public
|
|
2288
2288
|
*/
|
|
2289
2289
|
ResultSetMetadata?: ResultSetMetadata;
|
|
2290
2290
|
}
|
|
@@ -2293,21 +2293,21 @@ export interface ResultSet {
|
|
|
2293
2293
|
*/
|
|
2294
2294
|
export interface GetQueryResultsOutput {
|
|
2295
2295
|
/**
|
|
2296
|
-
* @public
|
|
2297
2296
|
* <p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement.
|
|
2298
2297
|
* </p>
|
|
2298
|
+
* @public
|
|
2299
2299
|
*/
|
|
2300
2300
|
UpdateCount?: number;
|
|
2301
2301
|
/**
|
|
2302
|
-
* @public
|
|
2303
2302
|
* <p>The results of the query execution.</p>
|
|
2303
|
+
* @public
|
|
2304
2304
|
*/
|
|
2305
2305
|
ResultSet?: ResultSet;
|
|
2306
2306
|
/**
|
|
2307
|
-
* @public
|
|
2308
2307
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2309
2308
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2310
2309
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2310
|
+
* @public
|
|
2311
2311
|
*/
|
|
2312
2312
|
NextToken?: string;
|
|
2313
2313
|
}
|
|
@@ -2316,79 +2316,79 @@ export interface GetQueryResultsOutput {
|
|
|
2316
2316
|
*/
|
|
2317
2317
|
export interface GetQueryRuntimeStatisticsInput {
|
|
2318
2318
|
/**
|
|
2319
|
-
* @public
|
|
2320
2319
|
* <p>The unique ID of the query execution.</p>
|
|
2320
|
+
* @public
|
|
2321
2321
|
*/
|
|
2322
2322
|
QueryExecutionId: string | undefined;
|
|
2323
2323
|
}
|
|
2324
2324
|
/**
|
|
2325
|
-
* @public
|
|
2326
2325
|
* <p>Statistics such as input rows and bytes read by the query, rows and bytes output by
|
|
2327
2326
|
* the query, and the number of rows written by the query.</p>
|
|
2327
|
+
* @public
|
|
2328
2328
|
*/
|
|
2329
2329
|
export interface QueryRuntimeStatisticsRows {
|
|
2330
2330
|
/**
|
|
2331
|
-
* @public
|
|
2332
2331
|
* <p>The number of rows read to execute the query.</p>
|
|
2332
|
+
* @public
|
|
2333
2333
|
*/
|
|
2334
2334
|
InputRows?: number;
|
|
2335
2335
|
/**
|
|
2336
|
-
* @public
|
|
2337
2336
|
* <p>The number of bytes read to execute the query.</p>
|
|
2337
|
+
* @public
|
|
2338
2338
|
*/
|
|
2339
2339
|
InputBytes?: number;
|
|
2340
2340
|
/**
|
|
2341
|
-
* @public
|
|
2342
2341
|
* <p>The number of bytes returned by the query.</p>
|
|
2342
|
+
* @public
|
|
2343
2343
|
*/
|
|
2344
2344
|
OutputBytes?: number;
|
|
2345
2345
|
/**
|
|
2346
|
-
* @public
|
|
2347
2346
|
* <p>The number of rows returned by the query.</p>
|
|
2347
|
+
* @public
|
|
2348
2348
|
*/
|
|
2349
2349
|
OutputRows?: number;
|
|
2350
2350
|
}
|
|
2351
2351
|
/**
|
|
2352
|
-
* @public
|
|
2353
2352
|
* <p>Timeline statistics such as query queue time, planning time, execution time, service
|
|
2354
2353
|
* processing time, and total execution time.</p>
|
|
2354
|
+
* @public
|
|
2355
2355
|
*/
|
|
2356
2356
|
export interface QueryRuntimeStatisticsTimeline {
|
|
2357
2357
|
/**
|
|
2358
|
-
* @public
|
|
2359
2358
|
* <p>The number of milliseconds that the query was in your query queue waiting for
|
|
2360
2359
|
* resources. Note that if transient errors occur, Athena might automatically
|
|
2361
2360
|
* add the query back to the queue.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
QueryQueueTimeInMillis?: number;
|
|
2364
2364
|
/**
|
|
2365
|
-
* @public
|
|
2366
2365
|
* <p> The number of milliseconds that Athena spends on preprocessing before it
|
|
2367
2366
|
* submits the query to the engine. </p>
|
|
2367
|
+
* @public
|
|
2368
2368
|
*/
|
|
2369
2369
|
ServicePreProcessingTimeInMillis?: number;
|
|
2370
2370
|
/**
|
|
2371
|
-
* @public
|
|
2372
2371
|
* <p>The number of milliseconds that Athena took to plan the query processing
|
|
2373
2372
|
* flow. This includes the time spent retrieving table partitions from the data source.
|
|
2374
2373
|
* Note that because the query engine performs the query planning, query planning time is a
|
|
2375
2374
|
* subset of engine processing time.</p>
|
|
2375
|
+
* @public
|
|
2376
2376
|
*/
|
|
2377
2377
|
QueryPlanningTimeInMillis?: number;
|
|
2378
2378
|
/**
|
|
2379
|
-
* @public
|
|
2380
2379
|
* <p>The number of milliseconds that the query took to execute.</p>
|
|
2380
|
+
* @public
|
|
2381
2381
|
*/
|
|
2382
2382
|
EngineExecutionTimeInMillis?: number;
|
|
2383
2383
|
/**
|
|
2384
|
-
* @public
|
|
2385
2384
|
* <p>The number of milliseconds that Athena took to finalize and publish the
|
|
2386
2385
|
* query results after the query engine finished running the query.</p>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
ServiceProcessingTimeInMillis?: number;
|
|
2389
2389
|
/**
|
|
2390
|
-
* @public
|
|
2391
2390
|
* <p>The number of milliseconds that Athena took to run the query.</p>
|
|
2391
|
+
* @public
|
|
2392
2392
|
*/
|
|
2393
2393
|
TotalExecutionTimeInMillis?: number;
|
|
2394
2394
|
}
|
|
@@ -2397,90 +2397,90 @@ export interface QueryRuntimeStatisticsTimeline {
|
|
|
2397
2397
|
*/
|
|
2398
2398
|
export interface GetSessionRequest {
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The session ID.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
SessionId: string | undefined;
|
|
2404
2404
|
}
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>Contains data processing unit (DPU) configuration settings and parameter mappings for
|
|
2408
2407
|
* a notebook engine.</p>
|
|
2408
|
+
* @public
|
|
2409
2409
|
*/
|
|
2410
2410
|
export interface EngineConfiguration {
|
|
2411
2411
|
/**
|
|
2412
|
-
* @public
|
|
2413
2412
|
* <p>The number of DPUs to use for the coordinator. A coordinator is a special executor
|
|
2414
2413
|
* that orchestrates processing work and manages other executors in a notebook session. The
|
|
2415
2414
|
* default is 1.</p>
|
|
2415
|
+
* @public
|
|
2416
2416
|
*/
|
|
2417
2417
|
CoordinatorDpuSize?: number;
|
|
2418
2418
|
/**
|
|
2419
|
-
* @public
|
|
2420
2419
|
* <p>The maximum number of DPUs that can run concurrently.</p>
|
|
2420
|
+
* @public
|
|
2421
2421
|
*/
|
|
2422
2422
|
MaxConcurrentDpus: number | undefined;
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p>The default number of DPUs to use for executors. An executor is the smallest unit of
|
|
2426
2425
|
* compute that a notebook session can request from Athena. The default is
|
|
2427
2426
|
* 1.</p>
|
|
2427
|
+
* @public
|
|
2428
2428
|
*/
|
|
2429
2429
|
DefaultExecutorDpuSize?: number;
|
|
2430
2430
|
/**
|
|
2431
|
-
* @public
|
|
2432
2431
|
* <p>Contains additional notebook engine <code>MAP<string, string></code> parameter
|
|
2433
2432
|
* mappings in the form of key-value pairs. To specify an Athena notebook that
|
|
2434
2433
|
* the Jupyter server will download and serve, specify a value for the <a>StartSessionRequest$NotebookVersion</a> field, and then add a key named
|
|
2435
2434
|
* <code>NotebookId</code> to <code>AdditionalConfigs</code> that has the value of the
|
|
2436
2435
|
* Athena notebook ID.</p>
|
|
2436
|
+
* @public
|
|
2437
2437
|
*/
|
|
2438
2438
|
AdditionalConfigs?: Record<string, string>;
|
|
2439
2439
|
/**
|
|
2440
|
-
* @public
|
|
2441
2440
|
* <p>Specifies custom jar files and Spark properties for use cases like cluster encryption,
|
|
2442
2441
|
* table formats, and general Spark tuning.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
SparkProperties?: Record<string, string>;
|
|
2445
2445
|
}
|
|
2446
2446
|
/**
|
|
2447
|
-
* @public
|
|
2448
2447
|
* <p>Contains session configuration information.</p>
|
|
2448
|
+
* @public
|
|
2449
2449
|
*/
|
|
2450
2450
|
export interface SessionConfiguration {
|
|
2451
2451
|
/**
|
|
2452
|
-
* @public
|
|
2453
2452
|
* <p>The ARN of the execution role used to access user resources for Spark sessions and
|
|
2454
2453
|
* Identity Center enabled workgroups. This property applies only to Spark enabled
|
|
2455
2454
|
* workgroups and Identity Center enabled workgroups.</p>
|
|
2455
|
+
* @public
|
|
2456
2456
|
*/
|
|
2457
2457
|
ExecutionRole?: string;
|
|
2458
2458
|
/**
|
|
2459
|
-
* @public
|
|
2460
2459
|
* <p>The Amazon S3 location that stores information for the notebook.</p>
|
|
2460
|
+
* @public
|
|
2461
2461
|
*/
|
|
2462
2462
|
WorkingDirectory?: string;
|
|
2463
2463
|
/**
|
|
2464
|
-
* @public
|
|
2465
2464
|
* <p>The idle timeout in seconds for the session.</p>
|
|
2465
|
+
* @public
|
|
2466
2466
|
*/
|
|
2467
2467
|
IdleTimeoutSeconds?: number;
|
|
2468
2468
|
/**
|
|
2469
|
-
* @public
|
|
2470
2469
|
* <p>If query and calculation results are encrypted in Amazon S3, indicates the
|
|
2471
2470
|
* encryption option used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and
|
|
2472
2471
|
* key information.</p>
|
|
2472
|
+
* @public
|
|
2473
2473
|
*/
|
|
2474
2474
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
2475
2475
|
}
|
|
2476
2476
|
/**
|
|
2477
|
-
* @public
|
|
2478
2477
|
* <p>Contains statistics for a session.</p>
|
|
2478
|
+
* @public
|
|
2479
2479
|
*/
|
|
2480
2480
|
export interface SessionStatistics {
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>The data processing unit execution time for a session in milliseconds.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
DpuExecutionInMillis?: number;
|
|
2486
2486
|
}
|
|
@@ -2503,33 +2503,32 @@ export declare const SessionState: {
|
|
|
2503
2503
|
*/
|
|
2504
2504
|
export type SessionState = (typeof SessionState)[keyof typeof SessionState];
|
|
2505
2505
|
/**
|
|
2506
|
-
* @public
|
|
2507
2506
|
* <p>Contains information about the status of a session.</p>
|
|
2507
|
+
* @public
|
|
2508
2508
|
*/
|
|
2509
2509
|
export interface SessionStatus {
|
|
2510
2510
|
/**
|
|
2511
|
-
* @public
|
|
2512
2511
|
* <p>The date and time that the session started.</p>
|
|
2512
|
+
* @public
|
|
2513
2513
|
*/
|
|
2514
2514
|
StartDateTime?: Date;
|
|
2515
2515
|
/**
|
|
2516
|
-
* @public
|
|
2517
2516
|
* <p>The most recent date and time that the session was modified.</p>
|
|
2517
|
+
* @public
|
|
2518
2518
|
*/
|
|
2519
2519
|
LastModifiedDateTime?: Date;
|
|
2520
2520
|
/**
|
|
2521
|
-
* @public
|
|
2522
2521
|
* <p>The date and time that the session ended.</p>
|
|
2522
|
+
* @public
|
|
2523
2523
|
*/
|
|
2524
2524
|
EndDateTime?: Date;
|
|
2525
2525
|
/**
|
|
2526
|
-
* @public
|
|
2527
2526
|
* <p>The date and time starting at which the session became idle. Can be empty if the
|
|
2528
2527
|
* session is not currently idle.</p>
|
|
2528
|
+
* @public
|
|
2529
2529
|
*/
|
|
2530
2530
|
IdleSinceDateTime?: Date;
|
|
2531
2531
|
/**
|
|
2532
|
-
* @public
|
|
2533
2532
|
* <p>The state of the session. A description of each state follows.</p>
|
|
2534
2533
|
* <p>
|
|
2535
2534
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -2550,12 +2549,13 @@ export interface SessionStatus {
|
|
|
2550
2549
|
* <p>
|
|
2551
2550
|
* <code>FAILED</code> - Due to a failure, the session and its resources are no longer
|
|
2552
2551
|
* running.</p>
|
|
2552
|
+
* @public
|
|
2553
2553
|
*/
|
|
2554
2554
|
State?: SessionState;
|
|
2555
2555
|
/**
|
|
2556
|
-
* @public
|
|
2557
2556
|
* <p>The reason for the session state change (for example, canceled because the session was
|
|
2558
2557
|
* terminated).</p>
|
|
2558
|
+
* @public
|
|
2559
2559
|
*/
|
|
2560
2560
|
StateChangeReason?: string;
|
|
2561
2561
|
}
|
|
@@ -2564,49 +2564,49 @@ export interface SessionStatus {
|
|
|
2564
2564
|
*/
|
|
2565
2565
|
export interface GetSessionResponse {
|
|
2566
2566
|
/**
|
|
2567
|
-
* @public
|
|
2568
2567
|
* <p>The session ID.</p>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
SessionId?: string;
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>The session description.</p>
|
|
2573
|
+
* @public
|
|
2574
2574
|
*/
|
|
2575
2575
|
Description?: string;
|
|
2576
2576
|
/**
|
|
2577
|
-
* @public
|
|
2578
2577
|
* <p>The workgroup to which the session belongs.</p>
|
|
2578
|
+
* @public
|
|
2579
2579
|
*/
|
|
2580
2580
|
WorkGroup?: string;
|
|
2581
2581
|
/**
|
|
2582
|
-
* @public
|
|
2583
2582
|
* <p>The engine version used by the session (for example, <code>PySpark engine version
|
|
2584
2583
|
* 3</code>). You can get a list of engine versions by calling <a>ListEngineVersions</a>.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
EngineVersion?: string;
|
|
2587
2587
|
/**
|
|
2588
|
-
* @public
|
|
2589
2588
|
* <p>Contains engine configuration information like DPU usage.</p>
|
|
2589
|
+
* @public
|
|
2590
2590
|
*/
|
|
2591
2591
|
EngineConfiguration?: EngineConfiguration;
|
|
2592
2592
|
/**
|
|
2593
|
-
* @public
|
|
2594
2593
|
* <p>The notebook version.</p>
|
|
2594
|
+
* @public
|
|
2595
2595
|
*/
|
|
2596
2596
|
NotebookVersion?: string;
|
|
2597
2597
|
/**
|
|
2598
|
-
* @public
|
|
2599
2598
|
* <p>Contains the workgroup configuration information used by the session.</p>
|
|
2599
|
+
* @public
|
|
2600
2600
|
*/
|
|
2601
2601
|
SessionConfiguration?: SessionConfiguration;
|
|
2602
2602
|
/**
|
|
2603
|
-
* @public
|
|
2604
2603
|
* <p>Contains information about the status of the session.</p>
|
|
2604
|
+
* @public
|
|
2605
2605
|
*/
|
|
2606
2606
|
Status?: SessionStatus;
|
|
2607
2607
|
/**
|
|
2608
|
-
* @public
|
|
2609
2608
|
* <p>Contains the DPU execution time.</p>
|
|
2609
|
+
* @public
|
|
2610
2610
|
*/
|
|
2611
2611
|
Statistics?: SessionStatistics;
|
|
2612
2612
|
}
|
|
@@ -2615,8 +2615,8 @@ export interface GetSessionResponse {
|
|
|
2615
2615
|
*/
|
|
2616
2616
|
export interface GetSessionStatusRequest {
|
|
2617
2617
|
/**
|
|
2618
|
-
* @public
|
|
2619
2618
|
* <p>The session ID.</p>
|
|
2619
|
+
* @public
|
|
2620
2620
|
*/
|
|
2621
2621
|
SessionId: string | undefined;
|
|
2622
2622
|
}
|
|
@@ -2625,13 +2625,13 @@ export interface GetSessionStatusRequest {
|
|
|
2625
2625
|
*/
|
|
2626
2626
|
export interface GetSessionStatusResponse {
|
|
2627
2627
|
/**
|
|
2628
|
-
* @public
|
|
2629
2628
|
* <p>The session ID.</p>
|
|
2629
|
+
* @public
|
|
2630
2630
|
*/
|
|
2631
2631
|
SessionId?: string;
|
|
2632
2632
|
/**
|
|
2633
|
-
* @public
|
|
2634
2633
|
* <p>Contains information about the status of the session.</p>
|
|
2634
|
+
* @public
|
|
2635
2635
|
*/
|
|
2636
2636
|
Status?: SessionStatus;
|
|
2637
2637
|
}
|
|
@@ -2640,88 +2640,88 @@ export interface GetSessionStatusResponse {
|
|
|
2640
2640
|
*/
|
|
2641
2641
|
export interface GetTableMetadataInput {
|
|
2642
2642
|
/**
|
|
2643
|
-
* @public
|
|
2644
2643
|
* <p>The name of the data catalog that contains the database and table metadata to
|
|
2645
2644
|
* return.</p>
|
|
2645
|
+
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
CatalogName: string | undefined;
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>The name of the database that contains the table metadata to return.</p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
DatabaseName: string | undefined;
|
|
2653
2653
|
/**
|
|
2654
|
-
* @public
|
|
2655
2654
|
* <p>The name of the table for which metadata is returned.</p>
|
|
2655
|
+
* @public
|
|
2656
2656
|
*/
|
|
2657
2657
|
TableName: string | undefined;
|
|
2658
2658
|
/**
|
|
2659
|
-
* @public
|
|
2660
2659
|
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
2661
2660
|
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
2661
|
+
* @public
|
|
2662
2662
|
*/
|
|
2663
2663
|
WorkGroup?: string;
|
|
2664
2664
|
}
|
|
2665
2665
|
/**
|
|
2666
|
-
* @public
|
|
2667
2666
|
* <p>Contains metadata for a column in a table.</p>
|
|
2667
|
+
* @public
|
|
2668
2668
|
*/
|
|
2669
2669
|
export interface Column {
|
|
2670
2670
|
/**
|
|
2671
|
-
* @public
|
|
2672
2671
|
* <p>The name of the column.</p>
|
|
2672
|
+
* @public
|
|
2673
2673
|
*/
|
|
2674
2674
|
Name: string | undefined;
|
|
2675
2675
|
/**
|
|
2676
|
-
* @public
|
|
2677
2676
|
* <p>The data type of the column.</p>
|
|
2677
|
+
* @public
|
|
2678
2678
|
*/
|
|
2679
2679
|
Type?: string;
|
|
2680
2680
|
/**
|
|
2681
|
-
* @public
|
|
2682
2681
|
* <p>Optional information about the column.</p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
Comment?: string;
|
|
2685
2685
|
}
|
|
2686
2686
|
/**
|
|
2687
|
-
* @public
|
|
2688
2687
|
* <p>Contains metadata for a table.</p>
|
|
2688
|
+
* @public
|
|
2689
2689
|
*/
|
|
2690
2690
|
export interface TableMetadata {
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>The name of the table.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
Name: string | undefined;
|
|
2696
2696
|
/**
|
|
2697
|
-
* @public
|
|
2698
2697
|
* <p>The time that the table was created.</p>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
CreateTime?: Date;
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>The last time the table was accessed.</p>
|
|
2703
|
+
* @public
|
|
2704
2704
|
*/
|
|
2705
2705
|
LastAccessTime?: Date;
|
|
2706
2706
|
/**
|
|
2707
|
-
* @public
|
|
2708
2707
|
* <p>The type of table. In Athena, only <code>EXTERNAL_TABLE</code> is
|
|
2709
2708
|
* supported.</p>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
TableType?: string;
|
|
2712
2712
|
/**
|
|
2713
|
-
* @public
|
|
2714
2713
|
* <p>A list of the columns in the table.</p>
|
|
2714
|
+
* @public
|
|
2715
2715
|
*/
|
|
2716
2716
|
Columns?: Column[];
|
|
2717
2717
|
/**
|
|
2718
|
-
* @public
|
|
2719
2718
|
* <p>A list of the partition keys in the table.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
PartitionKeys?: Column[];
|
|
2722
2722
|
/**
|
|
2723
|
-
* @public
|
|
2724
2723
|
* <p>A set of custom key/value pairs for table properties.</p>
|
|
2724
|
+
* @public
|
|
2725
2725
|
*/
|
|
2726
2726
|
Parameters?: Record<string, string>;
|
|
2727
2727
|
}
|
|
@@ -2730,8 +2730,8 @@ export interface TableMetadata {
|
|
|
2730
2730
|
*/
|
|
2731
2731
|
export interface GetTableMetadataOutput {
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>An object that contains table metadata.</p>
|
|
2734
|
+
* @public
|
|
2735
2735
|
*/
|
|
2736
2736
|
TableMetadata?: TableMetadata;
|
|
2737
2737
|
}
|
|
@@ -2740,8 +2740,8 @@ export interface GetTableMetadataOutput {
|
|
|
2740
2740
|
*/
|
|
2741
2741
|
export interface GetWorkGroupInput {
|
|
2742
2742
|
/**
|
|
2743
|
-
* @public
|
|
2744
2743
|
* <p>The name of the workgroup.</p>
|
|
2744
|
+
* @public
|
|
2745
2745
|
*/
|
|
2746
2746
|
WorkGroup: string | undefined;
|
|
2747
2747
|
}
|
|
@@ -2758,7 +2758,6 @@ export declare const WorkGroupState: {
|
|
|
2758
2758
|
*/
|
|
2759
2759
|
export type WorkGroupState = (typeof WorkGroupState)[keyof typeof WorkGroupState];
|
|
2760
2760
|
/**
|
|
2761
|
-
* @public
|
|
2762
2761
|
* <p>A workgroup, which contains a name, description, creation time, state, and other
|
|
2763
2762
|
* configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup
|
|
2764
2763
|
* enables you to isolate queries for you or your group of users from other queries in the
|
|
@@ -2767,20 +2766,20 @@ export type WorkGroupState = (typeof WorkGroupState)[keyof typeof WorkGroupState
|
|
|
2767
2766
|
* and to establish per-query data usage control limits for all queries in a workgroup. The
|
|
2768
2767
|
* workgroup settings override is specified in <code>EnforceWorkGroupConfiguration</code>
|
|
2769
2768
|
* (true/false) in the <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
2769
|
+
* @public
|
|
2770
2770
|
*/
|
|
2771
2771
|
export interface WorkGroup {
|
|
2772
2772
|
/**
|
|
2773
|
-
* @public
|
|
2774
2773
|
* <p>The workgroup name.</p>
|
|
2774
|
+
* @public
|
|
2775
2775
|
*/
|
|
2776
2776
|
Name: string | undefined;
|
|
2777
2777
|
/**
|
|
2778
|
-
* @public
|
|
2779
2778
|
* <p>The state of the workgroup: ENABLED or DISABLED.</p>
|
|
2779
|
+
* @public
|
|
2780
2780
|
*/
|
|
2781
2781
|
State?: WorkGroupState;
|
|
2782
2782
|
/**
|
|
2783
|
-
* @public
|
|
2784
2783
|
* <p>The configuration of the workgroup, which includes the location in Amazon S3
|
|
2785
2784
|
* where query and calculation results are stored, the encryption configuration, if any,
|
|
2786
2785
|
* used for query and calculation results; whether the Amazon CloudWatch Metrics are
|
|
@@ -2788,22 +2787,23 @@ export interface WorkGroup {
|
|
|
2788
2787
|
* the data usage limits for the amount of data scanned per query or per workgroup. The
|
|
2789
2788
|
* workgroup settings override is specified in <code>EnforceWorkGroupConfiguration</code>
|
|
2790
2789
|
* (true/false) in the <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
2790
|
+
* @public
|
|
2791
2791
|
*/
|
|
2792
2792
|
Configuration?: WorkGroupConfiguration;
|
|
2793
2793
|
/**
|
|
2794
|
-
* @public
|
|
2795
2794
|
* <p>The workgroup description.</p>
|
|
2795
|
+
* @public
|
|
2796
2796
|
*/
|
|
2797
2797
|
Description?: string;
|
|
2798
2798
|
/**
|
|
2799
|
-
* @public
|
|
2800
2799
|
* <p>The date and time the workgroup was created.</p>
|
|
2800
|
+
* @public
|
|
2801
2801
|
*/
|
|
2802
2802
|
CreationTime?: Date;
|
|
2803
2803
|
/**
|
|
2804
|
-
* @public
|
|
2805
2804
|
* <p>The ARN of the IAM Identity Center enabled application associated with the
|
|
2806
2805
|
* workgroup.</p>
|
|
2806
|
+
* @public
|
|
2807
2807
|
*/
|
|
2808
2808
|
IdentityCenterApplicationArn?: string;
|
|
2809
2809
|
}
|
|
@@ -2812,8 +2812,8 @@ export interface WorkGroup {
|
|
|
2812
2812
|
*/
|
|
2813
2813
|
export interface GetWorkGroupOutput {
|
|
2814
2814
|
/**
|
|
2815
|
-
* @public
|
|
2816
2815
|
* <p>Information about the workgroup.</p>
|
|
2816
|
+
* @public
|
|
2817
2817
|
*/
|
|
2818
2818
|
WorkGroup?: WorkGroup;
|
|
2819
2819
|
}
|
|
@@ -2822,33 +2822,32 @@ export interface GetWorkGroupOutput {
|
|
|
2822
2822
|
*/
|
|
2823
2823
|
export interface ImportNotebookInput {
|
|
2824
2824
|
/**
|
|
2825
|
-
* @public
|
|
2826
2825
|
* <p>The name of the Spark enabled workgroup to import the notebook to.</p>
|
|
2826
|
+
* @public
|
|
2827
2827
|
*/
|
|
2828
2828
|
WorkGroup: string | undefined;
|
|
2829
2829
|
/**
|
|
2830
|
-
* @public
|
|
2831
2830
|
* <p>The name of the notebook to import.</p>
|
|
2831
|
+
* @public
|
|
2832
2832
|
*/
|
|
2833
2833
|
Name: string | undefined;
|
|
2834
2834
|
/**
|
|
2835
|
-
* @public
|
|
2836
2835
|
* <p>The notebook content to be imported. The payload must be in <code>ipynb</code> format.</p>
|
|
2836
|
+
* @public
|
|
2837
2837
|
*/
|
|
2838
2838
|
Payload?: string;
|
|
2839
2839
|
/**
|
|
2840
|
-
* @public
|
|
2841
2840
|
* <p>The notebook content type. Currently, the only valid type is
|
|
2842
2841
|
* <code>IPYNB</code>.</p>
|
|
2842
|
+
* @public
|
|
2843
2843
|
*/
|
|
2844
2844
|
Type: NotebookType | undefined;
|
|
2845
2845
|
/**
|
|
2846
|
-
* @public
|
|
2847
2846
|
* <p>A URI that specifies the Amazon S3 location of a notebook file in <code>ipynb</code> format.</p>
|
|
2847
|
+
* @public
|
|
2848
2848
|
*/
|
|
2849
2849
|
NotebookS3LocationUri?: string;
|
|
2850
2850
|
/**
|
|
2851
|
-
* @public
|
|
2852
2851
|
* <p>A unique case-sensitive string used to ensure the request to import the notebook is
|
|
2853
2852
|
* idempotent (executes only once).</p>
|
|
2854
2853
|
* <important>
|
|
@@ -2857,6 +2856,7 @@ export interface ImportNotebookInput {
|
|
|
2857
2856
|
* using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
2858
2857
|
* this token or the action will fail.</p>
|
|
2859
2858
|
* </important>
|
|
2859
|
+
* @public
|
|
2860
2860
|
*/
|
|
2861
2861
|
ClientRequestToken?: string;
|
|
2862
2862
|
}
|
|
@@ -2865,8 +2865,8 @@ export interface ImportNotebookInput {
|
|
|
2865
2865
|
*/
|
|
2866
2866
|
export interface ImportNotebookOutput {
|
|
2867
2867
|
/**
|
|
2868
|
-
* @public
|
|
2869
2868
|
* <p>The ID assigned to the imported notebook.</p>
|
|
2869
|
+
* @public
|
|
2870
2870
|
*/
|
|
2871
2871
|
NotebookId?: string;
|
|
2872
2872
|
}
|
|
@@ -2875,31 +2875,31 @@ export interface ImportNotebookOutput {
|
|
|
2875
2875
|
*/
|
|
2876
2876
|
export interface ListApplicationDPUSizesInput {
|
|
2877
2877
|
/**
|
|
2878
|
-
* @public
|
|
2879
2878
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2879
|
+
* @public
|
|
2880
2880
|
*/
|
|
2881
2881
|
MaxResults?: number;
|
|
2882
2882
|
/**
|
|
2883
|
-
* @public
|
|
2884
2883
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2885
2884
|
* pagination if a previous request was truncated.</p>
|
|
2885
|
+
* @public
|
|
2886
2886
|
*/
|
|
2887
2887
|
NextToken?: string;
|
|
2888
2888
|
}
|
|
2889
2889
|
/**
|
|
2890
|
-
* @public
|
|
2891
2890
|
* <p>Contains the application runtime IDs and their supported DPU sizes.</p>
|
|
2891
|
+
* @public
|
|
2892
2892
|
*/
|
|
2893
2893
|
export interface ApplicationDPUSizes {
|
|
2894
2894
|
/**
|
|
2895
|
-
* @public
|
|
2896
2895
|
* <p>The name of the supported application runtime (for example, <code>Athena notebook
|
|
2897
2896
|
* version 1</code>).</p>
|
|
2897
|
+
* @public
|
|
2898
2898
|
*/
|
|
2899
2899
|
ApplicationRuntimeId?: string;
|
|
2900
2900
|
/**
|
|
2901
|
-
* @public
|
|
2902
2901
|
* <p>A list of the supported DPU sizes that the application runtime supports.</p>
|
|
2902
|
+
* @public
|
|
2903
2903
|
*/
|
|
2904
2904
|
SupportedDPUSizes?: number[];
|
|
2905
2905
|
}
|
|
@@ -2908,15 +2908,15 @@ export interface ApplicationDPUSizes {
|
|
|
2908
2908
|
*/
|
|
2909
2909
|
export interface ListApplicationDPUSizesOutput {
|
|
2910
2910
|
/**
|
|
2911
|
-
* @public
|
|
2912
2911
|
* <p>A list of the supported DPU sizes that the application runtime supports.</p>
|
|
2912
|
+
* @public
|
|
2913
2913
|
*/
|
|
2914
2914
|
ApplicationDPUSizes?: ApplicationDPUSizes[];
|
|
2915
2915
|
/**
|
|
2916
|
-
* @public
|
|
2917
2916
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2918
2917
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2919
2918
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2919
|
+
* @public
|
|
2920
2920
|
*/
|
|
2921
2921
|
NextToken?: string;
|
|
2922
2922
|
}
|
|
@@ -2925,12 +2925,11 @@ export interface ListApplicationDPUSizesOutput {
|
|
|
2925
2925
|
*/
|
|
2926
2926
|
export interface ListCalculationExecutionsRequest {
|
|
2927
2927
|
/**
|
|
2928
|
-
* @public
|
|
2929
2928
|
* <p>The session ID.</p>
|
|
2929
|
+
* @public
|
|
2930
2930
|
*/
|
|
2931
2931
|
SessionId: string | undefined;
|
|
2932
2932
|
/**
|
|
2933
|
-
* @public
|
|
2934
2933
|
* <p>A filter for a specific calculation execution state. A description of each state
|
|
2935
2934
|
* follows.</p>
|
|
2936
2935
|
* <p>
|
|
@@ -2951,39 +2950,40 @@ export interface ListCalculationExecutionsRequest {
|
|
|
2951
2950
|
* <code>COMPLETED</code> - The calculation has completed without error.</p>
|
|
2952
2951
|
* <p>
|
|
2953
2952
|
* <code>FAILED</code> - The calculation failed and is no longer running.</p>
|
|
2953
|
+
* @public
|
|
2954
2954
|
*/
|
|
2955
2955
|
StateFilter?: CalculationExecutionState;
|
|
2956
2956
|
/**
|
|
2957
|
-
* @public
|
|
2958
2957
|
* <p>The maximum number of calculation executions to return.</p>
|
|
2958
|
+
* @public
|
|
2959
2959
|
*/
|
|
2960
2960
|
MaxResults?: number;
|
|
2961
2961
|
/**
|
|
2962
|
-
* @public
|
|
2963
2962
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2964
2963
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2965
2964
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2965
|
+
* @public
|
|
2966
2966
|
*/
|
|
2967
2967
|
NextToken?: string;
|
|
2968
2968
|
}
|
|
2969
2969
|
/**
|
|
2970
|
-
* @public
|
|
2971
2970
|
* <p>Summary information for a notebook calculation.</p>
|
|
2971
|
+
* @public
|
|
2972
2972
|
*/
|
|
2973
2973
|
export interface CalculationSummary {
|
|
2974
2974
|
/**
|
|
2975
|
-
* @public
|
|
2976
2975
|
* <p>The calculation execution UUID.</p>
|
|
2976
|
+
* @public
|
|
2977
2977
|
*/
|
|
2978
2978
|
CalculationExecutionId?: string;
|
|
2979
2979
|
/**
|
|
2980
|
-
* @public
|
|
2981
2980
|
* <p>A description of the calculation.</p>
|
|
2981
|
+
* @public
|
|
2982
2982
|
*/
|
|
2983
2983
|
Description?: string;
|
|
2984
2984
|
/**
|
|
2985
|
-
* @public
|
|
2986
2985
|
* <p>Contains information about the status of the calculation.</p>
|
|
2986
|
+
* @public
|
|
2987
2987
|
*/
|
|
2988
2988
|
Status?: CalculationStatus;
|
|
2989
2989
|
}
|
|
@@ -2992,15 +2992,15 @@ export interface CalculationSummary {
|
|
|
2992
2992
|
*/
|
|
2993
2993
|
export interface ListCalculationExecutionsResponse {
|
|
2994
2994
|
/**
|
|
2995
|
-
* @public
|
|
2996
2995
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
2997
2996
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
2998
2997
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
2998
|
+
* @public
|
|
2999
2999
|
*/
|
|
3000
3000
|
NextToken?: string;
|
|
3001
3001
|
/**
|
|
3002
|
-
* @public
|
|
3003
3002
|
* <p>A list of <a>CalculationSummary</a> objects.</p>
|
|
3003
|
+
* @public
|
|
3004
3004
|
*/
|
|
3005
3005
|
Calculations?: CalculationSummary[];
|
|
3006
3006
|
}
|
|
@@ -3009,14 +3009,14 @@ export interface ListCalculationExecutionsResponse {
|
|
|
3009
3009
|
*/
|
|
3010
3010
|
export interface ListCapacityReservationsInput {
|
|
3011
3011
|
/**
|
|
3012
|
-
* @public
|
|
3013
3012
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3014
3013
|
* pagination if a previous request was truncated.</p>
|
|
3014
|
+
* @public
|
|
3015
3015
|
*/
|
|
3016
3016
|
NextToken?: string;
|
|
3017
3017
|
/**
|
|
3018
|
-
* @public
|
|
3019
3018
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3019
|
+
* @public
|
|
3020
3020
|
*/
|
|
3021
3021
|
MaxResults?: number;
|
|
3022
3022
|
}
|
|
@@ -3025,15 +3025,15 @@ export interface ListCapacityReservationsInput {
|
|
|
3025
3025
|
*/
|
|
3026
3026
|
export interface ListCapacityReservationsOutput {
|
|
3027
3027
|
/**
|
|
3028
|
-
* @public
|
|
3029
3028
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3030
3029
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3031
3030
|
* the NextToken from the response object of the previous page call.</p>
|
|
3031
|
+
* @public
|
|
3032
3032
|
*/
|
|
3033
3033
|
NextToken?: string;
|
|
3034
3034
|
/**
|
|
3035
|
-
* @public
|
|
3036
3035
|
* <p>The capacity reservations for the current account.</p>
|
|
3036
|
+
* @public
|
|
3037
3037
|
*/
|
|
3038
3038
|
CapacityReservations: CapacityReservation[] | undefined;
|
|
3039
3039
|
}
|
|
@@ -3042,26 +3042,26 @@ export interface ListCapacityReservationsOutput {
|
|
|
3042
3042
|
*/
|
|
3043
3043
|
export interface ListDatabasesInput {
|
|
3044
3044
|
/**
|
|
3045
|
-
* @public
|
|
3046
3045
|
* <p>The name of the data catalog that contains the databases to return.</p>
|
|
3046
|
+
* @public
|
|
3047
3047
|
*/
|
|
3048
3048
|
CatalogName: string | undefined;
|
|
3049
3049
|
/**
|
|
3050
|
-
* @public
|
|
3051
3050
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3052
3051
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3053
3052
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3053
|
+
* @public
|
|
3054
3054
|
*/
|
|
3055
3055
|
NextToken?: string;
|
|
3056
3056
|
/**
|
|
3057
|
-
* @public
|
|
3058
3057
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3058
|
+
* @public
|
|
3059
3059
|
*/
|
|
3060
3060
|
MaxResults?: number;
|
|
3061
3061
|
/**
|
|
3062
|
-
* @public
|
|
3063
3062
|
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
3064
3063
|
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
3064
|
+
* @public
|
|
3065
3065
|
*/
|
|
3066
3066
|
WorkGroup?: string;
|
|
3067
3067
|
}
|
|
@@ -3070,15 +3070,15 @@ export interface ListDatabasesInput {
|
|
|
3070
3070
|
*/
|
|
3071
3071
|
export interface ListDatabasesOutput {
|
|
3072
3072
|
/**
|
|
3073
|
-
* @public
|
|
3074
3073
|
* <p>A list of databases from a data catalog.</p>
|
|
3074
|
+
* @public
|
|
3075
3075
|
*/
|
|
3076
3076
|
DatabaseList?: Database[];
|
|
3077
3077
|
/**
|
|
3078
|
-
* @public
|
|
3079
3078
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3080
3079
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3081
3080
|
* the NextToken from the response object of the previous page call.</p>
|
|
3081
|
+
* @public
|
|
3082
3082
|
*/
|
|
3083
3083
|
NextToken?: string;
|
|
3084
3084
|
}
|
|
@@ -3087,38 +3087,38 @@ export interface ListDatabasesOutput {
|
|
|
3087
3087
|
*/
|
|
3088
3088
|
export interface ListDataCatalogsInput {
|
|
3089
3089
|
/**
|
|
3090
|
-
* @public
|
|
3091
3090
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3092
3091
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3093
3092
|
* the NextToken from the response object of the previous page call.</p>
|
|
3093
|
+
* @public
|
|
3094
3094
|
*/
|
|
3095
3095
|
NextToken?: string;
|
|
3096
3096
|
/**
|
|
3097
|
-
* @public
|
|
3098
3097
|
* <p>Specifies the maximum number of data catalogs to return.</p>
|
|
3098
|
+
* @public
|
|
3099
3099
|
*/
|
|
3100
3100
|
MaxResults?: number;
|
|
3101
3101
|
/**
|
|
3102
|
-
* @public
|
|
3103
3102
|
* <p>The name of the workgroup. Required if making an IAM Identity Center request.</p>
|
|
3103
|
+
* @public
|
|
3104
3104
|
*/
|
|
3105
3105
|
WorkGroup?: string;
|
|
3106
3106
|
}
|
|
3107
3107
|
/**
|
|
3108
|
-
* @public
|
|
3109
3108
|
* <p>The summary information for the data catalog, which includes its name and type.</p>
|
|
3109
|
+
* @public
|
|
3110
3110
|
*/
|
|
3111
3111
|
export interface DataCatalogSummary {
|
|
3112
3112
|
/**
|
|
3113
|
-
* @public
|
|
3114
3113
|
* <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,
|
|
3115
3114
|
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
3116
3115
|
* by Athena.</p>
|
|
3116
|
+
* @public
|
|
3117
3117
|
*/
|
|
3118
3118
|
CatalogName?: string;
|
|
3119
3119
|
/**
|
|
3120
|
-
* @public
|
|
3121
3120
|
* <p>The data catalog type.</p>
|
|
3121
|
+
* @public
|
|
3122
3122
|
*/
|
|
3123
3123
|
Type?: DataCatalogType;
|
|
3124
3124
|
}
|
|
@@ -3127,15 +3127,15 @@ export interface DataCatalogSummary {
|
|
|
3127
3127
|
*/
|
|
3128
3128
|
export interface ListDataCatalogsOutput {
|
|
3129
3129
|
/**
|
|
3130
|
-
* @public
|
|
3131
3130
|
* <p>A summary list of data catalogs.</p>
|
|
3131
|
+
* @public
|
|
3132
3132
|
*/
|
|
3133
3133
|
DataCatalogsSummary?: DataCatalogSummary[];
|
|
3134
3134
|
/**
|
|
3135
|
-
* @public
|
|
3136
3135
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3137
3136
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3138
3137
|
* the NextToken from the response object of the previous page call.</p>
|
|
3138
|
+
* @public
|
|
3139
3139
|
*/
|
|
3140
3140
|
NextToken?: string;
|
|
3141
3141
|
}
|
|
@@ -3144,15 +3144,15 @@ export interface ListDataCatalogsOutput {
|
|
|
3144
3144
|
*/
|
|
3145
3145
|
export interface ListEngineVersionsInput {
|
|
3146
3146
|
/**
|
|
3147
|
-
* @public
|
|
3148
3147
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3149
3148
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3150
3149
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3150
|
+
* @public
|
|
3151
3151
|
*/
|
|
3152
3152
|
NextToken?: string;
|
|
3153
3153
|
/**
|
|
3154
|
-
* @public
|
|
3155
3154
|
* <p>The maximum number of engine versions to return in this request.</p>
|
|
3155
|
+
* @public
|
|
3156
3156
|
*/
|
|
3157
3157
|
MaxResults?: number;
|
|
3158
3158
|
}
|
|
@@ -3161,15 +3161,15 @@ export interface ListEngineVersionsInput {
|
|
|
3161
3161
|
*/
|
|
3162
3162
|
export interface ListEngineVersionsOutput {
|
|
3163
3163
|
/**
|
|
3164
|
-
* @public
|
|
3165
3164
|
* <p>A list of engine versions that are available to choose from.</p>
|
|
3165
|
+
* @public
|
|
3166
3166
|
*/
|
|
3167
3167
|
EngineVersions?: EngineVersion[];
|
|
3168
3168
|
/**
|
|
3169
|
-
* @public
|
|
3170
3169
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3171
3170
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3172
3171
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3172
|
+
* @public
|
|
3173
3173
|
*/
|
|
3174
3174
|
NextToken?: string;
|
|
3175
3175
|
}
|
|
@@ -3194,12 +3194,11 @@ export type ExecutorState = (typeof ExecutorState)[keyof typeof ExecutorState];
|
|
|
3194
3194
|
*/
|
|
3195
3195
|
export interface ListExecutorsRequest {
|
|
3196
3196
|
/**
|
|
3197
|
-
* @public
|
|
3198
3197
|
* <p>The session ID.</p>
|
|
3198
|
+
* @public
|
|
3199
3199
|
*/
|
|
3200
3200
|
SessionId: string | undefined;
|
|
3201
3201
|
/**
|
|
3202
|
-
* @public
|
|
3203
3202
|
* <p>A filter for a specific executor state. A description of each state follows.</p>
|
|
3204
3203
|
* <p>
|
|
3205
3204
|
* <code>CREATING</code> - The executor is being started, including acquiring
|
|
@@ -3214,18 +3213,19 @@ export interface ListExecutorsRequest {
|
|
|
3214
3213
|
* <code>TERMINATED</code> - The executor is no longer running.</p>
|
|
3215
3214
|
* <p>
|
|
3216
3215
|
* <code>FAILED</code> - Due to a failure, the executor is no longer running.</p>
|
|
3216
|
+
* @public
|
|
3217
3217
|
*/
|
|
3218
3218
|
ExecutorStateFilter?: ExecutorState;
|
|
3219
3219
|
/**
|
|
3220
|
-
* @public
|
|
3221
3220
|
* <p>The maximum number of executors to return.</p>
|
|
3221
|
+
* @public
|
|
3222
3222
|
*/
|
|
3223
3223
|
MaxResults?: number;
|
|
3224
3224
|
/**
|
|
3225
|
-
* @public
|
|
3226
3225
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3227
3226
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3228
3227
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3228
|
+
* @public
|
|
3229
3229
|
*/
|
|
3230
3230
|
NextToken?: string;
|
|
3231
3231
|
}
|
|
@@ -3243,33 +3243,32 @@ export declare const ExecutorType: {
|
|
|
3243
3243
|
*/
|
|
3244
3244
|
export type ExecutorType = (typeof ExecutorType)[keyof typeof ExecutorType];
|
|
3245
3245
|
/**
|
|
3246
|
-
* @public
|
|
3247
3246
|
* <p>Contains summary information about an executor.</p>
|
|
3247
|
+
* @public
|
|
3248
3248
|
*/
|
|
3249
3249
|
export interface ExecutorsSummary {
|
|
3250
3250
|
/**
|
|
3251
|
-
* @public
|
|
3252
3251
|
* <p>The UUID of the executor.</p>
|
|
3252
|
+
* @public
|
|
3253
3253
|
*/
|
|
3254
3254
|
ExecutorId: string | undefined;
|
|
3255
3255
|
/**
|
|
3256
|
-
* @public
|
|
3257
3256
|
* <p>The type of executor used for the application (<code>COORDINATOR</code>,
|
|
3258
3257
|
* <code>GATEWAY</code>, or <code>WORKER</code>).</p>
|
|
3258
|
+
* @public
|
|
3259
3259
|
*/
|
|
3260
3260
|
ExecutorType?: ExecutorType;
|
|
3261
3261
|
/**
|
|
3262
|
-
* @public
|
|
3263
3262
|
* <p>The date and time that the executor started.</p>
|
|
3263
|
+
* @public
|
|
3264
3264
|
*/
|
|
3265
3265
|
StartDateTime?: number;
|
|
3266
3266
|
/**
|
|
3267
|
-
* @public
|
|
3268
3267
|
* <p>The date and time that the executor was terminated.</p>
|
|
3268
|
+
* @public
|
|
3269
3269
|
*/
|
|
3270
3270
|
TerminationDateTime?: number;
|
|
3271
3271
|
/**
|
|
3272
|
-
* @public
|
|
3273
3272
|
* <p>The processing state of the executor. A description of each state follows.</p>
|
|
3274
3273
|
* <p>
|
|
3275
3274
|
* <code>CREATING</code> - The executor is being started, including acquiring
|
|
@@ -3284,13 +3283,14 @@ export interface ExecutorsSummary {
|
|
|
3284
3283
|
* <code>TERMINATED</code> - The executor is no longer running.</p>
|
|
3285
3284
|
* <p>
|
|
3286
3285
|
* <code>FAILED</code> - Due to a failure, the executor is no longer running.</p>
|
|
3286
|
+
* @public
|
|
3287
3287
|
*/
|
|
3288
3288
|
ExecutorState?: ExecutorState;
|
|
3289
3289
|
/**
|
|
3290
|
-
* @public
|
|
3291
3290
|
* <p>The smallest unit of compute that a session can request from Athena. Size
|
|
3292
3291
|
* is measured in data processing unit (DPU) values, a relative measure of processing
|
|
3293
3292
|
* power.</p>
|
|
3293
|
+
* @public
|
|
3294
3294
|
*/
|
|
3295
3295
|
ExecutorSize?: number;
|
|
3296
3296
|
}
|
|
@@ -3299,20 +3299,20 @@ export interface ExecutorsSummary {
|
|
|
3299
3299
|
*/
|
|
3300
3300
|
export interface ListExecutorsResponse {
|
|
3301
3301
|
/**
|
|
3302
|
-
* @public
|
|
3303
3302
|
* <p>The session ID.</p>
|
|
3303
|
+
* @public
|
|
3304
3304
|
*/
|
|
3305
3305
|
SessionId: string | undefined;
|
|
3306
3306
|
/**
|
|
3307
|
-
* @public
|
|
3308
3307
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3309
3308
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3310
3309
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3310
|
+
* @public
|
|
3311
3311
|
*/
|
|
3312
3312
|
NextToken?: string;
|
|
3313
3313
|
/**
|
|
3314
|
-
* @public
|
|
3315
3314
|
* <p>Contains summary information about the executor.</p>
|
|
3315
|
+
* @public
|
|
3316
3316
|
*/
|
|
3317
3317
|
ExecutorsSummary?: ExecutorsSummary[];
|
|
3318
3318
|
}
|
|
@@ -3321,22 +3321,22 @@ export interface ListExecutorsResponse {
|
|
|
3321
3321
|
*/
|
|
3322
3322
|
export interface ListNamedQueriesInput {
|
|
3323
3323
|
/**
|
|
3324
|
-
* @public
|
|
3325
3324
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3326
3325
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3327
3326
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3327
|
+
* @public
|
|
3328
3328
|
*/
|
|
3329
3329
|
NextToken?: string;
|
|
3330
3330
|
/**
|
|
3331
|
-
* @public
|
|
3332
3331
|
* <p>The maximum number of queries to return in this request.</p>
|
|
3332
|
+
* @public
|
|
3333
3333
|
*/
|
|
3334
3334
|
MaxResults?: number;
|
|
3335
3335
|
/**
|
|
3336
|
-
* @public
|
|
3337
3336
|
* <p>The name of the workgroup from which the named queries are being returned. If a
|
|
3338
3337
|
* workgroup is not specified, the saved queries for the primary workgroup are
|
|
3339
3338
|
* returned.</p>
|
|
3339
|
+
* @public
|
|
3340
3340
|
*/
|
|
3341
3341
|
WorkGroup?: string;
|
|
3342
3342
|
}
|
|
@@ -3345,26 +3345,26 @@ export interface ListNamedQueriesInput {
|
|
|
3345
3345
|
*/
|
|
3346
3346
|
export interface ListNamedQueriesOutput {
|
|
3347
3347
|
/**
|
|
3348
|
-
* @public
|
|
3349
3348
|
* <p>The list of unique query IDs.</p>
|
|
3349
|
+
* @public
|
|
3350
3350
|
*/
|
|
3351
3351
|
NamedQueryIds?: string[];
|
|
3352
3352
|
/**
|
|
3353
|
-
* @public
|
|
3354
3353
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3355
3354
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3356
3355
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3356
|
+
* @public
|
|
3357
3357
|
*/
|
|
3358
3358
|
NextToken?: string;
|
|
3359
3359
|
}
|
|
3360
3360
|
/**
|
|
3361
|
-
* @public
|
|
3362
3361
|
* <p>A string for searching notebook names.</p>
|
|
3362
|
+
* @public
|
|
3363
3363
|
*/
|
|
3364
3364
|
export interface FilterDefinition {
|
|
3365
3365
|
/**
|
|
3366
|
-
* @public
|
|
3367
3366
|
* <p>The name of the notebook to search for.</p>
|
|
3367
|
+
* @public
|
|
3368
3368
|
*/
|
|
3369
3369
|
Name?: string;
|
|
3370
3370
|
}
|
|
@@ -3373,24 +3373,24 @@ export interface FilterDefinition {
|
|
|
3373
3373
|
*/
|
|
3374
3374
|
export interface ListNotebookMetadataInput {
|
|
3375
3375
|
/**
|
|
3376
|
-
* @public
|
|
3377
3376
|
* <p>Search filter string.</p>
|
|
3377
|
+
* @public
|
|
3378
3378
|
*/
|
|
3379
3379
|
Filters?: FilterDefinition;
|
|
3380
3380
|
/**
|
|
3381
|
-
* @public
|
|
3382
3381
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3383
3382
|
* pagination if a previous request was truncated.</p>
|
|
3383
|
+
* @public
|
|
3384
3384
|
*/
|
|
3385
3385
|
NextToken?: string;
|
|
3386
3386
|
/**
|
|
3387
|
-
* @public
|
|
3388
3387
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3388
|
+
* @public
|
|
3389
3389
|
*/
|
|
3390
3390
|
MaxResults?: number;
|
|
3391
3391
|
/**
|
|
3392
|
-
* @public
|
|
3393
3392
|
* <p>The name of the Spark enabled workgroup to retrieve notebook metadata for.</p>
|
|
3393
|
+
* @public
|
|
3394
3394
|
*/
|
|
3395
3395
|
WorkGroup: string | undefined;
|
|
3396
3396
|
}
|
|
@@ -3399,15 +3399,15 @@ export interface ListNotebookMetadataInput {
|
|
|
3399
3399
|
*/
|
|
3400
3400
|
export interface ListNotebookMetadataOutput {
|
|
3401
3401
|
/**
|
|
3402
|
-
* @public
|
|
3403
3402
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3404
3403
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3405
3404
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3405
|
+
* @public
|
|
3406
3406
|
*/
|
|
3407
3407
|
NextToken?: string;
|
|
3408
3408
|
/**
|
|
3409
|
-
* @public
|
|
3410
3409
|
* <p>The list of notebook metadata for the specified workgroup.</p>
|
|
3410
|
+
* @public
|
|
3411
3411
|
*/
|
|
3412
3412
|
NotebookMetadataList?: NotebookMetadata[];
|
|
3413
3413
|
}
|
|
@@ -3416,36 +3416,36 @@ export interface ListNotebookMetadataOutput {
|
|
|
3416
3416
|
*/
|
|
3417
3417
|
export interface ListNotebookSessionsRequest {
|
|
3418
3418
|
/**
|
|
3419
|
-
* @public
|
|
3420
3419
|
* <p>The ID of the notebook to list sessions for.</p>
|
|
3420
|
+
* @public
|
|
3421
3421
|
*/
|
|
3422
3422
|
NotebookId: string | undefined;
|
|
3423
3423
|
/**
|
|
3424
|
-
* @public
|
|
3425
3424
|
* <p>The maximum number of notebook sessions to return.</p>
|
|
3425
|
+
* @public
|
|
3426
3426
|
*/
|
|
3427
3427
|
MaxResults?: number;
|
|
3428
3428
|
/**
|
|
3429
|
-
* @public
|
|
3430
3429
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3431
3430
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3432
3431
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3432
|
+
* @public
|
|
3433
3433
|
*/
|
|
3434
3434
|
NextToken?: string;
|
|
3435
3435
|
}
|
|
3436
3436
|
/**
|
|
3437
|
-
* @public
|
|
3438
3437
|
* <p>Contains the notebook session ID and notebook session creation time.</p>
|
|
3438
|
+
* @public
|
|
3439
3439
|
*/
|
|
3440
3440
|
export interface NotebookSessionSummary {
|
|
3441
3441
|
/**
|
|
3442
|
-
* @public
|
|
3443
3442
|
* <p>The notebook session ID.</p>
|
|
3443
|
+
* @public
|
|
3444
3444
|
*/
|
|
3445
3445
|
SessionId?: string;
|
|
3446
3446
|
/**
|
|
3447
|
-
* @public
|
|
3448
3447
|
* <p>The time when the notebook session was created.</p>
|
|
3448
|
+
* @public
|
|
3449
3449
|
*/
|
|
3450
3450
|
CreationTime?: Date;
|
|
3451
3451
|
}
|
|
@@ -3454,15 +3454,15 @@ export interface NotebookSessionSummary {
|
|
|
3454
3454
|
*/
|
|
3455
3455
|
export interface ListNotebookSessionsResponse {
|
|
3456
3456
|
/**
|
|
3457
|
-
* @public
|
|
3458
3457
|
* <p>A list of the sessions belonging to the notebook.</p>
|
|
3458
|
+
* @public
|
|
3459
3459
|
*/
|
|
3460
3460
|
NotebookSessionsList: NotebookSessionSummary[] | undefined;
|
|
3461
3461
|
/**
|
|
3462
|
-
* @public
|
|
3463
3462
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3464
3463
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3465
3464
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3465
|
+
* @public
|
|
3466
3466
|
*/
|
|
3467
3467
|
NextToken?: string;
|
|
3468
3468
|
}
|
|
@@ -3471,36 +3471,36 @@ export interface ListNotebookSessionsResponse {
|
|
|
3471
3471
|
*/
|
|
3472
3472
|
export interface ListPreparedStatementsInput {
|
|
3473
3473
|
/**
|
|
3474
|
-
* @public
|
|
3475
3474
|
* <p>The workgroup to list the prepared statements for.</p>
|
|
3475
|
+
* @public
|
|
3476
3476
|
*/
|
|
3477
3477
|
WorkGroup: string | undefined;
|
|
3478
3478
|
/**
|
|
3479
|
-
* @public
|
|
3480
3479
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3481
3480
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3482
3481
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3482
|
+
* @public
|
|
3483
3483
|
*/
|
|
3484
3484
|
NextToken?: string;
|
|
3485
3485
|
/**
|
|
3486
|
-
* @public
|
|
3487
3486
|
* <p>The maximum number of results to return in this request.</p>
|
|
3487
|
+
* @public
|
|
3488
3488
|
*/
|
|
3489
3489
|
MaxResults?: number;
|
|
3490
3490
|
}
|
|
3491
3491
|
/**
|
|
3492
|
-
* @public
|
|
3493
3492
|
* <p>The name and last modified time of the prepared statement.</p>
|
|
3493
|
+
* @public
|
|
3494
3494
|
*/
|
|
3495
3495
|
export interface PreparedStatementSummary {
|
|
3496
3496
|
/**
|
|
3497
|
-
* @public
|
|
3498
3497
|
* <p>The name of the prepared statement.</p>
|
|
3498
|
+
* @public
|
|
3499
3499
|
*/
|
|
3500
3500
|
StatementName?: string;
|
|
3501
3501
|
/**
|
|
3502
|
-
* @public
|
|
3503
3502
|
* <p>The last modified time of the prepared statement.</p>
|
|
3503
|
+
* @public
|
|
3504
3504
|
*/
|
|
3505
3505
|
LastModifiedTime?: Date;
|
|
3506
3506
|
}
|
|
@@ -3509,15 +3509,15 @@ export interface PreparedStatementSummary {
|
|
|
3509
3509
|
*/
|
|
3510
3510
|
export interface ListPreparedStatementsOutput {
|
|
3511
3511
|
/**
|
|
3512
|
-
* @public
|
|
3513
3512
|
* <p>The list of prepared statements for the workgroup.</p>
|
|
3513
|
+
* @public
|
|
3514
3514
|
*/
|
|
3515
3515
|
PreparedStatements?: PreparedStatementSummary[];
|
|
3516
3516
|
/**
|
|
3517
|
-
* @public
|
|
3518
3517
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3519
3518
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3520
3519
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3520
|
+
* @public
|
|
3521
3521
|
*/
|
|
3522
3522
|
NextToken?: string;
|
|
3523
3523
|
}
|
|
@@ -3526,22 +3526,22 @@ export interface ListPreparedStatementsOutput {
|
|
|
3526
3526
|
*/
|
|
3527
3527
|
export interface ListQueryExecutionsInput {
|
|
3528
3528
|
/**
|
|
3529
|
-
* @public
|
|
3530
3529
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3531
3530
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3532
3531
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3532
|
+
* @public
|
|
3533
3533
|
*/
|
|
3534
3534
|
NextToken?: string;
|
|
3535
3535
|
/**
|
|
3536
|
-
* @public
|
|
3537
3536
|
* <p>The maximum number of query executions to return in this request.</p>
|
|
3537
|
+
* @public
|
|
3538
3538
|
*/
|
|
3539
3539
|
MaxResults?: number;
|
|
3540
3540
|
/**
|
|
3541
|
-
* @public
|
|
3542
3541
|
* <p>The name of the workgroup from which queries are being returned. If a workgroup is not
|
|
3543
3542
|
* specified, a list of available query execution IDs for the queries in the primary
|
|
3544
3543
|
* workgroup is returned.</p>
|
|
3544
|
+
* @public
|
|
3545
3545
|
*/
|
|
3546
3546
|
WorkGroup?: string;
|
|
3547
3547
|
}
|
|
@@ -3550,13 +3550,13 @@ export interface ListQueryExecutionsInput {
|
|
|
3550
3550
|
*/
|
|
3551
3551
|
export interface ListQueryExecutionsOutput {
|
|
3552
3552
|
/**
|
|
3553
|
-
* @public
|
|
3554
3553
|
* <p>The unique IDs of each query execution as an array of strings.</p>
|
|
3554
|
+
* @public
|
|
3555
3555
|
*/
|
|
3556
3556
|
QueryExecutionIds?: string[];
|
|
3557
3557
|
/**
|
|
3558
|
-
* @public
|
|
3559
3558
|
* <p>A token to be used by the next request if this request is truncated.</p>
|
|
3559
|
+
* @public
|
|
3560
3560
|
*/
|
|
3561
3561
|
NextToken?: string;
|
|
3562
3562
|
}
|
|
@@ -3565,12 +3565,11 @@ export interface ListQueryExecutionsOutput {
|
|
|
3565
3565
|
*/
|
|
3566
3566
|
export interface ListSessionsRequest {
|
|
3567
3567
|
/**
|
|
3568
|
-
* @public
|
|
3569
3568
|
* <p>The workgroup to which the session belongs.</p>
|
|
3569
|
+
* @public
|
|
3570
3570
|
*/
|
|
3571
3571
|
WorkGroup: string | undefined;
|
|
3572
3572
|
/**
|
|
3573
|
-
* @public
|
|
3574
3573
|
* <p>A filter for a specific session state. A description of each state follows.</p>
|
|
3575
3574
|
* <p>
|
|
3576
3575
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -3591,50 +3590,51 @@ export interface ListSessionsRequest {
|
|
|
3591
3590
|
* <p>
|
|
3592
3591
|
* <code>FAILED</code> - Due to a failure, the session and its resources are no longer
|
|
3593
3592
|
* running.</p>
|
|
3593
|
+
* @public
|
|
3594
3594
|
*/
|
|
3595
3595
|
StateFilter?: SessionState;
|
|
3596
3596
|
/**
|
|
3597
|
-
* @public
|
|
3598
3597
|
* <p>The maximum number of sessions to return.</p>
|
|
3598
|
+
* @public
|
|
3599
3599
|
*/
|
|
3600
3600
|
MaxResults?: number;
|
|
3601
3601
|
/**
|
|
3602
|
-
* @public
|
|
3603
3602
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3604
3603
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3605
3604
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3605
|
+
* @public
|
|
3606
3606
|
*/
|
|
3607
3607
|
NextToken?: string;
|
|
3608
3608
|
}
|
|
3609
3609
|
/**
|
|
3610
|
-
* @public
|
|
3611
3610
|
* <p>Contains summary information about a session.</p>
|
|
3611
|
+
* @public
|
|
3612
3612
|
*/
|
|
3613
3613
|
export interface SessionSummary {
|
|
3614
3614
|
/**
|
|
3615
|
-
* @public
|
|
3616
3615
|
* <p>The session ID.</p>
|
|
3616
|
+
* @public
|
|
3617
3617
|
*/
|
|
3618
3618
|
SessionId?: string;
|
|
3619
3619
|
/**
|
|
3620
|
-
* @public
|
|
3621
3620
|
* <p>The session description.</p>
|
|
3621
|
+
* @public
|
|
3622
3622
|
*/
|
|
3623
3623
|
Description?: string;
|
|
3624
3624
|
/**
|
|
3625
|
-
* @public
|
|
3626
3625
|
* <p>The engine version used by the session (for example, <code>PySpark engine version
|
|
3627
3626
|
* 3</code>).</p>
|
|
3627
|
+
* @public
|
|
3628
3628
|
*/
|
|
3629
3629
|
EngineVersion?: EngineVersion;
|
|
3630
3630
|
/**
|
|
3631
|
-
* @public
|
|
3632
3631
|
* <p>The notebook version.</p>
|
|
3632
|
+
* @public
|
|
3633
3633
|
*/
|
|
3634
3634
|
NotebookVersion?: string;
|
|
3635
3635
|
/**
|
|
3636
|
-
* @public
|
|
3637
3636
|
* <p>Contains information about the session status.</p>
|
|
3637
|
+
* @public
|
|
3638
3638
|
*/
|
|
3639
3639
|
Status?: SessionStatus;
|
|
3640
3640
|
}
|
|
@@ -3643,15 +3643,15 @@ export interface SessionSummary {
|
|
|
3643
3643
|
*/
|
|
3644
3644
|
export interface ListSessionsResponse {
|
|
3645
3645
|
/**
|
|
3646
|
-
* @public
|
|
3647
3646
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3648
3647
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3649
3648
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3649
|
+
* @public
|
|
3650
3650
|
*/
|
|
3651
3651
|
NextToken?: string;
|
|
3652
3652
|
/**
|
|
3653
|
-
* @public
|
|
3654
3653
|
* <p>A list of sessions.</p>
|
|
3654
|
+
* @public
|
|
3655
3655
|
*/
|
|
3656
3656
|
Sessions?: SessionSummary[];
|
|
3657
3657
|
}
|
|
@@ -3660,37 +3660,37 @@ export interface ListSessionsResponse {
|
|
|
3660
3660
|
*/
|
|
3661
3661
|
export interface ListTableMetadataInput {
|
|
3662
3662
|
/**
|
|
3663
|
-
* @public
|
|
3664
3663
|
* <p>The name of the data catalog for which table metadata should be returned.</p>
|
|
3664
|
+
* @public
|
|
3665
3665
|
*/
|
|
3666
3666
|
CatalogName: string | undefined;
|
|
3667
3667
|
/**
|
|
3668
|
-
* @public
|
|
3669
3668
|
* <p>The name of the database for which table metadata should be returned.</p>
|
|
3669
|
+
* @public
|
|
3670
3670
|
*/
|
|
3671
3671
|
DatabaseName: string | undefined;
|
|
3672
3672
|
/**
|
|
3673
|
-
* @public
|
|
3674
3673
|
* <p>A regex filter that pattern-matches table names. If no expression is supplied,
|
|
3675
3674
|
* metadata for all tables are listed.</p>
|
|
3675
|
+
* @public
|
|
3676
3676
|
*/
|
|
3677
3677
|
Expression?: string;
|
|
3678
3678
|
/**
|
|
3679
|
-
* @public
|
|
3680
3679
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3681
3680
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3682
3681
|
* the NextToken from the response object of the previous page call.</p>
|
|
3682
|
+
* @public
|
|
3683
3683
|
*/
|
|
3684
3684
|
NextToken?: string;
|
|
3685
3685
|
/**
|
|
3686
|
-
* @public
|
|
3687
3686
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3687
|
+
* @public
|
|
3688
3688
|
*/
|
|
3689
3689
|
MaxResults?: number;
|
|
3690
3690
|
/**
|
|
3691
|
-
* @public
|
|
3692
3691
|
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
3693
3692
|
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
3693
|
+
* @public
|
|
3694
3694
|
*/
|
|
3695
3695
|
WorkGroup?: string;
|
|
3696
3696
|
}
|
|
@@ -3699,15 +3699,15 @@ export interface ListTableMetadataInput {
|
|
|
3699
3699
|
*/
|
|
3700
3700
|
export interface ListTableMetadataOutput {
|
|
3701
3701
|
/**
|
|
3702
|
-
* @public
|
|
3703
3702
|
* <p>A list of table metadata.</p>
|
|
3703
|
+
* @public
|
|
3704
3704
|
*/
|
|
3705
3705
|
TableMetadataList?: TableMetadata[];
|
|
3706
3706
|
/**
|
|
3707
|
-
* @public
|
|
3708
3707
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3709
3708
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3710
3709
|
* the NextToken from the response object of the previous page call.</p>
|
|
3710
|
+
* @public
|
|
3711
3711
|
*/
|
|
3712
3712
|
NextToken?: string;
|
|
3713
3713
|
}
|
|
@@ -3716,21 +3716,21 @@ export interface ListTableMetadataOutput {
|
|
|
3716
3716
|
*/
|
|
3717
3717
|
export interface ListTagsForResourceInput {
|
|
3718
3718
|
/**
|
|
3719
|
-
* @public
|
|
3720
3719
|
* <p>Lists the tags for the resource with the specified ARN.</p>
|
|
3720
|
+
* @public
|
|
3721
3721
|
*/
|
|
3722
3722
|
ResourceARN: string | undefined;
|
|
3723
3723
|
/**
|
|
3724
|
-
* @public
|
|
3725
3724
|
* <p>The token for the next set of results, or null if there are no additional results for
|
|
3726
3725
|
* this request, where the request lists the tags for the resource with the specified
|
|
3727
3726
|
* ARN.</p>
|
|
3727
|
+
* @public
|
|
3728
3728
|
*/
|
|
3729
3729
|
NextToken?: string;
|
|
3730
3730
|
/**
|
|
3731
|
-
* @public
|
|
3732
3731
|
* <p>The maximum number of results to be returned per request that lists the tags for the
|
|
3733
3732
|
* resource.</p>
|
|
3733
|
+
* @public
|
|
3734
3734
|
*/
|
|
3735
3735
|
MaxResults?: number;
|
|
3736
3736
|
}
|
|
@@ -3739,13 +3739,13 @@ export interface ListTagsForResourceInput {
|
|
|
3739
3739
|
*/
|
|
3740
3740
|
export interface ListTagsForResourceOutput {
|
|
3741
3741
|
/**
|
|
3742
|
-
* @public
|
|
3743
3742
|
* <p>The list of tags associated with the specified resource.</p>
|
|
3743
|
+
* @public
|
|
3744
3744
|
*/
|
|
3745
3745
|
Tags?: Tag[];
|
|
3746
3746
|
/**
|
|
3747
|
-
* @public
|
|
3748
3747
|
* <p>A token to be used by the next request if this request is truncated.</p>
|
|
3748
|
+
* @public
|
|
3749
3749
|
*/
|
|
3750
3750
|
NextToken?: string;
|
|
3751
3751
|
}
|
|
@@ -3754,55 +3754,55 @@ export interface ListTagsForResourceOutput {
|
|
|
3754
3754
|
*/
|
|
3755
3755
|
export interface ListWorkGroupsInput {
|
|
3756
3756
|
/**
|
|
3757
|
-
* @public
|
|
3758
3757
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3759
3758
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3760
3759
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3760
|
+
* @public
|
|
3761
3761
|
*/
|
|
3762
3762
|
NextToken?: string;
|
|
3763
3763
|
/**
|
|
3764
|
-
* @public
|
|
3765
3764
|
* <p>The maximum number of workgroups to return in this request.</p>
|
|
3765
|
+
* @public
|
|
3766
3766
|
*/
|
|
3767
3767
|
MaxResults?: number;
|
|
3768
3768
|
}
|
|
3769
3769
|
/**
|
|
3770
|
-
* @public
|
|
3771
3770
|
* <p>The summary information for the workgroup, which includes its name, state,
|
|
3772
3771
|
* description, and the date and time it was created.</p>
|
|
3772
|
+
* @public
|
|
3773
3773
|
*/
|
|
3774
3774
|
export interface WorkGroupSummary {
|
|
3775
3775
|
/**
|
|
3776
|
-
* @public
|
|
3777
3776
|
* <p>The name of the workgroup.</p>
|
|
3777
|
+
* @public
|
|
3778
3778
|
*/
|
|
3779
3779
|
Name?: string;
|
|
3780
3780
|
/**
|
|
3781
|
-
* @public
|
|
3782
3781
|
* <p>The state of the workgroup.</p>
|
|
3782
|
+
* @public
|
|
3783
3783
|
*/
|
|
3784
3784
|
State?: WorkGroupState;
|
|
3785
3785
|
/**
|
|
3786
|
-
* @public
|
|
3787
3786
|
* <p>The workgroup description.</p>
|
|
3787
|
+
* @public
|
|
3788
3788
|
*/
|
|
3789
3789
|
Description?: string;
|
|
3790
3790
|
/**
|
|
3791
|
-
* @public
|
|
3792
3791
|
* <p>The workgroup creation date and time.</p>
|
|
3792
|
+
* @public
|
|
3793
3793
|
*/
|
|
3794
3794
|
CreationTime?: Date;
|
|
3795
3795
|
/**
|
|
3796
|
-
* @public
|
|
3797
3796
|
* <p>The engine version setting for all queries on the workgroup. Queries on the
|
|
3798
3797
|
* <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine
|
|
3799
3798
|
* regardless of this setting.</p>
|
|
3799
|
+
* @public
|
|
3800
3800
|
*/
|
|
3801
3801
|
EngineVersion?: EngineVersion;
|
|
3802
3802
|
/**
|
|
3803
|
-
* @public
|
|
3804
3803
|
* <p>The ARN of the IAM Identity Center enabled application associated with the
|
|
3805
3804
|
* workgroup.</p>
|
|
3805
|
+
* @public
|
|
3806
3806
|
*/
|
|
3807
3807
|
IdentityCenterApplicationArn?: string;
|
|
3808
3808
|
}
|
|
@@ -3811,16 +3811,16 @@ export interface WorkGroupSummary {
|
|
|
3811
3811
|
*/
|
|
3812
3812
|
export interface ListWorkGroupsOutput {
|
|
3813
3813
|
/**
|
|
3814
|
-
* @public
|
|
3815
3814
|
* <p>A list of <a>WorkGroupSummary</a> objects that include the names,
|
|
3816
3815
|
* descriptions, creation times, and states for each workgroup.</p>
|
|
3816
|
+
* @public
|
|
3817
3817
|
*/
|
|
3818
3818
|
WorkGroups?: WorkGroupSummary[];
|
|
3819
3819
|
/**
|
|
3820
|
-
* @public
|
|
3821
3820
|
* <p>A token generated by the Athena service that specifies where to continue
|
|
3822
3821
|
* pagination if a previous request was truncated. To obtain the next set of pages, pass in
|
|
3823
3822
|
* the <code>NextToken</code> from the response object of the previous page call.</p>
|
|
3823
|
+
* @public
|
|
3824
3824
|
*/
|
|
3825
3825
|
NextToken?: string;
|
|
3826
3826
|
}
|
|
@@ -3829,14 +3829,14 @@ export interface ListWorkGroupsOutput {
|
|
|
3829
3829
|
*/
|
|
3830
3830
|
export interface PutCapacityAssignmentConfigurationInput {
|
|
3831
3831
|
/**
|
|
3832
|
-
* @public
|
|
3833
3832
|
* <p>The name of the capacity reservation to put a capacity assignment configuration
|
|
3834
3833
|
* for.</p>
|
|
3834
|
+
* @public
|
|
3835
3835
|
*/
|
|
3836
3836
|
CapacityReservationName: string | undefined;
|
|
3837
3837
|
/**
|
|
3838
|
-
* @public
|
|
3839
3838
|
* <p>The list of assignments for the capacity assignment configuration.</p>
|
|
3839
|
+
* @public
|
|
3840
3840
|
*/
|
|
3841
3841
|
CapacityAssignments: CapacityAssignment[] | undefined;
|
|
3842
3842
|
}
|
|
@@ -3846,13 +3846,13 @@ export interface PutCapacityAssignmentConfigurationInput {
|
|
|
3846
3846
|
export interface PutCapacityAssignmentConfigurationOutput {
|
|
3847
3847
|
}
|
|
3848
3848
|
/**
|
|
3849
|
-
* @public
|
|
3850
3849
|
* <p>Contains configuration information for the calculation.</p>
|
|
3850
|
+
* @public
|
|
3851
3851
|
*/
|
|
3852
3852
|
export interface CalculationConfiguration {
|
|
3853
3853
|
/**
|
|
3854
|
-
* @public
|
|
3855
3854
|
* <p>A string that contains the code for the calculation.</p>
|
|
3855
|
+
* @public
|
|
3856
3856
|
*/
|
|
3857
3857
|
CodeBlock?: string;
|
|
3858
3858
|
}
|
|
@@ -3861,30 +3861,29 @@ export interface CalculationConfiguration {
|
|
|
3861
3861
|
*/
|
|
3862
3862
|
export interface StartCalculationExecutionRequest {
|
|
3863
3863
|
/**
|
|
3864
|
-
* @public
|
|
3865
3864
|
* <p>The session ID.</p>
|
|
3865
|
+
* @public
|
|
3866
3866
|
*/
|
|
3867
3867
|
SessionId: string | undefined;
|
|
3868
3868
|
/**
|
|
3869
|
-
* @public
|
|
3870
3869
|
* <p>A description of the calculation.</p>
|
|
3870
|
+
* @public
|
|
3871
3871
|
*/
|
|
3872
3872
|
Description?: string;
|
|
3873
3873
|
/**
|
|
3874
|
-
* @public
|
|
3875
3874
|
* @deprecated
|
|
3876
3875
|
*
|
|
3877
3876
|
* <p>Contains configuration information for the calculation.</p>
|
|
3877
|
+
* @public
|
|
3878
3878
|
*/
|
|
3879
3879
|
CalculationConfiguration?: CalculationConfiguration;
|
|
3880
3880
|
/**
|
|
3881
|
-
* @public
|
|
3882
3881
|
* <p>A string that contains the code of the calculation. Use this parameter instead of
|
|
3883
3882
|
* <a>CalculationConfiguration$CodeBlock</a>, which is deprecated.</p>
|
|
3883
|
+
* @public
|
|
3884
3884
|
*/
|
|
3885
3885
|
CodeBlock?: string;
|
|
3886
3886
|
/**
|
|
3887
|
-
* @public
|
|
3888
3887
|
* <p>A unique case-sensitive string used to ensure the request to create the calculation is
|
|
3889
3888
|
* idempotent (executes only once). If another
|
|
3890
3889
|
* <code>StartCalculationExecutionRequest</code> is received, the same response is
|
|
@@ -3896,6 +3895,7 @@ export interface StartCalculationExecutionRequest {
|
|
|
3896
3895
|
* not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
3897
3896
|
* this token or the action will fail.</p>
|
|
3898
3897
|
* </important>
|
|
3898
|
+
* @public
|
|
3899
3899
|
*/
|
|
3900
3900
|
ClientRequestToken?: string;
|
|
3901
3901
|
}
|
|
@@ -3904,12 +3904,11 @@ export interface StartCalculationExecutionRequest {
|
|
|
3904
3904
|
*/
|
|
3905
3905
|
export interface StartCalculationExecutionResponse {
|
|
3906
3906
|
/**
|
|
3907
|
-
* @public
|
|
3908
3907
|
* <p>The calculation execution UUID.</p>
|
|
3908
|
+
* @public
|
|
3909
3909
|
*/
|
|
3910
3910
|
CalculationExecutionId?: string;
|
|
3911
3911
|
/**
|
|
3912
|
-
* @public
|
|
3913
3912
|
* <p>
|
|
3914
3913
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
3915
3914
|
* <p>
|
|
@@ -3928,6 +3927,7 @@ export interface StartCalculationExecutionResponse {
|
|
|
3928
3927
|
* <code>COMPLETED</code> - The calculation has completed without error.</p>
|
|
3929
3928
|
* <p>
|
|
3930
3929
|
* <code>FAILED</code> - The calculation failed and is no longer running.</p>
|
|
3930
|
+
* @public
|
|
3931
3931
|
*/
|
|
3932
3932
|
State?: CalculationExecutionState;
|
|
3933
3933
|
}
|
|
@@ -3936,12 +3936,11 @@ export interface StartCalculationExecutionResponse {
|
|
|
3936
3936
|
*/
|
|
3937
3937
|
export interface StartQueryExecutionInput {
|
|
3938
3938
|
/**
|
|
3939
|
-
* @public
|
|
3940
3939
|
* <p>The SQL query statements to be executed.</p>
|
|
3940
|
+
* @public
|
|
3941
3941
|
*/
|
|
3942
3942
|
QueryString: string | undefined;
|
|
3943
3943
|
/**
|
|
3944
|
-
* @public
|
|
3945
3944
|
* <p>A unique case-sensitive string used to ensure the request to create the query is
|
|
3946
3945
|
* idempotent (executes only once). If another <code>StartQueryExecution</code> request is
|
|
3947
3946
|
* received, the same response is returned and another query is not created. An error is
|
|
@@ -3955,35 +3954,36 @@ export interface StartQueryExecutionInput {
|
|
|
3955
3954
|
* not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
3956
3955
|
* this token or the action will fail.</p>
|
|
3957
3956
|
* </important>
|
|
3957
|
+
* @public
|
|
3958
3958
|
*/
|
|
3959
3959
|
ClientRequestToken?: string;
|
|
3960
3960
|
/**
|
|
3961
|
-
* @public
|
|
3962
3961
|
* <p>The database within which the query executes.</p>
|
|
3962
|
+
* @public
|
|
3963
3963
|
*/
|
|
3964
3964
|
QueryExecutionContext?: QueryExecutionContext;
|
|
3965
3965
|
/**
|
|
3966
|
-
* @public
|
|
3967
3966
|
* <p>Specifies information about where and how to save the results of the query execution.
|
|
3968
3967
|
* If the query runs in a workgroup, then workgroup's settings may override query settings.
|
|
3969
3968
|
* This affects the query results location. The workgroup settings override is specified in
|
|
3970
3969
|
* EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
3970
|
+
* @public
|
|
3971
3971
|
*/
|
|
3972
3972
|
ResultConfiguration?: ResultConfiguration;
|
|
3973
3973
|
/**
|
|
3974
|
-
* @public
|
|
3975
3974
|
* <p>The name of the workgroup in which the query is being started.</p>
|
|
3975
|
+
* @public
|
|
3976
3976
|
*/
|
|
3977
3977
|
WorkGroup?: string;
|
|
3978
3978
|
/**
|
|
3979
|
-
* @public
|
|
3980
3979
|
* <p>A list of values for the parameters in a query. The values are applied sequentially to
|
|
3981
3980
|
* the parameters in the query in the order in which the parameters occur.</p>
|
|
3981
|
+
* @public
|
|
3982
3982
|
*/
|
|
3983
3983
|
ExecutionParameters?: string[];
|
|
3984
3984
|
/**
|
|
3985
|
-
* @public
|
|
3986
3985
|
* <p>Specifies the query result reuse behavior for the query.</p>
|
|
3986
|
+
* @public
|
|
3987
3987
|
*/
|
|
3988
3988
|
ResultReuseConfiguration?: ResultReuseConfiguration;
|
|
3989
3989
|
}
|
|
@@ -3992,14 +3992,14 @@ export interface StartQueryExecutionInput {
|
|
|
3992
3992
|
*/
|
|
3993
3993
|
export interface StartQueryExecutionOutput {
|
|
3994
3994
|
/**
|
|
3995
|
-
* @public
|
|
3996
3995
|
* <p>The unique ID of the query that ran as a result of this request.</p>
|
|
3996
|
+
* @public
|
|
3997
3997
|
*/
|
|
3998
3998
|
QueryExecutionId?: string;
|
|
3999
3999
|
}
|
|
4000
4000
|
/**
|
|
4001
|
-
* @public
|
|
4002
4001
|
* <p>The specified session already exists.</p>
|
|
4002
|
+
* @public
|
|
4003
4003
|
*/
|
|
4004
4004
|
export declare class SessionAlreadyExistsException extends __BaseException {
|
|
4005
4005
|
readonly name: "SessionAlreadyExistsException";
|
|
@@ -4015,37 +4015,36 @@ export declare class SessionAlreadyExistsException extends __BaseException {
|
|
|
4015
4015
|
*/
|
|
4016
4016
|
export interface StartSessionRequest {
|
|
4017
4017
|
/**
|
|
4018
|
-
* @public
|
|
4019
4018
|
* <p>The session description.</p>
|
|
4019
|
+
* @public
|
|
4020
4020
|
*/
|
|
4021
4021
|
Description?: string;
|
|
4022
4022
|
/**
|
|
4023
|
-
* @public
|
|
4024
4023
|
* <p>The workgroup to which the session belongs.</p>
|
|
4024
|
+
* @public
|
|
4025
4025
|
*/
|
|
4026
4026
|
WorkGroup: string | undefined;
|
|
4027
4027
|
/**
|
|
4028
|
-
* @public
|
|
4029
4028
|
* <p>Contains engine data processing unit (DPU) configuration settings and parameter
|
|
4030
4029
|
* mappings.</p>
|
|
4030
|
+
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
EngineConfiguration: EngineConfiguration | undefined;
|
|
4033
4033
|
/**
|
|
4034
|
-
* @public
|
|
4035
4034
|
* <p>The notebook version. This value is supplied automatically for notebook sessions in
|
|
4036
4035
|
* the Athena console and is not required for programmatic session access. The
|
|
4037
4036
|
* only valid notebook version is <code>Athena notebook version 1</code>. If
|
|
4038
4037
|
* you specify a value for <code>NotebookVersion</code>, you must also specify a value for
|
|
4039
4038
|
* <code>NotebookId</code>. See <a>EngineConfiguration$AdditionalConfigs</a>.</p>
|
|
4039
|
+
* @public
|
|
4040
4040
|
*/
|
|
4041
4041
|
NotebookVersion?: string;
|
|
4042
4042
|
/**
|
|
4043
|
-
* @public
|
|
4044
4043
|
* <p>The idle timeout in minutes for the session.</p>
|
|
4044
|
+
* @public
|
|
4045
4045
|
*/
|
|
4046
4046
|
SessionIdleTimeoutInMinutes?: number;
|
|
4047
4047
|
/**
|
|
4048
|
-
* @public
|
|
4049
4048
|
* <p>A unique case-sensitive string used to ensure the request to create the session is
|
|
4050
4049
|
* idempotent (executes only once). If another <code>StartSessionRequest</code> is
|
|
4051
4050
|
* received, the same response is returned and another session is not created. If a
|
|
@@ -4056,6 +4055,7 @@ export interface StartSessionRequest {
|
|
|
4056
4055
|
* not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
4057
4056
|
* this token or the action will fail.</p>
|
|
4058
4057
|
* </important>
|
|
4058
|
+
* @public
|
|
4059
4059
|
*/
|
|
4060
4060
|
ClientRequestToken?: string;
|
|
4061
4061
|
}
|
|
@@ -4064,12 +4064,11 @@ export interface StartSessionRequest {
|
|
|
4064
4064
|
*/
|
|
4065
4065
|
export interface StartSessionResponse {
|
|
4066
4066
|
/**
|
|
4067
|
-
* @public
|
|
4068
4067
|
* <p>The session ID.</p>
|
|
4068
|
+
* @public
|
|
4069
4069
|
*/
|
|
4070
4070
|
SessionId?: string;
|
|
4071
4071
|
/**
|
|
4072
|
-
* @public
|
|
4073
4072
|
* <p>The state of the session. A description of each state follows.</p>
|
|
4074
4073
|
* <p>
|
|
4075
4074
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -4090,6 +4089,7 @@ export interface StartSessionResponse {
|
|
|
4090
4089
|
* <p>
|
|
4091
4090
|
* <code>FAILED</code> - Due to a failure, the session and its resources are no longer
|
|
4092
4091
|
* running.</p>
|
|
4092
|
+
* @public
|
|
4093
4093
|
*/
|
|
4094
4094
|
State?: SessionState;
|
|
4095
4095
|
}
|
|
@@ -4098,8 +4098,8 @@ export interface StartSessionResponse {
|
|
|
4098
4098
|
*/
|
|
4099
4099
|
export interface StopCalculationExecutionRequest {
|
|
4100
4100
|
/**
|
|
4101
|
-
* @public
|
|
4102
4101
|
* <p>The calculation execution UUID.</p>
|
|
4102
|
+
* @public
|
|
4103
4103
|
*/
|
|
4104
4104
|
CalculationExecutionId: string | undefined;
|
|
4105
4105
|
}
|
|
@@ -4108,7 +4108,6 @@ export interface StopCalculationExecutionRequest {
|
|
|
4108
4108
|
*/
|
|
4109
4109
|
export interface StopCalculationExecutionResponse {
|
|
4110
4110
|
/**
|
|
4111
|
-
* @public
|
|
4112
4111
|
* <p>
|
|
4113
4112
|
* <code>CREATING</code> - The calculation is in the process of being created.</p>
|
|
4114
4113
|
* <p>
|
|
@@ -4127,6 +4126,7 @@ export interface StopCalculationExecutionResponse {
|
|
|
4127
4126
|
* <code>COMPLETED</code> - The calculation has completed without error.</p>
|
|
4128
4127
|
* <p>
|
|
4129
4128
|
* <code>FAILED</code> - The calculation failed and is no longer running.</p>
|
|
4129
|
+
* @public
|
|
4130
4130
|
*/
|
|
4131
4131
|
State?: CalculationExecutionState;
|
|
4132
4132
|
}
|
|
@@ -4135,8 +4135,8 @@ export interface StopCalculationExecutionResponse {
|
|
|
4135
4135
|
*/
|
|
4136
4136
|
export interface StopQueryExecutionInput {
|
|
4137
4137
|
/**
|
|
4138
|
-
* @public
|
|
4139
4138
|
* <p>The unique ID of the query execution to stop.</p>
|
|
4139
|
+
* @public
|
|
4140
4140
|
*/
|
|
4141
4141
|
QueryExecutionId?: string;
|
|
4142
4142
|
}
|
|
@@ -4150,14 +4150,14 @@ export interface StopQueryExecutionOutput {
|
|
|
4150
4150
|
*/
|
|
4151
4151
|
export interface TagResourceInput {
|
|
4152
4152
|
/**
|
|
4153
|
-
* @public
|
|
4154
4153
|
* <p>Specifies the ARN of the Athena resource to which tags are to be
|
|
4155
4154
|
* added.</p>
|
|
4155
|
+
* @public
|
|
4156
4156
|
*/
|
|
4157
4157
|
ResourceARN: string | undefined;
|
|
4158
4158
|
/**
|
|
4159
|
-
* @public
|
|
4160
4159
|
* <p>A collection of one or more tags, separated by commas, to be added to an Athena resource.</p>
|
|
4160
|
+
* @public
|
|
4161
4161
|
*/
|
|
4162
4162
|
Tags: Tag[] | undefined;
|
|
4163
4163
|
}
|
|
@@ -4171,8 +4171,8 @@ export interface TagResourceOutput {
|
|
|
4171
4171
|
*/
|
|
4172
4172
|
export interface TerminateSessionRequest {
|
|
4173
4173
|
/**
|
|
4174
|
-
* @public
|
|
4175
4174
|
* <p>The session ID.</p>
|
|
4175
|
+
* @public
|
|
4176
4176
|
*/
|
|
4177
4177
|
SessionId: string | undefined;
|
|
4178
4178
|
}
|
|
@@ -4181,7 +4181,6 @@ export interface TerminateSessionRequest {
|
|
|
4181
4181
|
*/
|
|
4182
4182
|
export interface TerminateSessionResponse {
|
|
4183
4183
|
/**
|
|
4184
|
-
* @public
|
|
4185
4184
|
* <p>The state of the session. A description of each state follows.</p>
|
|
4186
4185
|
* <p>
|
|
4187
4186
|
* <code>CREATING</code> - The session is being started, including acquiring
|
|
@@ -4202,6 +4201,7 @@ export interface TerminateSessionResponse {
|
|
|
4202
4201
|
* <p>
|
|
4203
4202
|
* <code>FAILED</code> - Due to a failure, the session and its resources are no longer
|
|
4204
4203
|
* running.</p>
|
|
4204
|
+
* @public
|
|
4205
4205
|
*/
|
|
4206
4206
|
State?: SessionState;
|
|
4207
4207
|
}
|
|
@@ -4210,14 +4210,14 @@ export interface TerminateSessionResponse {
|
|
|
4210
4210
|
*/
|
|
4211
4211
|
export interface UntagResourceInput {
|
|
4212
4212
|
/**
|
|
4213
|
-
* @public
|
|
4214
4213
|
* <p>Specifies the ARN of the resource from which tags are to be removed.</p>
|
|
4214
|
+
* @public
|
|
4215
4215
|
*/
|
|
4216
4216
|
ResourceARN: string | undefined;
|
|
4217
4217
|
/**
|
|
4218
|
-
* @public
|
|
4219
4218
|
* <p>A comma-separated list of one or more tag keys whose tags are to be removed from the
|
|
4220
4219
|
* specified resource.</p>
|
|
4220
|
+
* @public
|
|
4221
4221
|
*/
|
|
4222
4222
|
TagKeys: string[] | undefined;
|
|
4223
4223
|
}
|
|
@@ -4231,13 +4231,13 @@ export interface UntagResourceOutput {
|
|
|
4231
4231
|
*/
|
|
4232
4232
|
export interface UpdateCapacityReservationInput {
|
|
4233
4233
|
/**
|
|
4234
|
-
* @public
|
|
4235
4234
|
* <p>The new number of requested data processing units.</p>
|
|
4235
|
+
* @public
|
|
4236
4236
|
*/
|
|
4237
4237
|
TargetDpus: number | undefined;
|
|
4238
4238
|
/**
|
|
4239
|
-
* @public
|
|
4240
4239
|
* <p>The name of the capacity reservation.</p>
|
|
4240
|
+
* @public
|
|
4241
4241
|
*/
|
|
4242
4242
|
Name: string | undefined;
|
|
4243
4243
|
}
|
|
@@ -4251,27 +4251,26 @@ export interface UpdateCapacityReservationOutput {
|
|
|
4251
4251
|
*/
|
|
4252
4252
|
export interface UpdateDataCatalogInput {
|
|
4253
4253
|
/**
|
|
4254
|
-
* @public
|
|
4255
4254
|
* <p>The name of the data catalog to update. The catalog name must be unique for the
|
|
4256
4255
|
* Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at
|
|
4257
4256
|
* sign, or hyphen characters. The remainder of the length constraint of 256 is reserved
|
|
4258
4257
|
* for use by Athena.</p>
|
|
4258
|
+
* @public
|
|
4259
4259
|
*/
|
|
4260
4260
|
Name: string | undefined;
|
|
4261
4261
|
/**
|
|
4262
|
-
* @public
|
|
4263
4262
|
* <p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a
|
|
4264
4263
|
* federated catalog, <code>HIVE</code> for an external hive metastore, or
|
|
4265
4264
|
* <code>GLUE</code> for an Glue Data Catalog.</p>
|
|
4265
|
+
* @public
|
|
4266
4266
|
*/
|
|
4267
4267
|
Type: DataCatalogType | undefined;
|
|
4268
4268
|
/**
|
|
4269
|
-
* @public
|
|
4270
4269
|
* <p>New or modified text that describes the data catalog.</p>
|
|
4270
|
+
* @public
|
|
4271
4271
|
*/
|
|
4272
4272
|
Description?: string;
|
|
4273
4273
|
/**
|
|
4274
|
-
* @public
|
|
4275
4274
|
* <p>Specifies the Lambda function or functions to use for updating the data
|
|
4276
4275
|
* catalog. This is a mapping whose values depend on the catalog type. </p>
|
|
4277
4276
|
* <ul>
|
|
@@ -4311,6 +4310,7 @@ export interface UpdateDataCatalogInput {
|
|
|
4311
4310
|
* </ul>
|
|
4312
4311
|
* </li>
|
|
4313
4312
|
* </ul>
|
|
4313
|
+
* @public
|
|
4314
4314
|
*/
|
|
4315
4315
|
Parameters?: Record<string, string>;
|
|
4316
4316
|
}
|
|
@@ -4324,23 +4324,23 @@ export interface UpdateDataCatalogOutput {
|
|
|
4324
4324
|
*/
|
|
4325
4325
|
export interface UpdateNamedQueryInput {
|
|
4326
4326
|
/**
|
|
4327
|
-
* @public
|
|
4328
4327
|
* <p>The unique identifier (UUID) of the query.</p>
|
|
4328
|
+
* @public
|
|
4329
4329
|
*/
|
|
4330
4330
|
NamedQueryId: string | undefined;
|
|
4331
4331
|
/**
|
|
4332
|
-
* @public
|
|
4333
4332
|
* <p>The name of the query.</p>
|
|
4333
|
+
* @public
|
|
4334
4334
|
*/
|
|
4335
4335
|
Name: string | undefined;
|
|
4336
4336
|
/**
|
|
4337
|
-
* @public
|
|
4338
4337
|
* <p>The query description.</p>
|
|
4338
|
+
* @public
|
|
4339
4339
|
*/
|
|
4340
4340
|
Description?: string;
|
|
4341
4341
|
/**
|
|
4342
|
-
* @public
|
|
4343
4342
|
* <p>The contents of the query with all query statements.</p>
|
|
4343
|
+
* @public
|
|
4344
4344
|
*/
|
|
4345
4345
|
QueryString: string | undefined;
|
|
4346
4346
|
}
|
|
@@ -4354,28 +4354,27 @@ export interface UpdateNamedQueryOutput {
|
|
|
4354
4354
|
*/
|
|
4355
4355
|
export interface UpdateNotebookInput {
|
|
4356
4356
|
/**
|
|
4357
|
-
* @public
|
|
4358
4357
|
* <p>The ID of the notebook to update.</p>
|
|
4358
|
+
* @public
|
|
4359
4359
|
*/
|
|
4360
4360
|
NotebookId: string | undefined;
|
|
4361
4361
|
/**
|
|
4362
|
-
* @public
|
|
4363
4362
|
* <p>The updated content for the notebook.</p>
|
|
4363
|
+
* @public
|
|
4364
4364
|
*/
|
|
4365
4365
|
Payload: string | undefined;
|
|
4366
4366
|
/**
|
|
4367
|
-
* @public
|
|
4368
4367
|
* <p>The notebook content type. Currently, the only valid type is
|
|
4369
4368
|
* <code>IPYNB</code>.</p>
|
|
4369
|
+
* @public
|
|
4370
4370
|
*/
|
|
4371
4371
|
Type: NotebookType | undefined;
|
|
4372
4372
|
/**
|
|
4373
|
-
* @public
|
|
4374
4373
|
* <p>The active notebook session ID. Required if the notebook has an active session.</p>
|
|
4374
|
+
* @public
|
|
4375
4375
|
*/
|
|
4376
4376
|
SessionId?: string;
|
|
4377
4377
|
/**
|
|
4378
|
-
* @public
|
|
4379
4378
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
4380
4379
|
* idempotent (executes only once).</p>
|
|
4381
4380
|
* <important>
|
|
@@ -4384,6 +4383,7 @@ export interface UpdateNotebookInput {
|
|
|
4384
4383
|
* using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
4385
4384
|
* this token or the action will fail.</p>
|
|
4386
4385
|
* </important>
|
|
4386
|
+
* @public
|
|
4387
4387
|
*/
|
|
4388
4388
|
ClientRequestToken?: string;
|
|
4389
4389
|
}
|
|
@@ -4397,12 +4397,11 @@ export interface UpdateNotebookOutput {
|
|
|
4397
4397
|
*/
|
|
4398
4398
|
export interface UpdateNotebookMetadataInput {
|
|
4399
4399
|
/**
|
|
4400
|
-
* @public
|
|
4401
4400
|
* <p>The ID of the notebook to update the metadata for.</p>
|
|
4401
|
+
* @public
|
|
4402
4402
|
*/
|
|
4403
4403
|
NotebookId: string | undefined;
|
|
4404
4404
|
/**
|
|
4405
|
-
* @public
|
|
4406
4405
|
* <p>A unique case-sensitive string used to ensure the request to create the notebook is
|
|
4407
4406
|
* idempotent (executes only once).</p>
|
|
4408
4407
|
* <important>
|
|
@@ -4411,11 +4410,12 @@ export interface UpdateNotebookMetadataInput {
|
|
|
4411
4410
|
* using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide
|
|
4412
4411
|
* this token or the action will fail.</p>
|
|
4413
4412
|
* </important>
|
|
4413
|
+
* @public
|
|
4414
4414
|
*/
|
|
4415
4415
|
ClientRequestToken?: string;
|
|
4416
4416
|
/**
|
|
4417
|
-
* @public
|
|
4418
4417
|
* <p>The name to update the notebook to.</p>
|
|
4418
|
+
* @public
|
|
4419
4419
|
*/
|
|
4420
4420
|
Name: string | undefined;
|
|
4421
4421
|
}
|
|
@@ -4429,23 +4429,23 @@ export interface UpdateNotebookMetadataOutput {
|
|
|
4429
4429
|
*/
|
|
4430
4430
|
export interface UpdatePreparedStatementInput {
|
|
4431
4431
|
/**
|
|
4432
|
-
* @public
|
|
4433
4432
|
* <p>The name of the prepared statement.</p>
|
|
4433
|
+
* @public
|
|
4434
4434
|
*/
|
|
4435
4435
|
StatementName: string | undefined;
|
|
4436
4436
|
/**
|
|
4437
|
-
* @public
|
|
4438
4437
|
* <p>The workgroup for the prepared statement.</p>
|
|
4438
|
+
* @public
|
|
4439
4439
|
*/
|
|
4440
4440
|
WorkGroup: string | undefined;
|
|
4441
4441
|
/**
|
|
4442
|
-
* @public
|
|
4443
4442
|
* <p>The query string for the prepared statement.</p>
|
|
4443
|
+
* @public
|
|
4444
4444
|
*/
|
|
4445
4445
|
QueryStatement: string | undefined;
|
|
4446
4446
|
/**
|
|
4447
|
-
* @public
|
|
4448
4447
|
* <p>The description of the prepared statement.</p>
|
|
4448
|
+
* @public
|
|
4449
4449
|
*/
|
|
4450
4450
|
Description?: string;
|
|
4451
4451
|
}
|
|
@@ -4455,13 +4455,12 @@ export interface UpdatePreparedStatementInput {
|
|
|
4455
4455
|
export interface UpdatePreparedStatementOutput {
|
|
4456
4456
|
}
|
|
4457
4457
|
/**
|
|
4458
|
-
* @public
|
|
4459
4458
|
* <p>The information about the updates in the query results, such as output location and
|
|
4460
4459
|
* encryption configuration for the query results.</p>
|
|
4460
|
+
* @public
|
|
4461
4461
|
*/
|
|
4462
4462
|
export interface ResultConfigurationUpdates {
|
|
4463
4463
|
/**
|
|
4464
|
-
* @public
|
|
4465
4464
|
* <p>The location in Amazon S3 where your query and calculation results are stored,
|
|
4466
4465
|
* such as <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
|
|
4467
4466
|
* results, recent queries, and output files</a>. If workgroup settings override
|
|
@@ -4469,10 +4468,10 @@ export interface ResultConfigurationUpdates {
|
|
|
4469
4468
|
* encryption configuration that are specified for the workgroup. The "workgroup settings
|
|
4470
4469
|
* override" is specified in <code>EnforceWorkGroupConfiguration</code> (true/false) in the
|
|
4471
4470
|
* <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
|
|
4471
|
+
* @public
|
|
4472
4472
|
*/
|
|
4473
4473
|
OutputLocation?: string;
|
|
4474
4474
|
/**
|
|
4475
|
-
* @public
|
|
4476
4475
|
* <p>If set to "true", indicates that the previously-specified query results location (also
|
|
4477
4476
|
* known as a client-side setting) for queries in this workgroup should be ignored and set
|
|
4478
4477
|
* to null. If set to "false" or not set, and a value is present in the
|
|
@@ -4481,15 +4480,15 @@ export interface ResultConfigurationUpdates {
|
|
|
4481
4480
|
* <code>ResultConfiguration</code> will be updated with the new value. For more
|
|
4482
4481
|
* information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override
|
|
4483
4482
|
* Client-Side Settings</a>.</p>
|
|
4483
|
+
* @public
|
|
4484
4484
|
*/
|
|
4485
4485
|
RemoveOutputLocation?: boolean;
|
|
4486
4486
|
/**
|
|
4487
|
-
* @public
|
|
4488
4487
|
* <p>The encryption configuration for query and calculation results.</p>
|
|
4488
|
+
* @public
|
|
4489
4489
|
*/
|
|
4490
4490
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
4491
4491
|
/**
|
|
4492
|
-
* @public
|
|
4493
4492
|
* <p>If set to "true", indicates that the previously-specified encryption configuration
|
|
4494
4493
|
* (also known as the client-side setting) for queries in this workgroup should be ignored
|
|
4495
4494
|
* and set to null. If set to "false" or not set, and a value is present in the
|
|
@@ -4498,10 +4497,10 @@ export interface ResultConfigurationUpdates {
|
|
|
4498
4497
|
* <code>ResultConfiguration</code> will be updated with the new value. For more
|
|
4499
4498
|
* information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override
|
|
4500
4499
|
* Client-Side Settings</a>.</p>
|
|
4500
|
+
* @public
|
|
4501
4501
|
*/
|
|
4502
4502
|
RemoveEncryptionConfiguration?: boolean;
|
|
4503
4503
|
/**
|
|
4504
|
-
* @public
|
|
4505
4504
|
* <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>.
|
|
4506
4505
|
* If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it
|
|
4507
4506
|
* makes Amazon S3 calls to your specified output location. If the
|
|
@@ -4511,10 +4510,10 @@ export interface ResultConfigurationUpdates {
|
|
|
4511
4510
|
* <p>If workgroup settings override client-side settings, then the query uses the
|
|
4512
4511
|
* <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and
|
|
4513
4512
|
* also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
|
|
4513
|
+
* @public
|
|
4514
4514
|
*/
|
|
4515
4515
|
ExpectedBucketOwner?: string;
|
|
4516
4516
|
/**
|
|
4517
|
-
* @public
|
|
4518
4517
|
* <p>If set to "true", removes the Amazon Web Services account ID previously specified for
|
|
4519
4518
|
* <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to "false" or not
|
|
4520
4519
|
* set, and a value is present in the <code>ExpectedBucketOwner</code> in
|
|
@@ -4522,15 +4521,15 @@ export interface ResultConfigurationUpdates {
|
|
|
4522
4521
|
* <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code>
|
|
4523
4522
|
* is updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override
|
|
4524
4523
|
* Client-Side Settings</a>.</p>
|
|
4524
|
+
* @public
|
|
4525
4525
|
*/
|
|
4526
4526
|
RemoveExpectedBucketOwner?: boolean;
|
|
4527
4527
|
/**
|
|
4528
|
-
* @public
|
|
4529
4528
|
* <p>The ACL configuration for the query results.</p>
|
|
4529
|
+
* @public
|
|
4530
4530
|
*/
|
|
4531
4531
|
AclConfiguration?: AclConfiguration;
|
|
4532
4532
|
/**
|
|
4533
|
-
* @public
|
|
4534
4533
|
* <p>If set to <code>true</code>, indicates that the previously-specified ACL configuration
|
|
4535
4534
|
* for queries in this workgroup should be ignored and set to null. If set to
|
|
4536
4535
|
* <code>false</code> or not set, and a value is present in the
|
|
@@ -4538,92 +4537,92 @@ export interface ResultConfigurationUpdates {
|
|
|
4538
4537
|
* <code>AclConfiguration</code> in the workgroup's <code>ResultConfiguration</code> is
|
|
4539
4538
|
* updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override
|
|
4540
4539
|
* Client-Side Settings</a>.</p>
|
|
4540
|
+
* @public
|
|
4541
4541
|
*/
|
|
4542
4542
|
RemoveAclConfiguration?: boolean;
|
|
4543
4543
|
}
|
|
4544
4544
|
/**
|
|
4545
|
-
* @public
|
|
4546
4545
|
* <p>The configuration information that will be updated for this workgroup, which includes
|
|
4547
4546
|
* the location in Amazon S3 where query and calculation results are stored, the
|
|
4548
4547
|
* encryption option, if any, used for query results, whether the Amazon CloudWatch
|
|
4549
4548
|
* Metrics are enabled for the workgroup, whether the workgroup settings override the
|
|
4550
4549
|
* client-side settings, and the data usage limit for the amount of bytes scanned per
|
|
4551
4550
|
* query, if it is specified.</p>
|
|
4551
|
+
* @public
|
|
4552
4552
|
*/
|
|
4553
4553
|
export interface WorkGroupConfigurationUpdates {
|
|
4554
4554
|
/**
|
|
4555
|
-
* @public
|
|
4556
4555
|
* <p>If set to "true", the settings for the workgroup override client-side settings. If set
|
|
4557
4556
|
* 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>
|
|
4557
|
+
* @public
|
|
4558
4558
|
*/
|
|
4559
4559
|
EnforceWorkGroupConfiguration?: boolean;
|
|
4560
4560
|
/**
|
|
4561
|
-
* @public
|
|
4562
4561
|
* <p>The result configuration information about the queries in this workgroup that will be
|
|
4563
4562
|
* updated. Includes the updated results location and an updated option for encrypting
|
|
4564
4563
|
* query results.</p>
|
|
4564
|
+
* @public
|
|
4565
4565
|
*/
|
|
4566
4566
|
ResultConfigurationUpdates?: ResultConfigurationUpdates;
|
|
4567
4567
|
/**
|
|
4568
|
-
* @public
|
|
4569
4568
|
* <p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>
|
|
4569
|
+
* @public
|
|
4570
4570
|
*/
|
|
4571
4571
|
PublishCloudWatchMetricsEnabled?: boolean;
|
|
4572
4572
|
/**
|
|
4573
|
-
* @public
|
|
4574
4573
|
* <p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is
|
|
4575
4574
|
* allowed to scan.</p>
|
|
4575
|
+
* @public
|
|
4576
4576
|
*/
|
|
4577
4577
|
BytesScannedCutoffPerQuery?: number;
|
|
4578
4578
|
/**
|
|
4579
|
-
* @public
|
|
4580
4579
|
* <p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a>
|
|
4581
4580
|
* </p>
|
|
4581
|
+
* @public
|
|
4582
4582
|
*/
|
|
4583
4583
|
RemoveBytesScannedCutoffPerQuery?: boolean;
|
|
4584
4584
|
/**
|
|
4585
|
-
* @public
|
|
4586
4585
|
* <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
|
|
4587
4586
|
* members cannot query data from Requester Pays buckets, and queries that retrieve data
|
|
4588
4587
|
* from Requester Pays buckets cause an error. The default is <code>false</code>. For more
|
|
4589
4588
|
* information about Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>
|
|
4590
4589
|
* in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>
|
|
4590
|
+
* @public
|
|
4591
4591
|
*/
|
|
4592
4592
|
RequesterPaysEnabled?: boolean;
|
|
4593
4593
|
/**
|
|
4594
|
-
* @public
|
|
4595
4594
|
* <p>The engine version requested when a workgroup is updated. After the update, all
|
|
4596
4595
|
* queries on the workgroup run on the requested engine version. If no value was previously
|
|
4597
4596
|
* set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code>
|
|
4598
4597
|
* workgroup run on the preview engine regardless of this setting.</p>
|
|
4598
|
+
* @public
|
|
4599
4599
|
*/
|
|
4600
4600
|
EngineVersion?: EngineVersion;
|
|
4601
4601
|
/**
|
|
4602
|
-
* @public
|
|
4603
4602
|
* <p>Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.</p>
|
|
4603
|
+
* @public
|
|
4604
4604
|
*/
|
|
4605
4605
|
RemoveCustomerContentEncryptionConfiguration?: boolean;
|
|
4606
4606
|
/**
|
|
4607
|
-
* @public
|
|
4608
4607
|
* <p>Contains a user defined string in JSON format for a Spark-enabled workgroup.</p>
|
|
4608
|
+
* @public
|
|
4609
4609
|
*/
|
|
4610
4610
|
AdditionalConfiguration?: string;
|
|
4611
4611
|
/**
|
|
4612
|
-
* @public
|
|
4613
4612
|
* <p>The ARN of the execution role used to access user resources for Spark sessions and
|
|
4614
4613
|
* Identity Center enabled workgroups. This property applies only to Spark enabled
|
|
4615
4614
|
* workgroups and Identity Center enabled workgroups.</p>
|
|
4615
|
+
* @public
|
|
4616
4616
|
*/
|
|
4617
4617
|
ExecutionRole?: string;
|
|
4618
4618
|
/**
|
|
4619
|
-
* @public
|
|
4620
4619
|
* <p>Specifies the customer managed KMS key that is used to encrypt the user's data stores
|
|
4621
4620
|
* in Athena. When an Amazon Web Services managed key is used, this value is
|
|
4622
4621
|
* null. This setting does not apply to Athena SQL workgroups.</p>
|
|
4622
|
+
* @public
|
|
4623
4623
|
*/
|
|
4624
4624
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
4625
4625
|
/**
|
|
4626
|
-
* @public
|
|
4627
4626
|
* <p>Enforces a minimal level of encryption for the workgroup for query and calculation
|
|
4628
4627
|
* results that are written to Amazon S3. When enabled, workgroup users can set
|
|
4629
4628
|
* encryption only to the minimum level set by the administrator or higher when they submit
|
|
@@ -4633,12 +4632,13 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
4633
4632
|
* <code>EnforceWorkGroupConfiguration</code> is true, the
|
|
4634
4633
|
* <code>EnableMinimumEncryptionConfiguration</code> flag is ignored, and the workgroup
|
|
4635
4634
|
* configuration for encryption is used.</p>
|
|
4635
|
+
* @public
|
|
4636
4636
|
*/
|
|
4637
4637
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
4638
4638
|
/**
|
|
4639
|
-
* @public
|
|
4640
4639
|
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
4641
4640
|
* results.</p>
|
|
4641
|
+
* @public
|
|
4642
4642
|
*/
|
|
4643
4643
|
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
4644
4644
|
}
|
|
@@ -4647,23 +4647,23 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
4647
4647
|
*/
|
|
4648
4648
|
export interface UpdateWorkGroupInput {
|
|
4649
4649
|
/**
|
|
4650
|
-
* @public
|
|
4651
4650
|
* <p>The specified workgroup that will be updated.</p>
|
|
4651
|
+
* @public
|
|
4652
4652
|
*/
|
|
4653
4653
|
WorkGroup: string | undefined;
|
|
4654
4654
|
/**
|
|
4655
|
-
* @public
|
|
4656
4655
|
* <p>The workgroup description.</p>
|
|
4656
|
+
* @public
|
|
4657
4657
|
*/
|
|
4658
4658
|
Description?: string;
|
|
4659
4659
|
/**
|
|
4660
|
-
* @public
|
|
4661
4660
|
* <p>Contains configuration updates for an Athena SQL workgroup.</p>
|
|
4661
|
+
* @public
|
|
4662
4662
|
*/
|
|
4663
4663
|
ConfigurationUpdates?: WorkGroupConfigurationUpdates;
|
|
4664
4664
|
/**
|
|
4665
|
-
* @public
|
|
4666
4665
|
* <p>The workgroup state that will be updated for the given workgroup.</p>
|
|
4666
|
+
* @public
|
|
4667
4667
|
*/
|
|
4668
4668
|
State?: WorkGroupState;
|
|
4669
4669
|
}
|
|
@@ -4673,107 +4673,107 @@ export interface UpdateWorkGroupInput {
|
|
|
4673
4673
|
export interface UpdateWorkGroupOutput {
|
|
4674
4674
|
}
|
|
4675
4675
|
/**
|
|
4676
|
-
* @public
|
|
4677
4676
|
* <p>Stage plan information such as name, identifier, sub plans, and remote sources.</p>
|
|
4677
|
+
* @public
|
|
4678
4678
|
*/
|
|
4679
4679
|
export interface QueryStagePlanNode {
|
|
4680
4680
|
/**
|
|
4681
|
-
* @public
|
|
4682
4681
|
* <p>Name of the query stage plan that describes the operation this stage is performing as
|
|
4683
4682
|
* part of query execution.</p>
|
|
4683
|
+
* @public
|
|
4684
4684
|
*/
|
|
4685
4685
|
Name?: string;
|
|
4686
4686
|
/**
|
|
4687
|
-
* @public
|
|
4688
4687
|
* <p>Information about the operation this query stage plan node is performing.</p>
|
|
4688
|
+
* @public
|
|
4689
4689
|
*/
|
|
4690
4690
|
Identifier?: string;
|
|
4691
4691
|
/**
|
|
4692
|
-
* @public
|
|
4693
4692
|
* <p>Stage plan information such as name, identifier, sub plans, and remote sources of
|
|
4694
4693
|
* child plan nodes/</p>
|
|
4694
|
+
* @public
|
|
4695
4695
|
*/
|
|
4696
4696
|
Children?: QueryStagePlanNode[];
|
|
4697
4697
|
/**
|
|
4698
|
-
* @public
|
|
4699
4698
|
* <p>Source plan node IDs.</p>
|
|
4699
|
+
* @public
|
|
4700
4700
|
*/
|
|
4701
4701
|
RemoteSources?: string[];
|
|
4702
4702
|
}
|
|
4703
4703
|
/**
|
|
4704
|
-
* @public
|
|
4705
4704
|
* <p>Stage statistics such as input and output rows and bytes, execution time and stage
|
|
4706
4705
|
* state. This information also includes substages and the query stage plan.</p>
|
|
4706
|
+
* @public
|
|
4707
4707
|
*/
|
|
4708
4708
|
export interface QueryStage {
|
|
4709
4709
|
/**
|
|
4710
|
-
* @public
|
|
4711
4710
|
* <p>The identifier for a stage.</p>
|
|
4711
|
+
* @public
|
|
4712
4712
|
*/
|
|
4713
4713
|
StageId?: number;
|
|
4714
4714
|
/**
|
|
4715
|
-
* @public
|
|
4716
4715
|
* <p>State of the stage after query execution.</p>
|
|
4716
|
+
* @public
|
|
4717
4717
|
*/
|
|
4718
4718
|
State?: string;
|
|
4719
4719
|
/**
|
|
4720
|
-
* @public
|
|
4721
4720
|
* <p>The number of bytes output from the stage after execution.</p>
|
|
4721
|
+
* @public
|
|
4722
4722
|
*/
|
|
4723
4723
|
OutputBytes?: number;
|
|
4724
4724
|
/**
|
|
4725
|
-
* @public
|
|
4726
4725
|
* <p>The number of rows output from the stage after execution.</p>
|
|
4726
|
+
* @public
|
|
4727
4727
|
*/
|
|
4728
4728
|
OutputRows?: number;
|
|
4729
4729
|
/**
|
|
4730
|
-
* @public
|
|
4731
4730
|
* <p>The number of bytes input into the stage for execution.</p>
|
|
4731
|
+
* @public
|
|
4732
4732
|
*/
|
|
4733
4733
|
InputBytes?: number;
|
|
4734
4734
|
/**
|
|
4735
|
-
* @public
|
|
4736
4735
|
* <p>The number of rows input into the stage for execution.</p>
|
|
4736
|
+
* @public
|
|
4737
4737
|
*/
|
|
4738
4738
|
InputRows?: number;
|
|
4739
4739
|
/**
|
|
4740
|
-
* @public
|
|
4741
4740
|
* <p>Time taken to execute this stage.</p>
|
|
4741
|
+
* @public
|
|
4742
4742
|
*/
|
|
4743
4743
|
ExecutionTime?: number;
|
|
4744
4744
|
/**
|
|
4745
|
-
* @public
|
|
4746
4745
|
* <p>Stage plan information such as name, identifier, sub plans, and source stages.</p>
|
|
4746
|
+
* @public
|
|
4747
4747
|
*/
|
|
4748
4748
|
QueryStagePlan?: QueryStagePlanNode;
|
|
4749
4749
|
/**
|
|
4750
|
-
* @public
|
|
4751
4750
|
* <p>List of sub query stages that form this stage execution plan.</p>
|
|
4751
|
+
* @public
|
|
4752
4752
|
*/
|
|
4753
4753
|
SubStages?: QueryStage[];
|
|
4754
4754
|
}
|
|
4755
4755
|
/**
|
|
4756
|
-
* @public
|
|
4757
4756
|
* <p>The query execution timeline, statistics on input and output rows and bytes, and the
|
|
4758
4757
|
* different query stages that form the query execution plan.</p>
|
|
4758
|
+
* @public
|
|
4759
4759
|
*/
|
|
4760
4760
|
export interface QueryRuntimeStatistics {
|
|
4761
4761
|
/**
|
|
4762
|
-
* @public
|
|
4763
4762
|
* <p>Timeline statistics such as query queue time, planning time, execution time, service
|
|
4764
4763
|
* processing time, and total execution time.</p>
|
|
4764
|
+
* @public
|
|
4765
4765
|
*/
|
|
4766
4766
|
Timeline?: QueryRuntimeStatisticsTimeline;
|
|
4767
4767
|
/**
|
|
4768
|
-
* @public
|
|
4769
4768
|
* <p>Statistics such as input rows and bytes read by the query, rows and bytes output by
|
|
4770
4769
|
* the query, and the number of rows written by the query.</p>
|
|
4770
|
+
* @public
|
|
4771
4771
|
*/
|
|
4772
4772
|
Rows?: QueryRuntimeStatisticsRows;
|
|
4773
4773
|
/**
|
|
4774
|
-
* @public
|
|
4775
4774
|
* <p>Stage statistics such as input and output rows and bytes, execution time, and stage
|
|
4776
4775
|
* state. This information also includes substages and the query stage plan.</p>
|
|
4776
|
+
* @public
|
|
4777
4777
|
*/
|
|
4778
4778
|
OutputStage?: QueryStage;
|
|
4779
4779
|
}
|
|
@@ -4782,8 +4782,8 @@ export interface QueryRuntimeStatistics {
|
|
|
4782
4782
|
*/
|
|
4783
4783
|
export interface GetQueryRuntimeStatisticsOutput {
|
|
4784
4784
|
/**
|
|
4785
|
-
* @public
|
|
4786
4785
|
* <p>Runtime statistics about the query execution.</p>
|
|
4786
|
+
* @public
|
|
4787
4787
|
*/
|
|
4788
4788
|
QueryRuntimeStatistics?: QueryRuntimeStatistics;
|
|
4789
4789
|
}
|