delete_hsm `async` ¶

delete_hsm(
    hsm_arn: HsmArn, *, config_overrides: Optional[AsyncCloudHSMClientConfig] = None
) -> DeleteHsmResponse

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Parameters:

hsm_arn (HsmArn) –

The ARN of the HSM to delete.

Raises:

CloudHsmInternalException –

Indicates that an internal error occurred.
CloudHsmServiceException –

Indicates that an exception occurred in the AWS CloudHSM service.
InvalidRequestException –

Indicates that one or more of the request parameters are not valid.
UnknownServiceError –

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

Source code in docs_src/capo_cloudhsm/_services/async_cloud_hsm.py

async def delete_hsm(
    self,
    hsm_arn: "capo_cloudhsm.types.hsm_arn.HsmArn",
    *,
    config_overrides: Optional[AsyncCloudHSMClientConfig] = None,
) -> "capo_cloudhsm.types.delete_hsm_response.DeleteHsmResponse":
    """<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href="http://aws.amazon.com/cloudhsm/faqs-classic/">AWS CloudHSM Classic FAQs</a>, the <a href="https://docs.aws.amazon.com/cloudhsm/classic/userguide/">AWS CloudHSM Classic User Guide</a>, and the <a href="https://docs.aws.amazon.com/cloudhsm/classic/APIReference/">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href="http://aws.amazon.com/cloudhsm/">AWS CloudHSM</a>, the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/">AWS CloudHSM User Guide</a>, and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/">AWS CloudHSM API Reference</a>.</p> <p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>

    Args:
        hsm_arn: <p>The ARN of the HSM to delete.</p>

    Raises:
        capo_cloudhsm.errors.cloud_hsm_internal_exception.CloudHsmInternalException: <p>Indicates that an internal error occurred.</p>
        capo_cloudhsm.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>Indicates that an exception occurred in the AWS CloudHSM service.</p>
        capo_cloudhsm.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that one or more of the request parameters are not valid.</p>
        capo_cloudhsm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudhsm.types.delete_hsm_request.DeleteHsmRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudhsm.types.delete_hsm_response.DeleteHsmResponse"
    ]:
        import capo_cloudhsm._operations.cloud_hsm_frontend_service.delete_hsm

        (
            output,
            http_response,
        ) = await capo_cloudhsm._operations.cloud_hsm_frontend_service.delete_hsm.async_delete_hsm(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteHsm")
    )
    input_: capo_cloudhsm.types.delete_hsm_request.DeleteHsmRequest = {
        "hsm_arn": hsm_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_hsm async ¶

delete_hsm `async` ¶