search_data_tables ¶

def search_data_tables(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
    max_results: Optional["capo_connect.types.max_result1000.MaxResult1000"] = None,
    search_filter: Optional[
        "capo_connect.types.data_table_search_filter.DataTableSearchFilter"
    ] = None,
    search_criteria: Optional[
        "capo_connect.types.data_table_search_criteria.DataTableSearchCriteria"
    ] = None,
) -> "capo_connect.types.search_data_tables_response.SearchDataTablesResponse":
    """<p>Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.</p>

    Args:
        instance_id: <p>The unique identifier for the Amazon Connect instance to search within.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of data tables to return in one page of results.</p>
        search_filter: <p>Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.</p>
        search_criteria: <p>Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.search_data_tables_request.SearchDataTablesRequest]",
    ) -> OperationResponse[
        "capo_connect.types.search_data_tables_response.SearchDataTablesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.search_data_tables

        output, http_response = (
            capo_connect._operations.amazon_connect_service.search_data_tables.search_data_tables(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchDataTables")
    )
    input_: capo_connect.types.search_data_tables_request.SearchDataTablesRequest = {
        "instance_id": instance_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if search_filter is not None:
        input_["search_filter"] = search_filter
    if search_criteria is not None:
        input_["search_criteria"] = search_criteria

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