Glue / Paginator / ListTableOptimizerRuns

ListTableOptimizerRuns

class Glue.Paginator.ListTableOptimizerRuns

paginator = client.get_paginator('list_table_optimizer_runs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Glue.Client.list_table_optimizer_runs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    Type='compaction'|'retention'|'orphan_file_deletion',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CatalogId (string) –

  [REQUIRED]

  The Catalog ID of the table.

• DatabaseName (string) –

  [REQUIRED]

  The name of the database in the catalog in which the table resides.

• TableName (string) –

  [REQUIRED]

  The name of the table.

• Type (string) –

  [REQUIRED]

  The type of table optimizer. Currently, the only valid value is compaction.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CatalogId': 'string',
    'DatabaseName': 'string',
    'TableName': 'string',
    'TableOptimizerRuns': [
        {
            'eventType': 'starting'|'completed'|'failed'|'in_progress',
            'startTimestamp': datetime(2015, 1, 1),
            'endTimestamp': datetime(2015, 1, 1),
            'metrics': {
                'NumberOfBytesCompacted': 'string',
                'NumberOfFilesCompacted': 'string',
                'NumberOfDpus': 'string',
                'JobDurationInHour': 'string'
            },
            'error': 'string',
            'compactionMetrics': {
                'IcebergMetrics': {
                    'NumberOfBytesCompacted': 123,
                    'NumberOfFilesCompacted': 123,
                    'NumberOfDpus': 123,
                    'JobDurationInHour': 123.0
                }
            },
            'retentionMetrics': {
                'IcebergMetrics': {
                    'NumberOfDataFilesDeleted': 123,
                    'NumberOfManifestFilesDeleted': 123,
                    'NumberOfManifestListsDeleted': 123,
                    'NumberOfDpus': 123,
                    'JobDurationInHour': 123.0
                }
            },
            'orphanFileDeletionMetrics': {
                'IcebergMetrics': {
                    'NumberOfOrphanFilesDeleted': 123,
                    'NumberOfDpus': 123,
                    'JobDurationInHour': 123.0
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  • CatalogId (string) –

    The Catalog ID of the table.

  • DatabaseName (string) –

    The name of the database in the catalog in which the table resides.

  • TableName (string) –

    The name of the table.

  • TableOptimizerRuns (list) –

    A list of the optimizer runs associated with a table.

    • (dict) –

      Contains details for a table optimizer run.

      • eventType (string) –

        An event type representing the status of the table optimizer run.

      • startTimestamp (datetime) –

        Represents the epoch timestamp at which the compaction job was started within Lake Formation.

      • endTimestamp (datetime) –

        Represents the epoch timestamp at which the compaction job ended.

      • metrics (dict) –

        A RunMetrics object containing metrics for the optimizer run.

        This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

        • NumberOfBytesCompacted (string) –

          The number of bytes removed by the compaction job run.

        • NumberOfFilesCompacted (string) –

          The number of files removed by the compaction job run.

        • NumberOfDpus (string) –

          The number of DPU hours consumed by the job.

        • JobDurationInHour (string) –

          The duration of the job in hours.

      • error (string) –

        An error that occured during the optimizer run.

      • compactionMetrics (dict) –

        A CompactionMetrics object containing metrics for the optimizer run.

        • IcebergMetrics (dict) –

          A structure containing the Iceberg compaction metrics for the optimizer run.

          • NumberOfBytesCompacted (integer) –

            The number of bytes removed by the compaction job run.

          • NumberOfFilesCompacted (integer) –

            The number of files removed by the compaction job run.

          • NumberOfDpus (integer) –

            The number of DPU hours consumed by the job.

          • JobDurationInHour (float) –

            The duration of the job in hours.

      • retentionMetrics (dict) –

        A RetentionMetrics object containing metrics for the optimizer run.

        • IcebergMetrics (dict) –

          A structure containing the Iceberg retention metrics for the optimizer run.

          • NumberOfDataFilesDeleted (integer) –

            The number of data files deleted by the retention job run.

          • NumberOfManifestFilesDeleted (integer) –

            The number of manifest files deleted by the retention job run.

          • NumberOfManifestListsDeleted (integer) –

            The number of manifest lists deleted by the retention job run.

          • NumberOfDpus (integer) –

            The number of DPU hours consumed by the job.

          • JobDurationInHour (float) –

            The duration of the job in hours.

      • orphanFileDeletionMetrics (dict) –

        An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

        • IcebergMetrics (dict) –

          A structure containing the Iceberg orphan file deletion metrics for the optimizer run.

          • NumberOfOrphanFilesDeleted (integer) –

            The number of orphan files deleted by the orphan file deletion job run.

          • NumberOfDpus (integer) –

            The number of DPU hours consumed by the job.

          • JobDurationInHour (float) –

            The duration of the job in hours.