delete_distribution ¶

delete_distribution(
    id: string,
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    if_match: Optional[string] = None,
) -> None

Delete a distribution.

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:

id (string) –

The distribution ID.
if_match (Optional[string], default: None ) –

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

Raises:

AccessDenied –

Access denied.
DistributionNotDisabled –

The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
InvalidIfMatchVersion –

The If-Match version is missing or not valid.
NoSuchDistribution –

The specified distribution does not exist.
PreconditionFailed –

The precondition in one or more of the request fields evaluated to false.
ResourceInUse –

Cannot delete this resource because it is in use.
UnknownServiceError –

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

Source code in docs_src/capo_cloudfront/_services/cloud_front.py

def delete_distribution(
    self,
    id: "capo_cloudfront.types.string.string",
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    if_match: Optional["capo_cloudfront.types.string.string"] = None,
) -> None:
    """<p>Delete a distribution.</p> <important> <p>Before you can delete a distribution, you must disable it, which requires permission to update the distribution. Once deleted, a distribution cannot be recovered.</p> </important>

    Args:
        id: <p>The distribution ID.</p>
        if_match: <p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
        capo_cloudfront.errors.distribution_not_disabled.DistributionNotDisabled: <p>The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.</p>
        capo_cloudfront.errors.invalid_if_match_version.InvalidIfMatchVersion: <p>The <code>If-Match</code> version is missing or not valid.</p>
        capo_cloudfront.errors.no_such_distribution.NoSuchDistribution: <p>The specified distribution does not exist.</p>
        capo_cloudfront.errors.precondition_failed.PreconditionFailed: <p>The precondition in one or more of the request fields evaluated to <code>false</code>.</p>
        capo_cloudfront.errors.resource_in_use.ResourceInUse: <p>Cannot delete this resource because it is in use.</p>
        capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront.types.delete_distribution_request.DeleteDistributionRequest]",
    ) -> OperationResponse[None]:
        import capo_cloudfront._operations.cloudfront2020_05_31.delete_distribution

        output, http_response = (
            capo_cloudfront._operations.cloudfront2020_05_31.delete_distribution.delete_distribution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDistribution")
    )
    input_: capo_cloudfront.types.delete_distribution_request.DeleteDistributionRequest = {
        "id": id
    }
    if if_match is not None:
        input_["if_match"] = if_match

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