Response Elements

"ClientArn": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ClientArn (p. 17)

The ARN of the client to delete.

Type: String

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

Required: Yes

Response Syntax

{

"Status": "string"

}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Status (p. 17)

The status of the action.

Type: String

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

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

See Also

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

Request Syntax

{ "HapgArn": "string"

}

Request Parameters

The request accepts the following data in JSON format.

HapgArn (p. 19)

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 (p. 19)

The ARN of the high-availability partition group.

Type: String

Errors

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

HapgSerial (p. 19)

The serial number of the high-availability partition group.

Type: String

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

HsmsLastActionFailed (p. 19)

Type: Array of strings

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

HsmsPendingDeletion (p. 19)

Type: Array of strings

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

HsmsPendingRegistration (p. 19)

Type: Array of strings

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

Label (p. 19)

The label for the high-availability partition group.

Type: String

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

LastModiﬁedTimestamp (p. 19)

The date and time the high-availability partition group was last modiﬁed.

Type: String Pattern: \d*

PartitionSerialList (p. 19)

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

Type: Array of strings Pattern: \d{6,12}

See Also

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

Request Syntax

{

"HsmArn": "string",

"HsmSerialNumber": "string"

}

Request Parameters

The request accepts the following data in JSON format.

HsmArn (p. 22)

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be speciﬁed.

Type: String

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

Required: No

HsmSerialNumber (p. 22)

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be speciﬁed.

Type: String Pattern: \d{1,16}

Required: No

Response Syntax

Response Elements

"SshPublicKey": "string", "Status": "string", "StatusDetails": "string", "SubnetId": "string",

"SubscriptionEndDate": "string", "SubscriptionStartDate": "string", "SubscriptionType": "string", "VendorName": "string", "VpcId": "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.

AvailabilityZone (p. 22)

The Availability Zone that the HSM is in.

Type: String

Pattern: [a-zA-Z0-9\-]*

EniId (p. 22)

The identiﬁer of the elastic network interface (ENI) attached to the HSM.

Type: String

Pattern: eni-[0-9a-f]{8}

EniIp (p. 22)

The IP address assigned to the HSM's ENI.

Type: String

Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

HsmArn (p. 22)

The ARN of the HSM.

Type: String

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

HsmType (p. 22)

The HSM model type.

Type: String

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

IamRoleArn (p. 22)

The ARN of the IAM role assigned to the HSM.

Type: String

Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}

Response Elements

Partitions (p. 22)

The list of partitions on the HSM.

Type: Array of strings

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

partition-[0-9]{6,12}

SerialNumber (p. 22)

The serial number of the HSM.

Type: String Pattern: \d{1,16}

ServerCertLastUpdated (p. 22)

The date and time that the server certiﬁcate was last updated.

Type: String Pattern: \d*

ServerCertUri (p. 22)

The URI of the certiﬁcate server.

Type: String

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

SoftwareVersion (p. 22) The HSM software version.

Type: String

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

SshKeyLastUpdated (p. 22)

The date and time that the SSH key was last updated.

Type: String Pattern: \d*

SshPublicKey (p. 22) The public SSH key.

Type: String

Errors

Type: String

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

SubnetId (p. 22)

The identiﬁer of the subnet that the HSM is in.

Type: String

Pattern: subnet-[0-9a-f]{8}

SubscriptionEndDate (p. 22) The subscription end date.

Type: String Pattern: \d*

SubscriptionStartDate (p. 22) The subscription start date.

Type: String Pattern: \d*

SubscriptionType (p. 22)

Speciﬁes the type of subscription for the HSM.

• PRODUCTION - The HSM is being used in a production environment.

• TRIAL - The HSM is being used in a product trial.

Type: String

Valid Values: PRODUCTION VendorName (p. 22)

The name of the HSM vendor.

Type: String

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

VpcId (p. 22)

The identiﬁer of the VPC that the HSM is in.

Type: String

Pattern: vpc-[0-9a-f]{8}

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

CloudHsmInternalException

Indicates that an internal error occurred.

HTTP Status Code: 500

See Also

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

Request Syntax

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

}

Request Parameters

The request accepts the following data in JSON format.

CertiﬁcateFingerprint (p. 27) The certiﬁcate ﬁngerprint.

Type: String

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

Required: No ClientArn (p. 27)

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.

Errors

The following data is returned in JSON format by the service.

Certiﬁcate (p. 27)

The certiﬁcate installed on the HSMs used by this client.

Type: String

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

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

CertiﬁcateFingerprint (p. 27) The certiﬁcate ﬁngerprint.

Type: String

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

ClientArn (p. 27)

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 (p. 27)

The label of the client.

Type: String

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

LastModiﬁedTimestamp (p. 27)

The date and time the client was last modiﬁed.

Type: String Pattern: \d*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

CloudHsmInternalException

Indicates that an internal error occurred.

See Also

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

GetConﬁg

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.

Gets the conﬁguration ﬁles 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 (p. 30)

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 (p. 30)

The client version.

Type: String

Valid Values: 5.1 | 5.3 Required: Yes

HapgList (p. 30)

A list of ARNs that identify the high-availability partition groups that are associated with the client.

Response Elements

"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.

ConﬁgCred (p. 30)

The certiﬁcate ﬁle containing the server.pem ﬁles of the HSMs.

Type: String

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

ConﬁgFile (p. 30)

The chrystoki.conf conﬁguration ﬁle.

Type: String

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

ConﬁgType (p. 30)

The type of credentials.

Type: String

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

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Response Syntax

{

"AZList": [ "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.

AZList (p. 33)

The list of Availability Zones that have available AWS CloudHSM capacity.

Type: Array of strings Pattern: [a-zA-Z0-9\-]*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Request Syntax

{ "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

NextToken (p. 35)

The NextToken value from a previous call to ListHapgs. Pass null if this is the ﬁrst call.

Type: String

Pattern: [a-zA-Z0-9+/]*

Required: No

Response Syntax

{

"HapgList": [ "string" ], "NextToken": "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.

HapgList (p. 35)

The list of high-availability partition groups.

Type: Array of strings

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

Errors

NextToken (p. 35)

If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

Type: String

Pattern: [a-zA-Z0-9+/]*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Request Syntax

{ "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

NextToken (p. 37)

The NextToken value from a previous call to ListHsms. Pass null if this is the ﬁrst call.

Type: String

Pattern: [a-zA-Z0-9+/]*

Required: No

Response Syntax

{

"HsmList": [ "string" ], "NextToken": "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.

HsmList (p. 37)

The list of ARNs that identify the HSMs.

Type: Array of strings

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

Errors

NextToken (p. 37)

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

Type: String

Pattern: [a-zA-Z0-9+/]*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Request Syntax

{ "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

NextToken (p. 39)

The NextToken value from a previous call to ListLunaClients. Pass null if this is the ﬁrst call.

Type: String

Pattern: [a-zA-Z0-9+/]*

Required: No

Response Syntax

{

"ClientList": [ "string" ], "NextToken": "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.

ClientList (p. 39) The list of clients.

Type: Array of strings

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

Errors

NextToken (p. 39)

If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

Type: String

Pattern: [a-zA-Z0-9+/]*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Request Syntax

{

"ResourceArn": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ResourceArn (p. 41)

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

Type: String

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TagList (p. 41) One or more tags.

Type: Array of Tag (p. 54) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 55).

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

Response Elements

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeHapg

Request Syntax

Request Parameters

Response Syntax

Response Elements

See Also

DescribeHsm

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeLunaClient

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

GetConﬁg

Request Syntax

Request Parameters

Response Elements

Errors

See Also

ListAvailableZones

Response Syntax

Response Elements

Errors

See Also

ListHapgs

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

ListHsms

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

ListLunaClients

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

ListTagsForResource

Request Syntax

Request Parameters

Errors

See Also

ModifyHapg