SageMaker / Paginator / ListInferenceRecommendationsJobs

ListInferenceRecommendationsJobs

class SageMaker.Paginator.ListInferenceRecommendationsJobs

paginator = client.get_paginator('list_inference_recommendations_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_inference_recommendations_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='PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING'|'DELETED',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    ModelNameEquals='string',
    ModelPackageVersionArnEquals='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

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

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

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

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

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

• SortBy (string) – The parameter by which to sort the results.

• SortOrder (string) – The sort order for the results.

• ModelNameEquals (string) – A filter that returns only jobs that were created for this model.

• ModelPackageVersionArnEquals (string) – A filter that returns only jobs that were created for this versioned model package.

• 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

{
    'InferenceRecommendationsJobs': [
        {
            'JobName': 'string',
            'JobDescription': 'string',
            'JobType': 'Default'|'Advanced',
            'JobArn': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING'|'DELETED',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'RoleArn': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'FailureReason': 'string',
            'ModelName': 'string',
            'SamplePayloadUrl': 'string',
            'ModelPackageVersionArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • InferenceRecommendationsJobs (list) –

    The recommendations created from the Amazon SageMaker Inference Recommender job.

    • (dict) –

      A structure that contains a list of recommendation jobs.

      • JobName (string) –

        The name of the job.

      • JobDescription (string) –

        The job description.

      • JobType (string) –

        The recommendation job type.

      • JobArn (string) –

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

      • Status (string) –

        The status of the job.

      • CreationTime (datetime) –

        A timestamp that shows when the job was created.

      • CompletionTime (datetime) –

        A timestamp that shows when the job completed.

      • RoleArn (string) –

        The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

      • LastModifiedTime (datetime) –

        A timestamp that shows when the job was last modified.

      • FailureReason (string) –

        If the job fails, provides information why the job failed.

      • ModelName (string) –

        The name of the created model.

      • SamplePayloadUrl (string) –

        The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

      • ModelPackageVersionArn (string) –

        The Amazon Resource Name (ARN) of a versioned model package.