@aws-sdk/client-athena 3.817.0 → 3.822.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/index.js CHANGED
@@ -93,6 +93,7 @@ __export(index_exports, {
93
93
  NotebookType: () => NotebookType,
94
94
  PutCapacityAssignmentConfigurationCommand: () => PutCapacityAssignmentConfigurationCommand,
95
95
  QueryExecutionState: () => QueryExecutionState,
96
+ QueryResultType: () => QueryResultType,
96
97
  ResourceNotFoundException: () => ResourceNotFoundException,
97
98
  S3AclOption: () => S3AclOption,
98
99
  SessionAlreadyExistsException: () => SessionAlreadyExistsException,
@@ -517,6 +518,10 @@ var MetadataException = class _MetadataException extends AthenaServiceException
517
518
  this.Message = opts.Message;
518
519
  }
519
520
  };
521
+ var QueryResultType = {
522
+ DATA_MANIFEST: "DATA_MANIFEST",
523
+ DATA_ROWS: "DATA_ROWS"
524
+ };
520
525
  var ColumnNullable = {
521
526
  NOT_NULL: "NOT_NULL",
522
527
  NULLABLE: "NULLABLE",
@@ -2224,6 +2229,7 @@ var de_QueryExecution = /* @__PURE__ */ __name((output, context) => {
2224
2229
  return (0, import_smithy_client.take)(output, {
2225
2230
  EngineVersion: import_smithy_client._json,
2226
2231
  ExecutionParameters: import_smithy_client._json,
2232
+ ManagedQueryResultsConfiguration: import_smithy_client._json,
2227
2233
  Query: import_smithy_client.expectString,
2228
2234
  QueryExecutionContext: import_smithy_client._json,
2229
2235
  QueryExecutionId: import_smithy_client.expectString,
@@ -3656,6 +3662,7 @@ var paginateListWorkGroups = (0, import_core.createPaginator)(AthenaClient, List
3656
3662
  CapacityAllocationStatus,
3657
3663
  CapacityReservationStatus,
3658
3664
  MetadataException,
3665
+ QueryResultType,
3659
3666
  ColumnNullable,
3660
3667
  SessionState,
3661
3668
  WorkGroupState,
@@ -166,6 +166,10 @@ export class MetadataException extends __BaseException {
166
166
  this.Message = opts.Message;
167
167
  }
168
168
  }
169
+ export const QueryResultType = {
170
+ DATA_MANIFEST: "DATA_MANIFEST",
171
+ DATA_ROWS: "DATA_ROWS",
172
+ };
169
173
  export const ColumnNullable = {
170
174
  NOT_NULL: "NOT_NULL",
171
175
  NULLABLE: "NULLABLE",
@@ -1669,6 +1669,7 @@ const de_QueryExecution = (output, context) => {
1669
1669
  return take(output, {
1670
1670
  EngineVersion: _json,
1671
1671
  ExecutionParameters: _json,
1672
+ ManagedQueryResultsConfiguration: _json,
1672
1673
  Query: __expectString,
1673
1674
  QueryExecutionContext: _json,
1674
1675
  QueryExecutionId: __expectString,
@@ -52,6 +52,12 @@ declare const BatchGetQueryExecutionCommand_base: {
52
52
  * // QueryExecutionId: "STRING_VALUE",
53
53
  * // Query: "STRING_VALUE",
54
54
  * // StatementType: "DDL" || "DML" || "UTILITY",
55
+ * // ManagedQueryResultsConfiguration: { // ManagedQueryResultsConfiguration
56
+ * // Enabled: true || false, // required
57
+ * // EncryptionConfiguration: { // ManagedQueryResultsEncryptionConfiguration
58
+ * // KmsKey: "STRING_VALUE", // required
59
+ * // },
60
+ * // },
55
61
  * // ResultConfiguration: { // ResultConfiguration
56
62
  * // OutputLocation: "STRING_VALUE",
57
63
  * // EncryptionConfiguration: { // EncryptionConfiguration
@@ -49,6 +49,12 @@ declare const CreateWorkGroupCommand_base: {
49
49
  * S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
50
50
  * },
51
51
  * },
52
+ * ManagedQueryResultsConfiguration: { // ManagedQueryResultsConfiguration
53
+ * Enabled: true || false, // required
54
+ * EncryptionConfiguration: { // ManagedQueryResultsEncryptionConfiguration
55
+ * KmsKey: "STRING_VALUE", // required
56
+ * },
57
+ * },
52
58
  * EnforceWorkGroupConfiguration: true || false,
53
59
  * PublishCloudWatchMetricsEnabled: true || false,
54
60
  * BytesScannedCutoffPerQuery: Number("long"),
@@ -46,6 +46,12 @@ declare const GetQueryExecutionCommand_base: {
46
46
  * // QueryExecutionId: "STRING_VALUE",
47
47
  * // Query: "STRING_VALUE",
48
48
  * // StatementType: "DDL" || "DML" || "UTILITY",
49
+ * // ManagedQueryResultsConfiguration: { // ManagedQueryResultsConfiguration
50
+ * // Enabled: true || false, // required
51
+ * // EncryptionConfiguration: { // ManagedQueryResultsEncryptionConfiguration
52
+ * // KmsKey: "STRING_VALUE", // required
53
+ * // },
54
+ * // },
49
55
  * // ResultConfiguration: { // ResultConfiguration
50
56
  * // OutputLocation: "STRING_VALUE",
51
57
  * // EncryptionConfiguration: { // EncryptionConfiguration
@@ -53,6 +53,7 @@ declare const GetQueryResultsCommand_base: {
53
53
  * QueryExecutionId: "STRING_VALUE", // required
54
54
  * NextToken: "STRING_VALUE",
55
55
  * MaxResults: Number("int"),
56
+ * QueryResultType: "DATA_MANIFEST" || "DATA_ROWS",
56
57
  * };
57
58
  * const command = new GetQueryResultsCommand(input);
58
59
  * const response = await client.send(command);
@@ -55,6 +55,12 @@ declare const GetWorkGroupCommand_base: {
55
55
  * // S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
56
56
  * // },
57
57
  * // },
58
+ * // ManagedQueryResultsConfiguration: { // ManagedQueryResultsConfiguration
59
+ * // Enabled: true || false, // required
60
+ * // EncryptionConfiguration: { // ManagedQueryResultsEncryptionConfiguration
61
+ * // KmsKey: "STRING_VALUE", // required
62
+ * // },
63
+ * // },
58
64
  * // EnforceWorkGroupConfiguration: true || false,
59
65
  * // PublishCloudWatchMetricsEnabled: true || false,
60
66
  * // BytesScannedCutoffPerQuery: Number("long"),
@@ -55,6 +55,13 @@ declare const UpdateWorkGroupCommand_base: {
55
55
  * },
56
56
  * RemoveAclConfiguration: true || false,
57
57
  * },
58
+ * ManagedQueryResultsConfigurationUpdates: { // ManagedQueryResultsConfigurationUpdates
59
+ * Enabled: true || false,
60
+ * EncryptionConfiguration: { // ManagedQueryResultsEncryptionConfiguration
61
+ * KmsKey: "STRING_VALUE", // required
62
+ * },
63
+ * RemoveEncryptionConfiguration: true || false,
64
+ * },
58
65
  * PublishCloudWatchMetricsEnabled: true || false,
59
66
  * BytesScannedCutoffPerQuery: Number("long"),
60
67
  * RemoveBytesScannedCutoffPerQuery: true || false,
@@ -288,6 +288,43 @@ export interface EngineVersion {
288
288
  */
289
289
  EffectiveEngineVersion?: string | undefined;
290
290
  }
291
+ /**
292
+ * <p>If you encrypt query and calculation results in Athena owned storage, this field
293
+ * indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key
294
+ * information.</p>
295
+ * @public
296
+ */
297
+ export interface ManagedQueryResultsEncryptionConfiguration {
298
+ /**
299
+ * <p>The ARN of an KMS key for encrypting managed query results.</p>
300
+ * @public
301
+ */
302
+ KmsKey: string | undefined;
303
+ }
304
+ /**
305
+ * <p>
306
+ * The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
307
+ * </p>
308
+ * @public
309
+ */
310
+ export interface ManagedQueryResultsConfiguration {
311
+ /**
312
+ * <p>If set to true, allows you to store query results in Athena owned storage. If set to
313
+ * false, workgroup member stores query results in location specified under
314
+ * <code>ResultConfiguration$OutputLocation</code>. The default is false. A workgroup
315
+ * cannot have the <code>ResultConfiguration$OutputLocation</code> parameter when you set
316
+ * this field to true. </p>
317
+ * @public
318
+ */
319
+ Enabled: boolean | undefined;
320
+ /**
321
+ * <p>If you encrypt query and calculation results in Athena owned storage, this field
322
+ * indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key
323
+ * information.</p>
324
+ * @public
325
+ */
326
+ EncryptionConfiguration?: ManagedQueryResultsEncryptionConfiguration | undefined;
327
+ }
291
328
  /**
292
329
  * <p>The database and data catalog context in which the query execution occurs.</p>
293
330
  * @public
@@ -672,11 +709,18 @@ export interface QueryExecution {
672
709
  * <p>The type of query statement that was run. <code>DDL</code> indicates DDL query
673
710
  * statements. <code>DML</code> indicates DML (Data Manipulation Language) query
674
711
  * statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates
675
- * query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>,
676
- * <code>EXPLAIN</code>, <code>DESCRIBE</code>, or <code>SHOW TABLES</code>.</p>
712
+ * query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or
713
+ * <code>DESCRIBE TABLE</code>.</p>
677
714
  * @public
678
715
  */
679
716
  StatementType?: StatementType | undefined;
717
+ /**
718
+ * <p> The configuration for storing results in Athena owned storage, which includes whether
719
+ * this feature is enabled; whether encryption configuration, if any, is used for
720
+ * encrypting query results. </p>
721
+ * @public
722
+ */
723
+ ManagedQueryResultsConfiguration?: ManagedQueryResultsConfiguration | undefined;
680
724
  /**
681
725
  * <p>The location in Amazon S3 where query and calculation results are stored and
682
726
  * the encryption option, if any, used for query results. These are known as "client-side
@@ -1518,6 +1562,13 @@ export interface WorkGroupConfiguration {
1518
1562
  * @public
1519
1563
  */
1520
1564
  ResultConfiguration?: ResultConfiguration | undefined;
1565
+ /**
1566
+ * <p> The configuration for storing results in Athena owned storage, which includes whether
1567
+ * this feature is enabled; whether encryption configuration, if any, is used for
1568
+ * encrypting query results. </p>
1569
+ * @public
1570
+ */
1571
+ ManagedQueryResultsConfiguration?: ManagedQueryResultsConfiguration | undefined;
1521
1572
  /**
1522
1573
  * <p>If set to "true", the settings for the workgroup override client-side settings. If set
1523
1574
  * to "false", client-side settings are used. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>
@@ -2382,6 +2433,18 @@ export interface GetQueryExecutionOutput {
2382
2433
  */
2383
2434
  QueryExecution?: QueryExecution | undefined;
2384
2435
  }
2436
+ /**
2437
+ * @public
2438
+ * @enum
2439
+ */
2440
+ export declare const QueryResultType: {
2441
+ readonly DATA_MANIFEST: "DATA_MANIFEST";
2442
+ readonly DATA_ROWS: "DATA_ROWS";
2443
+ };
2444
+ /**
2445
+ * @public
2446
+ */
2447
+ export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
2385
2448
  /**
2386
2449
  * @public
2387
2450
  */
@@ -2403,6 +2466,15 @@ export interface GetQueryResultsInput {
2403
2466
  * @public
2404
2467
  */
2405
2468
  MaxResults?: number | undefined;
2469
+ /**
2470
+ * <p> When you set this to <code>DATA_ROWS</code> or empty, <code>GetQueryResults</code>
2471
+ * returns the query results in rows. If set to <code>DATA_MANIFEST</code>, it returns the
2472
+ * manifest file in rows. Only the query types <code>CREATE TABLE AS SELECT</code>,
2473
+ * <code>UNLOAD</code>, and <code>INSERT</code> can generate a manifest file. If you
2474
+ * use <code>DATA_MANIFEST</code> for other query types, the query will fail. </p>
2475
+ * @public
2476
+ */
2477
+ QueryResultType?: QueryResultType | undefined;
2406
2478
  }
2407
2479
  /**
2408
2480
  * @public
@@ -4771,6 +4843,32 @@ export interface UpdatePreparedStatementInput {
4771
4843
  */
4772
4844
  export interface UpdatePreparedStatementOutput {
4773
4845
  }
4846
+ /**
4847
+ * <p>Updates the configuration for managed query results.</p>
4848
+ * @public
4849
+ */
4850
+ export interface ManagedQueryResultsConfigurationUpdates {
4851
+ /**
4852
+ * <p>If set to true, specifies that Athena manages query results in Athena owned
4853
+ * storage.</p>
4854
+ * @public
4855
+ */
4856
+ Enabled?: boolean | undefined;
4857
+ /**
4858
+ * <p>If you encrypt query and calculation results in Athena owned storage, this field
4859
+ * indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key
4860
+ * information.</p>
4861
+ * @public
4862
+ */
4863
+ EncryptionConfiguration?: ManagedQueryResultsEncryptionConfiguration | undefined;
4864
+ /**
4865
+ * <p>If set to true, it removes workgroup from Athena owned storage. The existing query
4866
+ * results are cleaned up after 24hrs. You must provide query results in location specified
4867
+ * under <code>ResultConfiguration$OutputLocation</code>.</p>
4868
+ * @public
4869
+ */
4870
+ RemoveEncryptionConfiguration?: boolean | undefined;
4871
+ }
4774
4872
  /**
4775
4873
  * <p>The information about the updates in the query results, such as output location and
4776
4874
  * encryption configuration for the query results.</p>
@@ -4880,6 +4978,11 @@ export interface WorkGroupConfigurationUpdates {
4880
4978
  * @public
4881
4979
  */
4882
4980
  ResultConfigurationUpdates?: ResultConfigurationUpdates | undefined;
4981
+ /**
4982
+ * <p>Updates configuration information for managed query results in the workgroup.</p>
4983
+ * @public
4984
+ */
4985
+ ManagedQueryResultsConfigurationUpdates?: ManagedQueryResultsConfigurationUpdates | undefined;
4883
4986
  /**
4884
4987
  * <p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>
4885
4988
  * @public
@@ -73,6 +73,15 @@ export interface EngineVersion {
73
73
  SelectedEngineVersion?: string | undefined;
74
74
  EffectiveEngineVersion?: string | undefined;
75
75
  }
76
+ export interface ManagedQueryResultsEncryptionConfiguration {
77
+ KmsKey: string | undefined;
78
+ }
79
+ export interface ManagedQueryResultsConfiguration {
80
+ Enabled: boolean | undefined;
81
+ EncryptionConfiguration?:
82
+ | ManagedQueryResultsEncryptionConfiguration
83
+ | undefined;
84
+ }
76
85
  export interface QueryExecutionContext {
77
86
  Database?: string | undefined;
78
87
  Catalog?: string | undefined;
@@ -157,6 +166,9 @@ export interface QueryExecution {
157
166
  QueryExecutionId?: string | undefined;
158
167
  Query?: string | undefined;
159
168
  StatementType?: StatementType | undefined;
169
+ ManagedQueryResultsConfiguration?:
170
+ | ManagedQueryResultsConfiguration
171
+ | undefined;
160
172
  ResultConfiguration?: ResultConfiguration | undefined;
161
173
  ResultReuseConfiguration?: ResultReuseConfiguration | undefined;
162
174
  QueryExecutionContext?: QueryExecutionContext | undefined;
@@ -323,6 +335,9 @@ export interface IdentityCenterConfiguration {
323
335
  }
324
336
  export interface WorkGroupConfiguration {
325
337
  ResultConfiguration?: ResultConfiguration | undefined;
338
+ ManagedQueryResultsConfiguration?:
339
+ | ManagedQueryResultsConfiguration
340
+ | undefined;
326
341
  EnforceWorkGroupConfiguration?: boolean | undefined;
327
342
  PublishCloudWatchMetricsEnabled?: boolean | undefined;
328
343
  BytesScannedCutoffPerQuery?: number | undefined;
@@ -549,10 +564,17 @@ export interface GetQueryExecutionInput {
549
564
  export interface GetQueryExecutionOutput {
550
565
  QueryExecution?: QueryExecution | undefined;
551
566
  }
567
+ export declare const QueryResultType: {
568
+ readonly DATA_MANIFEST: "DATA_MANIFEST";
569
+ readonly DATA_ROWS: "DATA_ROWS";
570
+ };
571
+ export type QueryResultType =
572
+ (typeof QueryResultType)[keyof typeof QueryResultType];
552
573
  export interface GetQueryResultsInput {
553
574
  QueryExecutionId: string | undefined;
554
575
  NextToken?: string | undefined;
555
576
  MaxResults?: number | undefined;
577
+ QueryResultType?: QueryResultType | undefined;
556
578
  }
557
579
  export declare const ColumnNullable: {
558
580
  readonly NOT_NULL: "NOT_NULL";
@@ -1049,6 +1071,13 @@ export interface UpdatePreparedStatementInput {
1049
1071
  Description?: string | undefined;
1050
1072
  }
1051
1073
  export interface UpdatePreparedStatementOutput {}
1074
+ export interface ManagedQueryResultsConfigurationUpdates {
1075
+ Enabled?: boolean | undefined;
1076
+ EncryptionConfiguration?:
1077
+ | ManagedQueryResultsEncryptionConfiguration
1078
+ | undefined;
1079
+ RemoveEncryptionConfiguration?: boolean | undefined;
1080
+ }
1052
1081
  export interface ResultConfigurationUpdates {
1053
1082
  OutputLocation?: string | undefined;
1054
1083
  RemoveOutputLocation?: boolean | undefined;
@@ -1062,6 +1091,9 @@ export interface ResultConfigurationUpdates {
1062
1091
  export interface WorkGroupConfigurationUpdates {
1063
1092
  EnforceWorkGroupConfiguration?: boolean | undefined;
1064
1093
  ResultConfigurationUpdates?: ResultConfigurationUpdates | undefined;
1094
+ ManagedQueryResultsConfigurationUpdates?:
1095
+ | ManagedQueryResultsConfigurationUpdates
1096
+ | undefined;
1065
1097
  PublishCloudWatchMetricsEnabled?: boolean | undefined;
1066
1098
  BytesScannedCutoffPerQuery?: number | undefined;
1067
1099
  RemoveBytesScannedCutoffPerQuery?: boolean | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-athena",
3
3
  "description": "AWS SDK for JavaScript Athena Client for Node.js, Browser and React Native",
4
- "version": "3.817.0",
4
+ "version": "3.822.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-athena",
@@ -20,41 +20,41 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.816.0",
24
- "@aws-sdk/credential-provider-node": "3.817.0",
25
- "@aws-sdk/middleware-host-header": "3.804.0",
26
- "@aws-sdk/middleware-logger": "3.804.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.804.0",
28
- "@aws-sdk/middleware-user-agent": "3.816.0",
29
- "@aws-sdk/region-config-resolver": "3.808.0",
30
- "@aws-sdk/types": "3.804.0",
31
- "@aws-sdk/util-endpoints": "3.808.0",
32
- "@aws-sdk/util-user-agent-browser": "3.804.0",
33
- "@aws-sdk/util-user-agent-node": "3.816.0",
34
- "@smithy/config-resolver": "^4.1.2",
35
- "@smithy/core": "^3.3.3",
36
- "@smithy/fetch-http-handler": "^5.0.2",
37
- "@smithy/hash-node": "^4.0.2",
38
- "@smithy/invalid-dependency": "^4.0.2",
39
- "@smithy/middleware-content-length": "^4.0.2",
40
- "@smithy/middleware-endpoint": "^4.1.6",
41
- "@smithy/middleware-retry": "^4.1.7",
42
- "@smithy/middleware-serde": "^4.0.5",
43
- "@smithy/middleware-stack": "^4.0.2",
44
- "@smithy/node-config-provider": "^4.1.1",
45
- "@smithy/node-http-handler": "^4.0.4",
46
- "@smithy/protocol-http": "^5.1.0",
47
- "@smithy/smithy-client": "^4.2.6",
48
- "@smithy/types": "^4.2.0",
49
- "@smithy/url-parser": "^4.0.2",
23
+ "@aws-sdk/core": "3.821.0",
24
+ "@aws-sdk/credential-provider-node": "3.821.0",
25
+ "@aws-sdk/middleware-host-header": "3.821.0",
26
+ "@aws-sdk/middleware-logger": "3.821.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.821.0",
28
+ "@aws-sdk/middleware-user-agent": "3.821.0",
29
+ "@aws-sdk/region-config-resolver": "3.821.0",
30
+ "@aws-sdk/types": "3.821.0",
31
+ "@aws-sdk/util-endpoints": "3.821.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.821.0",
33
+ "@aws-sdk/util-user-agent-node": "3.821.0",
34
+ "@smithy/config-resolver": "^4.1.4",
35
+ "@smithy/core": "^3.5.1",
36
+ "@smithy/fetch-http-handler": "^5.0.4",
37
+ "@smithy/hash-node": "^4.0.4",
38
+ "@smithy/invalid-dependency": "^4.0.4",
39
+ "@smithy/middleware-content-length": "^4.0.4",
40
+ "@smithy/middleware-endpoint": "^4.1.9",
41
+ "@smithy/middleware-retry": "^4.1.10",
42
+ "@smithy/middleware-serde": "^4.0.8",
43
+ "@smithy/middleware-stack": "^4.0.4",
44
+ "@smithy/node-config-provider": "^4.1.3",
45
+ "@smithy/node-http-handler": "^4.0.6",
46
+ "@smithy/protocol-http": "^5.1.2",
47
+ "@smithy/smithy-client": "^4.4.1",
48
+ "@smithy/types": "^4.3.1",
49
+ "@smithy/url-parser": "^4.0.4",
50
50
  "@smithy/util-base64": "^4.0.0",
51
51
  "@smithy/util-body-length-browser": "^4.0.0",
52
52
  "@smithy/util-body-length-node": "^4.0.0",
53
- "@smithy/util-defaults-mode-browser": "^4.0.14",
54
- "@smithy/util-defaults-mode-node": "^4.0.14",
55
- "@smithy/util-endpoints": "^3.0.4",
56
- "@smithy/util-middleware": "^4.0.2",
57
- "@smithy/util-retry": "^4.0.3",
53
+ "@smithy/util-defaults-mode-browser": "^4.0.17",
54
+ "@smithy/util-defaults-mode-node": "^4.0.17",
55
+ "@smithy/util-endpoints": "^3.0.6",
56
+ "@smithy/util-middleware": "^4.0.4",
57
+ "@smithy/util-retry": "^4.0.5",
58
58
  "@smithy/util-utf8": "^4.0.0",
59
59
  "@types/uuid": "^9.0.1",
60
60
  "tslib": "^2.6.2",