AWS Glue

2024/06/06 - AWS Glue - 8 updated api methods

Changes  This release adds support for creating and updating Glue Data Catalog Views.

CreateTable (updated) Link ¶
Changes (request)
{'TableInput': {'ViewDefinition': {'Definer': 'string',
                                   'IsProtected': 'boolean',
                                   'Representations': [{'Dialect': 'REDSHIFT | '
                                                                   'ATHENA | '
                                                                   'SPARK',
                                                        'DialectVersion': 'string',
                                                        'ValidationConnection': 'string',
                                                        'ViewExpandedText': 'string',
                                                        'ViewOriginalText': 'string'}],
                                   'SubObjects': ['string']}}}

Creates a new table definition in the Data Catalog.

See also: AWS API Documentation

Request Syntax

client.create_table(
    CatalogId='string',
    DatabaseName='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'
        }
    }
)
type CatalogId

string

param CatalogId

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.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.

type TableInput

dict

param TableInput

[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) --

type PartitionIndexes

list

param PartitionIndexes

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.

type TransactionId

string

param TransactionId

The ID of the transaction.

type OpenTableFormatInput

dict

param OpenTableFormatInput

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

GetTable (updated) Link ¶
Changes (response)
{'Table': {'ViewDefinition': {'Representations': {'ValidationConnection': '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)
)
type CatalogId

string

param CatalogId

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

type Name

string

param Name

[REQUIRED]

The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

type TransactionId

string

param TransactionId

The transaction ID at which to read the table contents.

type QueryAsOfTime

datetime

param QueryAsOfTime

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 .

rtype

dict

returns

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'
        },
        '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
    }
}

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.

      • 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.

GetTableVersion (updated) Link ¶
Changes (response)
{'TableVersion': {'Table': {'ViewDefinition': {'Representations': {'ValidationConnection': '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'
)
type CatalogId

string

param CatalogId

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

type TableName

string

param TableName

[REQUIRED]

The name of the table. For Hive compatibility, this name is entirely lowercase.

type VersionId

string

param VersionId

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.

rtype

dict

returns

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'
            },
            '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
        },
        '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.

        • 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.

      • 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.

GetTableVersions (updated) Link ¶
Changes (response)
{'TableVersions': {'Table': {'ViewDefinition': {'Representations': {'ValidationConnection': '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
)
type CatalogId

string

param CatalogId

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

type TableName

string

param TableName

[REQUIRED]

The name of the table. For Hive compatibility, this name is entirely lowercase.

type NextToken

string

param NextToken

A continuation token, if this is not the first call.

type MaxResults

integer

param MaxResults

The maximum number of table versions to return in one response.

rtype

dict

returns

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'
                },
                '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
            },
            '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.

          • 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.

        • 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.

GetTables (updated) Link ¶
Changes (response)
{'TableList': {'ViewDefinition': {'Representations': {'ValidationConnection': '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)
)
type CatalogId

string

param CatalogId

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

type Expression

string

param Expression

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

type NextToken

string

param NextToken

A continuation token, included if this is a continuation call.

type MaxResults

integer

param MaxResults

The maximum number of tables to return in a single response.

type TransactionId

string

param TransactionId

The transaction ID at which to read the table contents.

type QueryAsOfTime

datetime

param QueryAsOfTime

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 .

rtype

dict

returns

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'
            },
            '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
        },
    ],
    '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.

        • 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.

    • NextToken (string) --

      A continuation token, present if the current list segment is not the last.

GetUnfilteredTableMetadata (updated) Link ¶
Changes (response)
{'Table': {'ViewDefinition': {'Representations': {'ValidationConnection': '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'
        }
    }
)
type Region

string

param Region

Specified only if the base tables belong to a different Amazon Web Services Region.

type CatalogId

string

param CatalogId

[REQUIRED]

The catalog ID where the table resides.

type DatabaseName

string

param DatabaseName

[REQUIRED]

(Required) Specifies the name of a database that contains the table.

type Name

string

param Name

[REQUIRED]

(Required) Specifies the name of a table for which you are requesting metadata.

type AuditContext

dict

param AuditContext

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.

type SupportedPermissionTypes

list

param SupportedPermissionTypes

[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) --

type ParentResourceArn

string

param ParentResourceArn

The resource ARN of the view.

type RootResourceArn

string

param RootResourceArn

The resource ARN of the root view in a chain of nested views.

type SupportedDialect

dict

param SupportedDialect

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.

type Permissions

list

param Permissions

The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.

  • (string) --

type QuerySessionContext

dict

param QuerySessionContext

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) --

rtype

dict

returns

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'
        },
        '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
    },
    '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.

      • 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.

    • 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.

SearchTables (updated) Link ¶
Changes (response)
{'TableList': {'ViewDefinition': {'Representations': {'ValidationConnection': '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'
)
type CatalogId

string

param CatalogId

A unique identifier, consisting of account_id .

type NextToken

string

param NextToken

A continuation token, included if this is a continuation call.

type Filters

list

param Filters

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.

type SearchText

string

param SearchText

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

type SortCriteria

list

param SortCriteria

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.

type MaxResults

integer

param MaxResults

The maximum number of tables to return in a single response.

type ResourceShareType

string

param ResourceShareType

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.

rtype

dict

returns

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'
            },
            '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
        },
    ]
}

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.

        • 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.

UpdateTable (updated) Link ¶
Changes (request)
{'Force': 'boolean',
 'TableInput': {'ViewDefinition': {'Definer': 'string',
                                   'IsProtected': 'boolean',
                                   'Representations': [{'Dialect': 'REDSHIFT | '
                                                                   'ATHENA | '
                                                                   'SPARK',
                                                        'DialectVersion': 'string',
                                                        'ValidationConnection': 'string',
                                                        'ViewExpandedText': 'string',
                                                        'ViewOriginalText': 'string'}],
                                   'SubObjects': ['string']}},
 'ViewUpdateAction': 'ADD | REPLACE | ADD_OR_REPLACE | DROP'}

Updates a metadata table in the Data Catalog.

See also: AWS API Documentation

Request Syntax

client.update_table(
    CatalogId='string',
    DatabaseName='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
)
type CatalogId

string

param CatalogId

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

type DatabaseName

string

param DatabaseName

[REQUIRED]

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

type TableInput

dict

param TableInput

[REQUIRED]

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) --

type SkipArchive

boolean

param SkipArchive

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.

type TransactionId

string

param TransactionId

The transaction ID at which to update the table contents.

type VersionId

string

param VersionId

The version ID at which to update the table contents.

type ViewUpdateAction

string

param ViewUpdateAction

The operation to be performed when updating the view.

type Force

boolean

param Force

A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --