@aws-sdk/client-athena 3.298.0 → 3.300.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 (66) hide show
  1. package/dist-cjs/protocols/Aws_json1_1.js +7 -0
  2. package/dist-es/protocols/Aws_json1_1.js +7 -0
  3. package/dist-types/Athena.d.ts +18 -20
  4. package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +5 -0
  5. package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +6 -0
  6. package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +5 -0
  7. package/dist-types/commands/CreateDataCatalogCommand.d.ts +14 -0
  8. package/dist-types/commands/CreateNamedQueryCommand.d.ts +8 -0
  9. package/dist-types/commands/CreateNotebookCommand.d.ts +5 -0
  10. package/dist-types/commands/CreatePreparedStatementCommand.d.ts +6 -0
  11. package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +6 -1
  12. package/dist-types/commands/CreateWorkGroupCommand.d.ts +39 -4
  13. package/dist-types/commands/DeleteDataCatalogCommand.d.ts +3 -0
  14. package/dist-types/commands/DeleteNamedQueryCommand.d.ts +3 -0
  15. package/dist-types/commands/DeleteNotebookCommand.d.ts +3 -0
  16. package/dist-types/commands/DeletePreparedStatementCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteWorkGroupCommand.d.ts +4 -0
  18. package/dist-types/commands/ExportNotebookCommand.d.ts +3 -0
  19. package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +4 -2
  20. package/dist-types/commands/GetCalculationExecutionCommand.d.ts +3 -0
  21. package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +3 -0
  22. package/dist-types/commands/GetDataCatalogCommand.d.ts +3 -0
  23. package/dist-types/commands/GetDatabaseCommand.d.ts +4 -0
  24. package/dist-types/commands/GetNamedQueryCommand.d.ts +3 -0
  25. package/dist-types/commands/GetNotebookMetadataCommand.d.ts +3 -0
  26. package/dist-types/commands/GetPreparedStatementCommand.d.ts +4 -0
  27. package/dist-types/commands/GetQueryExecutionCommand.d.ts +3 -0
  28. package/dist-types/commands/GetQueryResultsCommand.d.ts +8 -2
  29. package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +3 -0
  30. package/dist-types/commands/GetSessionCommand.d.ts +3 -0
  31. package/dist-types/commands/GetSessionStatusCommand.d.ts +3 -0
  32. package/dist-types/commands/GetTableMetadataCommand.d.ts +5 -0
  33. package/dist-types/commands/GetWorkGroupCommand.d.ts +3 -0
  34. package/dist-types/commands/ImportNotebookCommand.d.ts +7 -0
  35. package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +5 -1
  36. package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +6 -0
  37. package/dist-types/commands/ListDataCatalogsCommand.d.ts +6 -1
  38. package/dist-types/commands/ListDatabasesCommand.d.ts +5 -0
  39. package/dist-types/commands/ListEngineVersionsCommand.d.ts +4 -0
  40. package/dist-types/commands/ListExecutorsCommand.d.ts +9 -3
  41. package/dist-types/commands/ListNamedQueriesCommand.d.ts +5 -0
  42. package/dist-types/commands/ListNotebookMetadataCommand.d.ts +8 -0
  43. package/dist-types/commands/ListNotebookSessionsCommand.d.ts +5 -0
  44. package/dist-types/commands/ListPreparedStatementsCommand.d.ts +5 -0
  45. package/dist-types/commands/ListQueryExecutionsCommand.d.ts +5 -0
  46. package/dist-types/commands/ListSessionsCommand.d.ts +6 -0
  47. package/dist-types/commands/ListTableMetadataCommand.d.ts +7 -0
  48. package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -0
  49. package/dist-types/commands/ListWorkGroupsCommand.d.ts +4 -0
  50. package/dist-types/commands/StartCalculationExecutionCommand.d.ts +10 -1
  51. package/dist-types/commands/StartQueryExecutionCommand.d.ts +29 -0
  52. package/dist-types/commands/StartSessionCommand.d.ts +15 -0
  53. package/dist-types/commands/StopCalculationExecutionCommand.d.ts +3 -0
  54. package/dist-types/commands/StopQueryExecutionCommand.d.ts +3 -0
  55. package/dist-types/commands/TagResourceCommand.d.ts +10 -1
  56. package/dist-types/commands/TerminateSessionCommand.d.ts +3 -0
  57. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  58. package/dist-types/commands/UpdateDataCatalogCommand.d.ts +8 -0
  59. package/dist-types/commands/UpdateNamedQueryCommand.d.ts +6 -0
  60. package/dist-types/commands/UpdateNotebookCommand.d.ts +7 -0
  61. package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +5 -0
  62. package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +6 -0
  63. package/dist-types/commands/UpdateWorkGroupCommand.d.ts +39 -4
  64. package/dist-types/models/models_0.d.ts +72 -53
  65. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  66. package/package.json +12 -12
@@ -3569,6 +3569,9 @@ const serializeAws_json1_1WorkGroupConfiguration = (input, context) => {
3569
3569
  ...(input.CustomerContentEncryptionConfiguration != null && {
3570
3570
  CustomerContentEncryptionConfiguration: serializeAws_json1_1CustomerContentEncryptionConfiguration(input.CustomerContentEncryptionConfiguration, context),
3571
3571
  }),
3572
+ ...(input.EnableMinimumEncryptionConfiguration != null && {
3573
+ EnableMinimumEncryptionConfiguration: input.EnableMinimumEncryptionConfiguration,
3574
+ }),
3572
3575
  ...(input.EnforceWorkGroupConfiguration != null && {
3573
3576
  EnforceWorkGroupConfiguration: input.EnforceWorkGroupConfiguration,
3574
3577
  }),
@@ -3592,6 +3595,9 @@ const serializeAws_json1_1WorkGroupConfigurationUpdates = (input, context) => {
3592
3595
  ...(input.CustomerContentEncryptionConfiguration != null && {
3593
3596
  CustomerContentEncryptionConfiguration: serializeAws_json1_1CustomerContentEncryptionConfiguration(input.CustomerContentEncryptionConfiguration, context),
3594
3597
  }),
3598
+ ...(input.EnableMinimumEncryptionConfiguration != null && {
3599
+ EnableMinimumEncryptionConfiguration: input.EnableMinimumEncryptionConfiguration,
3600
+ }),
3595
3601
  ...(input.EnforceWorkGroupConfiguration != null && {
3596
3602
  EnforceWorkGroupConfiguration: input.EnforceWorkGroupConfiguration,
3597
3603
  }),
@@ -4770,6 +4776,7 @@ const deserializeAws_json1_1WorkGroupConfiguration = (output, context) => {
4770
4776
  CustomerContentEncryptionConfiguration: output.CustomerContentEncryptionConfiguration != null
4771
4777
  ? deserializeAws_json1_1CustomerContentEncryptionConfiguration(output.CustomerContentEncryptionConfiguration, context)
4772
4778
  : undefined,
4779
+ EnableMinimumEncryptionConfiguration: (0, smithy_client_1.expectBoolean)(output.EnableMinimumEncryptionConfiguration),
4773
4780
  EnforceWorkGroupConfiguration: (0, smithy_client_1.expectBoolean)(output.EnforceWorkGroupConfiguration),
4774
4781
  EngineVersion: output.EngineVersion != null ? deserializeAws_json1_1EngineVersion(output.EngineVersion, context) : undefined,
4775
4782
  ExecutionRole: (0, smithy_client_1.expectString)(output.ExecutionRole),
@@ -3444,6 +3444,9 @@ const serializeAws_json1_1WorkGroupConfiguration = (input, context) => {
3444
3444
  ...(input.CustomerContentEncryptionConfiguration != null && {
3445
3445
  CustomerContentEncryptionConfiguration: serializeAws_json1_1CustomerContentEncryptionConfiguration(input.CustomerContentEncryptionConfiguration, context),
3446
3446
  }),
3447
+ ...(input.EnableMinimumEncryptionConfiguration != null && {
3448
+ EnableMinimumEncryptionConfiguration: input.EnableMinimumEncryptionConfiguration,
3449
+ }),
3447
3450
  ...(input.EnforceWorkGroupConfiguration != null && {
3448
3451
  EnforceWorkGroupConfiguration: input.EnforceWorkGroupConfiguration,
3449
3452
  }),
@@ -3467,6 +3470,9 @@ const serializeAws_json1_1WorkGroupConfigurationUpdates = (input, context) => {
3467
3470
  ...(input.CustomerContentEncryptionConfiguration != null && {
3468
3471
  CustomerContentEncryptionConfiguration: serializeAws_json1_1CustomerContentEncryptionConfiguration(input.CustomerContentEncryptionConfiguration, context),
3469
3472
  }),
3473
+ ...(input.EnableMinimumEncryptionConfiguration != null && {
3474
+ EnableMinimumEncryptionConfiguration: input.EnableMinimumEncryptionConfiguration,
3475
+ }),
3470
3476
  ...(input.EnforceWorkGroupConfiguration != null && {
3471
3477
  EnforceWorkGroupConfiguration: input.EnforceWorkGroupConfiguration,
3472
3478
  }),
@@ -4645,6 +4651,7 @@ const deserializeAws_json1_1WorkGroupConfiguration = (output, context) => {
4645
4651
  CustomerContentEncryptionConfiguration: output.CustomerContentEncryptionConfiguration != null
4646
4652
  ? deserializeAws_json1_1CustomerContentEncryptionConfiguration(output.CustomerContentEncryptionConfiguration, context)
4647
4653
  : undefined,
4654
+ EnableMinimumEncryptionConfiguration: __expectBoolean(output.EnableMinimumEncryptionConfiguration),
4648
4655
  EnforceWorkGroupConfiguration: __expectBoolean(output.EnforceWorkGroupConfiguration),
4649
4656
  EngineVersion: output.EngineVersion != null ? deserializeAws_json1_1EngineVersion(output.EngineVersion, context) : undefined,
4650
4657
  ExecutionRole: __expectString(output.ExecutionRole),
@@ -155,17 +155,17 @@ export declare class Athena extends AthenaClient {
155
155
  * @public
156
156
  * <p>Gets an authentication token and the URL at which the notebook can be accessed. During
157
157
  * programmatic access, <code>CreatePresignedNotebookUrl</code> must be called every 10
158
- * minutes to refresh the authentication token.</p>
158
+ * minutes to refresh the authentication token. For information about granting programmatic
159
+ * access, see <a href="https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access">Grant
160
+ * programmatic access</a>.</p>
159
161
  */
160
162
  createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, options?: __HttpHandlerOptions): Promise<CreatePresignedNotebookUrlCommandOutput>;
161
163
  createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
162
164
  createPresignedNotebookUrl(args: CreatePresignedNotebookUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void): void;
163
165
  /**
164
166
  * @public
165
- * <p>Creates a workgroup with the specified name. Only one of <code>Configurations</code>
166
- * or <code>Configuration</code> can be specified; <code>Configurations</code> for a
167
- * workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or
168
- * <code>Configuration</code> for an Athena SQL workgroup.</p>
167
+ * <p>Creates a workgroup with the specified name. A workgroup can be an Apache Spark
168
+ * enabled workgroup or an Athena SQL workgroup.</p>
169
169
  */
170
170
  createWorkGroup(args: CreateWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkGroupCommandOutput>;
171
171
  createWorkGroup(args: CreateWorkGroupCommandInput, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void;
@@ -227,8 +227,7 @@ export declare class Athena extends AthenaClient {
227
227
  getCalculationExecution(args: GetCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void): void;
228
228
  /**
229
229
  * @public
230
- * <p>Retrieves a pre-signed URL to a copy of the code that was executed for the
231
- * calculation.</p>
230
+ * <p>Retrieves the unencrypted code that was executed for the calculation.</p>
232
231
  */
233
232
  getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, options?: __HttpHandlerOptions): Promise<GetCalculationExecutionCodeCommandOutput>;
234
233
  getCalculationExecutionCode(args: GetCalculationExecutionCodeCommandInput, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void): void;
@@ -290,8 +289,9 @@ export declare class Athena extends AthenaClient {
290
289
  * @public
291
290
  * <p>Streams the results of a single query execution specified by
292
291
  * <code>QueryExecutionId</code> from the Athena query results location in
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
294
- * but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
292
+ * Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and
293
+ * output files</a> in the <i>Amazon Athena User Guide</i>.
294
+ * This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
295
295
  * <p>To stream query results successfully, the IAM principal with permission to call
296
296
  * <code>GetQueryResults</code> also must have permissions to the Amazon S3
297
297
  * <code>GetObject</code> action for the Athena query results location.</p>
@@ -360,7 +360,7 @@ export declare class Athena extends AthenaClient {
360
360
  /**
361
361
  * @public
362
362
  * <p>Returns the supported DPU sizes for the supported application runtimes (for example,
363
- * <code>Jupyter 1.0</code>). </p>
363
+ * <code>Athena notebook version 1</code>). </p>
364
364
  */
365
365
  listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, options?: __HttpHandlerOptions): Promise<ListApplicationDPUSizesCommandOutput>;
366
366
  listApplicationDPUSizes(args: ListApplicationDPUSizesCommandInput, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void): void;
@@ -384,7 +384,8 @@ export declare class Athena extends AthenaClient {
384
384
  * @public
385
385
  * <p>Lists the data catalogs in the current Amazon Web Services account.</p>
386
386
  * <note>
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>
387
+ * <p>In the Athena console, data catalogs are listed as "data sources" on
388
+ * the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
388
389
  * </note>
389
390
  */
390
391
  listDataCatalogs(args: ListDataCatalogsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataCatalogsCommandOutput>;
@@ -400,9 +401,9 @@ export declare class Athena extends AthenaClient {
400
401
  listEngineVersions(args: ListEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void): void;
401
402
  /**
402
403
  * @public
403
- * <p>Lists, in descending order, the executors that have been submitted to a session. Newer
404
- * executors are listed first; older executors are listed later. The result can be
405
- * optionally filtered by state.</p>
404
+ * <p>Lists, in descending order, the executors that joined a session. Newer executors are
405
+ * listed first; older executors are listed later. The result can be optionally filtered by
406
+ * state.</p>
406
407
  */
407
408
  listExecutors(args: ListExecutorsCommandInput, options?: __HttpHandlerOptions): Promise<ListExecutorsCommandOutput>;
408
409
  listExecutors(args: ListExecutorsCommandInput, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void;
@@ -491,7 +492,7 @@ export declare class Athena extends AthenaClient {
491
492
  /**
492
493
  * @public
493
494
  * <p>Submits calculations for execution within a session. You can supply the code to run as
494
- * an inline code block within the request or as an Amazon S3 URL.</p>
495
+ * an inline code block within the request.</p>
495
496
  */
496
497
  startCalculationExecution(args: StartCalculationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartCalculationExecutionCommandOutput>;
497
498
  startCalculationExecution(args: StartCalculationExecutionCommandInput, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void): void;
@@ -551,7 +552,7 @@ export declare class Athena extends AthenaClient {
551
552
  * example, you can use tags to categorize Athena workgroups or data catalogs
552
553
  * by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to
553
554
  * search and filter workgroups or data catalogs in your account. For best practices, see
554
- * <a href="https://aws.amazon.com/answers/account-management/aws-tagging-strategies/">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode
555
+ * <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
555
556
  * characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use
556
557
  * letters and numbers representable in UTF-8, and the following characters: + - = . _ : /
557
558
  * @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you
@@ -617,10 +618,7 @@ export declare class Athena extends AthenaClient {
617
618
  /**
618
619
  * @public
619
620
  * <p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.
620
- * Only one of <code>ConfigurationsUpdates</code> or <code>ConfigurationUpdates</code> can
621
- * be specified; <code>ConfigurationsUpdates</code> for a workgroup with multi engine
622
- * support (for example, an Apache Spark enabled workgroup) or
623
- * <code>ConfigurationUpdates</code> for an Athena SQL workgroup.</p>
621
+ * Only <code>ConfigurationUpdates</code> can be specified.</p>
624
622
  */
625
623
  updateWorkGroup(args: UpdateWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkGroupCommandOutput>;
626
624
  updateWorkGroup(args: UpdateWorkGroupCommandInput, cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void): void;
@@ -34,6 +34,11 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu
34
34
  * import { AthenaClient, BatchGetNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import
35
35
  * // const { AthenaClient, BatchGetNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import
36
36
  * const client = new AthenaClient(config);
37
+ * const input = {
38
+ * NamedQueryIds: [ // required
39
+ * "STRING_VALUE",
40
+ * ],
41
+ * };
37
42
  * const command = new BatchGetNamedQueryCommand(input);
38
43
  * const response = await client.send(command);
39
44
  * ```
@@ -30,6 +30,12 @@ export interface BatchGetPreparedStatementCommandOutput extends BatchGetPrepared
30
30
  * import { AthenaClient, BatchGetPreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import
31
31
  * // const { AthenaClient, BatchGetPreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import
32
32
  * const client = new AthenaClient(config);
33
+ * const input = {
34
+ * PreparedStatementNames: [ // required
35
+ * "STRING_VALUE",
36
+ * ],
37
+ * WorkGroup: "STRING_VALUE", // required
38
+ * };
33
39
  * const command = new BatchGetPreparedStatementCommand(input);
34
40
  * const response = await client.send(command);
35
41
  * ```
@@ -31,6 +31,11 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
31
31
  * import { AthenaClient, BatchGetQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
32
32
  * // const { AthenaClient, BatchGetQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
33
33
  * const client = new AthenaClient(config);
34
+ * const input = {
35
+ * QueryExecutionIds: [ // required
36
+ * "STRING_VALUE",
37
+ * ],
38
+ * };
34
39
  * const command = new BatchGetQueryExecutionCommand(input);
35
40
  * const response = await client.send(command);
36
41
  * ```
@@ -27,6 +27,20 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
27
27
  * import { AthenaClient, CreateDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, CreateDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * Name: "STRING_VALUE", // required
32
+ * Type: "LAMBDA" || "GLUE" || "HIVE", // required
33
+ * Description: "STRING_VALUE",
34
+ * Parameters: {
35
+ * "<keys>": "STRING_VALUE",
36
+ * },
37
+ * Tags: [
38
+ * {
39
+ * Key: "STRING_VALUE",
40
+ * Value: "STRING_VALUE",
41
+ * },
42
+ * ],
43
+ * };
30
44
  * const command = new CreateDataCatalogCommand(input);
31
45
  * const response = await client.send(command);
32
46
  * ```
@@ -30,6 +30,14 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
30
30
  * import { AthenaClient, CreateNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import
31
31
  * // const { AthenaClient, CreateNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import
32
32
  * const client = new AthenaClient(config);
33
+ * const input = {
34
+ * Name: "STRING_VALUE", // required
35
+ * Description: "STRING_VALUE",
36
+ * Database: "STRING_VALUE", // required
37
+ * QueryString: "STRING_VALUE", // required
38
+ * ClientRequestToken: "STRING_VALUE",
39
+ * WorkGroup: "STRING_VALUE",
40
+ * };
33
41
  * const command = new CreateNamedQueryCommand(input);
34
42
  * const response = await client.send(command);
35
43
  * ```
@@ -28,6 +28,11 @@ export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __Met
28
28
  * import { AthenaClient, CreateNotebookCommand } from "@aws-sdk/client-athena"; // ES Modules import
29
29
  * // const { AthenaClient, CreateNotebookCommand } = require("@aws-sdk/client-athena"); // CommonJS import
30
30
  * const client = new AthenaClient(config);
31
+ * const input = {
32
+ * WorkGroup: "STRING_VALUE", // required
33
+ * Name: "STRING_VALUE", // required
34
+ * ClientRequestToken: "STRING_VALUE",
35
+ * };
31
36
  * const command = new CreateNotebookCommand(input);
32
37
  * const response = await client.send(command);
33
38
  * ```
@@ -26,6 +26,12 @@ export interface CreatePreparedStatementCommandOutput extends CreatePreparedStat
26
26
  * import { AthenaClient, CreatePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, CreatePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
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 CreatePreparedStatementCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -21,13 +21,18 @@ export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresigned
21
21
  * @public
22
22
  * <p>Gets an authentication token and the URL at which the notebook can be accessed. During
23
23
  * programmatic access, <code>CreatePresignedNotebookUrl</code> must be called every 10
24
- * minutes to refresh the authentication token.</p>
24
+ * minutes to refresh the authentication token. For information about granting programmatic
25
+ * access, see <a href="https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access">Grant
26
+ * programmatic access</a>.</p>
25
27
  * @example
26
28
  * Use a bare-bones client and the command you need to make an API call.
27
29
  * ```javascript
28
30
  * import { AthenaClient, CreatePresignedNotebookUrlCommand } from "@aws-sdk/client-athena"; // ES Modules import
29
31
  * // const { AthenaClient, CreatePresignedNotebookUrlCommand } = require("@aws-sdk/client-athena"); // CommonJS import
30
32
  * const client = new AthenaClient(config);
33
+ * const input = {
34
+ * SessionId: "STRING_VALUE", // required
35
+ * };
31
36
  * const command = new CreatePresignedNotebookUrlCommand(input);
32
37
  * const response = await client.send(command);
33
38
  * ```
@@ -19,16 +19,51 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Creates a workgroup with the specified name. Only one of <code>Configurations</code>
23
- * or <code>Configuration</code> can be specified; <code>Configurations</code> for a
24
- * workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or
25
- * <code>Configuration</code> for an Athena SQL workgroup.</p>
22
+ * <p>Creates a workgroup with the specified name. A workgroup can be an Apache Spark
23
+ * enabled workgroup or an Athena SQL workgroup.</p>
26
24
  * @example
27
25
  * Use a bare-bones client and the command you need to make an API call.
28
26
  * ```javascript
29
27
  * import { AthenaClient, CreateWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import
30
28
  * // const { AthenaClient, CreateWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import
31
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * Name: "STRING_VALUE", // required
32
+ * Configuration: {
33
+ * ResultConfiguration: {
34
+ * OutputLocation: "STRING_VALUE",
35
+ * EncryptionConfiguration: {
36
+ * EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
37
+ * KmsKey: "STRING_VALUE",
38
+ * },
39
+ * ExpectedBucketOwner: "STRING_VALUE",
40
+ * AclConfiguration: {
41
+ * S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
42
+ * },
43
+ * },
44
+ * EnforceWorkGroupConfiguration: true || false,
45
+ * PublishCloudWatchMetricsEnabled: true || false,
46
+ * BytesScannedCutoffPerQuery: Number("long"),
47
+ * RequesterPaysEnabled: true || false,
48
+ * EngineVersion: {
49
+ * SelectedEngineVersion: "STRING_VALUE",
50
+ * EffectiveEngineVersion: "STRING_VALUE",
51
+ * },
52
+ * AdditionalConfiguration: "STRING_VALUE",
53
+ * ExecutionRole: "STRING_VALUE",
54
+ * CustomerContentEncryptionConfiguration: {
55
+ * KmsKey: "STRING_VALUE", // required
56
+ * },
57
+ * EnableMinimumEncryptionConfiguration: true || false,
58
+ * },
59
+ * Description: "STRING_VALUE",
60
+ * Tags: [
61
+ * {
62
+ * Key: "STRING_VALUE",
63
+ * Value: "STRING_VALUE",
64
+ * },
65
+ * ],
66
+ * };
32
67
  * const command = new CreateWorkGroupCommand(input);
33
68
  * const response = await client.send(command);
34
69
  * ```
@@ -26,6 +26,9 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput,
26
26
  * import { AthenaClient, DeleteDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, DeleteDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * Name: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteDataCatalogCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -30,6 +30,9 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
30
30
  * import { AthenaClient, DeleteNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import
31
31
  * // const { AthenaClient, DeleteNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import
32
32
  * const client = new AthenaClient(config);
33
+ * const input = {
34
+ * NamedQueryId: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DeleteNamedQueryCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -26,6 +26,9 @@ export interface DeleteNotebookCommandOutput extends DeleteNotebookOutput, __Met
26
26
  * import { AthenaClient, DeleteNotebookCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, DeleteNotebookCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * NotebookId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteNotebookCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,10 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat
27
27
  * import { AthenaClient, DeletePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, DeletePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * StatementName: "STRING_VALUE", // required
32
+ * WorkGroup: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new DeletePreparedStatementCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -27,6 +27,10 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M
27
27
  * import { AthenaClient, DeleteWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, DeleteWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * WorkGroup: "STRING_VALUE", // required
32
+ * RecursiveDeleteOption: true || false,
33
+ * };
30
34
  * const command = new DeleteWorkGroupCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,9 @@ export interface ExportNotebookCommandOutput extends ExportNotebookOutput, __Met
26
26
  * import { AthenaClient, ExportNotebookCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, ExportNotebookCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * NotebookId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new ExportNotebookCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -19,14 +19,16 @@ export interface GetCalculationExecutionCodeCommandOutput extends GetCalculation
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Retrieves a pre-signed URL to a copy of the code that was executed for the
23
- * calculation.</p>
22
+ * <p>Retrieves the unencrypted code that was executed for the calculation.</p>
24
23
  * @example
25
24
  * Use a bare-bones client and the command you need to make an API call.
26
25
  * ```javascript
27
26
  * import { AthenaClient, GetCalculationExecutionCodeCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
27
  * // const { AthenaClient, GetCalculationExecutionCodeCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * CalculationExecutionId: "STRING_VALUE", // required
31
+ * };
30
32
  * const command = new GetCalculationExecutionCodeCommand(input);
31
33
  * const response = await client.send(command);
32
34
  * ```
@@ -26,6 +26,9 @@ export interface GetCalculationExecutionCommandOutput extends GetCalculationExec
26
26
  * import { AthenaClient, GetCalculationExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetCalculationExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * CalculationExecutionId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetCalculationExecutionCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,9 @@ export interface GetCalculationExecutionStatusCommandOutput extends GetCalculati
26
26
  * import { AthenaClient, GetCalculationExecutionStatusCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetCalculationExecutionStatusCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * CalculationExecutionId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetCalculationExecutionStatusCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,9 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
26
26
  * import { AthenaClient, GetDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * Name: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetDataCatalogCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
26
26
  * import { AthenaClient, GetDatabaseCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetDatabaseCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * CatalogName: "STRING_VALUE", // required
31
+ * DatabaseName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetDatabaseCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,9 @@ export interface GetNamedQueryCommandOutput extends GetNamedQueryOutput, __Metad
27
27
  * import { AthenaClient, GetNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, GetNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * NamedQueryId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new GetNamedQueryCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface GetNotebookMetadataCommandOutput extends GetNotebookMetadataOut
26
26
  * import { AthenaClient, GetNotebookMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetNotebookMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * NotebookId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetNotebookMetadataCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,10 @@ export interface GetPreparedStatementCommandOutput extends GetPreparedStatementO
27
27
  * import { AthenaClient, GetPreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, GetPreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * StatementName: "STRING_VALUE", // required
32
+ * WorkGroup: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new GetPreparedStatementCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -28,6 +28,9 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput,
28
28
  * import { AthenaClient, GetQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import
29
29
  * // const { AthenaClient, GetQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
30
30
  * const client = new AthenaClient(config);
31
+ * const input = {
32
+ * QueryExecutionId: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new GetQueryExecutionCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -21,8 +21,9 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M
21
21
  * @public
22
22
  * <p>Streams the results of a single query execution specified by
23
23
  * <code>QueryExecutionId</code> from the Athena query results location in
24
- * 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
25
- * but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
24
+ * Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and
25
+ * output files</a> in the <i>Amazon Athena User Guide</i>.
26
+ * This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>
26
27
  * <p>To stream query results successfully, the IAM principal with permission to call
27
28
  * <code>GetQueryResults</code> also must have permissions to the Amazon S3
28
29
  * <code>GetObject</code> action for the Athena query results location.</p>
@@ -40,6 +41,11 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M
40
41
  * import { AthenaClient, GetQueryResultsCommand } from "@aws-sdk/client-athena"; // ES Modules import
41
42
  * // const { AthenaClient, GetQueryResultsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
42
43
  * const client = new AthenaClient(config);
44
+ * const input = {
45
+ * QueryExecutionId: "STRING_VALUE", // required
46
+ * NextToken: "STRING_VALUE",
47
+ * MaxResults: Number("int"),
48
+ * };
43
49
  * const command = new GetQueryResultsCommand(input);
44
50
  * const response = await client.send(command);
45
51
  * ```
@@ -31,6 +31,9 @@ export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeS
31
31
  * import { AthenaClient, GetQueryRuntimeStatisticsCommand } from "@aws-sdk/client-athena"; // ES Modules import
32
32
  * // const { AthenaClient, GetQueryRuntimeStatisticsCommand } = require("@aws-sdk/client-athena"); // CommonJS import
33
33
  * const client = new AthenaClient(config);
34
+ * const input = {
35
+ * QueryExecutionId: "STRING_VALUE", // required
36
+ * };
34
37
  * const command = new GetQueryRuntimeStatisticsCommand(input);
35
38
  * const response = await client.send(command);
36
39
  * ```
@@ -27,6 +27,9 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
27
27
  * import { AthenaClient, GetSessionCommand } from "@aws-sdk/client-athena"; // ES Modules import
28
28
  * // const { AthenaClient, GetSessionCommand } = require("@aws-sdk/client-athena"); // CommonJS import
29
29
  * const client = new AthenaClient(config);
30
+ * const input = {
31
+ * SessionId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new GetSessionCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface GetSessionStatusCommandOutput extends GetSessionStatusResponse,
26
26
  * import { AthenaClient, GetSessionStatusCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetSessionStatusCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * SessionId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetSessionStatusCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,11 @@ export interface GetTableMetadataCommandOutput extends GetTableMetadataOutput, _
26
26
  * import { AthenaClient, GetTableMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetTableMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * CatalogName: "STRING_VALUE", // required
31
+ * DatabaseName: "STRING_VALUE", // required
32
+ * TableName: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetTableMetadataCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface GetWorkGroupCommandOutput extends GetWorkGroupOutput, __Metadat
26
26
  * import { AthenaClient, GetWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import
27
27
  * // const { AthenaClient, GetWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import
28
28
  * const client = new AthenaClient(config);
29
+ * const input = {
30
+ * WorkGroup: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetWorkGroupCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```