@aws-sdk/client-athena 3.451.0 → 3.458.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/README.md +68 -71
- package/dist-types/Athena.d.ts +0 -3
- package/dist-types/AthenaClient.d.ts +0 -3
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +1 -0
- package/dist-types/commands/CancelCapacityReservationCommand.d.ts +4 -1
- package/dist-types/commands/CreateCapacityReservationCommand.d.ts +2 -1
- package/dist-types/commands/CreateNamedQueryCommand.d.ts +0 -3
- package/dist-types/commands/DeleteCapacityReservationCommand.d.ts +5 -1
- package/dist-types/commands/DeleteNamedQueryCommand.d.ts +0 -3
- package/dist-types/commands/GetCapacityAssignmentConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +1 -0
- package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +1 -0
- package/dist-types/commands/ListNamedQueriesCommand.d.ts +0 -3
- package/dist-types/commands/ListQueryExecutionsCommand.d.ts +1 -4
- package/dist-types/commands/PutCapacityAssignmentConfigurationCommand.d.ts +3 -1
- package/dist-types/commands/StartCalculationExecutionCommand.d.ts +7 -0
- package/dist-types/commands/StopQueryExecutionCommand.d.ts +0 -3
- package/dist-types/commands/TagResourceCommand.d.ts +10 -8
- package/dist-types/commands/UpdateCapacityReservationCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -3
- package/dist-types/models/models_0.d.ts +136 -100
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +3 -3
package/dist-types/Athena.d.ts
CHANGED
|
@@ -491,9 +491,6 @@ export interface Athena {
|
|
|
491
491
|
* driver or later with the Amazon Athena API. Earlier version drivers do not
|
|
492
492
|
* 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
|
|
493
493
|
* Amazon Athena with JDBC</a>.</p>
|
|
494
|
-
* <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
|
|
495
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
496
|
-
* Guide</i>.</p>
|
|
497
494
|
*/
|
|
498
495
|
export declare class Athena extends AthenaClient implements Athena {
|
|
499
496
|
}
|
|
@@ -231,9 +231,6 @@ export interface AthenaClientResolvedConfig extends AthenaClientResolvedConfigTy
|
|
|
231
231
|
* driver or later with the Amazon Athena API. Earlier version drivers do not
|
|
232
232
|
* 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
|
|
233
233
|
* Amazon Athena with JDBC</a>.</p>
|
|
234
|
-
* <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
|
|
235
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
236
|
-
* Guide</i>.</p>
|
|
237
234
|
*/
|
|
238
235
|
export declare class AthenaClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AthenaClientResolvedConfig> {
|
|
239
236
|
/**
|
|
@@ -87,6 +87,7 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
|
|
|
87
87
|
* // DataManifestLocation: "STRING_VALUE",
|
|
88
88
|
* // TotalExecutionTimeInMillis: Number("long"),
|
|
89
89
|
* // QueryQueueTimeInMillis: Number("long"),
|
|
90
|
+
* // ServicePreProcessingTimeInMillis: Number("long"),
|
|
90
91
|
* // QueryPlanningTimeInMillis: Number("long"),
|
|
91
92
|
* // ServiceProcessingTimeInMillis: Number("long"),
|
|
92
93
|
* // ResultReuseInformation: { // ResultReuseInformation
|
|
@@ -23,7 +23,10 @@ export interface CancelCapacityReservationCommandOutput extends CancelCapacityRe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Cancels the capacity reservation with the specified name. Cancelled reservations
|
|
26
|
+
* <p>Cancels the capacity reservation with the specified name. Cancelled reservations
|
|
27
|
+
* remain in your account and will be deleted 45 days after cancellation. During the 45
|
|
28
|
+
* days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can
|
|
29
|
+
* refer to its tags and view it for historical reference. </p>
|
|
27
30
|
* @example
|
|
28
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
32
|
* ```javascript
|
|
@@ -23,7 +23,8 @@ export interface CreateCapacityReservationCommandOutput extends CreateCapacityRe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a capacity reservation with the specified name and number of requested data
|
|
26
|
+
* <p>Creates a capacity reservation with the specified name and number of requested data
|
|
27
|
+
* processing units.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -25,9 +25,6 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a named query in the specified workgroup. Requires that you have access to the
|
|
27
27
|
* workgroup.</p>
|
|
28
|
-
* <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
|
|
29
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
30
|
-
* Guide</i>.</p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
30
|
* ```javascript
|
|
@@ -23,7 +23,11 @@ export interface DeleteCapacityReservationCommandOutput extends DeleteCapacityRe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes a cancelled capacity reservation. A reservation must be cancelled before it
|
|
26
|
+
* <p>Deletes a cancelled capacity reservation. A reservation must be cancelled before it
|
|
27
|
+
* can be deleted. A deleted reservation is immediately removed from your account and can
|
|
28
|
+
* no longer be referenced, including by its ARN. A deleted reservation cannot be called by
|
|
29
|
+
* <code>GetCapacityReservation</code>, and deleted reservations do not appear in the
|
|
30
|
+
* output of <code>ListCapacityReservations</code>.</p>
|
|
27
31
|
* @example
|
|
28
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
33
|
* ```javascript
|
|
@@ -25,9 +25,6 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes the named query if you have access to the workgroup in which the query was
|
|
27
27
|
* saved.</p>
|
|
28
|
-
* <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
|
|
29
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
30
|
-
* Guide</i>.</p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
30
|
* ```javascript
|
|
@@ -23,7 +23,8 @@ export interface GetCapacityAssignmentConfigurationCommandOutput extends GetCapa
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets the capacity assignment configuration for a capacity reservation, if one
|
|
26
|
+
* <p>Gets the capacity assignment configuration for a capacity reservation, if one
|
|
27
|
+
* exists.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -81,6 +81,7 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput,
|
|
|
81
81
|
* // DataManifestLocation: "STRING_VALUE",
|
|
82
82
|
* // TotalExecutionTimeInMillis: Number("long"),
|
|
83
83
|
* // QueryQueueTimeInMillis: Number("long"),
|
|
84
|
+
* // ServicePreProcessingTimeInMillis: Number("long"),
|
|
84
85
|
* // QueryPlanningTimeInMillis: Number("long"),
|
|
85
86
|
* // ServiceProcessingTimeInMillis: Number("long"),
|
|
86
87
|
* // ResultReuseInformation: { // ResultReuseInformation
|
|
@@ -44,6 +44,7 @@ export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeS
|
|
|
44
44
|
* // QueryRuntimeStatistics: { // QueryRuntimeStatistics
|
|
45
45
|
* // Timeline: { // QueryRuntimeStatisticsTimeline
|
|
46
46
|
* // QueryQueueTimeInMillis: Number("long"),
|
|
47
|
+
* // ServicePreProcessingTimeInMillis: Number("long"),
|
|
47
48
|
* // QueryPlanningTimeInMillis: Number("long"),
|
|
48
49
|
* // EngineExecutionTimeInMillis: Number("long"),
|
|
49
50
|
* // ServiceProcessingTimeInMillis: Number("long"),
|
|
@@ -26,9 +26,6 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _
|
|
|
26
26
|
* <p>Provides a list of available query IDs only for queries saved in the specified
|
|
27
27
|
* workgroup. Requires that you have access to the specified workgroup. If a workgroup is
|
|
28
28
|
* not specified, lists the saved queries for the primary workgroup.</p>
|
|
29
|
-
* <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
|
|
30
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
31
|
-
* Guide</i>.</p>
|
|
32
29
|
* @example
|
|
33
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
31
|
* ```javascript
|
|
@@ -24,12 +24,9 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Provides a list of available query execution IDs for the queries in the specified
|
|
27
|
-
* workgroup. If a workgroup is not specified, returns a list of query execution IDs for
|
|
27
|
+
* workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for
|
|
28
28
|
* the primary workgroup. Requires you to have access to the workgroup in which the queries
|
|
29
29
|
* ran.</p>
|
|
30
|
-
* <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
|
|
31
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
32
|
-
* Guide</i>.</p>
|
|
33
30
|
* @example
|
|
34
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
32
|
* ```javascript
|
|
@@ -23,7 +23,9 @@ export interface PutCapacityAssignmentConfigurationCommandOutput extends PutCapa
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Puts a new capacity assignment configuration for a specified capacity reservation. If
|
|
26
|
+
* <p>Puts a new capacity assignment configuration for a specified capacity reservation. If
|
|
27
|
+
* a capacity assignment configuration already exists for the capacity reservation,
|
|
28
|
+
* replaces the existing capacity assignment configuration.</p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -25,6 +25,13 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Submits calculations for execution within a session. You can supply the code to run as
|
|
27
27
|
* an inline code block within the request.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>The request syntax requires the
|
|
30
|
+
* <a>StartCalculationExecutionRequest$CodeBlock</a> parameter or the <a>CalculationConfiguration$CodeBlock</a>
|
|
31
|
+
* parameter, but not both. Because
|
|
32
|
+
* <a>CalculationConfiguration$CodeBlock</a> is deprecated, use the
|
|
33
|
+
* <a>StartCalculationExecutionRequest$CodeBlock</a> parameter instead.</p>
|
|
34
|
+
* </note>
|
|
28
35
|
* @example
|
|
29
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
37
|
* ```javascript
|
|
@@ -25,9 +25,6 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Stops a query execution. Requires you to have access to the workgroup in which the
|
|
27
27
|
* query ran.</p>
|
|
28
|
-
* <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
|
|
29
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
30
|
-
* Guide</i>.</p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
30
|
* ```javascript
|
|
@@ -24,14 +24,16 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds one or more tags to an Athena resource. A tag is a label that you
|
|
27
|
-
* assign to a resource. Each tag consists of a key and an optional value, both of which
|
|
28
|
-
* example, you can use tags to categorize Athena workgroups,
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
27
|
+
* assign to a resource. Each tag consists of a key and an optional value, both of which
|
|
28
|
+
* you define. For example, you can use tags to categorize Athena workgroups,
|
|
29
|
+
* data catalogs, or capacity reservations by purpose, owner, or environment. Use a
|
|
30
|
+
* consistent set of tag keys to make it easier to search and filter the resources in your
|
|
31
|
+
* account. For best practices, see <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging
|
|
32
|
+
* Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and
|
|
33
|
+
* tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and
|
|
34
|
+
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys
|
|
35
|
+
* and values are case-sensitive. Tag keys must be unique per resource. If you specify more
|
|
36
|
+
* than one tag, separate them by commas.</p>
|
|
35
37
|
* @example
|
|
36
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
39
|
* ```javascript
|
|
@@ -23,7 +23,8 @@ export interface UpdateCapacityReservationCommandOutput extends UpdateCapacityRe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates the number of requested data processing units for the capacity reservation
|
|
26
|
+
* <p>Updates the number of requested data processing units for the capacity reservation
|
|
27
|
+
* with the specified name.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -10,9 +10,6 @@
|
|
|
10
10
|
* driver or later with the Amazon Athena API. Earlier version drivers do not
|
|
11
11
|
* 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
|
|
12
12
|
* Amazon Athena with JDBC</a>.</p>
|
|
13
|
-
* <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
|
|
14
|
-
* Code Samples</a> in the <i>Amazon Athena User
|
|
15
|
-
* Guide</i>.</p>
|
|
16
13
|
*
|
|
17
14
|
* @packageDocumentation
|
|
18
15
|
*/
|