about summary refs log tree commit diff
path: root/.venv/lib/python3.12/site-packages/botocore/data/kms/2014-11-01/examples-1.json
blob: c770d0edb13083d060d6bbc1b16eb6cd698eccbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
{
  "version": "1.0",
  "examples": {
    "CancelKeyDeletion": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          },
          "output": {
            "KeyId": "The ARN of the KMS key whose deletion you canceled."
          }
        },
        "description": "The following example cancels deletion of the specified KMS key.",
        "id": "to-cancel-deletion-of-a-cmk-1477428535102",
        "title": "To cancel deletion of a KMS key"
      }
    ],
    "ConnectCustomKeyStore": [
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "The ID of the AWS KMS custom key store."
          },
          "output": {
          }
        },
        "description": "This example connects an AWS KMS custom key store to its AWS CloudHSM cluster. This operation does not return any data. To verify that the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation.",
        "id": "to-connect-a-custom-key-store-to-its-cloudhsm-cluster-1628626947750",
        "title": "To connect a custom key store to its CloudHSM cluster"
      }
    ],
    "CreateAlias": [
      {
        "input": {
          "AliasName": "alias/ExampleAlias",
          "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "AliasName": "The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.",
            "TargetKeyId": "The identifier of the KMS key whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example creates an alias for the specified KMS key.",
        "id": "to-create-an-alias-1477505685119",
        "title": "To create an alias"
      }
    ],
    "CreateCustomKeyStore": [
      {
        "input": {
          "CloudHsmClusterId": "cluster-1a23b4cdefg",
          "CustomKeyStoreName": "ExampleKeyStore",
          "KeyStorePassword": "kmsPswd",
          "TrustAnchorCertificate": "<certificate-goes-here>"
        },
        "output": {
          "CustomKeyStoreId": "cks-1234567890abcdef0"
        },
        "comments": {
          "input": {
            "CloudHsmClusterId": "The ID of the CloudHSM cluster.",
            "CustomKeyStoreName": "A friendly name for the custom key store.",
            "KeyStorePassword": "The password for the kmsuser CU account in the specified cluster.",
            "TrustAnchorCertificate": "The content of the customerCA.crt file that you created when you initialized the cluster."
          },
          "output": {
            "CustomKeyStoreId": "The ID of the new custom key store."
          }
        },
        "description": "This example creates a custom key store that is associated with an AWS CloudHSM cluster.",
        "id": "to-create-an-aws-cloudhsm-custom-key-store-1628627769469",
        "title": "To create an AWS CloudHSM custom key store"
      }
    ],
    "CreateGrant": [
      {
        "input": {
          "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole",
          "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "Operations": [
            "Encrypt",
            "Decrypt"
          ]
        },
        "output": {
          "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
          "GrantToken": "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA"
        },
        "comments": {
          "input": {
            "GranteePrincipal": "The identity that is given permission to perform the operations specified in the grant.",
            "KeyId": "The identifier of the KMS key to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "Operations": "A list of operations that the grant allows."
          },
          "output": {
            "GrantId": "The unique identifier of the grant.",
            "GrantToken": "The grant token."
          }
        },
        "description": "The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key.",
        "id": "to-create-a-grant-1477972226782",
        "title": "To create a grant"
      }
    ],
    "CreateKey": [
      {
        "input": {
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2017-07-05T14:04:55-07:00",
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "SYMMETRIC_DEFAULT",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": false,
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "Tags": "One or more tags. Each tag consists of a tag key and a tag value."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this operation.",
        "id": "to-create-a-cmk-1478028992966",
        "title": "To create a KMS key"
      },
      {
        "input": {
          "KeySpec": "RSA_4096",
          "KeyUsage": "ENCRYPT_DECRYPT"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2021-04-05T14:04:55-07:00",
            "CustomerMasterKeySpec": "RSA_4096",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "RSAES_OAEP_SHA_1",
              "RSAES_OAEP_SHA_256"
            ],
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "RSA_4096",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": false,
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "KeySpec": "Describes the type of key material in the KMS key.",
            "KeyUsage": "The cryptographic operations for which you can use the KMS key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a KMS key that contains an asymmetric RSA key pair for encryption and decryption. The key spec and key usage can't be changed after the key is created.",
        "id": "to-create-an-asymmetric-rsa-kms-key-for-encryption-and-decryption-1630533897833",
        "title": "To create an asymmetric RSA KMS key for encryption and decryption"
      },
      {
        "input": {
          "KeySpec": "ECC_NIST_P521",
          "KeyUsage": "SIGN_VERIFY"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2019-12-02T07:48:55-07:00",
            "CustomerMasterKeySpec": "ECC_NIST_P521",
            "Description": "",
            "Enabled": true,
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "ECC_NIST_P521",
            "KeyState": "Enabled",
            "KeyUsage": "SIGN_VERIFY",
            "MultiRegion": false,
            "Origin": "AWS_KMS",
            "SigningAlgorithms": [
              "ECDSA_SHA_512"
            ]
          }
        },
        "comments": {
          "input": {
            "KeySpec": "Describes the type of key material in the KMS key.",
            "KeyUsage": "The cryptographic operations for which you can use the KMS key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a KMS key that contains an asymmetric elliptic curve (ECC) key pair for signing and verification. The key usage is required even though \"SIGN_VERIFY\" is the only valid value for ECC KMS keys. The key spec and key usage can't be changed after the key is created.",
        "id": "to-create-an-asymmetric-elliptic-curve-kms-key-for-signing-and-verification-1630541089401",
        "title": "To create an asymmetric elliptic curve KMS key for signing and verification"
      },
      {
        "input": {
          "MultiRegion": true
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab",
            "CreationDate": "2021-09-02T016:15:21-09:00",
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "mrk-1234abcd12ab34cd56ef12345678990ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "SYMMETRIC_DEFAULT",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": true,
            "MultiRegionConfiguration": {
              "MultiRegionKeyType": "PRIMARY",
              "PrimaryKey": {
                "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab",
                "Region": "us-west-2"
              },
              "ReplicaKeys": [

              ]
            },
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "MultiRegion": "Indicates whether the KMS key is a multi-Region (True) or regional (False) key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a multi-Region primary symmetric encryption key. Because the default values for all parameters create a symmetric encryption key, only the MultiRegion parameter is required for this KMS key.",
        "id": "to-create-a-multi-region-primary-kms-key-1630599158567",
        "title": "To create a multi-Region primary KMS key"
      },
      {
        "input": {
          "Origin": "EXTERNAL"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2019-12-02T07:48:55-07:00",
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": false,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "SYMMETRIC_DEFAULT",
            "KeyState": "PendingImport",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": false,
            "Origin": "EXTERNAL"
          }
        },
        "comments": {
          "input": {
            "Origin": "The source of the key material for the KMS key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL. ",
        "id": "to-create-a-kms-key-for-imported-key-material-1630603607560",
        "title": "To create a KMS key for imported key material"
      },
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0",
          "Origin": "AWS_CLOUDHSM"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CloudHsmClusterId": "cluster-1a23b4cdefg",
            "CreationDate": "2019-12-02T07:48:55-07:00",
            "CustomKeyStoreId": "cks-1234567890abcdef0",
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "SYMMETRIC_DEFAULT",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": false,
            "Origin": "AWS_CLOUDHSM"
          }
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "Identifies the custom key store that hosts the KMS key.",
            "Origin": "Indicates the source of the key material for the KMS key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a KMS key in the specified custom key store. The operation creates the KMS key and its metadata in AWS KMS and the key material in the AWS CloudHSM cluster associated with the custom key store. This example requires the Origin and CustomKeyStoreId parameters.",
        "id": "to-create-a-kms-key-in-a-custom-key-store-1630604382908",
        "title": "To create a KMS key in a custom key store"
      },
      {
        "input": {
          "KeySpec": "HMAC_384",
          "KeyUsage": "GENERATE_VERIFY_MAC"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2022-04-05T14:04:55-07:00",
            "CustomerMasterKeySpec": "HMAC_384",
            "Description": "",
            "Enabled": true,
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "HMAC_384",
            "KeyState": "Enabled",
            "KeyUsage": "GENERATE_VERIFY_MAC",
            "MacAlgorithms": [
              "HMAC_SHA_384"
            ],
            "MultiRegion": false,
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "KeySpec": "Describes the type of key material in the KMS key.",
            "KeyUsage": "The cryptographic operations for which you can use the KMS key."
          },
          "output": {
            "KeyMetadata": "Detailed information about the KMS key that this operation creates."
          }
        },
        "description": "This example creates a 384-bit symmetric HMAC KMS key. The GENERATE_VERIFY_MAC key usage value is required even though it's the only valid value for HMAC KMS keys. The key spec and key usage can't be changed after the key is created. ",
        "id": "to-create-an-hmac-kms-key-1630628752841",
        "title": "To create an HMAC KMS key"
      }
    ],
    "Decrypt": [
      {
        "input": {
          "CiphertextBlob": "<binary data>",
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "Plaintext": "<binary data>"
        },
        "comments": {
          "input": {
            "CiphertextBlob": "The encrypted data (ciphertext).",
            "KeyId": "A key identifier for the KMS key to use to decrypt the data."
          },
          "output": {
            "KeyId": "The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.",
            "Plaintext": "The decrypted (plaintext) data."
          }
        },
        "description": "The following example decrypts data that was encrypted with a KMS key.",
        "id": "to-decrypt-data-1478281622886",
        "title": "To decrypt data"
      }
    ],
    "DeleteAlias": [
      {
        "input": {
          "AliasName": "alias/ExampleAlias"
        },
        "comments": {
          "input": {
            "AliasName": "The alias to delete."
          }
        },
        "description": "The following example deletes the specified alias.",
        "id": "to-delete-an-alias-1478285209338",
        "title": "To delete an alias"
      }
    ],
    "DeleteCustomKeyStore": [
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "The ID of the custom key store to be deleted."
          },
          "output": {
          }
        },
        "description": "This example deletes a custom key store from AWS KMS. This operation does not delete the AWS CloudHSM cluster that was associated with the CloudHSM cluster. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation.  ",
        "id": "to-delete-a-custom-key-store-from-aws-kms-1628630837145",
        "title": "To delete a custom key store from AWS KMS"
      }
    ],
    "DeleteImportedKeyMaterial": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example deletes the imported key material from the specified KMS key.",
        "id": "to-delete-imported-key-material-1478561674507",
        "title": "To delete imported key material"
      }
    ],
    "DescribeCustomKeyStores": [
      {
        "input": {
        },
        "output": {
          "CustomKeyStores": [

          ]
        },
        "comments": {
          "input": {
          },
          "output": {
            "CustomKeyStores": "Details about each custom key store in the account and Region."
          }
        },
        "description": "This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID.",
        "id": "to-get-detailed-information-about-custom-key-stores-in-the-account-and-region-1628628556811",
        "title": "To get detailed information about custom key stores in the account and Region"
      },
      {
        "input": {
          "CustomKeyStoreName": "ExampleKeyStore"
        },
        "output": {
          "CustomKeyStores": [
            {
              "CloudHsmClusterId": "cluster-1a23b4cdefg",
              "ConnectionState": "CONNECTED",
              "CreationDate": "1.499288695918E9",
              "CustomKeyStoreId": "cks-1234567890abcdef0",
              "CustomKeyStoreName": "ExampleKeyStore",
              "TrustAnchorCertificate": "<certificate appears here>"
            }
          ]
        },
        "comments": {
          "input": {
            "CustomKeyStoreName": "The friendly name of the custom key store."
          },
          "output": {
            "CustomKeyStores": "Detailed information about the specified custom key store."
          }
        },
        "description": "This example gets detailed information about a particular AWS KMS custom key store that is associate with an AWS CloudHSM cluster. To limit the output to a particular custom key store, provide the custom key store name or ID. ",
        "id": "to-get-detailed-information-about-a-custom-key-store-associated-with-a-cloudhsm-cluster-1628628885843",
        "title": "To get detailed information about a custom key store associated with a CloudHSM cluster."
      }
    ],
    "DescribeKey": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": "2017-07-05T14:04:55-07:00",
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "SYMMETRIC_DEFAULT",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": false,
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
          },
          "output": {
            "KeyMetadata": "An object that contains information about the specified KMS key."
          }
        },
        "description": "The following example gets metadata for a symmetric encryption KMS key.",
        "id": "get-key-details-1478565820907",
        "title": "To get details about a KMS key"
      },
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": 1571767572.317,
            "CustomerMasterKeySpec": "RSA_2048",
            "Description": "",
            "Enabled": false,
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeySpec": "RSA_2048",
            "KeyState": "Disabled",
            "KeyUsage": "SIGN_VERIFY",
            "MultiRegion": false,
            "Origin": "AWS_KMS",
            "SigningAlgorithms": [
              "RSASSA_PKCS1_V1_5_SHA_256",
              "RSASSA_PKCS1_V1_5_SHA_384",
              "RSASSA_PKCS1_V1_5_SHA_512",
              "RSASSA_PSS_SHA_256",
              "RSASSA_PSS_SHA_384",
              "RSASSA_PSS_SHA_512"
            ]
          }
        },
        "comments": {
          "input": {
            "KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
          },
          "output": {
            "KeyMetadata": "An object that contains information about the specified KMS key."
          }
        },
        "description": "The following example gets metadata for an asymmetric RSA KMS key used for signing and verification.",
        "id": "to-get-details-about-an-rsa-asymmetric-kms-key-1637971611761",
        "title": "To get details about an RSA asymmetric KMS key"
      },
      {
        "input": {
          "KeyId": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
            "CreationDate": 1586329200.918,
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "mrk-1234abcd12ab34cd56ef1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": true,
            "MultiRegionConfiguration": {
              "MultiRegionKeyType": "PRIMARY",
              "PrimaryKey": {
                "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                "Region": "us-west-2"
              },
              "ReplicaKeys": [
                {
                  "Arn": "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                  "Region": "eu-west-1"
                },
                {
                  "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                  "Region": "ap-northeast-1"
                },
                {
                  "Arn": "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                  "Region": "sa-east-1"
                }
              ]
            },
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
          },
          "output": {
            "KeyMetadata": "An object that contains information about the specified KMS key."
          }
        },
        "description": "The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key. DescribeKey returns information about the primary key and all of its replicas.",
        "id": "to-get-details-about-a-multi-region-key-1637969624239",
        "title": "To get details about a multi-Region key"
      },
      {
        "input": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyMetadata": {
            "AWSAccountId": "123456789012",
            "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
            "CreationDate": 1566160362.664,
            "CustomerMasterKeySpec": "HMAC_256",
            "Description": "Development test key",
            "Enabled": true,
            "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeyState": "Enabled",
            "KeyUsage": "GENERATE_VERIFY_MAC",
            "MacAlgorithms": [
              "HMAC_SHA_256"
            ],
            "MultiRegion": false,
            "Origin": "AWS_KMS"
          }
        },
        "comments": {
          "input": {
            "KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
          },
          "output": {
            "KeyMetadata": "An object that contains information about the specified KMS key."
          }
        },
        "description": "The following example gets the metadata of an HMAC KMS key. ",
        "id": "to-get-details-about-an-hmac-kms-key-1637970472619",
        "title": "To get details about an HMAC KMS key"
      }
    ],
    "DisableKey": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to disable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example disables the specified KMS key.",
        "id": "to-disable-a-cmk-1478566583659",
        "title": "To disable a KMS key"
      }
    ],
    "DisableKeyRotation": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example disables automatic annual rotation of the key material for the specified KMS key.",
        "id": "to-disable-automatic-rotation-of-key-material-1478624396092",
        "title": "To disable automatic rotation of key material"
      }
    ],
    "DisconnectCustomKeyStore": [
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "The ID of the custom key store."
          },
          "output": {
          }
        },
        "description": "This example disconnects an AWS KMS custom key store from its AWS CloudHSM cluster. This operation doesn't return any data. To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation.",
        "id": "to-disconnect-a-custom-key-store-from-its-cloudhsm-cluster-1628627955156",
        "title": "To disconnect a custom key store from its CloudHSM cluster"
      }
    ],
    "EnableKey": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to enable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example enables the specified KMS key.",
        "id": "to-enable-a-cmk-1478627501129",
        "title": "To enable a KMS key"
      }
    ],
    "EnableKeyRotation": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example enables automatic annual rotation of the key material for the specified KMS key.",
        "id": "to-enable-automatic-rotation-of-key-material-1478629109677",
        "title": "To enable automatic rotation of key material"
      }
    ],
    "Encrypt": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "Plaintext": "<binary data>"
        },
        "output": {
          "CiphertextBlob": "<binary data>",
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.",
            "Plaintext": "The data to encrypt."
          },
          "output": {
            "CiphertextBlob": "The encrypted data (ciphertext).",
            "KeyId": "The ARN of the KMS key that was used to encrypt the data."
          }
        },
        "description": "The following example encrypts data with the specified KMS key.",
        "id": "to-encrypt-data-1478906026012",
        "title": "To encrypt data"
      }
    ],
    "GenerateDataKey": [
      {
        "input": {
          "KeyId": "alias/ExampleAlias",
          "KeySpec": "AES_256"
        },
        "output": {
          "CiphertextBlob": "<binary data>",
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "Plaintext": "<binary data>"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.",
            "KeySpec": "Specifies the type of data key to return."
          },
          "output": {
            "CiphertextBlob": "The encrypted data key.",
            "KeyId": "The ARN of the KMS key that was used to encrypt the data key.",
            "Plaintext": "The unencrypted (plaintext) data key."
          }
        },
        "description": "The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.",
        "id": "to-generate-a-data-key-1478912956062",
        "title": "To generate a data key"
      }
    ],
    "GenerateDataKeyPair": [
      {
        "input": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "KeyPairSpec": "RSA_3072"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "KeyPairSpec": "RSA_3072",
          "PrivateKeyCiphertextBlob": "<binary data>",
          "PrivateKeyPlaintext": "<binary data>",
          "PublicKey": "<binary data>"
        },
        "comments": {
          "input": {
            "KeyId": "The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.",
            "KeyPairSpec": "The requested key spec of the RSA data key pair."
          },
          "output": {
            "KeyId": "The key ARN of the symmetric encryption KMS key that was used to encrypt the private key.",
            "KeyPairSpec": "The actual key spec of the RSA data key pair.",
            "PrivateKeyCiphertextBlob": "The encrypted private key of the RSA data key pair.",
            "PrivateKeyPlaintext": "The plaintext private key of the RSA data key pair.",
            "PublicKey": "The public key (plaintext) of the RSA data key pair."
          }
        },
        "description": "This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.",
        "id": "to-generate-an-rsa-key-pair-for-encryption-and-decryption-1628619376878",
        "title": "To generate an RSA key pair for encryption and decryption"
      }
    ],
    "GenerateDataKeyPairWithoutPlaintext": [
      {
        "input": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "KeyPairSpec": "ECC_NIST_P521"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "KeyPairSpec": "ECC_NIST_P521",
          "PrivateKeyCiphertextBlob": "<binary data>",
          "PublicKey": "<binary data>"
        },
        "comments": {
          "input": {
            "KeyId": "The symmetric encryption KMS key that encrypts the private key of the ECC data key pair.",
            "KeyPairSpec": "The requested key spec of the ECC asymmetric data key pair."
          },
          "output": {
            "KeyId": "The key ARN of the symmetric encryption KMS key that encrypted the private key in the ECC asymmetric data key pair.",
            "KeyPairSpec": "The actual key spec of the ECC asymmetric data key pair.",
            "PrivateKeyCiphertextBlob": "The encrypted private key of the asymmetric ECC data key pair.",
            "PublicKey": "The public key (plaintext)."
          }
        },
        "description": "This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key.",
        "id": "to-generate-an-asymmetric-data-key-pair-without-a-plaintext-key-1628620971564",
        "title": "To generate an asymmetric data key pair without a plaintext key"
      }
    ],
    "GenerateDataKeyWithoutPlaintext": [
      {
        "input": {
          "KeyId": "alias/ExampleAlias",
          "KeySpec": "AES_256"
        },
        "output": {
          "CiphertextBlob": "<binary data>",
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.",
            "KeySpec": "Specifies the type of data key to return."
          },
          "output": {
            "CiphertextBlob": "The encrypted data key.",
            "KeyId": "The ARN of the KMS key that was used to encrypt the data key."
          }
        },
        "description": "The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified KMS key.",
        "id": "to-generate-an-encrypted-data-key-1478914121134",
        "title": "To generate an encrypted data key"
      }
    ],
    "GenerateMac": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "MacAlgorithm": "HMAC_SHA_384",
          "Message": "Hello World"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "Mac": "<HMAC_TAG>",
          "MacAlgorithm": "HMAC_SHA_384"
        },
        "comments": {
          "input": {
            "KeyId": "The HMAC KMS key input to the HMAC algorithm.",
            "MacAlgorithm": "The HMAC algorithm requested for the operation.",
            "Message": "The message input to the HMAC algorithm."
          },
          "output": {
            "KeyId": "The key ARN of the HMAC KMS key used in the operation.",
            "Mac": "The HMAC tag that results from this operation.",
            "MacAlgorithm": "The HMAC algorithm used in the operation."
          }
        },
        "description": "This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key.",
        "id": "to-generate-an-hmac-for-a-message-1631570135665",
        "title": "To generate an HMAC for a message"
      }
    ],
    "GenerateRandom": [
      {
        "input": {
          "NumberOfBytes": 32
        },
        "output": {
          "Plaintext": "<binary data>"
        },
        "comments": {
          "input": {
            "NumberOfBytes": "The length of the random data, specified in number of bytes."
          },
          "output": {
            "Plaintext": "The random data."
          }
        },
        "description": "The following example generates 32 bytes of random data.",
        "id": "to-generate-random-data-1479163645600",
        "title": "To generate random data"
      }
    ],
    "GetKeyPolicy": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "PolicyName": "default"
        },
        "output": {
          "Policy": "{\n  \"Version\" : \"2012-10-17\",\n  \"Id\" : \"key-default-1\",\n  \"Statement\" : [ {\n    \"Sid\" : \"Enable IAM User Permissions\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n      \"AWS\" : \"arn:aws:iam::111122223333:root\"\n    },\n    \"Action\" : \"kms:*\",\n    \"Resource\" : \"*\"\n  } ]\n}"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "PolicyName": "The name of the key policy to retrieve."
          },
          "output": {
            "Policy": "The key policy document."
          }
        },
        "description": "The following example retrieves the key policy for the specified KMS key.",
        "id": "to-retrieve-a-key-policy-1479170128325",
        "title": "To retrieve a key policy"
      }
    ],
    "GetKeyRotationStatus": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "KeyRotationEnabled": true
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          },
          "output": {
            "KeyRotationEnabled": "A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not."
          }
        },
        "description": "The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.",
        "id": "to-retrieve-the-rotation-status-for-a-cmk-1479172287408",
        "title": "To retrieve the rotation status for a KMS key"
      }
    ],
    "GetParametersForImport": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "WrappingAlgorithm": "RSAES_OAEP_SHA_1",
          "WrappingKeySpec": "RSA_2048"
        },
        "output": {
          "ImportToken": "<binary data>",
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "ParametersValidTo": "2016-12-01T14:52:17-08:00",
          "PublicKey": "<binary data>"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "WrappingAlgorithm": "The algorithm that you will use to encrypt the key material before importing it.",
            "WrappingKeySpec": "The type of wrapping key (public key) to return in the response."
          },
          "output": {
            "ImportToken": "The import token to send with a subsequent ImportKeyMaterial request.",
            "KeyId": "The ARN of the KMS key for which you are retrieving the public key and import token. This is the same KMS key specified in the request.",
            "ParametersValidTo": "The time at which the import token and public key are no longer valid.",
            "PublicKey": "The public key to use to encrypt the key material before importing it."
          }
        },
        "description": "The following example retrieves the public key and import token for the specified KMS key.",
        "id": "to-retrieve-the-public-key-and-import-token-for-a-cmk-1480626483211",
        "title": "To retrieve the public key and import token for a KMS key"
      }
    ],
    "GetPublicKey": [
      {
        "input": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321"
        },
        "output": {
          "CustomerMasterKeySpec": "RSA_4096",
          "EncryptionAlgorithms": [
            "RSAES_OAEP_SHA_1",
            "RSAES_OAEP_SHA_256"
          ],
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
          "KeyUsage": "ENCRYPT_DECRYPT",
          "PublicKey": "<binary data>"
        },
        "comments": {
          "input": {
            "KeyId": "The key ARN of the asymmetric KMS key."
          },
          "output": {
            "CustomerMasterKeySpec": "The key spec of the asymmetric KMS key from which the public key was downloaded.",
            "EncryptionAlgorithms": "The encryption algorithms supported by the asymmetric KMS key that was downloaded.",
            "KeyId": "The key ARN of the asymmetric KMS key from which the public key was downloaded.",
            "KeyUsage": "The key usage of the asymmetric KMS key from which the public key was downloaded.",
            "PublicKey": "The public key (plaintext) of the asymmetric KMS key."
          }
        },
        "description": "This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS KMS.",
        "id": "to-download-the-public-key-of-an-asymmetric-kms-key-1628621691873",
        "title": "To download the public key of an asymmetric KMS key"
      }
    ],
    "ImportKeyMaterial": [
      {
        "input": {
          "EncryptedKeyMaterial": "<binary data>",
          "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
          "ImportToken": "<binary data>",
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "EncryptedKeyMaterial": "The encrypted key material to import.",
            "ExpirationModel": "A value that specifies whether the key material expires.",
            "ImportToken": "The import token that you received in the response to a previous GetParametersForImport request.",
            "KeyId": "The identifier of the KMS key to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example imports key material into the specified KMS key.",
        "id": "to-import-key-material-into-a-cmk-1480630551969",
        "title": "To import key material into a KMS key"
      }
    ],
    "ListAliases": [
      {
        "output": {
          "Aliases": [
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
              "AliasName": "alias/aws/acm",
              "TargetKeyId": "da03f6f7-d279-427a-9cae-de48d07e5b66"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
              "AliasName": "alias/aws/ebs",
              "TargetKeyId": "25a217e7-7170-4b8c-8bf6-045ea5f70e5b"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
              "AliasName": "alias/aws/rds",
              "TargetKeyId": "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
              "AliasName": "alias/aws/redshift",
              "TargetKeyId": "08f7a25a-69e2-4fb5-8f10-393db27326fa"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
              "AliasName": "alias/aws/s3",
              "TargetKeyId": "d2b0f1a3-580d-4f79-b836-bc983be8cfa5"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example1",
              "AliasName": "alias/example1",
              "TargetKeyId": "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example2",
              "AliasName": "alias/example2",
              "TargetKeyId": "f32fef59-2cc2-445b-8573-2d73328acbee"
            },
            {
              "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example3",
              "AliasName": "alias/example3",
              "TargetKeyId": "1374ef38-d34e-4d5f-b2c9-4e0daee38855"
            }
          ],
          "Truncated": false
        },
        "comments": {
          "output": {
            "Aliases": "A list of aliases, including the key ID of the KMS key that each alias refers to.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists aliases.",
        "id": "to-list-aliases-1480729693349",
        "title": "To list aliases"
      }
    ],
    "ListGrants": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "Grants": [
            {
              "CreationDate": "2016-10-25T14:37:41-07:00",
              "GrantId": "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172",
              "GranteePrincipal": "acm.us-east-2.amazonaws.com",
              "IssuingAccount": "arn:aws:iam::111122223333:root",
              "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
              "Operations": [
                "Encrypt",
                "ReEncryptFrom",
                "ReEncryptTo"
              ],
              "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
            },
            {
              "CreationDate": "2016-10-25T14:37:41-07:00",
              "GrantId": "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200",
              "GranteePrincipal": "acm.us-east-2.amazonaws.com",
              "IssuingAccount": "arn:aws:iam::111122223333:root",
              "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
              "Operations": [
                "ReEncryptFrom",
                "ReEncryptTo"
              ],
              "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
            },
            {
              "CreationDate": "2016-10-25T14:37:41-07:00",
              "GrantId": "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f",
              "GranteePrincipal": "acm.us-east-2.amazonaws.com",
              "IssuingAccount": "arn:aws:iam::111122223333:root",
              "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
              "Operations": [
                "Encrypt",
                "ReEncryptFrom",
                "ReEncryptTo"
              ],
              "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
            },
            {
              "CreationDate": "2016-10-25T14:37:41-07:00",
              "GrantId": "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c",
              "GranteePrincipal": "acm.us-east-2.amazonaws.com",
              "IssuingAccount": "arn:aws:iam::111122223333:root",
              "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
              "Operations": [
                "Encrypt",
                "ReEncryptFrom",
                "ReEncryptTo"
              ],
              "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
            }
          ],
          "Truncated": true
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          },
          "output": {
            "Grants": "A list of grants.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists grants for the specified KMS key.",
        "id": "to-list-grants-for-a-cmk-1481067365389",
        "title": "To list grants for a KMS key"
      }
    ],
    "ListKeyPolicies": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "PolicyNames": [
            "default"
          ],
          "Truncated": false
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          },
          "output": {
            "PolicyNames": "A list of key policy names.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists key policies for the specified KMS key.",
        "id": "to-list-key-policies-for-a-cmk-1481069780998",
        "title": "To list key policies for a KMS key"
      }
    ],
    "ListKeys": [
      {
        "output": {
          "Keys": [
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e",
              "KeyId": "0d990263-018e-4e65-a703-eff731de951e"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841",
              "KeyId": "144be297-0ae1-44ac-9c8f-93cd8c82f841"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571",
              "KeyId": "21184251-b765-428e-b852-2c7353e72571"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c",
              "KeyId": "214fe92f-5b03-4ae1-b350-db2a45dbe10c"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458",
              "KeyId": "339963f2-e523-49d3-af24-a0fe752aa458"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a",
              "KeyId": "b776a44b-df37-4438-9be4-a27494e4271a"
            },
            {
              "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
              "KeyId": "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb"
            }
          ],
          "Truncated": false
        },
        "comments": {
          "output": {
            "Keys": "A list of KMS keys, including the key ID and Amazon Resource Name (ARN) of each one.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists KMS keys.",
        "id": "to-list-cmks-1481071643069",
        "title": "To list KMS keys"
      }
    ],
    "ListResourceTags": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "output": {
          "Tags": [
            {
              "TagKey": "CostCenter",
              "TagValue": "87654"
            },
            {
              "TagKey": "CreatedBy",
              "TagValue": "ExampleUser"
            },
            {
              "TagKey": "Purpose",
              "TagValue": "Test"
            }
          ],
          "Truncated": false
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          },
          "output": {
            "Tags": "A list of tags.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists tags for a KMS key.",
        "id": "to-list-tags-for-a-cmk-1483996855796",
        "title": "To list tags for a KMS key"
      }
    ],
    "ListRetirableGrants": [
      {
        "input": {
          "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole"
        },
        "output": {
          "Grants": [
            {
              "CreationDate": "2016-12-07T11:09:35-08:00",
              "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
              "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole",
              "IssuingAccount": "arn:aws:iam::444455556666:root",
              "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
              "Operations": [
                "Decrypt",
                "Encrypt"
              ],
              "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole"
            }
          ],
          "Truncated": false
        },
        "comments": {
          "input": {
            "RetiringPrincipal": "The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of a principal such as an AWS account (root), IAM user, federated user, or assumed role user."
          },
          "output": {
            "Grants": "A list of grants that the specified principal can retire.",
            "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
          }
        },
        "description": "The following example lists the grants that the specified principal (identity) can retire.",
        "id": "to-list-grants-that-the-specified-principal-can-retire-1481140499620",
        "title": "To list grants that the specified principal can retire"
      }
    ],
    "PutKeyPolicy": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "Policy": "{\n    \"Version\": \"2012-10-17\",\n    \"Id\": \"custom-policy-2016-12-07\",\n    \"Statement\": [\n        {\n            \"Sid\": \"Enable IAM User Permissions\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:root\"\n            },\n            \"Action\": \"kms:*\",\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow access for Key Administrators\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": [\n                    \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n                    \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n                ]\n            },\n            \"Action\": [\n                \"kms:Create*\",\n                \"kms:Describe*\",\n                \"kms:Enable*\",\n                \"kms:List*\",\n                \"kms:Put*\",\n                \"kms:Update*\",\n                \"kms:Revoke*\",\n                \"kms:Disable*\",\n                \"kms:Get*\",\n                \"kms:Delete*\",\n                \"kms:ScheduleKeyDeletion\",\n                \"kms:CancelKeyDeletion\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow use of the key\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:Encrypt\",\n                \"kms:Decrypt\",\n                \"kms:ReEncrypt*\",\n                \"kms:GenerateDataKey*\",\n                \"kms:DescribeKey\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow attachment of persistent resources\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:CreateGrant\",\n                \"kms:ListGrants\",\n                \"kms:RevokeGrant\"\n            ],\n            \"Resource\": \"*\",\n            \"Condition\": {\n                \"Bool\": {\n                    \"kms:GrantIsForAWSResource\": \"true\"\n                }\n            }\n        }\n    ]\n}\n",
          "PolicyName": "default"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "Policy": "The key policy document.",
            "PolicyName": "The name of the key policy."
          }
        },
        "description": "The following example attaches a key policy to the specified KMS key.",
        "id": "to-attach-a-key-policy-to-a-cmk-1481147345018",
        "title": "To attach a key policy to a KMS key"
      }
    ],
    "ReEncrypt": [
      {
        "input": {
          "CiphertextBlob": "<binary data>",
          "DestinationKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321"
        },
        "output": {
          "CiphertextBlob": "<binary data>",
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
          "SourceKeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "CiphertextBlob": "The data to reencrypt.",
            "DestinationKeyId": "The identifier of the KMS key to use to reencrypt the data. You can use any valid key identifier.",
            "SourceKeyId": "The identifier of the KMS key to use to decrypt the data. You can use any valid key identifier."
          },
          "output": {
            "CiphertextBlob": "The reencrypted data.",
            "KeyId": "The ARN of the KMS key that was used to reencrypt the data.",
            "SourceKeyId": "The ARN of the KMS key that was originally used to encrypt the data."
          }
        },
        "description": "The following example reencrypts data with the specified KMS key.",
        "id": "to-reencrypt-data-1481230358001",
        "title": "To reencrypt data"
      }
    ],
    "ReplicateKey": [
      {
        "input": {
          "KeyId": "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
          "ReplicaRegion": "us-west-2"
        },
        "output": {
          "ReplicaKeyMetadata": {
            "AWSAccountId": "111122223333",
            "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
            "CreationDate": 1607472987.918,
            "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
            "Description": "",
            "Enabled": true,
            "EncryptionAlgorithms": [
              "SYMMETRIC_DEFAULT"
            ],
            "KeyId": "mrk-1234abcd12ab34cd56ef1234567890ab",
            "KeyManager": "CUSTOMER",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "MultiRegion": true,
            "MultiRegionConfiguration": {
              "MultiRegionKeyType": "REPLICA",
              "PrimaryKey": {
                "Arn": "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                "Region": "us-east-1"
              },
              "ReplicaKeys": [
                {
                  "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
                  "Region": "us-west-2"
                }
              ]
            },
            "Origin": "AWS_KMS"
          },
          "ReplicaPolicy": "{\n  \"Version\" : \"2012-10-17\",\n  \"Id\" : \"key-default-1\",...}",
          "ReplicaTags": [

          ]
        },
        "comments": {
          "input": {
            "KeyId": "The key ID or key ARN of the multi-Region primary key",
            "ReplicaRegion": "The Region of the new replica."
          },
          "output": {
            "ReplicaKeyMetadata": "An object that displays detailed information about the replica key.",
            "ReplicaPolicy": "The key policy of the replica key. If you don't specify a key policy, the replica key gets the default key policy for a KMS key.",
            "ReplicaTags": "The tags on the replica key, if any."
          }
        },
        "description": "This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1. ",
        "id": "to-replicate-a-multi-region-key-in-a-different-aws-region-1628622402887",
        "title": "To replicate a multi-Region key in a different AWS Region"
      }
    ],
    "RetireGrant": [
      {
        "input": {
          "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
          "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "GrantId": "The identifier of the grant to retire.",
            "KeyId": "The Amazon Resource Name (ARN) of the KMS key associated with the grant."
          }
        },
        "description": "The following example retires a grant.",
        "id": "to-retire-a-grant-1481327028297",
        "title": "To retire a grant"
      }
    ],
    "RevokeGrant": [
      {
        "input": {
          "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "GrantId": "The identifier of the grant to revoke.",
            "KeyId": "The identifier of the KMS key associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example revokes a grant.",
        "id": "to-revoke-a-grant-1481329549302",
        "title": "To revoke a grant"
      }
    ],
    "ScheduleKeyDeletion": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "PendingWindowInDays": 7
        },
        "output": {
          "DeletionDate": "2016-12-17T16:00:00-08:00",
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "PendingWindowInDays": "The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key."
          },
          "output": {
            "DeletionDate": "The date and time after which KMS deletes the KMS key.",
            "KeyId": "The ARN of the KMS key that is scheduled for deletion."
          }
        },
        "description": "The following example schedules the specified KMS key for deletion.",
        "id": "to-schedule-a-cmk-for-deletion-1481331111094",
        "title": "To schedule a KMS key for deletion"
      }
    ],
    "Sign": [
      {
        "input": {
          "KeyId": "alias/ECC_signing_key",
          "Message": "<message to be signed>",
          "MessageType": "RAW",
          "SigningAlgorithm": "ECDSA_SHA_384"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "Signature": "<binary data>",
          "SigningAlgorithm": "ECDSA_SHA_384"
        },
        "comments": {
          "input": {
            "KeyId": "The asymmetric KMS key to be used to generate the digital signature. This example uses an alias of the KMS key.",
            "Message": "Message to be signed. Use Base-64 for the CLI.",
            "MessageType": "Indicates whether the message is RAW or a DIGEST.",
            "SigningAlgorithm": "The requested signing algorithm. This must be an algorithm that the KMS key supports."
          },
          "output": {
            "KeyId": "The key ARN of the asymmetric KMS key that was used to sign the message.",
            "Signature": "The digital signature of the message.",
            "SigningAlgorithm": "The actual signing algorithm that was used to generate the signature."
          }
        },
        "description": "This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.",
        "id": "to-digitally-sign-a-message-with-an-asymmetric-kms-key-1628631433832",
        "title": "To digitally sign a message with an asymmetric KMS key."
      }
    ],
    "TagResource": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "Tags": [
            {
              "TagKey": "Purpose",
              "TagValue": "Test"
            }
          ]
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.",
            "Tags": "A list of tags."
          }
        },
        "description": "The following example tags a KMS key.",
        "id": "to-tag-a-cmk-1483997246518",
        "title": "To tag a KMS key"
      }
    ],
    "UntagResource": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "TagKeys": [
            "Purpose",
            "CostCenter"
          ]
        },
        "comments": {
          "input": {
            "KeyId": "The identifier of the KMS key whose tags you are removing.",
            "TagKeys": "A list of tag keys. Provide only the tag keys, not the tag values."
          }
        },
        "description": "The following example removes tags from a KMS key.",
        "id": "to-remove-tags-from-a-cmk-1483997590962",
        "title": "To remove tags from a KMS key"
      }
    ],
    "UpdateAlias": [
      {
        "input": {
          "AliasName": "alias/ExampleAlias",
          "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "AliasName": "The alias to update.",
            "TargetKeyId": "The identifier of the KMS key that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example updates the specified alias to refer to the specified KMS key.",
        "id": "to-update-an-alias-1481572726920",
        "title": "To update an alias"
      }
    ],
    "UpdateCustomKeyStore": [
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0",
          "KeyStorePassword": "ExamplePassword"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "The ID of the custom key store that you are updating.",
            "KeyStorePassword": "The password for the kmsuser crypto user in the CloudHSM cluster."
          },
          "output": {
          }
        },
        "description": "This example tells KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return any data.",
        "id": "to-edit-the-properties-of-a-custom-key-store-1628629851834",
        "title": "To edit the password of a custom key store"
      },
      {
        "input": {
          "CustomKeyStoreId": "cks-1234567890abcdef0",
          "NewCustomKeyStoreName": "DevelopmentKeys"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CustomKeyStoreId": "The ID of the custom key store that you are updating.",
            "NewCustomKeyStoreName": "A new friendly name for the custom key store."
          },
          "output": {
          }
        },
        "description": "This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.",
        "id": "to-edit-the-friendly-name-of-a-custom-key-store-1630451340904",
        "title": "To edit the friendly name of a custom key store"
      },
      {
        "input": {
          "CloudHsmClusterId": "cluster-1a23b4cdefg",
          "CustomKeyStoreId": "cks-1234567890abcdef0"
        },
        "output": {
        },
        "comments": {
          "input": {
            "CloudHsmClusterId": "The ID of the AWS CloudHSM cluster that you want to associate with the custom key store. This cluster must be related to the original CloudHSM cluster for this key store.",
            "CustomKeyStoreId": "The ID of the custom key store that you are updating."
          },
          "output": {
          }
        },
        "description": "This example changes the cluster that is associated with a custom key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.",
        "id": "to-associate-the-custom-key-store-with-a-different-but-related-aws-cloudhsm-cluster-1630451842438",
        "title": "To associate the custom key store with a different, but related, AWS CloudHSM cluster."
      }
    ],
    "UpdateKeyDescription": [
      {
        "input": {
          "Description": "Example description that indicates the intended use of this KMS key.",
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "comments": {
          "input": {
            "Description": "The updated description.",
            "KeyId": "The identifier of the KMS key whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key."
          }
        },
        "description": "The following example updates the description of the specified KMS key.",
        "id": "to-update-the-description-of-a-cmk-1481574808619",
        "title": "To update the description of a KMS key"
      }
    ],
    "Verify": [
      {
        "input": {
          "KeyId": "alias/ECC_signing_key",
          "Message": "<message to be verified>",
          "MessageType": "RAW",
          "Signature": "<binary data>",
          "SigningAlgorithm": "ECDSA_SHA_384"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "SignatureValid": true,
          "SigningAlgorithm": "ECDSA_SHA_384"
        },
        "comments": {
          "input": {
            "KeyId": "The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.",
            "Message": "The message that was signed.",
            "MessageType": "Indicates whether the message is RAW or a DIGEST.",
            "Signature": "The signature to be verified.",
            "SigningAlgorithm": "The signing algorithm to be used to verify the signature."
          },
          "output": {
            "KeyId": "The key ARN of the asymmetric KMS key that was used to verify the digital signature.",
            "SignatureValid": "A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.",
            "SigningAlgorithm": "The signing algorithm that was used to verify the signature."
          }
        },
        "description": "This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS. ",
        "id": "to-use-an-asymmetric-kms-key-to-verify-a-digital-signature-1628633365663",
        "title": "To use an asymmetric KMS key to verify a digital signature"
      }
    ],
    "VerifyMac": [
      {
        "input": {
          "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "Mac": "<HMAC_TAG>",
          "MacAlgorithm": "HMAC_SHA_384",
          "Message": "Hello World"
        },
        "output": {
          "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
          "MacAlgorithm": "HMAC_SHA_384",
          "MacValid": true
        },
        "comments": {
          "input": {
            "KeyId": "The HMAC KMS key input to the HMAC algorithm.",
            "Mac": "The HMAC to be verified.",
            "MacAlgorithm": "The HMAC algorithm requested for the operation.",
            "Message": "The message input to the HMAC algorithm."
          },
          "output": {
            "KeyId": "The key ARN of the HMAC key used in the operation.",
            "MacAlgorithm": "The HMAC algorithm used in the operation.",
            "MacValid": "A value of 'true' indicates that verification succeeded. If verification fails, the call to VerifyMac fails."
          }
        },
        "description": "This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the MacValid value in the response indicates that the HMAC is valid.",
        "id": "to-verify-an-hmac-1631570863401",
        "title": "To verify an HMAC"
      }
    ]
  }
}