[ aws . lakeformation ]

list-table-storage-optimizers

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-table-storage-optimizers
[--catalog-id <value>]
--database-name <value>
--table-name <value>
[--storage-optimizer-type <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The Catalog ID of the table.

--database-name (string)

Name of the database where the table is present.

--table-name (string)

Name of the table.

--storage-optimizer-type (string)

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

Possible values:

• COMPACTION

• GARBAGE_COLLECTION

• ALL

--max-results (integer)

The number of storage optimizers to return on each call.

--next-token (string)

A continuation token, if this is a continuation call.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

StorageOptimizerList -> (list)

A list of the storage optimizers associated with a table.

(structure)

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

StorageOptimizerType -> (string)

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

Config -> (map)

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

key -> (string)

value -> (string)

ErrorMessage -> (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 -> (string)

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

LastRunDetails -> (string)

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

NextToken -> (string)

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