DescribeHsm
This is documentation for AWS CloudHSM Classic. For
more information, see AWS CloudHSM
Classic FAQs
For information about the current version of AWS
CloudHSM, see AWS CloudHSM
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
Request Syntax
{
"HsmArn": "string",
"HsmSerialNumber": "string"
}Request Parameters
The request accepts the following data in JSON format.
- HsmArn
-
The ARN of the HSM. Either the
HsmArnor theSerialNumberparameter must be specified.Type: String
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}Required: No
- HsmSerialNumber
-
The serial number of the HSM. Either the
HsmArnor theHsmSerialNumberparameter must be specified.Type: String
Pattern:
\d{1,16}Required: No
Response Syntax
{
"AvailabilityZone": "string",
"EniId": "string",
"EniIp": "string",
"HsmArn": "string",
"HsmType": "string",
"IamRoleArn": "string",
"Partitions": [ "string" ],
"SerialNumber": "string",
"ServerCertLastUpdated": "string",
"ServerCertUri": "string",
"SoftwareVersion": "string",
"SshKeyLastUpdated": "string",
"SshPublicKey": "string",
"Status": "string",
"StatusDetails": "string",
"SubnetId": "string",
"SubscriptionEndDate": "string",
"SubscriptionStartDate": "string",
"SubscriptionType": "string",
"VendorName": "string",
"VpcId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AvailabilityZone
-
The Availability Zone that the HSM is in.
Type: String
Pattern:
[a-zA-Z0-9\-]* - EniId
-
The identifier of the elastic network interface (ENI) attached to the HSM.
Type: String
Pattern:
eni-[0-9a-f]{8} - EniIp
-
The IP address assigned to the HSM's ENI.
Type: String
Pattern:
\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} - HsmArn
-
The ARN of the HSM.
Type: String
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8} - HsmType
-
The HSM model type.
Type: String
Pattern:
[\w :+=./\\-]* - IamRoleArn
-
The ARN of the IAM role assigned to the HSM.
Type: String
Pattern:
arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64} - Partitions
-
The list of partitions on the HSM.
Type: Array of strings
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12} - SerialNumber
-
The serial number of the HSM.
Type: String
Pattern:
\d{1,16} - ServerCertLastUpdated
-
The date and time that the server certificate was last updated.
Type: String
Pattern:
\d* - ServerCertUri
-
The URI of the certificate server.
Type: String
Pattern:
[\w :+=./\\-]* - SoftwareVersion
-
The HSM software version.
Type: String
Pattern:
[\w :+=./\\-]* - SshKeyLastUpdated
-
The date and time that the SSH key was last updated.
Type: String
Pattern:
\d* - SshPublicKey
-
The public SSH key.
Type: String
Pattern:
[a-zA-Z0-9+/= ._:\\@-]* - Status
-
The status of the HSM.
Type: String
Valid Values:
PENDING | RUNNING | UPDATING | SUSPENDED | TERMINATING | TERMINATED | DEGRADED - StatusDetails
-
Contains additional information about the status of the HSM.
Type: String
Pattern:
[\w :+=./\\-]* - SubnetId
-
The identifier of the subnet that the HSM is in.
Type: String
Pattern:
subnet-[0-9a-f]{8} - SubscriptionEndDate
-
The subscription end date.
Type: String
Pattern:
\d* - SubscriptionStartDate
-
The subscription start date.
Type: String
Pattern:
\d* - SubscriptionType
-
Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
Type: String
Valid Values:
PRODUCTION -
- VendorName
-
The name of the HSM vendor.
Type: String
Pattern:
[\w :+=./\\-]* - VpcId
-
The identifier of the VPC that the HSM is in.
Type: String
Pattern:
vpc-[0-9a-f]{8}
Errors
For information about the errors that are common to all actions, see Common Errors.
- CloudHsmInternalException
-
Indicates that an internal error occurred.
HTTP Status Code: 500
- CloudHsmServiceException
-
Indicates that an exception occurred in the AWS CloudHSM service.
HTTP Status Code: 400
- InvalidRequestException
-
Indicates that one or more of the request parameters are not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
