Storage APIs - AWS Lake Formation

Storage APIs

The Storage APIs allow you to manage storage optimization on governed tables in AWS Lake Formation.

Data Types

StorageOptimizer Structure

A structure describing the configuration and details of a storage optimizer.

Fields

  • StorageOptimizerType – UTF-8 string (valid values: compaction="COMPACTION" | garbage_collection="GARBAGE_COLLECTION" | index="INDEX" | copy_on_write="COPY_ON_WRITE" | all="GENERIC").

    The specific type of storage optimizer. The supported value is compaction.

  • Config – A map array of key-value pairs.

    Each key is a UTF-8 string.

    Each value is a UTF-8 string.

    A map of the storage optimizer configuration. Currently contains only one key-value pair: is_enabled indicates true or false for acceleration.

  • ErrorMessage – UTF-8 string.

    A message that contains information about any error (if present).

    When an acceleration result has an enabled status, the error message is empty.

    When an acceleration result has a disabled status, the message describes an error or simply indicates "disabled by the user".

  • Warnings – UTF-8 string.

    A message that contains information about any warnings (if present).

  • LastRunDetails – UTF-8 string.

    When an acceleration result has an enabled status, contains the details of the last job run.

Operations

ListTableStorageOptimizers Action (Python: list_table_storage_optimizers)

Returns the configuration of all storage optimizers associated with a specified table.

Request

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

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

    Name of the database where the table is present.

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

    Name of the table.

  • StorageOptimizerType – UTF-8 string (valid values: compaction="COMPACTION" | garbage_collection="GARBAGE_COLLECTION" | index="INDEX" | copy_on_write="COPY_ON_WRITE" | all="GENERIC").

    The specific type of storage optimizers to list. The supported value is compaction.

  • MaxResults – Number (integer), not less than 1 or more than 1000.

    The number of storage optimizers to return on each call.

  • NextToken – UTF-8 string.

    A continuation token, if this is a continuation call.

Response

  • StorageOptimizerList – An array of StorageOptimizer objects.

    A list of the storage optimizers associated with a table.

  • NextToken – UTF-8 string.

    A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Errors

  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateTableStorageOptimizer Action (Python: update_table_storage_optimizer)

Updates the configuration of the storage optimizers for a table.

Request

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

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

    Name of the database where the table is present.

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

    Name of the table for which to enable the storage optimizer.

  • StorageOptimizerConfigRequired: A map array of key-value pairs.

    Each key is a UTF-8 string (valid values: compaction="COMPACTION" | garbage_collection="GARBAGE_COLLECTION" | index="INDEX" | copy_on_write="COPY_ON_WRITE" | all="GENERIC").

    Each value is a A map array of key-value pairs.

    Each key is a UTF-8 string.

    Each value is a UTF-8 string.

    Name of the table for which to enable the storage optimizer.

Response

  • Result – UTF-8 string.

    A response indicating the success of failure of the operation.

Errors

  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException