Lightsail / Client / delete_container_image

delete_container_image#

Lightsail.Client.delete_container_image(**kwargs)#

Deletes a container image that is registered to your Amazon Lightsail container service.

See also: AWS API Documentation

Request Syntax

response = client.delete_container_image(
    serviceName='string',
    image='string'
)
Parameters:
  • serviceName (string) –

    [REQUIRED]

    The name of the container service for which to delete a registered container image.

  • image (string) –

    [REQUIRED]

    The name of the container image to delete from the container service.

    Use the GetContainerImages action to get the name of the container images that are registered to a container service.

    Note

    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( :). For example, :container-service-1.mystaticwebsite.1. Container images sourced from a public registry like Docker Hub don’t start with a colon. For example, nginx:latest or nginx.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Lightsail.Client.exceptions.ServiceException

  • Lightsail.Client.exceptions.InvalidInputException

  • Lightsail.Client.exceptions.NotFoundException

  • Lightsail.Client.exceptions.AccessDeniedException

  • Lightsail.Client.exceptions.UnauthenticatedException