Lightsail / Client / get_container_images

get_container_images#

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.

Request Syntax

response = client.get_container_images(
    serviceName='string'
)

Parameters:

serviceName (string) –

[REQUIRED]

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

Return type:

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

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.UnauthenticatedException