ModifyHapg
This is documentation for AWS CloudHSM Classic. For
more information, see AWS CloudHSM
Classic FAQs
For information about the current version of AWS
CloudHSM, see AWS CloudHSM
Modifies an existing high-availability partition group.
Request Syntax
{
"HapgArn": "string
",
"Label": "string
",
"PartitionSerialList": [ "string
" ]
}
Request Parameters
The request accepts the following data in JSON format.
- HapgArn
-
The ARN of the high-availability partition group to modify.
Type: String
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hapg-[0-9a-f]{8}
Required: Yes
- Label
-
The new label for the high-availability partition group.
Type: String
Pattern:
[a-zA-Z0-9_.-]{1,64}
Required: No
- PartitionSerialList
-
The list of partition serial numbers to make members of the high-availability partition group.
Type: Array of strings
Pattern:
\d{6,12}
Required: No
Response Syntax
{
"HapgArn": "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}
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: