:doc:`SageMaker <../../sagemaker>` / Client / list_inference_recommendations_jobs

***********************************
list_inference_recommendations_jobs
***********************************



.. py:method:: SageMaker.Client.list_inference_recommendations_jobs(**kwargs)

  

  Lists recommendation jobs that satisfy various filters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListInferenceRecommendationsJobs>`_  


  **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'|'DELETING'|'DELETED',
        SortBy='Name'|'CreationTime'|'Status',
        SortOrder='Ascending'|'Descending',
        NextToken='string',
        MaxResults=123,
        ModelNameEquals='string',
        ModelPackageVersionArnEquals='string'
    )
    
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

    A filter that returns only jobs created after the specified time (timestamp).

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

    A filter that returns only jobs created before the specified time (timestamp).

    

  
  :type LastModifiedTimeAfter: datetime
  :param LastModifiedTimeAfter: 

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

    

  
  :type LastModifiedTimeBefore: datetime
  :param LastModifiedTimeBefore: 

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

    

  
  :type NameContains: string
  :param NameContains: 

    A string in the job name. This filter returns only recommendations whose name contains the specified string.

    

  
  :type StatusEquals: string
  :param StatusEquals: 

    A filter that retrieves only inference recommendations jobs with a specific status.

    

  
  :type SortBy: string
  :param SortBy: 

    The parameter by which to sort the results.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order for the results.

    

  
  :type NextToken: string
  :param NextToken: 

    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.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of recommendations to return in the response.

    

  
  :type ModelNameEquals: string
  :param ModelNameEquals: 

    A filter that returns only jobs that were created for this model.

    

  
  :type ModelPackageVersionArnEquals: string
  :param ModelPackageVersionArnEquals: 

    A filter that returns only jobs that were created for this versioned model package.

    

  
  
  :rtype: 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'
              },
          ],
          '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.

            
          

          - **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.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  