Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTableMetadata

Returns table metadata for the specified catalog, database, and table.

Request Syntax


{
   "CatalogName": "string",
   "DatabaseName": "string",
   "TableName": "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 that contains the database and table metadata to return.

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 that contains the table metadata to return.

Type: String

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

Required: Yes

TableName

The name of the table for which metadata is returned.

Type: String

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

Required: Yes

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


{
   "TableMetadata": { 
      "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.

TableMetadata

An object that contains table metadata.

Type: TableMetadata object

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