Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTableOptimizer

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

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "TableName": "string",
   "Type": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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: Yes

DatabaseName

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

Type: String

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

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

Required: Yes

TableName

The 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

Type

The type of table optimizer.

Type: String

Valid Values: compaction

Required: Yes

Response Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "TableName": "string",
   "TableOptimizer": { 
      "configuration": { 
         "enabled": boolean,
         "roleArn": "string"
      },
      "lastRun": { 
         "endTimestamp": number,
         "error": "string",
         "eventType": "string",
         "metrics": { 
            "JobDurationInHour": "string",
            "NumberOfBytesCompacted": "string",
            "NumberOfDpus": "string",
            "NumberOfFilesCompacted": "string"
         },
         "startTimestamp": number
      },
      "type": "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.

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]*

DatabaseName

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

Type: String

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

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

TableName

The 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]*

TableOptimizer

The optimizer associated with the specified table.

Type: TableOptimizer object

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400