CloudHSMV2 / Client / delete_hsm

delete_hsm#

CloudHSMV2.Client.delete_hsm(**kwargs)#

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM’s elastic network interface (ENI), or the ID of the HSM’s ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.delete_hsm(
    ClusterId='string',
    HsmId='string',
    EniId='string',
    EniIp='string'
)
Parameters:

  • ClusterId (string) –

    [REQUIRED]

    The identifier (ID) of the cluster that contains the HSM that you are deleting.

  • HsmId (string) – The identifier (ID) of the HSM that you are deleting.

  • EniId (string) – The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

  • EniIp (string) – The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

Return type:

dict

Returns:

Response Syntax

{
    'HsmId': 'string'
}

Response Structure

  • (dict) –

    • HsmId (string) –

      The identifier (ID) of the HSM that was deleted.

Exceptions

  • CloudHSMV2.Client.exceptions.CloudHsmInternalFailureException

  • CloudHSMV2.Client.exceptions.CloudHsmServiceException

  • CloudHSMV2.Client.exceptions.CloudHsmResourceNotFoundException

  • CloudHSMV2.Client.exceptions.CloudHsmInvalidRequestException

  • CloudHSMV2.Client.exceptions.CloudHsmAccessDeniedException