/AWS1/CL_ATHDATACATALOG

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/ATHCATALOGNAMESTRING /AWS1/ATHCATALOGNAMESTRING

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.

iv_type TYPE /AWS1/ATHDATACATALOGTYPE /AWS1/ATHDATACATALOGTYPE

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.

Optional arguments:

iv_description TYPE /AWS1/ATHDESCRIPTIONSTRING /AWS1/ATHDESCRIPTIONSTRING

An optional description of the data catalog.

it_parameters TYPE /AWS1/CL_ATHPARAMETERSMAP_W=>TT_PARAMETERSMAP TT_PARAMETERSMAP

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

iv_status TYPE /AWS1/ATHDATACATALOGSTATUS /AWS1/ATHDATACATALOGSTATUS

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.

iv_connectiontype TYPE /AWS1/ATHCONNECTIONTYPE /AWS1/ATHCONNECTIONTYPE

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.

iv_error TYPE /AWS1/ATHERRORMESSAGE /AWS1/ATHERRORMESSAGE

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

---

Queryable Attributes

Name

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.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Description

An optional description of the data catalog.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Type

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.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

Parameters

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

Accessible with the following methods

Method	Description
GET_PARAMETERS()	Getter for PARAMETERS, with configurable default
ASK_PARAMETERS()	Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS()	Determine if PARAMETERS has a value

Status

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.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

ConnectionType

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.

Accessible with the following methods

Method	Description
GET_CONNECTIONTYPE()	Getter for CONNECTIONTYPE, with configurable default
ASK_CONNECTIONTYPE()	Getter for CONNECTIONTYPE w/ exceptions if field has no valu
HAS_CONNECTIONTYPE()	Determine if CONNECTIONTYPE has a value

Error

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

Accessible with the following methods

Method	Description
GET_ERROR()	Getter for ERROR, with configurable default
ASK_ERROR()	Getter for ERROR w/ exceptions if field has no value
HAS_ERROR()	Determine if ERROR has a value