@aws-sdk/client-athena 3.699.0 → 3.705.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 +38 -0
- package/dist-es/models/models_0.js +34 -0
- package/dist-types/commands/CreateDataCatalogCommand.d.ts +33 -3
- package/dist-types/commands/DeleteDataCatalogCommand.d.ts +15 -2
- package/dist-types/commands/GetDataCatalogCommand.d.ts +4 -1
- package/dist-types/commands/ListDataCatalogsCommand.d.ts +4 -1
- package/dist-types/commands/UpdateDataCatalogCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +408 -94
- package/dist-types/ts3.4/commands/CreateDataCatalogCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataCatalogCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +57 -8
- package/package.json +1 -1
package/dist-cjs/index.js
CHANGED
|
@@ -33,6 +33,7 @@ __export(src_exports, {
|
|
|
33
33
|
CapacityAllocationStatus: () => CapacityAllocationStatus,
|
|
34
34
|
CapacityReservationStatus: () => CapacityReservationStatus,
|
|
35
35
|
ColumnNullable: () => ColumnNullable,
|
|
36
|
+
ConnectionType: () => ConnectionType,
|
|
36
37
|
CreateCapacityReservationCommand: () => CreateCapacityReservationCommand,
|
|
37
38
|
CreateDataCatalogCommand: () => CreateDataCatalogCommand,
|
|
38
39
|
CreateNamedQueryCommand: () => CreateNamedQueryCommand,
|
|
@@ -40,6 +41,7 @@ __export(src_exports, {
|
|
|
40
41
|
CreatePreparedStatementCommand: () => CreatePreparedStatementCommand,
|
|
41
42
|
CreatePresignedNotebookUrlCommand: () => CreatePresignedNotebookUrlCommand,
|
|
42
43
|
CreateWorkGroupCommand: () => CreateWorkGroupCommand,
|
|
44
|
+
DataCatalogStatus: () => DataCatalogStatus,
|
|
43
45
|
DataCatalogType: () => DataCatalogType,
|
|
44
46
|
DeleteCapacityReservationCommand: () => DeleteCapacityReservationCommand,
|
|
45
47
|
DeleteDataCatalogCommand: () => DeleteDataCatalogCommand,
|
|
@@ -360,10 +362,44 @@ var QueryExecutionState = {
|
|
|
360
362
|
SUCCEEDED: "SUCCEEDED"
|
|
361
363
|
};
|
|
362
364
|
var DataCatalogType = {
|
|
365
|
+
FEDERATED: "FEDERATED",
|
|
363
366
|
GLUE: "GLUE",
|
|
364
367
|
HIVE: "HIVE",
|
|
365
368
|
LAMBDA: "LAMBDA"
|
|
366
369
|
};
|
|
370
|
+
var ConnectionType = {
|
|
371
|
+
BIGQUERY: "BIGQUERY",
|
|
372
|
+
CMDB: "CMDB",
|
|
373
|
+
DATALAKEGEN2: "DATALAKEGEN2",
|
|
374
|
+
DB2: "DB2",
|
|
375
|
+
DB2AS400: "DB2AS400",
|
|
376
|
+
DOCUMENTDB: "DOCUMENTDB",
|
|
377
|
+
DYNAMODB: "DYNAMODB",
|
|
378
|
+
GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE",
|
|
379
|
+
HBASE: "HBASE",
|
|
380
|
+
MYSQL: "MYSQL",
|
|
381
|
+
OPENSEARCH: "OPENSEARCH",
|
|
382
|
+
ORACLE: "ORACLE",
|
|
383
|
+
POSTGRESQL: "POSTGRESQL",
|
|
384
|
+
REDSHIFT: "REDSHIFT",
|
|
385
|
+
SAPHANA: "SAPHANA",
|
|
386
|
+
SNOWFLAKE: "SNOWFLAKE",
|
|
387
|
+
SQLSERVER: "SQLSERVER",
|
|
388
|
+
SYNAPSE: "SYNAPSE",
|
|
389
|
+
TIMESTREAM: "TIMESTREAM",
|
|
390
|
+
TPCDS: "TPCDS"
|
|
391
|
+
};
|
|
392
|
+
var DataCatalogStatus = {
|
|
393
|
+
CREATE_COMPLETE: "CREATE_COMPLETE",
|
|
394
|
+
CREATE_FAILED: "CREATE_FAILED",
|
|
395
|
+
CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE",
|
|
396
|
+
CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED",
|
|
397
|
+
CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS",
|
|
398
|
+
CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS",
|
|
399
|
+
DELETE_COMPLETE: "DELETE_COMPLETE",
|
|
400
|
+
DELETE_FAILED: "DELETE_FAILED",
|
|
401
|
+
DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS"
|
|
402
|
+
};
|
|
367
403
|
var ThrottleReason = {
|
|
368
404
|
CONCURRENT_QUERY_LIMIT_EXCEEDED: "CONCURRENT_QUERY_LIMIT_EXCEEDED"
|
|
369
405
|
};
|
|
@@ -3507,6 +3543,8 @@ var paginateListWorkGroups = (0, import_core.createPaginator)(AthenaClient, List
|
|
|
3507
3543
|
StatementType,
|
|
3508
3544
|
QueryExecutionState,
|
|
3509
3545
|
DataCatalogType,
|
|
3546
|
+
ConnectionType,
|
|
3547
|
+
DataCatalogStatus,
|
|
3510
3548
|
ThrottleReason,
|
|
3511
3549
|
TooManyRequestsException,
|
|
3512
3550
|
ResourceNotFoundException,
|
|
@@ -50,10 +50,44 @@ export const QueryExecutionState = {
|
|
|
50
50
|
SUCCEEDED: "SUCCEEDED",
|
|
51
51
|
};
|
|
52
52
|
export const DataCatalogType = {
|
|
53
|
+
FEDERATED: "FEDERATED",
|
|
53
54
|
GLUE: "GLUE",
|
|
54
55
|
HIVE: "HIVE",
|
|
55
56
|
LAMBDA: "LAMBDA",
|
|
56
57
|
};
|
|
58
|
+
export const ConnectionType = {
|
|
59
|
+
BIGQUERY: "BIGQUERY",
|
|
60
|
+
CMDB: "CMDB",
|
|
61
|
+
DATALAKEGEN2: "DATALAKEGEN2",
|
|
62
|
+
DB2: "DB2",
|
|
63
|
+
DB2AS400: "DB2AS400",
|
|
64
|
+
DOCUMENTDB: "DOCUMENTDB",
|
|
65
|
+
DYNAMODB: "DYNAMODB",
|
|
66
|
+
GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE",
|
|
67
|
+
HBASE: "HBASE",
|
|
68
|
+
MYSQL: "MYSQL",
|
|
69
|
+
OPENSEARCH: "OPENSEARCH",
|
|
70
|
+
ORACLE: "ORACLE",
|
|
71
|
+
POSTGRESQL: "POSTGRESQL",
|
|
72
|
+
REDSHIFT: "REDSHIFT",
|
|
73
|
+
SAPHANA: "SAPHANA",
|
|
74
|
+
SNOWFLAKE: "SNOWFLAKE",
|
|
75
|
+
SQLSERVER: "SQLSERVER",
|
|
76
|
+
SYNAPSE: "SYNAPSE",
|
|
77
|
+
TIMESTREAM: "TIMESTREAM",
|
|
78
|
+
TPCDS: "TPCDS",
|
|
79
|
+
};
|
|
80
|
+
export const DataCatalogStatus = {
|
|
81
|
+
CREATE_COMPLETE: "CREATE_COMPLETE",
|
|
82
|
+
CREATE_FAILED: "CREATE_FAILED",
|
|
83
|
+
CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE",
|
|
84
|
+
CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED",
|
|
85
|
+
CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS",
|
|
86
|
+
CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS",
|
|
87
|
+
DELETE_COMPLETE: "DELETE_COMPLETE",
|
|
88
|
+
DELETE_FAILED: "DELETE_FAILED",
|
|
89
|
+
DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS",
|
|
90
|
+
};
|
|
57
91
|
export const ThrottleReason = {
|
|
58
92
|
CONCURRENT_QUERY_LIMIT_EXCEEDED: "CONCURRENT_QUERY_LIMIT_EXCEEDED",
|
|
59
93
|
};
|
|
@@ -29,6 +29,24 @@ declare const CreateDataCatalogCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates (registers) a data catalog with the specified name and properties. Catalogs
|
|
31
31
|
* created are visible to all users of the same Amazon Web Services account.</p>
|
|
32
|
+
* <p>This API operation creates the following resources.</p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>CFN Stack Name with a maximum length of 128 characters and prefix
|
|
36
|
+
* <code>athenafederatedcatalog-CATALOG_NAME_SANITIZED</code> with length 23
|
|
37
|
+
* characters.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>Lambda Function Name with a maximum length of 64 characters and prefix
|
|
41
|
+
* <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23
|
|
42
|
+
* characters.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>Glue Connection Name with a maximum length of 255 characters and a prefix
|
|
46
|
+
* <code>athenafederatedcatalog_CATALOG_NAME_SANITIZED</code> with length 23
|
|
47
|
+
* characters. </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
32
50
|
* @example
|
|
33
51
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
52
|
* ```javascript
|
|
@@ -37,7 +55,7 @@ declare const CreateDataCatalogCommand_base: {
|
|
|
37
55
|
* const client = new AthenaClient(config);
|
|
38
56
|
* const input = { // CreateDataCatalogInput
|
|
39
57
|
* Name: "STRING_VALUE", // required
|
|
40
|
-
* Type: "LAMBDA" || "GLUE" || "HIVE", // required
|
|
58
|
+
* Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
|
|
41
59
|
* Description: "STRING_VALUE",
|
|
42
60
|
* Parameters: { // ParametersMap
|
|
43
61
|
* "<keys>": "STRING_VALUE",
|
|
@@ -51,7 +69,19 @@ declare const CreateDataCatalogCommand_base: {
|
|
|
51
69
|
* };
|
|
52
70
|
* const command = new CreateDataCatalogCommand(input);
|
|
53
71
|
* const response = await client.send(command);
|
|
54
|
-
* // {
|
|
72
|
+
* // { // CreateDataCatalogOutput
|
|
73
|
+
* // DataCatalog: { // DataCatalog
|
|
74
|
+
* // Name: "STRING_VALUE", // required
|
|
75
|
+
* // Description: "STRING_VALUE",
|
|
76
|
+
* // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
|
|
77
|
+
* // Parameters: { // ParametersMap
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "CREATE_FAILED_CLEANUP_IN_PROGRESS" || "CREATE_FAILED_CLEANUP_COMPLETE" || "CREATE_FAILED_CLEANUP_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",
|
|
81
|
+
* // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "CMDB" || "TPCDS" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "DATALAKEGEN2" || "DB2AS400",
|
|
82
|
+
* // Error: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
55
85
|
*
|
|
56
86
|
* ```
|
|
57
87
|
*
|
|
@@ -79,7 +109,7 @@ export declare class CreateDataCatalogCommand extends CreateDataCatalogCommand_b
|
|
|
79
109
|
protected static __types: {
|
|
80
110
|
api: {
|
|
81
111
|
input: CreateDataCatalogInput;
|
|
82
|
-
output:
|
|
112
|
+
output: CreateDataCatalogOutput;
|
|
83
113
|
};
|
|
84
114
|
sdk: {
|
|
85
115
|
input: CreateDataCatalogCommandInput;
|
|
@@ -36,10 +36,23 @@ declare const DeleteDataCatalogCommand_base: {
|
|
|
36
36
|
* const client = new AthenaClient(config);
|
|
37
37
|
* const input = { // DeleteDataCatalogInput
|
|
38
38
|
* Name: "STRING_VALUE", // required
|
|
39
|
+
* DeleteCatalogOnly: true || false,
|
|
39
40
|
* };
|
|
40
41
|
* const command = new DeleteDataCatalogCommand(input);
|
|
41
42
|
* const response = await client.send(command);
|
|
42
|
-
* // {
|
|
43
|
+
* // { // DeleteDataCatalogOutput
|
|
44
|
+
* // DataCatalog: { // DataCatalog
|
|
45
|
+
* // Name: "STRING_VALUE", // required
|
|
46
|
+
* // Description: "STRING_VALUE",
|
|
47
|
+
* // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
|
|
48
|
+
* // Parameters: { // ParametersMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "CREATE_FAILED_CLEANUP_IN_PROGRESS" || "CREATE_FAILED_CLEANUP_COMPLETE" || "CREATE_FAILED_CLEANUP_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",
|
|
52
|
+
* // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "CMDB" || "TPCDS" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "DATALAKEGEN2" || "DB2AS400",
|
|
53
|
+
* // Error: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // };
|
|
43
56
|
*
|
|
44
57
|
* ```
|
|
45
58
|
*
|
|
@@ -67,7 +80,7 @@ export declare class DeleteDataCatalogCommand extends DeleteDataCatalogCommand_b
|
|
|
67
80
|
protected static __types: {
|
|
68
81
|
api: {
|
|
69
82
|
input: DeleteDataCatalogInput;
|
|
70
|
-
output:
|
|
83
|
+
output: DeleteDataCatalogOutput;
|
|
71
84
|
};
|
|
72
85
|
sdk: {
|
|
73
86
|
input: DeleteDataCatalogCommandInput;
|
|
@@ -44,10 +44,13 @@ declare const GetDataCatalogCommand_base: {
|
|
|
44
44
|
* // DataCatalog: { // DataCatalog
|
|
45
45
|
* // Name: "STRING_VALUE", // required
|
|
46
46
|
* // Description: "STRING_VALUE",
|
|
47
|
-
* // Type: "LAMBDA" || "GLUE" || "HIVE", // required
|
|
47
|
+
* // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
|
|
48
48
|
* // Parameters: { // ParametersMap
|
|
49
49
|
* // "<keys>": "STRING_VALUE",
|
|
50
50
|
* // },
|
|
51
|
+
* // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "CREATE_FAILED_CLEANUP_IN_PROGRESS" || "CREATE_FAILED_CLEANUP_COMPLETE" || "CREATE_FAILED_CLEANUP_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",
|
|
52
|
+
* // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "CMDB" || "TPCDS" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "DATALAKEGEN2" || "DB2AS400",
|
|
53
|
+
* // Error: "STRING_VALUE",
|
|
51
54
|
* // },
|
|
52
55
|
* // };
|
|
53
56
|
*
|
|
@@ -49,7 +49,10 @@ declare const ListDataCatalogsCommand_base: {
|
|
|
49
49
|
* // DataCatalogsSummary: [ // DataCatalogSummaryList
|
|
50
50
|
* // { // DataCatalogSummary
|
|
51
51
|
* // CatalogName: "STRING_VALUE",
|
|
52
|
-
* // Type: "LAMBDA" || "GLUE" || "HIVE",
|
|
52
|
+
* // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED",
|
|
53
|
+
* // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "CREATE_FAILED_CLEANUP_IN_PROGRESS" || "CREATE_FAILED_CLEANUP_COMPLETE" || "CREATE_FAILED_CLEANUP_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",
|
|
54
|
+
* // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "CMDB" || "TPCDS" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "DATALAKEGEN2" || "DB2AS400",
|
|
55
|
+
* // Error: "STRING_VALUE",
|
|
53
56
|
* // },
|
|
54
57
|
* // ],
|
|
55
58
|
* // NextToken: "STRING_VALUE",
|
|
@@ -36,7 +36,7 @@ declare const UpdateDataCatalogCommand_base: {
|
|
|
36
36
|
* const client = new AthenaClient(config);
|
|
37
37
|
* const input = { // UpdateDataCatalogInput
|
|
38
38
|
* Name: "STRING_VALUE", // required
|
|
39
|
-
* Type: "LAMBDA" || "GLUE" || "HIVE", // required
|
|
39
|
+
* Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
|
|
40
40
|
* Description: "STRING_VALUE",
|
|
41
41
|
* Parameters: { // ParametersMap
|
|
42
42
|
* "<keys>": "STRING_VALUE",
|
|
@@ -850,6 +850,7 @@ export interface CreateCapacityReservationOutput {
|
|
|
850
850
|
* @enum
|
|
851
851
|
*/
|
|
852
852
|
export declare const DataCatalogType: {
|
|
853
|
+
readonly FEDERATED: "FEDERATED";
|
|
853
854
|
readonly GLUE: "GLUE";
|
|
854
855
|
readonly HIVE: "HIVE";
|
|
855
856
|
readonly LAMBDA: "LAMBDA";
|
|
@@ -867,13 +868,31 @@ export interface CreateDataCatalogInput {
|
|
|
867
868
|
* Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at
|
|
868
869
|
* sign, or hyphen characters. The remainder of the length constraint of 256 is reserved
|
|
869
870
|
* for use by Athena.</p>
|
|
871
|
+
* <p>For <code>FEDERATED</code> type the catalog name has following considerations and
|
|
872
|
+
* limits:</p>
|
|
873
|
+
* <ul>
|
|
874
|
+
* <li>
|
|
875
|
+
* <p>The catalog name allows special characters such as <code>_ , @ , \ , -
|
|
876
|
+
* </code>. These characters are replaced with a hyphen (-) when creating the CFN
|
|
877
|
+
* Stack Name and with an underscore (_) when creating the Lambda Function and Glue
|
|
878
|
+
* Connection Name.</p>
|
|
879
|
+
* </li>
|
|
880
|
+
* <li>
|
|
881
|
+
* <p>The catalog name has a theoretical limit of 128 characters. However, since we
|
|
882
|
+
* use it to create other resources that allow less characters and we prepend a
|
|
883
|
+
* prefix to it, the actual catalog name limit for <code>FEDERATED</code> catalog
|
|
884
|
+
* is 64 - 23 = 41 characters.</p>
|
|
885
|
+
* </li>
|
|
886
|
+
* </ul>
|
|
870
887
|
* @public
|
|
871
888
|
*/
|
|
872
889
|
Name: string | undefined;
|
|
873
890
|
/**
|
|
874
891
|
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
875
|
-
* <code>
|
|
876
|
-
*
|
|
892
|
+
* <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an
|
|
893
|
+
* external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which
|
|
894
|
+
* Athena creates the connection and the Lambda function for
|
|
895
|
+
* you based on the parameters that you pass.</p>
|
|
877
896
|
* @public
|
|
878
897
|
*/
|
|
879
898
|
Type: DataCatalogType | undefined;
|
|
@@ -940,20 +959,313 @@ export interface CreateDataCatalogInput {
|
|
|
940
959
|
* </li>
|
|
941
960
|
* </ul>
|
|
942
961
|
* </li>
|
|
962
|
+
* <li>
|
|
963
|
+
* <p>The <code>FEDERATED</code> data catalog type uses one of the following
|
|
964
|
+
* parameters, but not both. Use <code>connection-arn</code> for an existing
|
|
965
|
+
* Glue connection. Use <code>connection-type</code> and
|
|
966
|
+
* <code>connection-properties</code> to specify the configuration setting for
|
|
967
|
+
* a new connection.</p>
|
|
968
|
+
* <ul>
|
|
969
|
+
* <li>
|
|
970
|
+
* <p>
|
|
971
|
+
* <code>connection-arn:<i><glue_connection_arn_to_reuse></i>
|
|
972
|
+
* </code>
|
|
973
|
+
* </p>
|
|
974
|
+
* </li>
|
|
975
|
+
* <li>
|
|
976
|
+
* <p>
|
|
977
|
+
* <code>lambda-role-arn</code> (optional): The execution role to use for the
|
|
978
|
+
* Lambda function. If not provided, one is created.</p>
|
|
979
|
+
* </li>
|
|
980
|
+
* <li>
|
|
981
|
+
* <p>
|
|
982
|
+
* <code>connection-type:MYSQL|REDSHIFT|....,
|
|
983
|
+
* connection-properties:"<i><json_string></i>"</code>
|
|
984
|
+
* </p>
|
|
985
|
+
* <p>For <i>
|
|
986
|
+
* <code><json_string></code>
|
|
987
|
+
* </i>, use escaped
|
|
988
|
+
* JSON text, as in the following example.</p>
|
|
989
|
+
* <p>
|
|
990
|
+
* <code>"\{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"\}"</code>
|
|
991
|
+
* </p>
|
|
992
|
+
* </li>
|
|
993
|
+
* </ul>
|
|
994
|
+
* </li>
|
|
943
995
|
* </ul>
|
|
944
996
|
* @public
|
|
945
997
|
*/
|
|
946
998
|
Parameters?: Record<string, string> | undefined;
|
|
947
999
|
/**
|
|
948
|
-
* <p>A list of comma separated tags to add to the data catalog that is created
|
|
1000
|
+
* <p>A list of comma separated tags to add to the data catalog that is created. All the
|
|
1001
|
+
* resources that are created by the <code>CreateDataCatalog</code> API operation with
|
|
1002
|
+
* <code>FEDERATED</code> type will have the tag
|
|
1003
|
+
* <code>federated_athena_datacatalog="true"</code>. This includes the CFN Stack, Glue
|
|
1004
|
+
* Connection, Athena DataCatalog, and all the resources created as part of the CFN Stack
|
|
1005
|
+
* (Lambda Function, IAM policies/roles).</p>
|
|
949
1006
|
* @public
|
|
950
1007
|
*/
|
|
951
1008
|
Tags?: Tag[] | undefined;
|
|
952
1009
|
}
|
|
1010
|
+
/**
|
|
1011
|
+
* @public
|
|
1012
|
+
* @enum
|
|
1013
|
+
*/
|
|
1014
|
+
export declare const ConnectionType: {
|
|
1015
|
+
readonly BIGQUERY: "BIGQUERY";
|
|
1016
|
+
readonly CMDB: "CMDB";
|
|
1017
|
+
readonly DATALAKEGEN2: "DATALAKEGEN2";
|
|
1018
|
+
readonly DB2: "DB2";
|
|
1019
|
+
readonly DB2AS400: "DB2AS400";
|
|
1020
|
+
readonly DOCUMENTDB: "DOCUMENTDB";
|
|
1021
|
+
readonly DYNAMODB: "DYNAMODB";
|
|
1022
|
+
readonly GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE";
|
|
1023
|
+
readonly HBASE: "HBASE";
|
|
1024
|
+
readonly MYSQL: "MYSQL";
|
|
1025
|
+
readonly OPENSEARCH: "OPENSEARCH";
|
|
1026
|
+
readonly ORACLE: "ORACLE";
|
|
1027
|
+
readonly POSTGRESQL: "POSTGRESQL";
|
|
1028
|
+
readonly REDSHIFT: "REDSHIFT";
|
|
1029
|
+
readonly SAPHANA: "SAPHANA";
|
|
1030
|
+
readonly SNOWFLAKE: "SNOWFLAKE";
|
|
1031
|
+
readonly SQLSERVER: "SQLSERVER";
|
|
1032
|
+
readonly SYNAPSE: "SYNAPSE";
|
|
1033
|
+
readonly TIMESTREAM: "TIMESTREAM";
|
|
1034
|
+
readonly TPCDS: "TPCDS";
|
|
1035
|
+
};
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
|
|
1040
|
+
/**
|
|
1041
|
+
* @public
|
|
1042
|
+
* @enum
|
|
1043
|
+
*/
|
|
1044
|
+
export declare const DataCatalogStatus: {
|
|
1045
|
+
readonly CREATE_COMPLETE: "CREATE_COMPLETE";
|
|
1046
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
1047
|
+
readonly CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE";
|
|
1048
|
+
readonly CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED";
|
|
1049
|
+
readonly CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS";
|
|
1050
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
1051
|
+
readonly DELETE_COMPLETE: "DELETE_COMPLETE";
|
|
1052
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
1053
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
1054
|
+
};
|
|
1055
|
+
/**
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
export type DataCatalogStatus = (typeof DataCatalogStatus)[keyof typeof DataCatalogStatus];
|
|
1059
|
+
/**
|
|
1060
|
+
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1061
|
+
* <note>
|
|
1062
|
+
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
1063
|
+
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
1064
|
+
* </note>
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
export interface DataCatalog {
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,
|
|
1070
|
+
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
1071
|
+
* by Athena.</p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
Name: string | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>An optional description of the data catalog.</p>
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
Description?: string | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
1082
|
+
* <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an
|
|
1083
|
+
* external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which
|
|
1084
|
+
* Athena creates the connection and the Lambda function for
|
|
1085
|
+
* you based on the parameters that you pass.</p>
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1088
|
+
Type: DataCatalogType | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* <p>Specifies the Lambda function or functions to use for the data catalog.
|
|
1091
|
+
* This is a mapping whose values depend on the catalog type. </p>
|
|
1092
|
+
* <ul>
|
|
1093
|
+
* <li>
|
|
1094
|
+
* <p>For the <code>HIVE</code> data catalog type, use the following syntax. The
|
|
1095
|
+
* <code>metadata-function</code> parameter is required. <code>The
|
|
1096
|
+
* sdk-version</code> parameter is optional and defaults to the currently
|
|
1097
|
+
* supported version.</p>
|
|
1098
|
+
* <p>
|
|
1099
|
+
* <code>metadata-function=<i>lambda_arn</i>,
|
|
1100
|
+
* sdk-version=<i>version_number</i>
|
|
1101
|
+
* </code>
|
|
1102
|
+
* </p>
|
|
1103
|
+
* </li>
|
|
1104
|
+
* <li>
|
|
1105
|
+
* <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets
|
|
1106
|
+
* of required parameters, but not both.</p>
|
|
1107
|
+
* <ul>
|
|
1108
|
+
* <li>
|
|
1109
|
+
* <p>If you have one Lambda function that processes metadata
|
|
1110
|
+
* and another for reading the actual data, use the following syntax. Both
|
|
1111
|
+
* parameters are required.</p>
|
|
1112
|
+
* <p>
|
|
1113
|
+
* <code>metadata-function=<i>lambda_arn</i>,
|
|
1114
|
+
* record-function=<i>lambda_arn</i>
|
|
1115
|
+
* </code>
|
|
1116
|
+
* </p>
|
|
1117
|
+
* </li>
|
|
1118
|
+
* <li>
|
|
1119
|
+
* <p> If you have a composite Lambda function that processes
|
|
1120
|
+
* both metadata and data, use the following syntax to specify your Lambda function.</p>
|
|
1121
|
+
* <p>
|
|
1122
|
+
* <code>function=<i>lambda_arn</i>
|
|
1123
|
+
* </code>
|
|
1124
|
+
* </p>
|
|
1125
|
+
* </li>
|
|
1126
|
+
* </ul>
|
|
1127
|
+
* </li>
|
|
1128
|
+
* <li>
|
|
1129
|
+
* <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The
|
|
1130
|
+
* <code>
|
|
1131
|
+
* <i>catalog_id</i>
|
|
1132
|
+
* </code> is the account ID of the
|
|
1133
|
+
* Amazon Web Services account to which the Glue catalog
|
|
1134
|
+
* belongs.</p>
|
|
1135
|
+
* <p>
|
|
1136
|
+
* <code>catalog-id=<i>catalog_id</i>
|
|
1137
|
+
* </code>
|
|
1138
|
+
* </p>
|
|
1139
|
+
* <ul>
|
|
1140
|
+
* <li>
|
|
1141
|
+
* <p>The <code>GLUE</code> data catalog type also applies to the default
|
|
1142
|
+
* <code>AwsDataCatalog</code> that already exists in your account, of
|
|
1143
|
+
* which you can have only one and cannot modify.</p>
|
|
1144
|
+
* </li>
|
|
1145
|
+
* </ul>
|
|
1146
|
+
* </li>
|
|
1147
|
+
* <li>
|
|
1148
|
+
* <p>The <code>FEDERATED</code> data catalog type uses one of the following
|
|
1149
|
+
* parameters, but not both. Use <code>connection-arn</code> for an existing
|
|
1150
|
+
* Glue connection. Use <code>connection-type</code> and
|
|
1151
|
+
* <code>connection-properties</code> to specify the configuration setting for
|
|
1152
|
+
* a new connection.</p>
|
|
1153
|
+
* <ul>
|
|
1154
|
+
* <li>
|
|
1155
|
+
* <p>
|
|
1156
|
+
* <code>connection-arn:<i><glue_connection_arn_to_reuse></i>
|
|
1157
|
+
* </code>
|
|
1158
|
+
* </p>
|
|
1159
|
+
* </li>
|
|
1160
|
+
* <li>
|
|
1161
|
+
* <p>
|
|
1162
|
+
* <code>connection-type:MYSQL|REDSHIFT|....,
|
|
1163
|
+
* connection-properties:"<i><json_string></i>"</code>
|
|
1164
|
+
* </p>
|
|
1165
|
+
* <p>For <i>
|
|
1166
|
+
* <code><json_string></code>
|
|
1167
|
+
* </i>, use escaped
|
|
1168
|
+
* JSON text, as in the following example.</p>
|
|
1169
|
+
* <p>
|
|
1170
|
+
* <code>"\{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"\}"</code>
|
|
1171
|
+
* </p>
|
|
1172
|
+
* </li>
|
|
1173
|
+
* </ul>
|
|
1174
|
+
* </li>
|
|
1175
|
+
* </ul>
|
|
1176
|
+
* @public
|
|
1177
|
+
*/
|
|
1178
|
+
Parameters?: Record<string, string> | undefined;
|
|
1179
|
+
/**
|
|
1180
|
+
* <p>The status of the creation or deletion of the data catalog.</p>
|
|
1181
|
+
* <ul>
|
|
1182
|
+
* <li>
|
|
1183
|
+
* <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog
|
|
1184
|
+
* types are created synchronously. Their status is either
|
|
1185
|
+
* <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p>
|
|
1186
|
+
* </li>
|
|
1187
|
+
* <li>
|
|
1188
|
+
* <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p>
|
|
1189
|
+
* </li>
|
|
1190
|
+
* </ul>
|
|
1191
|
+
* <p>Data catalog creation status:</p>
|
|
1192
|
+
* <ul>
|
|
1193
|
+
* <li>
|
|
1194
|
+
* <p>
|
|
1195
|
+
* <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in
|
|
1196
|
+
* progress.</p>
|
|
1197
|
+
* </li>
|
|
1198
|
+
* <li>
|
|
1199
|
+
* <p>
|
|
1200
|
+
* <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p>
|
|
1201
|
+
* </li>
|
|
1202
|
+
* <li>
|
|
1203
|
+
* <p>
|
|
1204
|
+
* <code>CREATE_FAILED</code>: Data catalog could not be created.</p>
|
|
1205
|
+
* </li>
|
|
1206
|
+
* <li>
|
|
1207
|
+
* <p>
|
|
1208
|
+
* <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog
|
|
1209
|
+
* creation failed and is being removed.</p>
|
|
1210
|
+
* </li>
|
|
1211
|
+
* <li>
|
|
1212
|
+
* <p>
|
|
1213
|
+
* <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation
|
|
1214
|
+
* failed and was removed.</p>
|
|
1215
|
+
* </li>
|
|
1216
|
+
* <li>
|
|
1217
|
+
* <p>
|
|
1218
|
+
* <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation
|
|
1219
|
+
* failed but could not be removed.</p>
|
|
1220
|
+
* </li>
|
|
1221
|
+
* </ul>
|
|
1222
|
+
* <p>Data catalog deletion status:</p>
|
|
1223
|
+
* <ul>
|
|
1224
|
+
* <li>
|
|
1225
|
+
* <p>
|
|
1226
|
+
* <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in
|
|
1227
|
+
* progress.</p>
|
|
1228
|
+
* </li>
|
|
1229
|
+
* <li>
|
|
1230
|
+
* <p>
|
|
1231
|
+
* <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p>
|
|
1232
|
+
* </li>
|
|
1233
|
+
* <li>
|
|
1234
|
+
* <p>
|
|
1235
|
+
* <code>DELETE_FAILED</code>: Federated data catalog could not be
|
|
1236
|
+
* deleted.</p>
|
|
1237
|
+
* </li>
|
|
1238
|
+
* </ul>
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
Status?: DataCatalogStatus | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* <p>The type of connection for a <code>FEDERATED</code> data catalog (for example,
|
|
1244
|
+
* <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For
|
|
1245
|
+
* information about individual connectors, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html">Available data source
|
|
1246
|
+
* connectors</a>.</p>
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
ConnectionType?: ConnectionType | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* <p>Text of the error that occurred during data catalog creation or deletion.</p>
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
Error?: string | undefined;
|
|
1255
|
+
}
|
|
953
1256
|
/**
|
|
954
1257
|
* @public
|
|
955
1258
|
*/
|
|
956
1259
|
export interface CreateDataCatalogOutput {
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1262
|
+
* <note>
|
|
1263
|
+
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
1264
|
+
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
1265
|
+
* </note>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
DataCatalog?: DataCatalog | undefined;
|
|
957
1269
|
}
|
|
958
1270
|
/**
|
|
959
1271
|
* @public
|
|
@@ -1344,11 +1656,28 @@ export interface DeleteDataCatalogInput {
|
|
|
1344
1656
|
* @public
|
|
1345
1657
|
*/
|
|
1346
1658
|
Name: string | undefined;
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>Deletes the Athena Data Catalog. You can only use this with the <code>FEDERATED</code>
|
|
1661
|
+
* catalogs. You usually perform this before registering the connector with Glue Data
|
|
1662
|
+
* Catalog. After deletion, you will have to manage the Glue Connection and Lambda
|
|
1663
|
+
* function. </p>
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1666
|
+
DeleteCatalogOnly?: boolean | undefined;
|
|
1347
1667
|
}
|
|
1348
1668
|
/**
|
|
1349
1669
|
* @public
|
|
1350
1670
|
*/
|
|
1351
1671
|
export interface DeleteDataCatalogOutput {
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1674
|
+
* <note>
|
|
1675
|
+
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
1676
|
+
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
1677
|
+
* </note>
|
|
1678
|
+
* @public
|
|
1679
|
+
*/
|
|
1680
|
+
DataCatalog?: DataCatalog | undefined;
|
|
1352
1681
|
}
|
|
1353
1682
|
/**
|
|
1354
1683
|
* @public
|
|
@@ -1956,97 +2285,6 @@ export interface GetDataCatalogInput {
|
|
|
1956
2285
|
*/
|
|
1957
2286
|
WorkGroup?: string | undefined;
|
|
1958
2287
|
}
|
|
1959
|
-
/**
|
|
1960
|
-
* <p>Contains information about a data catalog in an Amazon Web Services account.</p>
|
|
1961
|
-
* <note>
|
|
1962
|
-
* <p>In the Athena console, data catalogs are listed as "data sources" on
|
|
1963
|
-
* the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
|
|
1964
|
-
* </note>
|
|
1965
|
-
* @public
|
|
1966
|
-
*/
|
|
1967
|
-
export interface DataCatalog {
|
|
1968
|
-
/**
|
|
1969
|
-
* <p>The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,
|
|
1970
|
-
* or hyphen characters. The remainder of the length constraint of 256 is reserved for use
|
|
1971
|
-
* by Athena.</p>
|
|
1972
|
-
* @public
|
|
1973
|
-
*/
|
|
1974
|
-
Name: string | undefined;
|
|
1975
|
-
/**
|
|
1976
|
-
* <p>An optional description of the data catalog.</p>
|
|
1977
|
-
* @public
|
|
1978
|
-
*/
|
|
1979
|
-
Description?: string | undefined;
|
|
1980
|
-
/**
|
|
1981
|
-
* <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
|
|
1982
|
-
* <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
|
|
1983
|
-
* Glue Data Catalog.</p>
|
|
1984
|
-
* @public
|
|
1985
|
-
*/
|
|
1986
|
-
Type: DataCatalogType | undefined;
|
|
1987
|
-
/**
|
|
1988
|
-
* <p>Specifies the Lambda function or functions to use for the data catalog.
|
|
1989
|
-
* This is a mapping whose values depend on the catalog type. </p>
|
|
1990
|
-
* <ul>
|
|
1991
|
-
* <li>
|
|
1992
|
-
* <p>For the <code>HIVE</code> data catalog type, use the following syntax. The
|
|
1993
|
-
* <code>metadata-function</code> parameter is required. <code>The
|
|
1994
|
-
* sdk-version</code> parameter is optional and defaults to the currently
|
|
1995
|
-
* supported version.</p>
|
|
1996
|
-
* <p>
|
|
1997
|
-
* <code>metadata-function=<i>lambda_arn</i>,
|
|
1998
|
-
* sdk-version=<i>version_number</i>
|
|
1999
|
-
* </code>
|
|
2000
|
-
* </p>
|
|
2001
|
-
* </li>
|
|
2002
|
-
* <li>
|
|
2003
|
-
* <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets
|
|
2004
|
-
* of required parameters, but not both.</p>
|
|
2005
|
-
* <ul>
|
|
2006
|
-
* <li>
|
|
2007
|
-
* <p>If you have one Lambda function that processes metadata
|
|
2008
|
-
* and another for reading the actual data, use the following syntax. Both
|
|
2009
|
-
* parameters are required.</p>
|
|
2010
|
-
* <p>
|
|
2011
|
-
* <code>metadata-function=<i>lambda_arn</i>,
|
|
2012
|
-
* record-function=<i>lambda_arn</i>
|
|
2013
|
-
* </code>
|
|
2014
|
-
* </p>
|
|
2015
|
-
* </li>
|
|
2016
|
-
* <li>
|
|
2017
|
-
* <p> If you have a composite Lambda function that processes
|
|
2018
|
-
* both metadata and data, use the following syntax to specify your Lambda function.</p>
|
|
2019
|
-
* <p>
|
|
2020
|
-
* <code>function=<i>lambda_arn</i>
|
|
2021
|
-
* </code>
|
|
2022
|
-
* </p>
|
|
2023
|
-
* </li>
|
|
2024
|
-
* </ul>
|
|
2025
|
-
* </li>
|
|
2026
|
-
* <li>
|
|
2027
|
-
* <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The
|
|
2028
|
-
* <code>
|
|
2029
|
-
* <i>catalog_id</i>
|
|
2030
|
-
* </code> is the account ID of the
|
|
2031
|
-
* Amazon Web Services account to which the Glue catalog
|
|
2032
|
-
* belongs.</p>
|
|
2033
|
-
* <p>
|
|
2034
|
-
* <code>catalog-id=<i>catalog_id</i>
|
|
2035
|
-
* </code>
|
|
2036
|
-
* </p>
|
|
2037
|
-
* <ul>
|
|
2038
|
-
* <li>
|
|
2039
|
-
* <p>The <code>GLUE</code> data catalog type also applies to the default
|
|
2040
|
-
* <code>AwsDataCatalog</code> that already exists in your account, of
|
|
2041
|
-
* which you can have only one and cannot modify.</p>
|
|
2042
|
-
* </li>
|
|
2043
|
-
* </ul>
|
|
2044
|
-
* </li>
|
|
2045
|
-
* </ul>
|
|
2046
|
-
* @public
|
|
2047
|
-
*/
|
|
2048
|
-
Parameters?: Record<string, string> | undefined;
|
|
2049
|
-
}
|
|
2050
2288
|
/**
|
|
2051
2289
|
* @public
|
|
2052
2290
|
*/
|
|
@@ -3123,6 +3361,82 @@ export interface DataCatalogSummary {
|
|
|
3123
3361
|
* @public
|
|
3124
3362
|
*/
|
|
3125
3363
|
Type?: DataCatalogType | undefined;
|
|
3364
|
+
/**
|
|
3365
|
+
* <p>The status of the creation or deletion of the data catalog.</p>
|
|
3366
|
+
* <ul>
|
|
3367
|
+
* <li>
|
|
3368
|
+
* <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog
|
|
3369
|
+
* types are created synchronously. Their status is either
|
|
3370
|
+
* <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p>
|
|
3371
|
+
* </li>
|
|
3372
|
+
* <li>
|
|
3373
|
+
* <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p>
|
|
3374
|
+
* </li>
|
|
3375
|
+
* </ul>
|
|
3376
|
+
* <p>Data catalog creation status:</p>
|
|
3377
|
+
* <ul>
|
|
3378
|
+
* <li>
|
|
3379
|
+
* <p>
|
|
3380
|
+
* <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in
|
|
3381
|
+
* progress.</p>
|
|
3382
|
+
* </li>
|
|
3383
|
+
* <li>
|
|
3384
|
+
* <p>
|
|
3385
|
+
* <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p>
|
|
3386
|
+
* </li>
|
|
3387
|
+
* <li>
|
|
3388
|
+
* <p>
|
|
3389
|
+
* <code>CREATE_FAILED</code>: Data catalog could not be created.</p>
|
|
3390
|
+
* </li>
|
|
3391
|
+
* <li>
|
|
3392
|
+
* <p>
|
|
3393
|
+
* <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog
|
|
3394
|
+
* creation failed and is being removed.</p>
|
|
3395
|
+
* </li>
|
|
3396
|
+
* <li>
|
|
3397
|
+
* <p>
|
|
3398
|
+
* <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation
|
|
3399
|
+
* failed and was removed.</p>
|
|
3400
|
+
* </li>
|
|
3401
|
+
* <li>
|
|
3402
|
+
* <p>
|
|
3403
|
+
* <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation
|
|
3404
|
+
* failed but could not be removed.</p>
|
|
3405
|
+
* </li>
|
|
3406
|
+
* </ul>
|
|
3407
|
+
* <p>Data catalog deletion status:</p>
|
|
3408
|
+
* <ul>
|
|
3409
|
+
* <li>
|
|
3410
|
+
* <p>
|
|
3411
|
+
* <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in
|
|
3412
|
+
* progress.</p>
|
|
3413
|
+
* </li>
|
|
3414
|
+
* <li>
|
|
3415
|
+
* <p>
|
|
3416
|
+
* <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p>
|
|
3417
|
+
* </li>
|
|
3418
|
+
* <li>
|
|
3419
|
+
* <p>
|
|
3420
|
+
* <code>DELETE_FAILED</code>: Federated data catalog could not be
|
|
3421
|
+
* deleted.</p>
|
|
3422
|
+
* </li>
|
|
3423
|
+
* </ul>
|
|
3424
|
+
* @public
|
|
3425
|
+
*/
|
|
3426
|
+
Status?: DataCatalogStatus | undefined;
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>The type of connection for a <code>FEDERATED</code> data catalog (for example,
|
|
3429
|
+
* <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For
|
|
3430
|
+
* information about individual connectors, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html">Available data source
|
|
3431
|
+
* connectors</a>.</p>
|
|
3432
|
+
* @public
|
|
3433
|
+
*/
|
|
3434
|
+
ConnectionType?: ConnectionType | undefined;
|
|
3435
|
+
/**
|
|
3436
|
+
* <p>Text of the error that occurred during data catalog creation or deletion.</p>
|
|
3437
|
+
* @public
|
|
3438
|
+
*/
|
|
3439
|
+
Error?: string | undefined;
|
|
3126
3440
|
}
|
|
3127
3441
|
/**
|
|
3128
3442
|
* @public
|
|
@@ -40,7 +40,7 @@ export declare class CreateDataCatalogCommand extends CreateDataCatalogCommand_b
|
|
|
40
40
|
protected static __types: {
|
|
41
41
|
api: {
|
|
42
42
|
input: CreateDataCatalogInput;
|
|
43
|
-
output:
|
|
43
|
+
output: CreateDataCatalogOutput;
|
|
44
44
|
};
|
|
45
45
|
sdk: {
|
|
46
46
|
input: CreateDataCatalogCommandInput;
|
|
@@ -40,7 +40,7 @@ export declare class DeleteDataCatalogCommand extends DeleteDataCatalogCommand_b
|
|
|
40
40
|
protected static __types: {
|
|
41
41
|
api: {
|
|
42
42
|
input: DeleteDataCatalogInput;
|
|
43
|
-
output:
|
|
43
|
+
output: DeleteDataCatalogOutput;
|
|
44
44
|
};
|
|
45
45
|
sdk: {
|
|
46
46
|
input: DeleteDataCatalogCommandInput;
|
|
@@ -194,6 +194,7 @@ export interface CreateCapacityReservationInput {
|
|
|
194
194
|
}
|
|
195
195
|
export interface CreateCapacityReservationOutput {}
|
|
196
196
|
export declare const DataCatalogType: {
|
|
197
|
+
readonly FEDERATED: "FEDERATED";
|
|
197
198
|
readonly GLUE: "GLUE";
|
|
198
199
|
readonly HIVE: "HIVE";
|
|
199
200
|
readonly LAMBDA: "LAMBDA";
|
|
@@ -207,7 +208,55 @@ export interface CreateDataCatalogInput {
|
|
|
207
208
|
Parameters?: Record<string, string> | undefined;
|
|
208
209
|
Tags?: Tag[] | undefined;
|
|
209
210
|
}
|
|
210
|
-
export
|
|
211
|
+
export declare const ConnectionType: {
|
|
212
|
+
readonly BIGQUERY: "BIGQUERY";
|
|
213
|
+
readonly CMDB: "CMDB";
|
|
214
|
+
readonly DATALAKEGEN2: "DATALAKEGEN2";
|
|
215
|
+
readonly DB2: "DB2";
|
|
216
|
+
readonly DB2AS400: "DB2AS400";
|
|
217
|
+
readonly DOCUMENTDB: "DOCUMENTDB";
|
|
218
|
+
readonly DYNAMODB: "DYNAMODB";
|
|
219
|
+
readonly GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE";
|
|
220
|
+
readonly HBASE: "HBASE";
|
|
221
|
+
readonly MYSQL: "MYSQL";
|
|
222
|
+
readonly OPENSEARCH: "OPENSEARCH";
|
|
223
|
+
readonly ORACLE: "ORACLE";
|
|
224
|
+
readonly POSTGRESQL: "POSTGRESQL";
|
|
225
|
+
readonly REDSHIFT: "REDSHIFT";
|
|
226
|
+
readonly SAPHANA: "SAPHANA";
|
|
227
|
+
readonly SNOWFLAKE: "SNOWFLAKE";
|
|
228
|
+
readonly SQLSERVER: "SQLSERVER";
|
|
229
|
+
readonly SYNAPSE: "SYNAPSE";
|
|
230
|
+
readonly TIMESTREAM: "TIMESTREAM";
|
|
231
|
+
readonly TPCDS: "TPCDS";
|
|
232
|
+
};
|
|
233
|
+
export type ConnectionType =
|
|
234
|
+
(typeof ConnectionType)[keyof typeof ConnectionType];
|
|
235
|
+
export declare const DataCatalogStatus: {
|
|
236
|
+
readonly CREATE_COMPLETE: "CREATE_COMPLETE";
|
|
237
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
238
|
+
readonly CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE";
|
|
239
|
+
readonly CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED";
|
|
240
|
+
readonly CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS";
|
|
241
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
242
|
+
readonly DELETE_COMPLETE: "DELETE_COMPLETE";
|
|
243
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
244
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
245
|
+
};
|
|
246
|
+
export type DataCatalogStatus =
|
|
247
|
+
(typeof DataCatalogStatus)[keyof typeof DataCatalogStatus];
|
|
248
|
+
export interface DataCatalog {
|
|
249
|
+
Name: string | undefined;
|
|
250
|
+
Description?: string | undefined;
|
|
251
|
+
Type: DataCatalogType | undefined;
|
|
252
|
+
Parameters?: Record<string, string> | undefined;
|
|
253
|
+
Status?: DataCatalogStatus | undefined;
|
|
254
|
+
ConnectionType?: ConnectionType | undefined;
|
|
255
|
+
Error?: string | undefined;
|
|
256
|
+
}
|
|
257
|
+
export interface CreateDataCatalogOutput {
|
|
258
|
+
DataCatalog?: DataCatalog | undefined;
|
|
259
|
+
}
|
|
211
260
|
export interface CreateNamedQueryInput {
|
|
212
261
|
Name: string | undefined;
|
|
213
262
|
Description?: string | undefined;
|
|
@@ -303,8 +352,11 @@ export interface DeleteCapacityReservationInput {
|
|
|
303
352
|
export interface DeleteCapacityReservationOutput {}
|
|
304
353
|
export interface DeleteDataCatalogInput {
|
|
305
354
|
Name: string | undefined;
|
|
355
|
+
DeleteCatalogOnly?: boolean | undefined;
|
|
356
|
+
}
|
|
357
|
+
export interface DeleteDataCatalogOutput {
|
|
358
|
+
DataCatalog?: DataCatalog | undefined;
|
|
306
359
|
}
|
|
307
|
-
export interface DeleteDataCatalogOutput {}
|
|
308
360
|
export interface DeleteNamedQueryInput {
|
|
309
361
|
NamedQueryId?: string | undefined;
|
|
310
362
|
}
|
|
@@ -469,12 +521,6 @@ export interface GetDataCatalogInput {
|
|
|
469
521
|
Name: string | undefined;
|
|
470
522
|
WorkGroup?: string | undefined;
|
|
471
523
|
}
|
|
472
|
-
export interface DataCatalog {
|
|
473
|
-
Name: string | undefined;
|
|
474
|
-
Description?: string | undefined;
|
|
475
|
-
Type: DataCatalogType | undefined;
|
|
476
|
-
Parameters?: Record<string, string> | undefined;
|
|
477
|
-
}
|
|
478
524
|
export interface GetDataCatalogOutput {
|
|
479
525
|
DataCatalog?: DataCatalog | undefined;
|
|
480
526
|
}
|
|
@@ -725,6 +771,9 @@ export interface ListDataCatalogsInput {
|
|
|
725
771
|
export interface DataCatalogSummary {
|
|
726
772
|
CatalogName?: string | undefined;
|
|
727
773
|
Type?: DataCatalogType | undefined;
|
|
774
|
+
Status?: DataCatalogStatus | undefined;
|
|
775
|
+
ConnectionType?: ConnectionType | undefined;
|
|
776
|
+
Error?: string | undefined;
|
|
728
777
|
}
|
|
729
778
|
export interface ListDataCatalogsOutput {
|
|
730
779
|
DataCatalogsSummary?: DataCatalogSummary[] | 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.705.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",
|