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

***********
list_images
***********



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

  

  Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

  

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


  **Request Syntax**
  ::

    response = client.list_images(
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        LastModifiedTimeAfter=datetime(2015, 1, 1),
        LastModifiedTimeBefore=datetime(2015, 1, 1),
        MaxResults=123,
        NameContains='string',
        NextToken='string',
        SortBy='CREATION_TIME'|'LAST_MODIFIED_TIME'|'IMAGE_NAME',
        SortOrder='ASCENDING'|'DESCENDING'
    )
    
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

    A filter that returns only images created on or after the specified time.

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

    A filter that returns only images created on or before the specified time.

    

  
  :type LastModifiedTimeAfter: datetime
  :param LastModifiedTimeAfter: 

    A filter that returns only images modified on or after the specified time.

    

  
  :type LastModifiedTimeBefore: datetime
  :param LastModifiedTimeBefore: 

    A filter that returns only images modified on or before the specified time.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of images to return in the response. The default value is 10.

    

  
  :type NameContains: string
  :param NameContains: 

    A filter that returns only images whose name contains the specified string.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous call to ``ListImages`` didn't return the full set of images, the call returns a token for getting the next set of images.

    

  
  :type SortBy: string
  :param SortBy: 

    The property used to sort results. The default value is ``CREATION_TIME``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order. The default value is ``DESCENDING``.

    

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

    
    ::

      {
          'Images': [
              {
                  'CreationTime': datetime(2015, 1, 1),
                  'Description': 'string',
                  'DisplayName': 'string',
                  'FailureReason': 'string',
                  'ImageArn': 'string',
                  'ImageName': 'string',
                  'ImageStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
                  'LastModifiedTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Images** *(list) --* 

        A list of images and their properties.

        
        

        - *(dict) --* 

          A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ``ImageVersion``.

          
          

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

            When the image was created.

            
          

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

            The description of the image.

            
          

          - **DisplayName** *(string) --* 

            The name of the image as displayed.

            
          

          - **FailureReason** *(string) --* 

            When a create, update, or delete operation fails, the reason for the failure.

            
          

          - **ImageArn** *(string) --* 

            The ARN of the image.

            
          

          - **ImageName** *(string) --* 

            The name of the image.

            
          

          - **ImageStatus** *(string) --* 

            The status of the image.

            
          

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

            When the image was last modified.

            
      
    
      

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

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

        
  