@aws-sdk/client-athena 3.231.0 → 3.235.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 (19) hide show
  1. package/dist-cjs/endpoint/ruleset.js +4 -315
  2. package/dist-cjs/protocols/Aws_json1_1.js +6 -0
  3. package/dist-es/endpoint/ruleset.js +4 -315
  4. package/dist-es/protocols/Aws_json1_1.js +6 -0
  5. package/dist-types/Athena.d.ts +17 -15
  6. package/dist-types/AthenaClient.d.ts +2 -2
  7. package/dist-types/commands/CreateNamedQueryCommand.d.ts +1 -1
  8. package/dist-types/commands/DeleteNamedQueryCommand.d.ts +1 -1
  9. package/dist-types/commands/GetQueryResultsCommand.d.ts +3 -3
  10. package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +5 -3
  11. package/dist-types/commands/ListNamedQueriesCommand.d.ts +1 -1
  12. package/dist-types/commands/ListQueryExecutionsCommand.d.ts +1 -1
  13. package/dist-types/commands/StopCalculationExecutionCommand.d.ts +2 -2
  14. package/dist-types/commands/StopQueryExecutionCommand.d.ts +1 -1
  15. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  16. package/dist-types/models/models_0.d.ts +153 -153
  17. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  18. package/dist-types/ts3.4/models/models_0.d.ts +2 -2
  19. package/package.json +8 -8
package/dist-es/protocols/Aws_json1_1.js CHANGED
@@ -1160,6 +1160,9 @@ const deserializeAws_json1_1GetCalculationExecutionCodeCommandError = async (out
1160
1160
  case "InternalServerException":
1161
1161
  case "com.amazonaws.athena#InternalServerException":
1162
1162
  throw await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context);
1163
+ case "InvalidRequestException":
1164
+ case "com.amazonaws.athena#InvalidRequestException":
1165
+ throw await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context);
1163
1166
  case "ResourceNotFoundException":
1164
1167
  case "com.amazonaws.athena#ResourceNotFoundException":
1165
1168
  throw await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context);
@@ -2417,6 +2420,9 @@ const deserializeAws_json1_1StopCalculationExecutionCommandError = async (output
2417
2420
  case "InternalServerException":
2418
2421
  case "com.amazonaws.athena#InternalServerException":
2419
2422
  throw await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context);
2423
+ case "InvalidRequestException":
2424
+ case "com.amazonaws.athena#InvalidRequestException":
2425
+ throw await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context);
2420
2426
  case "ResourceNotFoundException":
2421
2427
  case "com.amazonaws.athena#ResourceNotFoundException":
2422
2428
  throw await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context);
package/dist-types/Athena.d.ts CHANGED
@@ -68,11 +68,11 @@ import { UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput } from "./com
68
68
  * in parallel—so results are fast, even with large datasets and complex queries. For more
69
69
  * 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
70
70
  * Guide</i>.</p>
71
- * <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
71
+ * <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
72
72
  * driver or later with the Amazon Athena API. Earlier version drivers do not
73
73
  * 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
74
74
  * Amazon Athena with JDBC</a>.</p>
75
- * <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
75
+ * <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
76
76
  * Code Samples</a> in the <i>Amazon Athena User
77
77
  * Guide</i>.</p>
78
78
  */
@@ -122,7 +122,7 @@ export declare class Athena extends AthenaClient {
122
122
  /**
123
123
  * <p>Creates a named query in the specified workgroup. Requires that you have access to the
124
124
  * workgroup.</p>
125
- * <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
125
+ * <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
126
126
  * Code Samples</a> in the <i>Amazon Athena User
127
127
  * Guide</i>.</p>
128
128
  */
@@ -169,7 +169,7 @@ export declare class Athena extends AthenaClient {
169
169
  /**
170
170
  * <p>Deletes the named query if you have access to the workgroup in which the query was
171
171
  * saved.</p>
172
- * <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
172
+ * <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
173
173
  * Code Samples</a> in the <i>Amazon Athena User
174
174
  * Guide</i>.</p>
175
175
  */
@@ -266,26 +266,28 @@ export declare class Athena extends AthenaClient {
266
266
  * <code>QueryExecutionId</code> from the Athena query results location in
267
267
  * 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
268
268
  * but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
269
- * <p>To stream query results successfully, the IAM principal with permission to call
269
+ * <p>To stream query results successfully, the IAM principal with permission to call
270
270
  * <code>GetQueryResults</code> also must have permissions to the Amazon S3
271
271
  * <code>GetObject</code> action for the Athena query results location.</p>
272
- * <important>
272
+ * <important>
273
273
  * <p>IAM principals with permission to the Amazon S3
274
274
  * <code>GetObject</code> action for the query results location are able to retrieve
275
275
  * query results from Amazon S3 even if permission to the
276
276
  * <code>GetQueryResults</code> action is denied. To restrict user or role access,
277
277
  * ensure that Amazon S3 permissions to the Athena query location
278
278
  * are denied.</p>
279
- * </important>
279
+ * </important>
280
280
  */
281
281
  getQueryResults(args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryResultsCommandOutput>;
282
282
  getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
283
283
  getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
284
284
  /**
285
285
  * <p>Returns query execution runtime statistics related to a single execution of a query if
286
- * you have access to the workgroup in which the query ran. The query execution runtime
287
- * statistics is returned only when <a>QueryExecutionStatus$State</a> is in a
288
- * SUCCEEDED or FAILED state.</p>
286
+ * you have access to the workgroup in which the query ran. Query execution runtime
287
+ * statistics are returned only when <a>QueryExecutionStatus$State</a> is in a
288
+ * SUCCEEDED or FAILED state. Stage-level input and output row count and data size
289
+ * statistics are not shown when a query has row-level filters defined in Lake
290
+ * Formation.</p>
289
291
  */
290
292
  getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryRuntimeStatisticsCommandOutput>;
291
293
  getQueryRuntimeStatistics(args: GetQueryRuntimeStatisticsCommandInput, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void): void;
@@ -368,7 +370,7 @@ export declare class Athena extends AthenaClient {
368
370
  * <p>Provides a list of available query IDs only for queries saved in the specified
369
371
  * workgroup. Requires that you have access to the specified workgroup. If a workgroup is
370
372
  * not specified, lists the saved queries for the primary workgroup.</p>
371
- * <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
373
+ * <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
372
374
  * Code Samples</a> in the <i>Amazon Athena User
373
375
  * Guide</i>.</p>
374
376
  */
@@ -401,7 +403,7 @@ export declare class Athena extends AthenaClient {
401
403
  * workgroup. If a workgroup is not specified, returns a list of query execution IDs for
402
404
  * the primary workgroup. Requires you to have access to the workgroup in which the queries
403
405
  * ran.</p>
404
- * <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
406
+ * <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
405
407
  * Code Samples</a> in the <i>Amazon Athena User
406
408
  * Guide</i>.</p>
407
409
  */
@@ -466,12 +468,12 @@ export declare class Athena extends AthenaClient {
466
468
  * call on a calculation that is already in a terminal state (for example,
467
469
  * <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but
468
470
  * has no effect.</p>
469
- * <note>
471
+ * <note>
470
472
  * <p>Cancelling a calculation is done on a best effort basis. If a calculation cannot
471
473
  * be cancelled, you can be charged for its completion. If you are concerned about
472
474
  * being charged for a calculation that cannot be cancelled, consider terminating the
473
475
  * session in which the calculation is running.</p>
474
- * </note>
476
+ * </note>
475
477
  */
476
478
  stopCalculationExecution(args: StopCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StopCalculationExecutionCommandOutput>;
477
479
  stopCalculationExecution(args: StopCalculationExecutionCommandInput, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void): void;
@@ -479,7 +481,7 @@ export declare class Athena extends AthenaClient {
479
481
  /**
480
482
  * <p>Stops a query execution. Requires you to have access to the workgroup in which the
481
483
  * query ran.</p>
482
- * <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
484
+ * <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
483
485
  * Code Samples</a> in the <i>Amazon Athena User
484
486
  * Guide</i>.</p>
485
487
  */
package/dist-types/AthenaClient.d.ts CHANGED
@@ -190,11 +190,11 @@ export interface AthenaClientResolvedConfig extends AthenaClientResolvedConfigTy
190
190
  * in parallel—so results are fast, even with large datasets and complex queries. For more
191
191
  * 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
192
192
  * Guide</i>.</p>
193
- * <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
193
+ * <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the
194
194
  * driver or later with the Amazon Athena API. Earlier version drivers do not
195
195
  * 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
196
196
  * Amazon Athena with JDBC</a>.</p>
197
- * <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
197
+ * <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
198
198
  * Code Samples</a> in the <i>Amazon Athena User
199
199
  * Guide</i>.</p>
200
200
  */
package/dist-types/commands/CreateNamedQueryCommand.d.ts CHANGED
@@ -10,7 +10,7 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
10
10
  /**
11
11
  * <p>Creates a named query in the specified workgroup. Requires that you have access to the
12
12
  * workgroup.</p>
13
- * <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
13
+ * <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
14
14
  * Code Samples</a> in the <i>Amazon Athena User
15
15
  * Guide</i>.</p>
16
16
  * @example
package/dist-types/commands/DeleteNamedQueryCommand.d.ts CHANGED
@@ -10,7 +10,7 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
10
10
  /**
11
11
  * <p>Deletes the named query if you have access to the workgroup in which the query was
12
12
  * saved.</p>
13
- * <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
13
+ * <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
14
14
  * Code Samples</a> in the <i>Amazon Athena User
15
15
  * Guide</i>.</p>
16
16
  * @example
package/dist-types/commands/GetQueryResultsCommand.d.ts CHANGED
@@ -12,17 +12,17 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M
12
12
  * <code>QueryExecutionId</code> from the Athena query results location in
13
13
  * 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
14
14
  * but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
15
- * <p>To stream query results successfully, the IAM principal with permission to call
15
+ * <p>To stream query results successfully, the IAM principal with permission to call
16
16
  * <code>GetQueryResults</code> also must have permissions to the Amazon S3
17
17
  * <code>GetObject</code> action for the Athena query results location.</p>
18
- * <important>
18
+ * <important>
19
19
  * <p>IAM principals with permission to the Amazon S3
20
20
  * <code>GetObject</code> action for the query results location are able to retrieve
21
21
  * query results from Amazon S3 even if permission to the
22
22
  * <code>GetQueryResults</code> action is denied. To restrict user or role access,
23
23
  * ensure that Amazon S3 permissions to the Athena query location
24
24
  * are denied.</p>
25
- * </important>
25
+ * </important>
26
26
  * @example
27
27
  * Use a bare-bones client and the command you need to make an API call.
28
28
  * ```javascript
package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts CHANGED
@@ -9,9 +9,11 @@ export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeS
9
9
  }
10
10
  /**
11
11
  * <p>Returns query execution runtime statistics related to a single execution of a query if
12
- * you have access to the workgroup in which the query ran. The query execution runtime
13
- * statistics is returned only when <a>QueryExecutionStatus$State</a> is in a
14
- * SUCCEEDED or FAILED state.</p>
12
+ * you have access to the workgroup in which the query ran. Query execution runtime
13
+ * statistics are returned only when <a>QueryExecutionStatus$State</a> is in a
14
+ * SUCCEEDED or FAILED state. Stage-level input and output row count and data size
15
+ * statistics are not shown when a query has row-level filters defined in Lake
16
+ * Formation.</p>
15
17
  * @example
16
18
  * Use a bare-bones client and the command you need to make an API call.
17
19
  * ```javascript
package/dist-types/commands/ListNamedQueriesCommand.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _
11
11
  * <p>Provides a list of available query IDs only for queries saved in the specified
12
12
  * workgroup. Requires that you have access to the specified workgroup. If a workgroup is
13
13
  * not specified, lists the saved queries for the primary workgroup.</p>
14
- * <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
14
+ * <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
15
15
  * Code Samples</a> in the <i>Amazon Athena User
16
16
  * Guide</i>.</p>
17
17
  * @example
package/dist-types/commands/ListQueryExecutionsCommand.d.ts CHANGED
@@ -12,7 +12,7 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
12
12
  * workgroup. If a workgroup is not specified, returns a list of query execution IDs for
13
13
  * the primary workgroup. Requires you to have access to the workgroup in which the queries
14
14
  * ran.</p>
15
- * <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
15
+ * <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
16
16
  * Code Samples</a> in the <i>Amazon Athena User
17
17
  * Guide</i>.</p>
18
18
  * @example
package/dist-types/commands/StopCalculationExecutionCommand.d.ts CHANGED
@@ -12,12 +12,12 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
12
12
  * call on a calculation that is already in a terminal state (for example,
13
13
  * <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but
14
14
  * has no effect.</p>
15
- * <note>
15
+ * <note>
16
16
  * <p>Cancelling a calculation is done on a best effort basis. If a calculation cannot
17
17
  * be cancelled, you can be charged for its completion. If you are concerned about
18
18
  * being charged for a calculation that cannot be cancelled, consider terminating the
19
19
  * session in which the calculation is running.</p>
20
- * </note>
20
+ * </note>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
23
23
  * ```javascript
package/dist-types/commands/StopQueryExecutionCommand.d.ts CHANGED
@@ -10,7 +10,7 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
10
10
  /**
11
11
  * <p>Stops a query execution. Requires you to have access to the workgroup in which the
12
12
  * query ran.</p>
13
- * <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
13
+ * <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
14
14
  * Code Samples</a> in the <i>Amazon Athena User
15
15
  * Guide</i>.</p>
16
16
  * @example
package/dist-types/endpoint/EndpointParameters.d.ts CHANGED
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;