list_jobs ¶

def list_jobs(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    job_category: Optional["capo_sagemaker.types.job_category.JobCategory"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    sort_by: Optional["capo_sagemaker.types.sort_by.SortBy"] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    status_equals: Optional["capo_sagemaker.types.job_status.JobStatus"] = None,
) -> "capo_sagemaker.types.list_jobs_response.ListJobsResponse":
    """<p>Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in <code>SortBy</code>. Use pagination to retrieve large result sets efficiently.</p> <p>The following operations are related to <code>ListJobs</code>:</p> <ul> <li> <p> <code>CreateJob</code> </p> </li> <li> <p> <code>DescribeJob</code> </p> </li> </ul>

    Args:
        job_category: <p>The category of jobs to list.</p>
        next_token: <p>If the previous response was truncated, this token retrieves the next set of results.</p>
        max_results: <p>The maximum number of jobs to return in the response. The default value is 50.</p>
        creation_time_after: <p>A filter that returns only jobs created after the specified time.</p>
        creation_time_before: <p>A filter that returns only jobs created before the specified time.</p>
        last_modified_time_after: <p>A filter that returns only jobs modified after the specified time.</p>
        last_modified_time_before: <p>A filter that returns only jobs modified before the specified time.</p>
        name_contains: <p>A string in the job name to filter results. Only jobs whose name contains the specified string are returned.</p>
        sort_by: <p>The field to sort results by.</p>
        sort_order: <p>The sort order for results. Valid values are <code>Ascending</code> and <code>Descending</code>.</p>
        status_equals: <p>A filter that returns only jobs with the specified status.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_jobs_request.ListJobsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_jobs_response.ListJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_jobs

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_jobs.list_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListJobs")
    )
    input_: capo_sagemaker.types.list_jobs_request.ListJobsRequest = {}
    if job_category is not None:
        input_["job_category"] = job_category
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    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 last_modified_time_after is not None:
        input_["last_modified_time_after"] = last_modified_time_after
    if last_modified_time_before is not None:
        input_["last_modified_time_before"] = last_modified_time_before
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if status_equals is not None:
        input_["status_equals"] = status_equals

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