@aws-sdk/client-athena 3.936.0 → 3.938.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 +16 -0
- package/dist-cjs/index.js +143 -28
- package/dist-es/Athena.js +4 -0
- package/dist-es/commands/GetResourceDashboardCommand.js +16 -0
- package/dist-es/commands/GetSessionEndpointCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +117 -28
- package/dist-types/Athena.d.ts +14 -0
- package/dist-types/AthenaClient.d.ts +4 -2
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +1 -0
- package/dist-types/commands/CreateWorkGroupCommand.d.ts +40 -0
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +1 -0
- package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetResourceDashboardCommand.d.ts +85 -0
- package/dist-types/commands/GetSessionCommand.d.ts +31 -1
- package/dist-types/commands/GetSessionEndpointCommand.d.ts +87 -0
- package/dist-types/commands/GetWorkGroupCommand.d.ts +40 -0
- package/dist-types/commands/StartQueryExecutionCommand.d.ts +19 -0
- package/dist-types/commands/StartSessionCommand.d.ts +38 -1
- package/dist-types/commands/UpdateWorkGroupCommand.d.ts +40 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +271 -40
- package/dist-types/schemas/schemas_0.d.ts +15 -1
- package/dist-types/ts3.4/Athena.d.ts +34 -0
- package/dist-types/ts3.4/AthenaClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetResourceDashboardCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSessionEndpointCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +58 -7
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +15 -0
- package/package.json +1 -1
|
@@ -49,7 +49,7 @@ declare const GetSessionCommand_base: {
|
|
|
49
49
|
* // EngineVersion: "STRING_VALUE",
|
|
50
50
|
* // EngineConfiguration: { // EngineConfiguration
|
|
51
51
|
* // CoordinatorDpuSize: Number("int"),
|
|
52
|
-
* // MaxConcurrentDpus: Number("int"),
|
|
52
|
+
* // MaxConcurrentDpus: Number("int"),
|
|
53
53
|
* // DefaultExecutorDpuSize: Number("int"),
|
|
54
54
|
* // AdditionalConfigs: { // ParametersMap
|
|
55
55
|
* // "<keys>": "STRING_VALUE",
|
|
@@ -57,12 +57,42 @@ declare const GetSessionCommand_base: {
|
|
|
57
57
|
* // SparkProperties: {
|
|
58
58
|
* // "<keys>": "STRING_VALUE",
|
|
59
59
|
* // },
|
|
60
|
+
* // Classifications: [ // ClassificationList
|
|
61
|
+
* // { // Classification
|
|
62
|
+
* // Name: "STRING_VALUE",
|
|
63
|
+
* // Properties: {
|
|
64
|
+
* // "<keys>": "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
60
68
|
* // },
|
|
61
69
|
* // NotebookVersion: "STRING_VALUE",
|
|
70
|
+
* // MonitoringConfiguration: { // MonitoringConfiguration
|
|
71
|
+
* // CloudWatchLoggingConfiguration: { // CloudWatchLoggingConfiguration
|
|
72
|
+
* // Enabled: true || false, // required
|
|
73
|
+
* // LogGroup: "STRING_VALUE",
|
|
74
|
+
* // LogStreamNamePrefix: "STRING_VALUE",
|
|
75
|
+
* // LogTypes: { // LogTypesMap
|
|
76
|
+
* // "<keys>": [ // LogTypeValuesList
|
|
77
|
+
* // "STRING_VALUE",
|
|
78
|
+
* // ],
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // ManagedLoggingConfiguration: { // ManagedLoggingConfiguration
|
|
82
|
+
* // Enabled: true || false, // required
|
|
83
|
+
* // KmsKey: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // S3LoggingConfiguration: { // S3LoggingConfiguration
|
|
86
|
+
* // Enabled: true || false, // required
|
|
87
|
+
* // KmsKey: "STRING_VALUE",
|
|
88
|
+
* // LogLocation: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
62
91
|
* // SessionConfiguration: { // SessionConfiguration
|
|
63
92
|
* // ExecutionRole: "STRING_VALUE",
|
|
64
93
|
* // WorkingDirectory: "STRING_VALUE",
|
|
65
94
|
* // IdleTimeoutSeconds: Number("long"),
|
|
95
|
+
* // SessionIdleTimeoutInMinutes: Number("int"),
|
|
66
96
|
* // EncryptionConfiguration: { // EncryptionConfiguration
|
|
67
97
|
* // EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
|
|
68
98
|
* // KmsKey: "STRING_VALUE",
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
|
|
4
|
+
import { GetSessionEndpointRequest, GetSessionEndpointResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSessionEndpointCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSessionEndpointCommandInput extends GetSessionEndpointRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSessionEndpointCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSessionEndpointCommandOutput extends GetSessionEndpointResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetSessionEndpointCommand_base: {
|
|
25
|
+
new (input: GetSessionEndpointCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionEndpointCommandInput, GetSessionEndpointCommandOutput, AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetSessionEndpointCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionEndpointCommandInput, GetSessionEndpointCommandOutput, AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets a connection endpoint and authentication token for a given session Id.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AthenaClient, GetSessionEndpointCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
35
|
+
* // const { AthenaClient, GetSessionEndpointCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
36
|
+
* // import type { AthenaClientConfig } from "@aws-sdk/client-athena";
|
|
37
|
+
* const config = {}; // type is AthenaClientConfig
|
|
38
|
+
* const client = new AthenaClient(config);
|
|
39
|
+
* const input = { // GetSessionEndpointRequest
|
|
40
|
+
* SessionId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetSessionEndpointCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetSessionEndpointResponse
|
|
45
|
+
* // EndpointUrl: "STRING_VALUE", // required
|
|
46
|
+
* // AuthToken: "STRING_VALUE", // required
|
|
47
|
+
* // AuthTokenExpirationTime: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param GetSessionEndpointCommandInput - {@link GetSessionEndpointCommandInput}
|
|
53
|
+
* @returns {@link GetSessionEndpointCommandOutput}
|
|
54
|
+
* @see {@link GetSessionEndpointCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link GetSessionEndpointCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerException} (server fault)
|
|
59
|
+
* <p>Indicates a platform issue, which may be due to a transient condition or
|
|
60
|
+
* outage.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
63
|
+
* <p>Indicates that something is wrong with the input to the request. For example, a
|
|
64
|
+
* required parameter may be missing or out of range.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>A resource, such as a workgroup, was not found.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AthenaServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Athena service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class GetSessionEndpointCommand extends GetSessionEndpointCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: GetSessionEndpointRequest;
|
|
80
|
+
output: GetSessionEndpointResponse;
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: GetSessionEndpointCommandInput;
|
|
84
|
+
output: GetSessionEndpointCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -73,6 +73,46 @@ declare const GetWorkGroupCommand_base: {
|
|
|
73
73
|
* // },
|
|
74
74
|
* // AdditionalConfiguration: "STRING_VALUE",
|
|
75
75
|
* // ExecutionRole: "STRING_VALUE",
|
|
76
|
+
* // MonitoringConfiguration: { // MonitoringConfiguration
|
|
77
|
+
* // CloudWatchLoggingConfiguration: { // CloudWatchLoggingConfiguration
|
|
78
|
+
* // Enabled: true || false, // required
|
|
79
|
+
* // LogGroup: "STRING_VALUE",
|
|
80
|
+
* // LogStreamNamePrefix: "STRING_VALUE",
|
|
81
|
+
* // LogTypes: { // LogTypesMap
|
|
82
|
+
* // "<keys>": [ // LogTypeValuesList
|
|
83
|
+
* // "STRING_VALUE",
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // },
|
|
87
|
+
* // ManagedLoggingConfiguration: { // ManagedLoggingConfiguration
|
|
88
|
+
* // Enabled: true || false, // required
|
|
89
|
+
* // KmsKey: "STRING_VALUE",
|
|
90
|
+
* // },
|
|
91
|
+
* // S3LoggingConfiguration: { // S3LoggingConfiguration
|
|
92
|
+
* // Enabled: true || false, // required
|
|
93
|
+
* // KmsKey: "STRING_VALUE",
|
|
94
|
+
* // LogLocation: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
97
|
+
* // EngineConfiguration: { // EngineConfiguration
|
|
98
|
+
* // CoordinatorDpuSize: Number("int"),
|
|
99
|
+
* // MaxConcurrentDpus: Number("int"),
|
|
100
|
+
* // DefaultExecutorDpuSize: Number("int"),
|
|
101
|
+
* // AdditionalConfigs: { // ParametersMap
|
|
102
|
+
* // "<keys>": "STRING_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // SparkProperties: {
|
|
105
|
+
* // "<keys>": "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // Classifications: [ // ClassificationList
|
|
108
|
+
* // { // Classification
|
|
109
|
+
* // Name: "STRING_VALUE",
|
|
110
|
+
* // Properties: {
|
|
111
|
+
* // "<keys>": "STRING_VALUE",
|
|
112
|
+
* // },
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // },
|
|
76
116
|
* // CustomerContentEncryptionConfiguration: { // CustomerContentEncryptionConfiguration
|
|
77
117
|
* // KmsKey: "STRING_VALUE", // required
|
|
78
118
|
* // },
|
|
@@ -69,6 +69,25 @@ declare const StartQueryExecutionCommand_base: {
|
|
|
69
69
|
* MaxAgeInMinutes: Number("int"),
|
|
70
70
|
* },
|
|
71
71
|
* },
|
|
72
|
+
* EngineConfiguration: { // EngineConfiguration
|
|
73
|
+
* CoordinatorDpuSize: Number("int"),
|
|
74
|
+
* MaxConcurrentDpus: Number("int"),
|
|
75
|
+
* DefaultExecutorDpuSize: Number("int"),
|
|
76
|
+
* AdditionalConfigs: { // ParametersMap
|
|
77
|
+
* "<keys>": "STRING_VALUE",
|
|
78
|
+
* },
|
|
79
|
+
* SparkProperties: {
|
|
80
|
+
* "<keys>": "STRING_VALUE",
|
|
81
|
+
* },
|
|
82
|
+
* Classifications: [ // ClassificationList
|
|
83
|
+
* { // Classification
|
|
84
|
+
* Name: "STRING_VALUE",
|
|
85
|
+
* Properties: {
|
|
86
|
+
* "<keys>": "STRING_VALUE",
|
|
87
|
+
* },
|
|
88
|
+
* },
|
|
89
|
+
* ],
|
|
90
|
+
* },
|
|
72
91
|
* };
|
|
73
92
|
* const command = new StartQueryExecutionCommand(input);
|
|
74
93
|
* const response = await client.send(command);
|
|
@@ -42,7 +42,7 @@ declare const StartSessionCommand_base: {
|
|
|
42
42
|
* WorkGroup: "STRING_VALUE", // required
|
|
43
43
|
* EngineConfiguration: { // EngineConfiguration
|
|
44
44
|
* CoordinatorDpuSize: Number("int"),
|
|
45
|
-
* MaxConcurrentDpus: Number("int"),
|
|
45
|
+
* MaxConcurrentDpus: Number("int"),
|
|
46
46
|
* DefaultExecutorDpuSize: Number("int"),
|
|
47
47
|
* AdditionalConfigs: { // ParametersMap
|
|
48
48
|
* "<keys>": "STRING_VALUE",
|
|
@@ -50,10 +50,47 @@ declare const StartSessionCommand_base: {
|
|
|
50
50
|
* SparkProperties: {
|
|
51
51
|
* "<keys>": "STRING_VALUE",
|
|
52
52
|
* },
|
|
53
|
+
* Classifications: [ // ClassificationList
|
|
54
|
+
* { // Classification
|
|
55
|
+
* Name: "STRING_VALUE",
|
|
56
|
+
* Properties: {
|
|
57
|
+
* "<keys>": "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* ExecutionRole: "STRING_VALUE",
|
|
63
|
+
* MonitoringConfiguration: { // MonitoringConfiguration
|
|
64
|
+
* CloudWatchLoggingConfiguration: { // CloudWatchLoggingConfiguration
|
|
65
|
+
* Enabled: true || false, // required
|
|
66
|
+
* LogGroup: "STRING_VALUE",
|
|
67
|
+
* LogStreamNamePrefix: "STRING_VALUE",
|
|
68
|
+
* LogTypes: { // LogTypesMap
|
|
69
|
+
* "<keys>": [ // LogTypeValuesList
|
|
70
|
+
* "STRING_VALUE",
|
|
71
|
+
* ],
|
|
72
|
+
* },
|
|
73
|
+
* },
|
|
74
|
+
* ManagedLoggingConfiguration: { // ManagedLoggingConfiguration
|
|
75
|
+
* Enabled: true || false, // required
|
|
76
|
+
* KmsKey: "STRING_VALUE",
|
|
77
|
+
* },
|
|
78
|
+
* S3LoggingConfiguration: { // S3LoggingConfiguration
|
|
79
|
+
* Enabled: true || false, // required
|
|
80
|
+
* KmsKey: "STRING_VALUE",
|
|
81
|
+
* LogLocation: "STRING_VALUE",
|
|
82
|
+
* },
|
|
53
83
|
* },
|
|
54
84
|
* NotebookVersion: "STRING_VALUE",
|
|
55
85
|
* SessionIdleTimeoutInMinutes: Number("int"),
|
|
56
86
|
* ClientRequestToken: "STRING_VALUE",
|
|
87
|
+
* Tags: [ // TagList
|
|
88
|
+
* { // Tag
|
|
89
|
+
* Key: "STRING_VALUE",
|
|
90
|
+
* Value: "STRING_VALUE",
|
|
91
|
+
* },
|
|
92
|
+
* ],
|
|
93
|
+
* CopyWorkGroupTags: true || false,
|
|
57
94
|
* };
|
|
58
95
|
* const command = new StartSessionCommand(input);
|
|
59
96
|
* const response = await client.send(command);
|
|
@@ -84,6 +84,46 @@ declare const UpdateWorkGroupCommand_base: {
|
|
|
84
84
|
* CreateUserLevelPrefix: true || false,
|
|
85
85
|
* AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
86
86
|
* },
|
|
87
|
+
* MonitoringConfiguration: { // MonitoringConfiguration
|
|
88
|
+
* CloudWatchLoggingConfiguration: { // CloudWatchLoggingConfiguration
|
|
89
|
+
* Enabled: true || false, // required
|
|
90
|
+
* LogGroup: "STRING_VALUE",
|
|
91
|
+
* LogStreamNamePrefix: "STRING_VALUE",
|
|
92
|
+
* LogTypes: { // LogTypesMap
|
|
93
|
+
* "<keys>": [ // LogTypeValuesList
|
|
94
|
+
* "STRING_VALUE",
|
|
95
|
+
* ],
|
|
96
|
+
* },
|
|
97
|
+
* },
|
|
98
|
+
* ManagedLoggingConfiguration: { // ManagedLoggingConfiguration
|
|
99
|
+
* Enabled: true || false, // required
|
|
100
|
+
* KmsKey: "STRING_VALUE",
|
|
101
|
+
* },
|
|
102
|
+
* S3LoggingConfiguration: { // S3LoggingConfiguration
|
|
103
|
+
* Enabled: true || false, // required
|
|
104
|
+
* KmsKey: "STRING_VALUE",
|
|
105
|
+
* LogLocation: "STRING_VALUE",
|
|
106
|
+
* },
|
|
107
|
+
* },
|
|
108
|
+
* EngineConfiguration: { // EngineConfiguration
|
|
109
|
+
* CoordinatorDpuSize: Number("int"),
|
|
110
|
+
* MaxConcurrentDpus: Number("int"),
|
|
111
|
+
* DefaultExecutorDpuSize: Number("int"),
|
|
112
|
+
* AdditionalConfigs: { // ParametersMap
|
|
113
|
+
* "<keys>": "STRING_VALUE",
|
|
114
|
+
* },
|
|
115
|
+
* SparkProperties: {
|
|
116
|
+
* "<keys>": "STRING_VALUE",
|
|
117
|
+
* },
|
|
118
|
+
* Classifications: [ // ClassificationList
|
|
119
|
+
* { // Classification
|
|
120
|
+
* Name: "STRING_VALUE",
|
|
121
|
+
* Properties: {
|
|
122
|
+
* "<keys>": "STRING_VALUE",
|
|
123
|
+
* },
|
|
124
|
+
* },
|
|
125
|
+
* ],
|
|
126
|
+
* },
|
|
87
127
|
* },
|
|
88
128
|
* State: "ENABLED" || "DISABLED",
|
|
89
129
|
* };
|
|
@@ -29,7 +29,9 @@ export * from "./GetPreparedStatementCommand";
|
|
|
29
29
|
export * from "./GetQueryExecutionCommand";
|
|
30
30
|
export * from "./GetQueryResultsCommand";
|
|
31
31
|
export * from "./GetQueryRuntimeStatisticsCommand";
|
|
32
|
+
export * from "./GetResourceDashboardCommand";
|
|
32
33
|
export * from "./GetSessionCommand";
|
|
34
|
+
export * from "./GetSessionEndpointCommand";
|
|
33
35
|
export * from "./GetSessionStatusCommand";
|
|
34
36
|
export * from "./GetTableMetadataCommand";
|
|
35
37
|
export * from "./GetWorkGroupCommand";
|