get_data_catalog

Athena.Client.get_data_catalog(**kwargs)

Returns the specified data catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_data_catalog(
    Name='string'
)

Parameters

Name (string) --

[REQUIRED]

The name of the data catalog to return.

Return type

dict

Returns

Response Syntax

{
    'DataCatalog': {
        'Name': 'string',
        'Description': 'string',
        'Type': 'LAMBDA'|'GLUE'|'HIVE',
        'Parameters': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --
  • DataCatalog (dict) --

    The data catalog returned.

    • Name (string) --

      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.

    • Description (string) --

      An optional description of the data catalog.

    • Type (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.

    • Parameters (dict) --

      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.
      • (string) --
        • (string) --

Exceptions

• Athena.Client.exceptions.InternalServerException
• Athena.Client.exceptions.InvalidRequestException