1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2014-05-30", 5 "endpointPrefix":"cloudhsm", 6 "jsonVersion":"1.1", 7 "protocol":"json", 8 "serviceAbbreviation":"CloudHSM", 9 "serviceFullName":"Amazon CloudHSM", 10 "serviceId":"CloudHSM", 11 "signatureVersion":"v4", 12 "targetPrefix":"CloudHsmFrontendService", 13 "uid":"cloudhsm-2014-05-30" 14 }, 15 "operations":{ 16 "AddTagsToResource":{ 17 "name":"AddTagsToResource", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/" 21 }, 22 "input":{"shape":"AddTagsToResourceRequest"}, 23 "output":{"shape":"AddTagsToResourceResponse"}, 24 "errors":[ 25 {"shape":"CloudHsmServiceException"}, 26 {"shape":"CloudHsmInternalException"}, 27 {"shape":"InvalidRequestException"} 28 ], 29 "documentation":"<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>", 30 "deprecated":true, 31 "deprecatedMessage":"This API is deprecated." 32 }, 33 "CreateHapg":{ 34 "name":"CreateHapg", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/" 38 }, 39 "input":{"shape":"CreateHapgRequest"}, 40 "output":{"shape":"CreateHapgResponse"}, 41 "errors":[ 42 {"shape":"CloudHsmServiceException"}, 43 {"shape":"CloudHsmInternalException"}, 44 {"shape":"InvalidRequestException"} 45 ], 46 "documentation":"<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>", 47 "deprecated":true, 48 "deprecatedMessage":"This API is deprecated." 49 }, 50 "CreateHsm":{ 51 "name":"CreateHsm", 52 "http":{ 53 "method":"POST", 54 "requestUri":"/" 55 }, 56 "input":{"shape":"CreateHsmRequest"}, 57 "output":{"shape":"CreateHsmResponse"}, 58 "errors":[ 59 {"shape":"CloudHsmServiceException"}, 60 {"shape":"CloudHsmInternalException"}, 61 {"shape":"InvalidRequestException"} 62 ], 63 "documentation":"<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>", 64 "deprecated":true, 65 "deprecatedMessage":"This API is deprecated." 66 }, 67 "CreateLunaClient":{ 68 "name":"CreateLunaClient", 69 "http":{ 70 "method":"POST", 71 "requestUri":"/" 72 }, 73 "input":{"shape":"CreateLunaClientRequest"}, 74 "output":{"shape":"CreateLunaClientResponse"}, 75 "errors":[ 76 {"shape":"CloudHsmServiceException"}, 77 {"shape":"CloudHsmInternalException"}, 78 {"shape":"InvalidRequestException"} 79 ], 80 "documentation":"<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>", 81 "deprecated":true, 82 "deprecatedMessage":"This API is deprecated." 83 }, 84 "DeleteHapg":{ 85 "name":"DeleteHapg", 86 "http":{ 87 "method":"POST", 88 "requestUri":"/" 89 }, 90 "input":{"shape":"DeleteHapgRequest"}, 91 "output":{"shape":"DeleteHapgResponse"}, 92 "errors":[ 93 {"shape":"CloudHsmServiceException"}, 94 {"shape":"CloudHsmInternalException"}, 95 {"shape":"InvalidRequestException"} 96 ], 97 "documentation":"<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>", 98 "deprecated":true, 99 "deprecatedMessage":"This API is deprecated." 100 }, 101 "DeleteHsm":{ 102 "name":"DeleteHsm", 103 "http":{ 104 "method":"POST", 105 "requestUri":"/" 106 }, 107 "input":{"shape":"DeleteHsmRequest"}, 108 "output":{"shape":"DeleteHsmResponse"}, 109 "errors":[ 110 {"shape":"CloudHsmServiceException"}, 111 {"shape":"CloudHsmInternalException"}, 112 {"shape":"InvalidRequestException"} 113 ], 114 "documentation":"<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>", 115 "deprecated":true, 116 "deprecatedMessage":"This API is deprecated." 117 }, 118 "DeleteLunaClient":{ 119 "name":"DeleteLunaClient", 120 "http":{ 121 "method":"POST", 122 "requestUri":"/" 123 }, 124 "input":{"shape":"DeleteLunaClientRequest"}, 125 "output":{"shape":"DeleteLunaClientResponse"}, 126 "errors":[ 127 {"shape":"CloudHsmServiceException"}, 128 {"shape":"CloudHsmInternalException"}, 129 {"shape":"InvalidRequestException"} 130 ], 131 "documentation":"<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>", 132 "deprecated":true, 133 "deprecatedMessage":"This API is deprecated." 134 }, 135 "DescribeHapg":{ 136 "name":"DescribeHapg", 137 "http":{ 138 "method":"POST", 139 "requestUri":"/" 140 }, 141 "input":{"shape":"DescribeHapgRequest"}, 142 "output":{"shape":"DescribeHapgResponse"}, 143 "errors":[ 144 {"shape":"CloudHsmServiceException"}, 145 {"shape":"CloudHsmInternalException"}, 146 {"shape":"InvalidRequestException"} 147 ], 148 "documentation":"<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>", 149 "deprecated":true, 150 "deprecatedMessage":"This API is deprecated." 151 }, 152 "DescribeHsm":{ 153 "name":"DescribeHsm", 154 "http":{ 155 "method":"POST", 156 "requestUri":"/" 157 }, 158 "input":{"shape":"DescribeHsmRequest"}, 159 "output":{"shape":"DescribeHsmResponse"}, 160 "errors":[ 161 {"shape":"CloudHsmServiceException"}, 162 {"shape":"CloudHsmInternalException"}, 163 {"shape":"InvalidRequestException"} 164 ], 165 "documentation":"<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>", 166 "deprecated":true, 167 "deprecatedMessage":"This API is deprecated." 168 }, 169 "DescribeLunaClient":{ 170 "name":"DescribeLunaClient", 171 "http":{ 172 "method":"POST", 173 "requestUri":"/" 174 }, 175 "input":{"shape":"DescribeLunaClientRequest"}, 176 "output":{"shape":"DescribeLunaClientResponse"}, 177 "errors":[ 178 {"shape":"CloudHsmServiceException"}, 179 {"shape":"CloudHsmInternalException"}, 180 {"shape":"InvalidRequestException"} 181 ], 182 "documentation":"<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>", 183 "deprecated":true, 184 "deprecatedMessage":"This API is deprecated." 185 }, 186 "GetConfig":{ 187 "name":"GetConfig", 188 "http":{ 189 "method":"POST", 190 "requestUri":"/" 191 }, 192 "input":{"shape":"GetConfigRequest"}, 193 "output":{"shape":"GetConfigResponse"}, 194 "errors":[ 195 {"shape":"CloudHsmServiceException"}, 196 {"shape":"CloudHsmInternalException"}, 197 {"shape":"InvalidRequestException"} 198 ], 199 "documentation":"<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>", 200 "deprecated":true, 201 "deprecatedMessage":"This API is deprecated." 202 }, 203 "ListAvailableZones":{ 204 "name":"ListAvailableZones", 205 "http":{ 206 "method":"POST", 207 "requestUri":"/" 208 }, 209 "input":{"shape":"ListAvailableZonesRequest"}, 210 "output":{"shape":"ListAvailableZonesResponse"}, 211 "errors":[ 212 {"shape":"CloudHsmServiceException"}, 213 {"shape":"CloudHsmInternalException"}, 214 {"shape":"InvalidRequestException"} 215 ], 216 "documentation":"<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>", 217 "deprecated":true, 218 "deprecatedMessage":"This API is deprecated." 219 }, 220 "ListHapgs":{ 221 "name":"ListHapgs", 222 "http":{ 223 "method":"POST", 224 "requestUri":"/" 225 }, 226 "input":{"shape":"ListHapgsRequest"}, 227 "output":{"shape":"ListHapgsResponse"}, 228 "errors":[ 229 {"shape":"CloudHsmServiceException"}, 230 {"shape":"CloudHsmInternalException"}, 231 {"shape":"InvalidRequestException"} 232 ], 233 "documentation":"<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>", 234 "deprecated":true, 235 "deprecatedMessage":"This API is deprecated." 236 }, 237 "ListHsms":{ 238 "name":"ListHsms", 239 "http":{ 240 "method":"POST", 241 "requestUri":"/" 242 }, 243 "input":{"shape":"ListHsmsRequest"}, 244 "output":{"shape":"ListHsmsResponse"}, 245 "errors":[ 246 {"shape":"CloudHsmServiceException"}, 247 {"shape":"CloudHsmInternalException"}, 248 {"shape":"InvalidRequestException"} 249 ], 250 "documentation":"<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>", 251 "deprecated":true, 252 "deprecatedMessage":"This API is deprecated." 253 }, 254 "ListLunaClients":{ 255 "name":"ListLunaClients", 256 "http":{ 257 "method":"POST", 258 "requestUri":"/" 259 }, 260 "input":{"shape":"ListLunaClientsRequest"}, 261 "output":{"shape":"ListLunaClientsResponse"}, 262 "errors":[ 263 {"shape":"CloudHsmServiceException"}, 264 {"shape":"CloudHsmInternalException"}, 265 {"shape":"InvalidRequestException"} 266 ], 267 "documentation":"<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>", 268 "deprecated":true, 269 "deprecatedMessage":"This API is deprecated." 270 }, 271 "ListTagsForResource":{ 272 "name":"ListTagsForResource", 273 "http":{ 274 "method":"POST", 275 "requestUri":"/" 276 }, 277 "input":{"shape":"ListTagsForResourceRequest"}, 278 "output":{"shape":"ListTagsForResourceResponse"}, 279 "errors":[ 280 {"shape":"CloudHsmServiceException"}, 281 {"shape":"CloudHsmInternalException"}, 282 {"shape":"InvalidRequestException"} 283 ], 284 "documentation":"<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>", 285 "deprecated":true, 286 "deprecatedMessage":"This API is deprecated." 287 }, 288 "ModifyHapg":{ 289 "name":"ModifyHapg", 290 "http":{ 291 "method":"POST", 292 "requestUri":"/" 293 }, 294 "input":{"shape":"ModifyHapgRequest"}, 295 "output":{"shape":"ModifyHapgResponse"}, 296 "errors":[ 297 {"shape":"CloudHsmServiceException"}, 298 {"shape":"CloudHsmInternalException"}, 299 {"shape":"InvalidRequestException"} 300 ], 301 "documentation":"<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>", 302 "deprecated":true, 303 "deprecatedMessage":"This API is deprecated." 304 }, 305 "ModifyHsm":{ 306 "name":"ModifyHsm", 307 "http":{ 308 "method":"POST", 309 "requestUri":"/" 310 }, 311 "input":{"shape":"ModifyHsmRequest"}, 312 "output":{"shape":"ModifyHsmResponse"}, 313 "errors":[ 314 {"shape":"CloudHsmServiceException"}, 315 {"shape":"CloudHsmInternalException"}, 316 {"shape":"InvalidRequestException"} 317 ], 318 "documentation":"<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>", 319 "deprecated":true, 320 "deprecatedMessage":"This API is deprecated." 321 }, 322 "ModifyLunaClient":{ 323 "name":"ModifyLunaClient", 324 "http":{ 325 "method":"POST", 326 "requestUri":"/" 327 }, 328 "input":{"shape":"ModifyLunaClientRequest"}, 329 "output":{"shape":"ModifyLunaClientResponse"}, 330 "errors":[ 331 {"shape":"CloudHsmServiceException"} 332 ], 333 "documentation":"<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>", 334 "deprecated":true, 335 "deprecatedMessage":"This API is deprecated." 336 }, 337 "RemoveTagsFromResource":{ 338 "name":"RemoveTagsFromResource", 339 "http":{ 340 "method":"POST", 341 "requestUri":"/" 342 }, 343 "input":{"shape":"RemoveTagsFromResourceRequest"}, 344 "output":{"shape":"RemoveTagsFromResourceResponse"}, 345 "errors":[ 346 {"shape":"CloudHsmServiceException"}, 347 {"shape":"CloudHsmInternalException"}, 348 {"shape":"InvalidRequestException"} 349 ], 350 "documentation":"<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>", 351 "deprecated":true, 352 "deprecatedMessage":"This API is deprecated." 353 } 354 }, 355 "shapes":{ 356 "AZ":{ 357 "type":"string", 358 "pattern":"[a-zA-Z0-9\\-]*" 359 }, 360 "AZList":{ 361 "type":"list", 362 "member":{"shape":"AZ"} 363 }, 364 "AddTagsToResourceRequest":{ 365 "type":"structure", 366 "required":[ 367 "ResourceArn", 368 "TagList" 369 ], 370 "members":{ 371 "ResourceArn":{ 372 "shape":"String", 373 "documentation":"<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>" 374 }, 375 "TagList":{ 376 "shape":"TagList", 377 "documentation":"<p>One or more tags.</p>" 378 } 379 } 380 }, 381 "AddTagsToResourceResponse":{ 382 "type":"structure", 383 "required":["Status"], 384 "members":{ 385 "Status":{ 386 "shape":"String", 387 "documentation":"<p>The status of the operation.</p>" 388 } 389 } 390 }, 391 "Boolean":{"type":"boolean"}, 392 "Certificate":{ 393 "type":"string", 394 "max":2400, 395 "min":600, 396 "pattern":"[\\w :+=./\\n-]*" 397 }, 398 "CertificateFingerprint":{ 399 "type":"string", 400 "pattern":"([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]" 401 }, 402 "ClientArn":{ 403 "type":"string", 404 "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}" 405 }, 406 "ClientLabel":{ 407 "type":"string", 408 "pattern":"[a-zA-Z0-9_.-]{2,64}" 409 }, 410 "ClientList":{ 411 "type":"list", 412 "member":{"shape":"ClientArn"} 413 }, 414 "ClientToken":{ 415 "type":"string", 416 "pattern":"[a-zA-Z0-9]{1,64}" 417 }, 418 "ClientVersion":{ 419 "type":"string", 420 "enum":[ 421 "5.1", 422 "5.3" 423 ] 424 }, 425 "CloudHsmInternalException":{ 426 "type":"structure", 427 "members":{ 428 }, 429 "documentation":"<p>Indicates that an internal error occurred.</p>", 430 "exception":true, 431 "fault":true 432 }, 433 "CloudHsmObjectState":{ 434 "type":"string", 435 "enum":[ 436 "READY", 437 "UPDATING", 438 "DEGRADED" 439 ] 440 }, 441 "CloudHsmServiceException":{ 442 "type":"structure", 443 "members":{ 444 "message":{ 445 "shape":"String", 446 "documentation":"<p>Additional information about the error.</p>" 447 }, 448 "retryable":{ 449 "shape":"Boolean", 450 "documentation":"<p>Indicates if the action can be retried.</p>" 451 } 452 }, 453 "documentation":"<p>Indicates that an exception occurred in the AWS CloudHSM service.</p>", 454 "exception":true 455 }, 456 "CreateHapgRequest":{ 457 "type":"structure", 458 "required":["Label"], 459 "members":{ 460 "Label":{ 461 "shape":"Label", 462 "documentation":"<p>The label of the new high-availability partition group.</p>" 463 } 464 }, 465 "documentation":"<p>Contains the inputs for the <a>CreateHapgRequest</a> action.</p>" 466 }, 467 "CreateHapgResponse":{ 468 "type":"structure", 469 "members":{ 470 "HapgArn":{ 471 "shape":"HapgArn", 472 "documentation":"<p>The ARN of the high-availability partition group.</p>" 473 } 474 }, 475 "documentation":"<p>Contains the output of the <a>CreateHAPartitionGroup</a> action.</p>" 476 }, 477 "CreateHsmRequest":{ 478 "type":"structure", 479 "required":[ 480 "SubnetId", 481 "SshKey", 482 "IamRoleArn", 483 "SubscriptionType" 484 ], 485 "members":{ 486 "SubnetId":{ 487 "shape":"SubnetId", 488 "documentation":"<p>The identifier of the subnet in your VPC in which to place the HSM.</p>" 489 }, 490 "SshKey":{ 491 "shape":"SshKey", 492 "documentation":"<p>The SSH public key to install on the HSM.</p>" 493 }, 494 "EniIp":{ 495 "shape":"IpAddress", 496 "documentation":"<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>" 497 }, 498 "IamRoleArn":{ 499 "shape":"IamRoleArn", 500 "documentation":"<p>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.</p>" 501 }, 502 "ExternalId":{ 503 "shape":"ExternalId", 504 "documentation":"<p>The external ID from <code>IamRoleArn</code>, if present.</p>" 505 }, 506 "SubscriptionType":{"shape":"SubscriptionType"}, 507 "ClientToken":{ 508 "shape":"ClientToken", 509 "documentation":"<p>A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.</p>" 510 }, 511 "SyslogIp":{ 512 "shape":"IpAddress", 513 "documentation":"<p>The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>" 514 } 515 }, 516 "documentation":"<p>Contains the inputs for the <code>CreateHsm</code> operation.</p>" 517 }, 518 "CreateHsmResponse":{ 519 "type":"structure", 520 "members":{ 521 "HsmArn":{ 522 "shape":"HsmArn", 523 "documentation":"<p>The ARN of the HSM.</p>" 524 } 525 }, 526 "documentation":"<p>Contains the output of the <code>CreateHsm</code> operation.</p>" 527 }, 528 "CreateLunaClientRequest":{ 529 "type":"structure", 530 "required":["Certificate"], 531 "members":{ 532 "Label":{ 533 "shape":"ClientLabel", 534 "documentation":"<p>The label for the client.</p>" 535 }, 536 "Certificate":{ 537 "shape":"Certificate", 538 "documentation":"<p>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.</p>" 539 } 540 }, 541 "documentation":"<p>Contains the inputs for the <a>CreateLunaClient</a> action.</p>" 542 }, 543 "CreateLunaClientResponse":{ 544 "type":"structure", 545 "members":{ 546 "ClientArn":{ 547 "shape":"ClientArn", 548 "documentation":"<p>The ARN of the client.</p>" 549 } 550 }, 551 "documentation":"<p>Contains the output of the <a>CreateLunaClient</a> action.</p>" 552 }, 553 "DeleteHapgRequest":{ 554 "type":"structure", 555 "required":["HapgArn"], 556 "members":{ 557 "HapgArn":{ 558 "shape":"HapgArn", 559 "documentation":"<p>The ARN of the high-availability partition group to delete.</p>" 560 } 561 }, 562 "documentation":"<p>Contains the inputs for the <a>DeleteHapg</a> action.</p>" 563 }, 564 "DeleteHapgResponse":{ 565 "type":"structure", 566 "required":["Status"], 567 "members":{ 568 "Status":{ 569 "shape":"String", 570 "documentation":"<p>The status of the action.</p>" 571 } 572 }, 573 "documentation":"<p>Contains the output of the <a>DeleteHapg</a> action.</p>" 574 }, 575 "DeleteHsmRequest":{ 576 "type":"structure", 577 "required":["HsmArn"], 578 "members":{ 579 "HsmArn":{ 580 "shape":"HsmArn", 581 "documentation":"<p>The ARN of the HSM to delete.</p>" 582 } 583 }, 584 "documentation":"<p>Contains the inputs for the <a>DeleteHsm</a> operation.</p>" 585 }, 586 "DeleteHsmResponse":{ 587 "type":"structure", 588 "required":["Status"], 589 "members":{ 590 "Status":{ 591 "shape":"String", 592 "documentation":"<p>The status of the operation.</p>" 593 } 594 }, 595 "documentation":"<p>Contains the output of the <a>DeleteHsm</a> operation.</p>" 596 }, 597 "DeleteLunaClientRequest":{ 598 "type":"structure", 599 "required":["ClientArn"], 600 "members":{ 601 "ClientArn":{ 602 "shape":"ClientArn", 603 "documentation":"<p>The ARN of the client to delete.</p>" 604 } 605 } 606 }, 607 "DeleteLunaClientResponse":{ 608 "type":"structure", 609 "required":["Status"], 610 "members":{ 611 "Status":{ 612 "shape":"String", 613 "documentation":"<p>The status of the action.</p>" 614 } 615 } 616 }, 617 "DescribeHapgRequest":{ 618 "type":"structure", 619 "required":["HapgArn"], 620 "members":{ 621 "HapgArn":{ 622 "shape":"HapgArn", 623 "documentation":"<p>The ARN of the high-availability partition group to describe.</p>" 624 } 625 }, 626 "documentation":"<p>Contains the inputs for the <a>DescribeHapg</a> action.</p>" 627 }, 628 "DescribeHapgResponse":{ 629 "type":"structure", 630 "members":{ 631 "HapgArn":{ 632 "shape":"HapgArn", 633 "documentation":"<p>The ARN of the high-availability partition group.</p>" 634 }, 635 "HapgSerial":{ 636 "shape":"String", 637 "documentation":"<p>The serial number of the high-availability partition group.</p>" 638 }, 639 "HsmsLastActionFailed":{ 640 "shape":"HsmList", 641 "documentation":"<p/>" 642 }, 643 "HsmsPendingDeletion":{ 644 "shape":"HsmList", 645 "documentation":"<p/>" 646 }, 647 "HsmsPendingRegistration":{ 648 "shape":"HsmList", 649 "documentation":"<p/>" 650 }, 651 "Label":{ 652 "shape":"Label", 653 "documentation":"<p>The label for the high-availability partition group.</p>" 654 }, 655 "LastModifiedTimestamp":{ 656 "shape":"Timestamp", 657 "documentation":"<p>The date and time the high-availability partition group was last modified.</p>" 658 }, 659 "PartitionSerialList":{ 660 "shape":"PartitionSerialList", 661 "documentation":"<p>The list of partition serial numbers that belong to the high-availability partition group.</p>" 662 }, 663 "State":{ 664 "shape":"CloudHsmObjectState", 665 "documentation":"<p>The state of the high-availability partition group.</p>" 666 } 667 }, 668 "documentation":"<p>Contains the output of the <a>DescribeHapg</a> action.</p>" 669 }, 670 "DescribeHsmRequest":{ 671 "type":"structure", 672 "members":{ 673 "HsmArn":{ 674 "shape":"HsmArn", 675 "documentation":"<p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.</p>" 676 }, 677 "HsmSerialNumber":{ 678 "shape":"HsmSerialNumber", 679 "documentation":"<p>The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.</p>" 680 } 681 }, 682 "documentation":"<p>Contains the inputs for the <a>DescribeHsm</a> operation.</p>" 683 }, 684 "DescribeHsmResponse":{ 685 "type":"structure", 686 "members":{ 687 "HsmArn":{ 688 "shape":"HsmArn", 689 "documentation":"<p>The ARN of the HSM.</p>" 690 }, 691 "Status":{ 692 "shape":"HsmStatus", 693 "documentation":"<p>The status of the HSM.</p>" 694 }, 695 "StatusDetails":{ 696 "shape":"String", 697 "documentation":"<p>Contains additional information about the status of the HSM.</p>" 698 }, 699 "AvailabilityZone":{ 700 "shape":"AZ", 701 "documentation":"<p>The Availability Zone that the HSM is in.</p>" 702 }, 703 "EniId":{ 704 "shape":"EniId", 705 "documentation":"<p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>" 706 }, 707 "EniIp":{ 708 "shape":"IpAddress", 709 "documentation":"<p>The IP address assigned to the HSM's ENI.</p>" 710 }, 711 "SubscriptionType":{"shape":"SubscriptionType"}, 712 "SubscriptionStartDate":{ 713 "shape":"Timestamp", 714 "documentation":"<p>The subscription start date.</p>" 715 }, 716 "SubscriptionEndDate":{ 717 "shape":"Timestamp", 718 "documentation":"<p>The subscription end date.</p>" 719 }, 720 "VpcId":{ 721 "shape":"VpcId", 722 "documentation":"<p>The identifier of the VPC that the HSM is in.</p>" 723 }, 724 "SubnetId":{ 725 "shape":"SubnetId", 726 "documentation":"<p>The identifier of the subnet that the HSM is in.</p>" 727 }, 728 "IamRoleArn":{ 729 "shape":"IamRoleArn", 730 "documentation":"<p>The ARN of the IAM role assigned to the HSM.</p>" 731 }, 732 "SerialNumber":{ 733 "shape":"HsmSerialNumber", 734 "documentation":"<p>The serial number of the HSM.</p>" 735 }, 736 "VendorName":{ 737 "shape":"String", 738 "documentation":"<p>The name of the HSM vendor.</p>" 739 }, 740 "HsmType":{ 741 "shape":"String", 742 "documentation":"<p>The HSM model type.</p>" 743 }, 744 "SoftwareVersion":{ 745 "shape":"String", 746 "documentation":"<p>The HSM software version.</p>" 747 }, 748 "SshPublicKey":{ 749 "shape":"SshKey", 750 "documentation":"<p>The public SSH key.</p>" 751 }, 752 "SshKeyLastUpdated":{ 753 "shape":"Timestamp", 754 "documentation":"<p>The date and time that the SSH key was last updated.</p>" 755 }, 756 "ServerCertUri":{ 757 "shape":"String", 758 "documentation":"<p>The URI of the certificate server.</p>" 759 }, 760 "ServerCertLastUpdated":{ 761 "shape":"Timestamp", 762 "documentation":"<p>The date and time that the server certificate was last updated.</p>" 763 }, 764 "Partitions":{ 765 "shape":"PartitionList", 766 "documentation":"<p>The list of partitions on the HSM.</p>" 767 } 768 }, 769 "documentation":"<p>Contains the output of the <a>DescribeHsm</a> operation.</p>" 770 }, 771 "DescribeLunaClientRequest":{ 772 "type":"structure", 773 "members":{ 774 "ClientArn":{ 775 "shape":"ClientArn", 776 "documentation":"<p>The ARN of the client.</p>" 777 }, 778 "CertificateFingerprint":{ 779 "shape":"CertificateFingerprint", 780 "documentation":"<p>The certificate fingerprint.</p>" 781 } 782 } 783 }, 784 "DescribeLunaClientResponse":{ 785 "type":"structure", 786 "members":{ 787 "ClientArn":{ 788 "shape":"ClientArn", 789 "documentation":"<p>The ARN of the client.</p>" 790 }, 791 "Certificate":{ 792 "shape":"Certificate", 793 "documentation":"<p>The certificate installed on the HSMs used by this client.</p>" 794 }, 795 "CertificateFingerprint":{ 796 "shape":"CertificateFingerprint", 797 "documentation":"<p>The certificate fingerprint.</p>" 798 }, 799 "LastModifiedTimestamp":{ 800 "shape":"Timestamp", 801 "documentation":"<p>The date and time the client was last modified.</p>" 802 }, 803 "Label":{ 804 "shape":"Label", 805 "documentation":"<p>The label of the client.</p>" 806 } 807 } 808 }, 809 "EniId":{ 810 "type":"string", 811 "pattern":"eni-[0-9a-f]{8}" 812 }, 813 "ExternalId":{ 814 "type":"string", 815 "pattern":"[\\w :+=./-]*" 816 }, 817 "GetConfigRequest":{ 818 "type":"structure", 819 "required":[ 820 "ClientArn", 821 "ClientVersion", 822 "HapgList" 823 ], 824 "members":{ 825 "ClientArn":{ 826 "shape":"ClientArn", 827 "documentation":"<p>The ARN of the client.</p>" 828 }, 829 "ClientVersion":{ 830 "shape":"ClientVersion", 831 "documentation":"<p>The client version.</p>" 832 }, 833 "HapgList":{ 834 "shape":"HapgList", 835 "documentation":"<p>A list of ARNs that identify the high-availability partition groups that are associated with the client.</p>" 836 } 837 } 838 }, 839 "GetConfigResponse":{ 840 "type":"structure", 841 "members":{ 842 "ConfigType":{ 843 "shape":"String", 844 "documentation":"<p>The type of credentials.</p>" 845 }, 846 "ConfigFile":{ 847 "shape":"String", 848 "documentation":"<p>The chrystoki.conf configuration file.</p>" 849 }, 850 "ConfigCred":{ 851 "shape":"String", 852 "documentation":"<p>The certificate file containing the server.pem files of the HSMs.</p>" 853 } 854 } 855 }, 856 "HapgArn":{ 857 "type":"string", 858 "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}" 859 }, 860 "HapgList":{ 861 "type":"list", 862 "member":{"shape":"HapgArn"} 863 }, 864 "HsmArn":{ 865 "type":"string", 866 "documentation":"<p>An ARN that identifies an HSM.</p>", 867 "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}" 868 }, 869 "HsmList":{ 870 "type":"list", 871 "member":{"shape":"HsmArn"}, 872 "documentation":"<p>Contains a list of ARNs that identify the HSMs.</p>" 873 }, 874 "HsmSerialNumber":{ 875 "type":"string", 876 "pattern":"\\d{1,16}" 877 }, 878 "HsmStatus":{ 879 "type":"string", 880 "enum":[ 881 "PENDING", 882 "RUNNING", 883 "UPDATING", 884 "SUSPENDED", 885 "TERMINATING", 886 "TERMINATED", 887 "DEGRADED" 888 ] 889 }, 890 "IamRoleArn":{ 891 "type":"string", 892 "pattern":"arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}" 893 }, 894 "InvalidRequestException":{ 895 "type":"structure", 896 "members":{ 897 }, 898 "documentation":"<p>Indicates that one or more of the request parameters are not valid.</p>", 899 "exception":true 900 }, 901 "IpAddress":{ 902 "type":"string", 903 "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" 904 }, 905 "Label":{ 906 "type":"string", 907 "pattern":"[a-zA-Z0-9_.-]{1,64}" 908 }, 909 "ListAvailableZonesRequest":{ 910 "type":"structure", 911 "members":{ 912 }, 913 "documentation":"<p>Contains the inputs for the <a>ListAvailableZones</a> action.</p>" 914 }, 915 "ListAvailableZonesResponse":{ 916 "type":"structure", 917 "members":{ 918 "AZList":{ 919 "shape":"AZList", 920 "documentation":"<p>The list of Availability Zones that have available AWS CloudHSM capacity.</p>" 921 } 922 } 923 }, 924 "ListHapgsRequest":{ 925 "type":"structure", 926 "members":{ 927 "NextToken":{ 928 "shape":"PaginationToken", 929 "documentation":"<p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass null if this is the first call.</p>" 930 } 931 } 932 }, 933 "ListHapgsResponse":{ 934 "type":"structure", 935 "required":["HapgList"], 936 "members":{ 937 "HapgList":{ 938 "shape":"HapgList", 939 "documentation":"<p>The list of high-availability partition groups.</p>" 940 }, 941 "NextToken":{ 942 "shape":"PaginationToken", 943 "documentation":"<p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to retrieve the next set of items.</p>" 944 } 945 } 946 }, 947 "ListHsmsRequest":{ 948 "type":"structure", 949 "members":{ 950 "NextToken":{ 951 "shape":"PaginationToken", 952 "documentation":"<p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass null if this is the first call.</p>" 953 } 954 } 955 }, 956 "ListHsmsResponse":{ 957 "type":"structure", 958 "members":{ 959 "HsmList":{ 960 "shape":"HsmList", 961 "documentation":"<p>The list of ARNs that identify the HSMs.</p>" 962 }, 963 "NextToken":{ 964 "shape":"PaginationToken", 965 "documentation":"<p>If not null, more results are available. Pass this value to <code>ListHsms</code> to retrieve the next set of items.</p>" 966 } 967 }, 968 "documentation":"<p>Contains the output of the <code>ListHsms</code> operation.</p>" 969 }, 970 "ListLunaClientsRequest":{ 971 "type":"structure", 972 "members":{ 973 "NextToken":{ 974 "shape":"PaginationToken", 975 "documentation":"<p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>. Pass null if this is the first call.</p>" 976 } 977 } 978 }, 979 "ListLunaClientsResponse":{ 980 "type":"structure", 981 "required":["ClientList"], 982 "members":{ 983 "ClientList":{ 984 "shape":"ClientList", 985 "documentation":"<p>The list of clients.</p>" 986 }, 987 "NextToken":{ 988 "shape":"PaginationToken", 989 "documentation":"<p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to retrieve the next set of items.</p>" 990 } 991 } 992 }, 993 "ListTagsForResourceRequest":{ 994 "type":"structure", 995 "required":["ResourceArn"], 996 "members":{ 997 "ResourceArn":{ 998 "shape":"String", 999 "documentation":"<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>" 1000 } 1001 } 1002 }, 1003 "ListTagsForResourceResponse":{ 1004 "type":"structure", 1005 "required":["TagList"], 1006 "members":{ 1007 "TagList":{ 1008 "shape":"TagList", 1009 "documentation":"<p>One or more tags.</p>" 1010 } 1011 } 1012 }, 1013 "ModifyHapgRequest":{ 1014 "type":"structure", 1015 "required":["HapgArn"], 1016 "members":{ 1017 "HapgArn":{ 1018 "shape":"HapgArn", 1019 "documentation":"<p>The ARN of the high-availability partition group to modify.</p>" 1020 }, 1021 "Label":{ 1022 "shape":"Label", 1023 "documentation":"<p>The new label for the high-availability partition group.</p>" 1024 }, 1025 "PartitionSerialList":{ 1026 "shape":"PartitionSerialList", 1027 "documentation":"<p>The list of partition serial numbers to make members of the high-availability partition group.</p>" 1028 } 1029 } 1030 }, 1031 "ModifyHapgResponse":{ 1032 "type":"structure", 1033 "members":{ 1034 "HapgArn":{ 1035 "shape":"HapgArn", 1036 "documentation":"<p>The ARN of the high-availability partition group.</p>" 1037 } 1038 } 1039 }, 1040 "ModifyHsmRequest":{ 1041 "type":"structure", 1042 "required":["HsmArn"], 1043 "members":{ 1044 "HsmArn":{ 1045 "shape":"HsmArn", 1046 "documentation":"<p>The ARN of the HSM to modify.</p>" 1047 }, 1048 "SubnetId":{ 1049 "shape":"SubnetId", 1050 "documentation":"<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>" 1051 }, 1052 "EniIp":{ 1053 "shape":"IpAddress", 1054 "documentation":"<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>" 1055 }, 1056 "IamRoleArn":{ 1057 "shape":"IamRoleArn", 1058 "documentation":"<p>The new IAM role ARN.</p>" 1059 }, 1060 "ExternalId":{ 1061 "shape":"ExternalId", 1062 "documentation":"<p>The new external ID.</p>" 1063 }, 1064 "SyslogIp":{ 1065 "shape":"IpAddress", 1066 "documentation":"<p>The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>" 1067 } 1068 }, 1069 "documentation":"<p>Contains the inputs for the <a>ModifyHsm</a> operation.</p>" 1070 }, 1071 "ModifyHsmResponse":{ 1072 "type":"structure", 1073 "members":{ 1074 "HsmArn":{ 1075 "shape":"HsmArn", 1076 "documentation":"<p>The ARN of the HSM.</p>" 1077 } 1078 }, 1079 "documentation":"<p>Contains the output of the <a>ModifyHsm</a> operation.</p>" 1080 }, 1081 "ModifyLunaClientRequest":{ 1082 "type":"structure", 1083 "required":[ 1084 "ClientArn", 1085 "Certificate" 1086 ], 1087 "members":{ 1088 "ClientArn":{ 1089 "shape":"ClientArn", 1090 "documentation":"<p>The ARN of the client.</p>" 1091 }, 1092 "Certificate":{ 1093 "shape":"Certificate", 1094 "documentation":"<p>The new certificate for the client.</p>" 1095 } 1096 } 1097 }, 1098 "ModifyLunaClientResponse":{ 1099 "type":"structure", 1100 "members":{ 1101 "ClientArn":{ 1102 "shape":"ClientArn", 1103 "documentation":"<p>The ARN of the client.</p>" 1104 } 1105 } 1106 }, 1107 "PaginationToken":{ 1108 "type":"string", 1109 "pattern":"[a-zA-Z0-9+/]*" 1110 }, 1111 "PartitionArn":{ 1112 "type":"string", 1113 "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}" 1114 }, 1115 "PartitionList":{ 1116 "type":"list", 1117 "member":{"shape":"PartitionArn"} 1118 }, 1119 "PartitionSerial":{ 1120 "type":"string", 1121 "pattern":"\\d{6,12}" 1122 }, 1123 "PartitionSerialList":{ 1124 "type":"list", 1125 "member":{"shape":"PartitionSerial"} 1126 }, 1127 "RemoveTagsFromResourceRequest":{ 1128 "type":"structure", 1129 "required":[ 1130 "ResourceArn", 1131 "TagKeyList" 1132 ], 1133 "members":{ 1134 "ResourceArn":{ 1135 "shape":"String", 1136 "documentation":"<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>" 1137 }, 1138 "TagKeyList":{ 1139 "shape":"TagKeyList", 1140 "documentation":"<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>" 1141 } 1142 } 1143 }, 1144 "RemoveTagsFromResourceResponse":{ 1145 "type":"structure", 1146 "required":["Status"], 1147 "members":{ 1148 "Status":{ 1149 "shape":"String", 1150 "documentation":"<p>The status of the operation.</p>" 1151 } 1152 } 1153 }, 1154 "SshKey":{ 1155 "type":"string", 1156 "pattern":"[a-zA-Z0-9+/= ._:\\\\@-]*" 1157 }, 1158 "String":{ 1159 "type":"string", 1160 "pattern":"[\\w :+=./\\\\-]*" 1161 }, 1162 "SubnetId":{ 1163 "type":"string", 1164 "pattern":"subnet-[0-9a-f]{8}" 1165 }, 1166 "SubscriptionType":{ 1167 "type":"string", 1168 "documentation":"<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>", 1169 "enum":["PRODUCTION"] 1170 }, 1171 "Tag":{ 1172 "type":"structure", 1173 "required":[ 1174 "Key", 1175 "Value" 1176 ], 1177 "members":{ 1178 "Key":{ 1179 "shape":"TagKey", 1180 "documentation":"<p>The key of the tag.</p>" 1181 }, 1182 "Value":{ 1183 "shape":"TagValue", 1184 "documentation":"<p>The value of the tag.</p>" 1185 } 1186 }, 1187 "documentation":"<p>A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.</p>" 1188 }, 1189 "TagKey":{ 1190 "type":"string", 1191 "max":128, 1192 "min":1 1193 }, 1194 "TagKeyList":{ 1195 "type":"list", 1196 "member":{"shape":"TagKey"} 1197 }, 1198 "TagList":{ 1199 "type":"list", 1200 "member":{"shape":"Tag"} 1201 }, 1202 "TagValue":{ 1203 "type":"string", 1204 "max":256, 1205 "min":0 1206 }, 1207 "Timestamp":{ 1208 "type":"string", 1209 "pattern":"\\d*" 1210 }, 1211 "VpcId":{ 1212 "type":"string", 1213 "pattern":"vpc-[0-9a-f]{8}" 1214 } 1215 }, 1216 "documentation":"<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>" 1217} 1218