Skip to content

ListJobsRequest

Source code in docs_src/capo_sagemaker/types/list_jobs_request.py
class ListJobsRequest(TypedDict, closed=True):
    job_category: NotRequired["capo_sagemaker.types.job_category.JobCategory"]
    """<p>The category of jobs to list.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the previous response was truncated, this token retrieves the next set of results.</p>"""
    max_results: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>The maximum number of jobs to return in the response. The default value is 50.</p>"""
    creation_time_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only jobs created after the specified time.</p>"""
    creation_time_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only jobs created before the specified time.</p>"""
    last_modified_time_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only jobs modified after the specified time.</p>"""
    last_modified_time_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only jobs modified before the specified time.</p>"""
    name_contains: NotRequired["capo_sagemaker.types.name_contains.NameContains"]
    """<p>A string in the job name to filter results. Only jobs whose name contains the specified string are returned.</p>"""
    sort_by: NotRequired["capo_sagemaker.types.sort_by.SortBy"]
    """<p>The field to sort results by.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.sort_order.SortOrder"]
    """<p>The sort order for results. Valid values are <code>Ascending</code> and <code>Descending</code>.</p>"""
    status_equals: NotRequired["capo_sagemaker.types.job_status.JobStatus"]
    """<p>A filter that returns only jobs with the specified status.</p>"""

creation_time_after instance-attribute

creation_time_after: NotRequired[Timestamp]

A filter that returns only jobs created after the specified time.

creation_time_before instance-attribute

creation_time_before: NotRequired[Timestamp]

A filter that returns only jobs created before the specified time.

job_category instance-attribute

job_category: NotRequired[JobCategory]

The category of jobs to list.

last_modified_time_after instance-attribute

last_modified_time_after: NotRequired[Timestamp]

A filter that returns only jobs modified after the specified time.

last_modified_time_before instance-attribute

last_modified_time_before: NotRequired[Timestamp]

A filter that returns only jobs modified before the specified time.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of jobs to return in the response. The default value is 50.

name_contains instance-attribute

name_contains: NotRequired[NameContains]

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the previous response was truncated, this token retrieves the next set of results.

sort_by instance-attribute

sort_by: NotRequired[SortBy]

The field to sort results by.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order for results. Valid values are Ascending and Descending.

status_equals instance-attribute

status_equals: NotRequired[JobStatus]

A filter that returns only jobs with the specified status.