CloudHSM / Client / list_hsms

list_hsms#

CloudHSM.Client.list_hsms(**kwargs)#

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.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.list_hsms(
    NextToken='string'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'HsmList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains the output of the ListHsms operation.

    • HsmList (list) –

      The list of ARNs that identify the HSMs.

      • (string) –

        An ARN that identifies an HSM.

    • NextToken (string) –

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

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException