Class: Aws::Athena::Types::DataCatalog

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

An optional description of the data catalog.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 971

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 971

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

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.

    ^

Returns:

  • (Hash<String,String>) 


971
972
973
974
975
976
977
978
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 971

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 971

class DataCatalog < Struct.new(
  :name,
  :description,
  :type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end