delete_container_image `async` ¶

delete_container_image(
    service_name: ContainerServiceName,
    image: string,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> DeleteContainerImageResult

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

Parameters:

service_name (ContainerServiceName) –

The name of the container service for which to delete a registered container image.
image (string) –

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.

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.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def delete_container_image(
    self,
    service_name: "capo_lightsail.types.container_service_name.ContainerServiceName",
    image: "capo_lightsail.types.string.string",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> (
    "capo_lightsail.types.delete_container_image_result.DeleteContainerImageResult"
):
    """<p>Deletes a container image that is registered to your Amazon Lightsail container service.</p>

    Args:
        service_name: <p>The name of the container service for which to delete a registered container image.</p>
        image: <p>The name of the container image to delete from the container service.</p> <p>Use the <code>GetContainerImages</code> action to get the name of the container images that are registered to a container service.</p> <note> <p>Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (<code>:</code>). For example, <code>:container-service-1.mystaticwebsite.1</code>. Container images sourced from a public registry like Docker Hub don't start with a colon. For example, <code>nginx:latest</code> or <code>nginx</code>.</p> </note>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.delete_container_image_request.DeleteContainerImageRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.delete_container_image_result.DeleteContainerImageResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.delete_container_image

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.delete_container_image.async_delete_container_image(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteContainerImage")
    )
    input_: capo_lightsail.types.delete_container_image_request.DeleteContainerImageRequest = {
        "service_name": service_name,
        "image": image,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_container_image async ¶

delete_container_image `async` ¶