CreateLunaClient - AWS CloudHSM Service

CreateLunaClient

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.

Creates an HSM client.

Request Syntax

{ "Certificate": "string", "Label": "string" }

Request Parameters

The request accepts the following data in JSON format.

Certificate

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

Type: String

Length Constraints: Minimum length of 600. Maximum length of 2400.

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

Required: Yes

Label

The label for the client.

Type: String

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

Required: No

Response Syntax

{ "ClientArn": "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.

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}

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: