Skip to content

SearchTablesRequest

Source code in docs_src/capo_glue/types/search_tables_request.py
class SearchTablesRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>A unique identifier, consisting of <code> <i>account_id</i> </code>.</p>"""
    next_token: NotRequired["capo_glue.types.token.Token"]
    """<p>A continuation token, included if this is a continuation call.</p>"""
    filters: NotRequired[
        "capo_glue.types.search_property_predicates.SearchPropertyPredicates"
    ]
    """<p>A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.</p> <p>The <code>Comparator</code> member of the <code>PropertyPredicate</code> struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when <code>Key=Name</code>, a fuzzy match algorithm is used. The <code>Key</code> field (for example, the value of the <code>Name</code> field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the <code>Value</code> member of <code>PropertyPredicate</code>. For example, if <code>Key=Name</code> and <code>Value=link</code>, tables named <code>customer-link</code> and <code>xx-link-yy</code> are returned, but <code>xxlinkyy</code> is not returned.</p>"""
    search_text: NotRequired["capo_glue.types.value_string.ValueString"]
    """<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>"""
    sort_criteria: NotRequired["capo_glue.types.sort_criteria.SortCriteria"]
    """<p>A list of criteria for sorting the results by a field name, in an ascending or descending order.</p>"""
    max_results: NotRequired["capo_glue.types.page_size.PageSize"]
    """<p>The maximum number of tables to return in a single response.</p>"""
    resource_share_type: NotRequired[
        "capo_glue.types.resource_share_type.ResourceShareType"
    ]
    """<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>"""
    include_status_details: NotRequired[
        "capo_glue.types.boolean_nullable.BooleanNullable"
    ]
    """<p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

A unique identifier, consisting of account_id .

filters instance-attribute

filters: NotRequired[SearchPropertyPredicates]

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

include_status_details instance-attribute

include_status_details: NotRequired[BooleanNullable]

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

max_results instance-attribute

max_results: NotRequired[PageSize]

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

next_token instance-attribute

next_token: NotRequired[Token]

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

resource_share_type instance-attribute

resource_share_type: NotRequired[ResourceShareType]

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

  • If set to FOREIGN, will search the tables shared with your account.

  • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

search_text instance-attribute

search_text: NotRequired[ValueString]

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

sort_criteria instance-attribute

sort_criteria: NotRequired[SortCriteria]

A list of criteria for sorting the results by a field name, in an ascending or descending order.