search_tables ¶

def search_tables(
    self,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    catalog_id: Optional[
        "capo_glue.types.catalog_id_string.CatalogIdString"
    ] = None,
    next_token: Optional["capo_glue.types.token.Token"] = None,
    filters: Optional[
        "capo_glue.types.search_property_predicates.SearchPropertyPredicates"
    ] = None,
    search_text: Optional["capo_glue.types.value_string.ValueString"] = None,
    sort_criteria: Optional["capo_glue.types.sort_criteria.SortCriteria"] = None,
    max_results: Optional["capo_glue.types.page_size.PageSize"] = None,
    resource_share_type: Optional[
        "capo_glue.types.resource_share_type.ResourceShareType"
    ] = None,
    include_status_details: Optional[
        "capo_glue.types.boolean_nullable.BooleanNullable"
    ] = None,
) -> "capo_glue.types.search_tables_response.SearchTablesResponse":
    """<p>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. </p> <p>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. </p>

    Args:
        catalog_id: <p>A unique identifier, consisting of <code> <i>account_id</i> </code>.</p>
        next_token: <p>A continuation token, included if this is a continuation call.</p>
        filters: <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: <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: <p>A list of criteria for sorting the results by a field name, in an ascending or descending order.</p>
        max_results: <p>The maximum number of tables to return in a single response.</p>
        resource_share_type: <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: <p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>

    Raises:
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.search_tables_request.SearchTablesRequest]",
    ) -> OperationResponse[
        "capo_glue.types.search_tables_response.SearchTablesResponse"
    ]:
        import capo_glue._operations.aws_glue.search_tables

        output, http_response = (
            capo_glue._operations.aws_glue.search_tables.search_tables(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchTables")
    )
    input_: capo_glue.types.search_tables_request.SearchTablesRequest = {}
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters
    if search_text is not None:
        input_["search_text"] = search_text
    if sort_criteria is not None:
        input_["sort_criteria"] = sort_criteria
    if max_results is not None:
        input_["max_results"] = max_results
    if resource_share_type is not None:
        input_["resource_share_type"] = resource_share_type
    if include_status_details is not None:
        input_["include_status_details"] = include_status_details

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output