delete_public_key ¶

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

Remove a public key you previously added to CloudFront.

Parameters:

id (string) –

The ID of the public key you want to remove from CloudFront.
if_match (Optional[string], default: None ) –

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

Raises:

AccessDenied –

Access denied.
InvalidIfMatchVersion –

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

The specified public key doesn't exist.
PreconditionFailed –

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

The specified public key 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_public_key(
    self,
    id: "capo_cloudfront.types.string.string",
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    if_match: Optional["capo_cloudfront.types.string.string"] = None,
) -> None:
    """<p>Remove a public key you previously added to CloudFront.</p>

    Args:
        id: <p>The ID of the public key you want to remove from CloudFront.</p>
        if_match: <p>The value of the <code>ETag</code> header that you received when retrieving the public key identity to delete. For example: <code>E2QWRUHAPOMQZL</code>.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</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_public_key.NoSuchPublicKey: <p>The specified public key doesn't 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.public_key_in_use.PublicKeyInUse: <p>The specified public key 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_public_key_request.DeletePublicKeyRequest]",
    ) -> OperationResponse[None]:
        import capo_cloudfront._operations.cloudfront2020_05_31.delete_public_key

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePublicKey")
    )
    input_: capo_cloudfront.types.delete_public_key_request.DeletePublicKeyRequest = {
        "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