Table optimizer API

• TableOptimizer structure

• TableOptimizerConfiguration structure

• TableOptimizerRun structure

• BatchGetTableOptimizerEntry structure

• BatchTableOptimizer structure

• BatchGetTableOptimizerError structure

• RetentionConfiguration structure

• IcebergRetentionConfiguration structure

• OrphanFileDeletionConfiguration structure

• IcebergOrphanFileDeletionConfiguration structure

• CompactionMetrics structure

• RetentionMetrics structure

• OrphanFileDeletionMetrics structure

• IcebergCompactionMetrics structure

• IcebergRetentionMetrics structure

• IcebergOrphanFileDeletionMetrics structure

• RunMetrics structure

Fields

• type – UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

  The type of table optimizer. The valid values are:

  • compaction: for managing compaction with a table optimizer.

  • retention: for managing the retention of snapshot with a table optimizer.

  • orphan_file_deletion: for managing the deletion of orphan files with a table optimizer.

• configuration – A TableOptimizerConfiguration object.

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

• lastRun – A TableOptimizerRun object.

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

Fields

• roleArn – UTF-8 string, not less than 1 or more than 512 bytes long, matching the Single-line string pattern.

  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.

• retentionConfiguration – A RetentionConfiguration object.

  The configuration for a snapshot retention optimizer.

• orphanFileDeletionConfiguration – An OrphanFileDeletionConfiguration object.

  The configuration for an orphan file deletion optimizer.

Fields

• eventType – UTF-8 string (valid values: starting="STARTING" | completed="COMPLETED" | failed="FAILED" | in_progress="IN_PROGRESS").

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

• startTimestamp – Timestamp.

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

• endTimestamp – Timestamp.

  Represents the epoch timestamp at which the compaction job ended.

• metrics – A RunMetrics object.

  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.

• error – UTF-8 string.

  An error that occured during the optimizer run.

• compactionMetrics – A CompactionMetrics object.

  A CompactionMetrics object containing metrics for the optimizer run.

• retentionMetrics – A RetentionMetrics object.

  A RetentionMetrics object containing metrics for the optimizer run.

• orphanFileDeletionMetrics – An OrphanFileDeletionMetrics object.

  An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

Fields

• catalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• databaseName – UTF-8 string, at least 1 byte long.

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

• tableName – UTF-8 string, at least 1 byte long.

  The name of the table.

• type – UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

  The type of table optimizer.

Fields

• catalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• databaseName – UTF-8 string, at least 1 byte long.

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

• tableName – UTF-8 string, at least 1 byte long.

  The name of the table.

• tableOptimizer – A TableOptimizer object.

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

Fields

• error – An ErrorDetail object.

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

• catalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• databaseName – UTF-8 string, at least 1 byte long.

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

• tableName – UTF-8 string, at least 1 byte long.

  The name of the table.

• type – UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

  The type of table optimizer.

Fields

• icebergConfiguration – An IcebergRetentionConfiguration object.

  The configuration for an Iceberg snapshot retention optimizer.

Fields

• snapshotRetentionPeriodInDays – Number (integer).

  The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.

• numberOfSnapshotsToRetain – Number (integer).

  The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.

• cleanExpiredFiles – Boolean.

  If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.

Fields

• icebergConfiguration – An IcebergOrphanFileDeletionConfiguration object.

  The configuration for an Iceberg orphan file deletion optimizer.

Fields

• orphanFileRetentionPeriodInDays – Number (integer).

  The number of days that orphan files should be retained before file deletion. If an input is not provided, the default value 3 will be used.

• location – UTF-8 string.

  Specifies a directory in which to look for files (defaults to the table's location). You may choose a sub-directory rather than the top-level table location.

Fields

• IcebergMetrics – An IcebergCompactionMetrics object.

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

Fields

• IcebergMetrics – An IcebergRetentionMetrics object.

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

Fields

• IcebergMetrics – An IcebergOrphanFileDeletionMetrics object.

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

Fields

• NumberOfDpus – Number (Integer).

  The number of DPU hours consumed by the job.

• JobDurationInHour – Number (double).

  The duration of the job in hours.

Fields

• NumberOfDpus – Number (Integer).

  The number of DPU hours consumed by the job.

• JobDurationInHour – Number (double).

  The duration of the job in hours.

Fields

• NumberOfDpus – Number (Integer).

  The number of DPU hours consumed by the job.

• JobDurationInHour – Number (double).

  The duration of the job in hours.

Fields

• NumberOfBytesCompacted – UTF-8 string.

  The number of bytes removed by the compaction job run.

• NumberOfFilesCompacted – UTF-8 string.

  The number of files removed by the compaction job run.

• NumberOfDpus – UTF-8 string.

  The number of DPU hours consumed by the job.

• JobDurationInHour – UTF-8 string.

  The duration of the job in hours.

• GetTableOptimizer action (Python: get_table_optimizer)

• BatchGetTableOptimizer action (Python: batch_get_table_optimizer)

• ListTableOptimizerRuns action (Python: list_table_optimizer_runs)

• CreateTableOptimizer action (Python: create_table_optimizer)

• DeleteTableOptimizer action (Python: delete_table_optimizer)

• UpdateTableOptimizer action (Python: update_table_optimizer)

Request

• CatalogId – Required: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• Type – Required: UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

  The type of table optimizer.

Response

• CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• TableOptimizer – A TableOptimizer object.

  The optimizer associated with the specified table.

Errors

• EntityNotFoundException

• InvalidInputException

• AccessDeniedException

• InternalServiceException

• ThrottlingException

Request

• Entries – Required: An array of BatchGetTableOptimizerEntry objects.

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

Response

• TableOptimizers – An array of BatchTableOptimizer objects.

  A list of BatchTableOptimizer objects.

• Failures – An array of BatchGetTableOptimizerError objects.

  A list of errors from the operation.

Errors

• EntityNotFoundException

• InvalidInputException

• AccessDeniedException

• InternalServiceException

• ThrottlingException

Request

• CatalogId – Required: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• Type – Required: UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

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

• MaxResults – Number (integer).

  The maximum number of optimizer runs to return on each call.

• NextToken – UTF-8 string.

  A continuation token, if this is a continuation call.

Response

• CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• NextToken – UTF-8 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 – An array of TableOptimizerRun objects.

  A list of the optimizer runs associated with a table.

Errors

• EntityNotFoundException

• AccessDeniedException

• InvalidInputException

• ValidationException

• InternalServiceException

• ThrottlingException

Request

• CatalogId – Required: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• Type – Required: UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

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

• TableOptimizerConfiguration – Required: A TableOptimizerConfiguration object.

  A TableOptimizerConfiguration object representing the configuration of a table optimizer.

Response

• No Response parameters.

Errors

• EntityNotFoundException

• ValidationException

• InvalidInputException

• AccessDeniedException

• AlreadyExistsException

• InternalServiceException

• ThrottlingException

Request

• CatalogId – Required: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• Type – Required: UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

  The type of table optimizer.

Response

• No Response parameters.

Errors

• EntityNotFoundException

• InvalidInputException

• AccessDeniedException

• InternalServiceException

• ThrottlingException

Request

• CatalogId – Required: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The Catalog ID of the table.

• DatabaseName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

• TableName – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  The name of the table.

• Type – Required: UTF-8 string (valid values: compaction="COMPACTION" | retention="RETENTION" | orphan_file_deletion="ORPHAN_FILE_DELETION").

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

• TableOptimizerConfiguration – Required: A TableOptimizerConfiguration object.

  A TableOptimizerConfiguration object representing the configuration of a table optimizer.

Response

• No Response parameters.

Errors

• EntityNotFoundException

• InvalidInputException

• AccessDeniedException

• ValidationException

• InternalServiceException

• ThrottlingException

• ConcurrentModificationException