1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class Athena extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: Athena.Types.ClientConfiguration)
|
13 | config: Config & Athena.Types.ClientConfiguration;
|
14 | /**
|
15 | * Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.
|
16 | */
|
17 | batchGetNamedQuery(params: Athena.Types.BatchGetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request<Athena.Types.BatchGetNamedQueryOutput, AWSError>;
|
18 | /**
|
19 | * Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.
|
20 | */
|
21 | batchGetNamedQuery(callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request<Athena.Types.BatchGetNamedQueryOutput, AWSError>;
|
22 | /**
|
23 | * Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
|
24 | */
|
25 | batchGetQueryExecution(params: Athena.Types.BatchGetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request<Athena.Types.BatchGetQueryExecutionOutput, AWSError>;
|
26 | /**
|
27 | * Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
|
28 | */
|
29 | batchGetQueryExecution(callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request<Athena.Types.BatchGetQueryExecutionOutput, AWSError>;
|
30 | /**
|
31 | * Creates a named query in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
32 | */
|
33 | createNamedQuery(params: Athena.Types.CreateNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request<Athena.Types.CreateNamedQueryOutput, AWSError>;
|
34 | /**
|
35 | * Creates a named query in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
36 | */
|
37 | createNamedQuery(callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request<Athena.Types.CreateNamedQueryOutput, AWSError>;
|
38 | /**
|
39 | * Creates a workgroup with the specified name.
|
40 | */
|
41 | createWorkGroup(params: Athena.Types.CreateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request<Athena.Types.CreateWorkGroupOutput, AWSError>;
|
42 | /**
|
43 | * Creates a workgroup with the specified name.
|
44 | */
|
45 | createWorkGroup(callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request<Athena.Types.CreateWorkGroupOutput, AWSError>;
|
46 | /**
|
47 | * Deletes the named query if you have access to the workgroup in which the query was saved. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
48 | */
|
49 | deleteNamedQuery(params: Athena.Types.DeleteNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request<Athena.Types.DeleteNamedQueryOutput, AWSError>;
|
50 | /**
|
51 | * Deletes the named query if you have access to the workgroup in which the query was saved. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
52 | */
|
53 | deleteNamedQuery(callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request<Athena.Types.DeleteNamedQueryOutput, AWSError>;
|
54 | /**
|
55 | * Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
|
56 | */
|
57 | deleteWorkGroup(params: Athena.Types.DeleteWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request<Athena.Types.DeleteWorkGroupOutput, AWSError>;
|
58 | /**
|
59 | * Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
|
60 | */
|
61 | deleteWorkGroup(callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request<Athena.Types.DeleteWorkGroupOutput, AWSError>;
|
62 | /**
|
63 | * Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
|
64 | */
|
65 | getNamedQuery(params: Athena.Types.GetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request<Athena.Types.GetNamedQueryOutput, AWSError>;
|
66 | /**
|
67 | * Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
|
68 | */
|
69 | getNamedQuery(callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request<Athena.Types.GetNamedQueryOutput, AWSError>;
|
70 | /**
|
71 | * Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.
|
72 | */
|
73 | getQueryExecution(params: Athena.Types.GetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request<Athena.Types.GetQueryExecutionOutput, AWSError>;
|
74 | /**
|
75 | * Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.
|
76 | */
|
77 | getQueryExecution(callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request<Athena.Types.GetQueryExecutionOutput, AWSError>;
|
78 | /**
|
79 | * Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location. IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
|
80 | */
|
81 | getQueryResults(params: Athena.Types.GetQueryResultsInput, callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request<Athena.Types.GetQueryResultsOutput, AWSError>;
|
82 | /**
|
83 | * Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location. IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
|
84 | */
|
85 | getQueryResults(callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request<Athena.Types.GetQueryResultsOutput, AWSError>;
|
86 | /**
|
87 | * Returns information about the workgroup with the specified name.
|
88 | */
|
89 | getWorkGroup(params: Athena.Types.GetWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request<Athena.Types.GetWorkGroupOutput, AWSError>;
|
90 | /**
|
91 | * Returns information about the workgroup with the specified name.
|
92 | */
|
93 | getWorkGroup(callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request<Athena.Types.GetWorkGroupOutput, AWSError>;
|
94 | /**
|
95 | * Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
96 | */
|
97 | listNamedQueries(params: Athena.Types.ListNamedQueriesInput, callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request<Athena.Types.ListNamedQueriesOutput, AWSError>;
|
98 | /**
|
99 | * Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
100 | */
|
101 | listNamedQueries(callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request<Athena.Types.ListNamedQueriesOutput, AWSError>;
|
102 | /**
|
103 | * Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
104 | */
|
105 | listQueryExecutions(params: Athena.Types.ListQueryExecutionsInput, callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request<Athena.Types.ListQueryExecutionsOutput, AWSError>;
|
106 | /**
|
107 | * Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
108 | */
|
109 | listQueryExecutions(callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request<Athena.Types.ListQueryExecutionsOutput, AWSError>;
|
110 | /**
|
111 | * Lists the tags associated with this workgroup.
|
112 | */
|
113 | listTagsForResource(params: Athena.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request<Athena.Types.ListTagsForResourceOutput, AWSError>;
|
114 | /**
|
115 | * Lists the tags associated with this workgroup.
|
116 | */
|
117 | listTagsForResource(callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request<Athena.Types.ListTagsForResourceOutput, AWSError>;
|
118 | /**
|
119 | * Lists available workgroups for the account.
|
120 | */
|
121 | listWorkGroups(params: Athena.Types.ListWorkGroupsInput, callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request<Athena.Types.ListWorkGroupsOutput, AWSError>;
|
122 | /**
|
123 | * Lists available workgroups for the account.
|
124 | */
|
125 | listWorkGroups(callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request<Athena.Types.ListWorkGroupsOutput, AWSError>;
|
126 | /**
|
127 | * Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
128 | */
|
129 | startQueryExecution(params: Athena.Types.StartQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request<Athena.Types.StartQueryExecutionOutput, AWSError>;
|
130 | /**
|
131 | * Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
132 | */
|
133 | startQueryExecution(callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request<Athena.Types.StartQueryExecutionOutput, AWSError>;
|
134 | /**
|
135 | * Stops a query execution. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
136 | */
|
137 | stopQueryExecution(params: Athena.Types.StopQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request<Athena.Types.StopQueryExecutionOutput, AWSError>;
|
138 | /**
|
139 | * Stops a query execution. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
|
140 | */
|
141 | stopQueryExecution(callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request<Athena.Types.StopQueryExecutionOutput, AWSError>;
|
142 | /**
|
143 | * Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.
|
144 | */
|
145 | tagResource(params: Athena.Types.TagResourceInput, callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request<Athena.Types.TagResourceOutput, AWSError>;
|
146 | /**
|
147 | * Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.
|
148 | */
|
149 | tagResource(callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request<Athena.Types.TagResourceOutput, AWSError>;
|
150 | /**
|
151 | * Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.
|
152 | */
|
153 | untagResource(params: Athena.Types.UntagResourceInput, callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request<Athena.Types.UntagResourceOutput, AWSError>;
|
154 | /**
|
155 | * Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.
|
156 | */
|
157 | untagResource(callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request<Athena.Types.UntagResourceOutput, AWSError>;
|
158 | /**
|
159 | * Updates the workgroup with the specified name. The workgroup's name cannot be changed.
|
160 | */
|
161 | updateWorkGroup(params: Athena.Types.UpdateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request<Athena.Types.UpdateWorkGroupOutput, AWSError>;
|
162 | /**
|
163 | * Updates the workgroup with the specified name. The workgroup's name cannot be changed.
|
164 | */
|
165 | updateWorkGroup(callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request<Athena.Types.UpdateWorkGroupOutput, AWSError>;
|
166 | }
|
167 | declare namespace Athena {
|
168 | export type AmazonResourceName = string;
|
169 | export interface BatchGetNamedQueryInput {
|
170 | |
171 |
|
172 |
|
173 | NamedQueryIds: NamedQueryIdList;
|
174 | }
|
175 | export interface BatchGetNamedQueryOutput {
|
176 | |
177 |
|
178 |
|
179 | NamedQueries?: NamedQueryList;
|
180 | |
181 |
|
182 |
|
183 | UnprocessedNamedQueryIds?: UnprocessedNamedQueryIdList;
|
184 | }
|
185 | export interface BatchGetQueryExecutionInput {
|
186 | |
187 |
|
188 |
|
189 | QueryExecutionIds: QueryExecutionIdList;
|
190 | }
|
191 | export interface BatchGetQueryExecutionOutput {
|
192 | |
193 |
|
194 |
|
195 | QueryExecutions?: QueryExecutionList;
|
196 | |
197 |
|
198 |
|
199 | UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionIdList;
|
200 | }
|
201 | export type Boolean = boolean;
|
202 | export type BoxedBoolean = boolean;
|
203 | export type BytesScannedCutoffValue = number;
|
204 | export interface ColumnInfo {
|
205 | |
206 |
|
207 |
|
208 | CatalogName?: String;
|
209 | |
210 |
|
211 |
|
212 | SchemaName?: String;
|
213 | |
214 |
|
215 |
|
216 | TableName?: String;
|
217 | |
218 |
|
219 |
|
220 | Name: String;
|
221 | |
222 |
|
223 |
|
224 | Label?: String;
|
225 | |
226 |
|
227 |
|
228 | Type: String;
|
229 | |
230 |
|
231 |
|
232 | Precision?: Integer;
|
233 | |
234 |
|
235 |
|
236 | Scale?: Integer;
|
237 | |
238 |
|
239 |
|
240 | Nullable?: ColumnNullable;
|
241 | |
242 |
|
243 |
|
244 | CaseSensitive?: Boolean;
|
245 | }
|
246 | export type ColumnInfoList = ColumnInfo[];
|
247 | export type ColumnNullable = "NOT_NULL"|"NULLABLE"|"UNKNOWN"|string;
|
248 | export interface CreateNamedQueryInput {
|
249 | |
250 |
|
251 |
|
252 | Name: NameString;
|
253 | |
254 |
|
255 |
|
256 | Description?: DescriptionString;
|
257 | |
258 |
|
259 |
|
260 | Database: DatabaseString;
|
261 | |
262 |
|
263 |
|
264 | QueryString: QueryString;
|
265 | |
266 |
|
267 |
|
268 | ClientRequestToken?: IdempotencyToken;
|
269 | |
270 |
|
271 |
|
272 | WorkGroup?: WorkGroupName;
|
273 | }
|
274 | export interface CreateNamedQueryOutput {
|
275 | |
276 |
|
277 |
|
278 | NamedQueryId?: NamedQueryId;
|
279 | }
|
280 | export interface CreateWorkGroupInput {
|
281 | |
282 |
|
283 |
|
284 | Name: WorkGroupName;
|
285 | |
286 |
|
287 |
|
288 | Configuration?: WorkGroupConfiguration;
|
289 | |
290 |
|
291 |
|
292 | Description?: WorkGroupDescriptionString;
|
293 | |
294 |
|
295 |
|
296 | Tags?: TagList;
|
297 | }
|
298 | export interface CreateWorkGroupOutput {
|
299 | }
|
300 | export type DatabaseString = string;
|
301 | export type _Date = Date;
|
302 | export interface Datum {
|
303 | |
304 |
|
305 |
|
306 | VarCharValue?: datumString;
|
307 | }
|
308 | export interface DeleteNamedQueryInput {
|
309 | |
310 |
|
311 |
|
312 | NamedQueryId: NamedQueryId;
|
313 | }
|
314 | export interface DeleteNamedQueryOutput {
|
315 | }
|
316 | export interface DeleteWorkGroupInput {
|
317 | |
318 |
|
319 |
|
320 | WorkGroup: WorkGroupName;
|
321 | |
322 |
|
323 |
|
324 | RecursiveDeleteOption?: BoxedBoolean;
|
325 | }
|
326 | export interface DeleteWorkGroupOutput {
|
327 | }
|
328 | export type DescriptionString = string;
|
329 | export interface EncryptionConfiguration {
|
330 | |
331 |
|
332 |
|
333 | EncryptionOption: EncryptionOption;
|
334 | |
335 |
|
336 |
|
337 | KmsKey?: String;
|
338 | }
|
339 | export type EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS"|string;
|
340 | export type ErrorCode = string;
|
341 | export type ErrorMessage = string;
|
342 | export interface GetNamedQueryInput {
|
343 | |
344 |
|
345 |
|
346 | NamedQueryId: NamedQueryId;
|
347 | }
|
348 | export interface GetNamedQueryOutput {
|
349 | |
350 |
|
351 |
|
352 | NamedQuery?: NamedQuery;
|
353 | }
|
354 | export interface GetQueryExecutionInput {
|
355 | |
356 |
|
357 |
|
358 | QueryExecutionId: QueryExecutionId;
|
359 | }
|
360 | export interface GetQueryExecutionOutput {
|
361 | |
362 |
|
363 |
|
364 | QueryExecution?: QueryExecution;
|
365 | }
|
366 | export interface GetQueryResultsInput {
|
367 | |
368 |
|
369 |
|
370 | QueryExecutionId: QueryExecutionId;
|
371 | |
372 |
|
373 |
|
374 | NextToken?: Token;
|
375 | |
376 |
|
377 |
|
378 | MaxResults?: MaxQueryResults;
|
379 | }
|
380 | export interface GetQueryResultsOutput {
|
381 | |
382 |
|
383 |
|
384 | UpdateCount?: Long;
|
385 | |
386 |
|
387 |
|
388 | ResultSet?: ResultSet;
|
389 | |
390 |
|
391 |
|
392 | NextToken?: Token;
|
393 | }
|
394 | export interface GetWorkGroupInput {
|
395 | |
396 |
|
397 |
|
398 | WorkGroup: WorkGroupName;
|
399 | }
|
400 | export interface GetWorkGroupOutput {
|
401 | |
402 |
|
403 |
|
404 | WorkGroup?: WorkGroup;
|
405 | }
|
406 | export type IdempotencyToken = string;
|
407 | export type Integer = number;
|
408 | export interface ListNamedQueriesInput {
|
409 | |
410 |
|
411 |
|
412 | NextToken?: Token;
|
413 | |
414 |
|
415 |
|
416 | MaxResults?: MaxNamedQueriesCount;
|
417 | |
418 |
|
419 |
|
420 | WorkGroup?: WorkGroupName;
|
421 | }
|
422 | export interface ListNamedQueriesOutput {
|
423 | |
424 |
|
425 |
|
426 | NamedQueryIds?: NamedQueryIdList;
|
427 | |
428 |
|
429 |
|
430 | NextToken?: Token;
|
431 | }
|
432 | export interface ListQueryExecutionsInput {
|
433 | |
434 |
|
435 |
|
436 | NextToken?: Token;
|
437 | |
438 |
|
439 |
|
440 | MaxResults?: MaxQueryExecutionsCount;
|
441 | |
442 |
|
443 |
|
444 | WorkGroup?: WorkGroupName;
|
445 | }
|
446 | export interface ListQueryExecutionsOutput {
|
447 | |
448 |
|
449 |
|
450 | QueryExecutionIds?: QueryExecutionIdList;
|
451 | |
452 |
|
453 |
|
454 | NextToken?: Token;
|
455 | }
|
456 | export interface ListTagsForResourceInput {
|
457 | |
458 |
|
459 |
|
460 | ResourceARN: AmazonResourceName;
|
461 | |
462 |
|
463 |
|
464 | NextToken?: Token;
|
465 | |
466 |
|
467 |
|
468 | MaxResults?: MaxTagsCount;
|
469 | }
|
470 | export interface ListTagsForResourceOutput {
|
471 | |
472 |
|
473 |
|
474 | Tags?: TagList;
|
475 | |
476 |
|
477 |
|
478 | NextToken?: Token;
|
479 | }
|
480 | export interface ListWorkGroupsInput {
|
481 | |
482 |
|
483 |
|
484 | NextToken?: Token;
|
485 | |
486 |
|
487 |
|
488 | MaxResults?: MaxWorkGroupsCount;
|
489 | }
|
490 | export interface ListWorkGroupsOutput {
|
491 | |
492 |
|
493 |
|
494 | WorkGroups?: WorkGroupsList;
|
495 | |
496 |
|
497 |
|
498 | NextToken?: Token;
|
499 | }
|
500 | export type Long = number;
|
501 | export type MaxNamedQueriesCount = number;
|
502 | export type MaxQueryExecutionsCount = number;
|
503 | export type MaxQueryResults = number;
|
504 | export type MaxTagsCount = number;
|
505 | export type MaxWorkGroupsCount = number;
|
506 | export type NameString = string;
|
507 | export interface NamedQuery {
|
508 | |
509 |
|
510 |
|
511 | Name: NameString;
|
512 | |
513 |
|
514 |
|
515 | Description?: DescriptionString;
|
516 | |
517 |
|
518 |
|
519 | Database: DatabaseString;
|
520 | |
521 |
|
522 |
|
523 | QueryString: QueryString;
|
524 | |
525 |
|
526 |
|
527 | NamedQueryId?: NamedQueryId;
|
528 | |
529 |
|
530 |
|
531 | WorkGroup?: WorkGroupName;
|
532 | }
|
533 | export type NamedQueryId = string;
|
534 | export type NamedQueryIdList = NamedQueryId[];
|
535 | export type NamedQueryList = NamedQuery[];
|
536 | export interface QueryExecution {
|
537 | |
538 |
|
539 |
|
540 | QueryExecutionId?: QueryExecutionId;
|
541 | |
542 |
|
543 |
|
544 | Query?: QueryString;
|
545 | |
546 |
|
547 |
|
548 | StatementType?: StatementType;
|
549 | |
550 |
|
551 |
|
552 | ResultConfiguration?: ResultConfiguration;
|
553 | |
554 |
|
555 |
|
556 | QueryExecutionContext?: QueryExecutionContext;
|
557 | |
558 |
|
559 |
|
560 | Status?: QueryExecutionStatus;
|
561 | |
562 |
|
563 |
|
564 | Statistics?: QueryExecutionStatistics;
|
565 | |
566 |
|
567 |
|
568 | WorkGroup?: WorkGroupName;
|
569 | }
|
570 | export interface QueryExecutionContext {
|
571 | |
572 |
|
573 |
|
574 | Database?: DatabaseString;
|
575 | }
|
576 | export type QueryExecutionId = string;
|
577 | export type QueryExecutionIdList = QueryExecutionId[];
|
578 | export type QueryExecutionList = QueryExecution[];
|
579 | export type QueryExecutionState = "QUEUED"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string;
|
580 | export interface QueryExecutionStatistics {
|
581 | |
582 |
|
583 |
|
584 | EngineExecutionTimeInMillis?: Long;
|
585 | |
586 |
|
587 |
|
588 | DataScannedInBytes?: Long;
|
589 | |
590 |
|
591 |
|
592 | DataManifestLocation?: String;
|
593 | }
|
594 | export interface QueryExecutionStatus {
|
595 | |
596 |
|
597 |
|
598 | State?: QueryExecutionState;
|
599 | |
600 |
|
601 |
|
602 | StateChangeReason?: String;
|
603 | |
604 |
|
605 |
|
606 | SubmissionDateTime?: _Date;
|
607 | |
608 |
|
609 |
|
610 | CompletionDateTime?: _Date;
|
611 | }
|
612 | export type QueryString = string;
|
613 | export interface ResultConfiguration {
|
614 | |
615 |
|
616 |
|
617 | OutputLocation?: String;
|
618 | |
619 |
|
620 |
|
621 | EncryptionConfiguration?: EncryptionConfiguration;
|
622 | }
|
623 | export interface ResultConfigurationUpdates {
|
624 | |
625 |
|
626 |
|
627 | OutputLocation?: String;
|
628 | |
629 |
|
630 |
|
631 | RemoveOutputLocation?: BoxedBoolean;
|
632 | |
633 |
|
634 |
|
635 | EncryptionConfiguration?: EncryptionConfiguration;
|
636 | |
637 |
|
638 |
|
639 | RemoveEncryptionConfiguration?: BoxedBoolean;
|
640 | }
|
641 | export interface ResultSet {
|
642 | |
643 |
|
644 |
|
645 | Rows?: RowList;
|
646 | |
647 |
|
648 |
|
649 | ResultSetMetadata?: ResultSetMetadata;
|
650 | }
|
651 | export interface ResultSetMetadata {
|
652 | |
653 |
|
654 |
|
655 | ColumnInfo?: ColumnInfoList;
|
656 | }
|
657 | export interface Row {
|
658 | |
659 |
|
660 |
|
661 | Data?: datumList;
|
662 | }
|
663 | export type RowList = Row[];
|
664 | export interface StartQueryExecutionInput {
|
665 | |
666 |
|
667 |
|
668 | QueryString: QueryString;
|
669 | |
670 |
|
671 |
|
672 | ClientRequestToken?: IdempotencyToken;
|
673 | |
674 |
|
675 |
|
676 | QueryExecutionContext?: QueryExecutionContext;
|
677 | |
678 |
|
679 |
|
680 | ResultConfiguration?: ResultConfiguration;
|
681 | |
682 |
|
683 |
|
684 | WorkGroup?: WorkGroupName;
|
685 | }
|
686 | export interface StartQueryExecutionOutput {
|
687 | |
688 |
|
689 |
|
690 | QueryExecutionId?: QueryExecutionId;
|
691 | }
|
692 | export type StatementType = "DDL"|"DML"|"UTILITY"|string;
|
693 | export interface StopQueryExecutionInput {
|
694 | |
695 |
|
696 |
|
697 | QueryExecutionId: QueryExecutionId;
|
698 | }
|
699 | export interface StopQueryExecutionOutput {
|
700 | }
|
701 | export type String = string;
|
702 | export interface Tag {
|
703 | |
704 |
|
705 |
|
706 | Key?: TagKey;
|
707 | |
708 |
|
709 |
|
710 | Value?: TagValue;
|
711 | }
|
712 | export type TagKey = string;
|
713 | export type TagKeyList = TagKey[];
|
714 | export type TagList = Tag[];
|
715 | export interface TagResourceInput {
|
716 | |
717 |
|
718 |
|
719 | ResourceARN: AmazonResourceName;
|
720 | |
721 |
|
722 |
|
723 | Tags: TagList;
|
724 | }
|
725 | export interface TagResourceOutput {
|
726 | }
|
727 | export type TagValue = string;
|
728 | export type Token = string;
|
729 | export interface UnprocessedNamedQueryId {
|
730 | |
731 |
|
732 |
|
733 | NamedQueryId?: NamedQueryId;
|
734 | |
735 |
|
736 |
|
737 | ErrorCode?: ErrorCode;
|
738 | |
739 |
|
740 |
|
741 | ErrorMessage?: ErrorMessage;
|
742 | }
|
743 | export type UnprocessedNamedQueryIdList = UnprocessedNamedQueryId[];
|
744 | export interface UnprocessedQueryExecutionId {
|
745 | |
746 |
|
747 |
|
748 | QueryExecutionId?: QueryExecutionId;
|
749 | |
750 |
|
751 |
|
752 | ErrorCode?: ErrorCode;
|
753 | |
754 |
|
755 |
|
756 | ErrorMessage?: ErrorMessage;
|
757 | }
|
758 | export type UnprocessedQueryExecutionIdList = UnprocessedQueryExecutionId[];
|
759 | export interface UntagResourceInput {
|
760 | |
761 |
|
762 |
|
763 | ResourceARN: AmazonResourceName;
|
764 | |
765 |
|
766 |
|
767 | TagKeys: TagKeyList;
|
768 | }
|
769 | export interface UntagResourceOutput {
|
770 | }
|
771 | export interface UpdateWorkGroupInput {
|
772 | |
773 |
|
774 |
|
775 | WorkGroup: WorkGroupName;
|
776 | |
777 |
|
778 |
|
779 | Description?: WorkGroupDescriptionString;
|
780 | |
781 |
|
782 |
|
783 | ConfigurationUpdates?: WorkGroupConfigurationUpdates;
|
784 | |
785 |
|
786 |
|
787 | State?: WorkGroupState;
|
788 | }
|
789 | export interface UpdateWorkGroupOutput {
|
790 | }
|
791 | export interface WorkGroup {
|
792 | |
793 |
|
794 |
|
795 | Name: WorkGroupName;
|
796 | |
797 |
|
798 |
|
799 | State?: WorkGroupState;
|
800 | |
801 |
|
802 |
|
803 | Configuration?: WorkGroupConfiguration;
|
804 | |
805 |
|
806 |
|
807 | Description?: WorkGroupDescriptionString;
|
808 | |
809 |
|
810 |
|
811 | CreationTime?: _Date;
|
812 | }
|
813 | export interface WorkGroupConfiguration {
|
814 | |
815 |
|
816 |
|
817 | ResultConfiguration?: ResultConfiguration;
|
818 | |
819 |
|
820 |
|
821 | EnforceWorkGroupConfiguration?: BoxedBoolean;
|
822 | |
823 |
|
824 |
|
825 | PublishCloudWatchMetricsEnabled?: BoxedBoolean;
|
826 | |
827 |
|
828 |
|
829 | BytesScannedCutoffPerQuery?: BytesScannedCutoffValue;
|
830 | |
831 |
|
832 |
|
833 | RequesterPaysEnabled?: BoxedBoolean;
|
834 | }
|
835 | export interface WorkGroupConfigurationUpdates {
|
836 | |
837 |
|
838 |
|
839 | EnforceWorkGroupConfiguration?: BoxedBoolean;
|
840 | |
841 |
|
842 |
|
843 | ResultConfigurationUpdates?: ResultConfigurationUpdates;
|
844 | |
845 |
|
846 |
|
847 | PublishCloudWatchMetricsEnabled?: BoxedBoolean;
|
848 | |
849 |
|
850 |
|
851 | BytesScannedCutoffPerQuery?: BytesScannedCutoffValue;
|
852 | |
853 |
|
854 |
|
855 | RemoveBytesScannedCutoffPerQuery?: BoxedBoolean;
|
856 | |
857 |
|
858 |
|
859 | RequesterPaysEnabled?: BoxedBoolean;
|
860 | }
|
861 | export type WorkGroupDescriptionString = string;
|
862 | export type WorkGroupName = string;
|
863 | export type WorkGroupState = "ENABLED"|"DISABLED"|string;
|
864 | export interface WorkGroupSummary {
|
865 | |
866 |
|
867 |
|
868 | Name?: WorkGroupName;
|
869 | |
870 |
|
871 |
|
872 | State?: WorkGroupState;
|
873 | |
874 |
|
875 |
|
876 | Description?: WorkGroupDescriptionString;
|
877 | |
878 |
|
879 |
|
880 | CreationTime?: _Date;
|
881 | }
|
882 | export type WorkGroupsList = WorkGroupSummary[];
|
883 | export type datumList = Datum[];
|
884 | export type datumString = string;
|
885 | |
886 |
|
887 |
|
888 | export type apiVersion = "2017-05-18"|"latest"|string;
|
889 | export interface ClientApiVersions {
|
890 | |
891 |
|
892 |
|
893 | apiVersion?: apiVersion;
|
894 | }
|
895 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
896 | |
897 |
|
898 |
|
899 | export import Types = Athena;
|
900 | }
|
901 | export = Athena;
|