Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTableMetadata

Lists the metadata for the tables in the specified data catalog database.

Request Syntax


{
   "CatalogName": "string",
   "DatabaseName": "string",
   "Expression": "string",
   "MaxResults": number,
   "NextToken": "string",
   "WorkGroup": "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.

CatalogName

The name of the data catalog for which table metadata should be returned.

Type: String

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

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

Required: Yes

DatabaseName

The name of the database for which table metadata should be returned.

Type: String

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

Required: Yes

Expression

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

Type: String

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

Required: No

MaxResults

Specifies the maximum number of results to return.

Type: Integer

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

Required: No

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Type: String

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

Required: No

WorkGroup

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled AWS Glue Data Catalog.

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Required: No

Response Syntax


{
   "NextToken": "string",
   "TableMetadataList": [ 
      { 
         "Columns": [ 
            { 
               "Comment": "string",
               "Name": "string",
               "Type": "string"
            }
         ],
         "CreateTime": number,
         "LastAccessTime": number,
         "Name": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "PartitionKeys": [ 
            { 
               "Comment": "string",
               "Name": "string",
               "Type": "string"
            }
         ],
         "TableType": "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

Type: String

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

TableMetadataList

A list of table metadata.

Type: Array of TableMetadata objects

Errors

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

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

MetadataException

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

HTTP Status Code: 400