Skip to content

CloudFront  >  Operations  >  delete_distribution

delete_distribution

Operation

delete_distribution async 

delete_distribution(input: DeleteDistributionInput, plugins: list[Plugin] | None = None) -> DeleteDistributionOutput

Delete a distribution.

Warning

Before you can delete a distribution, you must disable it, which requires permission to update the distribution. Once deleted, a distribution cannot be recovered.

Parameters:

Name Type Description Default
input DeleteDistributionInput

An instance of DeleteDistributionInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteDistributionOutput

An instance of DeleteDistributionOutput.

Input

DeleteDistributionInput dataclass

Bases: _SerdeShape

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

Attributes

id class-attribute instance-attribute 
id: str | None = ...

The distribution ID.

if_match class-attribute instance-attribute 
if_match: str | None = ...

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

Output

DeleteDistributionOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDistributionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.