AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

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.

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagList' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Status' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

CreateHapg

$result = $client->createHapg([/* ... */]);
$promise = $client->createHapgAsync([/* ... */]);

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 a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Parameter Syntax

$result = $client->createHapg([
    'Label' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HapgArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

CreateHsm

$result = $client->createHsm([/* ... */]);
$promise = $client->createHsmAsync([/* ... */]);

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 uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

Parameter Syntax

$result = $client->createHsm([
    'ClientToken' => '<string>',
    'EniIp' => '<string>',
    'ExternalId' => '<string>',
    'IamRoleArn' => '<string>', // REQUIRED
    'SshKey' => '<string>', // REQUIRED
    'SubnetId' => '<string>', // REQUIRED
    'SubscriptionType' => 'PRODUCTION', // REQUIRED
    'SyslogIp' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HsmArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

CreateLunaClient

$result = $client->createLunaClient([/* ... */]);
$promise = $client->createLunaClientAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLunaClient([
    'Certificate' => '<string>', // REQUIRED
    'Label' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ClientArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DeleteHapg

$result = $client->deleteHapg([/* ... */]);
$promise = $client->deleteHapgAsync([/* ... */]);

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.

Deletes a high-availability partition group.

Parameter Syntax

$result = $client->deleteHapg([
    'HapgArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DeleteHsm

$result = $client->deleteHsm([/* ... */]);
$promise = $client->deleteHsmAsync([/* ... */]);

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.

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Parameter Syntax

$result = $client->deleteHsm([
    'HsmArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DeleteLunaClient

$result = $client->deleteLunaClient([/* ... */]);
$promise = $client->deleteLunaClientAsync([/* ... */]);

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.

Deletes a client.

Parameter Syntax

$result = $client->deleteLunaClient([
    'ClientArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DescribeHapg

$result = $client->describeHapg([/* ... */]);
$promise = $client->describeHapgAsync([/* ... */]);

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 a high-availability partition group.

Parameter Syntax

$result = $client->describeHapg([
    'HapgArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HapgArn' => '<string>',
    'HapgSerial' => '<string>',
    'HsmsLastActionFailed' => ['<string>', ...],
    'HsmsPendingDeletion' => ['<string>', ...],
    'HsmsPendingRegistration' => ['<string>', ...],
    'Label' => '<string>',
    'LastModifiedTimestamp' => '<string>',
    'PartitionSerialList' => ['<string>', ...],
    'State' => 'READY|UPDATING|DEGRADED',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DescribeHsm

$result = $client->describeHsm([/* ... */]);
$promise = $client->describeHsmAsync([/* ... */]);

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. You can identify the HSM by its ARN or its serial number.

Parameter Syntax

$result = $client->describeHsm([
    'HsmArn' => '<string>',
    'HsmSerialNumber' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AvailabilityZone' => '<string>',
    'EniId' => '<string>',
    'EniIp' => '<string>',
    'HsmArn' => '<string>',
    'HsmType' => '<string>',
    'IamRoleArn' => '<string>',
    'Partitions' => ['<string>', ...],
    'SerialNumber' => '<string>',
    'ServerCertLastUpdated' => '<string>',
    'ServerCertUri' => '<string>',
    'SoftwareVersion' => '<string>',
    'SshKeyLastUpdated' => '<string>',
    'SshPublicKey' => '<string>',
    'Status' => 'PENDING|RUNNING|UPDATING|SUSPENDED|TERMINATING|TERMINATED|DEGRADED',
    'StatusDetails' => '<string>',
    'SubnetId' => '<string>',
    'SubscriptionEndDate' => '<string>',
    'SubscriptionStartDate' => '<string>',
    'SubscriptionType' => 'PRODUCTION',
    'VendorName' => '<string>',
    'VpcId' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

DescribeLunaClient

$result = $client->describeLunaClient([/* ... */]);
$promise = $client->describeLunaClientAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeLunaClient([
    'CertificateFingerprint' => '<string>',
    'ClientArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Certificate' => '<string>',
    'CertificateFingerprint' => '<string>',
    'ClientArn' => '<string>',
    'Label' => '<string>',
    'LastModifiedTimestamp' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

GetConfigFiles

$result = $client->getConfigFiles([/* ... */]);
$promise = $client->getConfigFilesAsync([/* ... */]);

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 configuration files necessary to connect to all high availability partition groups the client is associated with.

Parameter Syntax

$result = $client->getConfigFiles([
    'ClientArn' => '<string>', // REQUIRED
    'ClientVersion' => '5.1|5.3', // REQUIRED
    'HapgList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConfigCred' => '<string>',
    'ConfigFile' => '<string>',
    'ConfigType' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ListAvailableZones

$result = $client->listAvailableZones([/* ... */]);
$promise = $client->listAvailableZonesAsync([/* ... */]);

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.

Lists the Availability Zones that have available AWS CloudHSM capacity.

Parameter Syntax

$result = $client->listAvailableZones([
]);

Parameter Details

Result Syntax

[
    'AZList' => ['<string>', ...],
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ListHapgs

$result = $client->listHapgs([/* ... */]);
$promise = $client->listHapgsAsync([/* ... */]);

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.

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Parameter Syntax

$result = $client->listHapgs([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HapgList' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ListHsms

$result = $client->listHsms([/* ... */]);
$promise = $client->listHsmsAsync([/* ... */]);

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 the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Parameter Syntax

$result = $client->listHsms([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HsmList' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ListLunaClients

$result = $client->listLunaClients([/* ... */]);
$promise = $client->listLunaClientsAsync([/* ... */]);

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.

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Parameter Syntax

$result = $client->listLunaClients([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ClientList' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Returns a list of all tags for the specified AWS CloudHSM resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ModifyHapg

$result = $client->modifyHapg([/* ... */]);
$promise = $client->modifyHapgAsync([/* ... */]);

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.

Modifies an existing high-availability partition group.

Parameter Syntax

$result = $client->modifyHapg([
    'HapgArn' => '<string>', // REQUIRED
    'Label' => '<string>',
    'PartitionSerialList' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'HapgArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ModifyHsm

$result = $client->modifyHsm([/* ... */]);
$promise = $client->modifyHsmAsync([/* ... */]);

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.

Modifies an HSM.

Parameter Syntax

$result = $client->modifyHsm([
    'EniIp' => '<string>',
    'ExternalId' => '<string>',
    'HsmArn' => '<string>', // REQUIRED
    'IamRoleArn' => '<string>',
    'SubnetId' => '<string>',
    'SyslogIp' => '<string>',
]);

Parameter Details

Result Syntax

[
    'HsmArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.

ModifyLunaClient

$result = $client->modifyLunaClient([/* ... */]);
$promise = $client->modifyLunaClientAsync([/* ... */]);

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.

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Parameter Syntax

$result = $client->modifyLunaClient([
    'Certificate' => '<string>', // REQUIRED
    'ClientArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ClientArn' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

RemoveTagsFromResource

$result = $client->removeTagsFromResource([/* ... */]);
$promise = $client->removeTagsFromResourceAsync([/* ... */]);

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.

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeyList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => '<string>',
]

Result Details

Errors

CloudHsmServiceException:

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHsmInternalException:

Indicates that an internal error occurred.

InvalidRequestException:

Indicates that one or more of the request parameters are not valid.