kms-2014-11-01.min.json (15019B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2014-11-01", 5 "endpointPrefix": "kms", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "KMS", 9 "serviceFullName": "AWS Key Management Service", 10 "signatureVersion": "v4", 11 "targetPrefix": "TrentService" 12 }, 13 "operations": { 14 "CancelKeyDeletion": { 15 "input": { 16 "type": "structure", 17 "required": [ 18 "KeyId" 19 ], 20 "members": { 21 "KeyId": {} 22 } 23 }, 24 "output": { 25 "type": "structure", 26 "members": { 27 "KeyId": {} 28 } 29 } 30 }, 31 "CreateAlias": { 32 "input": { 33 "type": "structure", 34 "required": [ 35 "AliasName", 36 "TargetKeyId" 37 ], 38 "members": { 39 "AliasName": {}, 40 "TargetKeyId": {} 41 } 42 } 43 }, 44 "CreateGrant": { 45 "input": { 46 "type": "structure", 47 "required": [ 48 "KeyId", 49 "GranteePrincipal" 50 ], 51 "members": { 52 "KeyId": {}, 53 "GranteePrincipal": {}, 54 "RetiringPrincipal": {}, 55 "Operations": { 56 "shape": "S8" 57 }, 58 "Constraints": { 59 "shape": "Sa" 60 }, 61 "GrantTokens": { 62 "shape": "Se" 63 }, 64 "Name": {} 65 } 66 }, 67 "output": { 68 "type": "structure", 69 "members": { 70 "GrantToken": {}, 71 "GrantId": {} 72 } 73 } 74 }, 75 "CreateKey": { 76 "input": { 77 "type": "structure", 78 "members": { 79 "Policy": {}, 80 "Description": {}, 81 "KeyUsage": {}, 82 "Origin": {}, 83 "BypassPolicyLockoutSafetyCheck": { 84 "type": "boolean" 85 } 86 } 87 }, 88 "output": { 89 "type": "structure", 90 "members": { 91 "KeyMetadata": { 92 "shape": "Sq" 93 } 94 } 95 } 96 }, 97 "Decrypt": { 98 "input": { 99 "type": "structure", 100 "required": [ 101 "CiphertextBlob" 102 ], 103 "members": { 104 "CiphertextBlob": { 105 "type": "blob" 106 }, 107 "EncryptionContext": { 108 "shape": "Sb" 109 }, 110 "GrantTokens": { 111 "shape": "Se" 112 } 113 } 114 }, 115 "output": { 116 "type": "structure", 117 "members": { 118 "KeyId": {}, 119 "Plaintext": { 120 "shape": "Sz" 121 } 122 } 123 } 124 }, 125 "DeleteAlias": { 126 "input": { 127 "type": "structure", 128 "required": [ 129 "AliasName" 130 ], 131 "members": { 132 "AliasName": {} 133 } 134 } 135 }, 136 "DeleteImportedKeyMaterial": { 137 "input": { 138 "type": "structure", 139 "required": [ 140 "KeyId" 141 ], 142 "members": { 143 "KeyId": {} 144 } 145 } 146 }, 147 "DescribeKey": { 148 "input": { 149 "type": "structure", 150 "required": [ 151 "KeyId" 152 ], 153 "members": { 154 "KeyId": {}, 155 "GrantTokens": { 156 "shape": "Se" 157 } 158 } 159 }, 160 "output": { 161 "type": "structure", 162 "members": { 163 "KeyMetadata": { 164 "shape": "Sq" 165 } 166 } 167 } 168 }, 169 "DisableKey": { 170 "input": { 171 "type": "structure", 172 "required": [ 173 "KeyId" 174 ], 175 "members": { 176 "KeyId": {} 177 } 178 } 179 }, 180 "DisableKeyRotation": { 181 "input": { 182 "type": "structure", 183 "required": [ 184 "KeyId" 185 ], 186 "members": { 187 "KeyId": {} 188 } 189 } 190 }, 191 "EnableKey": { 192 "input": { 193 "type": "structure", 194 "required": [ 195 "KeyId" 196 ], 197 "members": { 198 "KeyId": {} 199 } 200 } 201 }, 202 "EnableKeyRotation": { 203 "input": { 204 "type": "structure", 205 "required": [ 206 "KeyId" 207 ], 208 "members": { 209 "KeyId": {} 210 } 211 } 212 }, 213 "Encrypt": { 214 "input": { 215 "type": "structure", 216 "required": [ 217 "KeyId", 218 "Plaintext" 219 ], 220 "members": { 221 "KeyId": {}, 222 "Plaintext": { 223 "shape": "Sz" 224 }, 225 "EncryptionContext": { 226 "shape": "Sb" 227 }, 228 "GrantTokens": { 229 "shape": "Se" 230 } 231 } 232 }, 233 "output": { 234 "type": "structure", 235 "members": { 236 "CiphertextBlob": { 237 "type": "blob" 238 }, 239 "KeyId": {} 240 } 241 } 242 }, 243 "GenerateDataKey": { 244 "input": { 245 "type": "structure", 246 "required": [ 247 "KeyId" 248 ], 249 "members": { 250 "KeyId": {}, 251 "EncryptionContext": { 252 "shape": "Sb" 253 }, 254 "NumberOfBytes": { 255 "type": "integer" 256 }, 257 "KeySpec": {}, 258 "GrantTokens": { 259 "shape": "Se" 260 } 261 } 262 }, 263 "output": { 264 "type": "structure", 265 "members": { 266 "CiphertextBlob": { 267 "type": "blob" 268 }, 269 "Plaintext": { 270 "shape": "Sz" 271 }, 272 "KeyId": {} 273 } 274 } 275 }, 276 "GenerateDataKeyWithoutPlaintext": { 277 "input": { 278 "type": "structure", 279 "required": [ 280 "KeyId" 281 ], 282 "members": { 283 "KeyId": {}, 284 "EncryptionContext": { 285 "shape": "Sb" 286 }, 287 "KeySpec": {}, 288 "NumberOfBytes": { 289 "type": "integer" 290 }, 291 "GrantTokens": { 292 "shape": "Se" 293 } 294 } 295 }, 296 "output": { 297 "type": "structure", 298 "members": { 299 "CiphertextBlob": { 300 "type": "blob" 301 }, 302 "KeyId": {} 303 } 304 } 305 }, 306 "GenerateRandom": { 307 "input": { 308 "type": "structure", 309 "members": { 310 "NumberOfBytes": { 311 "type": "integer" 312 } 313 } 314 }, 315 "output": { 316 "type": "structure", 317 "members": { 318 "Plaintext": { 319 "shape": "Sz" 320 } 321 } 322 } 323 }, 324 "GetKeyPolicy": { 325 "input": { 326 "type": "structure", 327 "required": [ 328 "KeyId", 329 "PolicyName" 330 ], 331 "members": { 332 "KeyId": {}, 333 "PolicyName": {} 334 } 335 }, 336 "output": { 337 "type": "structure", 338 "members": { 339 "Policy": {} 340 } 341 } 342 }, 343 "GetKeyRotationStatus": { 344 "input": { 345 "type": "structure", 346 "required": [ 347 "KeyId" 348 ], 349 "members": { 350 "KeyId": {} 351 } 352 }, 353 "output": { 354 "type": "structure", 355 "members": { 356 "KeyRotationEnabled": { 357 "type": "boolean" 358 } 359 } 360 } 361 }, 362 "GetParametersForImport": { 363 "input": { 364 "type": "structure", 365 "required": [ 366 "KeyId", 367 "WrappingAlgorithm", 368 "WrappingKeySpec" 369 ], 370 "members": { 371 "KeyId": {}, 372 "WrappingAlgorithm": {}, 373 "WrappingKeySpec": {} 374 } 375 }, 376 "output": { 377 "type": "structure", 378 "members": { 379 "KeyId": {}, 380 "ImportToken": { 381 "type": "blob" 382 }, 383 "PublicKey": { 384 "shape": "Sz" 385 }, 386 "ParametersValidTo": { 387 "type": "timestamp" 388 } 389 } 390 } 391 }, 392 "ImportKeyMaterial": { 393 "input": { 394 "type": "structure", 395 "required": [ 396 "KeyId", 397 "ImportToken", 398 "EncryptedKeyMaterial" 399 ], 400 "members": { 401 "KeyId": {}, 402 "ImportToken": { 403 "type": "blob" 404 }, 405 "EncryptedKeyMaterial": { 406 "type": "blob" 407 }, 408 "ValidTo": { 409 "type": "timestamp" 410 }, 411 "ExpirationModel": {} 412 } 413 }, 414 "output": { 415 "type": "structure", 416 "members": {} 417 } 418 }, 419 "ListAliases": { 420 "input": { 421 "type": "structure", 422 "members": { 423 "Limit": { 424 "type": "integer" 425 }, 426 "Marker": {} 427 } 428 }, 429 "output": { 430 "type": "structure", 431 "members": { 432 "Aliases": { 433 "type": "list", 434 "member": { 435 "type": "structure", 436 "members": { 437 "AliasName": {}, 438 "AliasArn": {}, 439 "TargetKeyId": {} 440 } 441 } 442 }, 443 "NextMarker": {}, 444 "Truncated": { 445 "type": "boolean" 446 } 447 } 448 } 449 }, 450 "ListGrants": { 451 "input": { 452 "type": "structure", 453 "required": [ 454 "KeyId" 455 ], 456 "members": { 457 "Limit": { 458 "type": "integer" 459 }, 460 "Marker": {}, 461 "KeyId": {} 462 } 463 }, 464 "output": { 465 "shape": "S20" 466 } 467 }, 468 "ListKeyPolicies": { 469 "input": { 470 "type": "structure", 471 "required": [ 472 "KeyId" 473 ], 474 "members": { 475 "KeyId": {}, 476 "Limit": { 477 "type": "integer" 478 }, 479 "Marker": {} 480 } 481 }, 482 "output": { 483 "type": "structure", 484 "members": { 485 "PolicyNames": { 486 "type": "list", 487 "member": {} 488 }, 489 "NextMarker": {}, 490 "Truncated": { 491 "type": "boolean" 492 } 493 } 494 } 495 }, 496 "ListKeys": { 497 "input": { 498 "type": "structure", 499 "members": { 500 "Limit": { 501 "type": "integer" 502 }, 503 "Marker": {} 504 } 505 }, 506 "output": { 507 "type": "structure", 508 "members": { 509 "Keys": { 510 "type": "list", 511 "member": { 512 "type": "structure", 513 "members": { 514 "KeyId": {}, 515 "KeyArn": {} 516 } 517 } 518 }, 519 "NextMarker": {}, 520 "Truncated": { 521 "type": "boolean" 522 } 523 } 524 } 525 }, 526 "ListRetirableGrants": { 527 "input": { 528 "type": "structure", 529 "required": [ 530 "RetiringPrincipal" 531 ], 532 "members": { 533 "Limit": { 534 "type": "integer" 535 }, 536 "Marker": {}, 537 "RetiringPrincipal": {} 538 } 539 }, 540 "output": { 541 "shape": "S20" 542 } 543 }, 544 "PutKeyPolicy": { 545 "input": { 546 "type": "structure", 547 "required": [ 548 "KeyId", 549 "PolicyName", 550 "Policy" 551 ], 552 "members": { 553 "KeyId": {}, 554 "PolicyName": {}, 555 "Policy": {}, 556 "BypassPolicyLockoutSafetyCheck": { 557 "type": "boolean" 558 } 559 } 560 } 561 }, 562 "ReEncrypt": { 563 "input": { 564 "type": "structure", 565 "required": [ 566 "CiphertextBlob", 567 "DestinationKeyId" 568 ], 569 "members": { 570 "CiphertextBlob": { 571 "type": "blob" 572 }, 573 "SourceEncryptionContext": { 574 "shape": "Sb" 575 }, 576 "DestinationKeyId": {}, 577 "DestinationEncryptionContext": { 578 "shape": "Sb" 579 }, 580 "GrantTokens": { 581 "shape": "Se" 582 } 583 } 584 }, 585 "output": { 586 "type": "structure", 587 "members": { 588 "CiphertextBlob": { 589 "type": "blob" 590 }, 591 "SourceKeyId": {}, 592 "KeyId": {} 593 } 594 } 595 }, 596 "RetireGrant": { 597 "input": { 598 "type": "structure", 599 "members": { 600 "GrantToken": {}, 601 "KeyId": {}, 602 "GrantId": {} 603 } 604 } 605 }, 606 "RevokeGrant": { 607 "input": { 608 "type": "structure", 609 "required": [ 610 "KeyId", 611 "GrantId" 612 ], 613 "members": { 614 "KeyId": {}, 615 "GrantId": {} 616 } 617 } 618 }, 619 "ScheduleKeyDeletion": { 620 "input": { 621 "type": "structure", 622 "required": [ 623 "KeyId" 624 ], 625 "members": { 626 "KeyId": {}, 627 "PendingWindowInDays": { 628 "type": "integer" 629 } 630 } 631 }, 632 "output": { 633 "type": "structure", 634 "members": { 635 "KeyId": {}, 636 "DeletionDate": { 637 "type": "timestamp" 638 } 639 } 640 } 641 }, 642 "UpdateAlias": { 643 "input": { 644 "type": "structure", 645 "required": [ 646 "AliasName", 647 "TargetKeyId" 648 ], 649 "members": { 650 "AliasName": {}, 651 "TargetKeyId": {} 652 } 653 } 654 }, 655 "UpdateKeyDescription": { 656 "input": { 657 "type": "structure", 658 "required": [ 659 "KeyId", 660 "Description" 661 ], 662 "members": { 663 "KeyId": {}, 664 "Description": {} 665 } 666 } 667 } 668 }, 669 "shapes": { 670 "S8": { 671 "type": "list", 672 "member": {} 673 }, 674 "Sa": { 675 "type": "structure", 676 "members": { 677 "EncryptionContextSubset": { 678 "shape": "Sb" 679 }, 680 "EncryptionContextEquals": { 681 "shape": "Sb" 682 } 683 } 684 }, 685 "Sb": { 686 "type": "map", 687 "key": {}, 688 "value": {} 689 }, 690 "Se": { 691 "type": "list", 692 "member": {} 693 }, 694 "Sq": { 695 "type": "structure", 696 "required": [ 697 "KeyId" 698 ], 699 "members": { 700 "AWSAccountId": {}, 701 "KeyId": {}, 702 "Arn": {}, 703 "CreationDate": { 704 "type": "timestamp" 705 }, 706 "Enabled": { 707 "type": "boolean" 708 }, 709 "Description": {}, 710 "KeyUsage": {}, 711 "KeyState": {}, 712 "DeletionDate": { 713 "type": "timestamp" 714 }, 715 "ValidTo": { 716 "type": "timestamp" 717 }, 718 "Origin": {}, 719 "ExpirationModel": {} 720 } 721 }, 722 "Sz": { 723 "type": "blob", 724 "sensitive": true 725 }, 726 "S20": { 727 "type": "structure", 728 "members": { 729 "Grants": { 730 "type": "list", 731 "member": { 732 "type": "structure", 733 "members": { 734 "KeyId": {}, 735 "GrantId": {}, 736 "Name": {}, 737 "CreationDate": { 738 "type": "timestamp" 739 }, 740 "GranteePrincipal": {}, 741 "RetiringPrincipal": {}, 742 "IssuingAccount": {}, 743 "Operations": { 744 "shape": "S8" 745 }, 746 "Constraints": { 747 "shape": "Sa" 748 } 749 } 750 } 751 }, 752 "NextMarker": {}, 753 "Truncated": { 754 "type": "boolean" 755 } 756 } 757 } 758 } 759 }