diff --git a/clients/client-athena/src/commands/CreateDataCatalogCommand.ts b/clients/client-athena/src/commands/CreateDataCatalogCommand.ts index 1c9af2931d53..ea82efa22b2e 100644 --- a/clients/client-athena/src/commands/CreateDataCatalogCommand.ts +++ b/clients/client-athena/src/commands/CreateDataCatalogCommand.ts @@ -38,7 +38,7 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput, * const client = new AthenaClient(config); * const input = { // CreateDataCatalogInput * Name: "STRING_VALUE", // required - * Type: "LAMBDA" || "GLUE" || "HIVE", // required + * Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required * Description: "STRING_VALUE", * Parameters: { // ParametersMap * "": "STRING_VALUE", @@ -52,7 +52,19 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput, * }; * const command = new CreateDataCatalogCommand(input); * const response = await client.send(command); - * // {}; + * // { // CreateDataCatalogOutput + * // DataCatalog: { // DataCatalog + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required + * // Parameters: { // ParametersMap + * // "": "STRING_VALUE", + * // }, + * // 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", + * // 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", + * // Error: "STRING_VALUE", + * // }, + * // }; * * ``` * @@ -100,7 +112,7 @@ export class CreateDataCatalogCommand extends $Command protected declare static __types: { api: { input: CreateDataCatalogInput; - output: {}; + output: CreateDataCatalogOutput; }; sdk: { input: CreateDataCatalogCommandInput; diff --git a/clients/client-athena/src/commands/DeleteDataCatalogCommand.ts b/clients/client-athena/src/commands/DeleteDataCatalogCommand.ts index fc0e8a0f6bde..8db0db79da5d 100644 --- a/clients/client-athena/src/commands/DeleteDataCatalogCommand.ts +++ b/clients/client-athena/src/commands/DeleteDataCatalogCommand.ts @@ -40,7 +40,19 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput, * }; * const command = new DeleteDataCatalogCommand(input); * const response = await client.send(command); - * // {}; + * // { // DeleteDataCatalogOutput + * // DataCatalog: { // DataCatalog + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required + * // Parameters: { // ParametersMap + * // "": "STRING_VALUE", + * // }, + * // 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", + * // 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", + * // Error: "STRING_VALUE", + * // }, + * // }; * * ``` * @@ -88,7 +100,7 @@ export class DeleteDataCatalogCommand extends $Command protected declare static __types: { api: { input: DeleteDataCatalogInput; - output: {}; + output: DeleteDataCatalogOutput; }; sdk: { input: DeleteDataCatalogCommandInput; diff --git a/clients/client-athena/src/commands/GetDataCatalogCommand.ts b/clients/client-athena/src/commands/GetDataCatalogCommand.ts index fc1b2615ef1a..5b43ba94e594 100644 --- a/clients/client-athena/src/commands/GetDataCatalogCommand.ts +++ b/clients/client-athena/src/commands/GetDataCatalogCommand.ts @@ -45,10 +45,13 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met * // DataCatalog: { // DataCatalog * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", - * // Type: "LAMBDA" || "GLUE" || "HIVE", // required + * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required * // Parameters: { // ParametersMap * // "": "STRING_VALUE", * // }, + * // 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", + * // 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", + * // Error: "STRING_VALUE", * // }, * // }; * diff --git a/clients/client-athena/src/commands/ListDataCatalogsCommand.ts b/clients/client-athena/src/commands/ListDataCatalogsCommand.ts index 6b7a898e0452..c762228ea421 100644 --- a/clients/client-athena/src/commands/ListDataCatalogsCommand.ts +++ b/clients/client-athena/src/commands/ListDataCatalogsCommand.ts @@ -50,7 +50,10 @@ export interface ListDataCatalogsCommandOutput extends ListDataCatalogsOutput, _ * // DataCatalogsSummary: [ // DataCatalogSummaryList * // { // DataCatalogSummary * // CatalogName: "STRING_VALUE", - * // Type: "LAMBDA" || "GLUE" || "HIVE", + * // Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", + * // 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", + * // 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", + * // Error: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-athena/src/commands/UpdateDataCatalogCommand.ts b/clients/client-athena/src/commands/UpdateDataCatalogCommand.ts index 335b4069f2bf..50ece0fa59af 100644 --- a/clients/client-athena/src/commands/UpdateDataCatalogCommand.ts +++ b/clients/client-athena/src/commands/UpdateDataCatalogCommand.ts @@ -37,7 +37,7 @@ export interface UpdateDataCatalogCommandOutput extends UpdateDataCatalogOutput, * const client = new AthenaClient(config); * const input = { // UpdateDataCatalogInput * Name: "STRING_VALUE", // required - * Type: "LAMBDA" || "GLUE" || "HIVE", // required + * Type: "LAMBDA" || "GLUE" || "HIVE" || "FEDERATED", // required * Description: "STRING_VALUE", * Parameters: { // ParametersMap * "": "STRING_VALUE", diff --git a/clients/client-athena/src/models/models_0.ts b/clients/client-athena/src/models/models_0.ts index 65809b2ce6a7..db7a71ef6488 100644 --- a/clients/client-athena/src/models/models_0.ts +++ b/clients/client-athena/src/models/models_0.ts @@ -966,6 +966,7 @@ export interface CreateCapacityReservationOutput {} * @enum */ export const DataCatalogType = { + FEDERATED: "FEDERATED", GLUE: "GLUE", HIVE: "HIVE", LAMBDA: "LAMBDA", @@ -991,8 +992,10 @@ export interface CreateDataCatalogInput { /** *

The type of data catalog to create: LAMBDA for a federated catalog, - * HIVE for an external hive metastore, or GLUE for an - * Glue Data Catalog.

+ * GLUE for an Glue Data Catalog, and HIVE for an + * external Apache Hive metastore. FEDERATED is a federated catalog for which + * Athena creates the connection and the Lambda function for + * you based on the parameters that you pass.

* @public */ Type: DataCatalogType | undefined; @@ -1061,6 +1064,39 @@ export interface CreateDataCatalogInput { * * * + *
  • + *

    The FEDERATED data catalog type uses one of the following + * parameters, but not both. Use connection-arn for an existing + * Glue connection. Use connection-type and + * connection-properties to specify the configuration setting for + * a new connection.

    + *
      + *
    • + *

      + * connection-arn: + * + *

      + *
      • + *
    • + *

      + * lambda-role-arn (optional): The execution role to use for the + * Lambda function. If not provided, one is created.

      + *
      • + *
    • + *

      + * connection-type:MYSQL|REDSHIFT|...., + * connection-properties:"" + *

      + *

      For + * + * , use escaped + * JSON text, as in the following example.

      + *

      + * "\{\"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\"\}" + *

      + *
      • + *
    + *
    • * * @public */ @@ -1073,10 +1109,287 @@ export interface CreateDataCatalogInput { Tags?: Tag[]; } +/** + * @public + * @enum + */ +export const ConnectionType = { + BIGQUERY: "BIGQUERY", + CLOUDERAHIVE: "CLOUDERAHIVE", + CLOUDERAIMPALA: "CLOUDERAIMPALA", + CLOUDWATCH: "CLOUDWATCH", + CLOUDWATCHMETRICS: "CLOUDWATCHMETRICS", + CMDB: "CMDB", + DATALAKEGEN2: "DATALAKEGEN2", + DB2: "DB2", + DB2AS400: "DB2AS400", + DOCUMENTDB: "DOCUMENTDB", + DYNAMODB: "DYNAMODB", + GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE", + HBASE: "HBASE", + HORTONWORKSHIVE: "HORTONWORKSHIVE", + MSK: "MSK", + MYSQL: "MYSQL", + NEPTUNE: "NEPTUNE", + OPENSEARCH: "OPENSEARCH", + ORACLE: "ORACLE", + POSTGRESQL: "POSTGRESQL", + REDIS: "REDIS", + REDSHIFT: "REDSHIFT", + SAPHANA: "SAPHANA", + SNOWFLAKE: "SNOWFLAKE", + SQLSERVER: "SQLSERVER", + SYNAPSE: "SYNAPSE", + TERADATA: "TERADATA", + TIMESTREAM: "TIMESTREAM", + TPCDS: "TPCDS", + VERTICA: "VERTICA", +} as const; + +/** + * @public + */ +export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType]; + +/** + * @public + * @enum + */ +export const DataCatalogStatus = { + CREATE_COMPLETE: "CREATE_COMPLETE", + CREATE_FAILED: "CREATE_FAILED", + CREATE_FAILED_CLEANUP_COMPLETE: "CREATE_FAILED_CLEANUP_COMPLETE", + CREATE_FAILED_CLEANUP_FAILED: "CREATE_FAILED_CLEANUP_FAILED", + CREATE_FAILED_CLEANUP_IN_PROGRESS: "CREATE_FAILED_CLEANUP_IN_PROGRESS", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + DELETE_COMPLETE: "DELETE_COMPLETE", + DELETE_FAILED: "DELETE_FAILED", + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", +} as const; + /** * @public */ -export interface CreateDataCatalogOutput {} +export type DataCatalogStatus = (typeof DataCatalogStatus)[keyof typeof DataCatalogStatus]; + +/** + *

    Contains information about a data catalog in an Amazon Web Services account.

    + * + *

    In the Athena console, data catalogs are listed as "data sources" on + * the Data sources page under the Data source name column.

    + *     + * @public + */ +export interface DataCatalog { + /** + *

    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, + * or hyphen characters. The remainder of the length constraint of 256 is reserved for use + * by Athena.

    + * @public + */ + Name: string | undefined; + + /** + *

    An optional description of the data catalog.

    + * @public + */ + Description?: string; + + /** + *

    The type of data catalog to create: LAMBDA for a federated catalog, + * GLUE for an Glue Data Catalog, and HIVE for an + * external Apache Hive metastore. FEDERATED is a federated catalog for which + * Athena creates the connection and the Lambda function for + * you based on the parameters that you pass.

    + * @public + */ + Type: DataCatalogType | undefined; + + /** + *

    Specifies the Lambda function or functions to use for the data catalog. + * This is a mapping whose values depend on the catalog type.

    + *
      + *
    • + *

      For the HIVE data catalog type, use the following syntax. The + * metadata-function parameter is required. The + * sdk-version parameter is optional and defaults to the currently + * supported version.

      + *

      + * metadata-function=lambda_arn, + * sdk-version=version_number + * + *

      + *
      • + *
    • + *

      For the LAMBDA data catalog type, use one of the following sets + * of required parameters, but not both.

      + *
        + *
      • + *

        If you have one Lambda function that processes metadata + * and another for reading the actual data, use the following syntax. Both + * parameters are required.

        + *

        + * metadata-function=lambda_arn, + * record-function=lambda_arn + * + *

        + *
        • + *
      • + *

        If you have a composite Lambda function that processes + * both metadata and data, use the following syntax to specify your Lambda function.

        + *

        + * function=lambda_arn + * + *

        + *
        • + *
      + *
      • + *
    • + *

      The GLUE type takes a catalog ID parameter and is required. The + * + * catalog_id + * is the account ID of the + * Amazon Web Services account to which the Glue catalog + * belongs.

      + *

      + * catalog-id=catalog_id + * + *

      + *
        + *
      • + *

        The GLUE data catalog type also applies to the default + * AwsDataCatalog that already exists in your account, of + * which you can have only one and cannot modify.

        + *
        • + *
      + *
      • + *
    • + *

      The FEDERATED data catalog type uses one of the following + * parameters, but not both. Use connection-arn for an existing + * Glue connection. Use connection-type and + * connection-properties to specify the configuration setting for + * a new connection.

      + *
        + *
      • + *

        + * connection-arn: + * + *

        + *
        • + *
      • + *

        + * connection-type:MYSQL|REDSHIFT|...., + * connection-properties:"" + *

        + *

        For + * + * , use escaped + * JSON text, as in the following example.

        + *

        + * "\{\"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\"\}" + *

        + *
        • + *
      + *
      • + *
    + * @public + */ + Parameters?: Record; + + /** + *

    The status of the creation or deletion of the data catalog.

    + *
      + *
    • + *

      The LAMBDA, GLUE, and HIVE data catalog + * types are created synchronously. Their status is either + * CREATE_COMPLETE or CREATE_FAILED.

      + *
      • + *
    • + *

      The FEDERATED data catalog type is created asynchronously.

      + *
      • + *
    + *

    Data catalog creation status:

    + *
      + *
    • + *

      + * CREATE_IN_PROGRESS: Federated data catalog creation in + * progress.

      + *
      • + *
    • + *

      + * CREATE_COMPLETE: Data catalog creation complete.

      + *
      • + *
    • + *

      + * CREATE_FAILED: Data catalog could not be created.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog + * creation failed and is being removed.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation + * failed and was removed.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation + * failed but could not be removed.

      + *
      • + *
    + *

    Data catalog deletion status:

    + *
      + *
    • + *

      + * DELETE_IN_PROGRESS: Federated data catalog deletion in + * progress.

      + *
      • + *
    • + *

      + * DELETE_COMPLETE: Federated data catalog deleted.

      + *
      • + *
    • + *

      + * DELETE_FAILED: Federated data catalog could not be + * deleted.

      + *
      • + *
    + * @public + */ + Status?: DataCatalogStatus; + + /** + *

    The type of connection for a FEDERATED data catalog (for example, + * REDSHIFT, MYSQL, or SQLSERVER). For + * information about individual connectors, see Available data source + * connectors.

    + * @public + */ + ConnectionType?: ConnectionType; + + /** + *

    Text of the error that occurred during data catalog creation or deletion.

    + * @public + */ + Error?: string; +} + +/** + * @public + */ +export interface CreateDataCatalogOutput { + /** + *

    Contains information about a data catalog in an Amazon Web Services account.

    + * + *

    In the Athena console, data catalogs are listed as "data sources" on + * the Data sources page under the Data source name column.

    + *     + * @public + */ + DataCatalog?: DataCatalog; +} /** * @public @@ -1533,7 +1846,17 @@ export interface DeleteDataCatalogInput { /** * @public */ -export interface DeleteDataCatalogOutput {} +export interface DeleteDataCatalogOutput { + /** + *

    Contains information about a data catalog in an Amazon Web Services account.

    + * + *

    In the Athena console, data catalogs are listed as "data sources" on + * the Data sources page under the Data source name column.

    + *     + * @public + */ + DataCatalog?: DataCatalog; +} /** * @public @@ -2223,101 +2546,6 @@ export interface GetDataCatalogInput { WorkGroup?: string; } -/** - *

    Contains information about a data catalog in an Amazon Web Services account.

    - * - *

    In the Athena console, data catalogs are listed as "data sources" on - * the Data sources page under the Data source name column.

    - *     - * @public - */ -export interface DataCatalog { - /** - *

    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, - * or hyphen characters. The remainder of the length constraint of 256 is reserved for use - * by Athena.

    - * @public - */ - Name: string | undefined; - - /** - *

    An optional description of the data catalog.

    - * @public - */ - Description?: string; - - /** - *

    The type of data catalog to create: LAMBDA for a federated catalog, - * HIVE for an external hive metastore, or GLUE for an - * Glue Data Catalog.

    - * @public - */ - Type: DataCatalogType | undefined; - - /** - *

    Specifies the Lambda function or functions to use for the data catalog. - * This is a mapping whose values depend on the catalog type.

    - *
      - *
    • - *

      For the HIVE data catalog type, use the following syntax. The - * metadata-function parameter is required. The - * sdk-version parameter is optional and defaults to the currently - * supported version.

      - *

      - * metadata-function=lambda_arn, - * sdk-version=version_number - * - *

      - *
      • - *
    • - *

      For the LAMBDA data catalog type, use one of the following sets - * of required parameters, but not both.

      - *
        - *
      • - *

        If you have one Lambda function that processes metadata - * and another for reading the actual data, use the following syntax. Both - * parameters are required.

        - *

        - * metadata-function=lambda_arn, - * record-function=lambda_arn - * - *

        - *
        • - *
      • - *

        If you have a composite Lambda function that processes - * both metadata and data, use the following syntax to specify your Lambda function.

        - *

        - * function=lambda_arn - * - *

        - *
        • - *
      - *
      • - *
    • - *

      The GLUE type takes a catalog ID parameter and is required. The - * - * catalog_id - * is the account ID of the - * Amazon Web Services account to which the Glue catalog - * belongs.

      - *

      - * catalog-id=catalog_id - * - *

      - *
        - *
      • - *

        The GLUE data catalog type also applies to the default - * AwsDataCatalog that already exists in your account, of - * which you can have only one and cannot modify.

        - *
        • - *
      - *
      • - *
    - * @public - */ - Parameters?: Record; -} - /** * @public */ @@ -3530,6 +3758,85 @@ export interface DataCatalogSummary { * @public */ Type?: DataCatalogType; + + /** + *

    The status of the creation or deletion of the data catalog.

    + *
      + *
    • + *

      The LAMBDA, GLUE, and HIVE data catalog + * types are created synchronously. Their status is either + * CREATE_COMPLETE or CREATE_FAILED.

      + *
      • + *
    • + *

      The FEDERATED data catalog type is created asynchronously.

      + *
      • + *
    + *

    Data catalog creation status:

    + *
      + *
    • + *

      + * CREATE_IN_PROGRESS: Federated data catalog creation in + * progress.

      + *
      • + *
    • + *

      + * CREATE_COMPLETE: Data catalog creation complete.

      + *
      • + *
    • + *

      + * CREATE_FAILED: Data catalog could not be created.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog + * creation failed and is being removed.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation + * failed and was removed.

      + *
      • + *
    • + *

      + * CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation + * failed but could not be removed.

      + *
      • + *
    + *

    Data catalog deletion status:

    + *
      + *
    • + *

      + * DELETE_IN_PROGRESS: Federated data catalog deletion in + * progress.

      + *
      • + *
    • + *

      + * DELETE_COMPLETE: Federated data catalog deleted.

      + *
      • + *
    • + *

      + * DELETE_FAILED: Federated data catalog could not be + * deleted.

      + *
      • + *
    + * @public + */ + Status?: DataCatalogStatus; + + /** + *

    The type of connection for a FEDERATED data catalog (for example, + * REDSHIFT, MYSQL, or SQLSERVER). For + * information about individual connectors, see Available data source + * connectors.

    + * @public + */ + ConnectionType?: ConnectionType; + + /** + *

    Text of the error that occurred during data catalog creation or deletion.

    + * @public + */ + Error?: string; } /** diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json index 78f4b634fef3..dc44431e37d3 100644 --- a/codegen/sdk-codegen/aws-models/athena.json +++ b/codegen/sdk-codegen/aws-models/athena.json @@ -2172,6 +2172,191 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.athena#ConnectionType": { + "type": "enum", + "members": { + "DYNAMODB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "SYNAPSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNAPSE" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "DB2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2" + } + }, + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + }, + "GOOGLECLOUDSTORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLECLOUDSTORAGE" + } + }, + "HBASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HBASE" + } + }, + "DOCUMENTDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENTDB" + } + }, + "MSK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSK" + } + }, + "NEPTUNE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEPTUNE" + } + }, + "CMDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMDB" + } + }, + "TPCDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TPCDS" + } + }, + "REDIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIS" + } + }, + "CLOUDWATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH" + } + }, + "TIMESTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTREAM" + } + }, + "SAPHANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPHANA" + } + }, + "SNOWFLAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOWFLAKE" + } + }, + "TERADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATA" + } + }, + "VERTICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICA" + } + }, + "CLOUDERAIMPALA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDERAIMPALA" + } + }, + "CLOUDERAHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDERAHIVE" + } + }, + "HORTONWORKSHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORTONWORKSHIVE" + } + }, + "DATALAKEGEN2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATALAKEGEN2" + } + }, + "DB2AS400": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2AS400" + } + }, + "CLOUDWATCHMETRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCHMETRICS" + } + } + } + }, "com.amazonaws.athena#CoordinatorDpuSize": { "type": "integer", "traits": { @@ -2270,7 +2455,7 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

    The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

    ", + "smithy.api#documentation": "

    The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.

    ", "smithy.api#required": {} } }, @@ -2283,7 +2468,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

    Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

    \n
      \n
    • \n

      For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

      \n

      \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

      \n
      • \n
    • \n

      For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

      \n
        \n
      • \n

        If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

        \n

        \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

        \n
        • \n
      • \n

        If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

        \n

        \n function=lambda_arn\n \n

        \n
        • \n
      \n
      • \n
    • \n

      The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.

      \n

      \n catalog-id=catalog_id\n \n

      \n
        \n
      • \n

        The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

    \n
      \n
    • \n

      For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

      \n

      \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

      \n
      • \n
    • \n

      For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

      \n
        \n
      • \n

        If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

        \n

        \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

        \n
        • \n
      • \n

        If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

        \n

        \n function=lambda_arn\n \n

        \n
        • \n
      \n
      • \n
    • \n

      The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.

      \n

      \n catalog-id=catalog_id\n \n

      \n
        \n
      • \n

        The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

        \n
        • \n
      \n
      • \n
    • \n

      The FEDERATED data catalog type uses one of the following\n parameters, but not both. Use connection-arn for an existing\n Glue connection. Use connection-type and\n connection-properties to specify the configuration setting for\n a new connection.

      \n
        \n
      • \n

        \n connection-arn:\n \n

        \n
        • \n
      • \n

        \n lambda-role-arn (optional): The execution role to use for the\n Lambda function. If not provided, one is created.

        \n
        • \n
      • \n

        \n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"\"\n

        \n

        For \n \n , use escaped\n JSON text, as in the following example.

        \n

        \n \"{\\\"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\\\"}\"\n

        \n
        • \n
      \n
      • \n
    " } }, "Tags": { @@ -2299,7 +2484,11 @@ }, "com.amazonaws.athena#CreateDataCatalogOutput": { "type": "structure", - "members": {}, + "members": { + "DataCatalog": { + "target": "com.amazonaws.athena#DataCatalog" + } + }, "traits": { "smithy.api#output": {} } @@ -2675,14 +2864,32 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

    The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

    ", + "smithy.api#documentation": "

    The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.

    ", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

    Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

    \n
      \n
    • \n

      For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

      \n

      \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

      \n
      • \n
    • \n

      For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

      \n
        \n
      • \n

        If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

        \n

        \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

        \n
        • \n
      • \n

        If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

        \n

        \n function=lambda_arn\n \n

        \n
        • \n
      \n
      • \n
    • \n

      The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.

      \n

      \n catalog-id=catalog_id\n \n

      \n
        \n
      • \n

        The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

    \n
      \n
    • \n

      For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

      \n

      \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

      \n
      • \n
    • \n

      For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

      \n
        \n
      • \n

        If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

        \n

        \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

        \n
        • \n
      • \n

        If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

        \n

        \n function=lambda_arn\n \n

        \n
        • \n
      \n
      • \n
    • \n

      The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.

      \n

      \n catalog-id=catalog_id\n \n

      \n
        \n
      • \n

        The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

        \n
        • \n
      \n
      • \n
    • \n

      The FEDERATED data catalog type uses one of the following\n parameters, but not both. Use connection-arn for an existing\n Glue connection. Use connection-type and\n connection-properties to specify the configuration setting for\n a new connection.

      \n
        \n
      • \n

        \n connection-arn:\n \n

        \n
        • \n
      • \n

        \n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"\"\n

        \n

        For \n \n , use escaped\n JSON text, as in the following example.

        \n

        \n \"{\\\"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\\\"}\"\n

        \n
        • \n
      \n
      • \n
    " + } + }, + "Status": { + "target": "com.amazonaws.athena#DataCatalogStatus", + "traits": { + "smithy.api#documentation": "

    The status of the creation or deletion of the data catalog.

    \n
      \n
    • \n

      The LAMBDA, GLUE, and HIVE data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE or CREATE_FAILED.

      \n
      • \n
    • \n

      The FEDERATED data catalog type is created asynchronously.

      \n
      • \n
    \n

    Data catalog creation status:

    \n
      \n
    • \n

      \n CREATE_IN_PROGRESS: Federated data catalog creation in\n progress.

      \n
      • \n
    • \n

      \n CREATE_COMPLETE: Data catalog creation complete.

      \n
      • \n
    • \n

      \n CREATE_FAILED: Data catalog could not be created.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog\n creation failed and is being removed.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation\n failed and was removed.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation\n failed but could not be removed.

      \n
      • \n
    \n

    Data catalog deletion status:

    \n
      \n
    • \n

      \n DELETE_IN_PROGRESS: Federated data catalog deletion in\n progress.

      \n
      • \n
    • \n

      \n DELETE_COMPLETE: Federated data catalog deleted.

      \n
      • \n
    • \n

      \n DELETE_FAILED: Federated data catalog could not be\n deleted.

      \n
      • \n
    " + } + }, + "ConnectionType": { + "target": "com.amazonaws.athena#ConnectionType", + "traits": { + "smithy.api#documentation": "

    The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

    " + } + }, + "Error": { + "target": "com.amazonaws.athena#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    Text of the error that occurred during data catalog creation or deletion.

    " } } }, @@ -2690,6 +2897,65 @@ "smithy.api#documentation": "

    Contains information about a data catalog in an Amazon Web Services account.

    \n \n

    In the Athena console, data catalogs are listed as \"data sources\" on\n the Data sources page under the Data source name column.

    \n     " } }, + "com.amazonaws.athena#DataCatalogStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "CREATE_FAILED_CLEANUP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_IN_PROGRESS" + } + }, + "CREATE_FAILED_CLEANUP_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_COMPLETE" + } + }, + "CREATE_FAILED_CLEANUP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_COMPLETE" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, "com.amazonaws.athena#DataCatalogSummary": { "type": "structure", "members": { @@ -2704,6 +2970,24 @@ "traits": { "smithy.api#documentation": "

    The data catalog type.

    " } + }, + "Status": { + "target": "com.amazonaws.athena#DataCatalogStatus", + "traits": { + "smithy.api#documentation": "

    The status of the creation or deletion of the data catalog.

    \n
      \n
    • \n

      The LAMBDA, GLUE, and HIVE data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE or CREATE_FAILED.

      \n
      • \n
    • \n

      The FEDERATED data catalog type is created asynchronously.

      \n
      • \n
    \n

    Data catalog creation status:

    \n
      \n
    • \n

      \n CREATE_IN_PROGRESS: Federated data catalog creation in\n progress.

      \n
      • \n
    • \n

      \n CREATE_COMPLETE: Data catalog creation complete.

      \n
      • \n
    • \n

      \n CREATE_FAILED: Data catalog could not be created.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog\n creation failed and is being removed.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation\n failed and was removed.

      \n
      • \n
    • \n

      \n CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation\n failed but could not be removed.

      \n
      • \n
    \n

    Data catalog deletion status:

    \n
      \n
    • \n

      \n DELETE_IN_PROGRESS: Federated data catalog deletion in\n progress.

      \n
      • \n
    • \n

      \n DELETE_COMPLETE: Federated data catalog deleted.

      \n
      • \n
    • \n

      \n DELETE_FAILED: Federated data catalog could not be\n deleted.

      \n
      • \n
    " + } + }, + "ConnectionType": { + "target": "com.amazonaws.athena#ConnectionType", + "traits": { + "smithy.api#documentation": "

    The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

    " + } + }, + "Error": { + "target": "com.amazonaws.athena#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    Text of the error that occurred during data catalog creation or deletion.

    " + } } }, "traits": { @@ -2736,6 +3020,12 @@ "traits": { "smithy.api#enumValue": "HIVE" } + }, + "FEDERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEDERATED" + } } } }, @@ -2887,7 +3177,11 @@ }, "com.amazonaws.athena#DeleteDataCatalogOutput": { "type": "structure", - "members": {}, + "members": { + "DataCatalog": { + "target": "com.amazonaws.athena#DataCatalog" + } + }, "traits": { "smithy.api#output": {} }