:doc:`Lightsail <../../lightsail>` / Client / get_container_images

********************
get_container_images
********************



.. py:method:: Lightsail.Client.get_container_images(**kwargs)

  

  Returns the container images that are registered to your Amazon Lightsail container service.

   

  .. note::

    

    If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContainerImages>`_  


  **Request Syntax**
  ::

    response = client.get_container_images(
        serviceName='string'
    )
    
  :type serviceName: string
  :param serviceName: **[REQUIRED]** 

    The name of the container service for which to return registered container images.

    

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

    
    ::

      {
          'containerImages': [
              {
                  'image': 'string',
                  'digest': 'string',
                  'createdAt': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **containerImages** *(list) --* 

        An array of objects that describe container images that are registered to the container service.

        
        

        - *(dict) --* 

          Describes a container image that is registered to an Amazon Lightsail container service.

          
          

          - **image** *(string) --* 

            The name of the container image.

            
          

          - **digest** *(string) --* 

            The digest of the container image.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp when the container image was created.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  