Table
Represents a collection of related data organized in columns and rows.
Contents
- Name
-
The table name. For Hive compatibility, this must be entirely lowercase.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- CatalogId
-
The ID of the Data Catalog in which the table resides.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- CreatedBy
-
The person or entity who created the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- CreateTime
-
The time when the table definition was created in the Data Catalog.
Type: Timestamp
Required: No
- DatabaseName
-
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- Description
-
A description of the table.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- FederatedTable
-
A
FederatedTablestructure that references an entity outside the AWS Glue Data Catalog.Type: FederatedTable object
Required: No
- IsMultiDialectView
-
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Type: Boolean
Required: No
- IsRegisteredWithLakeFormation
-
Indicates whether the table has been registered with AWS Lake Formation.
Type: Boolean
Required: No
- LastAccessTime
-
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
Type: Timestamp
Required: No
- LastAnalyzedTime
-
The last time that column statistics were computed for this table.
Type: Timestamp
Required: No
- Owner
-
The owner of the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- Parameters
-
These key-value pairs define properties associated with the table.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Value Length Constraints: Maximum length of 512000.
Required: No
- PartitionKeys
-
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys, you must at least set the value ofpartitionKeysto an empty list. For example:"PartitionKeys": []Type: Array of Column objects
Required: No
- Retention
-
The retention time for this table.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- Status
-
A structure containing information about the state of an asynchronous change to a table.
Type: TableStatus object
Required: No
- StorageDescriptor
-
A storage descriptor containing information about the physical storage of this table.
Type: StorageDescriptor object
Required: No
- TableType
-
The type of this table. AWS Glue will create tables with the
EXTERNAL_TABLEtype. Other services, such as Athena, may create tables with additional table types.AWS Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by AWS Lake Formation. The AWS Glue Data Catalog understands
GOVERNED.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- TargetTable
-
A
TableIdentifierstructure that describes a target table for resource linking.Type: TableIdentifier object
Required: No
- UpdateTime
-
The last time that the table was updated.
Type: Timestamp
Required: No
- VersionId
-
The ID of the table version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- ViewDefinition
-
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
Type: ViewDefinition object
Required: No
- ViewExpandedText
-
Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.
Type: String
Length Constraints: Maximum length of 409600.
Required: No
- ViewOriginalText
-
Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations. If the table is a
VIRTUAL_VIEW, certain Athena configuration encoded in base64.Type: String
Length Constraints: Maximum length of 409600.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
