1{ 2 "smithy": "1.0", 3 "metadata": { 4 "suppressions": [ 5 { 6 "id": "HttpMethodSemantics", 7 "namespace": "*" 8 }, 9 { 10 "id": "HttpResponseCodeSemantics", 11 "namespace": "*" 12 }, 13 { 14 "id": "PaginatedTrait", 15 "namespace": "*" 16 }, 17 { 18 "id": "HttpHeaderTrait", 19 "namespace": "*" 20 }, 21 { 22 "id": "HttpUriConflict", 23 "namespace": "*" 24 }, 25 { 26 "id": "Service", 27 "namespace": "*" 28 } 29 ] 30 }, 31 "shapes": { 32 "com.amazonaws.cloudhsm#AZ": { 33 "type": "string", 34 "traits": { 35 "smithy.api#pattern": "[a-zA-Z0-9\\-]*" 36 } 37 }, 38 "com.amazonaws.cloudhsm#AZList": { 39 "type": "list", 40 "member": { 41 "target": "com.amazonaws.cloudhsm#AZ" 42 } 43 }, 44 "com.amazonaws.cloudhsm#AddTagsToResource": { 45 "type": "operation", 46 "input": { 47 "target": "com.amazonaws.cloudhsm#AddTagsToResourceRequest" 48 }, 49 "output": { 50 "target": "com.amazonaws.cloudhsm#AddTagsToResourceResponse" 51 }, 52 "errors": [ 53 { 54 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 55 }, 56 { 57 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 58 }, 59 { 60 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 61 } 62 ], 63 "traits": { 64 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p>\n <p>Each tag consists of a key and a value. Tag keys must be unique to each\n resource.</p>" 65 } 66 }, 67 "com.amazonaws.cloudhsm#AddTagsToResourceRequest": { 68 "type": "structure", 69 "members": { 70 "ResourceArn": { 71 "target": "com.amazonaws.cloudhsm#String", 72 "traits": { 73 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>", 74 "smithy.api#required": {} 75 } 76 }, 77 "TagList": { 78 "target": "com.amazonaws.cloudhsm#TagList", 79 "traits": { 80 "smithy.api#documentation": "<p>One or more tags.</p>", 81 "smithy.api#required": {} 82 } 83 } 84 } 85 }, 86 "com.amazonaws.cloudhsm#AddTagsToResourceResponse": { 87 "type": "structure", 88 "members": { 89 "Status": { 90 "target": "com.amazonaws.cloudhsm#String", 91 "traits": { 92 "smithy.api#documentation": "<p>The status of the operation.</p>", 93 "smithy.api#required": {} 94 } 95 } 96 } 97 }, 98 "com.amazonaws.cloudhsm#Boolean": { 99 "type": "boolean" 100 }, 101 "com.amazonaws.cloudhsm#Certificate": { 102 "type": "string", 103 "traits": { 104 "smithy.api#length": { 105 "min": 600, 106 "max": 2400 107 }, 108 "smithy.api#pattern": "[\\w :+=./\\n-]*" 109 } 110 }, 111 "com.amazonaws.cloudhsm#CertificateFingerprint": { 112 "type": "string", 113 "traits": { 114 "smithy.api#pattern": "([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]" 115 } 116 }, 117 "com.amazonaws.cloudhsm#ClientArn": { 118 "type": "string", 119 "traits": { 120 "smithy.api#pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}" 121 } 122 }, 123 "com.amazonaws.cloudhsm#ClientLabel": { 124 "type": "string", 125 "traits": { 126 "smithy.api#pattern": "[a-zA-Z0-9_.-]{2,64}" 127 } 128 }, 129 "com.amazonaws.cloudhsm#ClientList": { 130 "type": "list", 131 "member": { 132 "target": "com.amazonaws.cloudhsm#ClientArn" 133 } 134 }, 135 "com.amazonaws.cloudhsm#ClientToken": { 136 "type": "string", 137 "traits": { 138 "smithy.api#pattern": "[a-zA-Z0-9]{1,64}" 139 } 140 }, 141 "com.amazonaws.cloudhsm#ClientVersion": { 142 "type": "string", 143 "traits": { 144 "smithy.api#enum": [ 145 { 146 "value": "5.1", 147 "name": "FIVE_ONE" 148 }, 149 { 150 "value": "5.3", 151 "name": "FIVE_THREE" 152 } 153 ] 154 } 155 }, 156 "com.amazonaws.cloudhsm#CloudHsmFrontendService": { 157 "type": "service", 158 "version": "2014-05-30", 159 "operations": [ 160 { 161 "target": "com.amazonaws.cloudhsm#AddTagsToResource" 162 }, 163 { 164 "target": "com.amazonaws.cloudhsm#CreateHapg" 165 }, 166 { 167 "target": "com.amazonaws.cloudhsm#CreateHsm" 168 }, 169 { 170 "target": "com.amazonaws.cloudhsm#CreateLunaClient" 171 }, 172 { 173 "target": "com.amazonaws.cloudhsm#DeleteHapg" 174 }, 175 { 176 "target": "com.amazonaws.cloudhsm#DeleteHsm" 177 }, 178 { 179 "target": "com.amazonaws.cloudhsm#DeleteLunaClient" 180 }, 181 { 182 "target": "com.amazonaws.cloudhsm#DescribeHapg" 183 }, 184 { 185 "target": "com.amazonaws.cloudhsm#DescribeHsm" 186 }, 187 { 188 "target": "com.amazonaws.cloudhsm#DescribeLunaClient" 189 }, 190 { 191 "target": "com.amazonaws.cloudhsm#GetConfig" 192 }, 193 { 194 "target": "com.amazonaws.cloudhsm#ListAvailableZones" 195 }, 196 { 197 "target": "com.amazonaws.cloudhsm#ListHapgs" 198 }, 199 { 200 "target": "com.amazonaws.cloudhsm#ListHsms" 201 }, 202 { 203 "target": "com.amazonaws.cloudhsm#ListLunaClients" 204 }, 205 { 206 "target": "com.amazonaws.cloudhsm#ListTagsForResource" 207 }, 208 { 209 "target": "com.amazonaws.cloudhsm#ModifyHapg" 210 }, 211 { 212 "target": "com.amazonaws.cloudhsm#ModifyHsm" 213 }, 214 { 215 "target": "com.amazonaws.cloudhsm#ModifyLunaClient" 216 }, 217 { 218 "target": "com.amazonaws.cloudhsm#RemoveTagsFromResource" 219 } 220 ], 221 "traits": { 222 "aws.api#service": { 223 "sdkId": "CloudHSM", 224 "arnNamespace": "cloudhsm", 225 "cloudFormationName": "CloudHSM", 226 "cloudTrailEventSource": "cloudhsm.amazonaws.com", 227 "endpointPrefix": "cloudhsm" 228 }, 229 "aws.auth#sigv4": { 230 "name": "cloudhsm" 231 }, 232 "aws.protocols#awsJson1_1": {}, 233 "smithy.api#documentation": "<fullname>AWS CloudHSM Service</fullname>\n <p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>", 234 "smithy.api#title": "Amazon CloudHSM" 235 } 236 }, 237 "com.amazonaws.cloudhsm#CloudHsmInternalException": { 238 "type": "structure", 239 "members": { 240 "message": { 241 "target": "com.amazonaws.cloudhsm#String", 242 "traits": { 243 "smithy.api#documentation": "<p>Additional information about the error.</p>" 244 } 245 }, 246 "retryable": { 247 "target": "com.amazonaws.cloudhsm#Boolean", 248 "traits": { 249 "smithy.api#documentation": "<p>Indicates if the action can be retried.</p>" 250 } 251 } 252 }, 253 "traits": { 254 "smithy.api#documentation": "<p>Indicates that an internal error occurred.</p>", 255 "smithy.api#error": "server" 256 } 257 }, 258 "com.amazonaws.cloudhsm#CloudHsmObjectState": { 259 "type": "string", 260 "traits": { 261 "smithy.api#enum": [ 262 { 263 "value": "READY", 264 "name": "READY" 265 }, 266 { 267 "value": "UPDATING", 268 "name": "UPDATING" 269 }, 270 { 271 "value": "DEGRADED", 272 "name": "DEGRADED" 273 } 274 ] 275 } 276 }, 277 "com.amazonaws.cloudhsm#CloudHsmServiceException": { 278 "type": "structure", 279 "members": { 280 "message": { 281 "target": "com.amazonaws.cloudhsm#String", 282 "traits": { 283 "smithy.api#documentation": "<p>Additional information about the error.</p>" 284 } 285 }, 286 "retryable": { 287 "target": "com.amazonaws.cloudhsm#Boolean", 288 "traits": { 289 "smithy.api#documentation": "<p>Indicates if the action can be retried.</p>" 290 } 291 } 292 }, 293 "traits": { 294 "smithy.api#documentation": "<p>Indicates that an exception occurred in the AWS CloudHSM service.</p>", 295 "smithy.api#error": "client" 296 } 297 }, 298 "com.amazonaws.cloudhsm#CreateHapg": { 299 "type": "operation", 300 "input": { 301 "target": "com.amazonaws.cloudhsm#CreateHapgRequest" 302 }, 303 "output": { 304 "target": "com.amazonaws.cloudhsm#CreateHapgResponse" 305 }, 306 "errors": [ 307 { 308 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 309 }, 310 { 311 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 312 }, 313 { 314 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 315 } 316 ], 317 "traits": { 318 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Creates a high-availability partition group. A high-availability partition group is a\n group of partitions that spans multiple physical HSMs.</p>" 319 } 320 }, 321 "com.amazonaws.cloudhsm#CreateHapgRequest": { 322 "type": "structure", 323 "members": { 324 "Label": { 325 "target": "com.amazonaws.cloudhsm#Label", 326 "traits": { 327 "smithy.api#documentation": "<p>The label of the new high-availability partition group.</p>", 328 "smithy.api#required": {} 329 } 330 } 331 }, 332 "traits": { 333 "smithy.api#documentation": "<p>Contains the inputs for the <a>CreateHapgRequest</a> action.</p>" 334 } 335 }, 336 "com.amazonaws.cloudhsm#CreateHapgResponse": { 337 "type": "structure", 338 "members": { 339 "HapgArn": { 340 "target": "com.amazonaws.cloudhsm#HapgArn", 341 "traits": { 342 "smithy.api#documentation": "<p>The ARN of the high-availability partition group.</p>" 343 } 344 } 345 }, 346 "traits": { 347 "smithy.api#documentation": "<p>Contains the output of the <a>CreateHAPartitionGroup</a> action.</p>" 348 } 349 }, 350 "com.amazonaws.cloudhsm#CreateHsm": { 351 "type": "operation", 352 "input": { 353 "target": "com.amazonaws.cloudhsm#CreateHsmRequest" 354 }, 355 "output": { 356 "target": "com.amazonaws.cloudhsm#CreateHsmResponse" 357 }, 358 "errors": [ 359 { 360 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 361 }, 362 { 363 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 364 }, 365 { 366 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 367 } 368 ], 369 "traits": { 370 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Creates an uninitialized HSM instance.</p>\n <p>There is an upfront fee charged for each HSM instance that you create with the\n <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a\n 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\n <b>Account and Billing Support</b>.</p>\n <important>\n <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the\n status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be\n initialized when the status changes to <code>RUNNING</code>.</p>\n </important>" 371 } 372 }, 373 "com.amazonaws.cloudhsm#CreateHsmRequest": { 374 "type": "structure", 375 "members": { 376 "SubnetId": { 377 "target": "com.amazonaws.cloudhsm#SubnetId", 378 "traits": { 379 "smithy.api#documentation": "<p>The identifier of the subnet in your VPC in which to place the HSM.</p>", 380 "smithy.api#required": {}, 381 "smithy.api#xmlName": "SubnetId" 382 } 383 }, 384 "SshKey": { 385 "target": "com.amazonaws.cloudhsm#SshKey", 386 "traits": { 387 "smithy.api#documentation": "<p>The SSH public key to install on the HSM.</p>", 388 "smithy.api#required": {}, 389 "smithy.api#xmlName": "SshKey" 390 } 391 }, 392 "EniIp": { 393 "target": "com.amazonaws.cloudhsm#IpAddress", 394 "traits": { 395 "smithy.api#documentation": "<p>The IP address to assign to the HSM's ENI.</p>\n <p>If an IP address is not specified, an IP address will be randomly chosen from the CIDR\n range of the subnet.</p>", 396 "smithy.api#xmlName": "EniIp" 397 } 398 }, 399 "IamRoleArn": { 400 "target": "com.amazonaws.cloudhsm#IamRoleArn", 401 "traits": { 402 "smithy.api#documentation": "<p>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your\n behalf.</p>", 403 "smithy.api#required": {}, 404 "smithy.api#xmlName": "IamRoleArn" 405 } 406 }, 407 "ExternalId": { 408 "target": "com.amazonaws.cloudhsm#ExternalId", 409 "traits": { 410 "smithy.api#documentation": "<p>The external ID from <code>IamRoleArn</code>, if present.</p>", 411 "smithy.api#xmlName": "ExternalId" 412 } 413 }, 414 "SubscriptionType": { 415 "target": "com.amazonaws.cloudhsm#SubscriptionType", 416 "traits": { 417 "smithy.api#required": {}, 418 "smithy.api#xmlName": "SubscriptionType" 419 } 420 }, 421 "ClientToken": { 422 "target": "com.amazonaws.cloudhsm#ClientToken", 423 "traits": { 424 "smithy.api#documentation": "<p>A user-defined token to ensure idempotence. Subsequent calls to this operation with the\n same token will be ignored.</p>", 425 "smithy.api#xmlName": "ClientToken" 426 } 427 }, 428 "SyslogIp": { 429 "target": "com.amazonaws.cloudhsm#IpAddress", 430 "traits": { 431 "smithy.api#documentation": "<p>The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one\n syslog monitoring server.</p>", 432 "smithy.api#xmlName": "SyslogIp" 433 } 434 } 435 }, 436 "traits": { 437 "smithy.api#documentation": "<p>Contains the inputs for the <code>CreateHsm</code> operation.</p>", 438 "smithy.api#xmlName": "CreateHsmRequest" 439 } 440 }, 441 "com.amazonaws.cloudhsm#CreateHsmResponse": { 442 "type": "structure", 443 "members": { 444 "HsmArn": { 445 "target": "com.amazonaws.cloudhsm#HsmArn", 446 "traits": { 447 "smithy.api#documentation": "<p>The ARN of the HSM.</p>" 448 } 449 } 450 }, 451 "traits": { 452 "smithy.api#documentation": "<p>Contains the output of the <code>CreateHsm</code> operation.</p>" 453 } 454 }, 455 "com.amazonaws.cloudhsm#CreateLunaClient": { 456 "type": "operation", 457 "input": { 458 "target": "com.amazonaws.cloudhsm#CreateLunaClientRequest" 459 }, 460 "output": { 461 "target": "com.amazonaws.cloudhsm#CreateLunaClientResponse" 462 }, 463 "errors": [ 464 { 465 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 466 }, 467 { 468 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 469 }, 470 { 471 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 472 } 473 ], 474 "traits": { 475 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Creates an HSM client.</p>" 476 } 477 }, 478 "com.amazonaws.cloudhsm#CreateLunaClientRequest": { 479 "type": "structure", 480 "members": { 481 "Label": { 482 "target": "com.amazonaws.cloudhsm#ClientLabel", 483 "traits": { 484 "smithy.api#documentation": "<p>The label for the client.</p>" 485 } 486 }, 487 "Certificate": { 488 "target": "com.amazonaws.cloudhsm#Certificate", 489 "traits": { 490 "smithy.api#documentation": "<p>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used\n by this client.</p>", 491 "smithy.api#required": {} 492 } 493 } 494 }, 495 "traits": { 496 "smithy.api#documentation": "<p>Contains the inputs for the <a>CreateLunaClient</a> action.</p>" 497 } 498 }, 499 "com.amazonaws.cloudhsm#CreateLunaClientResponse": { 500 "type": "structure", 501 "members": { 502 "ClientArn": { 503 "target": "com.amazonaws.cloudhsm#ClientArn", 504 "traits": { 505 "smithy.api#documentation": "<p>The ARN of the client.</p>" 506 } 507 } 508 }, 509 "traits": { 510 "smithy.api#documentation": "<p>Contains the output of the <a>CreateLunaClient</a> action.</p>" 511 } 512 }, 513 "com.amazonaws.cloudhsm#DeleteHapg": { 514 "type": "operation", 515 "input": { 516 "target": "com.amazonaws.cloudhsm#DeleteHapgRequest" 517 }, 518 "output": { 519 "target": "com.amazonaws.cloudhsm#DeleteHapgResponse" 520 }, 521 "errors": [ 522 { 523 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 524 }, 525 { 526 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 527 }, 528 { 529 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 530 } 531 ], 532 "traits": { 533 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Deletes a high-availability partition group.</p>" 534 } 535 }, 536 "com.amazonaws.cloudhsm#DeleteHapgRequest": { 537 "type": "structure", 538 "members": { 539 "HapgArn": { 540 "target": "com.amazonaws.cloudhsm#HapgArn", 541 "traits": { 542 "smithy.api#documentation": "<p>The ARN of the high-availability partition group to delete.</p>", 543 "smithy.api#required": {} 544 } 545 } 546 }, 547 "traits": { 548 "smithy.api#documentation": "<p>Contains the inputs for the <a>DeleteHapg</a> action.</p>" 549 } 550 }, 551 "com.amazonaws.cloudhsm#DeleteHapgResponse": { 552 "type": "structure", 553 "members": { 554 "Status": { 555 "target": "com.amazonaws.cloudhsm#String", 556 "traits": { 557 "smithy.api#documentation": "<p>The status of the action.</p>", 558 "smithy.api#required": {} 559 } 560 } 561 }, 562 "traits": { 563 "smithy.api#documentation": "<p>Contains the output of the <a>DeleteHapg</a> action.</p>" 564 } 565 }, 566 "com.amazonaws.cloudhsm#DeleteHsm": { 567 "type": "operation", 568 "input": { 569 "target": "com.amazonaws.cloudhsm#DeleteHsmRequest" 570 }, 571 "output": { 572 "target": "com.amazonaws.cloudhsm#DeleteHsmResponse" 573 }, 574 "errors": [ 575 { 576 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 577 }, 578 { 579 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 580 }, 581 { 582 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 583 } 584 ], 585 "traits": { 586 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Deletes an HSM. After completion, this operation cannot be undone and your key material\n cannot be recovered.</p>" 587 } 588 }, 589 "com.amazonaws.cloudhsm#DeleteHsmRequest": { 590 "type": "structure", 591 "members": { 592 "HsmArn": { 593 "target": "com.amazonaws.cloudhsm#HsmArn", 594 "traits": { 595 "smithy.api#documentation": "<p>The ARN of the HSM to delete.</p>", 596 "smithy.api#required": {}, 597 "smithy.api#xmlName": "HsmArn" 598 } 599 } 600 }, 601 "traits": { 602 "smithy.api#documentation": "<p>Contains the inputs for the <a>DeleteHsm</a> operation.</p>", 603 "smithy.api#xmlName": "DeleteHsmRequest" 604 } 605 }, 606 "com.amazonaws.cloudhsm#DeleteHsmResponse": { 607 "type": "structure", 608 "members": { 609 "Status": { 610 "target": "com.amazonaws.cloudhsm#String", 611 "traits": { 612 "smithy.api#documentation": "<p>The status of the operation.</p>", 613 "smithy.api#required": {} 614 } 615 } 616 }, 617 "traits": { 618 "smithy.api#documentation": "<p>Contains the output of the <a>DeleteHsm</a> operation.</p>" 619 } 620 }, 621 "com.amazonaws.cloudhsm#DeleteLunaClient": { 622 "type": "operation", 623 "input": { 624 "target": "com.amazonaws.cloudhsm#DeleteLunaClientRequest" 625 }, 626 "output": { 627 "target": "com.amazonaws.cloudhsm#DeleteLunaClientResponse" 628 }, 629 "errors": [ 630 { 631 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 632 }, 633 { 634 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 635 }, 636 { 637 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 638 } 639 ], 640 "traits": { 641 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Deletes a client.</p>" 642 } 643 }, 644 "com.amazonaws.cloudhsm#DeleteLunaClientRequest": { 645 "type": "structure", 646 "members": { 647 "ClientArn": { 648 "target": "com.amazonaws.cloudhsm#ClientArn", 649 "traits": { 650 "smithy.api#documentation": "<p>The ARN of the client to delete.</p>", 651 "smithy.api#required": {} 652 } 653 } 654 } 655 }, 656 "com.amazonaws.cloudhsm#DeleteLunaClientResponse": { 657 "type": "structure", 658 "members": { 659 "Status": { 660 "target": "com.amazonaws.cloudhsm#String", 661 "traits": { 662 "smithy.api#documentation": "<p>The status of the action.</p>", 663 "smithy.api#required": {} 664 } 665 } 666 } 667 }, 668 "com.amazonaws.cloudhsm#DescribeHapg": { 669 "type": "operation", 670 "input": { 671 "target": "com.amazonaws.cloudhsm#DescribeHapgRequest" 672 }, 673 "output": { 674 "target": "com.amazonaws.cloudhsm#DescribeHapgResponse" 675 }, 676 "errors": [ 677 { 678 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 679 }, 680 { 681 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 682 }, 683 { 684 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 685 } 686 ], 687 "traits": { 688 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Retrieves information about a high-availability partition group.</p>" 689 } 690 }, 691 "com.amazonaws.cloudhsm#DescribeHapgRequest": { 692 "type": "structure", 693 "members": { 694 "HapgArn": { 695 "target": "com.amazonaws.cloudhsm#HapgArn", 696 "traits": { 697 "smithy.api#documentation": "<p>The ARN of the high-availability partition group to describe.</p>", 698 "smithy.api#required": {} 699 } 700 } 701 }, 702 "traits": { 703 "smithy.api#documentation": "<p>Contains the inputs for the <a>DescribeHapg</a> action.</p>" 704 } 705 }, 706 "com.amazonaws.cloudhsm#DescribeHapgResponse": { 707 "type": "structure", 708 "members": { 709 "HapgArn": { 710 "target": "com.amazonaws.cloudhsm#HapgArn", 711 "traits": { 712 "smithy.api#documentation": "<p>The ARN of the high-availability partition group.</p>" 713 } 714 }, 715 "HapgSerial": { 716 "target": "com.amazonaws.cloudhsm#String", 717 "traits": { 718 "smithy.api#documentation": "<p>The serial number of the high-availability partition group.</p>" 719 } 720 }, 721 "HsmsLastActionFailed": { 722 "target": "com.amazonaws.cloudhsm#HsmList", 723 "traits": { 724 "smithy.api#documentation": "<p></p>" 725 } 726 }, 727 "HsmsPendingDeletion": { 728 "target": "com.amazonaws.cloudhsm#HsmList", 729 "traits": { 730 "smithy.api#documentation": "<p></p>" 731 } 732 }, 733 "HsmsPendingRegistration": { 734 "target": "com.amazonaws.cloudhsm#HsmList", 735 "traits": { 736 "smithy.api#documentation": "<p></p>" 737 } 738 }, 739 "Label": { 740 "target": "com.amazonaws.cloudhsm#Label", 741 "traits": { 742 "smithy.api#documentation": "<p>The label for the high-availability partition group.</p>" 743 } 744 }, 745 "LastModifiedTimestamp": { 746 "target": "com.amazonaws.cloudhsm#Timestamp", 747 "traits": { 748 "smithy.api#documentation": "<p>The date and time the high-availability partition group was last modified.</p>" 749 } 750 }, 751 "PartitionSerialList": { 752 "target": "com.amazonaws.cloudhsm#PartitionSerialList", 753 "traits": { 754 "smithy.api#documentation": "<p>The list of partition serial numbers that belong to the high-availability partition\n group.</p>" 755 } 756 }, 757 "State": { 758 "target": "com.amazonaws.cloudhsm#CloudHsmObjectState", 759 "traits": { 760 "smithy.api#documentation": "<p>The state of the high-availability partition group.</p>" 761 } 762 } 763 }, 764 "traits": { 765 "smithy.api#documentation": "<p>Contains the output of the <a>DescribeHapg</a> action.</p>" 766 } 767 }, 768 "com.amazonaws.cloudhsm#DescribeHsm": { 769 "type": "operation", 770 "input": { 771 "target": "com.amazonaws.cloudhsm#DescribeHsmRequest" 772 }, 773 "output": { 774 "target": "com.amazonaws.cloudhsm#DescribeHsmResponse" 775 }, 776 "errors": [ 777 { 778 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 779 }, 780 { 781 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 782 }, 783 { 784 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 785 } 786 ], 787 "traits": { 788 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial\n number.</p>" 789 } 790 }, 791 "com.amazonaws.cloudhsm#DescribeHsmRequest": { 792 "type": "structure", 793 "members": { 794 "HsmArn": { 795 "target": "com.amazonaws.cloudhsm#HsmArn", 796 "traits": { 797 "smithy.api#documentation": "<p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code>\n parameter must be specified.</p>" 798 } 799 }, 800 "HsmSerialNumber": { 801 "target": "com.amazonaws.cloudhsm#HsmSerialNumber", 802 "traits": { 803 "smithy.api#documentation": "<p>The serial number of the HSM. Either the <code>HsmArn</code> or the\n <code>HsmSerialNumber</code> parameter must be specified.</p>" 804 } 805 } 806 }, 807 "traits": { 808 "smithy.api#documentation": "<p>Contains the inputs for the <a>DescribeHsm</a> operation.</p>" 809 } 810 }, 811 "com.amazonaws.cloudhsm#DescribeHsmResponse": { 812 "type": "structure", 813 "members": { 814 "HsmArn": { 815 "target": "com.amazonaws.cloudhsm#HsmArn", 816 "traits": { 817 "smithy.api#documentation": "<p>The ARN of the HSM.</p>" 818 } 819 }, 820 "Status": { 821 "target": "com.amazonaws.cloudhsm#HsmStatus", 822 "traits": { 823 "smithy.api#documentation": "<p>The status of the HSM.</p>" 824 } 825 }, 826 "StatusDetails": { 827 "target": "com.amazonaws.cloudhsm#String", 828 "traits": { 829 "smithy.api#documentation": "<p>Contains additional information about the status of the HSM.</p>" 830 } 831 }, 832 "AvailabilityZone": { 833 "target": "com.amazonaws.cloudhsm#AZ", 834 "traits": { 835 "smithy.api#documentation": "<p>The Availability Zone that the HSM is in.</p>" 836 } 837 }, 838 "EniId": { 839 "target": "com.amazonaws.cloudhsm#EniId", 840 "traits": { 841 "smithy.api#documentation": "<p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>" 842 } 843 }, 844 "EniIp": { 845 "target": "com.amazonaws.cloudhsm#IpAddress", 846 "traits": { 847 "smithy.api#documentation": "<p>The IP address assigned to the HSM's ENI.</p>" 848 } 849 }, 850 "SubscriptionType": { 851 "target": "com.amazonaws.cloudhsm#SubscriptionType" 852 }, 853 "SubscriptionStartDate": { 854 "target": "com.amazonaws.cloudhsm#Timestamp", 855 "traits": { 856 "smithy.api#documentation": "<p>The subscription start date.</p>" 857 } 858 }, 859 "SubscriptionEndDate": { 860 "target": "com.amazonaws.cloudhsm#Timestamp", 861 "traits": { 862 "smithy.api#documentation": "<p>The subscription end date.</p>" 863 } 864 }, 865 "VpcId": { 866 "target": "com.amazonaws.cloudhsm#VpcId", 867 "traits": { 868 "smithy.api#documentation": "<p>The identifier of the VPC that the HSM is in.</p>" 869 } 870 }, 871 "SubnetId": { 872 "target": "com.amazonaws.cloudhsm#SubnetId", 873 "traits": { 874 "smithy.api#documentation": "<p>The identifier of the subnet that the HSM is in.</p>" 875 } 876 }, 877 "IamRoleArn": { 878 "target": "com.amazonaws.cloudhsm#IamRoleArn", 879 "traits": { 880 "smithy.api#documentation": "<p>The ARN of the IAM role assigned to the HSM.</p>" 881 } 882 }, 883 "SerialNumber": { 884 "target": "com.amazonaws.cloudhsm#HsmSerialNumber", 885 "traits": { 886 "smithy.api#documentation": "<p>The serial number of the HSM.</p>" 887 } 888 }, 889 "VendorName": { 890 "target": "com.amazonaws.cloudhsm#String", 891 "traits": { 892 "smithy.api#documentation": "<p>The name of the HSM vendor.</p>" 893 } 894 }, 895 "HsmType": { 896 "target": "com.amazonaws.cloudhsm#String", 897 "traits": { 898 "smithy.api#documentation": "<p>The HSM model type.</p>" 899 } 900 }, 901 "SoftwareVersion": { 902 "target": "com.amazonaws.cloudhsm#String", 903 "traits": { 904 "smithy.api#documentation": "<p>The HSM software version.</p>" 905 } 906 }, 907 "SshPublicKey": { 908 "target": "com.amazonaws.cloudhsm#SshKey", 909 "traits": { 910 "smithy.api#documentation": "<p>The public SSH key.</p>" 911 } 912 }, 913 "SshKeyLastUpdated": { 914 "target": "com.amazonaws.cloudhsm#Timestamp", 915 "traits": { 916 "smithy.api#documentation": "<p>The date and time that the SSH key was last updated.</p>" 917 } 918 }, 919 "ServerCertUri": { 920 "target": "com.amazonaws.cloudhsm#String", 921 "traits": { 922 "smithy.api#documentation": "<p>The URI of the certificate server.</p>" 923 } 924 }, 925 "ServerCertLastUpdated": { 926 "target": "com.amazonaws.cloudhsm#Timestamp", 927 "traits": { 928 "smithy.api#documentation": "<p>The date and time that the server certificate was last updated.</p>" 929 } 930 }, 931 "Partitions": { 932 "target": "com.amazonaws.cloudhsm#PartitionList", 933 "traits": { 934 "smithy.api#documentation": "<p>The list of partitions on the HSM.</p>" 935 } 936 } 937 }, 938 "traits": { 939 "smithy.api#documentation": "<p>Contains the output of the <a>DescribeHsm</a> operation.</p>" 940 } 941 }, 942 "com.amazonaws.cloudhsm#DescribeLunaClient": { 943 "type": "operation", 944 "input": { 945 "target": "com.amazonaws.cloudhsm#DescribeLunaClientRequest" 946 }, 947 "output": { 948 "target": "com.amazonaws.cloudhsm#DescribeLunaClientResponse" 949 }, 950 "errors": [ 951 { 952 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 953 }, 954 { 955 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 956 }, 957 { 958 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 959 } 960 ], 961 "traits": { 962 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Retrieves information about an HSM client.</p>" 963 } 964 }, 965 "com.amazonaws.cloudhsm#DescribeLunaClientRequest": { 966 "type": "structure", 967 "members": { 968 "ClientArn": { 969 "target": "com.amazonaws.cloudhsm#ClientArn", 970 "traits": { 971 "smithy.api#documentation": "<p>The ARN of the client.</p>" 972 } 973 }, 974 "CertificateFingerprint": { 975 "target": "com.amazonaws.cloudhsm#CertificateFingerprint", 976 "traits": { 977 "smithy.api#documentation": "<p>The certificate fingerprint.</p>" 978 } 979 } 980 } 981 }, 982 "com.amazonaws.cloudhsm#DescribeLunaClientResponse": { 983 "type": "structure", 984 "members": { 985 "ClientArn": { 986 "target": "com.amazonaws.cloudhsm#ClientArn", 987 "traits": { 988 "smithy.api#documentation": "<p>The ARN of the client.</p>" 989 } 990 }, 991 "Certificate": { 992 "target": "com.amazonaws.cloudhsm#Certificate", 993 "traits": { 994 "smithy.api#documentation": "<p>The certificate installed on the HSMs used by this client.</p>" 995 } 996 }, 997 "CertificateFingerprint": { 998 "target": "com.amazonaws.cloudhsm#CertificateFingerprint", 999 "traits": { 1000 "smithy.api#documentation": "<p>The certificate fingerprint.</p>" 1001 } 1002 }, 1003 "LastModifiedTimestamp": { 1004 "target": "com.amazonaws.cloudhsm#Timestamp", 1005 "traits": { 1006 "smithy.api#documentation": "<p>The date and time the client was last modified.</p>" 1007 } 1008 }, 1009 "Label": { 1010 "target": "com.amazonaws.cloudhsm#Label", 1011 "traits": { 1012 "smithy.api#documentation": "<p>The label of the client.</p>" 1013 } 1014 } 1015 } 1016 }, 1017 "com.amazonaws.cloudhsm#EniId": { 1018 "type": "string", 1019 "traits": { 1020 "smithy.api#pattern": "eni-[0-9a-f]{8}" 1021 } 1022 }, 1023 "com.amazonaws.cloudhsm#ExternalId": { 1024 "type": "string", 1025 "traits": { 1026 "smithy.api#pattern": "[\\w :+=./-]*" 1027 } 1028 }, 1029 "com.amazonaws.cloudhsm#GetConfig": { 1030 "type": "operation", 1031 "input": { 1032 "target": "com.amazonaws.cloudhsm#GetConfigRequest" 1033 }, 1034 "output": { 1035 "target": "com.amazonaws.cloudhsm#GetConfigResponse" 1036 }, 1037 "errors": [ 1038 { 1039 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1040 }, 1041 { 1042 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1043 }, 1044 { 1045 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1046 } 1047 ], 1048 "traits": { 1049 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Gets the configuration files necessary to connect to all high availability partition\n groups the client is associated with.</p>" 1050 } 1051 }, 1052 "com.amazonaws.cloudhsm#GetConfigRequest": { 1053 "type": "structure", 1054 "members": { 1055 "ClientArn": { 1056 "target": "com.amazonaws.cloudhsm#ClientArn", 1057 "traits": { 1058 "smithy.api#documentation": "<p>The ARN of the client.</p>", 1059 "smithy.api#required": {} 1060 } 1061 }, 1062 "ClientVersion": { 1063 "target": "com.amazonaws.cloudhsm#ClientVersion", 1064 "traits": { 1065 "smithy.api#documentation": "<p>The client version.</p>", 1066 "smithy.api#required": {} 1067 } 1068 }, 1069 "HapgList": { 1070 "target": "com.amazonaws.cloudhsm#HapgList", 1071 "traits": { 1072 "smithy.api#documentation": "<p>A list of ARNs that identify the high-availability partition groups that are associated\n with the client.</p>", 1073 "smithy.api#required": {} 1074 } 1075 } 1076 } 1077 }, 1078 "com.amazonaws.cloudhsm#GetConfigResponse": { 1079 "type": "structure", 1080 "members": { 1081 "ConfigType": { 1082 "target": "com.amazonaws.cloudhsm#String", 1083 "traits": { 1084 "smithy.api#documentation": "<p>The type of credentials.</p>" 1085 } 1086 }, 1087 "ConfigFile": { 1088 "target": "com.amazonaws.cloudhsm#String", 1089 "traits": { 1090 "smithy.api#documentation": "<p>The chrystoki.conf configuration file.</p>" 1091 } 1092 }, 1093 "ConfigCred": { 1094 "target": "com.amazonaws.cloudhsm#String", 1095 "traits": { 1096 "smithy.api#documentation": "<p>The certificate file containing the server.pem files of the HSMs.</p>" 1097 } 1098 } 1099 } 1100 }, 1101 "com.amazonaws.cloudhsm#HapgArn": { 1102 "type": "string", 1103 "traits": { 1104 "smithy.api#pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}" 1105 } 1106 }, 1107 "com.amazonaws.cloudhsm#HapgList": { 1108 "type": "list", 1109 "member": { 1110 "target": "com.amazonaws.cloudhsm#HapgArn" 1111 } 1112 }, 1113 "com.amazonaws.cloudhsm#HsmArn": { 1114 "type": "string", 1115 "traits": { 1116 "smithy.api#documentation": "<p>An ARN that identifies an HSM.</p>", 1117 "smithy.api#pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}" 1118 } 1119 }, 1120 "com.amazonaws.cloudhsm#HsmList": { 1121 "type": "list", 1122 "member": { 1123 "target": "com.amazonaws.cloudhsm#HsmArn" 1124 }, 1125 "traits": { 1126 "smithy.api#documentation": "<p>Contains a list of ARNs that identify the HSMs.</p>" 1127 } 1128 }, 1129 "com.amazonaws.cloudhsm#HsmSerialNumber": { 1130 "type": "string", 1131 "traits": { 1132 "smithy.api#pattern": "\\d{1,16}" 1133 } 1134 }, 1135 "com.amazonaws.cloudhsm#HsmStatus": { 1136 "type": "string", 1137 "traits": { 1138 "smithy.api#enum": [ 1139 { 1140 "value": "PENDING", 1141 "name": "PENDING" 1142 }, 1143 { 1144 "value": "RUNNING", 1145 "name": "RUNNING" 1146 }, 1147 { 1148 "value": "UPDATING", 1149 "name": "UPDATING" 1150 }, 1151 { 1152 "value": "SUSPENDED", 1153 "name": "SUSPENDED" 1154 }, 1155 { 1156 "value": "TERMINATING", 1157 "name": "TERMINATING" 1158 }, 1159 { 1160 "value": "TERMINATED", 1161 "name": "TERMINATED" 1162 }, 1163 { 1164 "value": "DEGRADED", 1165 "name": "DEGRADED" 1166 } 1167 ] 1168 } 1169 }, 1170 "com.amazonaws.cloudhsm#IamRoleArn": { 1171 "type": "string", 1172 "traits": { 1173 "smithy.api#pattern": "arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}" 1174 } 1175 }, 1176 "com.amazonaws.cloudhsm#InvalidRequestException": { 1177 "type": "structure", 1178 "members": { 1179 "message": { 1180 "target": "com.amazonaws.cloudhsm#String", 1181 "traits": { 1182 "smithy.api#documentation": "<p>Additional information about the error.</p>" 1183 } 1184 }, 1185 "retryable": { 1186 "target": "com.amazonaws.cloudhsm#Boolean", 1187 "traits": { 1188 "smithy.api#documentation": "<p>Indicates if the action can be retried.</p>" 1189 } 1190 } 1191 }, 1192 "traits": { 1193 "smithy.api#documentation": "<p>Indicates that one or more of the request parameters are not valid.</p>", 1194 "smithy.api#error": "client" 1195 } 1196 }, 1197 "com.amazonaws.cloudhsm#IpAddress": { 1198 "type": "string", 1199 "traits": { 1200 "smithy.api#pattern": "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" 1201 } 1202 }, 1203 "com.amazonaws.cloudhsm#Label": { 1204 "type": "string", 1205 "traits": { 1206 "smithy.api#pattern": "[a-zA-Z0-9_.-]{1,64}" 1207 } 1208 }, 1209 "com.amazonaws.cloudhsm#ListAvailableZones": { 1210 "type": "operation", 1211 "input": { 1212 "target": "com.amazonaws.cloudhsm#ListAvailableZonesRequest" 1213 }, 1214 "output": { 1215 "target": "com.amazonaws.cloudhsm#ListAvailableZonesResponse" 1216 }, 1217 "errors": [ 1218 { 1219 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1220 }, 1221 { 1222 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1223 }, 1224 { 1225 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1226 } 1227 ], 1228 "traits": { 1229 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>" 1230 } 1231 }, 1232 "com.amazonaws.cloudhsm#ListAvailableZonesRequest": { 1233 "type": "structure", 1234 "members": {}, 1235 "traits": { 1236 "smithy.api#documentation": "<p>Contains the inputs for the <a>ListAvailableZones</a> action.</p>" 1237 } 1238 }, 1239 "com.amazonaws.cloudhsm#ListAvailableZonesResponse": { 1240 "type": "structure", 1241 "members": { 1242 "AZList": { 1243 "target": "com.amazonaws.cloudhsm#AZList", 1244 "traits": { 1245 "smithy.api#documentation": "<p>The list of Availability Zones that have available AWS CloudHSM capacity.</p>" 1246 } 1247 } 1248 } 1249 }, 1250 "com.amazonaws.cloudhsm#ListHapgs": { 1251 "type": "operation", 1252 "input": { 1253 "target": "com.amazonaws.cloudhsm#ListHapgsRequest" 1254 }, 1255 "output": { 1256 "target": "com.amazonaws.cloudhsm#ListHapgsResponse" 1257 }, 1258 "errors": [ 1259 { 1260 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1261 }, 1262 { 1263 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1264 }, 1265 { 1266 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1267 } 1268 ], 1269 "traits": { 1270 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Lists the high-availability partition groups for the account.</p>\n <p>This operation supports pagination with the use of the <code>NextToken</code> member.\n If more results are available, the <code>NextToken</code> member of the response contains a\n token that you pass in the next call to <code>ListHapgs</code> to retrieve the next set of\n items.</p>" 1271 } 1272 }, 1273 "com.amazonaws.cloudhsm#ListHapgsRequest": { 1274 "type": "structure", 1275 "members": { 1276 "NextToken": { 1277 "target": "com.amazonaws.cloudhsm#PaginationToken", 1278 "traits": { 1279 "smithy.api#documentation": "<p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass\n null if this is the first call.</p>" 1280 } 1281 } 1282 } 1283 }, 1284 "com.amazonaws.cloudhsm#ListHapgsResponse": { 1285 "type": "structure", 1286 "members": { 1287 "HapgList": { 1288 "target": "com.amazonaws.cloudhsm#HapgList", 1289 "traits": { 1290 "smithy.api#documentation": "<p>The list of high-availability partition groups.</p>", 1291 "smithy.api#required": {} 1292 } 1293 }, 1294 "NextToken": { 1295 "target": "com.amazonaws.cloudhsm#PaginationToken", 1296 "traits": { 1297 "smithy.api#documentation": "<p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to\n retrieve the next set of items.</p>" 1298 } 1299 } 1300 } 1301 }, 1302 "com.amazonaws.cloudhsm#ListHsms": { 1303 "type": "operation", 1304 "input": { 1305 "target": "com.amazonaws.cloudhsm#ListHsmsRequest" 1306 }, 1307 "output": { 1308 "target": "com.amazonaws.cloudhsm#ListHsmsResponse" 1309 }, 1310 "errors": [ 1311 { 1312 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1313 }, 1314 { 1315 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1316 }, 1317 { 1318 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1319 } 1320 ], 1321 "traits": { 1322 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Retrieves the identifiers of all of the HSMs provisioned for the current\n customer.</p>\n <p>This operation supports pagination with the use of the <code>NextToken</code> member.\n If more results are available, the <code>NextToken</code> member of the response contains a\n token that you pass in the next call to <code>ListHsms</code> to retrieve the next set of\n items.</p>" 1323 } 1324 }, 1325 "com.amazonaws.cloudhsm#ListHsmsRequest": { 1326 "type": "structure", 1327 "members": { 1328 "NextToken": { 1329 "target": "com.amazonaws.cloudhsm#PaginationToken", 1330 "traits": { 1331 "smithy.api#documentation": "<p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass\n null if this is the first call.</p>" 1332 } 1333 } 1334 } 1335 }, 1336 "com.amazonaws.cloudhsm#ListHsmsResponse": { 1337 "type": "structure", 1338 "members": { 1339 "HsmList": { 1340 "target": "com.amazonaws.cloudhsm#HsmList", 1341 "traits": { 1342 "smithy.api#documentation": "<p>The list of ARNs that identify the HSMs.</p>" 1343 } 1344 }, 1345 "NextToken": { 1346 "target": "com.amazonaws.cloudhsm#PaginationToken", 1347 "traits": { 1348 "smithy.api#documentation": "<p>If not null, more results are available. Pass this value to <code>ListHsms</code> to\n retrieve the next set of items.</p>" 1349 } 1350 } 1351 }, 1352 "traits": { 1353 "smithy.api#documentation": "<p>Contains the output of the <code>ListHsms</code> operation.</p>" 1354 } 1355 }, 1356 "com.amazonaws.cloudhsm#ListLunaClients": { 1357 "type": "operation", 1358 "input": { 1359 "target": "com.amazonaws.cloudhsm#ListLunaClientsRequest" 1360 }, 1361 "output": { 1362 "target": "com.amazonaws.cloudhsm#ListLunaClientsResponse" 1363 }, 1364 "errors": [ 1365 { 1366 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1367 }, 1368 { 1369 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1370 }, 1371 { 1372 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1373 } 1374 ], 1375 "traits": { 1376 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Lists all of the clients.</p>\n <p>This operation supports pagination with the use of the <code>NextToken</code> member.\n If more results are available, the <code>NextToken</code> member of the response contains a\n token that you pass in the next call to <code>ListLunaClients</code> to retrieve the next set\n of items.</p>" 1377 } 1378 }, 1379 "com.amazonaws.cloudhsm#ListLunaClientsRequest": { 1380 "type": "structure", 1381 "members": { 1382 "NextToken": { 1383 "target": "com.amazonaws.cloudhsm#PaginationToken", 1384 "traits": { 1385 "smithy.api#documentation": "<p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>.\n Pass null if this is the first call.</p>" 1386 } 1387 } 1388 } 1389 }, 1390 "com.amazonaws.cloudhsm#ListLunaClientsResponse": { 1391 "type": "structure", 1392 "members": { 1393 "ClientList": { 1394 "target": "com.amazonaws.cloudhsm#ClientList", 1395 "traits": { 1396 "smithy.api#documentation": "<p>The list of clients.</p>", 1397 "smithy.api#required": {} 1398 } 1399 }, 1400 "NextToken": { 1401 "target": "com.amazonaws.cloudhsm#PaginationToken", 1402 "traits": { 1403 "smithy.api#documentation": "<p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to\n retrieve the next set of items.</p>" 1404 } 1405 } 1406 } 1407 }, 1408 "com.amazonaws.cloudhsm#ListTagsForResource": { 1409 "type": "operation", 1410 "input": { 1411 "target": "com.amazonaws.cloudhsm#ListTagsForResourceRequest" 1412 }, 1413 "output": { 1414 "target": "com.amazonaws.cloudhsm#ListTagsForResourceResponse" 1415 }, 1416 "errors": [ 1417 { 1418 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1419 }, 1420 { 1421 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1422 }, 1423 { 1424 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1425 } 1426 ], 1427 "traits": { 1428 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>" 1429 } 1430 }, 1431 "com.amazonaws.cloudhsm#ListTagsForResourceRequest": { 1432 "type": "structure", 1433 "members": { 1434 "ResourceArn": { 1435 "target": "com.amazonaws.cloudhsm#String", 1436 "traits": { 1437 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>", 1438 "smithy.api#required": {} 1439 } 1440 } 1441 } 1442 }, 1443 "com.amazonaws.cloudhsm#ListTagsForResourceResponse": { 1444 "type": "structure", 1445 "members": { 1446 "TagList": { 1447 "target": "com.amazonaws.cloudhsm#TagList", 1448 "traits": { 1449 "smithy.api#documentation": "<p>One or more tags.</p>", 1450 "smithy.api#required": {} 1451 } 1452 } 1453 } 1454 }, 1455 "com.amazonaws.cloudhsm#ModifyHapg": { 1456 "type": "operation", 1457 "input": { 1458 "target": "com.amazonaws.cloudhsm#ModifyHapgRequest" 1459 }, 1460 "output": { 1461 "target": "com.amazonaws.cloudhsm#ModifyHapgResponse" 1462 }, 1463 "errors": [ 1464 { 1465 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1466 }, 1467 { 1468 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1469 }, 1470 { 1471 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1472 } 1473 ], 1474 "traits": { 1475 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Modifies an existing high-availability partition group.</p>" 1476 } 1477 }, 1478 "com.amazonaws.cloudhsm#ModifyHapgRequest": { 1479 "type": "structure", 1480 "members": { 1481 "HapgArn": { 1482 "target": "com.amazonaws.cloudhsm#HapgArn", 1483 "traits": { 1484 "smithy.api#documentation": "<p>The ARN of the high-availability partition group to modify.</p>", 1485 "smithy.api#required": {} 1486 } 1487 }, 1488 "Label": { 1489 "target": "com.amazonaws.cloudhsm#Label", 1490 "traits": { 1491 "smithy.api#documentation": "<p>The new label for the high-availability partition group.</p>" 1492 } 1493 }, 1494 "PartitionSerialList": { 1495 "target": "com.amazonaws.cloudhsm#PartitionSerialList", 1496 "traits": { 1497 "smithy.api#documentation": "<p>The list of partition serial numbers to make members of the high-availability partition\n group.</p>" 1498 } 1499 } 1500 } 1501 }, 1502 "com.amazonaws.cloudhsm#ModifyHapgResponse": { 1503 "type": "structure", 1504 "members": { 1505 "HapgArn": { 1506 "target": "com.amazonaws.cloudhsm#HapgArn", 1507 "traits": { 1508 "smithy.api#documentation": "<p>The ARN of the high-availability partition group.</p>" 1509 } 1510 } 1511 } 1512 }, 1513 "com.amazonaws.cloudhsm#ModifyHsm": { 1514 "type": "operation", 1515 "input": { 1516 "target": "com.amazonaws.cloudhsm#ModifyHsmRequest" 1517 }, 1518 "output": { 1519 "target": "com.amazonaws.cloudhsm#ModifyHsmResponse" 1520 }, 1521 "errors": [ 1522 { 1523 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1524 }, 1525 { 1526 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1527 }, 1528 { 1529 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1530 } 1531 ], 1532 "traits": { 1533 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Modifies an HSM.</p>\n <important>\n <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS\n CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure\n that your AWS CloudHSM service is configured for high availability, and consider executing this\n operation during a maintenance window.</p>\n </important>" 1534 } 1535 }, 1536 "com.amazonaws.cloudhsm#ModifyHsmRequest": { 1537 "type": "structure", 1538 "members": { 1539 "HsmArn": { 1540 "target": "com.amazonaws.cloudhsm#HsmArn", 1541 "traits": { 1542 "smithy.api#documentation": "<p>The ARN of the HSM to modify.</p>", 1543 "smithy.api#required": {}, 1544 "smithy.api#xmlName": "HsmArn" 1545 } 1546 }, 1547 "SubnetId": { 1548 "target": "com.amazonaws.cloudhsm#SubnetId", 1549 "traits": { 1550 "smithy.api#documentation": "<p>The new identifier of the subnet that the HSM is in. The new subnet must be in the same\n Availability Zone as the current subnet.</p>", 1551 "smithy.api#xmlName": "SubnetId" 1552 } 1553 }, 1554 "EniIp": { 1555 "target": "com.amazonaws.cloudhsm#IpAddress", 1556 "traits": { 1557 "smithy.api#documentation": "<p>The new IP address for the elastic network interface (ENI) attached to the\n HSM.</p>\n <p>If the HSM is moved to a different subnet, and an IP address is not specified, an IP\n address will be randomly chosen from the CIDR range of the new subnet.</p>", 1558 "smithy.api#xmlName": "EniIp" 1559 } 1560 }, 1561 "IamRoleArn": { 1562 "target": "com.amazonaws.cloudhsm#IamRoleArn", 1563 "traits": { 1564 "smithy.api#documentation": "<p>The new IAM role ARN.</p>", 1565 "smithy.api#xmlName": "IamRoleArn" 1566 } 1567 }, 1568 "ExternalId": { 1569 "target": "com.amazonaws.cloudhsm#ExternalId", 1570 "traits": { 1571 "smithy.api#documentation": "<p>The new external ID.</p>", 1572 "smithy.api#xmlName": "ExternalId" 1573 } 1574 }, 1575 "SyslogIp": { 1576 "target": "com.amazonaws.cloudhsm#IpAddress", 1577 "traits": { 1578 "smithy.api#documentation": "<p>The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports\n one syslog monitoring server.</p>", 1579 "smithy.api#xmlName": "SyslogIp" 1580 } 1581 } 1582 }, 1583 "traits": { 1584 "smithy.api#documentation": "<p>Contains the inputs for the <a>ModifyHsm</a> operation.</p>", 1585 "smithy.api#xmlName": "ModifyHsmRequest" 1586 } 1587 }, 1588 "com.amazonaws.cloudhsm#ModifyHsmResponse": { 1589 "type": "structure", 1590 "members": { 1591 "HsmArn": { 1592 "target": "com.amazonaws.cloudhsm#HsmArn", 1593 "traits": { 1594 "smithy.api#documentation": "<p>The ARN of the HSM.</p>" 1595 } 1596 } 1597 }, 1598 "traits": { 1599 "smithy.api#documentation": "<p>Contains the output of the <a>ModifyHsm</a> operation.</p>" 1600 } 1601 }, 1602 "com.amazonaws.cloudhsm#ModifyLunaClient": { 1603 "type": "operation", 1604 "input": { 1605 "target": "com.amazonaws.cloudhsm#ModifyLunaClientRequest" 1606 }, 1607 "output": { 1608 "target": "com.amazonaws.cloudhsm#ModifyLunaClientResponse" 1609 }, 1610 "errors": [ 1611 { 1612 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1613 } 1614 ], 1615 "traits": { 1616 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Modifies the certificate used by the client.</p>\n <p>This action can potentially start a workflow to install the new certificate on the\n client's HSMs.</p>" 1617 } 1618 }, 1619 "com.amazonaws.cloudhsm#ModifyLunaClientRequest": { 1620 "type": "structure", 1621 "members": { 1622 "ClientArn": { 1623 "target": "com.amazonaws.cloudhsm#ClientArn", 1624 "traits": { 1625 "smithy.api#documentation": "<p>The ARN of the client.</p>", 1626 "smithy.api#required": {} 1627 } 1628 }, 1629 "Certificate": { 1630 "target": "com.amazonaws.cloudhsm#Certificate", 1631 "traits": { 1632 "smithy.api#documentation": "<p>The new certificate for the client.</p>", 1633 "smithy.api#required": {} 1634 } 1635 } 1636 } 1637 }, 1638 "com.amazonaws.cloudhsm#ModifyLunaClientResponse": { 1639 "type": "structure", 1640 "members": { 1641 "ClientArn": { 1642 "target": "com.amazonaws.cloudhsm#ClientArn", 1643 "traits": { 1644 "smithy.api#documentation": "<p>The ARN of the client.</p>" 1645 } 1646 } 1647 } 1648 }, 1649 "com.amazonaws.cloudhsm#PaginationToken": { 1650 "type": "string", 1651 "traits": { 1652 "smithy.api#pattern": "[a-zA-Z0-9+/]*" 1653 } 1654 }, 1655 "com.amazonaws.cloudhsm#PartitionArn": { 1656 "type": "string", 1657 "traits": { 1658 "smithy.api#pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}" 1659 } 1660 }, 1661 "com.amazonaws.cloudhsm#PartitionList": { 1662 "type": "list", 1663 "member": { 1664 "target": "com.amazonaws.cloudhsm#PartitionArn" 1665 } 1666 }, 1667 "com.amazonaws.cloudhsm#PartitionSerial": { 1668 "type": "string", 1669 "traits": { 1670 "smithy.api#pattern": "\\d{6,12}" 1671 } 1672 }, 1673 "com.amazonaws.cloudhsm#PartitionSerialList": { 1674 "type": "list", 1675 "member": { 1676 "target": "com.amazonaws.cloudhsm#PartitionSerial" 1677 } 1678 }, 1679 "com.amazonaws.cloudhsm#RemoveTagsFromResource": { 1680 "type": "operation", 1681 "input": { 1682 "target": "com.amazonaws.cloudhsm#RemoveTagsFromResourceRequest" 1683 }, 1684 "output": { 1685 "target": "com.amazonaws.cloudhsm#RemoveTagsFromResourceResponse" 1686 }, 1687 "errors": [ 1688 { 1689 "target": "com.amazonaws.cloudhsm#CloudHsmInternalException" 1690 }, 1691 { 1692 "target": "com.amazonaws.cloudhsm#CloudHsmServiceException" 1693 }, 1694 { 1695 "target": "com.amazonaws.cloudhsm#InvalidRequestException" 1696 } 1697 ], 1698 "traits": { 1699 "smithy.api#documentation": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For\n more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM\n Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS\n CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p>\n <p>\n <b>For information about the current version of AWS\n CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the\n <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>,\n and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API\n Reference</a>.</p>\n <p>Removes one or more tags from the specified AWS CloudHSM resource.</p>\n <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the\n value for an existing tag, use <a>AddTagsToResource</a>.</p>" 1700 } 1701 }, 1702 "com.amazonaws.cloudhsm#RemoveTagsFromResourceRequest": { 1703 "type": "structure", 1704 "members": { 1705 "ResourceArn": { 1706 "target": "com.amazonaws.cloudhsm#String", 1707 "traits": { 1708 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>", 1709 "smithy.api#required": {} 1710 } 1711 }, 1712 "TagKeyList": { 1713 "target": "com.amazonaws.cloudhsm#TagKeyList", 1714 "traits": { 1715 "smithy.api#documentation": "<p>The tag key or keys to remove.</p>\n <p>Specify only the tag key to remove (not the value). To overwrite the value for an\n existing tag, use <a>AddTagsToResource</a>.</p>", 1716 "smithy.api#required": {} 1717 } 1718 } 1719 } 1720 }, 1721 "com.amazonaws.cloudhsm#RemoveTagsFromResourceResponse": { 1722 "type": "structure", 1723 "members": { 1724 "Status": { 1725 "target": "com.amazonaws.cloudhsm#String", 1726 "traits": { 1727 "smithy.api#documentation": "<p>The status of the operation.</p>", 1728 "smithy.api#required": {} 1729 } 1730 } 1731 } 1732 }, 1733 "com.amazonaws.cloudhsm#SshKey": { 1734 "type": "string", 1735 "traits": { 1736 "smithy.api#pattern": "[a-zA-Z0-9+/= ._:\\\\@-]*" 1737 } 1738 }, 1739 "com.amazonaws.cloudhsm#String": { 1740 "type": "string", 1741 "traits": { 1742 "smithy.api#pattern": "[\\w :+=./\\\\-]*" 1743 } 1744 }, 1745 "com.amazonaws.cloudhsm#SubnetId": { 1746 "type": "string", 1747 "traits": { 1748 "smithy.api#pattern": "subnet-[0-9a-f]{8}" 1749 } 1750 }, 1751 "com.amazonaws.cloudhsm#SubscriptionType": { 1752 "type": "string", 1753 "traits": { 1754 "smithy.api#documentation": "<p>Specifies the type of subscription for the HSM.</p>\n <ul>\n <li>\n <p>\n <b>PRODUCTION</b> - The HSM is being used in a production\n environment.</p>\n </li>\n <li>\n <p>\n <b>TRIAL</b> - The HSM is being used in a product\n trial.</p>\n </li>\n </ul>", 1755 "smithy.api#enum": [ 1756 { 1757 "value": "PRODUCTION", 1758 "name": "PRODUCTION" 1759 } 1760 ] 1761 } 1762 }, 1763 "com.amazonaws.cloudhsm#Tag": { 1764 "type": "structure", 1765 "members": { 1766 "Key": { 1767 "target": "com.amazonaws.cloudhsm#TagKey", 1768 "traits": { 1769 "smithy.api#documentation": "<p>The key of the tag.</p>", 1770 "smithy.api#required": {} 1771 } 1772 }, 1773 "Value": { 1774 "target": "com.amazonaws.cloudhsm#TagValue", 1775 "traits": { 1776 "smithy.api#documentation": "<p>The value of the tag.</p>", 1777 "smithy.api#required": {} 1778 } 1779 } 1780 }, 1781 "traits": { 1782 "smithy.api#documentation": "<p>A key-value pair that identifies or specifies metadata about an AWS CloudHSM\n resource.</p>" 1783 } 1784 }, 1785 "com.amazonaws.cloudhsm#TagKey": { 1786 "type": "string", 1787 "traits": { 1788 "smithy.api#length": { 1789 "min": 1, 1790 "max": 128 1791 } 1792 } 1793 }, 1794 "com.amazonaws.cloudhsm#TagKeyList": { 1795 "type": "list", 1796 "member": { 1797 "target": "com.amazonaws.cloudhsm#TagKey" 1798 } 1799 }, 1800 "com.amazonaws.cloudhsm#TagList": { 1801 "type": "list", 1802 "member": { 1803 "target": "com.amazonaws.cloudhsm#Tag" 1804 } 1805 }, 1806 "com.amazonaws.cloudhsm#TagValue": { 1807 "type": "string", 1808 "traits": { 1809 "smithy.api#length": { 1810 "min": 0, 1811 "max": 256 1812 } 1813 } 1814 }, 1815 "com.amazonaws.cloudhsm#Timestamp": { 1816 "type": "string", 1817 "traits": { 1818 "smithy.api#pattern": "\\d*" 1819 } 1820 }, 1821 "com.amazonaws.cloudhsm#VpcId": { 1822 "type": "string", 1823 "traits": { 1824 "smithy.api#pattern": "vpc-[0-9a-f]{8}" 1825 } 1826 } 1827 } 1828} 1829