POST

/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm

http://cloudhsm.{region}.amazonaws.com/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm

This is documentation for AWS CloudHSM Classic. 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>. For information about the current version of AWS CloudHSM, 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>. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://cloudhsm.{region}.amazonaws.com/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://cloudhsm.{region}.amazonaws.com/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'