@aws-sdk/client-athena 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist-types/Athena.d.ts +61 -0
  2. package/dist-types/AthenaClient.d.ts +24 -4
  3. package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDataCatalogCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateNamedQueryCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateNotebookCommand.d.ts +16 -0
  9. package/dist-types/commands/CreatePreparedStatementCommand.d.ts +16 -0
  10. package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateWorkGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteDataCatalogCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteNamedQueryCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteNotebookCommand.d.ts +16 -0
  15. package/dist-types/commands/DeletePreparedStatementCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteWorkGroupCommand.d.ts +16 -0
  17. package/dist-types/commands/ExportNotebookCommand.d.ts +16 -0
  18. package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +16 -0
  19. package/dist-types/commands/GetCalculationExecutionCommand.d.ts +16 -0
  20. package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +16 -0
  21. package/dist-types/commands/GetDataCatalogCommand.d.ts +16 -0
  22. package/dist-types/commands/GetDatabaseCommand.d.ts +16 -0
  23. package/dist-types/commands/GetNamedQueryCommand.d.ts +16 -0
  24. package/dist-types/commands/GetNotebookMetadataCommand.d.ts +16 -0
  25. package/dist-types/commands/GetPreparedStatementCommand.d.ts +16 -0
  26. package/dist-types/commands/GetQueryExecutionCommand.d.ts +16 -0
  27. package/dist-types/commands/GetQueryResultsCommand.d.ts +16 -0
  28. package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +16 -0
  29. package/dist-types/commands/GetSessionCommand.d.ts +16 -0
  30. package/dist-types/commands/GetSessionStatusCommand.d.ts +16 -0
  31. package/dist-types/commands/GetTableMetadataCommand.d.ts +16 -0
  32. package/dist-types/commands/GetWorkGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/ImportNotebookCommand.d.ts +16 -0
  34. package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +16 -0
  36. package/dist-types/commands/ListDataCatalogsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListDatabasesCommand.d.ts +16 -0
  38. package/dist-types/commands/ListEngineVersionsCommand.d.ts +16 -0
  39. package/dist-types/commands/ListExecutorsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListNamedQueriesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListNotebookMetadataCommand.d.ts +16 -0
  42. package/dist-types/commands/ListNotebookSessionsCommand.d.ts +16 -0
  43. package/dist-types/commands/ListPreparedStatementsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListQueryExecutionsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListSessionsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListTableMetadataCommand.d.ts +16 -0
  47. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/ListWorkGroupsCommand.d.ts +16 -0
  49. package/dist-types/commands/StartCalculationExecutionCommand.d.ts +16 -0
  50. package/dist-types/commands/StartQueryExecutionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartSessionCommand.d.ts +16 -0
  52. package/dist-types/commands/StopCalculationExecutionCommand.d.ts +16 -0
  53. package/dist-types/commands/StopQueryExecutionCommand.d.ts +16 -0
  54. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  55. package/dist-types/commands/TerminateSessionCommand.d.ts +16 -0
  56. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateDataCatalogCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdateNamedQueryCommand.d.ts +16 -0
  59. package/dist-types/commands/UpdateNotebookCommand.d.ts +16 -0
  60. package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +16 -0
  61. package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +16 -0
  62. package/dist-types/commands/UpdateWorkGroupCommand.d.ts +16 -0
  63. package/dist-types/models/AthenaServiceException.d.ts +2 -0
  64. package/dist-types/models/models_0.d.ts +456 -0
  65. package/dist-types/pagination/GetQueryResultsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/Interfaces.d.ts +3 -0
  67. package/dist-types/pagination/ListApplicationDPUSizesPaginator.d.ts +3 -0
  68. package/dist-types/pagination/ListCalculationExecutionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/ListDataCatalogsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDatabasesPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListEngineVersionsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExecutorsPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListNamedQueriesPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListPreparedStatementsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListQueryExecutionsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListSessionsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListTableMetadataPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListWorkGroupsPaginator.d.ts +3 -0
  80. package/package.json +29 -29
@@ -61,6 +61,7 @@ import { UpdateNotebookMetadataCommandInput, UpdateNotebookMetadataCommandOutput
61
61
  import { UpdatePreparedStatementCommandInput, UpdatePreparedStatementCommandOutput } from "./commands/UpdatePreparedStatementCommand";
62
62
  import { UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput } from "./commands/UpdateWorkGroupCommand";
63
63
  /**
64
+ * @public
64
65
  * <p>Amazon Athena is an interactive query service that lets you use standard SQL
65
66
  * to analyze data directly in Amazon S3. You can point Athena at your
66
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
@@ -78,6 +79,7 @@ import { UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput } from "./com
78
79
  */
79
80
  export declare class Athena extends AthenaClient {
80
81
  /**
82
+ * @public
81
83
  * <p>Returns the details of a single named query or a list of up to 50 queries, which you
82
84
  * provide as an array of query ID strings. Requires you to have access to the workgroup in
83
85
  * which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the
@@ -92,6 +94,7 @@ export declare class Athena extends AthenaClient {
92
94
  batchGetNamedQuery(args: BatchGetNamedQueryCommandInput, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void): void;
93
95
  batchGetNamedQuery(args: BatchGetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void): void;
94
96
  /**
97
+ * @public
95
98
  * <p>Returns the details of a single prepared statement or a list of up to 256 prepared
96
99
  * statements for the array of prepared statement names that you provide. Requires you to
97
100
  * have access to the workgroup to which the prepared statements belong. If a prepared
@@ -102,6 +105,7 @@ export declare class Athena extends AthenaClient {
102
105
  batchGetPreparedStatement(args: BatchGetPreparedStatementCommandInput, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void): void;
103
106
  batchGetPreparedStatement(args: BatchGetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void): void;
104
107
  /**
108
+ * @public
105
109
  * <p>Returns the details of a single query execution or a list of up to 50 query
106
110
  * executions, which you provide as an array of query execution ID strings. Requires you to
107
111
  * have access to the workgroup in which the queries ran. To get a list of query execution
@@ -113,6 +117,7 @@ export declare class Athena extends AthenaClient {
113
117
  batchGetQueryExecution(args: BatchGetQueryExecutionCommandInput, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void): void;
114
118
  batchGetQueryExecution(args: BatchGetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void): void;
115
119
  /**
120
+ * @public
116
121
  * <p>Creates (registers) a data catalog with the specified name and properties. Catalogs
117
122
  * created are visible to all users of the same Amazon Web Services account.</p>
118
123
  */
@@ -120,6 +125,7 @@ export declare class Athena extends AthenaClient {
120
125
  createDataCatalog(args: CreateDataCatalogCommandInput, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void): void;
121
126
  createDataCatalog(args: CreateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void): void;
122
127
  /**
128
+ * @public
123
129
  * <p>Creates a named query in the specified workgroup. Requires that you have access to the
124
130
  * workgroup.</p>
125
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
@@ -130,6 +136,7 @@ export declare class Athena extends AthenaClient {
130
136
  createNamedQuery(args: CreateNamedQueryCommandInput, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void): void;
131
137
  createNamedQuery(args: CreateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void): void;
132
138
  /**
139
+ * @public
133
140
  * <p>Creates an empty <code>ipynb</code> file in the specified Apache Spark enabled
134
141
  * workgroup. Throws an error if a file in the workgroup with the same name already
135
142
  * exists.</p>
@@ -138,12 +145,14 @@ export declare class Athena extends AthenaClient {
138
145
  createNotebook(args: CreateNotebookCommandInput, cb: (err: any, data?: CreateNotebookCommandOutput) => void): void;
139
146
  createNotebook(args: CreateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotebookCommandOutput) => void): void;
140
147
  /**
148
+ * @public
141
149
  * <p>Creates a prepared statement for use with SQL queries in Athena.</p>
142
150
  */
143
151
  createPreparedStatement(args: CreatePreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<CreatePreparedStatementCommandOutput>;
144
152
  createPreparedStatement(args: CreatePreparedStatementCommandInput, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void): void;
145
153
  createPreparedStatement(args: CreatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void): void;
146
154
  /**
155
+ * @public
147
156
  * <p>Gets an authentication token and the URL at which the notebook can be accessed. During
148
157
  * programmatic access, <code>CreatePresignedNotebookUrl</code> must be called every 10
149
158
  * minutes to refresh the authentication token.</p>
@@ -152,6 +161,7 @@ export declare class Athena extends AthenaClient {
152
161
  createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
153
162
  createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
154
163
  /**
164
+ * @public
155
165
  * <p>Creates a workgroup with the specified name. Only one of <code>Configurations</code>
156
166
  * or <code>Configuration</code> can be specified; <code>Configurations</code> for a
157
167
  * workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or
@@ -161,12 +171,14 @@ export declare class Athena extends AthenaClient {
161
171
  createWorkGroup(args: CreateWorkGroupCommandInput, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void;
162
172
  createWorkGroup(args: CreateWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void;
163
173
  /**
174
+ * @public
164
175
  * <p>Deletes a data catalog.</p>
165
176
  */
166
177
  deleteDataCatalog(args: DeleteDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataCatalogCommandOutput>;
167
178
  deleteDataCatalog(args: DeleteDataCatalogCommandInput, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void): void;
168
179
  deleteDataCatalog(args: DeleteDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void): void;
169
180
  /**
181
+ * @public
170
182
  * <p>Deletes the named query if you have access to the workgroup in which the query was
171
183
  * saved.</p>
172
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
@@ -177,12 +189,14 @@ export declare class Athena extends AthenaClient {
177
189
  deleteNamedQuery(args: DeleteNamedQueryCommandInput, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void): void;
178
190
  deleteNamedQuery(args: DeleteNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void): void;
179
191
  /**
192
+ * @public
180
193
  * <p>Deletes the specified notebook.</p>
181
194
  */
182
195
  deleteNotebook(args: DeleteNotebookCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNotebookCommandOutput>;
183
196
  deleteNotebook(args: DeleteNotebookCommandInput, cb: (err: any, data?: DeleteNotebookCommandOutput) => void): void;
184
197
  deleteNotebook(args: DeleteNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotebookCommandOutput) => void): void;
185
198
  /**
199
+ * @public
186
200
  * <p>Deletes the prepared statement with the specified name from the specified
187
201
  * workgroup.</p>
188
202
  */
@@ -190,6 +204,7 @@ export declare class Athena extends AthenaClient {
190
204
  deletePreparedStatement(args: DeletePreparedStatementCommandInput, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void): void;
191
205
  deletePreparedStatement(args: DeletePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void): void;
192
206
  /**
207
+ * @public
193
208
  * <p>Deletes the workgroup with the specified name. The primary workgroup cannot be
194
209
  * deleted.</p>
195
210
  */
@@ -197,18 +212,21 @@ export declare class Athena extends AthenaClient {
197
212
  deleteWorkGroup(args: DeleteWorkGroupCommandInput, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void): void;
198
213
  deleteWorkGroup(args: DeleteWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void): void;
199
214
  /**
215
+ * @public
200
216
  * <p>Exports the specified notebook and its metadata.</p>
201
217
  */
202
218
  exportNotebook(args: ExportNotebookCommandInput, options?: __HttpHandlerOptions): Promise<ExportNotebookCommandOutput>;
203
219
  exportNotebook(args: ExportNotebookCommandInput, cb: (err: any, data?: ExportNotebookCommandOutput) => void): void;
204
220
  exportNotebook(args: ExportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportNotebookCommandOutput) => void): void;
205
221
  /**
222
+ * @public
206
223
  * <p>Describes a previously submitted calculation execution.</p>
207
224
  */
208
225
  getCalculationExecution(args: GetCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionCommandOutput>;
209
226
  getCalculationExecution(args: GetCalculationExecutionCommandInput, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void): void;
210
227
  getCalculationExecution(args: GetCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void): void;
211
228
  /**
229
+ * @public
212
230
  * <p>Retrieves a pre-signed URL to a copy of the code that was executed for the
213
231
  * calculation.</p>
214
232
  */
@@ -216,24 +234,28 @@ export declare class Athena extends AthenaClient {
216
234
  getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void): void;
217
235
  getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void): void;
218
236
  /**
237
+ * @public
219
238
  * <p>Gets the status of a current calculation.</p>
220
239
  */
221
240
  getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionStatusCommandOutput>;
222
241
  getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void): void;
223
242
  getCalculationExecutionStatus(args: GetCalculationExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void): void;
224
243
  /**
244
+ * @public
225
245
  * <p>Returns a database object for the specified database and data catalog.</p>
226
246
  */
227
247
  getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<GetDatabaseCommandOutput>;
228
248
  getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void;
229
249
  getDatabase(args: GetDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void;
230
250
  /**
251
+ * @public
231
252
  * <p>Returns the specified data catalog.</p>
232
253
  */
233
254
  getDataCatalog(args: GetDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<GetDataCatalogCommandOutput>;
234
255
  getDataCatalog(args: GetDataCatalogCommandInput, cb: (err: any, data?: GetDataCatalogCommandOutput) => void): void;
235
256
  getDataCatalog(args: GetDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCatalogCommandOutput) => void): void;
236
257
  /**
258
+ * @public
237
259
  * <p>Returns information about a single query. Requires that you have access to the
238
260
  * workgroup in which the query was saved.</p>
239
261
  */
@@ -241,12 +263,14 @@ export declare class Athena extends AthenaClient {
241
263
  getNamedQuery(args: GetNamedQueryCommandInput, cb: (err: any, data?: GetNamedQueryCommandOutput) => void): void;
242
264
  getNamedQuery(args: GetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamedQueryCommandOutput) => void): void;
243
265
  /**
266
+ * @public
244
267
  * <p>Retrieves notebook metadata for the specified notebook ID.</p>
245
268
  */
246
269
  getNotebookMetadata(args: GetNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<GetNotebookMetadataCommandOutput>;
247
270
  getNotebookMetadata(args: GetNotebookMetadataCommandInput, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void): void;
248
271
  getNotebookMetadata(args: GetNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void): void;
249
272
  /**
273
+ * @public
250
274
  * <p>Retrieves the prepared statement with the specified name from the specified
251
275
  * workgroup.</p>
252
276
  */
@@ -254,6 +278,7 @@ export declare class Athena extends AthenaClient {
254
278
  getPreparedStatement(args: GetPreparedStatementCommandInput, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void): void;
255
279
  getPreparedStatement(args: GetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void): void;
256
280
  /**
281
+ * @public
257
282
  * <p>Returns information about a single execution of a query if you have access to the
258
283
  * workgroup in which the query ran. Each time a query executes, information about the
259
284
  * query execution is saved with a unique ID.</p>
@@ -262,6 +287,7 @@ export declare class Athena extends AthenaClient {
262
287
  getQueryExecution(args: GetQueryExecutionCommandInput, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void): void;
263
288
  getQueryExecution(args: GetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void): void;
264
289
  /**
290
+ * @public
265
291
  * <p>Streams the results of a single query execution specified by
266
292
  * <code>QueryExecutionId</code> from the Athena query results location in
267
293
  * Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query
@@ -282,6 +308,7 @@ export declare class Athena extends AthenaClient {
282
308
  getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
283
309
  getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
284
310
  /**
311
+ * @public
285
312
  * <p>Returns query execution runtime statistics related to a single execution of a query if
286
313
  * you have access to the workgroup in which the query ran. Query execution runtime
287
314
  * statistics are returned only when <a>QueryExecutionStatus$State</a> is in a
@@ -293,6 +320,7 @@ export declare class Athena extends AthenaClient {
293
320
  getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void): void;
294
321
  getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void): void;
295
322
  /**
323
+ * @public
296
324
  * <p>Gets the full details of a previously created session, including the session status
297
325
  * and configuration.</p>
298
326
  */
@@ -300,24 +328,28 @@ export declare class Athena extends AthenaClient {
300
328
  getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
301
329
  getSession(args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
302
330
  /**
331
+ * @public
303
332
  * <p>Gets the current status of a session.</p>
304
333
  */
305
334
  getSessionStatus(args: GetSessionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetSessionStatusCommandOutput>;
306
335
  getSessionStatus(args: GetSessionStatusCommandInput, cb: (err: any, data?: GetSessionStatusCommandOutput) => void): void;
307
336
  getSessionStatus(args: GetSessionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionStatusCommandOutput) => void): void;
308
337
  /**
338
+ * @public
309
339
  * <p>Returns table metadata for the specified catalog, database, and table.</p>
310
340
  */
311
341
  getTableMetadata(args: GetTableMetadataCommandInput, options?: __HttpHandlerOptions): Promise<GetTableMetadataCommandOutput>;
312
342
  getTableMetadata(args: GetTableMetadataCommandInput, cb: (err: any, data?: GetTableMetadataCommandOutput) => void): void;
313
343
  getTableMetadata(args: GetTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableMetadataCommandOutput) => void): void;
314
344
  /**
345
+ * @public
315
346
  * <p>Returns information about the workgroup with the specified name.</p>
316
347
  */
317
348
  getWorkGroup(args: GetWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkGroupCommandOutput>;
318
349
  getWorkGroup(args: GetWorkGroupCommandInput, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void;
319
350
  getWorkGroup(args: GetWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void;
320
351
  /**
352
+ * @public
321
353
  * <p>Imports a single <code>ipynb</code> file to a Spark enabled workgroup. The maximum
322
354
  * file size that can be imported is 10 megabytes. If an <code>ipynb</code> file with the
323
355
  * same name already exists in the workgroup, throws an error.</p>
@@ -326,6 +358,7 @@ export declare class Athena extends AthenaClient {
326
358
  importNotebook(args: ImportNotebookCommandInput, cb: (err: any, data?: ImportNotebookCommandOutput) => void): void;
327
359
  importNotebook(args: ImportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportNotebookCommandOutput) => void): void;
328
360
  /**
361
+ * @public
329
362
  * <p>Returns the supported DPU sizes for the supported application runtimes (for example,
330
363
  * <code>Jupyter 1.0</code>). </p>
331
364
  */
@@ -333,6 +366,7 @@ export declare class Athena extends AthenaClient {
333
366
  listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void): void;
334
367
  listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void): void;
335
368
  /**
369
+ * @public
336
370
  * <p>Lists the calculations that have been submitted to a session in descending order.
337
371
  * Newer calculations are listed first; older calculations are listed later.</p>
338
372
  */
@@ -340,12 +374,14 @@ export declare class Athena extends AthenaClient {
340
374
  listCalculationExecutions(args: ListCalculationExecutionsCommandInput, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void): void;
341
375
  listCalculationExecutions(args: ListCalculationExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void): void;
342
376
  /**
377
+ * @public
343
378
  * <p>Lists the databases in the specified data catalog.</p>
344
379
  */
345
380
  listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise<ListDatabasesCommandOutput>;
346
381
  listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
347
382
  listDatabases(args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
348
383
  /**
384
+ * @public
349
385
  * <p>Lists the data catalogs in the current Amazon Web Services account.</p>
350
386
  * <note>
351
387
  * <p>In the Athena console, data catalogs are listed as "data sources" on the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
@@ -355,6 +391,7 @@ export declare class Athena extends AthenaClient {
355
391
  listDataCatalogs(args: ListDataCatalogsCommandInput, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void): void;
356
392
  listDataCatalogs(args: ListDataCatalogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void): void;
357
393
  /**
394
+ * @public
358
395
  * <p>Returns a list of engine versions that are available to choose from, including the
359
396
  * Auto option.</p>
360
397
  */
@@ -362,6 +399,7 @@ export declare class Athena extends AthenaClient {
362
399
  listEngineVersions(args: ListEngineVersionsCommandInput, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void): void;
363
400
  listEngineVersions(args: ListEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void): void;
364
401
  /**
402
+ * @public
365
403
  * <p>Lists, in descending order, the executors that have been submitted to a session. Newer
366
404
  * executors are listed first; older executors are listed later. The result can be
367
405
  * optionally filtered by state.</p>
@@ -370,6 +408,7 @@ export declare class Athena extends AthenaClient {
370
408
  listExecutors(args: ListExecutorsCommandInput, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void;
371
409
  listExecutors(args: ListExecutorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void;
372
410
  /**
411
+ * @public
373
412
  * <p>Provides a list of available query IDs only for queries saved in the specified
374
413
  * workgroup. Requires that you have access to the specified workgroup. If a workgroup is
375
414
  * not specified, lists the saved queries for the primary workgroup.</p>
@@ -381,12 +420,14 @@ export declare class Athena extends AthenaClient {
381
420
  listNamedQueries(args: ListNamedQueriesCommandInput, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void): void;
382
421
  listNamedQueries(args: ListNamedQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void): void;
383
422
  /**
423
+ * @public
384
424
  * <p>Displays the notebook files for the specified workgroup in paginated format.</p>
385
425
  */
386
426
  listNotebookMetadata(args: ListNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<ListNotebookMetadataCommandOutput>;
387
427
  listNotebookMetadata(args: ListNotebookMetadataCommandInput, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void): void;
388
428
  listNotebookMetadata(args: ListNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void): void;
389
429
  /**
430
+ * @public
390
431
  * <p>Lists, in descending order, the sessions that have been created in a notebook that are
391
432
  * in an active state like <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>
392
433
  * or <code>BUSY</code>. Newer sessions are listed first; older sessions are listed
@@ -396,12 +437,14 @@ export declare class Athena extends AthenaClient {
396
437
  listNotebookSessions(args: ListNotebookSessionsCommandInput, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void): void;
397
438
  listNotebookSessions(args: ListNotebookSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void): void;
398
439
  /**
440
+ * @public
399
441
  * <p>Lists the prepared statements in the specified workgroup.</p>
400
442
  */
401
443
  listPreparedStatements(args: ListPreparedStatementsCommandInput, options?: __HttpHandlerOptions): Promise<ListPreparedStatementsCommandOutput>;
402
444
  listPreparedStatements(args: ListPreparedStatementsCommandInput, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void): void;
403
445
  listPreparedStatements(args: ListPreparedStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void): void;
404
446
  /**
447
+ * @public
405
448
  * <p>Provides a list of available query execution IDs for the queries in the specified
406
449
  * workgroup. If a workgroup is not specified, returns a list of query execution IDs for
407
450
  * the primary workgroup. Requires you to have access to the workgroup in which the queries
@@ -414,6 +457,7 @@ export declare class Athena extends AthenaClient {
414
457
  listQueryExecutions(args: ListQueryExecutionsCommandInput, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void): void;
415
458
  listQueryExecutions(args: ListQueryExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void): void;
416
459
  /**
460
+ * @public
417
461
  * <p>Lists the sessions in a workgroup that are in an active state like
418
462
  * <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>, or
419
463
  * <code>BUSY</code>. Newer sessions are listed first; older sessions are listed
@@ -423,12 +467,14 @@ export declare class Athena extends AthenaClient {
423
467
  listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void;
424
468
  listSessions(args: ListSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSessionsCommandOutput) => void): void;
425
469
  /**
470
+ * @public
426
471
  * <p>Lists the metadata for the tables in the specified data catalog database.</p>
427
472
  */
428
473
  listTableMetadata(args: ListTableMetadataCommandInput, options?: __HttpHandlerOptions): Promise<ListTableMetadataCommandOutput>;
429
474
  listTableMetadata(args: ListTableMetadataCommandInput, cb: (err: any, data?: ListTableMetadataCommandOutput) => void): void;
430
475
  listTableMetadata(args: ListTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableMetadataCommandOutput) => void): void;
431
476
  /**
477
+ * @public
432
478
  * <p>Lists the tags associated with an Athena workgroup or data catalog
433
479
  * resource.</p>
434
480
  */
@@ -436,12 +482,14 @@ export declare class Athena extends AthenaClient {
436
482
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
437
483
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
438
484
  /**
485
+ * @public
439
486
  * <p>Lists available workgroups for the account.</p>
440
487
  */
441
488
  listWorkGroups(args: ListWorkGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkGroupsCommandOutput>;
442
489
  listWorkGroups(args: ListWorkGroupsCommandInput, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void): void;
443
490
  listWorkGroups(args: ListWorkGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void): void;
444
491
  /**
492
+ * @public
445
493
  * <p>Submits calculations for execution within a session. You can supply the code to run as
446
494
  * an inline code block within the request or as an Amazon S3 URL.</p>
447
495
  */
@@ -449,6 +497,7 @@ export declare class Athena extends AthenaClient {
449
497
  startCalculationExecution(args: StartCalculationExecutionCommandInput, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void): void;
450
498
  startCalculationExecution(args: StartCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void): void;
451
499
  /**
500
+ * @public
452
501
  * <p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to
453
502
  * have access to the workgroup in which the query ran. Running queries against an external
454
503
  * catalog requires <a>GetDataCatalog</a> permission to the catalog. For code
@@ -460,6 +509,7 @@ export declare class Athena extends AthenaClient {
460
509
  startQueryExecution(args: StartQueryExecutionCommandInput, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void): void;
461
510
  startQueryExecution(args: StartQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void): void;
462
511
  /**
512
+ * @public
463
513
  * <p>Creates a session for running calculations within a workgroup. The session is ready
464
514
  * when it reaches an <code>IDLE</code> state.</p>
465
515
  */
@@ -467,6 +517,7 @@ export declare class Athena extends AthenaClient {
467
517
  startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void;
468
518
  startSession(args: StartSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSessionCommandOutput) => void): void;
469
519
  /**
520
+ * @public
470
521
  * <p>Requests the cancellation of a calculation. A <code>StopCalculationExecution</code>
471
522
  * call on a calculation that is already in a terminal state (for example,
472
523
  * <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but
@@ -482,6 +533,7 @@ export declare class Athena extends AthenaClient {
482
533
  stopCalculationExecution(args: StopCalculationExecutionCommandInput, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void): void;
483
534
  stopCalculationExecution(args: StopCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void): void;
484
535
  /**
536
+ * @public
485
537
  * <p>Stops a query execution. Requires you to have access to the workgroup in which the
486
538
  * query ran.</p>
487
539
  * <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
@@ -492,6 +544,7 @@ export declare class Athena extends AthenaClient {
492
544
  stopQueryExecution(args: StopQueryExecutionCommandInput, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void): void;
493
545
  stopQueryExecution(args: StopQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void): void;
494
546
  /**
547
+ * @public
495
548
  * <p>Adds one or more tags to an Athena resource. A tag is a label that you
496
549
  * assign to a resource. In Athena, a resource can be a workgroup or data
497
550
  * catalog. Each tag consists of a key and an optional value, both of which you define. For
@@ -508,6 +561,7 @@ export declare class Athena extends AthenaClient {
508
561
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
509
562
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
510
563
  /**
564
+ * @public
511
565
  * <p>Terminates an active session. A <code>TerminateSession</code> call on a session that
512
566
  * is already inactive (for example, in a <code>FAILED</code>, <code>TERMINATED</code> or
513
567
  * <code>TERMINATING</code> state) succeeds but has no effect. Calculations running in
@@ -518,18 +572,21 @@ export declare class Athena extends AthenaClient {
518
572
  terminateSession(args: TerminateSessionCommandInput, cb: (err: any, data?: TerminateSessionCommandOutput) => void): void;
519
573
  terminateSession(args: TerminateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateSessionCommandOutput) => void): void;
520
574
  /**
575
+ * @public
521
576
  * <p>Removes one or more tags from a data catalog or workgroup resource.</p>
522
577
  */
523
578
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
524
579
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
525
580
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
526
581
  /**
582
+ * @public
527
583
  * <p>Updates the data catalog that has the specified name.</p>
528
584
  */
529
585
  updateDataCatalog(args: UpdateDataCatalogCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataCatalogCommandOutput>;
530
586
  updateDataCatalog(args: UpdateDataCatalogCommandInput, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void): void;
531
587
  updateDataCatalog(args: UpdateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void): void;
532
588
  /**
589
+ * @public
533
590
  * <p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be
534
591
  * updated.</p>
535
592
  */
@@ -537,24 +594,28 @@ export declare class Athena extends AthenaClient {
537
594
  updateNamedQuery(args: UpdateNamedQueryCommandInput, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void): void;
538
595
  updateNamedQuery(args: UpdateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void): void;
539
596
  /**
597
+ * @public
540
598
  * <p>Updates the contents of a Spark notebook.</p>
541
599
  */
542
600
  updateNotebook(args: UpdateNotebookCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotebookCommandOutput>;
543
601
  updateNotebook(args: UpdateNotebookCommandInput, cb: (err: any, data?: UpdateNotebookCommandOutput) => void): void;
544
602
  updateNotebook(args: UpdateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookCommandOutput) => void): void;
545
603
  /**
604
+ * @public
546
605
  * <p>Updates the metadata for a notebook.</p>
547
606
  */
548
607
  updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotebookMetadataCommandOutput>;
549
608
  updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void): void;
550
609
  updateNotebookMetadata(args: UpdateNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void): void;
551
610
  /**
611
+ * @public
552
612
  * <p>Updates a prepared statement.</p>
553
613
  */
554
614
  updatePreparedStatement(args: UpdatePreparedStatementCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePreparedStatementCommandOutput>;
555
615
  updatePreparedStatement(args: UpdatePreparedStatementCommandInput, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void): void;
556
616
  updatePreparedStatement(args: UpdatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void): void;
557
617
  /**
618
+ * @public
558
619
  * <p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.
559
620
  * Only one of <code>ConfigurationsUpdates</code> or <code>ConfigurationUpdates</code> can
560
621
  * be specified; <code>ConfigurationsUpdates</code> for a workgroup with multi engine
@@ -68,15 +68,24 @@ import { UpdateNotebookMetadataCommandInput, UpdateNotebookMetadataCommandOutput
68
68
  import { UpdatePreparedStatementCommandInput, UpdatePreparedStatementCommandOutput } from "./commands/UpdatePreparedStatementCommand";
69
69
  import { UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput } from "./commands/UpdateWorkGroupCommand";
70
70
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
71
+ /**
72
+ * @public
73
+ */
71
74
  export type ServiceInputTypes = BatchGetNamedQueryCommandInput | BatchGetPreparedStatementCommandInput | BatchGetQueryExecutionCommandInput | CreateDataCatalogCommandInput | CreateNamedQueryCommandInput | CreateNotebookCommandInput | CreatePreparedStatementCommandInput | CreatePresignedNotebookUrlCommandInput | CreateWorkGroupCommandInput | DeleteDataCatalogCommandInput | DeleteNamedQueryCommandInput | DeleteNotebookCommandInput | DeletePreparedStatementCommandInput | DeleteWorkGroupCommandInput | ExportNotebookCommandInput | GetCalculationExecutionCodeCommandInput | GetCalculationExecutionCommandInput | GetCalculationExecutionStatusCommandInput | GetDataCatalogCommandInput | GetDatabaseCommandInput | GetNamedQueryCommandInput | GetNotebookMetadataCommandInput | GetPreparedStatementCommandInput | GetQueryExecutionCommandInput | GetQueryResultsCommandInput | GetQueryRuntimeStatisticsCommandInput | GetSessionCommandInput | GetSessionStatusCommandInput | GetTableMetadataCommandInput | GetWorkGroupCommandInput | ImportNotebookCommandInput | ListApplicationDPUSizesCommandInput | ListCalculationExecutionsCommandInput | ListDataCatalogsCommandInput | ListDatabasesCommandInput | ListEngineVersionsCommandInput | ListExecutorsCommandInput | ListNamedQueriesCommandInput | ListNotebookMetadataCommandInput | ListNotebookSessionsCommandInput | ListPreparedStatementsCommandInput | ListQueryExecutionsCommandInput | ListSessionsCommandInput | ListTableMetadataCommandInput | ListTagsForResourceCommandInput | ListWorkGroupsCommandInput | StartCalculationExecutionCommandInput | StartQueryExecutionCommandInput | StartSessionCommandInput | StopCalculationExecutionCommandInput | StopQueryExecutionCommandInput | TagResourceCommandInput | TerminateSessionCommandInput | UntagResourceCommandInput | UpdateDataCatalogCommandInput | UpdateNamedQueryCommandInput | UpdateNotebookCommandInput | UpdateNotebookMetadataCommandInput | UpdatePreparedStatementCommandInput | UpdateWorkGroupCommandInput;
75
+ /**
76
+ * @public
77
+ */
72
78
  export type ServiceOutputTypes = BatchGetNamedQueryCommandOutput | BatchGetPreparedStatementCommandOutput | BatchGetQueryExecutionCommandOutput | CreateDataCatalogCommandOutput | CreateNamedQueryCommandOutput | CreateNotebookCommandOutput | CreatePreparedStatementCommandOutput | CreatePresignedNotebookUrlCommandOutput | CreateWorkGroupCommandOutput | DeleteDataCatalogCommandOutput | DeleteNamedQueryCommandOutput | DeleteNotebookCommandOutput | DeletePreparedStatementCommandOutput | DeleteWorkGroupCommandOutput | ExportNotebookCommandOutput | GetCalculationExecutionCodeCommandOutput | GetCalculationExecutionCommandOutput | GetCalculationExecutionStatusCommandOutput | GetDataCatalogCommandOutput | GetDatabaseCommandOutput | GetNamedQueryCommandOutput | GetNotebookMetadataCommandOutput | GetPreparedStatementCommandOutput | GetQueryExecutionCommandOutput | GetQueryResultsCommandOutput | GetQueryRuntimeStatisticsCommandOutput | GetSessionCommandOutput | GetSessionStatusCommandOutput | GetTableMetadataCommandOutput | GetWorkGroupCommandOutput | ImportNotebookCommandOutput | ListApplicationDPUSizesCommandOutput | ListCalculationExecutionsCommandOutput | ListDataCatalogsCommandOutput | ListDatabasesCommandOutput | ListEngineVersionsCommandOutput | ListExecutorsCommandOutput | ListNamedQueriesCommandOutput | ListNotebookMetadataCommandOutput | ListNotebookSessionsCommandOutput | ListPreparedStatementsCommandOutput | ListQueryExecutionsCommandOutput | ListSessionsCommandOutput | ListTableMetadataCommandOutput | ListTagsForResourceCommandOutput | ListWorkGroupsCommandOutput | StartCalculationExecutionCommandOutput | StartQueryExecutionCommandOutput | StartSessionCommandOutput | StopCalculationExecutionCommandOutput | StopQueryExecutionCommandOutput | TagResourceCommandOutput | TerminateSessionCommandOutput | UntagResourceCommandOutput | UpdateDataCatalogCommandOutput | UpdateNamedQueryCommandOutput | UpdateNotebookCommandOutput | UpdateNotebookMetadataCommandOutput | UpdatePreparedStatementCommandOutput | UpdateWorkGroupCommandOutput;
79
+ /**
80
+ * @public
81
+ */
73
82
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
74
83
  /**
75
84
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
76
85
  */
77
86
  requestHandler?: __HttpHandler;
78
87
  /**
79
- * A constructor for a class implementing the {@link __Checksum} interface
88
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
80
89
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
81
90
  * @internal
82
91
  */
@@ -166,23 +175,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
166
175
  */
167
176
  logger?: __Logger;
168
177
  /**
169
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
178
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
170
179
  */
171
180
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
172
181
  }
182
+ /**
183
+ * @public
184
+ */
173
185
  type AthenaClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
174
186
  /**
175
- * The configuration interface of AthenaClient class constructor that set the region, credentials and other options.
187
+ * @public
188
+ *
189
+ * The configuration interface of AthenaClient class constructor that set the region, credentials and other options.
176
190
  */
177
191
  export interface AthenaClientConfig extends AthenaClientConfigType {
178
192
  }
193
+ /**
194
+ * @public
195
+ */
179
196
  type AthenaClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
180
197
  /**
181
- * The resolved configuration interface of AthenaClient class. This is resolved and normalized from the {@link AthenaClientConfig | constructor configuration interface}.
198
+ * @public
199
+ *
200
+ * The resolved configuration interface of AthenaClient class. This is resolved and normalized from the {@link AthenaClientConfig | constructor configuration interface}.
182
201
  */
183
202
  export interface AthenaClientResolvedConfig extends AthenaClientResolvedConfigType {
184
203
  }
185
204
  /**
205
+ * @public
186
206
  * <p>Amazon Athena is an interactive query service that lets you use standard SQL
187
207
  * to analyze data directly in Amazon S3. You can point Athena at your
188
208
  * 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
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { BatchGetNamedQueryInput, BatchGetNamedQueryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetNamedQueryCommand}.
8
10
  */
9
11
  export interface BatchGetNamedQueryCommandInput extends BatchGetNamedQueryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetNamedQueryCommand}.
13
17
  */
14
18
  export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the details of a single named query or a list of up to 50 queries, which you
18
23
  * provide as an array of query ID strings. Requires you to have access to the workgroup in
19
24
  * which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the
@@ -33,6 +38,8 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param BatchGetNamedQueryCommandInput - {@link BatchGetNamedQueryCommandInput}
42
+ * @returns {@link BatchGetNamedQueryCommandOutput}
36
43
  * @see {@link BatchGetNamedQueryCommandInput} for command's `input` shape.
37
44
  * @see {@link BatchGetNamedQueryCommandOutput} for command's `response` shape.
38
45
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu
50
57
  export declare class BatchGetNamedQueryCommand extends $Command<BatchGetNamedQueryCommandInput, BatchGetNamedQueryCommandOutput, AthenaClientResolvedConfig> {
51
58
  readonly input: BatchGetNamedQueryCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: BatchGetNamedQueryCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetNamedQueryCommandInput, BatchGetNamedQueryCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { BatchGetPreparedStatementInput, BatchGetPreparedStatementOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetPreparedStatementCommand}.
8
10
  */
9
11
  export interface BatchGetPreparedStatementCommandInput extends BatchGetPreparedStatementInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetPreparedStatementCommand}.
13
17
  */
14
18
  export interface BatchGetPreparedStatementCommandOutput extends BatchGetPreparedStatementOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the details of a single prepared statement or a list of up to 256 prepared
18
23
  * statements for the array of prepared statement names that you provide. Requires you to
19
24
  * have access to the workgroup to which the prepared statements belong. If a prepared
@@ -29,6 +34,8 @@ export interface BatchGetPreparedStatementCommandOutput extends BatchGetPrepared
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param BatchGetPreparedStatementCommandInput - {@link BatchGetPreparedStatementCommandInput}
38
+ * @returns {@link BatchGetPreparedStatementCommandOutput}
32
39
  * @see {@link BatchGetPreparedStatementCommandInput} for command's `input` shape.
33
40
  * @see {@link BatchGetPreparedStatementCommandOutput} for command's `response` shape.
34
41
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface BatchGetPreparedStatementCommandOutput extends BatchGetPrepared
46
53
  export declare class BatchGetPreparedStatementCommand extends $Command<BatchGetPreparedStatementCommandInput, BatchGetPreparedStatementCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: BatchGetPreparedStatementCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: BatchGetPreparedStatementCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetPreparedStatementCommandInput, BatchGetPreparedStatementCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }