Skip to content

/AWS1/CL_ATHDATACATALOGSUMMARY

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_catalogname TYPE /AWS1/ATHCATALOGNAMESTRING /AWS1/ATHCATALOGNAMESTRING

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.

iv_type TYPE /AWS1/ATHDATACATALOGTYPE /AWS1/ATHDATACATALOGTYPE

The data catalog type.

iv_status TYPE /AWS1/ATHDATACATALOGSTATUS /AWS1/ATHDATACATALOGSTATUS

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.

iv_connectiontype TYPE /AWS1/ATHCONNECTIONTYPE /AWS1/ATHCONNECTIONTYPE

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.

iv_error TYPE /AWS1/ATHERRORMESSAGE /AWS1/ATHERRORMESSAGE

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

Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_CATALOGNAME() Getter for CATALOGNAME, with configurable default
ASK_CATALOGNAME() Getter for CATALOGNAME w/ exceptions if field has no value
HAS_CATALOGNAME() Determine if CATALOGNAME has a value

Type

The data catalog type.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

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.

Accessible with the following methods

Method Description
GET_CONNECTIONTYPE() Getter for CONNECTIONTYPE, with configurable default
ASK_CONNECTIONTYPE() Getter for CONNECTIONTYPE w/ exceptions if field has no valu
HAS_CONNECTIONTYPE() Determine if CONNECTIONTYPE has a value

Error

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

Accessible with the following methods

Method Description
GET_ERROR() Getter for ERROR, with configurable default
ASK_ERROR() Getter for ERROR w/ exceptions if field has no value
HAS_ERROR() Determine if ERROR has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_DATACATALOGSUMMARYLIST

TYPES TT_DATACATALOGSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ATHDATACATALOGSUMMARY WITH DEFAULT KEY
.