CloudHSM / Client / list_hapgs

list_hapgs#

CloudHSM.Client.list_hapgs(**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.

Lists the high-availability partition groups for the account.

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 ListHapgs 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_hapgs(
    NextToken='string'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • HapgList (list) –

      The list of high-availability partition groups.

      • (string) –

    • NextToken (string) –

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

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException