GetConfig
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
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
Request Syntax
{
"ClientArn": "string",
"ClientVersion": "string",
"HapgList": [ "string" ]
}Request Parameters
The request accepts the following data in JSON format.
- ClientArn
-
The ARN of the client.
Type: String
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:client-[0-9a-f]{8}Required: Yes
- ClientVersion
-
The client version.
Type: String
Valid Values:
5.1 | 5.3Required: Yes
- HapgList
-
A list of ARNs that identify the high-availability partition groups that are associated with the client.
Type: Array of strings
Pattern:
arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hapg-[0-9a-f]{8}Required: Yes
Response Syntax
{
"ConfigCred": "string",
"ConfigFile": "string",
"ConfigType": "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.
- ConfigCred
-
The certificate file containing the server.pem files of the HSMs.
Type: String
Pattern:
[\w :+=./\\-]* - ConfigFile
-
The chrystoki.conf configuration file.
Type: String
Pattern:
[\w :+=./\\-]* - ConfigType
-
The type of credentials.
Type: String
Pattern:
[\w :+=./\\-]*
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:
