DescribeHapg - AWS CloudHSM Service
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

DescribeHapg

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.

Request Syntax

{
   "HapgArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

HapgArn

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

Type: String

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

Required: Yes

Response Syntax

{
   "HapgArn": "string",
   "HapgSerial": "string",
   "HsmsLastActionFailed": [ "string" ],
   "HsmsPendingDeletion": [ "string" ],
   "HsmsPendingRegistration": [ "string" ],
   "Label": "string",
   "LastModifiedTimestamp": "string",
   "PartitionSerialList": [ "string" ],
   "State": "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.

HapgArn

The ARN of the high-availability partition group.

Type: String

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

HapgSerial

The serial number of the high-availability partition group.

Type: String

Pattern: [\w :+=./\\-]*

HsmsLastActionFailed

Type: Array of strings

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

HsmsPendingDeletion

Type: Array of strings

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

HsmsPendingRegistration

Type: Array of strings

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

Label

The label for the high-availability partition group.

Type: String

Pattern: [a-zA-Z0-9_.-]{1,64}

LastModifiedTimestamp

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

Type: String

Pattern: \d*

PartitionSerialList

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

Type: Array of strings

Pattern: \d{6,12}

State

The state of the high-availability partition group.

Type: String

Valid Values: READY | UPDATING | DEGRADED

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: