search_agents ¶

def search_agents(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    filters: "capo_quicksight.types.agent_search_filter_list.AgentSearchFilterList",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    max_results: Optional[
        "capo_quicksight.types.agents_max_results.AgentsMaxResults"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_quicksight.types.search_agents_response.SearchAgentsResponse":
    """<p>Searches for agents based on specified filters.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the agents.</p>
        filters: <p>The filters to apply when searching agents.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>The token for the next set of results, or null if there are no more 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_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_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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_agents_request.SearchAgentsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_agents_response.SearchAgentsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_agents

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchAgents")
    )
    input_: capo_quicksight.types.search_agents_request.SearchAgentsRequest = {
        "aws_account_id": aws_account_id,
        "filters": filters,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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