SageMaker / Paginator / ListTransformJobs

ListTransformJobs

class SageMaker.Paginator.ListTransformJobs

paginator = client.get_paginator('list_transform_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_transform_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 transform jobs created after the specified time.

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

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

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

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

• StatusEquals (string) – A filter that retrieves only transform 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 Descending.

• 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

{
    'TransformJobSummaries': [
        {
            'TransformJobName': 'string',
            'TransformJobArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'TransformEndTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'TransformJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'FailureReason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • TransformJobSummaries (list) –

    An array of TransformJobSummary objects.

    • (dict) –

      Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

      • TransformJobName (string) –

        The name of the transform job.

      • TransformJobArn (string) –

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

      • CreationTime (datetime) –

        A timestamp that shows when the transform Job was created.

      • TransformEndTime (datetime) –

        Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

      • LastModifiedTime (datetime) –

        Indicates when the transform job was last modified.

      • TransformJobStatus (string) –

        The status of the transform job.

      • FailureReason (string) –

        If the transform job failed, the reason it failed.