Glue / Client / list_integration_table_properties

list_integration_table_properties

Glue.Client.list_integration_table_properties(**kwargs)

Lists the integration table properties in your account. This operation supports filtering and pagination.

See also: AWS API Documentation

Request Syntax

response = client.list_integration_table_properties(
    Marker='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123
)

Parameters:

• Marker (string) – The pagination token for the next page of results. The initial value is null.

• Filters (list) –

  A list of filters. Supported filter keys are SourceArn, TargetArn, SourceTableName, and TargetTableName.

  • (dict) –

    A key-value filter used to narrow the list of integration table properties returned by ListIntegrationTableProperties. Specify a filter key and one or more values to match.

    • Name (string) –

      The name of the filter. Supported filter keys are SourceArn, TargetArn, SourceTableName, and TargetTableName.

    • Values (list) –

      A list of filter values.

      • (string) –

• MaxRecords (integer) – The maximum number of records to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'IntegrationTablePropertiesList': [
        {
            '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',
                'IntegrationArn': 'string'
            }
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • IntegrationTablePropertiesList (list) –

    A list of integration table properties meeting the filter criteria.

    • (dict) –

      The properties of a single integration table, including the resource ARN, the table name, and the source or target table configuration.

      • ResourceArn (string) –

        The connection ARN of the source, or the database ARN of the target.

      • TableName (string) –

        The name of the source 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 accepted values for this parameter are:

              • identity - Uses source values directly without transformation

              • year - Extracts the year from timestamp values (e.g., 2023)

              • month - Extracts the month from timestamp values (e.g., 2023-01)

              • day - Extracts the day from timestamp values (e.g., 2023-01-15)

              • hour - Extracts the hour from timestamp values (e.g., 2023-01-15-14)

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

        • IntegrationArn (string) –

          The ARN of the integration that owns this target table configuration.

  • Marker (string) –

    The pagination token for the next page. Returns null if there are no more results.

Exceptions

• Glue.Client.exceptions.ValidationException

• Glue.Client.exceptions.AccessDeniedException

• Glue.Client.exceptions.ResourceNotFoundException

• Glue.Client.exceptions.InternalServerException

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.InvalidInputException