Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTables

Retrieves the definitions of some or all of the tables in a given Database.

Request Syntax


{
   "AttributesToGet": [ "string" ],
   "CatalogId": "string",
   "DatabaseName": "string",
   "Expression": "string",
   "IncludeStatusDetails": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "QueryAsOfTime": number,
   "TransactionId": "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.

AttributesToGet

Specifies the table fields returned by the GetTables call. This parameter doesn’t accept an empty list. The request must include NAME.

The following are the valid combinations of values:

NAME - Names of all tables in the database.
NAME, TABLE_TYPE - Names of all tables and the table types.

Type: Array of strings

Valid Values: NAME | TABLE_TYPE

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 whose tables to list. 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

Expression

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

IncludeStatusDetails

Specifies whether to include status details related to a request to create or update an AWS Glue Data Catalog view.

Type: Boolean

Required: No

MaxResults

The maximum number of tables to return in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A continuation token, included if this is a continuation call.

Type: String

Required: No

QueryAsOfTime

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

Type: Timestamp

Required: No

TransactionId

The transaction ID at which to read the table contents.

Type: String

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

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "TableList": [ 
      { 
         "CatalogId": "string",
         "CreatedBy": "string",
         "CreateTime": number,
         "DatabaseName": "string",
         "Description": "string",
         "FederatedTable": { 
            "ConnectionName": "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"
      }
   ]
}

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, present if the current list segment is not the last.

Type: String

TableList

A list of the requested Table objects.

Type: Array of Table objects

Errors

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

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

FederationSourceException

A federation source failed.

HTTP Status Code: 400

FederationSourceRetryableException

A federation source failed, but the operation may be retried.

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