Class: Aws::Athena::Types::DataCatalogSummary

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_name ⇒ String

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.

Returns:

  • (String) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1151

class DataCatalogSummary < Struct.new(
  :catalog_name,
  :type,
  :status,
  :connection_type,
  :error)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ String

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.

Returns:

  • (String) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1151

class DataCatalogSummary < Struct.new(
  :catalog_name,
  :type,
  :status,
  :connection_type,
  :error)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ String

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

Returns:

  • (String) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1151

class DataCatalogSummary < Struct.new(
  :catalog_name,
  :type,
  :status,
  :connection_type,
  :error)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1151

class DataCatalogSummary < Struct.new(
  :catalog_name,
  :type,
  :status,
  :connection_type,
  :error)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data catalog type.

Returns:

  • (String) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1151

class DataCatalogSummary < Struct.new(
  :catalog_name,
  :type,
  :status,
  :connection_type,
  :error)
  SENSITIVE = []
  include Aws::Structure
end