UpdateTableOptimizer
Updates the configuration for an existing table optimizer.
Request Syntax
{
"CatalogId": "string
",
"DatabaseName": "string
",
"TableName": "string
",
"TableOptimizerConfiguration": {
"compactionConfiguration": {
"icebergConfiguration": {
"deleteFileThreshold": number
,
"minInputFiles": number
,
"strategy": "string
"
}
},
"enabled": boolean
,
"orphanFileDeletionConfiguration": {
"icebergConfiguration": {
"location": "string
",
"orphanFileRetentionPeriodInDays": number
,
"runRateInHours": number
}
},
"retentionConfiguration": {
"icebergConfiguration": {
"cleanExpiredFiles": boolean
,
"numberOfSnapshotsToRetain": number
,
"runRateInHours": number
,
"snapshotRetentionPeriodInDays": number
}
},
"roleArn": "string
",
"vpcConfiguration": { ... }
},
"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
- TableOptimizerConfiguration
-
A
TableOptimizerConfiguration
object representing the configuration of a table optimizer.Type: TableOptimizerConfiguration object
Required: Yes
- Type
-
The type of table optimizer.
Type: String
Valid Values:
compaction | retention | orphan_file_deletion
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- ConcurrentModificationException
-
Two processes are trying to modify a resource simultaneously.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- 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.
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- ThrottlingException
-
The throttling threshhold was exceeded.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- ValidationException
-
A value could not be validated.
- Message
-
A message describing the problem.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: