Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTableStorageOptimizers

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

Request Syntax


POST /ListTableStorageOptimizers HTTP/1.1
Content-type: application/json

{
   "CatalogId": "string",
   "DatabaseName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "StorageOptimizerType": "string",
   "TableName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

CatalogId

The Catalog ID of the table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

DatabaseName

Name of the database where the table is present.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

MaxResults

The number of storage optimizers to return on each call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

StorageOptimizerType

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

Type: String

Valid Values: COMPACTION | GARBAGE_COLLECTION | ALL

Required: No

TableName

Name of the table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "StorageOptimizerList": [ 
      { 
         "Config": { 
            "string" : "string" 
         },
         "ErrorMessage": "string",
         "LastRunDetails": "string",
         "StorageOptimizerType": "string",
         "Warnings": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

StorageOptimizerList

A list of the storage optimizers associated with a table.

Type: Array of StorageOptimizer objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 403

EntityNotFoundException

A specified entity does not exist.

Message: A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

Message: A message describing the problem.

HTTP Status Code: 400