delete_container_recipe ¶

delete_container_recipe(
    container_recipe_arn: ContainerRecipeArn,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> DeleteContainerRecipeResponse

Deletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references it.

Parameters:

container_recipe_arn (ContainerRecipeArn) –

The Amazon Resource Name (ARN) of the container recipe to delete.

Raises:

CallRateLimitExceededException –

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
ClientException –

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
ForbiddenException –

You are not authorized to perform the requested operation.
InvalidRequestException –

The request is malformed or otherwise invalid. Verify the request and try again.
ResourceDependencyException –

You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
ServiceException –

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
ServiceUnavailableException –

The service is unable to process your request at this time.
UnknownServiceError –

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

Examples:

Delete a container recipe The following example deletes the specified container recipe.

>>> client.delete_container_recipe(container_recipe_arn='arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0')

Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py

def delete_container_recipe(
    self,
    container_recipe_arn: "capo_imagebuilder.types.container_recipe_arn.ContainerRecipeArn",
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.delete_container_recipe_response.DeleteContainerRecipeResponse":
    """<p>Deletes a container recipe. The request fails with <code>ResourceDependencyException</code> if the recipe is shared with other accounts, or if an image pipeline references it.</p>

    Args:
        container_recipe_arn: <p>The Amazon Resource Name (ARN) of the container recipe to delete.</p>

    Raises:
        capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
        capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
        capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
        capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
        capo_imagebuilder.errors.resource_dependency_exception.ResourceDependencyException: <p>You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Delete a container recipe
        The following example deletes the specified container recipe.

        >>> client.delete_container_recipe(container_recipe_arn='arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.delete_container_recipe_request.DeleteContainerRecipeRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.delete_container_recipe_response.DeleteContainerRecipeResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.delete_container_recipe

        output, http_response = (
            capo_imagebuilder._operations.imagebuilder.delete_container_recipe.delete_container_recipe(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteContainerRecipe")
    )
    input_: capo_imagebuilder.types.delete_container_recipe_request.DeleteContainerRecipeRequest = {
        "container_recipe_arn": container_recipe_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output