ListTableOptimizerRuns - AWS Glue
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListTableOptimizerRuns

Lists the history of previous optimizer runs for a specific table.

Request Syntax

{
   "CatalogId": "string",
   "DatabaseName": "string",
   "MaxResults": number,
   "NextToken": "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

MaxResults

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

Type: Integer

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

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 | retention | orphan_file_deletion

Required: Yes

Response Syntax

{
   "CatalogId": "string",
   "DatabaseName": "string",
   "NextToken": "string",
   "TableName": "string",
   "TableOptimizerRuns": [ 
      { 
         "compactionMetrics": { 
            "IcebergMetrics": { 
               "JobDurationInHour": number,
               "NumberOfBytesCompacted": number,
               "NumberOfDpus": number,
               "NumberOfFilesCompacted": number
            }
         },
         "endTimestamp": number,
         "error": "string",
         "eventType": "string",
         "metrics": { 
            "JobDurationInHour": "string",
            "NumberOfBytesCompacted": "string",
            "NumberOfDpus": "string",
            "NumberOfFilesCompacted": "string"
         },
         "orphanFileDeletionMetrics": { 
            "IcebergMetrics": { 
               "JobDurationInHour": number,
               "NumberOfDpus": number,
               "NumberOfOrphanFilesDeleted": number
            }
         },
         "retentionMetrics": { 
            "IcebergMetrics": { 
               "JobDurationInHour": number,
               "NumberOfDataFilesDeleted": number,
               "NumberOfDpus": number,
               "NumberOfManifestFilesDeleted": number,
               "NumberOfManifestListsDeleted": number
            }
         },
         "startTimestamp": number
      }
   ]
}

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

NextToken

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

Type: String

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

TableOptimizerRuns

A list of the optimizer runs associated with a table.

Type: Array of TableOptimizerRun objects

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

ThrottlingException

The throttling threshhold was exceeded.

HTTP Status Code: 400

ValidationException

A value could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: