Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142021,119944.8 KB

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

post/#X-Amz-Target=AWSGlue.SearchTables

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'AWSGlue.SearchTables' required

Request body

CatalogIdstring

A unique identifier, consisting of <code> <i>account_id</i> </code>.

NextTokenstring

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

SearchTextstring
<p>A string used for a text search.</p> <p>Specifying a value in quotes filters based on an exact match to the value.</p>
MaxResultsinteger

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

ResourceShareType'FOREIGN' | 'ALL' | 'FEDERATED'
<p>Allows you to specify that you want to search the tables shared with your account. The allowable values are <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FOREIGN</code>, will search the tables shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will search the tables shared with your account, as well as the tables in yor local account. </p> </li> </ul>

Response

Success

NextTokenstring

A continuation token, present if the current list segment is not the last.