Skip to content

list_evaluators

list_evaluators(
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListEvaluatorsResponse

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Parameters:

  • next_token (Optional[str], default: None ) –

    The pagination token from a previous request to retrieve the next page of results.

  • max_results (Optional[int], default: None ) –

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

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def list_evaluators(
    self,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_bedrock_agentcore_control.types.list_evaluators_response.ListEvaluatorsResponse":
    """<p> Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user. </p>

    Args:
        next_token: <p> The pagination token from a previous request to retrieve the next page of results. </p>
        max_results: <p> The maximum number of evaluators to return in a single response. </p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.list_evaluators_request.ListEvaluatorsRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.list_evaluators_response.ListEvaluatorsResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_evaluators

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_evaluators.list_evaluators(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_bedrock_agentcore_control.types.list_evaluators_response.ListEvaluatorsResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.list_evaluators_response

        return capo_bedrock_agentcore_control.types.list_evaluators_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListEvaluators", redact_output=_redact_output),
    )
    input_: capo_bedrock_agentcore_control.types.list_evaluators_request.ListEvaluatorsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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