@aws-sdk/client-athena 3.465.0 → 3.467.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/models/models_0.js +4 -1
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/models/models_0.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +5 -0
- package/dist-types/commands/CreateWorkGroupCommand.d.ts +9 -0
- package/dist-types/commands/GetDataCatalogCommand.d.ts +1 -0
- package/dist-types/commands/GetDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/GetQueryExecutionCommand.d.ts +5 -0
- package/dist-types/commands/GetTableMetadataCommand.d.ts +1 -0
- package/dist-types/commands/GetWorkGroupCommand.d.ts +10 -0
- package/dist-types/commands/ListDataCatalogsCommand.d.ts +1 -0
- package/dist-types/commands/ListDatabasesCommand.d.ts +1 -0
- package/dist-types/commands/ListQueryExecutionsCommand.d.ts +3 -3
- package/dist-types/commands/ListTableMetadataCommand.d.ts +1 -0
- package/dist-types/commands/ListWorkGroupsCommand.d.ts +1 -0
- package/dist-types/commands/StartCalculationExecutionCommand.d.ts +4 -5
- package/dist-types/commands/UpdateWorkGroupCommand.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +139 -10
- package/dist-types/ts3.4/models/models_0.d.ts +26 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SessionAlreadyExistsException = exports.ExecutorType = exports.ExecutorState = exports.WorkGroupState = exports.SessionState = exports.ColumnNullable = exports.MetadataException = exports.CapacityReservationStatus = exports.CapacityAllocationStatus = exports.CalculationExecutionState = exports.NotebookType = exports.ResourceNotFoundException = exports.TooManyRequestsException = exports.ThrottleReason = exports.DataCatalogType = exports.QueryExecutionState = exports.StatementType = exports.EncryptionOption = exports.InvalidRequestException = exports.InternalServerException = exports.S3AclOption = void 0;
|
|
3
|
+
exports.SessionAlreadyExistsException = exports.ExecutorType = exports.ExecutorState = exports.WorkGroupState = exports.SessionState = exports.ColumnNullable = exports.MetadataException = exports.CapacityReservationStatus = exports.CapacityAllocationStatus = exports.CalculationExecutionState = exports.NotebookType = exports.ResourceNotFoundException = exports.TooManyRequestsException = exports.ThrottleReason = exports.DataCatalogType = exports.QueryExecutionState = exports.StatementType = exports.EncryptionOption = exports.AuthenticationType = exports.InvalidRequestException = exports.InternalServerException = exports.S3AclOption = void 0;
|
|
4
4
|
const AthenaServiceException_1 = require("./AthenaServiceException");
|
|
5
5
|
exports.S3AclOption = {
|
|
6
6
|
BUCKET_OWNER_FULL_CONTROL: "BUCKET_OWNER_FULL_CONTROL",
|
|
@@ -34,6 +34,9 @@ class InvalidRequestException extends AthenaServiceException_1.AthenaServiceExce
|
|
|
34
34
|
}
|
|
35
35
|
}
|
|
36
36
|
exports.InvalidRequestException = InvalidRequestException;
|
|
37
|
+
exports.AuthenticationType = {
|
|
38
|
+
DIRECTORY_IDENTITY: "DIRECTORY_IDENTITY",
|
|
39
|
+
};
|
|
37
40
|
exports.EncryptionOption = {
|
|
38
41
|
CSE_KMS: "CSE_KMS",
|
|
39
42
|
SSE_KMS: "SSE_KMS",
|
|
@@ -3385,6 +3385,7 @@ const de_QueryExecution = (output, context) => {
|
|
|
3385
3385
|
Query: smithy_client_1.expectString,
|
|
3386
3386
|
QueryExecutionContext: smithy_client_1._json,
|
|
3387
3387
|
QueryExecutionId: smithy_client_1.expectString,
|
|
3388
|
+
QueryResultsS3AccessGrantsConfiguration: smithy_client_1._json,
|
|
3388
3389
|
ResultConfiguration: smithy_client_1._json,
|
|
3389
3390
|
ResultReuseConfiguration: smithy_client_1._json,
|
|
3390
3391
|
StatementType: smithy_client_1.expectString,
|
|
@@ -3506,6 +3507,7 @@ const de_WorkGroup = (output, context) => {
|
|
|
3506
3507
|
Configuration: smithy_client_1._json,
|
|
3507
3508
|
CreationTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
3508
3509
|
Description: smithy_client_1.expectString,
|
|
3510
|
+
IdentityCenterApplicationArn: smithy_client_1.expectString,
|
|
3509
3511
|
Name: smithy_client_1.expectString,
|
|
3510
3512
|
State: smithy_client_1.expectString,
|
|
3511
3513
|
});
|
|
@@ -3523,6 +3525,7 @@ const de_WorkGroupSummary = (output, context) => {
|
|
|
3523
3525
|
CreationTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
3524
3526
|
Description: smithy_client_1.expectString,
|
|
3525
3527
|
EngineVersion: smithy_client_1._json,
|
|
3528
|
+
IdentityCenterApplicationArn: smithy_client_1.expectString,
|
|
3526
3529
|
Name: smithy_client_1.expectString,
|
|
3527
3530
|
State: smithy_client_1.expectString,
|
|
3528
3531
|
});
|
|
@@ -29,6 +29,9 @@ export class InvalidRequestException extends __BaseException {
|
|
|
29
29
|
this.Message = opts.Message;
|
|
30
30
|
}
|
|
31
31
|
}
|
|
32
|
+
export const AuthenticationType = {
|
|
33
|
+
DIRECTORY_IDENTITY: "DIRECTORY_IDENTITY",
|
|
34
|
+
};
|
|
32
35
|
export const EncryptionOption = {
|
|
33
36
|
CSE_KMS: "CSE_KMS",
|
|
34
37
|
SSE_KMS: "SSE_KMS",
|
|
@@ -3244,6 +3244,7 @@ const de_QueryExecution = (output, context) => {
|
|
|
3244
3244
|
Query: __expectString,
|
|
3245
3245
|
QueryExecutionContext: _json,
|
|
3246
3246
|
QueryExecutionId: __expectString,
|
|
3247
|
+
QueryResultsS3AccessGrantsConfiguration: _json,
|
|
3247
3248
|
ResultConfiguration: _json,
|
|
3248
3249
|
ResultReuseConfiguration: _json,
|
|
3249
3250
|
StatementType: __expectString,
|
|
@@ -3365,6 +3366,7 @@ const de_WorkGroup = (output, context) => {
|
|
|
3365
3366
|
Configuration: _json,
|
|
3366
3367
|
CreationTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
3367
3368
|
Description: __expectString,
|
|
3369
|
+
IdentityCenterApplicationArn: __expectString,
|
|
3368
3370
|
Name: __expectString,
|
|
3369
3371
|
State: __expectString,
|
|
3370
3372
|
});
|
|
@@ -3382,6 +3384,7 @@ const de_WorkGroupSummary = (output, context) => {
|
|
|
3382
3384
|
CreationTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
3383
3385
|
Description: __expectString,
|
|
3384
3386
|
EngineVersion: _json,
|
|
3387
|
+
IdentityCenterApplicationArn: __expectString,
|
|
3385
3388
|
Name: __expectString,
|
|
3386
3389
|
State: __expectString,
|
|
3387
3390
|
});
|
|
@@ -103,6 +103,11 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
|
|
|
103
103
|
* // "STRING_VALUE",
|
|
104
104
|
* // ],
|
|
105
105
|
* // SubstatementType: "STRING_VALUE",
|
|
106
|
+
* // QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
|
|
107
|
+
* // EnableS3AccessGrants: true || false, // required
|
|
108
|
+
* // CreateUserLevelPrefix: true || false,
|
|
109
|
+
* // AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
110
|
+
* // },
|
|
106
111
|
* // },
|
|
107
112
|
* // ],
|
|
108
113
|
* // UnprocessedQueryExecutionIds: [ // UnprocessedQueryExecutionIdList
|
|
@@ -59,6 +59,15 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
|
|
|
59
59
|
* KmsKey: "STRING_VALUE", // required
|
|
60
60
|
* },
|
|
61
61
|
* EnableMinimumEncryptionConfiguration: true || false,
|
|
62
|
+
* IdentityCenterConfiguration: { // IdentityCenterConfiguration
|
|
63
|
+
* EnableIdentityCenter: true || false,
|
|
64
|
+
* IdentityCenterInstanceArn: "STRING_VALUE",
|
|
65
|
+
* },
|
|
66
|
+
* QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
|
|
67
|
+
* EnableS3AccessGrants: true || false, // required
|
|
68
|
+
* CreateUserLevelPrefix: true || false,
|
|
69
|
+
* AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
70
|
+
* },
|
|
62
71
|
* },
|
|
63
72
|
* Description: "STRING_VALUE",
|
|
64
73
|
* Tags: [ // TagList
|
|
@@ -32,6 +32,7 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
|
|
|
32
32
|
* const client = new AthenaClient(config);
|
|
33
33
|
* const input = { // GetDataCatalogInput
|
|
34
34
|
* Name: "STRING_VALUE", // required
|
|
35
|
+
* WorkGroup: "STRING_VALUE",
|
|
35
36
|
* };
|
|
36
37
|
* const command = new GetDataCatalogCommand(input);
|
|
37
38
|
* const response = await client.send(command);
|
|
@@ -33,6 +33,7 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
|
|
|
33
33
|
* const input = { // GetDatabaseInput
|
|
34
34
|
* CatalogName: "STRING_VALUE", // required
|
|
35
35
|
* DatabaseName: "STRING_VALUE", // required
|
|
36
|
+
* WorkGroup: "STRING_VALUE",
|
|
36
37
|
* };
|
|
37
38
|
* const command = new GetDatabaseCommand(input);
|
|
38
39
|
* const response = await client.send(command);
|
|
@@ -97,6 +97,11 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput,
|
|
|
97
97
|
* // "STRING_VALUE",
|
|
98
98
|
* // ],
|
|
99
99
|
* // SubstatementType: "STRING_VALUE",
|
|
100
|
+
* // QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
|
|
101
|
+
* // EnableS3AccessGrants: true || false, // required
|
|
102
|
+
* // CreateUserLevelPrefix: true || false,
|
|
103
|
+
* // AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
104
|
+
* // },
|
|
100
105
|
* // },
|
|
101
106
|
* // };
|
|
102
107
|
*
|
|
@@ -34,6 +34,7 @@ export interface GetTableMetadataCommandOutput extends GetTableMetadataOutput, _
|
|
|
34
34
|
* CatalogName: "STRING_VALUE", // required
|
|
35
35
|
* DatabaseName: "STRING_VALUE", // required
|
|
36
36
|
* TableName: "STRING_VALUE", // required
|
|
37
|
+
* WorkGroup: "STRING_VALUE",
|
|
37
38
|
* };
|
|
38
39
|
* const command = new GetTableMetadataCommand(input);
|
|
39
40
|
* const response = await client.send(command);
|
|
@@ -65,9 +65,19 @@ export interface GetWorkGroupCommandOutput extends GetWorkGroupOutput, __Metadat
|
|
|
65
65
|
* // KmsKey: "STRING_VALUE", // required
|
|
66
66
|
* // },
|
|
67
67
|
* // EnableMinimumEncryptionConfiguration: true || false,
|
|
68
|
+
* // IdentityCenterConfiguration: { // IdentityCenterConfiguration
|
|
69
|
+
* // EnableIdentityCenter: true || false,
|
|
70
|
+
* // IdentityCenterInstanceArn: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
|
|
73
|
+
* // EnableS3AccessGrants: true || false, // required
|
|
74
|
+
* // CreateUserLevelPrefix: true || false,
|
|
75
|
+
* // AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
76
|
+
* // },
|
|
68
77
|
* // },
|
|
69
78
|
* // Description: "STRING_VALUE",
|
|
70
79
|
* // CreationTime: new Date("TIMESTAMP"),
|
|
80
|
+
* // IdentityCenterApplicationArn: "STRING_VALUE",
|
|
71
81
|
* // },
|
|
72
82
|
* // };
|
|
73
83
|
*
|
|
@@ -37,6 +37,7 @@ export interface ListDataCatalogsCommandOutput extends ListDataCatalogsOutput, _
|
|
|
37
37
|
* const input = { // ListDataCatalogsInput
|
|
38
38
|
* NextToken: "STRING_VALUE",
|
|
39
39
|
* MaxResults: Number("int"),
|
|
40
|
+
* WorkGroup: "STRING_VALUE",
|
|
40
41
|
* };
|
|
41
42
|
* const command = new ListDataCatalogsCommand(input);
|
|
42
43
|
* const response = await client.send(command);
|
|
@@ -34,6 +34,7 @@ export interface ListDatabasesCommandOutput extends ListDatabasesOutput, __Metad
|
|
|
34
34
|
* CatalogName: "STRING_VALUE", // required
|
|
35
35
|
* NextToken: "STRING_VALUE",
|
|
36
36
|
* MaxResults: Number("int"),
|
|
37
|
+
* WorkGroup: "STRING_VALUE",
|
|
37
38
|
* };
|
|
38
39
|
* const command = new ListDatabasesCommand(input);
|
|
39
40
|
* const response = await client.send(command);
|
|
@@ -24,9 +24,9 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Provides a list of available query execution IDs for the queries in the specified
|
|
27
|
-
* workgroup. Athena keeps a query history for 45 days. If a workgroup is not
|
|
28
|
-
*
|
|
29
|
-
* ran.</p>
|
|
27
|
+
* workgroup. Athena keeps a query history for 45 days. If a workgroup is not
|
|
28
|
+
* specified, returns a list of query execution IDs for the primary workgroup. Requires you
|
|
29
|
+
* to have access to the workgroup in which the queries ran.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -36,6 +36,7 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
|
|
|
36
36
|
* Expression: "STRING_VALUE",
|
|
37
37
|
* NextToken: "STRING_VALUE",
|
|
38
38
|
* MaxResults: Number("int"),
|
|
39
|
+
* WorkGroup: "STRING_VALUE",
|
|
39
40
|
* };
|
|
40
41
|
* const command = new ListTableMetadataCommand(input);
|
|
41
42
|
* const response = await client.send(command);
|
|
@@ -47,6 +47,7 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
|
|
|
47
47
|
* // SelectedEngineVersion: "STRING_VALUE",
|
|
48
48
|
* // EffectiveEngineVersion: "STRING_VALUE",
|
|
49
49
|
* // },
|
|
50
|
+
* // IdentityCenterApplicationArn: "STRING_VALUE",
|
|
50
51
|
* // },
|
|
51
52
|
* // ],
|
|
52
53
|
* // NextToken: "STRING_VALUE",
|
|
@@ -26,11 +26,10 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
|
|
|
26
26
|
* <p>Submits calculations for execution within a session. You can supply the code to run as
|
|
27
27
|
* an inline code block within the request.</p>
|
|
28
28
|
* <note>
|
|
29
|
-
* <p>The request syntax requires the
|
|
30
|
-
*
|
|
31
|
-
* parameter
|
|
32
|
-
*
|
|
33
|
-
* <a>StartCalculationExecutionRequest$CodeBlock</a> parameter instead.</p>
|
|
29
|
+
* <p>The request syntax requires the <a>StartCalculationExecutionRequest$CodeBlock</a> parameter or the <a>CalculationConfiguration$CodeBlock</a> parameter, but not both. Because
|
|
30
|
+
* <a>CalculationConfiguration$CodeBlock</a> is deprecated, use the
|
|
31
|
+
* <a>StartCalculationExecutionRequest$CodeBlock</a> parameter
|
|
32
|
+
* instead.</p>
|
|
34
33
|
* </note>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -66,6 +66,11 @@ export interface UpdateWorkGroupCommandOutput extends UpdateWorkGroupOutput, __M
|
|
|
66
66
|
* KmsKey: "STRING_VALUE", // required
|
|
67
67
|
* },
|
|
68
68
|
* EnableMinimumEncryptionConfiguration: true || false,
|
|
69
|
+
* QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
|
|
70
|
+
* EnableS3AccessGrants: true || false, // required
|
|
71
|
+
* CreateUserLevelPrefix: true || false,
|
|
72
|
+
* AuthenticationType: "DIRECTORY_IDENTITY", // required
|
|
73
|
+
* },
|
|
69
74
|
* },
|
|
70
75
|
* State: "ENABLED" || "DISABLED",
|
|
71
76
|
* };
|
|
@@ -303,6 +303,42 @@ export interface QueryExecutionContext {
|
|
|
303
303
|
*/
|
|
304
304
|
Catalog?: string;
|
|
305
305
|
}
|
|
306
|
+
/**
|
|
307
|
+
* @public
|
|
308
|
+
* @enum
|
|
309
|
+
*/
|
|
310
|
+
export declare const AuthenticationType: {
|
|
311
|
+
readonly DIRECTORY_IDENTITY: "DIRECTORY_IDENTITY";
|
|
312
|
+
};
|
|
313
|
+
/**
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
320
|
+
* results.</p>
|
|
321
|
+
*/
|
|
322
|
+
export interface QueryResultsS3AccessGrantsConfiguration {
|
|
323
|
+
/**
|
|
324
|
+
* @public
|
|
325
|
+
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
326
|
+
* results.</p>
|
|
327
|
+
*/
|
|
328
|
+
EnableS3AccessGrants: boolean | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* @public
|
|
331
|
+
* <p>When enabled, appends the user ID as an Amazon S3 path prefix to the query
|
|
332
|
+
* result output location.</p>
|
|
333
|
+
*/
|
|
334
|
+
CreateUserLevelPrefix?: boolean;
|
|
335
|
+
/**
|
|
336
|
+
* @public
|
|
337
|
+
* <p>The authentication type used for Amazon S3 access grants. Currently, only
|
|
338
|
+
* <code>DIRECTORY_IDENTITY</code> is supported.</p>
|
|
339
|
+
*/
|
|
340
|
+
AuthenticationType: AuthenticationType | undefined;
|
|
341
|
+
}
|
|
306
342
|
/**
|
|
307
343
|
* @public
|
|
308
344
|
* @enum
|
|
@@ -692,6 +728,12 @@ export interface QueryExecution {
|
|
|
692
728
|
* <p>The kind of query statement that was run.</p>
|
|
693
729
|
*/
|
|
694
730
|
SubstatementType?: string;
|
|
731
|
+
/**
|
|
732
|
+
* @public
|
|
733
|
+
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
734
|
+
* results.</p>
|
|
735
|
+
*/
|
|
736
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
695
737
|
}
|
|
696
738
|
/**
|
|
697
739
|
* @public
|
|
@@ -1125,6 +1167,22 @@ export interface CustomerContentEncryptionConfiguration {
|
|
|
1125
1167
|
*/
|
|
1126
1168
|
KmsKey: string | undefined;
|
|
1127
1169
|
}
|
|
1170
|
+
/**
|
|
1171
|
+
* @public
|
|
1172
|
+
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1173
|
+
*/
|
|
1174
|
+
export interface IdentityCenterConfiguration {
|
|
1175
|
+
/**
|
|
1176
|
+
* @public
|
|
1177
|
+
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1178
|
+
*/
|
|
1179
|
+
EnableIdentityCenter?: boolean;
|
|
1180
|
+
/**
|
|
1181
|
+
* @public
|
|
1182
|
+
* <p>The IAM Identity Center instance ARN that the workgroup associates to.</p>
|
|
1183
|
+
*/
|
|
1184
|
+
IdentityCenterInstanceArn?: string;
|
|
1185
|
+
}
|
|
1128
1186
|
/**
|
|
1129
1187
|
* @public
|
|
1130
1188
|
* <p>The configuration of the workgroup, which includes the location in Amazon S3
|
|
@@ -1188,8 +1246,9 @@ export interface WorkGroupConfiguration {
|
|
|
1188
1246
|
AdditionalConfiguration?: string;
|
|
1189
1247
|
/**
|
|
1190
1248
|
* @public
|
|
1191
|
-
* <p>
|
|
1192
|
-
* only to Spark
|
|
1249
|
+
* <p>The ARN of the execution role used to access user resources for Spark sessions and Identity Center
|
|
1250
|
+
* enabled workgroups. This property applies only to Spark enabled workgroups and Identity
|
|
1251
|
+
* Center enabled workgroups.</p>
|
|
1193
1252
|
*/
|
|
1194
1253
|
ExecutionRole?: string;
|
|
1195
1254
|
/**
|
|
@@ -1210,6 +1269,17 @@ export interface WorkGroupConfiguration {
|
|
|
1210
1269
|
* configuration for encryption is used.</p>
|
|
1211
1270
|
*/
|
|
1212
1271
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
1272
|
+
/**
|
|
1273
|
+
* @public
|
|
1274
|
+
* <p>Specifies whether the workgroup is IAM Identity Center supported.</p>
|
|
1275
|
+
*/
|
|
1276
|
+
IdentityCenterConfiguration?: IdentityCenterConfiguration;
|
|
1277
|
+
/**
|
|
1278
|
+
* @public
|
|
1279
|
+
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
1280
|
+
* results.</p>
|
|
1281
|
+
*/
|
|
1282
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
1213
1283
|
}
|
|
1214
1284
|
/**
|
|
1215
1285
|
* @public
|
|
@@ -1813,6 +1883,12 @@ export interface GetDatabaseInput {
|
|
|
1813
1883
|
* <p>The name of the database to return.</p>
|
|
1814
1884
|
*/
|
|
1815
1885
|
DatabaseName: string | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* @public
|
|
1888
|
+
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
1889
|
+
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
1890
|
+
*/
|
|
1891
|
+
WorkGroup?: string;
|
|
1816
1892
|
}
|
|
1817
1893
|
/**
|
|
1818
1894
|
* @public
|
|
@@ -1872,6 +1948,11 @@ export interface GetDataCatalogInput {
|
|
|
1872
1948
|
* <p>The name of the data catalog to return.</p>
|
|
1873
1949
|
*/
|
|
1874
1950
|
Name: string | undefined;
|
|
1951
|
+
/**
|
|
1952
|
+
* @public
|
|
1953
|
+
* <p>The name of the workgroup. Required if making an IAM Identity Center request.</p>
|
|
1954
|
+
*/
|
|
1955
|
+
WorkGroup?: string;
|
|
1875
1956
|
}
|
|
1876
1957
|
/**
|
|
1877
1958
|
* @public
|
|
@@ -2144,7 +2225,7 @@ export interface ColumnInfo {
|
|
|
2144
2225
|
Scale?: number;
|
|
2145
2226
|
/**
|
|
2146
2227
|
* @public
|
|
2147
|
-
* <p>
|
|
2228
|
+
* <p>Unsupported constraint. This value always shows as <code>UNKNOWN</code>.</p>
|
|
2148
2229
|
*/
|
|
2149
2230
|
Nullable?: ColumnNullable;
|
|
2150
2231
|
/**
|
|
@@ -2368,8 +2449,9 @@ export interface EngineConfiguration {
|
|
|
2368
2449
|
export interface SessionConfiguration {
|
|
2369
2450
|
/**
|
|
2370
2451
|
* @public
|
|
2371
|
-
* <p>The ARN of the execution role used
|
|
2372
|
-
* property applies only to Spark
|
|
2452
|
+
* <p>The ARN of the execution role used to access user resources for Spark sessions and Identity Center
|
|
2453
|
+
* enabled workgroups. This property applies only to Spark enabled workgroups and Identity
|
|
2454
|
+
* Center enabled workgroups.</p>
|
|
2373
2455
|
*/
|
|
2374
2456
|
ExecutionRole?: string;
|
|
2375
2457
|
/**
|
|
@@ -2572,6 +2654,12 @@ export interface GetTableMetadataInput {
|
|
|
2572
2654
|
* <p>The name of the table for which metadata is returned.</p>
|
|
2573
2655
|
*/
|
|
2574
2656
|
TableName: string | undefined;
|
|
2657
|
+
/**
|
|
2658
|
+
* @public
|
|
2659
|
+
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
2660
|
+
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
2661
|
+
*/
|
|
2662
|
+
WorkGroup?: string;
|
|
2575
2663
|
}
|
|
2576
2664
|
/**
|
|
2577
2665
|
* @public
|
|
@@ -2711,6 +2799,12 @@ export interface WorkGroup {
|
|
|
2711
2799
|
* <p>The date and time the workgroup was created.</p>
|
|
2712
2800
|
*/
|
|
2713
2801
|
CreationTime?: Date;
|
|
2802
|
+
/**
|
|
2803
|
+
* @public
|
|
2804
|
+
* <p>The ARN of the IAM Identity Center enabled application associated with the
|
|
2805
|
+
* workgroup.</p>
|
|
2806
|
+
*/
|
|
2807
|
+
IdentityCenterApplicationArn?: string;
|
|
2714
2808
|
}
|
|
2715
2809
|
/**
|
|
2716
2810
|
* @public
|
|
@@ -2958,6 +3052,12 @@ export interface ListDatabasesInput {
|
|
|
2958
3052
|
* <p>Specifies the maximum number of results to return.</p>
|
|
2959
3053
|
*/
|
|
2960
3054
|
MaxResults?: number;
|
|
3055
|
+
/**
|
|
3056
|
+
* @public
|
|
3057
|
+
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
3058
|
+
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
3059
|
+
*/
|
|
3060
|
+
WorkGroup?: string;
|
|
2961
3061
|
}
|
|
2962
3062
|
/**
|
|
2963
3063
|
* @public
|
|
@@ -2992,6 +3092,12 @@ export interface ListDataCatalogsInput {
|
|
|
2992
3092
|
* <p>Specifies the maximum number of data catalogs to return.</p>
|
|
2993
3093
|
*/
|
|
2994
3094
|
MaxResults?: number;
|
|
3095
|
+
/**
|
|
3096
|
+
* @public
|
|
3097
|
+
* <p>The name of the workgroup. Required if
|
|
3098
|
+
* making an IAM Identity Center request.</p>
|
|
3099
|
+
*/
|
|
3100
|
+
WorkGroup?: string;
|
|
2995
3101
|
}
|
|
2996
3102
|
/**
|
|
2997
3103
|
* @public
|
|
@@ -3576,6 +3682,12 @@ export interface ListTableMetadataInput {
|
|
|
3576
3682
|
* <p>Specifies the maximum number of results to return.</p>
|
|
3577
3683
|
*/
|
|
3578
3684
|
MaxResults?: number;
|
|
3685
|
+
/**
|
|
3686
|
+
* @public
|
|
3687
|
+
* <p>The name of the workgroup for which the metadata is being fetched. Required if
|
|
3688
|
+
* requesting an IAM Identity Center enabled Glue Data Catalog.</p>
|
|
3689
|
+
*/
|
|
3690
|
+
WorkGroup?: string;
|
|
3579
3691
|
}
|
|
3580
3692
|
/**
|
|
3581
3693
|
* @public
|
|
@@ -3682,6 +3794,12 @@ export interface WorkGroupSummary {
|
|
|
3682
3794
|
* regardless of this setting.</p>
|
|
3683
3795
|
*/
|
|
3684
3796
|
EngineVersion?: EngineVersion;
|
|
3797
|
+
/**
|
|
3798
|
+
* @public
|
|
3799
|
+
* <p>The ARN of the IAM Identity Center enabled application associated with the
|
|
3800
|
+
* workgroup.</p>
|
|
3801
|
+
*/
|
|
3802
|
+
IdentityCenterApplicationArn?: string;
|
|
3685
3803
|
}
|
|
3686
3804
|
/**
|
|
3687
3805
|
* @public
|
|
@@ -3756,7 +3874,8 @@ export interface StartCalculationExecutionRequest {
|
|
|
3756
3874
|
CalculationConfiguration?: CalculationConfiguration;
|
|
3757
3875
|
/**
|
|
3758
3876
|
* @public
|
|
3759
|
-
* <p>A string that contains the code of the calculation. Use this parameter instead of
|
|
3877
|
+
* <p>A string that contains the code of the calculation. Use this parameter instead of
|
|
3878
|
+
* <a>CalculationConfiguration$CodeBlock</a>, which is deprecated.</p>
|
|
3760
3879
|
*/
|
|
3761
3880
|
CodeBlock?: string;
|
|
3762
3881
|
/**
|
|
@@ -3820,8 +3939,11 @@ export interface StartQueryExecutionInput {
|
|
|
3820
3939
|
* @public
|
|
3821
3940
|
* <p>A unique case-sensitive string used to ensure the request to create the query is
|
|
3822
3941
|
* idempotent (executes only once). If another <code>StartQueryExecution</code> request is
|
|
3823
|
-
* received, the same response is returned and another query is not created.
|
|
3824
|
-
*
|
|
3942
|
+
* received, the same response is returned and another query is not created. An error is
|
|
3943
|
+
* returned if a parameter, such as <code>QueryString</code>, has changed. A call to
|
|
3944
|
+
* <code>StartQueryExecution</code> that uses a previous client request token returns
|
|
3945
|
+
* the same <code>QueryExecutionId</code> even if the requester doesn't have permission on
|
|
3946
|
+
* the tables specified in <code>QueryString</code>.</p>
|
|
3825
3947
|
* <important>
|
|
3826
3948
|
* <p>This token is listed as not required because Amazon Web Services SDKs (for example
|
|
3827
3949
|
* the Amazon Web Services SDK for Java) auto-generate the token for users. If you are
|
|
@@ -4483,8 +4605,9 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
4483
4605
|
AdditionalConfiguration?: string;
|
|
4484
4606
|
/**
|
|
4485
4607
|
* @public
|
|
4486
|
-
* <p>The ARN of the execution role used to access user resources
|
|
4487
|
-
* only to Spark
|
|
4608
|
+
* <p>The ARN of the execution role used to access user resources for Spark sessions and Identity Center
|
|
4609
|
+
* enabled workgroups. This property applies only to Spark enabled workgroups and Identity
|
|
4610
|
+
* Center enabled workgroups.</p>
|
|
4488
4611
|
*/
|
|
4489
4612
|
ExecutionRole?: string;
|
|
4490
4613
|
/**
|
|
@@ -4507,6 +4630,12 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
4507
4630
|
* configuration for encryption is used.</p>
|
|
4508
4631
|
*/
|
|
4509
4632
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
4633
|
+
/**
|
|
4634
|
+
* @public
|
|
4635
|
+
* <p>Specifies whether Amazon S3 access grants are enabled for query
|
|
4636
|
+
* results.</p>
|
|
4637
|
+
*/
|
|
4638
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
4510
4639
|
}
|
|
4511
4640
|
/**
|
|
4512
4641
|
* @public
|
|
@@ -75,6 +75,16 @@ export interface QueryExecutionContext {
|
|
|
75
75
|
Database?: string;
|
|
76
76
|
Catalog?: string;
|
|
77
77
|
}
|
|
78
|
+
export declare const AuthenticationType: {
|
|
79
|
+
readonly DIRECTORY_IDENTITY: "DIRECTORY_IDENTITY";
|
|
80
|
+
};
|
|
81
|
+
export type AuthenticationType =
|
|
82
|
+
(typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
83
|
+
export interface QueryResultsS3AccessGrantsConfiguration {
|
|
84
|
+
EnableS3AccessGrants: boolean | undefined;
|
|
85
|
+
CreateUserLevelPrefix?: boolean;
|
|
86
|
+
AuthenticationType: AuthenticationType | undefined;
|
|
87
|
+
}
|
|
78
88
|
export declare const EncryptionOption: {
|
|
79
89
|
readonly CSE_KMS: "CSE_KMS";
|
|
80
90
|
readonly SSE_KMS: "SSE_KMS";
|
|
@@ -154,6 +164,7 @@ export interface QueryExecution {
|
|
|
154
164
|
EngineVersion?: EngineVersion;
|
|
155
165
|
ExecutionParameters?: string[];
|
|
156
166
|
SubstatementType?: string;
|
|
167
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
157
168
|
}
|
|
158
169
|
export interface UnprocessedQueryExecutionId {
|
|
159
170
|
QueryExecutionId?: string;
|
|
@@ -253,6 +264,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
253
264
|
export interface CustomerContentEncryptionConfiguration {
|
|
254
265
|
KmsKey: string | undefined;
|
|
255
266
|
}
|
|
267
|
+
export interface IdentityCenterConfiguration {
|
|
268
|
+
EnableIdentityCenter?: boolean;
|
|
269
|
+
IdentityCenterInstanceArn?: string;
|
|
270
|
+
}
|
|
256
271
|
export interface WorkGroupConfiguration {
|
|
257
272
|
ResultConfiguration?: ResultConfiguration;
|
|
258
273
|
EnforceWorkGroupConfiguration?: boolean;
|
|
@@ -264,6 +279,8 @@ export interface WorkGroupConfiguration {
|
|
|
264
279
|
ExecutionRole?: string;
|
|
265
280
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
266
281
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
282
|
+
IdentityCenterConfiguration?: IdentityCenterConfiguration;
|
|
283
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
267
284
|
}
|
|
268
285
|
export interface CreateWorkGroupInput {
|
|
269
286
|
Name: string | undefined;
|
|
@@ -424,6 +441,7 @@ export interface GetCapacityReservationOutput {
|
|
|
424
441
|
export interface GetDatabaseInput {
|
|
425
442
|
CatalogName: string | undefined;
|
|
426
443
|
DatabaseName: string | undefined;
|
|
444
|
+
WorkGroup?: string;
|
|
427
445
|
}
|
|
428
446
|
export interface Database {
|
|
429
447
|
Name: string | undefined;
|
|
@@ -441,6 +459,7 @@ export declare class MetadataException extends __BaseException {
|
|
|
441
459
|
}
|
|
442
460
|
export interface GetDataCatalogInput {
|
|
443
461
|
Name: string | undefined;
|
|
462
|
+
WorkGroup?: string;
|
|
444
463
|
}
|
|
445
464
|
export interface DataCatalog {
|
|
446
465
|
Name: string | undefined;
|
|
@@ -595,6 +614,7 @@ export interface GetTableMetadataInput {
|
|
|
595
614
|
CatalogName: string | undefined;
|
|
596
615
|
DatabaseName: string | undefined;
|
|
597
616
|
TableName: string | undefined;
|
|
617
|
+
WorkGroup?: string;
|
|
598
618
|
}
|
|
599
619
|
export interface Column {
|
|
600
620
|
Name: string | undefined;
|
|
@@ -628,6 +648,7 @@ export interface WorkGroup {
|
|
|
628
648
|
Configuration?: WorkGroupConfiguration;
|
|
629
649
|
Description?: string;
|
|
630
650
|
CreationTime?: Date;
|
|
651
|
+
IdentityCenterApplicationArn?: string;
|
|
631
652
|
}
|
|
632
653
|
export interface GetWorkGroupOutput {
|
|
633
654
|
WorkGroup?: WorkGroup;
|
|
@@ -681,6 +702,7 @@ export interface ListDatabasesInput {
|
|
|
681
702
|
CatalogName: string | undefined;
|
|
682
703
|
NextToken?: string;
|
|
683
704
|
MaxResults?: number;
|
|
705
|
+
WorkGroup?: string;
|
|
684
706
|
}
|
|
685
707
|
export interface ListDatabasesOutput {
|
|
686
708
|
DatabaseList?: Database[];
|
|
@@ -689,6 +711,7 @@ export interface ListDatabasesOutput {
|
|
|
689
711
|
export interface ListDataCatalogsInput {
|
|
690
712
|
NextToken?: string;
|
|
691
713
|
MaxResults?: number;
|
|
714
|
+
WorkGroup?: string;
|
|
692
715
|
}
|
|
693
716
|
export interface DataCatalogSummary {
|
|
694
717
|
CatalogName?: string;
|
|
@@ -820,6 +843,7 @@ export interface ListTableMetadataInput {
|
|
|
820
843
|
Expression?: string;
|
|
821
844
|
NextToken?: string;
|
|
822
845
|
MaxResults?: number;
|
|
846
|
+
WorkGroup?: string;
|
|
823
847
|
}
|
|
824
848
|
export interface ListTableMetadataOutput {
|
|
825
849
|
TableMetadataList?: TableMetadata[];
|
|
@@ -844,6 +868,7 @@ export interface WorkGroupSummary {
|
|
|
844
868
|
Description?: string;
|
|
845
869
|
CreationTime?: Date;
|
|
846
870
|
EngineVersion?: EngineVersion;
|
|
871
|
+
IdentityCenterApplicationArn?: string;
|
|
847
872
|
}
|
|
848
873
|
export interface ListWorkGroupsOutput {
|
|
849
874
|
WorkGroups?: WorkGroupSummary[];
|
|
@@ -989,6 +1014,7 @@ export interface WorkGroupConfigurationUpdates {
|
|
|
989
1014
|
ExecutionRole?: string;
|
|
990
1015
|
CustomerContentEncryptionConfiguration?: CustomerContentEncryptionConfiguration;
|
|
991
1016
|
EnableMinimumEncryptionConfiguration?: boolean;
|
|
1017
|
+
QueryResultsS3AccessGrantsConfiguration?: QueryResultsS3AccessGrantsConfiguration;
|
|
992
1018
|
}
|
|
993
1019
|
export interface UpdateWorkGroupInput {
|
|
994
1020
|
WorkGroup: string | 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.
|
|
4
|
+
"version": "3.467.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|