github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/cloudhsm/2014-05-30/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<fullname>AWS CloudHSM Service</fullname> <p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p>", 4 "operations": { 5 "AddTagsToResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>", 6 "CreateHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>", 7 "CreateHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>", 8 "CreateLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an HSM client.</p>", 9 "DeleteHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a high-availability partition group.</p>", 10 "DeleteHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>", 11 "DeleteLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a client.</p>", 12 "DescribeHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about a high-availability partition group.</p>", 13 "DescribeHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>", 14 "DescribeLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM client.</p>", 15 "GetConfig": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>", 16 "ListAvailableZones": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>", 17 "ListHapgs": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHapgs</code> to retrieve the next set of items.</p>", 18 "ListHsms": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHsms</code> to retrieve the next set of items.</p>", 19 "ListLunaClients": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListLunaClients</code> to retrieve the next set of items.</p>", 20 "ListTagsForResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>", 21 "ModifyHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an existing high-availability partition group.</p>", 22 "ModifyHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an HSM.</p> <important> <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.</p> </important>", 23 "ModifyLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>", 24 "RemoveTagsFromResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>" 25 }, 26 "shapes": { 27 "AZ": { 28 "base": null, 29 "refs": { 30 "AZList$member": null, 31 "DescribeHsmResponse$AvailabilityZone": "<p>The Availability Zone that the HSM is in.</p>" 32 } 33 }, 34 "AZList": { 35 "base": null, 36 "refs": { 37 "ListAvailableZonesResponse$AZList": "<p>The list of Availability Zones that have available AWS CloudHSM capacity.</p>" 38 } 39 }, 40 "AddTagsToResourceRequest": { 41 "base": null, 42 "refs": { 43 } 44 }, 45 "AddTagsToResourceResponse": { 46 "base": null, 47 "refs": { 48 } 49 }, 50 "Boolean": { 51 "base": null, 52 "refs": { 53 "CloudHsmServiceException$retryable": "<p>Indicates if the action can be retried.</p>" 54 } 55 }, 56 "Certificate": { 57 "base": null, 58 "refs": { 59 "CreateLunaClientRequest$Certificate": "<p>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.</p>", 60 "DescribeLunaClientResponse$Certificate": "<p>The certificate installed on the HSMs used by this client.</p>", 61 "ModifyLunaClientRequest$Certificate": "<p>The new certificate for the client.</p>" 62 } 63 }, 64 "CertificateFingerprint": { 65 "base": null, 66 "refs": { 67 "DescribeLunaClientRequest$CertificateFingerprint": "<p>The certificate fingerprint.</p>", 68 "DescribeLunaClientResponse$CertificateFingerprint": "<p>The certificate fingerprint.</p>" 69 } 70 }, 71 "ClientArn": { 72 "base": null, 73 "refs": { 74 "ClientList$member": null, 75 "CreateLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>", 76 "DeleteLunaClientRequest$ClientArn": "<p>The ARN of the client to delete.</p>", 77 "DescribeLunaClientRequest$ClientArn": "<p>The ARN of the client.</p>", 78 "DescribeLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>", 79 "GetConfigRequest$ClientArn": "<p>The ARN of the client.</p>", 80 "ModifyLunaClientRequest$ClientArn": "<p>The ARN of the client.</p>", 81 "ModifyLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>" 82 } 83 }, 84 "ClientLabel": { 85 "base": null, 86 "refs": { 87 "CreateLunaClientRequest$Label": "<p>The label for the client.</p>" 88 } 89 }, 90 "ClientList": { 91 "base": null, 92 "refs": { 93 "ListLunaClientsResponse$ClientList": "<p>The list of clients.</p>" 94 } 95 }, 96 "ClientToken": { 97 "base": null, 98 "refs": { 99 "CreateHsmRequest$ClientToken": "<p>A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.</p>" 100 } 101 }, 102 "ClientVersion": { 103 "base": null, 104 "refs": { 105 "GetConfigRequest$ClientVersion": "<p>The client version.</p>" 106 } 107 }, 108 "CloudHsmInternalException": { 109 "base": "<p>Indicates that an internal error occurred.</p>", 110 "refs": { 111 } 112 }, 113 "CloudHsmObjectState": { 114 "base": null, 115 "refs": { 116 "DescribeHapgResponse$State": "<p>The state of the high-availability partition group.</p>" 117 } 118 }, 119 "CloudHsmServiceException": { 120 "base": "<p>Indicates that an exception occurred in the AWS CloudHSM service.</p>", 121 "refs": { 122 } 123 }, 124 "CreateHapgRequest": { 125 "base": "<p>Contains the inputs for the <a>CreateHapgRequest</a> action.</p>", 126 "refs": { 127 } 128 }, 129 "CreateHapgResponse": { 130 "base": "<p>Contains the output of the <a>CreateHAPartitionGroup</a> action.</p>", 131 "refs": { 132 } 133 }, 134 "CreateHsmRequest": { 135 "base": "<p>Contains the inputs for the <code>CreateHsm</code> operation.</p>", 136 "refs": { 137 } 138 }, 139 "CreateHsmResponse": { 140 "base": "<p>Contains the output of the <code>CreateHsm</code> operation.</p>", 141 "refs": { 142 } 143 }, 144 "CreateLunaClientRequest": { 145 "base": "<p>Contains the inputs for the <a>CreateLunaClient</a> action.</p>", 146 "refs": { 147 } 148 }, 149 "CreateLunaClientResponse": { 150 "base": "<p>Contains the output of the <a>CreateLunaClient</a> action.</p>", 151 "refs": { 152 } 153 }, 154 "DeleteHapgRequest": { 155 "base": "<p>Contains the inputs for the <a>DeleteHapg</a> action.</p>", 156 "refs": { 157 } 158 }, 159 "DeleteHapgResponse": { 160 "base": "<p>Contains the output of the <a>DeleteHapg</a> action.</p>", 161 "refs": { 162 } 163 }, 164 "DeleteHsmRequest": { 165 "base": "<p>Contains the inputs for the <a>DeleteHsm</a> operation.</p>", 166 "refs": { 167 } 168 }, 169 "DeleteHsmResponse": { 170 "base": "<p>Contains the output of the <a>DeleteHsm</a> operation.</p>", 171 "refs": { 172 } 173 }, 174 "DeleteLunaClientRequest": { 175 "base": null, 176 "refs": { 177 } 178 }, 179 "DeleteLunaClientResponse": { 180 "base": null, 181 "refs": { 182 } 183 }, 184 "DescribeHapgRequest": { 185 "base": "<p>Contains the inputs for the <a>DescribeHapg</a> action.</p>", 186 "refs": { 187 } 188 }, 189 "DescribeHapgResponse": { 190 "base": "<p>Contains the output of the <a>DescribeHapg</a> action.</p>", 191 "refs": { 192 } 193 }, 194 "DescribeHsmRequest": { 195 "base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation.</p>", 196 "refs": { 197 } 198 }, 199 "DescribeHsmResponse": { 200 "base": "<p>Contains the output of the <a>DescribeHsm</a> operation.</p>", 201 "refs": { 202 } 203 }, 204 "DescribeLunaClientRequest": { 205 "base": null, 206 "refs": { 207 } 208 }, 209 "DescribeLunaClientResponse": { 210 "base": null, 211 "refs": { 212 } 213 }, 214 "EniId": { 215 "base": null, 216 "refs": { 217 "DescribeHsmResponse$EniId": "<p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>" 218 } 219 }, 220 "ExternalId": { 221 "base": null, 222 "refs": { 223 "CreateHsmRequest$ExternalId": "<p>The external ID from <code>IamRoleArn</code>, if present.</p>", 224 "ModifyHsmRequest$ExternalId": "<p>The new external ID.</p>" 225 } 226 }, 227 "GetConfigRequest": { 228 "base": null, 229 "refs": { 230 } 231 }, 232 "GetConfigResponse": { 233 "base": null, 234 "refs": { 235 } 236 }, 237 "HapgArn": { 238 "base": null, 239 "refs": { 240 "CreateHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>", 241 "DeleteHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to delete.</p>", 242 "DescribeHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to describe.</p>", 243 "DescribeHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>", 244 "HapgList$member": null, 245 "ModifyHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to modify.</p>", 246 "ModifyHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>" 247 } 248 }, 249 "HapgList": { 250 "base": null, 251 "refs": { 252 "GetConfigRequest$HapgList": "<p>A list of ARNs that identify the high-availability partition groups that are associated with the client.</p>", 253 "ListHapgsResponse$HapgList": "<p>The list of high-availability partition groups.</p>" 254 } 255 }, 256 "HsmArn": { 257 "base": "<p>An ARN that identifies an HSM.</p>", 258 "refs": { 259 "CreateHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>", 260 "DeleteHsmRequest$HsmArn": "<p>The ARN of the HSM to delete.</p>", 261 "DescribeHsmRequest$HsmArn": "<p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.</p>", 262 "DescribeHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>", 263 "HsmList$member": null, 264 "ModifyHsmRequest$HsmArn": "<p>The ARN of the HSM to modify.</p>", 265 "ModifyHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>" 266 } 267 }, 268 "HsmList": { 269 "base": "<p>Contains a list of ARNs that identify the HSMs.</p>", 270 "refs": { 271 "DescribeHapgResponse$HsmsLastActionFailed": "<p/>", 272 "DescribeHapgResponse$HsmsPendingDeletion": "<p/>", 273 "DescribeHapgResponse$HsmsPendingRegistration": "<p/>", 274 "ListHsmsResponse$HsmList": "<p>The list of ARNs that identify the HSMs.</p>" 275 } 276 }, 277 "HsmSerialNumber": { 278 "base": null, 279 "refs": { 280 "DescribeHsmRequest$HsmSerialNumber": "<p>The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.</p>", 281 "DescribeHsmResponse$SerialNumber": "<p>The serial number of the HSM.</p>" 282 } 283 }, 284 "HsmStatus": { 285 "base": null, 286 "refs": { 287 "DescribeHsmResponse$Status": "<p>The status of the HSM.</p>" 288 } 289 }, 290 "IamRoleArn": { 291 "base": null, 292 "refs": { 293 "CreateHsmRequest$IamRoleArn": "<p>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.</p>", 294 "DescribeHsmResponse$IamRoleArn": "<p>The ARN of the IAM role assigned to the HSM.</p>", 295 "ModifyHsmRequest$IamRoleArn": "<p>The new IAM role ARN.</p>" 296 } 297 }, 298 "InvalidRequestException": { 299 "base": "<p>Indicates that one or more of the request parameters are not valid.</p>", 300 "refs": { 301 } 302 }, 303 "IpAddress": { 304 "base": null, 305 "refs": { 306 "CreateHsmRequest$EniIp": "<p>The IP address to assign to the HSM's ENI.</p> <p>If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.</p>", 307 "CreateHsmRequest$SyslogIp": "<p>The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>", 308 "DescribeHsmResponse$EniIp": "<p>The IP address assigned to the HSM's ENI.</p>", 309 "ModifyHsmRequest$EniIp": "<p>The new IP address for the elastic network interface (ENI) attached to the HSM.</p> <p>If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.</p>", 310 "ModifyHsmRequest$SyslogIp": "<p>The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>" 311 } 312 }, 313 "Label": { 314 "base": null, 315 "refs": { 316 "CreateHapgRequest$Label": "<p>The label of the new high-availability partition group.</p>", 317 "DescribeHapgResponse$Label": "<p>The label for the high-availability partition group.</p>", 318 "DescribeLunaClientResponse$Label": "<p>The label of the client.</p>", 319 "ModifyHapgRequest$Label": "<p>The new label for the high-availability partition group.</p>" 320 } 321 }, 322 "ListAvailableZonesRequest": { 323 "base": "<p>Contains the inputs for the <a>ListAvailableZones</a> action.</p>", 324 "refs": { 325 } 326 }, 327 "ListAvailableZonesResponse": { 328 "base": null, 329 "refs": { 330 } 331 }, 332 "ListHapgsRequest": { 333 "base": null, 334 "refs": { 335 } 336 }, 337 "ListHapgsResponse": { 338 "base": null, 339 "refs": { 340 } 341 }, 342 "ListHsmsRequest": { 343 "base": null, 344 "refs": { 345 } 346 }, 347 "ListHsmsResponse": { 348 "base": "<p>Contains the output of the <code>ListHsms</code> operation.</p>", 349 "refs": { 350 } 351 }, 352 "ListLunaClientsRequest": { 353 "base": null, 354 "refs": { 355 } 356 }, 357 "ListLunaClientsResponse": { 358 "base": null, 359 "refs": { 360 } 361 }, 362 "ListTagsForResourceRequest": { 363 "base": null, 364 "refs": { 365 } 366 }, 367 "ListTagsForResourceResponse": { 368 "base": null, 369 "refs": { 370 } 371 }, 372 "ModifyHapgRequest": { 373 "base": null, 374 "refs": { 375 } 376 }, 377 "ModifyHapgResponse": { 378 "base": null, 379 "refs": { 380 } 381 }, 382 "ModifyHsmRequest": { 383 "base": "<p>Contains the inputs for the <a>ModifyHsm</a> operation.</p>", 384 "refs": { 385 } 386 }, 387 "ModifyHsmResponse": { 388 "base": "<p>Contains the output of the <a>ModifyHsm</a> operation.</p>", 389 "refs": { 390 } 391 }, 392 "ModifyLunaClientRequest": { 393 "base": null, 394 "refs": { 395 } 396 }, 397 "ModifyLunaClientResponse": { 398 "base": null, 399 "refs": { 400 } 401 }, 402 "PaginationToken": { 403 "base": null, 404 "refs": { 405 "ListHapgsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass null if this is the first call.</p>", 406 "ListHapgsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to retrieve the next set of items.</p>", 407 "ListHsmsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass null if this is the first call.</p>", 408 "ListHsmsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHsms</code> to retrieve the next set of items.</p>", 409 "ListLunaClientsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>. Pass null if this is the first call.</p>", 410 "ListLunaClientsResponse$NextToken": "<p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to retrieve the next set of items.</p>" 411 } 412 }, 413 "PartitionArn": { 414 "base": null, 415 "refs": { 416 "PartitionList$member": null 417 } 418 }, 419 "PartitionList": { 420 "base": null, 421 "refs": { 422 "DescribeHsmResponse$Partitions": "<p>The list of partitions on the HSM.</p>" 423 } 424 }, 425 "PartitionSerial": { 426 "base": null, 427 "refs": { 428 "PartitionSerialList$member": null 429 } 430 }, 431 "PartitionSerialList": { 432 "base": null, 433 "refs": { 434 "DescribeHapgResponse$PartitionSerialList": "<p>The list of partition serial numbers that belong to the high-availability partition group.</p>", 435 "ModifyHapgRequest$PartitionSerialList": "<p>The list of partition serial numbers to make members of the high-availability partition group.</p>" 436 } 437 }, 438 "RemoveTagsFromResourceRequest": { 439 "base": null, 440 "refs": { 441 } 442 }, 443 "RemoveTagsFromResourceResponse": { 444 "base": null, 445 "refs": { 446 } 447 }, 448 "SshKey": { 449 "base": null, 450 "refs": { 451 "CreateHsmRequest$SshKey": "<p>The SSH public key to install on the HSM.</p>", 452 "DescribeHsmResponse$SshPublicKey": "<p>The public SSH key.</p>" 453 } 454 }, 455 "String": { 456 "base": null, 457 "refs": { 458 "AddTagsToResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>", 459 "AddTagsToResourceResponse$Status": "<p>The status of the operation.</p>", 460 "CloudHsmServiceException$message": "<p>Additional information about the error.</p>", 461 "DeleteHapgResponse$Status": "<p>The status of the action.</p>", 462 "DeleteHsmResponse$Status": "<p>The status of the operation.</p>", 463 "DeleteLunaClientResponse$Status": "<p>The status of the action.</p>", 464 "DescribeHapgResponse$HapgSerial": "<p>The serial number of the high-availability partition group.</p>", 465 "DescribeHsmResponse$StatusDetails": "<p>Contains additional information about the status of the HSM.</p>", 466 "DescribeHsmResponse$VendorName": "<p>The name of the HSM vendor.</p>", 467 "DescribeHsmResponse$HsmType": "<p>The HSM model type.</p>", 468 "DescribeHsmResponse$SoftwareVersion": "<p>The HSM software version.</p>", 469 "DescribeHsmResponse$ServerCertUri": "<p>The URI of the certificate server.</p>", 470 "GetConfigResponse$ConfigType": "<p>The type of credentials.</p>", 471 "GetConfigResponse$ConfigFile": "<p>The chrystoki.conf configuration file.</p>", 472 "GetConfigResponse$ConfigCred": "<p>The certificate file containing the server.pem files of the HSMs.</p>", 473 "ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>", 474 "RemoveTagsFromResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>", 475 "RemoveTagsFromResourceResponse$Status": "<p>The status of the operation.</p>" 476 } 477 }, 478 "SubnetId": { 479 "base": null, 480 "refs": { 481 "CreateHsmRequest$SubnetId": "<p>The identifier of the subnet in your VPC in which to place the HSM.</p>", 482 "DescribeHsmResponse$SubnetId": "<p>The identifier of the subnet that the HSM is in.</p>", 483 "ModifyHsmRequest$SubnetId": "<p>The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.</p>" 484 } 485 }, 486 "SubscriptionType": { 487 "base": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li> <p> <b>PRODUCTION</b> - The HSM is being used in a production environment.</p> </li> <li> <p> <b>TRIAL</b> - The HSM is being used in a product trial.</p> </li> </ul>", 488 "refs": { 489 "CreateHsmRequest$SubscriptionType": null, 490 "DescribeHsmResponse$SubscriptionType": null 491 } 492 }, 493 "Tag": { 494 "base": "<p>A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.</p>", 495 "refs": { 496 "TagList$member": null 497 } 498 }, 499 "TagKey": { 500 "base": null, 501 "refs": { 502 "Tag$Key": "<p>The key of the tag.</p>", 503 "TagKeyList$member": null 504 } 505 }, 506 "TagKeyList": { 507 "base": null, 508 "refs": { 509 "RemoveTagsFromResourceRequest$TagKeyList": "<p>The tag key or keys to remove.</p> <p>Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>" 510 } 511 }, 512 "TagList": { 513 "base": null, 514 "refs": { 515 "AddTagsToResourceRequest$TagList": "<p>One or more tags.</p>", 516 "ListTagsForResourceResponse$TagList": "<p>One or more tags.</p>" 517 } 518 }, 519 "TagValue": { 520 "base": null, 521 "refs": { 522 "Tag$Value": "<p>The value of the tag.</p>" 523 } 524 }, 525 "Timestamp": { 526 "base": null, 527 "refs": { 528 "DescribeHapgResponse$LastModifiedTimestamp": "<p>The date and time the high-availability partition group was last modified.</p>", 529 "DescribeHsmResponse$SubscriptionStartDate": "<p>The subscription start date.</p>", 530 "DescribeHsmResponse$SubscriptionEndDate": "<p>The subscription end date.</p>", 531 "DescribeHsmResponse$SshKeyLastUpdated": "<p>The date and time that the SSH key was last updated.</p>", 532 "DescribeHsmResponse$ServerCertLastUpdated": "<p>The date and time that the server certificate was last updated.</p>", 533 "DescribeLunaClientResponse$LastModifiedTimestamp": "<p>The date and time the client was last modified.</p>" 534 } 535 }, 536 "VpcId": { 537 "base": null, 538 "refs": { 539 "DescribeHsmResponse$VpcId": "<p>The identifier of the VPC that the HSM is in.</p>" 540 } 541 } 542 } 543 }