Request Syntax Request Parameters Response Elements Errors See Also

UpdateTable

Updates a metadata table in the Data Catalog.

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "Force": boolean,
   "SkipArchive": boolean,
   "TableInput": { 
      "Description": "string",
      "LastAccessTime": number,
      "LastAnalyzedTime": number,
      "Name": "string",
      "Owner": "string",
      "Parameters": { 
         "string" : "string" 
      },
      "PartitionKeys": [ 
         { 
            "Comment": "string",
            "Name": "string",
            "Parameters": { 
               "string" : "string" 
            },
            "Type": "string"
         }
      ],
      "Retention": number,
      "StorageDescriptor": { 
         "AdditionalLocations": [ "string" ],
         "BucketColumns": [ "string" ],
         "Columns": [ 
            { 
               "Comment": "string",
               "Name": "string",
               "Parameters": { 
                  "string" : "string" 
               },
               "Type": "string"
            }
         ],
         "Compressed": boolean,
         "InputFormat": "string",
         "Location": "string",
         "NumberOfBuckets": number,
         "OutputFormat": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "SchemaReference": { 
            "SchemaId": { 
               "RegistryName": "string",
               "SchemaArn": "string",
               "SchemaName": "string"
            },
            "SchemaVersionId": "string",
            "SchemaVersionNumber": number
         },
         "SerdeInfo": { 
            "Name": "string",
            "Parameters": { 
               "string" : "string" 
            },
            "SerializationLibrary": "string"
         },
         "SkewedInfo": { 
            "SkewedColumnNames": [ "string" ],
            "SkewedColumnValueLocationMaps": { 
               "string" : "string" 
            },
            "SkewedColumnValues": [ "string" ]
         },
         "SortColumns": [ 
            { 
               "Column": "string",
               "SortOrder": number
            }
         ],
         "StoredAsSubDirectories": boolean
      },
      "TableType": "string",
      "TargetTable": { 
         "CatalogId": "string",
         "DatabaseName": "string",
         "Name": "string",
         "Region": "string"
      },
      "ViewDefinition": { 
         "Definer": "string",
         "IsProtected": boolean,
         "Representations": [ 
            { 
               "Dialect": "string",
               "DialectVersion": "string",
               "ValidationConnection": "string",
               "ViewExpandedText": "string",
               "ViewOriginalText": "string"
            }
         ],
         "SubObjects": [ "string" ]
      },
      "ViewExpandedText": "string",
      "ViewOriginalText": "string"
   },
   "TransactionId": "string",
   "VersionId": "string",
   "ViewUpdateAction": "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 ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.

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

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

Type: String

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

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

Required: Yes

Force

A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.

Type: Boolean

Required: No

SkipArchive

By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.

Type: Boolean

Required: No

TableInput

An updated TableInput object to define the metadata table in the catalog.

Type: TableInput object

Required: Yes

TransactionId

The transaction ID at which to update the table contents.

Type: String

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

Pattern: [\p{L}\p{N}\p{P}]*

Required: No

VersionId

The version ID at which to update the table contents.

Type: String

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

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

Required: No

ViewUpdateAction

The operation to be performed when updating the view.

Type: String

Valid Values: ADD | REPLACE | ADD_OR_REPLACE | DROP

Required: No

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.

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

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

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

ResourceNotReadyException

A resource was not ready for a transaction.

HTTP Status Code: 400

ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

HTTP Status Code: 400