SageMaker / Paginator / ListProcessingJobs

ListProcessingJobs#

class SageMaker.Paginator.ListProcessingJobs#
paginator = client.get_paginator('list_processing_jobs')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

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

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

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

  • NameContains (string) – A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

  • StatusEquals (string) – A filter that retrieves only processing jobs with a specific status.

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

  • SortOrder (string) – The sort order for results. The default is Ascending.

  • 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

{
    'ProcessingJobSummaries': [
        {
            'ProcessingJobName': 'string',
            'ProcessingJobArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'ProcessingEndTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ProcessingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'FailureReason': 'string',
            'ExitMessage': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • ProcessingJobSummaries (list) –

      An array of ProcessingJobSummary objects, each listing a processing job.

      • (dict) –

        Summary of information about a processing job.

        • ProcessingJobName (string) –

          The name of the processing job.

        • ProcessingJobArn (string) –

          The Amazon Resource Name (ARN) of the processing job..

        • CreationTime (datetime) –

          The time at which the processing job was created.

        • ProcessingEndTime (datetime) –

          The time at which the processing job completed.

        • LastModifiedTime (datetime) –

          A timestamp that indicates the last time the processing job was modified.

        • ProcessingJobStatus (string) –

          The status of the processing job.

        • FailureReason (string) –

          A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

        • ExitMessage (string) –

          An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.