SageMaker / Paginator / ListEdgePackagingJobs

ListEdgePackagingJobs#

class SageMaker.Paginator.ListEdgePackagingJobs#
paginator = client.get_paginator('list_edge_packaging_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SageMaker.Client.list_edge_packaging_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',
    ModelNameContains='string',
    StatusEquals='STARTING'|'INPROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED',
    SortBy='NAME'|'MODEL_NAME'|'CREATION_TIME'|'LAST_MODIFIED_TIME'|'STATUS',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • CreationTimeAfter (datetime) – Select jobs where the job was created after specified time.

  • CreationTimeBefore (datetime) – Select jobs where the job was created before specified time.

  • LastModifiedTimeAfter (datetime) – Select jobs where the job was updated after specified time.

  • LastModifiedTimeBefore (datetime) – Select jobs where the job was updated before specified time.

  • NameContains (string) – Filter for jobs containing this name in their packaging job name.

  • ModelNameContains (string) – Filter for jobs where the model name contains this string.

  • StatusEquals (string) – The job status to filter for.

  • SortBy (string) – Use to specify what column to sort by.

  • SortOrder (string) – What direction to sort by.

  • 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

{
    'EdgePackagingJobSummaries': [
        {
            'EdgePackagingJobArn': 'string',
            'EdgePackagingJobName': 'string',
            'EdgePackagingJobStatus': 'STARTING'|'INPROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED',
            'CompilationJobName': 'string',
            'ModelName': 'string',
            'ModelVersion': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • EdgePackagingJobSummaries (list) –

      Summaries of edge packaging jobs.

      • (dict) –

        Summary of edge packaging job.

        • EdgePackagingJobArn (string) –

          The Amazon Resource Name (ARN) of the edge packaging job.

        • EdgePackagingJobName (string) –

          The name of the edge packaging job.

        • EdgePackagingJobStatus (string) –

          The status of the edge packaging job.

        • CompilationJobName (string) –

          The name of the SageMaker Neo compilation job.

        • ModelName (string) –

          The name of the model.

        • ModelVersion (string) –

          The version of the model.

        • CreationTime (datetime) –

          The timestamp of when the job was created.

        • LastModifiedTime (datetime) –

          The timestamp of when the edge packaging job was last updated.