Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DataCatalog

import type { DataCatalog } from "https://aws-api.deno.dev/v0.3/services/athena.ts?docs=full";

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

interface DataCatalog {
Description?: string | null;
Name: string;
Parameters?: {
[key: string]: string | null | undefined;
} | null;
Type: DataCatalogType;
}

§Properties

§
Description?: string | null
[src]

An optional description of the data catalog.

§
Name: string
[src]

The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

§
Parameters?: {
[key: string]: string | null | undefined;
} | null
[src]

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.
    • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.
§
Type: DataCatalogType
[src]

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.