describe_hapg

CloudHSM.Client.describe_hapg(**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 information about a high-availability partition group.

See also: AWS API Documentation

Request Syntax

response = client.describe_hapg(
    HapgArn='string'
)

Parameters

HapgArn (string) --

[REQUIRED]

The ARN of the high-availability partition group to describe.

Return type

dict

Returns

Response Syntax

{
    'HapgArn': 'string',
    'HapgSerial': 'string',
    'HsmsLastActionFailed': [
        'string',
    ],
    'HsmsPendingDeletion': [
        'string',
    ],
    'HsmsPendingRegistration': [
        'string',
    ],
    'Label': 'string',
    'LastModifiedTimestamp': 'string',
    'PartitionSerialList': [
        'string',
    ],
    'State': 'READY'|'UPDATING'|'DEGRADED'
}

Response Structure

• (dict) --

  Contains the output of the DescribeHapg action.

  • HapgArn (string) --

    The ARN of the high-availability partition group.

  • HapgSerial (string) --

    The serial number of the high-availability partition group.

  • HsmsLastActionFailed (list) --
    • (string) --

      An ARN that identifies an HSM.

  • HsmsPendingDeletion (list) --
    • (string) --

      An ARN that identifies an HSM.

  • HsmsPendingRegistration (list) --
    • (string) --

      An ARN that identifies an HSM.

  • Label (string) --

    The label for the high-availability partition group.

  • LastModifiedTimestamp (string) --

    The date and time the high-availability partition group was last modified.

  • PartitionSerialList (list) --

    The list of partition serial numbers that belong to the high-availability partition group.

    • (string) --
  • State (string) --

    The state of the high-availability partition group.

Exceptions

• CloudHSM.Client.exceptions.CloudHsmServiceException
• CloudHSM.Client.exceptions.CloudHsmInternalException
• CloudHSM.Client.exceptions.InvalidRequestException