SageMaker / Client / list_ai_recommendation_jobs

list_ai_recommendation_jobs

SageMaker.Client.list_ai_recommendation_jobs(**kwargs)

Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

See also: AWS API Documentation

Request Syntax

response = client.list_ai_recommendation_jobs(
    MaxResults=123,
    NextToken='string',
    NameContains='string',
    StatusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending'
)
Parameters:

  • MaxResults (integer) – The maximum number of recommendation jobs to return in the response.

  • NextToken (string) – If the previous call to ListAIRecommendationJobs didn’t return the full set of jobs, the call returns a token for getting the next set.

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

  • StatusEquals (string) – A filter that returns only recommendation jobs with the specified status.

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

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

  • SortBy (string) – The field to sort results by. The default is CreationTime.

  • SortOrder (string) – The sort order for results. The default is Descending.

Return type:

dict

Returns:

Response Syntax

{
    'AIRecommendationJobs': [
        {
            'AIRecommendationJobName': 'string',
            'AIRecommendationJobArn': 'string',
            'AIRecommendationJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'CreationTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AIRecommendationJobs (list) –

      An array of AIRecommendationJobSummary objects, one for each recommendation job that matches the specified filters.

      • (dict) –

        Summary information about an AI recommendation job.

        • AIRecommendationJobName (string) –

          The name of the recommendation job.

        • AIRecommendationJobArn (string) –

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

        • AIRecommendationJobStatus (string) –

          The status of the recommendation job.

        • CreationTime (datetime) –

          A timestamp that indicates when the recommendation job was created.

        • EndTime (datetime) –

          A timestamp that indicates when the recommendation job completed.

    • NextToken (string) –

      If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.