search_knowledge_bases ¶

def search_knowledge_bases(
    self,
    aws_account_id: "capo_quicksight.types.kb_aws_account_id.KbAwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.next_token.NextToken"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
    filters: Optional[
        "capo_quicksight.types.knowledge_base_search_filters.KnowledgeBaseSearchFilters"
    ] = None,
    sort_by: Optional[
        "capo_quicksight.types.knowledge_base_sort_by.KnowledgeBaseSortBy"
    ] = None,
) -> "capo_quicksight.types.search_knowledge_bases_response.SearchKnowledgeBasesResponse":
    """<p>Searches for a subset of knowledge bases based on specified filters.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>
        max_results: <p>The maximum number of results to return.</p>
        filters: <p>The filters to apply when searching knowledge bases.</p>
        sort_by: <p>The sort configuration for the search results.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.search_knowledge_bases_request.SearchKnowledgeBasesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_knowledge_bases_response.SearchKnowledgeBasesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_knowledge_bases

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.search_knowledge_bases.search_knowledge_bases(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_quicksight.types.search_knowledge_bases_response.SearchKnowledgeBasesResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.search_knowledge_bases_response

        return (
            capo_quicksight.types.search_knowledge_bases_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("SearchKnowledgeBases", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.search_knowledge_bases_request.SearchKnowledgeBasesRequest = {
        "aws_account_id": aws_account_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    if sort_by is not None:
        input_["sort_by"] = sort_by

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