@aws-sdk/client-athena 3.299.0 → 3.301.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/protocols/Aws_json1_1.js +7 -0
- package/dist-es/protocols/Aws_json1_1.js +7 -0
- package/dist-types/Athena.d.ts +18 -20
- package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +5 -0
- package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +6 -0
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +5 -0
- package/dist-types/commands/CreateDataCatalogCommand.d.ts +14 -0
- package/dist-types/commands/CreateNamedQueryCommand.d.ts +8 -0
- package/dist-types/commands/CreateNotebookCommand.d.ts +5 -0
- package/dist-types/commands/CreatePreparedStatementCommand.d.ts +6 -0
- package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +6 -1
- package/dist-types/commands/CreateWorkGroupCommand.d.ts +39 -4
- package/dist-types/commands/DeleteDataCatalogCommand.d.ts +3 -0
- package/dist-types/commands/DeleteNamedQueryCommand.d.ts +3 -0
- package/dist-types/commands/DeleteNotebookCommand.d.ts +3 -0
- package/dist-types/commands/DeletePreparedStatementCommand.d.ts +4 -0
- package/dist-types/commands/DeleteWorkGroupCommand.d.ts +4 -0
- package/dist-types/commands/ExportNotebookCommand.d.ts +3 -0
- package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +4 -2
- package/dist-types/commands/GetCalculationExecutionCommand.d.ts +3 -0
- package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +3 -0
- package/dist-types/commands/GetDataCatalogCommand.d.ts +3 -0
- package/dist-types/commands/GetDatabaseCommand.d.ts +4 -0
- package/dist-types/commands/GetNamedQueryCommand.d.ts +3 -0
- package/dist-types/commands/GetNotebookMetadataCommand.d.ts +3 -0
- package/dist-types/commands/GetPreparedStatementCommand.d.ts +4 -0
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +3 -0
- package/dist-types/commands/GetQueryResultsCommand.d.ts +8 -2
- package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +3 -0
- package/dist-types/commands/GetSessionCommand.d.ts +3 -0
- package/dist-types/commands/GetSessionStatusCommand.d.ts +3 -0
- package/dist-types/commands/GetTableMetadataCommand.d.ts +5 -0
- package/dist-types/commands/GetWorkGroupCommand.d.ts +3 -0
- package/dist-types/commands/ImportNotebookCommand.d.ts +7 -0
- package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +5 -1
- package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +6 -0
- package/dist-types/commands/ListDataCatalogsCommand.d.ts +6 -1
- package/dist-types/commands/ListDatabasesCommand.d.ts +5 -0
- package/dist-types/commands/ListEngineVersionsCommand.d.ts +4 -0
- package/dist-types/commands/ListExecutorsCommand.d.ts +9 -3
- package/dist-types/commands/ListNamedQueriesCommand.d.ts +5 -0
- package/dist-types/commands/ListNotebookMetadataCommand.d.ts +8 -0
- package/dist-types/commands/ListNotebookSessionsCommand.d.ts +5 -0
- package/dist-types/commands/ListPreparedStatementsCommand.d.ts +5 -0
- package/dist-types/commands/ListQueryExecutionsCommand.d.ts +5 -0
- package/dist-types/commands/ListSessionsCommand.d.ts +6 -0
- package/dist-types/commands/ListTableMetadataCommand.d.ts +7 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -0
- package/dist-types/commands/ListWorkGroupsCommand.d.ts +4 -0
- package/dist-types/commands/StartCalculationExecutionCommand.d.ts +10 -1
- package/dist-types/commands/StartQueryExecutionCommand.d.ts +29 -0
- package/dist-types/commands/StartSessionCommand.d.ts +15 -0
- package/dist-types/commands/StopCalculationExecutionCommand.d.ts +3 -0
- package/dist-types/commands/StopQueryExecutionCommand.d.ts +3 -0
- package/dist-types/commands/TagResourceCommand.d.ts +10 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +3 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDataCatalogCommand.d.ts +8 -0
- package/dist-types/commands/UpdateNamedQueryCommand.d.ts +6 -0
- package/dist-types/commands/UpdateNotebookCommand.d.ts +7 -0
- package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +5 -0
- package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +6 -0
- package/dist-types/commands/UpdateWorkGroupCommand.d.ts +39 -4
- package/dist-types/models/models_0.d.ts +72 -53
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +8 -8
|
@@ -28,6 +28,13 @@ export interface ImportNotebookCommandOutput extends ImportNotebookOutput, __Met
|
|
|
28
28
|
* import { AthenaClient, ImportNotebookCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
29
29
|
* // const { AthenaClient, ImportNotebookCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
30
30
|
* const client = new AthenaClient(config);
|
|
31
|
+
* const input = { // ImportNotebookInput
|
|
32
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
33
|
+
* Name: "STRING_VALUE", // required
|
|
34
|
+
* Payload: "STRING_VALUE", // required
|
|
35
|
+
* Type: "IPYNB", // required
|
|
36
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
37
|
+
* };
|
|
31
38
|
* const command = new ImportNotebookCommand(input);
|
|
32
39
|
* const response = await client.send(command);
|
|
33
40
|
* ```
|
|
@@ -20,13 +20,17 @@ export interface ListApplicationDPUSizesCommandOutput extends ListApplicationDPU
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns the supported DPU sizes for the supported application runtimes (for example,
|
|
23
|
-
* <code>
|
|
23
|
+
* <code>Athena notebook version 1</code>). </p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { AthenaClient, ListApplicationDPUSizesCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, ListApplicationDPUSizesCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // ListApplicationDPUSizesInput
|
|
31
|
+
* MaxResults: Number("int"),
|
|
32
|
+
* NextToken: "STRING_VALUE",
|
|
33
|
+
* };
|
|
30
34
|
* const command = new ListApplicationDPUSizesCommand(input);
|
|
31
35
|
* const response = await client.send(command);
|
|
32
36
|
* ```
|
|
@@ -27,6 +27,12 @@ export interface ListCalculationExecutionsCommandOutput extends ListCalculationE
|
|
|
27
27
|
* import { AthenaClient, ListCalculationExecutionsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, ListCalculationExecutionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // ListCalculationExecutionsRequest
|
|
31
|
+
* SessionId: "STRING_VALUE", // required
|
|
32
|
+
* StateFilter: "CREATING" || "CREATED" || "QUEUED" || "RUNNING" || "CANCELING" || "CANCELED" || "COMPLETED" || "FAILED",
|
|
33
|
+
* MaxResults: Number("int"),
|
|
34
|
+
* NextToken: "STRING_VALUE",
|
|
35
|
+
* };
|
|
30
36
|
* const command = new ListCalculationExecutionsCommand(input);
|
|
31
37
|
* const response = await client.send(command);
|
|
32
38
|
* ```
|
|
@@ -21,7 +21,8 @@ export interface ListDataCatalogsCommandOutput extends ListDataCatalogsOutput, _
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Lists the data catalogs in the current Amazon Web Services account.</p>
|
|
23
23
|
* <note>
|
|
24
|
-
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
24
|
+
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
25
|
+
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
25
26
|
* </note>
|
|
26
27
|
* @example
|
|
27
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,6 +30,10 @@ export interface ListDataCatalogsCommandOutput extends ListDataCatalogsOutput, _
|
|
|
29
30
|
* import { AthenaClient, ListDataCatalogsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
30
31
|
* // const { AthenaClient, ListDataCatalogsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
31
32
|
* const client = new AthenaClient(config);
|
|
33
|
+
* const input = { // ListDataCatalogsInput
|
|
34
|
+
* NextToken: "STRING_VALUE",
|
|
35
|
+
* MaxResults: Number("int"),
|
|
36
|
+
* };
|
|
32
37
|
* const command = new ListDataCatalogsCommand(input);
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
@@ -26,6 +26,11 @@ export interface ListDatabasesCommandOutput extends ListDatabasesOutput, __Metad
|
|
|
26
26
|
* import { AthenaClient, ListDatabasesCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, ListDatabasesCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // ListDatabasesInput
|
|
30
|
+
* CatalogName: "STRING_VALUE", // required
|
|
31
|
+
* NextToken: "STRING_VALUE",
|
|
32
|
+
* MaxResults: Number("int"),
|
|
33
|
+
* };
|
|
29
34
|
* const command = new ListDatabasesCommand(input);
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
@@ -27,6 +27,10 @@ export interface ListEngineVersionsCommandOutput extends ListEngineVersionsOutpu
|
|
|
27
27
|
* import { AthenaClient, ListEngineVersionsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, ListEngineVersionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // ListEngineVersionsInput
|
|
31
|
+
* NextToken: "STRING_VALUE",
|
|
32
|
+
* MaxResults: Number("int"),
|
|
33
|
+
* };
|
|
30
34
|
* const command = new ListEngineVersionsCommand(input);
|
|
31
35
|
* const response = await client.send(command);
|
|
32
36
|
* ```
|
|
@@ -19,15 +19,21 @@ export interface ListExecutorsCommandOutput extends ListExecutorsResponse, __Met
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Lists, in descending order, the executors that
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Lists, in descending order, the executors that joined a session. Newer executors are
|
|
23
|
+
* listed first; older executors are listed later. The result can be optionally filtered by
|
|
24
|
+
* state.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
28
28
|
* import { AthenaClient, ListExecutorsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
29
29
|
* // const { AthenaClient, ListExecutorsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
30
30
|
* const client = new AthenaClient(config);
|
|
31
|
+
* const input = { // ListExecutorsRequest
|
|
32
|
+
* SessionId: "STRING_VALUE", // required
|
|
33
|
+
* ExecutorStateFilter: "CREATING" || "CREATED" || "REGISTERED" || "TERMINATING" || "TERMINATED" || "FAILED",
|
|
34
|
+
* MaxResults: Number("int"),
|
|
35
|
+
* NextToken: "STRING_VALUE",
|
|
36
|
+
* };
|
|
31
37
|
* const command = new ListExecutorsCommand(input);
|
|
32
38
|
* const response = await client.send(command);
|
|
33
39
|
* ```
|
|
@@ -31,6 +31,11 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _
|
|
|
31
31
|
* import { AthenaClient, ListNamedQueriesCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
32
32
|
* // const { AthenaClient, ListNamedQueriesCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
33
33
|
* const client = new AthenaClient(config);
|
|
34
|
+
* const input = { // ListNamedQueriesInput
|
|
35
|
+
* NextToken: "STRING_VALUE",
|
|
36
|
+
* MaxResults: Number("int"),
|
|
37
|
+
* WorkGroup: "STRING_VALUE",
|
|
38
|
+
* };
|
|
34
39
|
* const command = new ListNamedQueriesCommand(input);
|
|
35
40
|
* const response = await client.send(command);
|
|
36
41
|
* ```
|
|
@@ -26,6 +26,14 @@ export interface ListNotebookMetadataCommandOutput extends ListNotebookMetadataO
|
|
|
26
26
|
* import { AthenaClient, ListNotebookMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, ListNotebookMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // ListNotebookMetadataInput
|
|
30
|
+
* Filters: { // FilterDefinition
|
|
31
|
+
* Name: "STRING_VALUE",
|
|
32
|
+
* },
|
|
33
|
+
* NextToken: "STRING_VALUE",
|
|
34
|
+
* MaxResults: Number("int"),
|
|
35
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
29
37
|
* const command = new ListNotebookMetadataCommand(input);
|
|
30
38
|
* const response = await client.send(command);
|
|
31
39
|
* ```
|
|
@@ -29,6 +29,11 @@ export interface ListNotebookSessionsCommandOutput extends ListNotebookSessionsR
|
|
|
29
29
|
* import { AthenaClient, ListNotebookSessionsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
30
30
|
* // const { AthenaClient, ListNotebookSessionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
31
31
|
* const client = new AthenaClient(config);
|
|
32
|
+
* const input = { // ListNotebookSessionsRequest
|
|
33
|
+
* NotebookId: "STRING_VALUE", // required
|
|
34
|
+
* MaxResults: Number("int"),
|
|
35
|
+
* NextToken: "STRING_VALUE",
|
|
36
|
+
* };
|
|
32
37
|
* const command = new ListNotebookSessionsCommand(input);
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
@@ -26,6 +26,11 @@ export interface ListPreparedStatementsCommandOutput extends ListPreparedStateme
|
|
|
26
26
|
* import { AthenaClient, ListPreparedStatementsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, ListPreparedStatementsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // ListPreparedStatementsInput
|
|
30
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
31
|
+
* NextToken: "STRING_VALUE",
|
|
32
|
+
* MaxResults: Number("int"),
|
|
33
|
+
* };
|
|
29
34
|
* const command = new ListPreparedStatementsCommand(input);
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
@@ -32,6 +32,11 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
|
|
|
32
32
|
* import { AthenaClient, ListQueryExecutionsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
33
33
|
* // const { AthenaClient, ListQueryExecutionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
34
34
|
* const client = new AthenaClient(config);
|
|
35
|
+
* const input = { // ListQueryExecutionsInput
|
|
36
|
+
* NextToken: "STRING_VALUE",
|
|
37
|
+
* MaxResults: Number("int"),
|
|
38
|
+
* WorkGroup: "STRING_VALUE",
|
|
39
|
+
* };
|
|
35
40
|
* const command = new ListQueryExecutionsCommand(input);
|
|
36
41
|
* const response = await client.send(command);
|
|
37
42
|
* ```
|
|
@@ -29,6 +29,12 @@ export interface ListSessionsCommandOutput extends ListSessionsResponse, __Metad
|
|
|
29
29
|
* import { AthenaClient, ListSessionsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
30
30
|
* // const { AthenaClient, ListSessionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
31
31
|
* const client = new AthenaClient(config);
|
|
32
|
+
* const input = { // ListSessionsRequest
|
|
33
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
34
|
+
* StateFilter: "CREATING" || "CREATED" || "IDLE" || "BUSY" || "TERMINATING" || "TERMINATED" || "DEGRADED" || "FAILED",
|
|
35
|
+
* MaxResults: Number("int"),
|
|
36
|
+
* NextToken: "STRING_VALUE",
|
|
37
|
+
* };
|
|
32
38
|
* const command = new ListSessionsCommand(input);
|
|
33
39
|
* const response = await client.send(command);
|
|
34
40
|
* ```
|
|
@@ -26,6 +26,13 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
|
|
|
26
26
|
* import { AthenaClient, ListTableMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, ListTableMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // ListTableMetadataInput
|
|
30
|
+
* CatalogName: "STRING_VALUE", // required
|
|
31
|
+
* DatabaseName: "STRING_VALUE", // required
|
|
32
|
+
* Expression: "STRING_VALUE",
|
|
33
|
+
* NextToken: "STRING_VALUE",
|
|
34
|
+
* MaxResults: Number("int"),
|
|
35
|
+
* };
|
|
29
36
|
* const command = new ListTableMetadataCommand(input);
|
|
30
37
|
* const response = await client.send(command);
|
|
31
38
|
* ```
|
|
@@ -27,6 +27,11 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
|
|
|
27
27
|
* import { AthenaClient, ListTagsForResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, ListTagsForResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // ListTagsForResourceInput
|
|
31
|
+
* ResourceARN: "STRING_VALUE", // required
|
|
32
|
+
* NextToken: "STRING_VALUE",
|
|
33
|
+
* MaxResults: Number("int"),
|
|
34
|
+
* };
|
|
30
35
|
* const command = new ListTagsForResourceCommand(input);
|
|
31
36
|
* const response = await client.send(command);
|
|
32
37
|
* ```
|
|
@@ -26,6 +26,10 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
|
|
|
26
26
|
* import { AthenaClient, ListWorkGroupsCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, ListWorkGroupsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // ListWorkGroupsInput
|
|
30
|
+
* NextToken: "STRING_VALUE",
|
|
31
|
+
* MaxResults: Number("int"),
|
|
32
|
+
* };
|
|
29
33
|
* const command = new ListWorkGroupsCommand(input);
|
|
30
34
|
* const response = await client.send(command);
|
|
31
35
|
* ```
|
|
@@ -20,13 +20,22 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Submits calculations for execution within a session. You can supply the code to run as
|
|
23
|
-
* an inline code block within the request
|
|
23
|
+
* an inline code block within the request.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { AthenaClient, StartCalculationExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, StartCalculationExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // StartCalculationExecutionRequest
|
|
31
|
+
* SessionId: "STRING_VALUE", // required
|
|
32
|
+
* Description: "STRING_VALUE",
|
|
33
|
+
* CalculationConfiguration: { // CalculationConfiguration
|
|
34
|
+
* CodeBlock: "STRING_VALUE",
|
|
35
|
+
* },
|
|
36
|
+
* CodeBlock: "STRING_VALUE",
|
|
37
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
38
|
+
* };
|
|
30
39
|
* const command = new StartCalculationExecutionCommand(input);
|
|
31
40
|
* const response = await client.send(command);
|
|
32
41
|
* ```
|
|
@@ -31,6 +31,35 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut
|
|
|
31
31
|
* import { AthenaClient, StartQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
32
32
|
* // const { AthenaClient, StartQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
33
33
|
* const client = new AthenaClient(config);
|
|
34
|
+
* const input = { // StartQueryExecutionInput
|
|
35
|
+
* QueryString: "STRING_VALUE", // required
|
|
36
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
37
|
+
* QueryExecutionContext: { // QueryExecutionContext
|
|
38
|
+
* Database: "STRING_VALUE",
|
|
39
|
+
* Catalog: "STRING_VALUE",
|
|
40
|
+
* },
|
|
41
|
+
* ResultConfiguration: { // ResultConfiguration
|
|
42
|
+
* OutputLocation: "STRING_VALUE",
|
|
43
|
+
* EncryptionConfiguration: { // EncryptionConfiguration
|
|
44
|
+
* EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
|
|
45
|
+
* KmsKey: "STRING_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
48
|
+
* AclConfiguration: { // AclConfiguration
|
|
49
|
+
* S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* WorkGroup: "STRING_VALUE",
|
|
53
|
+
* ExecutionParameters: [ // ExecutionParameters
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* ResultReuseConfiguration: { // ResultReuseConfiguration
|
|
57
|
+
* ResultReuseByAgeConfiguration: { // ResultReuseByAgeConfiguration
|
|
58
|
+
* Enabled: true || false, // required
|
|
59
|
+
* MaxAgeInMinutes: Number("int"),
|
|
60
|
+
* },
|
|
61
|
+
* },
|
|
62
|
+
* };
|
|
34
63
|
* const command = new StartQueryExecutionCommand(input);
|
|
35
64
|
* const response = await client.send(command);
|
|
36
65
|
* ```
|
|
@@ -27,6 +27,21 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
|
|
|
27
27
|
* import { AthenaClient, StartSessionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, StartSessionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // StartSessionRequest
|
|
31
|
+
* Description: "STRING_VALUE",
|
|
32
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
33
|
+
* EngineConfiguration: { // EngineConfiguration
|
|
34
|
+
* CoordinatorDpuSize: Number("int"),
|
|
35
|
+
* MaxConcurrentDpus: Number("int"), // required
|
|
36
|
+
* DefaultExecutorDpuSize: Number("int"),
|
|
37
|
+
* AdditionalConfigs: { // ParametersMap
|
|
38
|
+
* "<keys>": "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* },
|
|
41
|
+
* NotebookVersion: "STRING_VALUE",
|
|
42
|
+
* SessionIdleTimeoutInMinutes: Number("int"),
|
|
43
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
44
|
+
* };
|
|
30
45
|
* const command = new StartSessionCommand(input);
|
|
31
46
|
* const response = await client.send(command);
|
|
32
47
|
* ```
|
|
@@ -35,6 +35,9 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
|
|
|
35
35
|
* import { AthenaClient, StopCalculationExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
36
36
|
* // const { AthenaClient, StopCalculationExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
37
37
|
* const client = new AthenaClient(config);
|
|
38
|
+
* const input = { // StopCalculationExecutionRequest
|
|
39
|
+
* CalculationExecutionId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
38
41
|
* const command = new StopCalculationExecutionCommand(input);
|
|
39
42
|
* const response = await client.send(command);
|
|
40
43
|
* ```
|
|
@@ -30,6 +30,9 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
|
|
|
30
30
|
* import { AthenaClient, StopQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
31
31
|
* // const { AthenaClient, StopQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
32
32
|
* const client = new AthenaClient(config);
|
|
33
|
+
* const input = { // StopQueryExecutionInput
|
|
34
|
+
* QueryExecutionId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
33
36
|
* const command = new StopQueryExecutionCommand(input);
|
|
34
37
|
* const response = await client.send(command);
|
|
35
38
|
* ```
|
|
@@ -25,7 +25,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
25
25
|
* example, you can use tags to categorize Athena workgroups or data catalogs
|
|
26
26
|
* by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
|
|
27
27
|
* search and filter workgroups or data catalogs in your account. For best practices, see
|
|
28
|
-
*
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode
|
|
29
29
|
* characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use
|
|
30
30
|
* letters and numbers representable in UTF-8, and the following characters: + - = . _ : /
|
|
31
31
|
* @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you
|
|
@@ -36,6 +36,15 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
36
36
|
* import { AthenaClient, TagResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
37
37
|
* // const { AthenaClient, TagResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
38
38
|
* const client = new AthenaClient(config);
|
|
39
|
+
* const input = { // TagResourceInput
|
|
40
|
+
* ResourceARN: "STRING_VALUE", // required
|
|
41
|
+
* Tags: [ // TagList // required
|
|
42
|
+
* { // Tag
|
|
43
|
+
* Key: "STRING_VALUE",
|
|
44
|
+
* Value: "STRING_VALUE",
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* };
|
|
39
48
|
* const command = new TagResourceCommand(input);
|
|
40
49
|
* const response = await client.send(command);
|
|
41
50
|
* ```
|
|
@@ -30,6 +30,9 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
|
|
|
30
30
|
* import { AthenaClient, TerminateSessionCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
31
31
|
* // const { AthenaClient, TerminateSessionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
32
32
|
* const client = new AthenaClient(config);
|
|
33
|
+
* const input = { // TerminateSessionRequest
|
|
34
|
+
* SessionId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
33
36
|
* const command = new TerminateSessionCommand(input);
|
|
34
37
|
* const response = await client.send(command);
|
|
35
38
|
* ```
|
|
@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
|
|
|
26
26
|
* import { AthenaClient, UntagResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, UntagResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // UntagResourceInput
|
|
30
|
+
* ResourceARN: "STRING_VALUE", // required
|
|
31
|
+
* TagKeys: [ // TagKeyList // required
|
|
32
|
+
* "STRING_VALUE",
|
|
33
|
+
* ],
|
|
34
|
+
* };
|
|
29
35
|
* const command = new UntagResourceCommand(input);
|
|
30
36
|
* const response = await client.send(command);
|
|
31
37
|
* ```
|
|
@@ -26,6 +26,14 @@ export interface UpdateDataCatalogCommandOutput extends UpdateDataCatalogOutput,
|
|
|
26
26
|
* import { AthenaClient, UpdateDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, UpdateDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // UpdateDataCatalogInput
|
|
30
|
+
* Name: "STRING_VALUE", // required
|
|
31
|
+
* Type: "LAMBDA" || "GLUE" || "HIVE", // required
|
|
32
|
+
* Description: "STRING_VALUE",
|
|
33
|
+
* Parameters: { // ParametersMap
|
|
34
|
+
* "<keys>": "STRING_VALUE",
|
|
35
|
+
* },
|
|
36
|
+
* };
|
|
29
37
|
* const command = new UpdateDataCatalogCommand(input);
|
|
30
38
|
* const response = await client.send(command);
|
|
31
39
|
* ```
|
|
@@ -27,6 +27,12 @@ export interface UpdateNamedQueryCommandOutput extends UpdateNamedQueryOutput, _
|
|
|
27
27
|
* import { AthenaClient, UpdateNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
28
28
|
* // const { AthenaClient, UpdateNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
29
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // UpdateNamedQueryInput
|
|
31
|
+
* NamedQueryId: "STRING_VALUE", // required
|
|
32
|
+
* Name: "STRING_VALUE", // required
|
|
33
|
+
* Description: "STRING_VALUE",
|
|
34
|
+
* QueryString: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
30
36
|
* const command = new UpdateNamedQueryCommand(input);
|
|
31
37
|
* const response = await client.send(command);
|
|
32
38
|
* ```
|
|
@@ -26,6 +26,13 @@ export interface UpdateNotebookCommandOutput extends UpdateNotebookOutput, __Met
|
|
|
26
26
|
* import { AthenaClient, UpdateNotebookCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, UpdateNotebookCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // UpdateNotebookInput
|
|
30
|
+
* NotebookId: "STRING_VALUE", // required
|
|
31
|
+
* Payload: "STRING_VALUE", // required
|
|
32
|
+
* Type: "IPYNB", // required
|
|
33
|
+
* SessionId: "STRING_VALUE",
|
|
34
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
35
|
+
* };
|
|
29
36
|
* const command = new UpdateNotebookCommand(input);
|
|
30
37
|
* const response = await client.send(command);
|
|
31
38
|
* ```
|
|
@@ -26,6 +26,11 @@ export interface UpdateNotebookMetadataCommandOutput extends UpdateNotebookMetad
|
|
|
26
26
|
* import { AthenaClient, UpdateNotebookMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, UpdateNotebookMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // UpdateNotebookMetadataInput
|
|
30
|
+
* NotebookId: "STRING_VALUE", // required
|
|
31
|
+
* ClientRequestToken: "STRING_VALUE",
|
|
32
|
+
* Name: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
29
34
|
* const command = new UpdateNotebookMetadataCommand(input);
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
@@ -26,6 +26,12 @@ export interface UpdatePreparedStatementCommandOutput extends UpdatePreparedStat
|
|
|
26
26
|
* import { AthenaClient, UpdatePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
27
27
|
* // const { AthenaClient, UpdatePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
28
28
|
* const client = new AthenaClient(config);
|
|
29
|
+
* const input = { // UpdatePreparedStatementInput
|
|
30
|
+
* StatementName: "STRING_VALUE", // required
|
|
31
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
32
|
+
* QueryStatement: "STRING_VALUE", // required
|
|
33
|
+
* Description: "STRING_VALUE",
|
|
34
|
+
* };
|
|
29
35
|
* const command = new UpdatePreparedStatementCommand(input);
|
|
30
36
|
* const response = await client.send(command);
|
|
31
37
|
* ```
|
|
@@ -20,16 +20,51 @@ export interface UpdateWorkGroupCommandOutput extends UpdateWorkGroupOutput, __M
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.
|
|
23
|
-
* Only
|
|
24
|
-
* be specified; <code>ConfigurationsUpdates</code> for a workgroup with multi engine
|
|
25
|
-
* support (for example, an Apache Spark enabled workgroup) or
|
|
26
|
-
* <code>ConfigurationUpdates</code> for an Athena SQL workgroup.</p>
|
|
23
|
+
* Only <code>ConfigurationUpdates</code> can be specified.</p>
|
|
27
24
|
* @example
|
|
28
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
26
|
* ```javascript
|
|
30
27
|
* import { AthenaClient, UpdateWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import
|
|
31
28
|
* // const { AthenaClient, UpdateWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import
|
|
32
29
|
* const client = new AthenaClient(config);
|
|
30
|
+
* const input = { // UpdateWorkGroupInput
|
|
31
|
+
* WorkGroup: "STRING_VALUE", // required
|
|
32
|
+
* Description: "STRING_VALUE",
|
|
33
|
+
* ConfigurationUpdates: { // WorkGroupConfigurationUpdates
|
|
34
|
+
* EnforceWorkGroupConfiguration: true || false,
|
|
35
|
+
* ResultConfigurationUpdates: { // ResultConfigurationUpdates
|
|
36
|
+
* OutputLocation: "STRING_VALUE",
|
|
37
|
+
* RemoveOutputLocation: true || false,
|
|
38
|
+
* EncryptionConfiguration: { // EncryptionConfiguration
|
|
39
|
+
* EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
|
|
40
|
+
* KmsKey: "STRING_VALUE",
|
|
41
|
+
* },
|
|
42
|
+
* RemoveEncryptionConfiguration: true || false,
|
|
43
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
44
|
+
* RemoveExpectedBucketOwner: true || false,
|
|
45
|
+
* AclConfiguration: { // AclConfiguration
|
|
46
|
+
* S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
|
|
47
|
+
* },
|
|
48
|
+
* RemoveAclConfiguration: true || false,
|
|
49
|
+
* },
|
|
50
|
+
* PublishCloudWatchMetricsEnabled: true || false,
|
|
51
|
+
* BytesScannedCutoffPerQuery: Number("long"),
|
|
52
|
+
* RemoveBytesScannedCutoffPerQuery: true || false,
|
|
53
|
+
* RequesterPaysEnabled: true || false,
|
|
54
|
+
* EngineVersion: { // EngineVersion
|
|
55
|
+
* SelectedEngineVersion: "STRING_VALUE",
|
|
56
|
+
* EffectiveEngineVersion: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* RemoveCustomerContentEncryptionConfiguration: true || false,
|
|
59
|
+
* AdditionalConfiguration: "STRING_VALUE",
|
|
60
|
+
* ExecutionRole: "STRING_VALUE",
|
|
61
|
+
* CustomerContentEncryptionConfiguration: { // CustomerContentEncryptionConfiguration
|
|
62
|
+
* KmsKey: "STRING_VALUE", // required
|
|
63
|
+
* },
|
|
64
|
+
* EnableMinimumEncryptionConfiguration: true || false,
|
|
65
|
+
* },
|
|
66
|
+
* State: "ENABLED" || "DISABLED",
|
|
67
|
+
* };
|
|
33
68
|
* const command = new UpdateWorkGroupCommand(input);
|
|
34
69
|
* const response = await client.send(command);
|
|
35
70
|
* ```
|