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.

The summary information for the data catalog, which includes its name and type.

Inheritance Hierarchy

System.Object
  Amazon.Athena.Model.DataCatalogSummary

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

Syntax

C#
public class DataCatalogSummary

The DataCatalogSummary type exposes the following members

Constructors

NameDescription
Public Method DataCatalogSummary()

Properties

NameTypeDescription
Public Property CatalogName System.String

Gets and sets the property CatalogName.

The name of the data catalog. The catalog name is 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 ConnectionType Amazon.Athena.ConnectionType

Gets and sets the property ConnectionType.

The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.

Public Property Error System.String

Gets and sets the property Error.

Text of the error that occurred during data catalog creation or deletion.

Public Property Status Amazon.Athena.DataCatalogStatus

Gets and sets the property Status.

The status of the creation or deletion of the data catalog.

  • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.

  • The FEDERATED data catalog type is created asynchronously.

Data catalog creation status:

  • CREATE_IN_PROGRESS: Federated data catalog creation in progress.

  • CREATE_COMPLETE: Data catalog creation complete.

  • CREATE_FAILED: Data catalog could not be created.

  • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.

  • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.

  • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

Data catalog deletion status:

  • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.

  • DELETE_COMPLETE: Federated data catalog deleted.

  • DELETE_FAILED: Federated data catalog could not be deleted.

Public Property Type Amazon.Athena.DataCatalogType

Gets and sets the property Type.

The data catalog type.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5