CloudHSM / Client / delete_hsm

delete_hsm#

CloudHSM.Client.delete_hsm(**kwargs)#

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.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.delete_hsm(
    HsmArn='string'
)
Parameters:

HsmArn (string) –

[REQUIRED]

The ARN of the HSM to delete.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'string'
}

Response Structure

  • (dict) –

    Contains the output of the DeleteHsm operation.

    • Status (string) –

      The status of the operation.

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException