SageMaker / Client / list_inference_recommendations_jobs

list_inference_recommendations_jobs#

SageMaker.Client.list_inference_recommendations_jobs(**kwargs)#

Lists recommendation jobs that satisfy various filters.

See also: AWS API Documentation

Request Syntax

response = client.list_inference_recommendations_jobs(
    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',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
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.

  • NextToken (string) – If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

  • MaxResults (integer) – The maximum number of recommendations to return in the 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',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'RoleArn': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'FailureReason': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A token for getting the next set of recommendations, if there are any.