SageMaker / Paginator / ListJobs

ListJobs

class SageMaker.Paginator.ListJobs
paginator = client.get_paginator('list_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    JobCategory='AgentRFT'|'AgentRFTEvaluation',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    StatusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • JobCategory (string) –

    [REQUIRED]

    The category of jobs to list.

  • CreationTimeAfter (datetime) – A filter that returns only jobs created after the specified time.

  • CreationTimeBefore (datetime) – A filter that returns only jobs created before the specified time.

  • LastModifiedTimeAfter (datetime) – A filter that returns only jobs modified after the specified time.

  • LastModifiedTimeBefore (datetime) – A filter that returns only jobs modified before the specified time.

  • NameContains (string) – A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

  • SortBy (string) – The field to sort results by.

  • SortOrder (string) – The sort order for results. Valid values are Ascending and Descending.

  • StatusEquals (string) – A filter that returns only jobs with the specified status.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'JobSummaries': [
        {
            'JobArn': 'string',
            'JobName': 'string',
            'JobCategory': 'AgentRFT'|'AgentRFTEvaluation',
            'JobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting'|'DeleteFailed',
            'JobSecondaryStatus': 'Starting'|'Downloading'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Interrupted'|'Failed'|'Completed'|'Restarting'|'Pending'|'Evaluating'|'Deleting'|'DeleteFailed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • JobSummaries (list) –

      An array of JobSummary objects that provide summary information about the jobs.

      • (dict) –

        Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job.

        • JobArn (string) –

          The Amazon Resource Name (ARN) of the job.

        • JobName (string) –

          The name of the job.

        • JobCategory (string) –

          The category of the job.

        • JobStatus (string) –

          The current status of the job.

        • JobSecondaryStatus (string) –

          The secondary status of the job, providing more granular information about the job’s progress. Secondary statuses may change between releases.

        • CreationTime (datetime) –

          The date and time that the job was created.

        • LastModifiedTime (datetime) –

          The date and time that the job was last modified.

        • EndTime (datetime) –

          The date and time that the job ended.