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

**************************
list_inference_experiments
**************************



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

  

  Returns the list of all inference experiments.

  

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


  **Request Syntax**
  ::

    response = client.list_inference_experiments(
        NameContains='string',
        Type='ShadowMode',
        StatusEquals='Creating'|'Created'|'Updating'|'Running'|'Starting'|'Stopping'|'Completed'|'Cancelled',
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        LastModifiedTimeAfter=datetime(2015, 1, 1),
        LastModifiedTimeBefore=datetime(2015, 1, 1),
        SortBy='Name'|'CreationTime'|'Status',
        SortOrder='Ascending'|'Descending',
        NextToken='string',
        MaxResults=123
    )
    
  :type NameContains: string
  :param NameContains: 

    Selects inference experiments whose names contain this name.

    

  
  :type Type: string
  :param Type: 

    Selects inference experiments of this type. For the possible types of inference experiments, see `CreateInferenceExperiment <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html>`__.

    

  
  :type StatusEquals: string
  :param StatusEquals: 

    Selects inference experiments which are in this status. For the possible statuses, see `DescribeInferenceExperiment <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html>`__.

    

  
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

    Selects inference experiments which were created after this timestamp.

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

    Selects inference experiments which were created before this timestamp.

    

  
  :type LastModifiedTimeAfter: datetime
  :param LastModifiedTimeAfter: 

    Selects inference experiments which were last modified after this timestamp.

    

  
  :type LastModifiedTimeBefore: datetime
  :param LastModifiedTimeBefore: 

    Selects inference experiments which were last modified before this timestamp.

    

  
  :type SortBy: string
  :param SortBy: 

    The column by which to sort the listed inference experiments.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The direction of sorting (ascending or descending).

    

  
  :type NextToken: string
  :param NextToken: 

    The response from the last list when returning a list large enough to need tokening.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to select.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'InferenceExperiments': [
              {
                  'Name': 'string',
                  'Type': 'ShadowMode',
                  'Schedule': {
                      'StartTime': datetime(2015, 1, 1),
                      'EndTime': datetime(2015, 1, 1)
                  },
                  'Status': 'Creating'|'Created'|'Updating'|'Running'|'Starting'|'Stopping'|'Completed'|'Cancelled',
                  'StatusReason': 'string',
                  'Description': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'CompletionTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'RoleArn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **InferenceExperiments** *(list) --* 

        List of inference experiments.

        
        

        - *(dict) --* 

          Lists a summary of properties of an inference experiment.

          
          

          - **Name** *(string) --* 

            The name of the inference experiment.

            
          

          - **Type** *(string) --* 

            The type of the inference experiment.

            
          

          - **Schedule** *(dict) --* 

            The duration for which the inference experiment ran or will run.

             

            The maximum duration that you can set for an inference experiment is 30 days.

            
            

            - **StartTime** *(datetime) --* 

              The timestamp at which the inference experiment started or will start.

              
            

            - **EndTime** *(datetime) --* 

              The timestamp at which the inference experiment ended or will end.

              
        
          

          - **Status** *(string) --* 

            The status of the inference experiment.

            
          

          - **StatusReason** *(string) --* 

            The error message for the inference experiment status result.

            
          

          - **Description** *(string) --* 

            The description of the inference experiment.

            
          

          - **CreationTime** *(datetime) --* 

            The timestamp at which the inference experiment was created.

            
          

          - **CompletionTime** *(datetime) --* 

            The timestamp at which the inference experiment was completed.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when you last modified the inference experiment.

            
          

          - **RoleArn** *(string) --* 

            The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

            
      
    
      

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

        The token to use when calling the next page of results.

        
  