Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14208070.3 KB

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.

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

post/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm

Headers

X-Amz-Target'CloudHsmFrontendService.DescribeHsm' required

Request body

HsmArnstring

The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.

HsmSerialNumberstring

The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.

Response

Success

HsmArnstring

The ARN of the HSM.

Status'PENDING' | 'RUNNING' | 'UPDATING' | 'SUSPENDED' | 'TERMINATING' | 'TERMINATED' | 'DEGRADED'

The status of the HSM.

StatusDetailsstring

Contains additional information about the status of the HSM.

AvailabilityZonestring

The Availability Zone that the HSM is in.

EniIdstring

The identifier of the elastic network interface (ENI) attached to the HSM.

EniIpstring

The IP address assigned to the HSM's ENI.

SubscriptionType'PRODUCTION'
<p>Specifies the type of subscription for the HSM.</p> <ul> <li> <p> <b>PRODUCTION</b> - The HSM is being used in a production environment.</p> </li> <li> <p> <b>TRIAL</b> - The HSM is being used in a product trial.</p> </li> </ul>
SubscriptionStartDatestring

The subscription start date.

SubscriptionEndDatestring

The subscription end date.

VpcIdstring

The identifier of the VPC that the HSM is in.

SubnetIdstring

The identifier of the subnet that the HSM is in.

IamRoleArnstring

The ARN of the IAM role assigned to the HSM.

SerialNumberstring

The serial number of the HSM.

VendorNamestring

The name of the HSM vendor.

HsmTypestring

The HSM model type.

SoftwareVersionstring

The HSM software version.

SshPublicKeystring

The public SSH key.

SshKeyLastUpdatedstring

The date and time that the SSH key was last updated.

ServerCertUristring

The URI of the certificate server.

ServerCertLastUpdatedstring

The date and time that the server certificate was last updated.

PartitionsPartitionArn[]

The list of partitions on the HSM.