AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDataCatalog operation. Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Athena.AmazonAthenaRequest
      Amazon.Athena.Model.CreateDataCatalogRequest

Namespace: Amazon.Athena.Model
Assembly: AWSSDK.Athena.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDataCatalogRequest : AmazonAthenaRequest
         IAmazonWebServiceRequest

The CreateDataCatalogRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDataCatalogRequest()

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

A description of the data catalog to be created.

Public Property Name System.String

Gets and sets the property Name.

The name of the data catalog to create. 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.

Public Property Parameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Parameters.

Specifies the Lambda function or functions to use for creating 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 Data 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.

Public Property Tags System.Collections.Generic.List<Amazon.Athena.Model.Tag>

Gets and sets the property Tags.

A list of comma separated tags to add to the data catalog that is created.

Public Property Type Amazon.Athena.DataCatalogType

Gets and sets the property Type.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5