@aws-sdk/client-athena 3.654.0 → 3.657.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
@@ -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,54 @@ 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
+ CLOUDERAHIVE: "CLOUDERAHIVE",
373
+ CLOUDERAIMPALA: "CLOUDERAIMPALA",
374
+ CLOUDWATCH: "CLOUDWATCH",
375
+ CLOUDWATCHMETRICS: "CLOUDWATCHMETRICS",
376
+ CMDB: "CMDB",
377
+ DATALAKEGEN2: "DATALAKEGEN2",
378
+ DB2: "DB2",
379
+ DB2AS400: "DB2AS400",
380
+ DOCUMENTDB: "DOCUMENTDB",
381
+ DYNAMODB: "DYNAMODB",
382
+ GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE",
383
+ HBASE: "HBASE",
384
+ HORTONWORKSHIVE: "HORTONWORKSHIVE",
385
+ MSK: "MSK",
386
+ MYSQL: "MYSQL",
387
+ NEPTUNE: "NEPTUNE",
388
+ OPENSEARCH: "OPENSEARCH",
389
+ ORACLE: "ORACLE",
390
+ POSTGRESQL: "POSTGRESQL",
391
+ REDIS: "REDIS",
392
+ REDSHIFT: "REDSHIFT",
393
+ SAPHANA: "SAPHANA",
394
+ SNOWFLAKE: "SNOWFLAKE",
395
+ SQLSERVER: "SQLSERVER",
396
+ SYNAPSE: "SYNAPSE",
397
+ TERADATA: "TERADATA",
398
+ TIMESTREAM: "TIMESTREAM",
399
+ TPCDS: "TPCDS",
400
+ VERTICA: "VERTICA"
401
+ };
402
+ var DataCatalogStatus = {
403
+ CREATE_COMPLETE: "CREATE_COMPLETE",
404
+ CREATE_FAILED: "CREATE_FAILED",
405
+ CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE",
406
+ CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED",
407
+ CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS",
408
+ CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS",
409
+ DELETE_COMPLETE: "DELETE_COMPLETE",
410
+ DELETE_FAILED: "DELETE_FAILED",
411
+ DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS"
412
+ };
367
413
  var ThrottleReason = {
368
414
  CONCURRENT_QUERY_LIMIT_EXCEEDED: "CONCURRENT_QUERY_LIMIT_EXCEEDED"
369
415
  };
@@ -3507,6 +3553,8 @@ var paginateListWorkGroups = (0, import_core.createPaginator)(AthenaClient, List
3507
3553
  StatementType,
3508
3554
  QueryExecutionState,
3509
3555
  DataCatalogType,
3556
+ ConnectionType,
3557
+ DataCatalogStatus,
3510
3558
  ThrottleReason,
3511
3559
  TooManyRequestsException,
3512
3560
  ResourceNotFoundException,
@@ -50,10 +50,54 @@ 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
+ CLOUDERAHIVE: "CLOUDERAHIVE",
61
+ CLOUDERAIMPALA: "CLOUDERAIMPALA",
62
+ CLOUDWATCH: "CLOUDWATCH",
63
+ CLOUDWATCHMETRICS: "CLOUDWATCHMETRICS",
64
+ CMDB: "CMDB",
65
+ DATALAKEGEN2: "DATALAKEGEN2",
66
+ DB2: "DB2",
67
+ DB2AS400: "DB2AS400",
68
+ DOCUMENTDB: "DOCUMENTDB",
69
+ DYNAMODB: "DYNAMODB",
70
+ GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE",
71
+ HBASE: "HBASE",
72
+ HORTONWORKSHIVE: "HORTONWORKSHIVE",
73
+ MSK: "MSK",
74
+ MYSQL: "MYSQL",
75
+ NEPTUNE: "NEPTUNE",
76
+ OPENSEARCH: "OPENSEARCH",
77
+ ORACLE: "ORACLE",
78
+ POSTGRESQL: "POSTGRESQL",
79
+ REDIS: "REDIS",
80
+ REDSHIFT: "REDSHIFT",
81
+ SAPHANA: "SAPHANA",
82
+ SNOWFLAKE: "SNOWFLAKE",
83
+ SQLSERVER: "SQLSERVER",
84
+ SYNAPSE: "SYNAPSE",
85
+ TERADATA: "TERADATA",
86
+ TIMESTREAM: "TIMESTREAM",
87
+ TPCDS: "TPCDS",
88
+ VERTICA: "VERTICA",
89
+ };
90
+ export const DataCatalogStatus = {
91
+ CREATE_COMPLETE: "CREATE_COMPLETE",
92
+ CREATE_FAILED: "CREATE_FAILED",
93
+ CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE",
94
+ CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED",
95
+ CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS",
96
+ CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS",
97
+ DELETE_COMPLETE: "DELETE_COMPLETE",
98
+ DELETE_FAILED: "DELETE_FAILED",
99
+ DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS",
100
+ };
57
101
  export const ThrottleReason = {
58
102
  CONCURRENT_QUERY_LIMIT_EXCEEDED: "CONCURRENT_QUERY_LIMIT_EXCEEDED",
59
103
  };
@@ -37,7 +37,7 @@ declare const CreateDataCatalogCommand_base: {
37
37
  * const client = new AthenaClient(config);
38
38
  * const input = { // CreateDataCatalogInput
39
39
  * Name: "STRING_VALUE", // required
40
- * Type: "LAMBDA" || "GLUE" || "HIVE", // required
40
+ * Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
41
41
  * Description: "STRING_VALUE",
42
42
  * Parameters: { // ParametersMap
43
43
  * "<keys>": "STRING_VALUE",
@@ -51,7 +51,19 @@ declare const CreateDataCatalogCommand_base: {
51
51
  * };
52
52
  * const command = new CreateDataCatalogCommand(input);
53
53
  * const response = await client.send(command);
54
- * // {};
54
+ * // { // CreateDataCatalogOutput
55
+ * // DataCatalog: { // DataCatalog
56
+ * // Name: "STRING_VALUE", // required
57
+ * // Description: "STRING_VALUE",
58
+ * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
59
+ * // Parameters: { // ParametersMap
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // 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",
63
+ * // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "MSK" || "NEPTUNE" || "CMDB" || "TPCDS" || "REDIS" || "CLOUDWATCH" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "TERADATA" || "VERTICA" || "CLOUDERAIMPALA" || "CLOUDERAHIVE" || "HORTONWORKSHIVE" || "DATALAKEGEN2" || "DB2AS400" || "CLOUDWATCHMETRICS",
64
+ * // Error: "STRING_VALUE",
65
+ * // },
66
+ * // };
55
67
  *
56
68
  * ```
57
69
  *
@@ -79,7 +91,7 @@ export declare class CreateDataCatalogCommand extends CreateDataCatalogCommand_b
79
91
  protected static __types: {
80
92
  api: {
81
93
  input: CreateDataCatalogInput;
82
- output: {};
94
+ output: CreateDataCatalogOutput;
83
95
  };
84
96
  sdk: {
85
97
  input: CreateDataCatalogCommandInput;
@@ -39,7 +39,19 @@ declare const DeleteDataCatalogCommand_base: {
39
39
  * };
40
40
  * const command = new DeleteDataCatalogCommand(input);
41
41
  * const response = await client.send(command);
42
- * // {};
42
+ * // { // DeleteDataCatalogOutput
43
+ * // DataCatalog: { // DataCatalog
44
+ * // Name: "STRING_VALUE", // required
45
+ * // Description: "STRING_VALUE",
46
+ * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required
47
+ * // Parameters: { // ParametersMap
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // 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",
51
+ * // ConnectionType: "DYNAMODB" || "MYSQL" || "POSTGRESQL" || "REDSHIFT" || "ORACLE" || "SYNAPSE" || "SQLSERVER" || "DB2" || "OPENSEARCH" || "BIGQUERY" || "GOOGLECLOUDSTORAGE" || "HBASE" || "DOCUMENTDB" || "MSK" || "NEPTUNE" || "CMDB" || "TPCDS" || "REDIS" || "CLOUDWATCH" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "TERADATA" || "VERTICA" || "CLOUDERAIMPALA" || "CLOUDERAHIVE" || "HORTONWORKSHIVE" || "DATALAKEGEN2" || "DB2AS400" || "CLOUDWATCHMETRICS",
52
+ * // Error: "STRING_VALUE",
53
+ * // },
54
+ * // };
43
55
  *
44
56
  * ```
45
57
  *
@@ -67,7 +79,7 @@ export declare class DeleteDataCatalogCommand extends DeleteDataCatalogCommand_b
67
79
  protected static __types: {
68
80
  api: {
69
81
  input: DeleteDataCatalogInput;
70
- output: {};
82
+ output: DeleteDataCatalogOutput;
71
83
  };
72
84
  sdk: {
73
85
  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" || "MSK" || "NEPTUNE" || "CMDB" || "TPCDS" || "REDIS" || "CLOUDWATCH" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "TERADATA" || "VERTICA" || "CLOUDERAIMPALA" || "CLOUDERAHIVE" || "HORTONWORKSHIVE" || "DATALAKEGEN2" || "DB2AS400" || "CLOUDWATCHMETRICS",
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" || "MSK" || "NEPTUNE" || "CMDB" || "TPCDS" || "REDIS" || "CLOUDWATCH" || "TIMESTREAM" || "SAPHANA" || "SNOWFLAKE" || "TERADATA" || "VERTICA" || "CLOUDERAIMPALA" || "CLOUDERAHIVE" || "HORTONWORKSHIVE" || "DATALAKEGEN2" || "DB2AS400" || "CLOUDWATCHMETRICS",
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",
@@ -848,6 +848,7 @@ export interface CreateCapacityReservationOutput {
848
848
  * @enum
849
849
  */
850
850
  export declare const DataCatalogType: {
851
+ readonly FEDERATED: "FEDERATED";
851
852
  readonly GLUE: "GLUE";
852
853
  readonly HIVE: "HIVE";
853
854
  readonly LAMBDA: "LAMBDA";
@@ -870,8 +871,10 @@ export interface CreateDataCatalogInput {
870
871
  Name: string | undefined;
871
872
  /**
872
873
  * <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
873
- * <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
874
- * Glue Data Catalog.</p>
874
+ * <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an
875
+ * external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which
876
+ * Athena creates the connection and the Lambda function for
877
+ * you based on the parameters that you pass.</p>
875
878
  * @public
876
879
  */
877
880
  Type: DataCatalogType | undefined;
@@ -938,6 +941,39 @@ export interface CreateDataCatalogInput {
938
941
  * </li>
939
942
  * </ul>
940
943
  * </li>
944
+ * <li>
945
+ * <p>The <code>FEDERATED</code> data catalog type uses one of the following
946
+ * parameters, but not both. Use <code>connection-arn</code> for an existing
947
+ * Glue connection. Use <code>connection-type</code> and
948
+ * <code>connection-properties</code> to specify the configuration setting for
949
+ * a new connection.</p>
950
+ * <ul>
951
+ * <li>
952
+ * <p>
953
+ * <code>connection-arn:<i><glue_connection_arn_to_reuse></i>
954
+ * </code>
955
+ * </p>
956
+ * </li>
957
+ * <li>
958
+ * <p>
959
+ * <code>lambda-role-arn</code> (optional): The execution role to use for the
960
+ * Lambda function. If not provided, one is created.</p>
961
+ * </li>
962
+ * <li>
963
+ * <p>
964
+ * <code>connection-type:MYSQL|REDSHIFT|....,
965
+ * connection-properties:"<i><json_string></i>"</code>
966
+ * </p>
967
+ * <p>For <i>
968
+ * <code><json_string></code>
969
+ * </i>, use escaped
970
+ * JSON text, as in the following example.</p>
971
+ * <p>
972
+ * <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>
973
+ * </p>
974
+ * </li>
975
+ * </ul>
976
+ * </li>
941
977
  * </ul>
942
978
  * @public
943
979
  */
@@ -948,10 +984,275 @@ export interface CreateDataCatalogInput {
948
984
  */
949
985
  Tags?: Tag[];
950
986
  }
987
+ /**
988
+ * @public
989
+ * @enum
990
+ */
991
+ export declare const ConnectionType: {
992
+ readonly BIGQUERY: "BIGQUERY";
993
+ readonly CLOUDERAHIVE: "CLOUDERAHIVE";
994
+ readonly CLOUDERAIMPALA: "CLOUDERAIMPALA";
995
+ readonly CLOUDWATCH: "CLOUDWATCH";
996
+ readonly CLOUDWATCHMETRICS: "CLOUDWATCHMETRICS";
997
+ readonly CMDB: "CMDB";
998
+ readonly DATALAKEGEN2: "DATALAKEGEN2";
999
+ readonly DB2: "DB2";
1000
+ readonly DB2AS400: "DB2AS400";
1001
+ readonly DOCUMENTDB: "DOCUMENTDB";
1002
+ readonly DYNAMODB: "DYNAMODB";
1003
+ readonly GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE";
1004
+ readonly HBASE: "HBASE";
1005
+ readonly HORTONWORKSHIVE: "HORTONWORKSHIVE";
1006
+ readonly MSK: "MSK";
1007
+ readonly MYSQL: "MYSQL";
1008
+ readonly NEPTUNE: "NEPTUNE";
1009
+ readonly OPENSEARCH: "OPENSEARCH";
1010
+ readonly ORACLE: "ORACLE";
1011
+ readonly POSTGRESQL: "POSTGRESQL";
1012
+ readonly REDIS: "REDIS";
1013
+ readonly REDSHIFT: "REDSHIFT";
1014
+ readonly SAPHANA: "SAPHANA";
1015
+ readonly SNOWFLAKE: "SNOWFLAKE";
1016
+ readonly SQLSERVER: "SQLSERVER";
1017
+ readonly SYNAPSE: "SYNAPSE";
1018
+ readonly TERADATA: "TERADATA";
1019
+ readonly TIMESTREAM: "TIMESTREAM";
1020
+ readonly TPCDS: "TPCDS";
1021
+ readonly VERTICA: "VERTICA";
1022
+ };
1023
+ /**
1024
+ * @public
1025
+ */
1026
+ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
1027
+ /**
1028
+ * @public
1029
+ * @enum
1030
+ */
1031
+ export declare const DataCatalogStatus: {
1032
+ readonly CREATE_COMPLETE: "CREATE_COMPLETE";
1033
+ readonly CREATE_FAILED: "CREATE_FAILED";
1034
+ readonly CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE";
1035
+ readonly CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED";
1036
+ readonly CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS";
1037
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
1038
+ readonly DELETE_COMPLETE: "DELETE_COMPLETE";
1039
+ readonly DELETE_FAILED: "DELETE_FAILED";
1040
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
1041
+ };
1042
+ /**
1043
+ * @public
1044
+ */
1045
+ export type DataCatalogStatus = (typeof DataCatalogStatus)[keyof typeof DataCatalogStatus];
1046
+ /**
1047
+ * <p>Contains information about a data catalog in an Amazon Web Services account.</p>
1048
+ * <note>
1049
+ * <p>In the Athena console, data catalogs are listed as "data sources" on
1050
+ * the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
1051
+ * </note>
1052
+ * @public
1053
+ */
1054
+ export interface DataCatalog {
1055
+ /**
1056
+ * <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,
1057
+ * or hyphen characters. The remainder of the length constraint of 256 is reserved for use
1058
+ * by Athena.</p>
1059
+ * @public
1060
+ */
1061
+ Name: string | undefined;
1062
+ /**
1063
+ * <p>An optional description of the data catalog.</p>
1064
+ * @public
1065
+ */
1066
+ Description?: string;
1067
+ /**
1068
+ * <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
1069
+ * <code>GLUE</code> for an Glue Data Catalog, and <code>HIVE</code> for an
1070
+ * external Apache Hive metastore. <code>FEDERATED</code> is a federated catalog for which
1071
+ * Athena creates the connection and the Lambda function for
1072
+ * you based on the parameters that you pass.</p>
1073
+ * @public
1074
+ */
1075
+ Type: DataCatalogType | undefined;
1076
+ /**
1077
+ * <p>Specifies the Lambda function or functions to use for the data catalog.
1078
+ * This is a mapping whose values depend on the catalog type. </p>
1079
+ * <ul>
1080
+ * <li>
1081
+ * <p>For the <code>HIVE</code> data catalog type, use the following syntax. The
1082
+ * <code>metadata-function</code> parameter is required. <code>The
1083
+ * sdk-version</code> parameter is optional and defaults to the currently
1084
+ * supported version.</p>
1085
+ * <p>
1086
+ * <code>metadata-function=<i>lambda_arn</i>,
1087
+ * sdk-version=<i>version_number</i>
1088
+ * </code>
1089
+ * </p>
1090
+ * </li>
1091
+ * <li>
1092
+ * <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets
1093
+ * of required parameters, but not both.</p>
1094
+ * <ul>
1095
+ * <li>
1096
+ * <p>If you have one Lambda function that processes metadata
1097
+ * and another for reading the actual data, use the following syntax. Both
1098
+ * parameters are required.</p>
1099
+ * <p>
1100
+ * <code>metadata-function=<i>lambda_arn</i>,
1101
+ * record-function=<i>lambda_arn</i>
1102
+ * </code>
1103
+ * </p>
1104
+ * </li>
1105
+ * <li>
1106
+ * <p> If you have a composite Lambda function that processes
1107
+ * both metadata and data, use the following syntax to specify your Lambda function.</p>
1108
+ * <p>
1109
+ * <code>function=<i>lambda_arn</i>
1110
+ * </code>
1111
+ * </p>
1112
+ * </li>
1113
+ * </ul>
1114
+ * </li>
1115
+ * <li>
1116
+ * <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The
1117
+ * <code>
1118
+ * <i>catalog_id</i>
1119
+ * </code> is the account ID of the
1120
+ * Amazon Web Services account to which the Glue catalog
1121
+ * belongs.</p>
1122
+ * <p>
1123
+ * <code>catalog-id=<i>catalog_id</i>
1124
+ * </code>
1125
+ * </p>
1126
+ * <ul>
1127
+ * <li>
1128
+ * <p>The <code>GLUE</code> data catalog type also applies to the default
1129
+ * <code>AwsDataCatalog</code> that already exists in your account, of
1130
+ * which you can have only one and cannot modify.</p>
1131
+ * </li>
1132
+ * </ul>
1133
+ * </li>
1134
+ * <li>
1135
+ * <p>The <code>FEDERATED</code> data catalog type uses one of the following
1136
+ * parameters, but not both. Use <code>connection-arn</code> for an existing
1137
+ * Glue connection. Use <code>connection-type</code> and
1138
+ * <code>connection-properties</code> to specify the configuration setting for
1139
+ * a new connection.</p>
1140
+ * <ul>
1141
+ * <li>
1142
+ * <p>
1143
+ * <code>connection-arn:<i><glue_connection_arn_to_reuse></i>
1144
+ * </code>
1145
+ * </p>
1146
+ * </li>
1147
+ * <li>
1148
+ * <p>
1149
+ * <code>connection-type:MYSQL|REDSHIFT|....,
1150
+ * connection-properties:"<i><json_string></i>"</code>
1151
+ * </p>
1152
+ * <p>For <i>
1153
+ * <code><json_string></code>
1154
+ * </i>, use escaped
1155
+ * JSON text, as in the following example.</p>
1156
+ * <p>
1157
+ * <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>
1158
+ * </p>
1159
+ * </li>
1160
+ * </ul>
1161
+ * </li>
1162
+ * </ul>
1163
+ * @public
1164
+ */
1165
+ Parameters?: Record<string, string>;
1166
+ /**
1167
+ * <p>The status of the creation or deletion of the data catalog.</p>
1168
+ * <ul>
1169
+ * <li>
1170
+ * <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog
1171
+ * types are created synchronously. Their status is either
1172
+ * <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p>
1173
+ * </li>
1174
+ * <li>
1175
+ * <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p>
1176
+ * </li>
1177
+ * </ul>
1178
+ * <p>Data catalog creation status:</p>
1179
+ * <ul>
1180
+ * <li>
1181
+ * <p>
1182
+ * <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in
1183
+ * progress.</p>
1184
+ * </li>
1185
+ * <li>
1186
+ * <p>
1187
+ * <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p>
1188
+ * </li>
1189
+ * <li>
1190
+ * <p>
1191
+ * <code>CREATE_FAILED</code>: Data catalog could not be created.</p>
1192
+ * </li>
1193
+ * <li>
1194
+ * <p>
1195
+ * <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog
1196
+ * creation failed and is being removed.</p>
1197
+ * </li>
1198
+ * <li>
1199
+ * <p>
1200
+ * <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation
1201
+ * failed and was removed.</p>
1202
+ * </li>
1203
+ * <li>
1204
+ * <p>
1205
+ * <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation
1206
+ * failed but could not be removed.</p>
1207
+ * </li>
1208
+ * </ul>
1209
+ * <p>Data catalog deletion status:</p>
1210
+ * <ul>
1211
+ * <li>
1212
+ * <p>
1213
+ * <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in
1214
+ * progress.</p>
1215
+ * </li>
1216
+ * <li>
1217
+ * <p>
1218
+ * <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p>
1219
+ * </li>
1220
+ * <li>
1221
+ * <p>
1222
+ * <code>DELETE_FAILED</code>: Federated data catalog could not be
1223
+ * deleted.</p>
1224
+ * </li>
1225
+ * </ul>
1226
+ * @public
1227
+ */
1228
+ Status?: DataCatalogStatus;
1229
+ /**
1230
+ * <p>The type of connection for a <code>FEDERATED</code> data catalog (for example,
1231
+ * <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For
1232
+ * information about individual connectors, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html">Available data source
1233
+ * connectors</a>.</p>
1234
+ * @public
1235
+ */
1236
+ ConnectionType?: ConnectionType;
1237
+ /**
1238
+ * <p>Text of the error that occurred during data catalog creation or deletion.</p>
1239
+ * @public
1240
+ */
1241
+ Error?: string;
1242
+ }
951
1243
  /**
952
1244
  * @public
953
1245
  */
954
1246
  export interface CreateDataCatalogOutput {
1247
+ /**
1248
+ * <p>Contains information about a data catalog in an Amazon Web Services account.</p>
1249
+ * <note>
1250
+ * <p>In the Athena console, data catalogs are listed as "data sources" on
1251
+ * the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
1252
+ * </note>
1253
+ * @public
1254
+ */
1255
+ DataCatalog?: DataCatalog;
955
1256
  }
956
1257
  /**
957
1258
  * @public
@@ -1347,6 +1648,15 @@ export interface DeleteDataCatalogInput {
1347
1648
  * @public
1348
1649
  */
1349
1650
  export interface DeleteDataCatalogOutput {
1651
+ /**
1652
+ * <p>Contains information about a data catalog in an Amazon Web Services account.</p>
1653
+ * <note>
1654
+ * <p>In the Athena console, data catalogs are listed as "data sources" on
1655
+ * the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
1656
+ * </note>
1657
+ * @public
1658
+ */
1659
+ DataCatalog?: DataCatalog;
1350
1660
  }
1351
1661
  /**
1352
1662
  * @public
@@ -1954,97 +2264,6 @@ export interface GetDataCatalogInput {
1954
2264
  */
1955
2265
  WorkGroup?: string;
1956
2266
  }
1957
- /**
1958
- * <p>Contains information about a data catalog in an Amazon Web Services account.</p>
1959
- * <note>
1960
- * <p>In the Athena console, data catalogs are listed as "data sources" on
1961
- * the <b>Data sources</b> page under the <b>Data source name</b> column.</p>
1962
- * </note>
1963
- * @public
1964
- */
1965
- export interface DataCatalog {
1966
- /**
1967
- * <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,
1968
- * or hyphen characters. The remainder of the length constraint of 256 is reserved for use
1969
- * by Athena.</p>
1970
- * @public
1971
- */
1972
- Name: string | undefined;
1973
- /**
1974
- * <p>An optional description of the data catalog.</p>
1975
- * @public
1976
- */
1977
- Description?: string;
1978
- /**
1979
- * <p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,
1980
- * <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an
1981
- * Glue Data Catalog.</p>
1982
- * @public
1983
- */
1984
- Type: DataCatalogType | undefined;
1985
- /**
1986
- * <p>Specifies the Lambda function or functions to use for the data catalog.
1987
- * This is a mapping whose values depend on the catalog type. </p>
1988
- * <ul>
1989
- * <li>
1990
- * <p>For the <code>HIVE</code> data catalog type, use the following syntax. The
1991
- * <code>metadata-function</code> parameter is required. <code>The
1992
- * sdk-version</code> parameter is optional and defaults to the currently
1993
- * supported version.</p>
1994
- * <p>
1995
- * <code>metadata-function=<i>lambda_arn</i>,
1996
- * sdk-version=<i>version_number</i>
1997
- * </code>
1998
- * </p>
1999
- * </li>
2000
- * <li>
2001
- * <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets
2002
- * of required parameters, but not both.</p>
2003
- * <ul>
2004
- * <li>
2005
- * <p>If you have one Lambda function that processes metadata
2006
- * and another for reading the actual data, use the following syntax. Both
2007
- * parameters are required.</p>
2008
- * <p>
2009
- * <code>metadata-function=<i>lambda_arn</i>,
2010
- * record-function=<i>lambda_arn</i>
2011
- * </code>
2012
- * </p>
2013
- * </li>
2014
- * <li>
2015
- * <p> If you have a composite Lambda function that processes
2016
- * both metadata and data, use the following syntax to specify your Lambda function.</p>
2017
- * <p>
2018
- * <code>function=<i>lambda_arn</i>
2019
- * </code>
2020
- * </p>
2021
- * </li>
2022
- * </ul>
2023
- * </li>
2024
- * <li>
2025
- * <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The
2026
- * <code>
2027
- * <i>catalog_id</i>
2028
- * </code> is the account ID of the
2029
- * Amazon Web Services account to which the Glue catalog
2030
- * belongs.</p>
2031
- * <p>
2032
- * <code>catalog-id=<i>catalog_id</i>
2033
- * </code>
2034
- * </p>
2035
- * <ul>
2036
- * <li>
2037
- * <p>The <code>GLUE</code> data catalog type also applies to the default
2038
- * <code>AwsDataCatalog</code> that already exists in your account, of
2039
- * which you can have only one and cannot modify.</p>
2040
- * </li>
2041
- * </ul>
2042
- * </li>
2043
- * </ul>
2044
- * @public
2045
- */
2046
- Parameters?: Record<string, string>;
2047
- }
2048
2267
  /**
2049
2268
  * @public
2050
2269
  */
@@ -3121,6 +3340,82 @@ export interface DataCatalogSummary {
3121
3340
  * @public
3122
3341
  */
3123
3342
  Type?: DataCatalogType;
3343
+ /**
3344
+ * <p>The status of the creation or deletion of the data catalog.</p>
3345
+ * <ul>
3346
+ * <li>
3347
+ * <p>The <code>LAMBDA</code>, <code>GLUE</code>, and <code>HIVE</code> data catalog
3348
+ * types are created synchronously. Their status is either
3349
+ * <code>CREATE_COMPLETE</code> or <code>CREATE_FAILED</code>.</p>
3350
+ * </li>
3351
+ * <li>
3352
+ * <p>The <code>FEDERATED</code> data catalog type is created asynchronously.</p>
3353
+ * </li>
3354
+ * </ul>
3355
+ * <p>Data catalog creation status:</p>
3356
+ * <ul>
3357
+ * <li>
3358
+ * <p>
3359
+ * <code>CREATE_IN_PROGRESS</code>: Federated data catalog creation in
3360
+ * progress.</p>
3361
+ * </li>
3362
+ * <li>
3363
+ * <p>
3364
+ * <code>CREATE_COMPLETE</code>: Data catalog creation complete.</p>
3365
+ * </li>
3366
+ * <li>
3367
+ * <p>
3368
+ * <code>CREATE_FAILED</code>: Data catalog could not be created.</p>
3369
+ * </li>
3370
+ * <li>
3371
+ * <p>
3372
+ * <code>CREATE_FAILED_CLEANUP_IN_PROGRESS</code>: Federated data catalog
3373
+ * creation failed and is being removed.</p>
3374
+ * </li>
3375
+ * <li>
3376
+ * <p>
3377
+ * <code>CREATE_FAILED_CLEANUP_COMPLETE</code>: Federated data catalog creation
3378
+ * failed and was removed.</p>
3379
+ * </li>
3380
+ * <li>
3381
+ * <p>
3382
+ * <code>CREATE_FAILED_CLEANUP_FAILED</code>: Federated data catalog creation
3383
+ * failed but could not be removed.</p>
3384
+ * </li>
3385
+ * </ul>
3386
+ * <p>Data catalog deletion status:</p>
3387
+ * <ul>
3388
+ * <li>
3389
+ * <p>
3390
+ * <code>DELETE_IN_PROGRESS</code>: Federated data catalog deletion in
3391
+ * progress.</p>
3392
+ * </li>
3393
+ * <li>
3394
+ * <p>
3395
+ * <code>DELETE_COMPLETE</code>: Federated data catalog deleted.</p>
3396
+ * </li>
3397
+ * <li>
3398
+ * <p>
3399
+ * <code>DELETE_FAILED</code>: Federated data catalog could not be
3400
+ * deleted.</p>
3401
+ * </li>
3402
+ * </ul>
3403
+ * @public
3404
+ */
3405
+ Status?: DataCatalogStatus;
3406
+ /**
3407
+ * <p>The type of connection for a <code>FEDERATED</code> data catalog (for example,
3408
+ * <code>REDSHIFT</code>, <code>MYSQL</code>, or <code>SQLSERVER</code>). For
3409
+ * information about individual connectors, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html">Available data source
3410
+ * connectors</a>.</p>
3411
+ * @public
3412
+ */
3413
+ ConnectionType?: ConnectionType;
3414
+ /**
3415
+ * <p>Text of the error that occurred during data catalog creation or deletion.</p>
3416
+ * @public
3417
+ */
3418
+ Error?: string;
3124
3419
  }
3125
3420
  /**
3126
3421
  * @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;
@@ -190,6 +190,7 @@ export interface CreateCapacityReservationInput {
190
190
  }
191
191
  export interface CreateCapacityReservationOutput {}
192
192
  export declare const DataCatalogType: {
193
+ readonly FEDERATED: "FEDERATED";
193
194
  readonly GLUE: "GLUE";
194
195
  readonly HIVE: "HIVE";
195
196
  readonly LAMBDA: "LAMBDA";
@@ -203,7 +204,65 @@ export interface CreateDataCatalogInput {
203
204
  Parameters?: Record<string, string>;
204
205
  Tags?: Tag[];
205
206
  }
206
- export interface CreateDataCatalogOutput {}
207
+ export declare const ConnectionType: {
208
+ readonly BIGQUERY: "BIGQUERY";
209
+ readonly CLOUDERAHIVE: "CLOUDERAHIVE";
210
+ readonly CLOUDERAIMPALA: "CLOUDERAIMPALA";
211
+ readonly CLOUDWATCH: "CLOUDWATCH";
212
+ readonly CLOUDWATCHMETRICS: "CLOUDWATCHMETRICS";
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 HORTONWORKSHIVE: "HORTONWORKSHIVE";
222
+ readonly MSK: "MSK";
223
+ readonly MYSQL: "MYSQL";
224
+ readonly NEPTUNE: "NEPTUNE";
225
+ readonly OPENSEARCH: "OPENSEARCH";
226
+ readonly ORACLE: "ORACLE";
227
+ readonly POSTGRESQL: "POSTGRESQL";
228
+ readonly REDIS: "REDIS";
229
+ readonly REDSHIFT: "REDSHIFT";
230
+ readonly SAPHANA: "SAPHANA";
231
+ readonly SNOWFLAKE: "SNOWFLAKE";
232
+ readonly SQLSERVER: "SQLSERVER";
233
+ readonly SYNAPSE: "SYNAPSE";
234
+ readonly TERADATA: "TERADATA";
235
+ readonly TIMESTREAM: "TIMESTREAM";
236
+ readonly TPCDS: "TPCDS";
237
+ readonly VERTICA: "VERTICA";
238
+ };
239
+ export type ConnectionType =
240
+ (typeof ConnectionType)[keyof typeof ConnectionType];
241
+ export declare const DataCatalogStatus: {
242
+ readonly CREATE_COMPLETE: "CREATE_COMPLETE";
243
+ readonly CREATE_FAILED: "CREATE_FAILED";
244
+ readonly CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE";
245
+ readonly CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED";
246
+ readonly CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS";
247
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
248
+ readonly DELETE_COMPLETE: "DELETE_COMPLETE";
249
+ readonly DELETE_FAILED: "DELETE_FAILED";
250
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
251
+ };
252
+ export type DataCatalogStatus =
253
+ (typeof DataCatalogStatus)[keyof typeof DataCatalogStatus];
254
+ export interface DataCatalog {
255
+ Name: string | undefined;
256
+ Description?: string;
257
+ Type: DataCatalogType | undefined;
258
+ Parameters?: Record<string, string>;
259
+ Status?: DataCatalogStatus;
260
+ ConnectionType?: ConnectionType;
261
+ Error?: string;
262
+ }
263
+ export interface CreateDataCatalogOutput {
264
+ DataCatalog?: DataCatalog;
265
+ }
207
266
  export interface CreateNamedQueryInput {
208
267
  Name: string | undefined;
209
268
  Description?: string;
@@ -296,7 +355,9 @@ export interface DeleteCapacityReservationOutput {}
296
355
  export interface DeleteDataCatalogInput {
297
356
  Name: string | undefined;
298
357
  }
299
- export interface DeleteDataCatalogOutput {}
358
+ export interface DeleteDataCatalogOutput {
359
+ DataCatalog?: DataCatalog;
360
+ }
300
361
  export interface DeleteNamedQueryInput {
301
362
  NamedQueryId?: string;
302
363
  }
@@ -461,12 +522,6 @@ export interface GetDataCatalogInput {
461
522
  Name: string | undefined;
462
523
  WorkGroup?: string;
463
524
  }
464
- export interface DataCatalog {
465
- Name: string | undefined;
466
- Description?: string;
467
- Type: DataCatalogType | undefined;
468
- Parameters?: Record<string, string>;
469
- }
470
525
  export interface GetDataCatalogOutput {
471
526
  DataCatalog?: DataCatalog;
472
527
  }
@@ -717,6 +772,9 @@ export interface ListDataCatalogsInput {
717
772
  export interface DataCatalogSummary {
718
773
  CatalogName?: string;
719
774
  Type?: DataCatalogType;
775
+ Status?: DataCatalogStatus;
776
+ ConnectionType?: ConnectionType;
777
+ Error?: string;
720
778
  }
721
779
  export interface ListDataCatalogsOutput {
722
780
  DataCatalogsSummary?: DataCatalogSummary[];
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.654.0",
4
+ "version": "3.657.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",