Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeLunaClient

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 an HSM client.

Request Syntax


{
   "CertificateFingerprint": "string",
   "ClientArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CertificateFingerprint

The certificate fingerprint.

Type: String

Pattern: ([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]

Required: No

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: No

Response Syntax


{
   "Certificate": "string",
   "CertificateFingerprint": "string",
   "ClientArn": "string",
   "Label": "string",
   "LastModifiedTimestamp": "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.

Certificate

The certificate installed on the HSMs used by this client.

Type: String

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

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

CertificateFingerprint

The certificate fingerprint.

Type: String

Pattern: ([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]

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}

Label

The label of the client.

Type: String

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

LastModifiedTimestamp

The date and time the client was last modified.

Type: String

Pattern: \d*

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