@aws-sdk/client-athena 3.315.0 → 3.319.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-cjs/Athena.js +64 -840
- package/dist-cjs/protocols/Aws_json1_1.js +4 -4
- package/dist-es/Athena.js +64 -840
- package/dist-es/protocols/Aws_json1_1.js +4 -4
- package/dist-types/Athena.d.ts +81 -264
- package/dist-types/ts3.4/Athena.d.ts +2 -1
- package/package.json +8 -8
package/dist-types/Athena.d.ts
CHANGED
|
@@ -60,567 +60,384 @@ import { UpdateNotebookCommandInput, UpdateNotebookCommandOutput } from "./comma
|
|
|
60
60
|
import { UpdateNotebookMetadataCommandInput, UpdateNotebookMetadataCommandOutput } from "./commands/UpdateNotebookMetadataCommand";
|
|
61
61
|
import { UpdatePreparedStatementCommandInput, UpdatePreparedStatementCommandOutput } from "./commands/UpdatePreparedStatementCommand";
|
|
62
62
|
import { UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput } from "./commands/UpdateWorkGroupCommand";
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
* to analyze data directly in Amazon S3. You can point Athena at your
|
|
67
|
-
* data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay
|
|
68
|
-
* only for the queries you run. Athena scales automatically—executing queries
|
|
69
|
-
* in parallel—so results are fast, even with large datasets and complex queries. For more
|
|
70
|
-
* information, see <a href="http://docs.aws.amazon.com/athena/latest/ug/what-is.html">What is Amazon Athena</a> in the <i>Amazon Athena User
|
|
71
|
-
* Guide</i>.</p>
|
|
72
|
-
* <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
|
|
73
|
-
* driver or later with the Amazon Athena API. Earlier version drivers do not
|
|
74
|
-
* support the API. For more information and to download the driver, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html">Accessing
|
|
75
|
-
* Amazon Athena with JDBC</a>.</p>
|
|
76
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="https://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
77
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
78
|
-
* Guide</i>.</p>
|
|
79
|
-
*/
|
|
80
|
-
export declare class Athena extends AthenaClient {
|
|
81
|
-
/**
|
|
82
|
-
* @public
|
|
83
|
-
* <p>Returns the details of a single named query or a list of up to 50 queries, which you
|
|
84
|
-
* provide as an array of query ID strings. Requires you to have access to the workgroup in
|
|
85
|
-
* which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the
|
|
86
|
-
* list of named query IDs in the specified workgroup. If information could not be
|
|
87
|
-
* retrieved for a submitted query ID, information about the query ID submitted is listed
|
|
88
|
-
* under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed
|
|
89
|
-
* queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each
|
|
90
|
-
* unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of
|
|
91
|
-
* query execution IDs.</p>
|
|
63
|
+
export interface Athena {
|
|
64
|
+
/**
|
|
65
|
+
* @see {@link BatchGetNamedQueryCommand}
|
|
92
66
|
*/
|
|
93
67
|
batchGetNamedQuery(args: BatchGetNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetNamedQueryCommandOutput>;
|
|
94
68
|
batchGetNamedQuery(args: BatchGetNamedQueryCommandInput, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void): void;
|
|
95
69
|
batchGetNamedQuery(args: BatchGetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void): void;
|
|
96
70
|
/**
|
|
97
|
-
* @
|
|
98
|
-
* <p>Returns the details of a single prepared statement or a list of up to 256 prepared
|
|
99
|
-
* statements for the array of prepared statement names that you provide. Requires you to
|
|
100
|
-
* have access to the workgroup to which the prepared statements belong. If a prepared
|
|
101
|
-
* statement cannot be retrieved for the name specified, the statement is listed in
|
|
102
|
-
* <code>UnprocessedPreparedStatementNames</code>.</p>
|
|
71
|
+
* @see {@link BatchGetPreparedStatementCommand}
|
|
103
72
|
*/
|
|
104
73
|
batchGetPreparedStatement(args: BatchGetPreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetPreparedStatementCommandOutput>;
|
|
105
74
|
batchGetPreparedStatement(args: BatchGetPreparedStatementCommandInput, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void): void;
|
|
106
75
|
batchGetPreparedStatement(args: BatchGetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void): void;
|
|
107
76
|
/**
|
|
108
|
-
* @
|
|
109
|
-
* <p>Returns the details of a single query execution or a list of up to 50 query
|
|
110
|
-
* executions, which you provide as an array of query execution ID strings. Requires you to
|
|
111
|
-
* have access to the workgroup in which the queries ran. To get a list of query execution
|
|
112
|
-
* IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ
|
|
113
|
-
* from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details
|
|
114
|
-
* about named queries.</p>
|
|
77
|
+
* @see {@link BatchGetQueryExecutionCommand}
|
|
115
78
|
*/
|
|
116
79
|
batchGetQueryExecution(args: BatchGetQueryExecutionCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetQueryExecutionCommandOutput>;
|
|
117
80
|
batchGetQueryExecution(args: BatchGetQueryExecutionCommandInput, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void): void;
|
|
118
81
|
batchGetQueryExecution(args: BatchGetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void): void;
|
|
119
82
|
/**
|
|
120
|
-
* @
|
|
121
|
-
* <p>Creates (registers) a data catalog with the specified name and properties. Catalogs
|
|
122
|
-
* created are visible to all users of the same Amazon Web Services account.</p>
|
|
83
|
+
* @see {@link CreateDataCatalogCommand}
|
|
123
84
|
*/
|
|
124
85
|
createDataCatalog(args: CreateDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataCatalogCommandOutput>;
|
|
125
86
|
createDataCatalog(args: CreateDataCatalogCommandInput, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void): void;
|
|
126
87
|
createDataCatalog(args: CreateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void): void;
|
|
127
88
|
/**
|
|
128
|
-
* @
|
|
129
|
-
* <p>Creates a named query in the specified workgroup. Requires that you have access to the
|
|
130
|
-
* workgroup.</p>
|
|
131
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
132
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
133
|
-
* Guide</i>.</p>
|
|
89
|
+
* @see {@link CreateNamedQueryCommand}
|
|
134
90
|
*/
|
|
135
91
|
createNamedQuery(args: CreateNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise<CreateNamedQueryCommandOutput>;
|
|
136
92
|
createNamedQuery(args: CreateNamedQueryCommandInput, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void): void;
|
|
137
93
|
createNamedQuery(args: CreateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void): void;
|
|
138
94
|
/**
|
|
139
|
-
* @
|
|
140
|
-
* <p>Creates an empty <code>ipynb</code> file in the specified Apache Spark enabled
|
|
141
|
-
* workgroup. Throws an error if a file in the workgroup with the same name already
|
|
142
|
-
* exists.</p>
|
|
95
|
+
* @see {@link CreateNotebookCommand}
|
|
143
96
|
*/
|
|
144
97
|
createNotebook(args: CreateNotebookCommandInput, options?: __HttpHandlerOptions): Promise<CreateNotebookCommandOutput>;
|
|
145
98
|
createNotebook(args: CreateNotebookCommandInput, cb: (err: any, data?: CreateNotebookCommandOutput) => void): void;
|
|
146
99
|
createNotebook(args: CreateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotebookCommandOutput) => void): void;
|
|
147
100
|
/**
|
|
148
|
-
* @
|
|
149
|
-
* <p>Creates a prepared statement for use with SQL queries in Athena.</p>
|
|
101
|
+
* @see {@link CreatePreparedStatementCommand}
|
|
150
102
|
*/
|
|
151
103
|
createPreparedStatement(args: CreatePreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<CreatePreparedStatementCommandOutput>;
|
|
152
104
|
createPreparedStatement(args: CreatePreparedStatementCommandInput, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void): void;
|
|
153
105
|
createPreparedStatement(args: CreatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void): void;
|
|
154
106
|
/**
|
|
155
|
-
* @
|
|
156
|
-
* <p>Gets an authentication token and the URL at which the notebook can be accessed. During
|
|
157
|
-
* programmatic access, <code>CreatePresignedNotebookUrl</code> must be called every 10
|
|
158
|
-
* minutes to refresh the authentication token. For information about granting programmatic
|
|
159
|
-
* access, see <a href="https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access">Grant
|
|
160
|
-
* programmatic access</a>.</p>
|
|
107
|
+
* @see {@link CreatePresignedNotebookUrlCommand}
|
|
161
108
|
*/
|
|
162
109
|
createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, options?: __HttpHandlerOptions): Promise<CreatePresignedNotebookUrlCommandOutput>;
|
|
163
110
|
createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
|
|
164
111
|
createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
|
|
165
112
|
/**
|
|
166
|
-
* @
|
|
167
|
-
* <p>Creates a workgroup with the specified name. A workgroup can be an Apache Spark
|
|
168
|
-
* enabled workgroup or an Athena SQL workgroup.</p>
|
|
113
|
+
* @see {@link CreateWorkGroupCommand}
|
|
169
114
|
*/
|
|
170
115
|
createWorkGroup(args: CreateWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkGroupCommandOutput>;
|
|
171
116
|
createWorkGroup(args: CreateWorkGroupCommandInput, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void;
|
|
172
117
|
createWorkGroup(args: CreateWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void;
|
|
173
118
|
/**
|
|
174
|
-
* @
|
|
175
|
-
* <p>Deletes a data catalog.</p>
|
|
119
|
+
* @see {@link DeleteDataCatalogCommand}
|
|
176
120
|
*/
|
|
177
121
|
deleteDataCatalog(args: DeleteDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataCatalogCommandOutput>;
|
|
178
122
|
deleteDataCatalog(args: DeleteDataCatalogCommandInput, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void): void;
|
|
179
123
|
deleteDataCatalog(args: DeleteDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void): void;
|
|
180
124
|
/**
|
|
181
|
-
* @
|
|
182
|
-
* <p>Deletes the named query if you have access to the workgroup in which the query was
|
|
183
|
-
* saved.</p>
|
|
184
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
185
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
186
|
-
* Guide</i>.</p>
|
|
125
|
+
* @see {@link DeleteNamedQueryCommand}
|
|
187
126
|
*/
|
|
188
127
|
deleteNamedQuery(args: DeleteNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNamedQueryCommandOutput>;
|
|
189
128
|
deleteNamedQuery(args: DeleteNamedQueryCommandInput, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void): void;
|
|
190
129
|
deleteNamedQuery(args: DeleteNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void): void;
|
|
191
130
|
/**
|
|
192
|
-
* @
|
|
193
|
-
* <p>Deletes the specified notebook.</p>
|
|
131
|
+
* @see {@link DeleteNotebookCommand}
|
|
194
132
|
*/
|
|
195
133
|
deleteNotebook(args: DeleteNotebookCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNotebookCommandOutput>;
|
|
196
134
|
deleteNotebook(args: DeleteNotebookCommandInput, cb: (err: any, data?: DeleteNotebookCommandOutput) => void): void;
|
|
197
135
|
deleteNotebook(args: DeleteNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotebookCommandOutput) => void): void;
|
|
198
136
|
/**
|
|
199
|
-
* @
|
|
200
|
-
* <p>Deletes the prepared statement with the specified name from the specified
|
|
201
|
-
* workgroup.</p>
|
|
137
|
+
* @see {@link DeletePreparedStatementCommand}
|
|
202
138
|
*/
|
|
203
139
|
deletePreparedStatement(args: DeletePreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<DeletePreparedStatementCommandOutput>;
|
|
204
140
|
deletePreparedStatement(args: DeletePreparedStatementCommandInput, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void): void;
|
|
205
141
|
deletePreparedStatement(args: DeletePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void): void;
|
|
206
142
|
/**
|
|
207
|
-
* @
|
|
208
|
-
* <p>Deletes the workgroup with the specified name. The primary workgroup cannot be
|
|
209
|
-
* deleted.</p>
|
|
143
|
+
* @see {@link DeleteWorkGroupCommand}
|
|
210
144
|
*/
|
|
211
145
|
deleteWorkGroup(args: DeleteWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkGroupCommandOutput>;
|
|
212
146
|
deleteWorkGroup(args: DeleteWorkGroupCommandInput, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void): void;
|
|
213
147
|
deleteWorkGroup(args: DeleteWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void): void;
|
|
214
148
|
/**
|
|
215
|
-
* @
|
|
216
|
-
* <p>Exports the specified notebook and its metadata.</p>
|
|
149
|
+
* @see {@link ExportNotebookCommand}
|
|
217
150
|
*/
|
|
218
151
|
exportNotebook(args: ExportNotebookCommandInput, options?: __HttpHandlerOptions): Promise<ExportNotebookCommandOutput>;
|
|
219
152
|
exportNotebook(args: ExportNotebookCommandInput, cb: (err: any, data?: ExportNotebookCommandOutput) => void): void;
|
|
220
153
|
exportNotebook(args: ExportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportNotebookCommandOutput) => void): void;
|
|
221
154
|
/**
|
|
222
|
-
* @
|
|
223
|
-
* <p>Describes a previously submitted calculation execution.</p>
|
|
155
|
+
* @see {@link GetCalculationExecutionCommand}
|
|
224
156
|
*/
|
|
225
157
|
getCalculationExecution(args: GetCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionCommandOutput>;
|
|
226
158
|
getCalculationExecution(args: GetCalculationExecutionCommandInput, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void): void;
|
|
227
159
|
getCalculationExecution(args: GetCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void): void;
|
|
228
160
|
/**
|
|
229
|
-
* @
|
|
230
|
-
* <p>Retrieves the unencrypted code that was executed for the calculation.</p>
|
|
161
|
+
* @see {@link GetCalculationExecutionCodeCommand}
|
|
231
162
|
*/
|
|
232
163
|
getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionCodeCommandOutput>;
|
|
233
164
|
getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void): void;
|
|
234
165
|
getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void): void;
|
|
235
166
|
/**
|
|
236
|
-
* @
|
|
237
|
-
* <p>Gets the status of a current calculation.</p>
|
|
167
|
+
* @see {@link GetCalculationExecutionStatusCommand}
|
|
238
168
|
*/
|
|
239
169
|
getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionStatusCommandOutput>;
|
|
240
170
|
getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void): void;
|
|
241
171
|
getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void): void;
|
|
242
172
|
/**
|
|
243
|
-
* @
|
|
244
|
-
* <p>Returns a database object for the specified database and data catalog.</p>
|
|
173
|
+
* @see {@link GetDatabaseCommand}
|
|
245
174
|
*/
|
|
246
175
|
getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<GetDatabaseCommandOutput>;
|
|
247
176
|
getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void;
|
|
248
177
|
getDatabase(args: GetDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void;
|
|
249
178
|
/**
|
|
250
|
-
* @
|
|
251
|
-
* <p>Returns the specified data catalog.</p>
|
|
179
|
+
* @see {@link GetDataCatalogCommand}
|
|
252
180
|
*/
|
|
253
181
|
getDataCatalog(args: GetDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<GetDataCatalogCommandOutput>;
|
|
254
182
|
getDataCatalog(args: GetDataCatalogCommandInput, cb: (err: any, data?: GetDataCatalogCommandOutput) => void): void;
|
|
255
183
|
getDataCatalog(args: GetDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCatalogCommandOutput) => void): void;
|
|
256
184
|
/**
|
|
257
|
-
* @
|
|
258
|
-
* <p>Returns information about a single query. Requires that you have access to the
|
|
259
|
-
* workgroup in which the query was saved.</p>
|
|
185
|
+
* @see {@link GetNamedQueryCommand}
|
|
260
186
|
*/
|
|
261
187
|
getNamedQuery(args: GetNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise<GetNamedQueryCommandOutput>;
|
|
262
188
|
getNamedQuery(args: GetNamedQueryCommandInput, cb: (err: any, data?: GetNamedQueryCommandOutput) => void): void;
|
|
263
189
|
getNamedQuery(args: GetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamedQueryCommandOutput) => void): void;
|
|
264
190
|
/**
|
|
265
|
-
* @
|
|
266
|
-
* <p>Retrieves notebook metadata for the specified notebook ID.</p>
|
|
191
|
+
* @see {@link GetNotebookMetadataCommand}
|
|
267
192
|
*/
|
|
268
193
|
getNotebookMetadata(args: GetNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<GetNotebookMetadataCommandOutput>;
|
|
269
194
|
getNotebookMetadata(args: GetNotebookMetadataCommandInput, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void): void;
|
|
270
195
|
getNotebookMetadata(args: GetNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void): void;
|
|
271
196
|
/**
|
|
272
|
-
* @
|
|
273
|
-
* <p>Retrieves the prepared statement with the specified name from the specified
|
|
274
|
-
* workgroup.</p>
|
|
197
|
+
* @see {@link GetPreparedStatementCommand}
|
|
275
198
|
*/
|
|
276
199
|
getPreparedStatement(args: GetPreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<GetPreparedStatementCommandOutput>;
|
|
277
200
|
getPreparedStatement(args: GetPreparedStatementCommandInput, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void): void;
|
|
278
201
|
getPreparedStatement(args: GetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void): void;
|
|
279
202
|
/**
|
|
280
|
-
* @
|
|
281
|
-
* <p>Returns information about a single execution of a query if you have access to the
|
|
282
|
-
* workgroup in which the query ran. Each time a query executes, information about the
|
|
283
|
-
* query execution is saved with a unique ID.</p>
|
|
203
|
+
* @see {@link GetQueryExecutionCommand}
|
|
284
204
|
*/
|
|
285
205
|
getQueryExecution(args: GetQueryExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryExecutionCommandOutput>;
|
|
286
206
|
getQueryExecution(args: GetQueryExecutionCommandInput, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void): void;
|
|
287
207
|
getQueryExecution(args: GetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void): void;
|
|
288
208
|
/**
|
|
289
|
-
* @
|
|
290
|
-
* <p>Streams the results of a single query execution specified by
|
|
291
|
-
* <code>QueryExecutionId</code> from the Athena query results location in
|
|
292
|
-
* Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and
|
|
293
|
-
* output files</a> in the <i>Amazon Athena User Guide</i>.
|
|
294
|
-
* This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
|
|
295
|
-
* <p>To stream query results successfully, the IAM principal with permission to call
|
|
296
|
-
* <code>GetQueryResults</code> also must have permissions to the Amazon S3
|
|
297
|
-
* <code>GetObject</code> action for the Athena query results location.</p>
|
|
298
|
-
* <important>
|
|
299
|
-
* <p>IAM principals with permission to the Amazon S3
|
|
300
|
-
* <code>GetObject</code> action for the query results location are able to retrieve
|
|
301
|
-
* query results from Amazon S3 even if permission to the
|
|
302
|
-
* <code>GetQueryResults</code> action is denied. To restrict user or role access,
|
|
303
|
-
* ensure that Amazon S3 permissions to the Athena query location
|
|
304
|
-
* are denied.</p>
|
|
305
|
-
* </important>
|
|
209
|
+
* @see {@link GetQueryResultsCommand}
|
|
306
210
|
*/
|
|
307
211
|
getQueryResults(args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryResultsCommandOutput>;
|
|
308
212
|
getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
|
|
309
213
|
getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
|
|
310
214
|
/**
|
|
311
|
-
* @
|
|
312
|
-
* <p>Returns query execution runtime statistics related to a single execution of a query if
|
|
313
|
-
* you have access to the workgroup in which the query ran. Query execution runtime
|
|
314
|
-
* statistics are returned only when <a>QueryExecutionStatus$State</a> is in a
|
|
315
|
-
* SUCCEEDED or FAILED state. Stage-level input and output row count and data size
|
|
316
|
-
* statistics are not shown when a query has row-level filters defined in Lake
|
|
317
|
-
* Formation.</p>
|
|
215
|
+
* @see {@link GetQueryRuntimeStatisticsCommand}
|
|
318
216
|
*/
|
|
319
217
|
getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryRuntimeStatisticsCommandOutput>;
|
|
320
218
|
getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void): void;
|
|
321
219
|
getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void): void;
|
|
322
220
|
/**
|
|
323
|
-
* @
|
|
324
|
-
* <p>Gets the full details of a previously created session, including the session status
|
|
325
|
-
* and configuration.</p>
|
|
221
|
+
* @see {@link GetSessionCommand}
|
|
326
222
|
*/
|
|
327
223
|
getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise<GetSessionCommandOutput>;
|
|
328
224
|
getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
|
|
329
225
|
getSession(args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
|
|
330
226
|
/**
|
|
331
|
-
* @
|
|
332
|
-
* <p>Gets the current status of a session.</p>
|
|
227
|
+
* @see {@link GetSessionStatusCommand}
|
|
333
228
|
*/
|
|
334
229
|
getSessionStatus(args: GetSessionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetSessionStatusCommandOutput>;
|
|
335
230
|
getSessionStatus(args: GetSessionStatusCommandInput, cb: (err: any, data?: GetSessionStatusCommandOutput) => void): void;
|
|
336
231
|
getSessionStatus(args: GetSessionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionStatusCommandOutput) => void): void;
|
|
337
232
|
/**
|
|
338
|
-
* @
|
|
339
|
-
* <p>Returns table metadata for the specified catalog, database, and table.</p>
|
|
233
|
+
* @see {@link GetTableMetadataCommand}
|
|
340
234
|
*/
|
|
341
235
|
getTableMetadata(args: GetTableMetadataCommandInput, options?: __HttpHandlerOptions): Promise<GetTableMetadataCommandOutput>;
|
|
342
236
|
getTableMetadata(args: GetTableMetadataCommandInput, cb: (err: any, data?: GetTableMetadataCommandOutput) => void): void;
|
|
343
237
|
getTableMetadata(args: GetTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableMetadataCommandOutput) => void): void;
|
|
344
238
|
/**
|
|
345
|
-
* @
|
|
346
|
-
* <p>Returns information about the workgroup with the specified name.</p>
|
|
239
|
+
* @see {@link GetWorkGroupCommand}
|
|
347
240
|
*/
|
|
348
241
|
getWorkGroup(args: GetWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkGroupCommandOutput>;
|
|
349
242
|
getWorkGroup(args: GetWorkGroupCommandInput, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void;
|
|
350
243
|
getWorkGroup(args: GetWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void;
|
|
351
244
|
/**
|
|
352
|
-
* @
|
|
353
|
-
* <p>Imports a single <code>ipynb</code> file to a Spark enabled workgroup. The maximum
|
|
354
|
-
* file size that can be imported is 10 megabytes. If an <code>ipynb</code> file with the
|
|
355
|
-
* same name already exists in the workgroup, throws an error.</p>
|
|
245
|
+
* @see {@link ImportNotebookCommand}
|
|
356
246
|
*/
|
|
357
247
|
importNotebook(args: ImportNotebookCommandInput, options?: __HttpHandlerOptions): Promise<ImportNotebookCommandOutput>;
|
|
358
248
|
importNotebook(args: ImportNotebookCommandInput, cb: (err: any, data?: ImportNotebookCommandOutput) => void): void;
|
|
359
249
|
importNotebook(args: ImportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportNotebookCommandOutput) => void): void;
|
|
360
250
|
/**
|
|
361
|
-
* @
|
|
362
|
-
* <p>Returns the supported DPU sizes for the supported application runtimes (for example,
|
|
363
|
-
* <code>Athena notebook version 1</code>). </p>
|
|
251
|
+
* @see {@link ListApplicationDPUSizesCommand}
|
|
364
252
|
*/
|
|
365
253
|
listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, options?: __HttpHandlerOptions): Promise<ListApplicationDPUSizesCommandOutput>;
|
|
366
254
|
listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void): void;
|
|
367
255
|
listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void): void;
|
|
368
256
|
/**
|
|
369
|
-
* @
|
|
370
|
-
* <p>Lists the calculations that have been submitted to a session in descending order.
|
|
371
|
-
* Newer calculations are listed first; older calculations are listed later.</p>
|
|
257
|
+
* @see {@link ListCalculationExecutionsCommand}
|
|
372
258
|
*/
|
|
373
259
|
listCalculationExecutions(args: ListCalculationExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCalculationExecutionsCommandOutput>;
|
|
374
260
|
listCalculationExecutions(args: ListCalculationExecutionsCommandInput, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void): void;
|
|
375
261
|
listCalculationExecutions(args: ListCalculationExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void): void;
|
|
376
262
|
/**
|
|
377
|
-
* @
|
|
378
|
-
* <p>Lists the databases in the specified data catalog.</p>
|
|
263
|
+
* @see {@link ListDatabasesCommand}
|
|
379
264
|
*/
|
|
380
265
|
listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise<ListDatabasesCommandOutput>;
|
|
381
266
|
listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
|
|
382
267
|
listDatabases(args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
|
|
383
268
|
/**
|
|
384
|
-
* @
|
|
385
|
-
* <p>Lists the data catalogs in the current Amazon Web Services account.</p>
|
|
386
|
-
* <note>
|
|
387
|
-
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
388
|
-
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
389
|
-
* </note>
|
|
269
|
+
* @see {@link ListDataCatalogsCommand}
|
|
390
270
|
*/
|
|
391
271
|
listDataCatalogs(args: ListDataCatalogsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataCatalogsCommandOutput>;
|
|
392
272
|
listDataCatalogs(args: ListDataCatalogsCommandInput, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void): void;
|
|
393
273
|
listDataCatalogs(args: ListDataCatalogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void): void;
|
|
394
274
|
/**
|
|
395
|
-
* @
|
|
396
|
-
* <p>Returns a list of engine versions that are available to choose from, including the
|
|
397
|
-
* Auto option.</p>
|
|
275
|
+
* @see {@link ListEngineVersionsCommand}
|
|
398
276
|
*/
|
|
399
277
|
listEngineVersions(args: ListEngineVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListEngineVersionsCommandOutput>;
|
|
400
278
|
listEngineVersions(args: ListEngineVersionsCommandInput, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void): void;
|
|
401
279
|
listEngineVersions(args: ListEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void): void;
|
|
402
280
|
/**
|
|
403
|
-
* @
|
|
404
|
-
* <p>Lists, in descending order, the executors that joined a session. Newer executors are
|
|
405
|
-
* listed first; older executors are listed later. The result can be optionally filtered by
|
|
406
|
-
* state.</p>
|
|
281
|
+
* @see {@link ListExecutorsCommand}
|
|
407
282
|
*/
|
|
408
283
|
listExecutors(args: ListExecutorsCommandInput, options?: __HttpHandlerOptions): Promise<ListExecutorsCommandOutput>;
|
|
409
284
|
listExecutors(args: ListExecutorsCommandInput, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void;
|
|
410
285
|
listExecutors(args: ListExecutorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void;
|
|
411
286
|
/**
|
|
412
|
-
* @
|
|
413
|
-
* <p>Provides a list of available query IDs only for queries saved in the specified
|
|
414
|
-
* workgroup. Requires that you have access to the specified workgroup. If a workgroup is
|
|
415
|
-
* not specified, lists the saved queries for the primary workgroup.</p>
|
|
416
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
417
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
418
|
-
* Guide</i>.</p>
|
|
287
|
+
* @see {@link ListNamedQueriesCommand}
|
|
419
288
|
*/
|
|
420
289
|
listNamedQueries(args: ListNamedQueriesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamedQueriesCommandOutput>;
|
|
421
290
|
listNamedQueries(args: ListNamedQueriesCommandInput, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void): void;
|
|
422
291
|
listNamedQueries(args: ListNamedQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void): void;
|
|
423
292
|
/**
|
|
424
|
-
* @
|
|
425
|
-
* <p>Displays the notebook files for the specified workgroup in paginated format.</p>
|
|
293
|
+
* @see {@link ListNotebookMetadataCommand}
|
|
426
294
|
*/
|
|
427
295
|
listNotebookMetadata(args: ListNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<ListNotebookMetadataCommandOutput>;
|
|
428
296
|
listNotebookMetadata(args: ListNotebookMetadataCommandInput, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void): void;
|
|
429
297
|
listNotebookMetadata(args: ListNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void): void;
|
|
430
298
|
/**
|
|
431
|
-
* @
|
|
432
|
-
* <p>Lists, in descending order, the sessions that have been created in a notebook that are
|
|
433
|
-
* in an active state like <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>
|
|
434
|
-
* or <code>BUSY</code>. Newer sessions are listed first; older sessions are listed
|
|
435
|
-
* later.</p>
|
|
299
|
+
* @see {@link ListNotebookSessionsCommand}
|
|
436
300
|
*/
|
|
437
301
|
listNotebookSessions(args: ListNotebookSessionsCommandInput, options?: __HttpHandlerOptions): Promise<ListNotebookSessionsCommandOutput>;
|
|
438
302
|
listNotebookSessions(args: ListNotebookSessionsCommandInput, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void): void;
|
|
439
303
|
listNotebookSessions(args: ListNotebookSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void): void;
|
|
440
304
|
/**
|
|
441
|
-
* @
|
|
442
|
-
* <p>Lists the prepared statements in the specified workgroup.</p>
|
|
305
|
+
* @see {@link ListPreparedStatementsCommand}
|
|
443
306
|
*/
|
|
444
307
|
listPreparedStatements(args: ListPreparedStatementsCommandInput, options?: __HttpHandlerOptions): Promise<ListPreparedStatementsCommandOutput>;
|
|
445
308
|
listPreparedStatements(args: ListPreparedStatementsCommandInput, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void): void;
|
|
446
309
|
listPreparedStatements(args: ListPreparedStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void): void;
|
|
447
310
|
/**
|
|
448
|
-
* @
|
|
449
|
-
* <p>Provides a list of available query execution IDs for the queries in the specified
|
|
450
|
-
* workgroup. If a workgroup is not specified, returns a list of query execution IDs for
|
|
451
|
-
* the primary workgroup. Requires you to have access to the workgroup in which the queries
|
|
452
|
-
* ran.</p>
|
|
453
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
454
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
455
|
-
* Guide</i>.</p>
|
|
311
|
+
* @see {@link ListQueryExecutionsCommand}
|
|
456
312
|
*/
|
|
457
313
|
listQueryExecutions(args: ListQueryExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListQueryExecutionsCommandOutput>;
|
|
458
314
|
listQueryExecutions(args: ListQueryExecutionsCommandInput, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void): void;
|
|
459
315
|
listQueryExecutions(args: ListQueryExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void): void;
|
|
460
316
|
/**
|
|
461
|
-
* @
|
|
462
|
-
* <p>Lists the sessions in a workgroup that are in an active state like
|
|
463
|
-
* <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>, or
|
|
464
|
-
* <code>BUSY</code>. Newer sessions are listed first; older sessions are listed
|
|
465
|
-
* later.</p>
|
|
317
|
+
* @see {@link ListSessionsCommand}
|
|
466
318
|
*/
|
|
467
319
|
listSessions(args: ListSessionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSessionsCommandOutput>;
|
|
468
320
|
listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void;
|
|
469
321
|
listSessions(args: ListSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSessionsCommandOutput) => void): void;
|
|
470
322
|
/**
|
|
471
|
-
* @
|
|
472
|
-
* <p>Lists the metadata for the tables in the specified data catalog database.</p>
|
|
323
|
+
* @see {@link ListTableMetadataCommand}
|
|
473
324
|
*/
|
|
474
325
|
listTableMetadata(args: ListTableMetadataCommandInput, options?: __HttpHandlerOptions): Promise<ListTableMetadataCommandOutput>;
|
|
475
326
|
listTableMetadata(args: ListTableMetadataCommandInput, cb: (err: any, data?: ListTableMetadataCommandOutput) => void): void;
|
|
476
327
|
listTableMetadata(args: ListTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableMetadataCommandOutput) => void): void;
|
|
477
328
|
/**
|
|
478
|
-
* @
|
|
479
|
-
* <p>Lists the tags associated with an Athena workgroup or data catalog
|
|
480
|
-
* resource.</p>
|
|
329
|
+
* @see {@link ListTagsForResourceCommand}
|
|
481
330
|
*/
|
|
482
331
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
483
332
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
484
333
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
485
334
|
/**
|
|
486
|
-
* @
|
|
487
|
-
* <p>Lists available workgroups for the account.</p>
|
|
335
|
+
* @see {@link ListWorkGroupsCommand}
|
|
488
336
|
*/
|
|
489
337
|
listWorkGroups(args: ListWorkGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkGroupsCommandOutput>;
|
|
490
338
|
listWorkGroups(args: ListWorkGroupsCommandInput, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void): void;
|
|
491
339
|
listWorkGroups(args: ListWorkGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void): void;
|
|
492
340
|
/**
|
|
493
|
-
* @
|
|
494
|
-
* <p>Submits calculations for execution within a session. You can supply the code to run as
|
|
495
|
-
* an inline code block within the request.</p>
|
|
341
|
+
* @see {@link StartCalculationExecutionCommand}
|
|
496
342
|
*/
|
|
497
343
|
startCalculationExecution(args: StartCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartCalculationExecutionCommandOutput>;
|
|
498
344
|
startCalculationExecution(args: StartCalculationExecutionCommandInput, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void): void;
|
|
499
345
|
startCalculationExecution(args: StartCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void): void;
|
|
500
346
|
/**
|
|
501
|
-
* @
|
|
502
|
-
* <p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to
|
|
503
|
-
* have access to the workgroup in which the query ran. Running queries against an external
|
|
504
|
-
* catalog requires <a>GetDataCatalog</a> permission to the catalog. For code
|
|
505
|
-
* samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
506
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
507
|
-
* Guide</i>.</p>
|
|
347
|
+
* @see {@link StartQueryExecutionCommand}
|
|
508
348
|
*/
|
|
509
349
|
startQueryExecution(args: StartQueryExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartQueryExecutionCommandOutput>;
|
|
510
350
|
startQueryExecution(args: StartQueryExecutionCommandInput, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void): void;
|
|
511
351
|
startQueryExecution(args: StartQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void): void;
|
|
512
352
|
/**
|
|
513
|
-
* @
|
|
514
|
-
* <p>Creates a session for running calculations within a workgroup. The session is ready
|
|
515
|
-
* when it reaches an <code>IDLE</code> state.</p>
|
|
353
|
+
* @see {@link StartSessionCommand}
|
|
516
354
|
*/
|
|
517
355
|
startSession(args: StartSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartSessionCommandOutput>;
|
|
518
356
|
startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void;
|
|
519
357
|
startSession(args: StartSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSessionCommandOutput) => void): void;
|
|
520
358
|
/**
|
|
521
|
-
* @
|
|
522
|
-
* <p>Requests the cancellation of a calculation. A <code>StopCalculationExecution</code>
|
|
523
|
-
* call on a calculation that is already in a terminal state (for example,
|
|
524
|
-
* <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but
|
|
525
|
-
* has no effect.</p>
|
|
526
|
-
* <note>
|
|
527
|
-
* <p>Cancelling a calculation is done on a best effort basis. If a calculation cannot
|
|
528
|
-
* be cancelled, you can be charged for its completion. If you are concerned about
|
|
529
|
-
* being charged for a calculation that cannot be cancelled, consider terminating the
|
|
530
|
-
* session in which the calculation is running.</p>
|
|
531
|
-
* </note>
|
|
359
|
+
* @see {@link StopCalculationExecutionCommand}
|
|
532
360
|
*/
|
|
533
361
|
stopCalculationExecution(args: StopCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StopCalculationExecutionCommandOutput>;
|
|
534
362
|
stopCalculationExecution(args: StopCalculationExecutionCommandInput, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void): void;
|
|
535
363
|
stopCalculationExecution(args: StopCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void): void;
|
|
536
364
|
/**
|
|
537
|
-
* @
|
|
538
|
-
* <p>Stops a query execution. Requires you to have access to the workgroup in which the
|
|
539
|
-
* query ran.</p>
|
|
540
|
-
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
541
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
542
|
-
* Guide</i>.</p>
|
|
365
|
+
* @see {@link StopQueryExecutionCommand}
|
|
543
366
|
*/
|
|
544
367
|
stopQueryExecution(args: StopQueryExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StopQueryExecutionCommandOutput>;
|
|
545
368
|
stopQueryExecution(args: StopQueryExecutionCommandInput, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void): void;
|
|
546
369
|
stopQueryExecution(args: StopQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void): void;
|
|
547
370
|
/**
|
|
548
|
-
* @
|
|
549
|
-
* <p>Adds one or more tags to an Athena resource. A tag is a label that you
|
|
550
|
-
* assign to a resource. In Athena, a resource can be a workgroup or data
|
|
551
|
-
* catalog. Each tag consists of a key and an optional value, both of which you define. For
|
|
552
|
-
* example, you can use tags to categorize Athena workgroups or data catalogs
|
|
553
|
-
* by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
|
|
554
|
-
* search and filter workgroups or data catalogs in your account. For best practices, see
|
|
555
|
-
* <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode
|
|
556
|
-
* characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use
|
|
557
|
-
* letters and numbers representable in UTF-8, and the following characters: + - = . _ : /
|
|
558
|
-
* @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you
|
|
559
|
-
* specify more than one tag, separate them by commas.</p>
|
|
371
|
+
* @see {@link TagResourceCommand}
|
|
560
372
|
*/
|
|
561
373
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
562
374
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
563
375
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
564
376
|
/**
|
|
565
|
-
* @
|
|
566
|
-
* <p>Terminates an active session. A <code>TerminateSession</code> call on a session that
|
|
567
|
-
* is already inactive (for example, in a <code>FAILED</code>, <code>TERMINATED</code> or
|
|
568
|
-
* <code>TERMINATING</code> state) succeeds but has no effect. Calculations running in
|
|
569
|
-
* the session when <code>TerminateSession</code> is called are forcefully stopped, but may
|
|
570
|
-
* display as <code>FAILED</code> instead of <code>STOPPED</code>.</p>
|
|
377
|
+
* @see {@link TerminateSessionCommand}
|
|
571
378
|
*/
|
|
572
379
|
terminateSession(args: TerminateSessionCommandInput, options?: __HttpHandlerOptions): Promise<TerminateSessionCommandOutput>;
|
|
573
380
|
terminateSession(args: TerminateSessionCommandInput, cb: (err: any, data?: TerminateSessionCommandOutput) => void): void;
|
|
574
381
|
terminateSession(args: TerminateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateSessionCommandOutput) => void): void;
|
|
575
382
|
/**
|
|
576
|
-
* @
|
|
577
|
-
* <p>Removes one or more tags from a data catalog or workgroup resource.</p>
|
|
383
|
+
* @see {@link UntagResourceCommand}
|
|
578
384
|
*/
|
|
579
385
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
580
386
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
581
387
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
582
388
|
/**
|
|
583
|
-
* @
|
|
584
|
-
* <p>Updates the data catalog that has the specified name.</p>
|
|
389
|
+
* @see {@link UpdateDataCatalogCommand}
|
|
585
390
|
*/
|
|
586
391
|
updateDataCatalog(args: UpdateDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataCatalogCommandOutput>;
|
|
587
392
|
updateDataCatalog(args: UpdateDataCatalogCommandInput, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void): void;
|
|
588
393
|
updateDataCatalog(args: UpdateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void): void;
|
|
589
394
|
/**
|
|
590
|
-
* @
|
|
591
|
-
* <p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be
|
|
592
|
-
* updated.</p>
|
|
395
|
+
* @see {@link UpdateNamedQueryCommand}
|
|
593
396
|
*/
|
|
594
397
|
updateNamedQuery(args: UpdateNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNamedQueryCommandOutput>;
|
|
595
398
|
updateNamedQuery(args: UpdateNamedQueryCommandInput, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void): void;
|
|
596
399
|
updateNamedQuery(args: UpdateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void): void;
|
|
597
400
|
/**
|
|
598
|
-
* @
|
|
599
|
-
* <p>Updates the contents of a Spark notebook.</p>
|
|
401
|
+
* @see {@link UpdateNotebookCommand}
|
|
600
402
|
*/
|
|
601
403
|
updateNotebook(args: UpdateNotebookCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotebookCommandOutput>;
|
|
602
404
|
updateNotebook(args: UpdateNotebookCommandInput, cb: (err: any, data?: UpdateNotebookCommandOutput) => void): void;
|
|
603
405
|
updateNotebook(args: UpdateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookCommandOutput) => void): void;
|
|
604
406
|
/**
|
|
605
|
-
* @
|
|
606
|
-
* <p>Updates the metadata for a notebook.</p>
|
|
407
|
+
* @see {@link UpdateNotebookMetadataCommand}
|
|
607
408
|
*/
|
|
608
409
|
updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotebookMetadataCommandOutput>;
|
|
609
410
|
updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void): void;
|
|
610
411
|
updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void): void;
|
|
611
412
|
/**
|
|
612
|
-
* @
|
|
613
|
-
* <p>Updates a prepared statement.</p>
|
|
413
|
+
* @see {@link UpdatePreparedStatementCommand}
|
|
614
414
|
*/
|
|
615
415
|
updatePreparedStatement(args: UpdatePreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePreparedStatementCommandOutput>;
|
|
616
416
|
updatePreparedStatement(args: UpdatePreparedStatementCommandInput, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void): void;
|
|
617
417
|
updatePreparedStatement(args: UpdatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void): void;
|
|
618
418
|
/**
|
|
619
|
-
* @
|
|
620
|
-
* <p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.
|
|
621
|
-
* Only <code>ConfigurationUpdates</code> can be specified.</p>
|
|
419
|
+
* @see {@link UpdateWorkGroupCommand}
|
|
622
420
|
*/
|
|
623
421
|
updateWorkGroup(args: UpdateWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkGroupCommandOutput>;
|
|
624
422
|
updateWorkGroup(args: UpdateWorkGroupCommandInput, cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void): void;
|
|
625
423
|
updateWorkGroup(args: UpdateWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void): void;
|
|
626
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* @public
|
|
427
|
+
* <p>Amazon Athena is an interactive query service that lets you use standard SQL
|
|
428
|
+
* to analyze data directly in Amazon S3. You can point Athena at your
|
|
429
|
+
* data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay
|
|
430
|
+
* only for the queries you run. Athena scales automatically—executing queries
|
|
431
|
+
* in parallel—so results are fast, even with large datasets and complex queries. For more
|
|
432
|
+
* information, see <a href="http://docs.aws.amazon.com/athena/latest/ug/what-is.html">What is Amazon Athena</a> in the <i>Amazon Athena User
|
|
433
|
+
* Guide</i>.</p>
|
|
434
|
+
* <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
|
|
435
|
+
* driver or later with the Amazon Athena API. Earlier version drivers do not
|
|
436
|
+
* support the API. For more information and to download the driver, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html">Accessing
|
|
437
|
+
* Amazon Athena with JDBC</a>.</p>
|
|
438
|
+
* <p>For code samples using the Amazon Web Services SDK for Java, see <a href="https://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
|
|
439
|
+
* Code Samples</a> in the <i>Amazon Athena User
|
|
440
|
+
* Guide</i>.</p>
|
|
441
|
+
*/
|
|
442
|
+
export declare class Athena extends AthenaClient implements Athena {
|
|
443
|
+
}
|