Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListHsms

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 the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Request Syntax


{
   "NextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

NextToken

The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

Type: String

Pattern: [a-zA-Z0-9+/]*

Required: No

Response Syntax


{
   "HsmList": [ "string" ],
   "NextToken": "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.

HsmList

The list of ARNs that identify the HSMs.

Type: Array of strings

Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}

NextToken

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

Type: String

Pattern: [a-zA-Z0-9+/]*

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