list_evaluation_jobs ¶

def list_evaluation_jobs(
    self,
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    creation_time_after: Optional["capo_bedrock.types.timestamp.Timestamp"] = None,
    creation_time_before: Optional["capo_bedrock.types.timestamp.Timestamp"] = None,
    status_equals: Optional[
        "capo_bedrock.types.evaluation_job_status.EvaluationJobStatus"
    ] = None,
    application_type_equals: Optional[
        "capo_bedrock.types.application_type.ApplicationType"
    ] = None,
    name_contains: Optional[
        "capo_bedrock.types.evaluation_job_name.EvaluationJobName"
    ] = None,
    max_results: Optional["capo_bedrock.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_bedrock.types.pagination_token.PaginationToken"
    ] = None,
    sort_by: Optional["capo_bedrock.types.sort_jobs_by.SortJobsBy"] = None,
    sort_order: Optional["capo_bedrock.types.sort_order.SortOrder"] = None,
) -> "capo_bedrock.types.list_evaluation_jobs_response.ListEvaluationJobsResponse":
    """<p>Lists all existing evaluation jobs.</p>

    Args:
        creation_time_after: <p>A filter to only list evaluation jobs created after a specified time.</p>
        creation_time_before: <p>A filter to only list evaluation jobs created before a specified time.</p>
        status_equals: <p>A filter to only list evaluation jobs that are of a certain status.</p>
        application_type_equals: <p>A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.</p>
        name_contains: <p>A filter to only list evaluation jobs that contain a specified string in the job name.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>Continuation token from the previous response, for Amazon Bedrock to list the next set of results.</p>
        sort_by: <p>Specifies a creation time to sort the list of evaluation jobs by when they were created.</p>
        sort_order: <p>Specifies whether to sort the list of evaluation jobs by either ascending or descending order.</p>

    Raises:
        capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock.types.list_evaluation_jobs_request.ListEvaluationJobsRequest]",
    ) -> OperationResponse[
        "capo_bedrock.types.list_evaluation_jobs_response.ListEvaluationJobsResponse"
    ]:
        import capo_bedrock._operations.amazon_bedrock_control_plane_service.list_evaluation_jobs

        output, http_response = (
            capo_bedrock._operations.amazon_bedrock_control_plane_service.list_evaluation_jobs.list_evaluation_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEvaluationJobs")
    )
    input_: capo_bedrock.types.list_evaluation_jobs_request.ListEvaluationJobsRequest = {}
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if status_equals is not None:
        input_["status_equals"] = status_equals
    if application_type_equals is not None:
        input_["application_type_equals"] = application_type_equals
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

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