Glue / Client / batch_get_table_optimizer

batch_get_table_optimizer

Glue.Client.batch_get_table_optimizer(**kwargs)

Returns the configuration for the specified table optimizers.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_table_optimizer(
    Entries=[
        {
            'catalogId': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'type': 'compaction'
        },
    ]
)

Parameters:

Entries (list) –

[REQUIRED]

A list of BatchGetTableOptimizerEntry objects specifying the table optimizers to retrieve.

• (dict) –

  Represents a table optimizer to retrieve in the BatchGetTableOptimizer operation.

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

  • type (string) –

    The type of table optimizer.

Return type:

dict

Returns:

Response Syntax

{
    'TableOptimizers': [
        {
            'catalogId': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'tableOptimizer': {
                'type': 'compaction',
                'configuration': {
                    'roleArn': 'string',
                    'enabled': True|False
                },
                'lastRun': {
                    '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'
                }
            }
        },
    ],
    'Failures': [
        {
            'error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            },
            'catalogId': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'type': 'compaction'
        },
    ]
}

Response Structure

• (dict) –

  • TableOptimizers (list) –

    A list of BatchTableOptimizer objects.

    • (dict) –

      Contains details for one of the table optimizers returned by the BatchGetTableOptimizer operation.

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

      • tableOptimizer (dict) –

        A TableOptimizer object that contains details on the configuration and last run of a table optimzer.

        • type (string) –

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

        • configuration (dict) –

          A TableOptimizerConfiguration object that was specified when creating or updating a table optimizer.

          • roleArn (string) –

            A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller’s behalf.

          • enabled (boolean) –

            Whether table optimization is enabled.

        • lastRun (dict) –

          A TableOptimizerRun object representing the last run of the table optimizer.

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

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

  • Failures (list) –

    A list of errors from the operation.

    • (dict) –

      Contains details on one of the errors in the error list returned by the BatchGetTableOptimizer operation.

      • error (dict) –

        An ErrorDetail object containing code and message details about the error.

        • ErrorCode (string) –

          The code associated with this error.

        • ErrorMessage (string) –

          A message describing the error.

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

      • type (string) –

        The type of table optimizer.

Exceptions

• Glue.Client.exceptions.InternalServiceException