SageMaker / Paginator / ListOptimizationJobs

ListOptimizationJobs#

class SageMaker.Paginator.ListOptimizationJobs#
paginator = client.get_paginator('list_optimization_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SageMaker.Client.list_optimization_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),
    OptimizationContains='string',
    NameContains='string',
    StatusEquals='INPROGRESS'|'COMPLETED'|'FAILED'|'STARTING'|'STOPPING'|'STOPPED',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • CreationTimeAfter (datetime) – Filters the results to only those optimization jobs that were created after the specified time.

  • CreationTimeBefore (datetime) – Filters the results to only those optimization jobs that were created before the specified time.

  • LastModifiedTimeAfter (datetime) – Filters the results to only those optimization jobs that were updated after the specified time.

  • LastModifiedTimeBefore (datetime) – Filters the results to only those optimization jobs that were updated before the specified time.

  • OptimizationContains (string) – Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.

  • NameContains (string) – Filters the results to only those optimization jobs with a name that contains the specified string.

  • StatusEquals (string) – Filters the results to only those optimization jobs with the specified status.

  • SortBy (string) – The field by which to sort the optimization jobs in the response. 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

{
    'OptimizationJobSummaries': [
        {
            'OptimizationJobName': 'string',
            'OptimizationJobArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'OptimizationJobStatus': 'INPROGRESS'|'COMPLETED'|'FAILED'|'STARTING'|'STOPPING'|'STOPPED',
            'OptimizationStartTime': datetime(2015, 1, 1),
            'OptimizationEndTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'DeploymentInstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.inf2.xlarge'|'ml.inf2.8xlarge'|'ml.inf2.24xlarge'|'ml.inf2.48xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
            'OptimizationTypes': [
                'string',
            ]
        },
    ],

}

Response Structure

  • (dict) –

    • OptimizationJobSummaries (list) –

      A list of optimization jobs and their properties that matches any of the filters you specified in the request.

      • (dict) –

        Summarizes an optimization job by providing some of its key properties.

        • OptimizationJobName (string) –

          The name that you assigned to the optimization job.

        • OptimizationJobArn (string) –

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

        • CreationTime (datetime) –

          The time when you created the optimization job.

        • OptimizationJobStatus (string) –

          The current status of the optimization job.

        • OptimizationStartTime (datetime) –

          The time when the optimization job started.

        • OptimizationEndTime (datetime) –

          The time when the optimization job finished processing.

        • LastModifiedTime (datetime) –

          The time when the optimization job was last updated.

        • DeploymentInstanceType (string) –

          The type of instance that hosts the optimized model that you create with the optimization job.

        • OptimizationTypes (list) –

          The optimization techniques that are applied by the optimization job.

          • (string) –