GetTableVersions
Retrieves a list of strings that identify available versions of a specified table.
Request Syntax
{
"AuditContext": {
"AdditionalAuditContext": "string",
"AllColumnsRequested": boolean,
"RequestedColumns": [ "string" ]
},
"CatalogId": "string",
"DatabaseName": "string",
"MaxResults": number,
"NextToken": "string",
"TableName": "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.
- AuditContext
-
A structure containing the Lake Formation audit context.
Type: AuditContext object
Required: No
- 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
- MaxResults
-
The maximum number of table versions to return in one response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A continuation token, if this is not the first call.
Type: String
Required: No
- 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
Response Syntax
{
"NextToken": "string",
"TableVersions": [
{
"Table": {
"CatalogId": "string",
"CreatedBy": "string",
"CreateTime": number,
"DatabaseName": "string",
"Description": "string",
"FederatedTable": {
"ConnectionName": "string",
"ConnectionType": "string",
"DatabaseIdentifier": "string",
"Identifier": "string"
},
"IcebergTableMetadata": {
"CurrentSchemaId": number,
"DefaultSortOrderId": number,
"DefaultSpecId": number,
"FormatVersion": "string",
"LastColumnId": number,
"LastPartitionId": number,
"Location": "string",
"PartitionSpecs": [
{
"Fields": [
{
"FieldId": number,
"Name": "string",
"SourceId": number,
"Transform": "string"
}
],
"SpecId": number
}
],
"Properties": {
"string" : "string"
},
"Schemas": [
{
"Fields": [
{
"Doc": "string",
"Id": number,
"InitialDefault": JSON value,
"Name": "string",
"Required": boolean,
"Type": JSON value,
"WriteDefault": JSON value
}
],
"IdentifierFieldIds": [ number ],
"SchemaId": number,
"Type": "string"
}
],
"SortOrders": [
{
"Fields": [
{
"Direction": "string",
"NullOrder": "string",
"SourceId": number,
"Transform": "string"
}
],
"OrderId": number
}
],
"TableUuid": "string"
},
"IsMaterializedView": boolean,
"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,
"RLSProperties": {
"DefaultRLSPolicy": "string"
},
"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",
"IsManaged": boolean,
"IsProtected": boolean,
"LastRefreshType": "string",
"RefreshSeconds": number,
"Representations": [
{
"Dialect": "string",
"DialectVersion": "string",
"IsStale": boolean,
"ValidationConnection": "string",
"ViewExpandedText": "string",
"ViewOriginalText": "string"
}
],
"SparkPipelineInfo": {
"string" : "string"
},
"SubObjects": [ "string" ],
"SubObjectsStatistics": [
{
"FileCount": number,
"GlueVersionId": "string",
"PartitionCount": number,
"SourceType": "string",
"TotalFileBytes": number
}
],
"SubObjectVersionIds": [ number ],
"ViewVersionId": number,
"ViewVersionToken": "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.
- NextToken
-
A continuation token, if the list of available versions does not include the last one.
Type: String
- TableVersions
-
A list of strings identifying available versions of the specified table.
Type: Array of TableVersion objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
