2025/06/27 - AWS Glue - 16 updated api methods
Changes AWS Glue now supports schema, partition and sort management of Apache Iceberg tables using Glue SDK
{'CatalogInput': {'FederatedCatalog': {'ConnectionType': 'string'}}}
Creates a new catalog in the Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_catalog(
Name='string',
CatalogInput={
'Description': 'string',
'FederatedCatalog': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'Parameters': {
'string': 'string'
},
'TargetRedshiftCatalog': {
'CatalogArn': 'string'
},
'CatalogProperties': {
'DataLakeAccessProperties': {
'DataLakeAccess': True|False,
'DataTransferRole': 'string',
'KmsKey': 'string',
'CatalogType': 'string'
},
'CustomProperties': {
'string': 'string'
}
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'CreateDatabaseDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'AllowFullTableExternalDataAccess': 'True'|'False'
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the catalog to create.
dict
[REQUIRED]
A CatalogInput object that defines the metadata for the catalog.
Description (string) --
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
FederatedCatalog (dict) --
A FederatedCatalog object. A FederatedCatalog structure that references an entity outside the Glue Data Catalog, for example a Redshift database.
Identifier (string) --
A unique identifier for the federated catalog.
ConnectionName (string) --
The name of the connection to an external data source, for example a Redshift-federated catalog.
ConnectionType (string) --
The type of connection used to access the federated catalog, specifying the protocol or method for connection to the external data source.
Parameters (dict) --
A map array of key-value pairs that define the parameters and properties of the catalog.
(string) --
(string) --
TargetRedshiftCatalog (dict) --
A TargetRedshiftCatalog object that describes a target catalog for resource linking.
CatalogArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the catalog resource.
CatalogProperties (dict) --
A CatalogProperties object that specifies data lake access properties and other custom properties.
DataLakeAccessProperties (dict) --
A DataLakeAccessProperties object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.
DataLakeAccess (boolean) --
Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.
DataTransferRole (string) --
A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
KmsKey (string) --
An encryption key that will be used for the staging bucket that will be created along with the catalog.
CatalogType (string) --
Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.
CustomProperties (dict) --
Additional key-value properties for the catalog, such as column statistics optimizations.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
CreateDatabaseDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
AllowFullTableExternalDataAccess (string) --
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
dict
A map array of key-value pairs, not more than 50 pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not more than 256 bytes long. The tags you assign to the catalog.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'DatabaseInput': {'FederatedDatabase': {'ConnectionType': 'string'}}}
Creates a new database in a Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_database(
CatalogId='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Region': 'string'
},
'FederatedDatabase': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
}
},
Tags={
'string': 'string'
}
)
string
The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
dict
[REQUIRED]
The metadata for the database.
Name (string) -- [REQUIRED]
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
Region (string) --
Region of the target database.
FederatedDatabase (dict) --
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated database, such as JDBC, ODBC, or other supported connection protocols.
dict
The tags you assign to the database.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'Name': 'string',
'OpenTableFormatInput': {'IcebergInput': {'CreateIcebergTableInput': {'Location': 'string',
'PartitionSpec': {'Fields': [{'FieldId': 'integer',
'Name': 'string',
'SourceId': 'integer',
'Transform': 'string'}],
'SpecId': 'integer'},
'Properties': {'string': 'string'},
'Schema': {'Fields': [{'Doc': 'string',
'Id': 'integer',
'Name': 'string',
'Required': 'boolean',
'Type': {}}],
'IdentifierFieldIds': ['integer'],
'SchemaId': 'integer',
'Type': 'struct'},
'WriteOrder': {'Fields': [{'Direction': 'asc '
'| '
'desc',
'NullOrder': 'nulls-first '
'| '
'nulls-last',
'SourceId': 'integer',
'Transform': 'string'}],
'OrderId': 'integer'}}}}}
Creates a new table definition in the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_table(
CatalogId='string',
DatabaseName='string',
Name='string',
TableInput={
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ValidationConnection': 'string',
'ViewExpandedText': 'string'
},
],
'SubObjects': [
'string',
]
}
},
PartitionIndexes=[
{
'Keys': [
'string',
],
'IndexName': 'string'
},
],
TransactionId='string',
OpenTableFormatInput={
'IcebergInput': {
'MetadataOperation': 'CREATE',
'Version': 'string',
'CreateIcebergTableInput': {
'Location': 'string',
'Schema': {
'SchemaId': 123,
'IdentifierFieldIds': [
123,
],
'Type': 'struct',
'Fields': [
{
'Id': 123,
'Name': 'string',
'Type': {...}|[...]|123|123.4|'string'|True|None,
'Required': True|False,
'Doc': 'string'
},
]
},
'PartitionSpec': {
'Fields': [
{
'SourceId': 123,
'Transform': 'string',
'Name': 'string',
'FieldId': 123
},
],
'SpecId': 123
},
'WriteOrder': {
'OrderId': 123,
'Fields': [
{
'SourceId': 123,
'Transform': 'string',
'Direction': 'asc'|'desc',
'NullOrder': 'nulls-first'|'nulls-last'
},
]
},
'Properties': {
'string': 'string'
}
}
}
}
)
string
The ID of the Data Catalog in which to create the Table. If none is supplied, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
string
The unique identifier for the table within the specified database that will be created in the Glue Data Catalog.
dict
[REQUIRED]
The TableInput object that defines the metadata table to create in the catalog.
Name (string) -- [REQUIRED]
The table name. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the table.
Owner (string) --
The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
LastAccessTime (datetime) --
The last time that the table was accessed.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
Representations (list) --
A list of structures that contains the dialect of the view, and the query that defines the view.
(dict) --
A structure containing details of a representation to update or create a Lake Formation view.
Dialect (string) --
A parameter that specifies the engine type of a specific representation.
DialectVersion (string) --
A parameter that specifies the version of the engine of a specific representation.
ViewOriginalText (string) --
A string that represents the original SQL query that describes the view.
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
ViewExpandedText (string) --
A string that represents the SQL query that describes the view with expanded resource ARNs
SubObjects (list) --
A list of base table ARNs that make up the view.
(string) --
list
A list of partition indexes, PartitionIndex structures, to create in the table.
(dict) --
A structure for a partition index.
Keys (list) -- [REQUIRED]
The keys for the partition index.
(string) --
IndexName (string) -- [REQUIRED]
The name of the partition index.
string
The ID of the transaction.
dict
Specifies an OpenTableFormatInput structure when creating an open format table.
IcebergInput (dict) --
Specifies an IcebergInput structure that defines an Apache Iceberg metadata table.
MetadataOperation (string) -- [REQUIRED]
A required metadata operation. Can only be set to CREATE.
Version (string) --
The table version for the Iceberg table. Defaults to 2.
CreateIcebergTableInput (dict) --
The configuration parameters required to create a new Iceberg table in the Glue Data Catalog, including table properties and metadata specifications.
Location (string) -- [REQUIRED]
The S3 location where the Iceberg table data will be stored.
Schema (dict) -- [REQUIRED]
The schema definition that specifies the structure, field types, and metadata for the Iceberg table.
SchemaId (integer) --
The unique identifier for this schema version within the Iceberg table's schema evolution history.
IdentifierFieldIds (list) --
The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.
(integer) --
Type (string) --
The root type of the schema structure, typically "struct" for Iceberg table schemas.
Fields (list) -- [REQUIRED]
The list of field definitions that make up the table schema, including field names, types, and metadata.
(dict) --
Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.
Id (integer) -- [REQUIRED]
The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
Name (string) -- [REQUIRED]
The name of the field as it appears in the table schema and query operations.
Type (:ref:`document<document>`) -- [REQUIRED]
The data type definition for this field, specifying the structure and format of the data it contains.
Required (boolean) -- [REQUIRED]
Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
Doc (string) --
Optional documentation or description text that provides additional context about the purpose and usage of this field.
PartitionSpec (dict) --
The partitioning specification that defines how the Iceberg table data will be organized and partitioned for optimal query performance.
Fields (list) -- [REQUIRED]
The list of partition fields that define how the table data should be partitioned, including source fields and their transformations.
(dict) --
Defines a single partition field within an Iceberg partition specification, including the source field, transformation function, partition name, and unique identifier.
SourceId (integer) -- [REQUIRED]
The identifier of the source field from the table schema that this partition field is based on.
Transform (string) -- [REQUIRED]
The transformation function applied to the source field to create the partition, such as identity, bucket, truncate, year, month, day, or hour.
Name (string) -- [REQUIRED]
The name of the partition field as it will appear in the partitioned table structure.
FieldId (integer) --
The unique identifier assigned to this partition field within the Iceberg table's partition specification.
SpecId (integer) --
The unique identifier for this partition specification within the Iceberg table's metadata history.
WriteOrder (dict) --
The sort order specification that defines how data should be ordered within each partition to optimize query performance.
OrderId (integer) -- [REQUIRED]
The unique identifier for this sort order specification within the Iceberg table's metadata.
Fields (list) -- [REQUIRED]
The list of fields and their sort directions that define the ordering criteria for the Iceberg table data.
(dict) --
Defines a single field within an Iceberg sort order specification, including the source field, transformation, sort direction, and null value ordering.
SourceId (integer) -- [REQUIRED]
The identifier of the source field from the table schema that this sort field is based on.
Transform (string) -- [REQUIRED]
The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.
Direction (string) -- [REQUIRED]
The sort direction for this field, either ascending or descending.
NullOrder (string) -- [REQUIRED]
The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.
Properties (dict) --
Key-value pairs of additional table properties and configuration settings for the Iceberg table.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'Catalog': {'FederatedCatalog': {'ConnectionType': 'string'}}}
The name of the Catalog to retrieve. This should be all lowercase.
See also: AWS API Documentation
Request Syntax
client.get_catalog(
CatalogId='string'
)
string
[REQUIRED]
The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
dict
Response Syntax
{
'Catalog': {
'CatalogId': 'string',
'Name': 'string',
'ResourceArn': 'string',
'Description': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'TargetRedshiftCatalog': {
'CatalogArn': 'string'
},
'FederatedCatalog': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'CatalogProperties': {
'DataLakeAccessProperties': {
'DataLakeAccess': True|False,
'DataTransferRole': 'string',
'KmsKey': 'string',
'ManagedWorkgroupName': 'string',
'ManagedWorkgroupStatus': 'string',
'RedshiftDatabaseName': 'string',
'StatusMessage': 'string',
'CatalogType': 'string'
},
'CustomProperties': {
'string': 'string'
}
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'CreateDatabaseDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'AllowFullTableExternalDataAccess': 'True'|'False'
}
}
Response Structure
(dict) --
Catalog (dict) --
A Catalog object. The definition of the specified catalog in the Glue Data Catalog.
CatalogId (string) --
The ID of the catalog. To grant access to the default catalog, this field should not be provided.
Name (string) --
The name of the catalog. Cannot be the same as the account ID.
ResourceArn (string) --
The Amazon Resource Name (ARN) assigned to the catalog resource.
Description (string) --
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
Parameters (dict) --
A map array of key-value pairs that define parameters and properties of the catalog.
(string) --
(string) --
CreateTime (datetime) --
The time at which the catalog was created.
UpdateTime (datetime) --
The time at which the catalog was last updated.
TargetRedshiftCatalog (dict) --
A TargetRedshiftCatalog object that describes a target catalog for database resource linking.
CatalogArn (string) --
The Amazon Resource Name (ARN) of the catalog resource.
FederatedCatalog (dict) --
A FederatedCatalog object that points to an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated catalog.
ConnectionName (string) --
The name of the connection to an external data source, for example a Redshift-federated catalog.
ConnectionType (string) --
The type of connection used to access the federated catalog, specifying the protocol or method for connection to the external data source.
CatalogProperties (dict) --
A CatalogProperties object that specifies data lake access properties and other custom properties.
DataLakeAccessProperties (dict) --
A DataLakeAccessProperties object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.
DataLakeAccess (boolean) --
Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.
DataTransferRole (string) --
A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
KmsKey (string) --
An encryption key that will be used for the staging bucket that will be created along with the catalog.
ManagedWorkgroupName (string) --
The managed Redshift Serverless compute name that is created for your catalog resource.
ManagedWorkgroupStatus (string) --
The managed Redshift Serverless compute status.
RedshiftDatabaseName (string) --
The default Redshift database resource name in the managed compute.
StatusMessage (string) --
A message that gives more detailed information about the managed workgroup status.
CatalogType (string) --
Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.
CustomProperties (dict) --
Additional key-value properties for the catalog, such as column statistics optimizations.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
CreateDatabaseDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
AllowFullTableExternalDataAccess (string) --
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
{'CatalogList': {'FederatedCatalog': {'ConnectionType': 'string'}}}
Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.
See also: AWS API Documentation
Request Syntax
client.get_catalogs(
ParentCatalogId='string',
NextToken='string',
MaxResults=123,
Recursive=True|False,
IncludeRoot=True|False
)
string
The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.
string
A continuation token, if this is a continuation call.
integer
The maximum number of catalogs to return in one response.
boolean
Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId. Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.
boolean
Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ParentCatalogId = NULL | Amazon Web Services Account ID, all catalogs and the default catalog are enumerated in the response.
When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.
dict
Response Syntax
{
'CatalogList': [
{
'CatalogId': 'string',
'Name': 'string',
'ResourceArn': 'string',
'Description': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'TargetRedshiftCatalog': {
'CatalogArn': 'string'
},
'FederatedCatalog': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'CatalogProperties': {
'DataLakeAccessProperties': {
'DataLakeAccess': True|False,
'DataTransferRole': 'string',
'KmsKey': 'string',
'ManagedWorkgroupName': 'string',
'ManagedWorkgroupStatus': 'string',
'RedshiftDatabaseName': 'string',
'StatusMessage': 'string',
'CatalogType': 'string'
},
'CustomProperties': {
'string': 'string'
}
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'CreateDatabaseDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'AllowFullTableExternalDataAccess': 'True'|'False'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CatalogList (list) --
An array of Catalog objects. A list of Catalog objects from the specified parent catalog.
(dict) --
The catalog object represents a logical grouping of databases in the Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.
CatalogId (string) --
The ID of the catalog. To grant access to the default catalog, this field should not be provided.
Name (string) --
The name of the catalog. Cannot be the same as the account ID.
ResourceArn (string) --
The Amazon Resource Name (ARN) assigned to the catalog resource.
Description (string) --
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
Parameters (dict) --
A map array of key-value pairs that define parameters and properties of the catalog.
(string) --
(string) --
CreateTime (datetime) --
The time at which the catalog was created.
UpdateTime (datetime) --
The time at which the catalog was last updated.
TargetRedshiftCatalog (dict) --
A TargetRedshiftCatalog object that describes a target catalog for database resource linking.
CatalogArn (string) --
The Amazon Resource Name (ARN) of the catalog resource.
FederatedCatalog (dict) --
A FederatedCatalog object that points to an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated catalog.
ConnectionName (string) --
The name of the connection to an external data source, for example a Redshift-federated catalog.
ConnectionType (string) --
The type of connection used to access the federated catalog, specifying the protocol or method for connection to the external data source.
CatalogProperties (dict) --
A CatalogProperties object that specifies data lake access properties and other custom properties.
DataLakeAccessProperties (dict) --
A DataLakeAccessProperties object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.
DataLakeAccess (boolean) --
Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.
DataTransferRole (string) --
A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
KmsKey (string) --
An encryption key that will be used for the staging bucket that will be created along with the catalog.
ManagedWorkgroupName (string) --
The managed Redshift Serverless compute name that is created for your catalog resource.
ManagedWorkgroupStatus (string) --
The managed Redshift Serverless compute status.
RedshiftDatabaseName (string) --
The default Redshift database resource name in the managed compute.
StatusMessage (string) --
A message that gives more detailed information about the managed workgroup status.
CatalogType (string) --
Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.
CustomProperties (dict) --
Additional key-value properties for the catalog, such as column statistics optimizations.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
CreateDatabaseDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
AllowFullTableExternalDataAccess (string) --
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
{'Database': {'FederatedDatabase': {'ConnectionType': 'string'}}}
Retrieves the definition of a specified database.
See also: AWS API Documentation
Request Syntax
client.get_database(
CatalogId='string',
Name='string'
)
string
The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
dict
Response Syntax
{
'Database': {
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'FederatedDatabase': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
}
}
}
Response Structure
(dict) --
Database (dict) --
The definition of the specified database in the Data Catalog.
Name (string) --
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
(string) --
(string) --
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
Region (string) --
Region of the target database.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
FederatedDatabase (dict) --
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated database, such as JDBC, ODBC, or other supported connection protocols.
{'DatabaseList': {'FederatedDatabase': {'ConnectionType': 'string'}}}
Retrieves all databases defined in a given Data Catalog.
See also: AWS API Documentation
Request Syntax
client.get_databases(
CatalogId='string',
NextToken='string',
MaxResults=123,
ResourceShareType='FOREIGN'|'ALL'|'FEDERATED',
AttributesToGet=[
'NAME',
]
)
string
The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
string
A continuation token, if this is a continuation call.
integer
The maximum number of databases to return in one response.
string
Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.
If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
list
Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.
(string) --
dict
Response Syntax
{
'DatabaseList': [
{
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'FederatedDatabase': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DatabaseList (list) --
A list of Database objects from the specified catalog.
(dict) --
The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
Name (string) --
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
(string) --
(string) --
CreateTime (datetime) --
The time at which the metadata database was created in the catalog.
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
Region (string) --
Region of the target database.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
FederatedDatabase (dict) --
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated database, such as JDBC, ODBC, or other supported connection protocols.
NextToken (string) --
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
{'Table': {'FederatedTable': {'ConnectionType': 'string'}}}
Retrieves the Table definition in a Data Catalog for a specified table.
See also: AWS API Documentation
Request Syntax
client.get_table(
CatalogId='string',
DatabaseName='string',
Name='string',
TransactionId='string',
QueryAsOfTime=datetime(2015, 1, 1),
IncludeStatusDetails=True|False
)
string
The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
string
[REQUIRED]
The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
string
The transaction ID at which to read the table contents.
datetime
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
boolean
Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
dict
Response Syntax
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
}
}
Response Structure
(dict) --
Table (dict) --
The Table object that defines the specified table.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
{'TableVersion': {'Table': {'FederatedTable': {'ConnectionType': 'string'}}}}
Retrieves a specified version of a table.
See also: AWS API Documentation
Request Syntax
client.get_table_version(
CatalogId='string',
DatabaseName='string',
TableName='string',
VersionId='string'
)
string
The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
string
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
string
The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
dict
Response Syntax
{
'TableVersion': {
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
},
'VersionId': 'string'
}
}
Response Structure
(dict) --
TableVersion (dict) --
The requested table version.
Table (dict) --
The table in question.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
VersionId (string) --
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
{'TableVersions': {'Table': {'FederatedTable': {'ConnectionType': 'string'}}}}
Retrieves a list of strings that identify available versions of a specified table.
See also: AWS API Documentation
Request Syntax
client.get_table_versions(
CatalogId='string',
DatabaseName='string',
TableName='string',
NextToken='string',
MaxResults=123
)
string
The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
string
[REQUIRED]
The name of the table. For Hive compatibility, this name is entirely lowercase.
string
A continuation token, if this is not the first call.
integer
The maximum number of table versions to return in one response.
dict
Response Syntax
{
'TableVersions': [
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
},
'VersionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TableVersions (list) --
A list of strings identifying available versions of the specified table.
(dict) --
Specifies a version of a table.
Table (dict) --
The table in question.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
VersionId (string) --
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
NextToken (string) --
A continuation token, if the list of available versions does not include the last one.
{'TableList': {'FederatedTable': {'ConnectionType': 'string'}}}
Retrieves the definitions of some or all of the tables in a given Database.
See also: AWS API Documentation
Request Syntax
client.get_tables(
CatalogId='string',
DatabaseName='string',
Expression='string',
NextToken='string',
MaxResults=123,
TransactionId='string',
QueryAsOfTime=datetime(2015, 1, 1),
IncludeStatusDetails=True|False,
AttributesToGet=[
'NAME'|'TABLE_TYPE',
]
)
string
The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
string
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
string
A continuation token, included if this is a continuation call.
integer
The maximum number of tables to return in a single response.
string
The transaction ID at which to read the table contents.
datetime
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
boolean
Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
list
Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.
The following are the valid combinations of values:
NAME - Names of all tables in the database.
NAME, TABLE_TYPE - Names of all tables and the table types.
(string) --
dict
Response Syntax
{
'TableList': [
{
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TableList (list) --
A list of the requested Table objects.
(dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
NextToken (string) --
A continuation token, present if the current list segment is not the last.
{'Table': {'FederatedTable': {'ConnectionType': 'string'}}}
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is glue:GetTable.
See also: AWS API Documentation
Request Syntax
client.get_unfiltered_table_metadata(
Region='string',
CatalogId='string',
DatabaseName='string',
Name='string',
AuditContext={
'AdditionalAuditContext': 'string',
'RequestedColumns': [
'string',
],
'AllColumnsRequested': True|False
},
SupportedPermissionTypes=[
'COLUMN_PERMISSION'|'CELL_FILTER_PERMISSION'|'NESTED_PERMISSION'|'NESTED_CELL_PERMISSION',
],
ParentResourceArn='string',
RootResourceArn='string',
SupportedDialect={
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string'
},
Permissions=[
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
],
QuerySessionContext={
'QueryId': 'string',
'QueryStartTime': datetime(2015, 1, 1),
'ClusterId': 'string',
'QueryAuthorizationId': 'string',
'AdditionalContext': {
'string': 'string'
}
}
)
string
Specified only if the base tables belong to a different Amazon Web Services Region.
string
[REQUIRED]
The catalog ID where the table resides.
string
[REQUIRED]
(Required) Specifies the name of a database that contains the table.
string
[REQUIRED]
(Required) Specifies the name of a table for which you are requesting metadata.
dict
A structure containing Lake Formation audit context information.
AdditionalAuditContext (string) --
A string containing the additional audit context information.
RequestedColumns (list) --
The requested columns for audit.
(string) --
AllColumnsRequested (boolean) --
All columns request for audit.
list
[REQUIRED]
Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted values are:
COLUMN_PERMISSION - Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
NESTED_PERMISSION - Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
(string) --
string
The resource ARN of the view.
string
The resource ARN of the root view in a chain of nested views.
dict
A structure specifying the dialect and dialect version used by the query engine.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
list
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
(string) --
dict
A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
QueryId (string) --
A unique identifier generated by the query engine for the query.
QueryStartTime (datetime) --
A timestamp provided by the query engine for when the query started.
ClusterId (string) --
An identifier string for the consumer cluster.
QueryAuthorizationId (string) --
A cryptographically generated query identifier generated by Glue or Lake Formation.
AdditionalContext (dict) --
An opaque string-string map passed by the query engine.
(string) --
(string) --
dict
Response Syntax
{
'Table': {
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
},
'AuthorizedColumns': [
'string',
],
'IsRegisteredWithLakeFormation': True|False,
'CellFilters': [
{
'ColumnName': 'string',
'RowFilterExpression': 'string'
},
],
'QueryAuthorizationId': 'string',
'IsMultiDialectView': True|False,
'ResourceArn': 'string',
'IsProtected': True|False,
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
],
'RowFilter': 'string'
}
Response Structure
(dict) --
Table (dict) --
A Table object containing the table metadata.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
AuthorizedColumns (list) --
A list of column names that the user has been granted access to.
(string) --
IsRegisteredWithLakeFormation (boolean) --
A Boolean value that indicates whether the partition location is registered with Lake Formation.
CellFilters (list) --
A list of column row filters.
(dict) --
A filter that uses both column-level and row-level filtering.
ColumnName (string) --
A string containing the name of the column.
RowFilterExpression (string) --
A string containing the row-level filter expression.
QueryAuthorizationId (string) --
A cryptographically generated query identifier generated by Glue or Lake Formation.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
ResourceArn (string) --
The resource ARN of the parent resource extracted from the request.
IsProtected (boolean) --
A flag that instructs the engine not to push user-provided operations into the logical plan of the view during query planning. However, if set this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Permissions (list) --
The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
(string) --
RowFilter (string) --
The filter that applies to the table. For example when applying the filter in SQL, it would go in the WHERE clause and can be evaluated by using an AND operator with any other predicates applied by the user querying the table.
{'TableList': {'FederatedTable': {'ConnectionType': 'string'}}}
Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
See also: AWS API Documentation
Request Syntax
client.search_tables(
CatalogId='string',
NextToken='string',
Filters=[
{
'Key': 'string',
'Value': 'string',
'Comparator': 'EQUALS'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_EQUALS'|'LESS_THAN_EQUALS'
},
],
SearchText='string',
SortCriteria=[
{
'FieldName': 'string',
'Sort': 'ASC'|'DESC'
},
],
MaxResults=123,
ResourceShareType='FOREIGN'|'ALL'|'FEDERATED',
IncludeStatusDetails=True|False
)
string
A unique identifier, consisting of ``account_id ``.
string
A continuation token, included if this is a continuation call.
list
A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
(dict) --
Defines a property predicate.
Key (string) --
The key of the property.
Value (string) --
The value of the property.
Comparator (string) --
The comparator used to compare this property to others.
string
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
list
A list of criteria for sorting the results by a field name, in an ascending or descending order.
(dict) --
Specifies a field to sort by and a sort order.
FieldName (string) --
The name of the field on which to sort.
Sort (string) --
An ascending or descending sort.
integer
The maximum number of tables to return in a single response.
string
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
boolean
Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
dict
Response Syntax
{
'NextToken': 'string',
'TableList': [
{
'Name': 'string',
'DatabaseName': 'string',
'Description': 'string',
'Owner': 'string',
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'CreatedBy': 'string',
'IsRegisteredWithLakeFormation': True|False,
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'CatalogId': 'string',
'VersionId': 'string',
'FederatedTable': {
'Identifier': 'string',
'DatabaseIdentifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'SubObjects': [
'string',
],
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'ValidationConnection': 'string',
'IsStale': True|False
},
]
},
'IsMultiDialectView': True|False,
'Status': {
'RequestedBy': 'string',
'UpdatedBy': 'string',
'RequestTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Action': 'UPDATE'|'CREATE',
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Details': {
'RequestedChange': {'... recursive ...'},
'ViewValidations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewValidationText': 'string',
'UpdateTime': datetime(2015, 1, 1),
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
},
]
}
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
A continuation token, present if the current list segment is not the last.
TableList (list) --
A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
(dict) --
Represents a collection of related data organized in columns and rows.
Name (string) --
The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName (string) --
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description (string) --
A description of the table.
Owner (string) --
The owner of the table.
CreateTime (datetime) --
The time when the table definition was created in the Data Catalog.
UpdateTime (datetime) --
The last time that the table was updated.
LastAccessTime (datetime) --
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) --
The name of the column.
SortOrder (integer) --
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) --
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
CreatedBy (string) --
The person or entity who created the table.
IsRegisteredWithLakeFormation (boolean) --
Indicates whether the table has been registered with Lake Formation.
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
VersionId (string) --
The ID of the table version.
FederatedTable (dict) --
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated table.
DatabaseIdentifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
SubObjects (list) --
A list of table Amazon Resource Names (ARNs).
(string) --
Representations (list) --
A list of representations.
(dict) --
A structure that contains the dialect of the view, and the query that defines the view.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText (string) --
The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view ( ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.
ViewExpandedText (string) --
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
IsStale (boolean) --
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView (boolean) --
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status (dict) --
A structure containing information about the state of an asynchronous change to a table.
RequestedBy (string) --
The ARN of the user who requested the asynchronous change.
UpdatedBy (string) --
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime (datetime) --
An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime (datetime) --
An ISO 8601 formatted date string indicating the time that the state was last updated.
Action (string) --
Indicates which action was called on the table, currently only CREATE or UPDATE.
State (string) --
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Error (dict) --
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different ``Error``s for each dialect.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
Details (dict) --
A StatusDetails object with information about the requested change.
RequestedChange (dict) --
A Table object representing the requested changes.
ViewValidations (list) --
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(dict) --
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect (string) --
The dialect of the query engine.
DialectVersion (string) --
The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText (string) --
The SELECT query that defines the view, as provided by the customer.
UpdateTime (datetime) --
The time of the last update.
State (string) --
The state of the validation.
Error (dict) --
An error associated with the validation.
ErrorCode (string) --
The code associated with this error.
ErrorMessage (string) --
A message describing the error.
{'CatalogInput': {'FederatedCatalog': {'ConnectionType': 'string'}}}
Updates an existing catalog's properties in the Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_catalog(
CatalogId='string',
CatalogInput={
'Description': 'string',
'FederatedCatalog': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
},
'Parameters': {
'string': 'string'
},
'TargetRedshiftCatalog': {
'CatalogArn': 'string'
},
'CatalogProperties': {
'DataLakeAccessProperties': {
'DataLakeAccess': True|False,
'DataTransferRole': 'string',
'KmsKey': 'string',
'CatalogType': 'string'
},
'CustomProperties': {
'string': 'string'
}
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'CreateDatabaseDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'AllowFullTableExternalDataAccess': 'True'|'False'
}
)
string
[REQUIRED]
The ID of the catalog.
dict
[REQUIRED]
A CatalogInput object specifying the new properties of an existing catalog.
Description (string) --
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
FederatedCatalog (dict) --
A FederatedCatalog object. A FederatedCatalog structure that references an entity outside the Glue Data Catalog, for example a Redshift database.
Identifier (string) --
A unique identifier for the federated catalog.
ConnectionName (string) --
The name of the connection to an external data source, for example a Redshift-federated catalog.
ConnectionType (string) --
The type of connection used to access the federated catalog, specifying the protocol or method for connection to the external data source.
Parameters (dict) --
A map array of key-value pairs that define the parameters and properties of the catalog.
(string) --
(string) --
TargetRedshiftCatalog (dict) --
A TargetRedshiftCatalog object that describes a target catalog for resource linking.
CatalogArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the catalog resource.
CatalogProperties (dict) --
A CatalogProperties object that specifies data lake access properties and other custom properties.
DataLakeAccessProperties (dict) --
A DataLakeAccessProperties object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.
DataLakeAccess (boolean) --
Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.
DataTransferRole (string) --
A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.
KmsKey (string) --
An encryption key that will be used for the staging bucket that will be created along with the catalog.
CatalogType (string) --
Specifies a federated catalog type for the native catalog resource. The currently supported type is aws:redshift.
CustomProperties (dict) --
Additional key-value properties for the catalog, such as column statistics optimizations.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
CreateDatabaseDefaultPermissions (list) --
An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Typically should be explicitly set as an empty list.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
AllowFullTableExternalDataAccess (string) --
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
dict
Response Syntax
{}
Response Structure
(dict) --
{'DatabaseInput': {'FederatedDatabase': {'ConnectionType': 'string'}}}
Updates an existing database definition in a Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_database(
CatalogId='string',
Name='string',
DatabaseInput={
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'Parameters': {
'string': 'string'
},
'CreateTableDefaultPermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
]
},
],
'TargetDatabase': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Region': 'string'
},
'FederatedDatabase': {
'Identifier': 'string',
'ConnectionName': 'string',
'ConnectionType': 'string'
}
}
)
string
The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
dict
[REQUIRED]
A DatabaseInput object specifying the new definition of the metadata database in the catalog.
Name (string) -- [REQUIRED]
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the database.
LocationUri (string) --
The location of the database (for example, an HDFS path).
Parameters (dict) --
These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
(string) --
(string) --
CreateTableDefaultPermissions (list) --
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
(dict) --
Permissions granted to a principal.
Principal (dict) --
The principal who is granted permissions.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
Permissions (list) --
The permissions that are granted to the principal.
(string) --
TargetDatabase (dict) --
A DatabaseIdentifier structure that describes a target database for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the database resides.
DatabaseName (string) --
The name of the catalog database.
Region (string) --
Region of the target database.
FederatedDatabase (dict) --
A FederatedDatabase structure that references an entity outside the Glue Data Catalog.
Identifier (string) --
A unique identifier for the federated database.
ConnectionName (string) --
The name of the connection to the external metastore.
ConnectionType (string) --
The type of connection used to access the federated database, such as JDBC, ODBC, or other supported connection protocols.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Name': 'string',
'UpdateOpenTableFormatInput': {'UpdateIcebergInput': {'UpdateIcebergTableInput': {'Updates': [{'Location': 'string',
'PartitionSpec': {'Fields': [{'FieldId': 'integer',
'Name': 'string',
'SourceId': 'integer',
'Transform': 'string'}],
'SpecId': 'integer'},
'Properties': {'string': 'string'},
'Schema': {'Fields': [{'Doc': 'string',
'Id': 'integer',
'Name': 'string',
'Required': 'boolean',
'Type': {}}],
'IdentifierFieldIds': ['integer'],
'SchemaId': 'integer',
'Type': 'struct'},
'SortOrder': {'Fields': [{'Direction': 'asc '
'| '
'desc',
'NullOrder': 'nulls-first '
'| '
'nulls-last',
'SourceId': 'integer',
'Transform': 'string'}],
'OrderId': 'integer'}}]}}}}
Updates a metadata table in the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_table(
CatalogId='string',
DatabaseName='string',
Name='string',
TableInput={
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'LastAccessTime': datetime(2015, 1, 1),
'LastAnalyzedTime': datetime(2015, 1, 1),
'Retention': 123,
'StorageDescriptor': {
'Columns': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'Location': 'string',
'AdditionalLocations': [
'string',
],
'InputFormat': 'string',
'OutputFormat': 'string',
'Compressed': True|False,
'NumberOfBuckets': 123,
'SerdeInfo': {
'Name': 'string',
'SerializationLibrary': 'string',
'Parameters': {
'string': 'string'
}
},
'BucketColumns': [
'string',
],
'SortColumns': [
{
'Column': 'string',
'SortOrder': 123
},
],
'Parameters': {
'string': 'string'
},
'SkewedInfo': {
'SkewedColumnNames': [
'string',
],
'SkewedColumnValues': [
'string',
],
'SkewedColumnValueLocationMaps': {
'string': 'string'
}
},
'StoredAsSubDirectories': True|False,
'SchemaReference': {
'SchemaId': {
'SchemaArn': 'string',
'SchemaName': 'string',
'RegistryName': 'string'
},
'SchemaVersionId': 'string',
'SchemaVersionNumber': 123
}
},
'PartitionKeys': [
{
'Name': 'string',
'Type': 'string',
'Comment': 'string',
'Parameters': {
'string': 'string'
}
},
],
'ViewOriginalText': 'string',
'ViewExpandedText': 'string',
'TableType': 'string',
'Parameters': {
'string': 'string'
},
'TargetTable': {
'CatalogId': 'string',
'DatabaseName': 'string',
'Name': 'string',
'Region': 'string'
},
'ViewDefinition': {
'IsProtected': True|False,
'Definer': 'string',
'Representations': [
{
'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
'DialectVersion': 'string',
'ViewOriginalText': 'string',
'ValidationConnection': 'string',
'ViewExpandedText': 'string'
},
],
'SubObjects': [
'string',
]
}
},
SkipArchive=True|False,
TransactionId='string',
VersionId='string',
ViewUpdateAction='ADD'|'REPLACE'|'ADD_OR_REPLACE'|'DROP',
Force=True|False,
UpdateOpenTableFormatInput={
'UpdateIcebergInput': {
'UpdateIcebergTableInput': {
'Updates': [
{
'Schema': {
'SchemaId': 123,
'IdentifierFieldIds': [
123,
],
'Type': 'struct',
'Fields': [
{
'Id': 123,
'Name': 'string',
'Type': {...}|[...]|123|123.4|'string'|True|None,
'Required': True|False,
'Doc': 'string'
},
]
},
'PartitionSpec': {
'Fields': [
{
'SourceId': 123,
'Transform': 'string',
'Name': 'string',
'FieldId': 123
},
],
'SpecId': 123
},
'SortOrder': {
'OrderId': 123,
'Fields': [
{
'SourceId': 123,
'Transform': 'string',
'Direction': 'asc'|'desc',
'NullOrder': 'nulls-first'|'nulls-last'
},
]
},
'Location': 'string',
'Properties': {
'string': 'string'
}
},
]
}
}
}
)
string
The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
string
[REQUIRED]
The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
string
The unique identifier for the table within the specified database that will be created in the Glue Data Catalog.
dict
An updated TableInput object to define the metadata table in the catalog.
Name (string) -- [REQUIRED]
The table name. For Hive compatibility, this is folded to lowercase when it is stored.
Description (string) --
A description of the table.
Owner (string) --
The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
LastAccessTime (datetime) --
The last time that the table was accessed.
LastAnalyzedTime (datetime) --
The last time that column statistics were computed for this table.
Retention (integer) --
The retention time for this table.
StorageDescriptor (dict) --
A storage descriptor containing information about the physical storage of this table.
Columns (list) --
A list of the Columns in the table.
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
Location (string) --
The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations (list) --
A list of locations that point to the path where a Delta table is located.
(string) --
InputFormat (string) --
The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
OutputFormat (string) --
The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
Compressed (boolean) --
True if the data in the table is compressed, or False if not.
NumberOfBuckets (integer) --
Must be specified if the table contains any dimension columns.
SerdeInfo (dict) --
The serialization/deserialization (SerDe) information.
Name (string) --
Name of the SerDe.
SerializationLibrary (string) --
Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters (dict) --
These key-value pairs define initialization parameters for the SerDe.
(string) --
(string) --
BucketColumns (list) --
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string) --
SortColumns (list) --
A list specifying the sort order of each bucket in the table.
(dict) --
Specifies the sort order of a sorted column.
Column (string) -- [REQUIRED]
The name of the column.
SortOrder (integer) -- [REQUIRED]
Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).
Parameters (dict) --
The user-supplied properties in key-value form.
(string) --
(string) --
SkewedInfo (dict) --
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames (list) --
A list of names of columns that contain skewed values.
(string) --
SkewedColumnValues (list) --
A list of values that appear so frequently as to be considered skewed.
(string) --
SkewedColumnValueLocationMaps (dict) --
A mapping of skewed values to the columns that contain them.
(string) --
(string) --
StoredAsSubDirectories (boolean) --
True if the table data is stored in subdirectories, or False if not.
SchemaReference (dict) --
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId (dict) --
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn (string) --
The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName (string) --
The name of the schema. One of SchemaArn or SchemaName has to be provided.
RegistryName (string) --
The name of the schema registry that contains the schema.
SchemaVersionId (string) --
The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber (integer) --
The version number of the schema.
PartitionKeys (list) --
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 of partitionKeys to an empty list. For example:
"PartitionKeys": []
(dict) --
A column in a Table.
Name (string) -- [REQUIRED]
The name of the Column.
Type (string) --
The data type of the Column.
Comment (string) --
A free-form text comment.
Parameters (dict) --
These key-value pairs define properties associated with the column.
(string) --
(string) --
ViewOriginalText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText (string) --
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType (string) --
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
EXTERNAL_TABLE
Hive compatible attribute - indicates a non-Hive managed table.
GOVERNED
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
Parameters (dict) --
These key-value pairs define properties associated with the table.
(string) --
(string) --
TargetTable (dict) --
A TableIdentifier structure that describes a target table for resource linking.
CatalogId (string) --
The ID of the Data Catalog in which the table resides.
DatabaseName (string) --
The name of the catalog database that contains the target table.
Name (string) --
The name of the target table.
Region (string) --
Region of the target table.
ViewDefinition (dict) --
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected (boolean) --
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer (string) --
The definer of a view in SQL.
Representations (list) --
A list of structures that contains the dialect of the view, and the query that defines the view.
(dict) --
A structure containing details of a representation to update or create a Lake Formation view.
Dialect (string) --
A parameter that specifies the engine type of a specific representation.
DialectVersion (string) --
A parameter that specifies the version of the engine of a specific representation.
ViewOriginalText (string) --
A string that represents the original SQL query that describes the view.
ValidationConnection (string) --
The name of the connection to be used to validate the specific representation of the view.
ViewExpandedText (string) --
A string that represents the SQL query that describes the view with expanded resource ARNs
SubObjects (list) --
A list of base table ARNs that make up the view.
(string) --
boolean
By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.
string
The transaction ID at which to update the table contents.
string
The version ID at which to update the table contents.
string
The operation to be performed when updating the view.
boolean
A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
dict
Input parameters for updating open table format tables in GlueData Catalog, serving as a wrapper for format-specific update operations such as Apache Iceberg.
UpdateIcebergInput (dict) --
Apache Iceberg-specific update parameters that define the table modifications to be applied, including schema changes, partition specifications, and table properties.
UpdateIcebergTableInput (dict) -- [REQUIRED]
The specific update operations to be applied to the Iceberg table, containing a list of updates that define the new state of the table including schema, partitions, and properties.
Updates (list) -- [REQUIRED]
The list of table update operations that specify the changes to be made to the Iceberg table, including schema modifications, partition specifications, and table properties.
(dict) --
Defines a complete set of updates to be applied to an Iceberg table, including schema changes, partitioning modifications, sort order adjustments, location updates, and property changes.
Schema (dict) -- [REQUIRED]
The updated schema definition for the Iceberg table, specifying any changes to field structure, data types, or schema metadata.
SchemaId (integer) --
The unique identifier for this schema version within the Iceberg table's schema evolution history.
IdentifierFieldIds (list) --
The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.
(integer) --
Type (string) --
The root type of the schema structure, typically "struct" for Iceberg table schemas.
Fields (list) -- [REQUIRED]
The list of field definitions that make up the table schema, including field names, types, and metadata.
(dict) --
Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.
Id (integer) -- [REQUIRED]
The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
Name (string) -- [REQUIRED]
The name of the field as it appears in the table schema and query operations.
Type (:ref:`document<document>`) -- [REQUIRED]
The data type definition for this field, specifying the structure and format of the data it contains.
Required (boolean) -- [REQUIRED]
Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
Doc (string) --
Optional documentation or description text that provides additional context about the purpose and usage of this field.
PartitionSpec (dict) --
The updated partitioning specification that defines how the table data should be reorganized and partitioned.
Fields (list) -- [REQUIRED]
The list of partition fields that define how the table data should be partitioned, including source fields and their transformations.
(dict) --
Defines a single partition field within an Iceberg partition specification, including the source field, transformation function, partition name, and unique identifier.
SourceId (integer) -- [REQUIRED]
The identifier of the source field from the table schema that this partition field is based on.
Transform (string) -- [REQUIRED]
The transformation function applied to the source field to create the partition, such as identity, bucket, truncate, year, month, day, or hour.
Name (string) -- [REQUIRED]
The name of the partition field as it will appear in the partitioned table structure.
FieldId (integer) --
The unique identifier assigned to this partition field within the Iceberg table's partition specification.
SpecId (integer) --
The unique identifier for this partition specification within the Iceberg table's metadata history.
SortOrder (dict) --
The updated sort order specification that defines how data should be ordered within partitions for optimal query performance.
OrderId (integer) -- [REQUIRED]
The unique identifier for this sort order specification within the Iceberg table's metadata.
Fields (list) -- [REQUIRED]
The list of fields and their sort directions that define the ordering criteria for the Iceberg table data.
(dict) --
Defines a single field within an Iceberg sort order specification, including the source field, transformation, sort direction, and null value ordering.
SourceId (integer) -- [REQUIRED]
The identifier of the source field from the table schema that this sort field is based on.
Transform (string) -- [REQUIRED]
The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.
Direction (string) -- [REQUIRED]
The sort direction for this field, either ascending or descending.
NullOrder (string) -- [REQUIRED]
The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.
Location (string) -- [REQUIRED]
The updated S3 location where the Iceberg table data will be stored.
Properties (dict) --
Updated key-value pairs of table properties and configuration settings for the Iceberg table.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --