Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTableVersion

Retrieves a specified version of a table.

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "TableName": "string",
   "VersionId": "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 tables reside. 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 database in the catalog 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

TableName

The name of the table. 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

VersionId

The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.

Type: String

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

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

Required: No

Response Syntax


{
   "TableVersion": { 
      "Table": { 
         "CatalogId": "string",
         "CreatedBy": "string",
         "CreateTime": number,
         "DatabaseName": "string",
         "Description": "string",
         "FederatedTable": { 
            "ConnectionName": "string",
            "ConnectionType": "string",
            "DatabaseIdentifier": "string",
            "Identifier": "string"
         },
         "IsMultiDialectView": boolean,
         "IsRegisteredWithLakeFormation": boolean,
         "LastAccessTime": number,
         "LastAnalyzedTime": number,
         "Name": "string",
         "Owner": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "PartitionKeys": [ 
            { 
               "Comment": "string",
               "Name": "string",
               "Parameters": { 
                  "string" : "string" 
               },
               "Type": "string"
            }
         ],
         "Retention": number,
         "Status": { 
            "Action": "string",
            "Details": { 
               "RequestedChange": "Table",
               "ViewValidations": [ 
                  { 
                     "Dialect": "string",
                     "DialectVersion": "string",
                     "Error": { 
                        "ErrorCode": "string",
                        "ErrorMessage": "string"
                     },
                     "State": "string",
                     "UpdateTime": number,
                     "ViewValidationText": "string"
                  }
               ]
            },
            "Error": { 
               "ErrorCode": "string",
               "ErrorMessage": "string"
            },
            "RequestedBy": "string",
            "RequestTime": number,
            "State": "string",
            "UpdatedBy": "string",
            "UpdateTime": 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"
         },
         "UpdateTime": number,
         "VersionId": "string",
         "ViewDefinition": { 
            "Definer": "string",
            "IsProtected": boolean,
            "Representations": [ 
               { 
                  "Dialect": "string",
                  "DialectVersion": "string",
                  "IsStale": boolean,
                  "ValidationConnection": "string",
                  "ViewExpandedText": "string",
                  "ViewOriginalText": "string"
               }
            ],
            "SubObjects": [ "string" ]
         },
         "ViewExpandedText": "string",
         "ViewOriginalText": "string"
      },
      "VersionId": "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.

TableVersion

The requested table version.

Type: TableVersion object

Errors

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

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

GlueEncryptionException

An encryption operation failed.

Message: The 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

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400