Glue / Client / get_integration_table_properties

get_integration_table_properties

Glue.Client.get_integration_table_properties(**kwargs)

This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.

See also: AWS API Documentation

Request Syntax

response = client.get_integration_table_properties(
    ResourceArn='string',
    TableName='string'
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.

  • TableName (string) –

    [REQUIRED]

    The name of the table to be replicated.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceArn': 'string',
    'TableName': 'string',
    'SourceTableConfig': {
        'Fields': [
            'string',
        ],
        'FilterPredicate': 'string',
        'PrimaryKey': [
            'string',
        ],
        'RecordUpdateField': 'string'
    },
    'TargetTableConfig': {
        'UnnestSpec': 'TOPLEVEL'|'FULL'|'NOUNNEST',
        'PartitionSpec': [
            {
                'FieldName': 'string',
                'FunctionSpec': 'string',
                'ConversionSpec': 'string'
            },
        ],
        'TargetTableName': 'string'
    }
}

Response Structure

  • (dict) –

    • ResourceArn (string) –

      The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.

    • TableName (string) –

      The name of the table to be replicated.

    • SourceTableConfig (dict) –

      A structure for the source table configuration.

      • Fields (list) –

        A list of fields used for column-level filtering. Currently unsupported.

        • (string) –

      • FilterPredicate (string) –

        A condition clause used for row-level filtering. Currently unsupported.

      • PrimaryKey (list) –

        Provide the primary key set for this table. Currently supported specifically for SAP EntityOf entities upon request. Contact Amazon Web Services Support to make this feature available.

        • (string) –

      • RecordUpdateField (string) –

        Incremental pull timestamp-based field. Currently unsupported.

    • TargetTableConfig (dict) –

      A structure for the target table configuration.

      • UnnestSpec (string) –

        Specifies how nested objects are flattened to top-level elements. Valid values are: “TOPLEVEL”, “FULL”, or “NOUNNEST”.

      • PartitionSpec (list) –

        Determines the file layout on the target.

        • (dict) –

          A structure that describes how data is partitioned on the target.

          • FieldName (string) –

            The field name used to partition data on the target. Avoid using columns that have unique values for each row (for example, LastModifiedTimestamp, SystemModTimeStamp) as the partition column. These columns are not suitable for partitioning because they create a large number of small partitions, which can lead to performance issues.

          • FunctionSpec (string) –

            Specifies the function used to partition data on the target. The only accepted value for this parameter is ‘identity’ (string). The ‘identity’ function ensures that the data partitioning on the target follows the same scheme as the source. In other words, the partitioning structure of the source data is preserved in the target destination.

          • ConversionSpec (string) –

            Specifies the timestamp format of the source data. Valid values are:

            • epoch_sec - Unix epoch timestamp in seconds

            • epoch_milli - Unix epoch timestamp in milliseconds

            • iso - ISO 8601 formatted timestamp

            Note

            Only specify ConversionSpec when using timestamp-based partition functions (year, month, day, or hour). Glue Zero-ETL uses this parameter to correctly transform source data into timestamp format before partitioning.

            Do not use high-cardinality columns with the identity partition function. High-cardinality columns include:

            • Primary keys

            • Timestamp fields (such as LastModifiedTimestamp, CreatedDate)

            • System-generated timestamps

            Using high-cardinality columns with identity partitioning creates many small partitions, which can significantly degrade ingestion performance.

      • TargetTableName (string) –

        The optional name of a target table.

Exceptions