delete_certificate ¶

delete_certificate(
    certificate_id: CertificateId,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    force_delete: Optional[ForceDelete] = None,
) -> None

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.

Requires permission to access the DeleteCertificate action.

Parameters:

certificate_id (CertificateId) –

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
force_delete (Optional[ForceDelete], default: None ) –

Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

Raises:

CertificateStateException –

The certificate operation is not allowed.
DeleteConflictException –

You can't delete the resource because it is attached to one or more resources.
InternalFailureException –

An unexpected error has occurred.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

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

Source code in docs_src/capo_iot/_services/io_t.py

def delete_certificate(
    self,
    certificate_id: "capo_iot.types.certificate_id.CertificateId",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    force_delete: Optional["capo_iot.types.force_delete.ForceDelete"] = None,
) -> None:
    """<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPolicy</a> action to detach all policies. Next, use the <a>UpdateCertificate</a> action to set the certificate to the INACTIVE status.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteCertificate</a> action.</p>

    Args:
        certificate_id: <p>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</p>
        force_delete: <p>Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.</p>

    Raises:
        capo_iot.errors.certificate_state_exception.CertificateStateException: <p>The certificate operation is not allowed.</p>
        capo_iot.errors.delete_conflict_exception.DeleteConflictException: <p>You can't delete the resource because it is attached to one or more resources.</p>
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.delete_certificate_request.DeleteCertificateRequest]",
    ) -> OperationResponse[None]:
        import capo_iot._operations.aws_iot_service.delete_certificate

        output, http_response = (
            capo_iot._operations.aws_iot_service.delete_certificate.delete_certificate(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCertificate")
    )
    input_: capo_iot.types.delete_certificate_request.DeleteCertificateRequest = {
        "certificate_id": certificate_id
    }
    if force_delete is not None:
        input_["force_delete"] = force_delete

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