Glue / Client / list_table_optimizer_runs
list_table_optimizer_runs#
- Glue.Client.list_table_optimizer_runs(**kwargs)#
Lists the history of previous optimizer runs for a specific table.
See also: AWS API Documentation
Request Syntax
response = client.list_table_optimizer_runs( CatalogId='string', DatabaseName='string', TableName='string', Type='compaction', MaxResults=123, NextToken='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
.MaxResults (integer) – The maximum number of optimizer runs to return on each call.
NextToken (string) – A continuation token, if this is a continuation call.
- Return type:
dict
- Returns:
Response Syntax
{ 'CatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'NextToken': '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' }, ] }
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.
NextToken (string) –
A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
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.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.
Exceptions
Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.AccessDeniedException
Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.InternalServiceException