DataCatalog

Contains information about a data catalog in an AWS account.

Note

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

Name

The name of the data catalog. The catalog name must be unique for the AWS 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Type

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

Type: String

Valid Values: LAMBDA | GLUE | HIVE

Required: Yes

Description

An optional description of the data catalog.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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 AWS account to which the AWS 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.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Key Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Value Length Constraints: Maximum length of 51200.

Required: No

DataCatalog

Note

Contents

See Also