-
Notifications
You must be signed in to change notification settings - Fork 891
/
Copy pathAWSKMSResources.m
4155 lines (4143 loc) · 490 KB
/
AWSKMSResources.m
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
//
// Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License").
// You may not use this file except in compliance with the License.
// A copy of the License is located at
//
// http://aws.amazon.com/apache2.0
//
// or in the "license" file accompanying this file. This file is distributed
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language governing
// permissions and limitations under the License.
//
#import "AWSKMSResources.h"
#import <AWSCore/AWSCocoaLumberjack.h>
@interface AWSKMSResources ()
@property (nonatomic, strong) NSDictionary *definitionDictionary;
@end
@implementation AWSKMSResources
+ (instancetype)sharedInstance {
static AWSKMSResources *_sharedResources = nil;
static dispatch_once_t once_token;
dispatch_once(&once_token, ^{
_sharedResources = [AWSKMSResources new];
});
return _sharedResources;
}
- (NSDictionary *)JSONObject {
return self.definitionDictionary;
}
- (instancetype)init {
if (self = [super init]) {
//init method
NSError *error = nil;
_definitionDictionary = [NSJSONSerialization JSONObjectWithData:[[self definitionString] dataUsingEncoding:NSUTF8StringEncoding]
options:kNilOptions
error:&error];
if (_definitionDictionary == nil) {
if (error) {
AWSDDLogError(@"Failed to parse JSON service definition: %@",error);
}
}
}
return self;
}
- (NSString *)definitionString {
return @"{\
\"version\":\"2.0\",\
\"metadata\":{\
\"apiVersion\":\"2014-11-01\",\
\"endpointPrefix\":\"kms\",\
\"jsonVersion\":\"1.1\",\
\"protocol\":\"json\",\
\"protocols\":[\"json\"],\
\"serviceAbbreviation\":\"KMS\",\
\"serviceFullName\":\"AWS Key Management Service\",\
\"serviceId\":\"KMS\",\
\"signatureVersion\":\"v4\",\
\"targetPrefix\":\"TrentService\",\
\"uid\":\"kms-2014-11-01\",\
\"auth\":[\"aws.auth#sigv4\"]\
},\
\"operations\":{\
\"CancelKeyDeletion\":{\
\"name\":\"CancelKeyDeletion\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"CancelKeyDeletionRequest\"},\
\"output\":{\"shape\":\"CancelKeyDeletionResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p> <p>For more information about scheduling and canceling deletion of a KMS key, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\\\">Deleting KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CancelKeyDeletion</a> (key policy)</p> <p> <b>Related operations</b>: <a>ScheduleKeyDeletion</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ConnectCustomKeyStore\":{\
\"name\":\"ConnectCustomKeyStore\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ConnectCustomKeyStoreRequest\"},\
\"output\":{\"shape\":\"ConnectCustomKeyStoreResponse\"},\
\"errors\":[\
{\"shape\":\"CloudHsmClusterNotActiveException\"},\
{\"shape\":\"CustomKeyStoreInvalidStateException\"},\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"CloudHsmClusterInvalidConfigurationException\"}\
],\
\"documentation\":\"<p>Connects or reconnects a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a> to its backing key store. For an CloudHSM key store, <code>ConnectCustomKeyStore</code> connects the key store to its associated CloudHSM cluster. For an external key store, <code>ConnectCustomKeyStore</code> connects the key store to the external key store proxy that communicates with your external key manager.</p> <p>The custom key store must be connected before you can create KMS keys in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key store at any time.</p> <p>The connection process for a custom key store can take an extended amount of time to complete. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p> This operation is part of the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.</p> <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again.</p> <p> <b>CloudHSM key store</b> </p> <p>During the connection process for an CloudHSM key store, KMS finds the CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p> <p>To connect an CloudHSM key store, its associated CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href=\\\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html\\\">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href=\\\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html\\\">CreateHsm</a> operation. Also, the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\\\"> <code>kmsuser</code> crypto user</a> (CU) must not be logged into the cluster. This prevents KMS from using this account to log in.</p> <p>If you are having trouble connecting or disconnecting a CloudHSM key store, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\\\">Troubleshooting an CloudHSM key store</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>External key store</b> </p> <p>When you connect an external key store that uses public endpoint connectivity, KMS tests its ability to communicate with your external key manager by sending a request via the external key store proxy.</p> <p>When you connect to an external key store that uses VPC endpoint service connectivity, KMS establishes the networking elements that it needs to communicate with your external key manager via the external key store proxy. This includes creating an interface endpoint to the VPC endpoint service and a private hosted zone for traffic between KMS and the VPC endpoint service.</p> <p>To connect an external key store, KMS must be able to connect to the external key store proxy, the external key store proxy must be able to communicate with your external key manager, and the external key manager must be available for cryptographic operations.</p> <p>If you are having trouble connecting or disconnecting an external key store, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html\\\">Troubleshooting an external key store</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ConnectCustomKeyStore</a> (IAM policy)</p> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CreateCustomKeyStore</a> </p> </li> <li> <p> <a>DeleteCustomKeyStore</a> </p> </li> <li> <p> <a>DescribeCustomKeyStores</a> </p> </li> <li> <p> <a>DisconnectCustomKeyStore</a> </p> </li> <li> <p> <a>UpdateCustomKeyStore</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"CreateAlias\":{\
\"name\":\"CreateAlias\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"CreateAliasRequest\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"AlreadyExistsException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidAliasNameException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Creates a friendly name for a KMS key. </p> <note> <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/abac.html\\\">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> </note> <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\\\">cryptographic operations</a>, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. You can also change the KMS key that's associated with the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>) at any time. These operations don't affect the underlying KMS key. </p> <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.</p> <p>The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html\\\">Using aliases</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>This operation does not return a response. To get the alias that you created, use the <a>ListAliases</a> operation.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p> <p> <b>Required permissions</b> </p> <ul> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CreateAlias</a> on the alias (IAM policy).</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CreateAlias</a> on the KMS key (key policy).</p> </li> </ul> <p>For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access\\\">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DeleteAlias</a> </p> </li> <li> <p> <a>ListAliases</a> </p> </li> <li> <p> <a>UpdateAlias</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"CreateCustomKeyStore\":{\
\"name\":\"CreateCustomKeyStore\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"CreateCustomKeyStoreRequest\"},\
\"output\":{\"shape\":\"CreateCustomKeyStoreResponse\"},\
\"errors\":[\
{\"shape\":\"CloudHsmClusterInUseException\"},\
{\"shape\":\"CustomKeyStoreNameInUseException\"},\
{\"shape\":\"CloudHsmClusterNotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"CloudHsmClusterNotActiveException\"},\
{\"shape\":\"IncorrectTrustAnchorException\"},\
{\"shape\":\"CloudHsmClusterInvalidConfigurationException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"XksProxyUriInUseException\"},\
{\"shape\":\"XksProxyUriEndpointInUseException\"},\
{\"shape\":\"XksProxyUriUnreachableException\"},\
{\"shape\":\"XksProxyIncorrectAuthenticationCredentialException\"},\
{\"shape\":\"XksProxyVpcEndpointServiceInUseException\"},\
{\"shape\":\"XksProxyVpcEndpointServiceNotFoundException\"},\
{\"shape\":\"XksProxyVpcEndpointServiceInvalidConfigurationException\"},\
{\"shape\":\"XksProxyInvalidResponseException\"},\
{\"shape\":\"XksProxyInvalidConfigurationException\"}\
],\
\"documentation\":\"<p>Creates a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a> backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html\\\">CloudHSM key stores</a> backed by an <a href=\\\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html\\\">CloudHSM cluster</a> and <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html\\\">external key stores</a> backed by an external key store proxy and external key manager outside of Amazon Web Services.</p> <p> This operation is part of the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.</p> <p>Before you create the custom key store, the required elements must be in place and operational. We recommend that you use the test tools that KMS provides to verify the configuration your external key store proxy. For details about the required elements and verification tests, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore\\\">Assemble the prerequisites (for CloudHSM key stores)</a> or <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements\\\">Assemble the prerequisites (for external key stores)</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>To create a custom key store, use the following parameters.</p> <ul> <li> <p>To create an CloudHSM key store, specify the <code>CustomKeyStoreName</code>, <code>CloudHsmClusterId</code>, <code>KeyStorePassword</code>, and <code>TrustAnchorCertificate</code>. The <code>CustomKeyStoreType</code> parameter is optional for CloudHSM key stores. If you include it, set it to the default value, <code>AWS_CLOUDHSM</code>. For help with failures, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\\\">Troubleshooting an CloudHSM key store</a> in the <i>Key Management Service Developer Guide</i>.</p> </li> <li> <p>To create an external key store, specify the <code>CustomKeyStoreName</code> and a <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>. Also, specify values for <code>XksProxyConnectivity</code>, <code>XksProxyAuthenticationCredential</code>, <code>XksProxyUriEndpoint</code>, and <code>XksProxyUriPath</code>. If your <code>XksProxyConnectivity</code> value is <code>VPC_ENDPOINT_SERVICE</code>, specify the <code>XksProxyVpcEndpointServiceName</code> parameter. For help with failures, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html\\\">Troubleshooting an external key store</a> in the <i>Key Management Service Developer Guide</i>.</p> </li> </ul> <note> <p>For external key stores:</p> <p>Some external key managers provide a simpler method for creating an external key store. For details, see your external key manager documentation.</p> <p>When creating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot use a proxy configuration with the <code>CreateCustomKeyStore</code> operation. However, you can use the values in the file to help you determine the correct values for the <code>CreateCustomKeyStore</code> parameters.</p> </note> <p>When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect a new CloudHSM key store to its CloudHSM cluster, or to connect a new external key store to the external key store proxy for your external key manager. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.</p> <p>For help with failures, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\\\">Troubleshooting a custom key store</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CreateCustomKeyStore</a> (IAM policy).</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ConnectCustomKeyStore</a> </p> </li> <li> <p> <a>DeleteCustomKeyStore</a> </p> </li> <li> <p> <a>DescribeCustomKeyStores</a> </p> </li> <li> <p> <a>DisconnectCustomKeyStore</a> </p> </li> <li> <p> <a>UpdateCustomKeyStore</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"CreateGrant\":{\
\"name\":\"CreateGrant\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"CreateGrantRequest\"},\
\"output\":{\"shape\":\"CreateGrantResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Adds a grant to a KMS key. </p> <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies. </p> <p>For detailed information about grants, including grant terminology, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html\\\">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of working with grants in several programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html\\\">Programming grants</a>. </p> <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a <code>GrantId</code>.</p> <ul> <li> <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant. </p> <p>However, to use the permissions in the grant immediately, use the <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token\\\">Using a grant token</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> </li> <li> <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can use the <code>GrantId</code> and a key identifier to identify the grant in the <a>RetireGrant</a> and <a>RevokeGrant</a> operations. To find the grant ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a> operations.</p> </li> </ul> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter. </p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CreateGrant</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ListGrants</a> </p> </li> <li> <p> <a>ListRetirableGrants</a> </p> </li> <li> <p> <a>RetireGrant</a> </p> </li> <li> <p> <a>RevokeGrant</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"CreateKey\":{\
\"name\":\"CreateKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"CreateKeyRequest\"},\
\"output\":{\"shape\":\"CreateKeyResponse\"},\
\"errors\":[\
{\"shape\":\"MalformedPolicyDocumentException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"TagException\"},\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"CustomKeyStoreInvalidStateException\"},\
{\"shape\":\"CloudHsmClusterInvalidConfigurationException\"},\
{\"shape\":\"XksKeyInvalidConfigurationException\"},\
{\"shape\":\"XksKeyAlreadyInUseException\"},\
{\"shape\":\"XksKeyNotFoundException\"}\
],\
\"documentation\":\"<p>Creates a unique customer managed <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys\\\">KMS key</a> in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.</p> <p>A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, description, and key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html\\\">Managing keys</a> in the <i>Key Management Service Developer Guide</i> </p> <p>Use the parameters of <code>CreateKey</code> to specify the type of KMS key, the source of its key material, its key policy, description, tags, and other properties.</p> <note> <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p> </note> <p>To create different types of KMS keys, use the following guidance:</p> <dl> <dt>Symmetric encryption KMS key</dt> <dd> <p>By default, <code>CreateKey</code> creates a symmetric encryption KMS key with key material that KMS generates. This is the basic and most widely used type of KMS key, and provides the best performance.</p> <p>To create a symmetric encryption KMS key, you don't need to specify any parameters. The default value for <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, the default value for <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, and the default value for <code>Origin</code>, <code>AWS_KMS</code>, create a symmetric encryption KMS key with KMS key material.</p> <p>If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p> <p> </p> </dd> <dt>Asymmetric KMS keys</dt> <dd> <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.</p> <p>Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to download the public key so it can be used outside of KMS. Each KMS key can have only one key usage. KMS keys with RSA key pairs can be used to encrypt and decrypt data or sign and verify messages (but not both). KMS keys with NIST-recommended ECC key pairs can be used to sign and verify messages or derive shared secrets (but not both). KMS keys with <code>ECC_SECG_P256K1</code> can be used only to sign and verify messages. KMS keys with SM2 key pairs (China Regions only) can be used to either encrypt and decrypt data, sign and verify messages, or derive shared secrets (you must choose one key usage type). For information about asymmetric KMS keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> </p> </dd> <dt>HMAC KMS key</dt> <dd> <p>To create an HMAC KMS key, set the <code>KeySpec</code> parameter to a key spec value for HMAC KMS keys. Then set the <code>KeyUsage</code> parameter to <code>GENERATE_VERIFY_MAC</code>. You must set the key usage even though <code>GENERATE_VERIFY_MAC</code> is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.</p> <p>HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (<a>GenerateMac</a>) and verify (<a>VerifyMac</a>) HMAC codes for messages up to 4096 bytes.</p> <p> </p> </dd> <dt>Multi-Region primary keys</dt> <dt>Imported key material</dt> <dd> <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region, use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its primary key to a replica key, use the <a>UpdatePrimaryRegion</a> operation.</p> <p>You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.</p> <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\\\">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> </p> </dd> <dd> <p>To import your own key material into a KMS key, begin by creating a KMS key with no key material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token. Use the wrapping public key to encrypt your key material. Then, use <a>ImportKeyMaterial</a> with your import token to import the key material. For step-by-step instructions, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing Key Material</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> <p>You can import key material into KMS keys of all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't import key material into a KMS key in a custom key store.</p> <p>To create a multi-Region primary key with imported key material, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For instructions, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html \\\">Importing key material into multi-Region keys</a>. For more information about multi-Region keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\\\">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> </p> </dd> <dt>Custom key store</dt> <dd> <p>A <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a> lets you protect your Amazon Web Services resources using keys in a backing key store that you own and manage. When you request a cryptographic operation with a KMS key in a custom key store, the operation is performed in the backing key store using its cryptographic keys.</p> <p>KMS supports <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html\\\">CloudHSM key stores</a> backed by an CloudHSM cluster and <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html\\\">external key stores</a> backed by an external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you specify an existing encryption key in the external key manager.</p> <note> <p>Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.</p> </note> <p>Before you create a KMS key in a custom key store, the <code>ConnectionState</code> of the key store must be <code>CONNECTED</code>. To connect the custom key store, use the <a>ConnectCustomKeyStore</a> operation. To find the <code>ConnectionState</code>, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>To create a KMS key in a custom key store, use the <code>CustomKeyStoreId</code>. Use the default <code>KeySpec</code> value, <code>SYMMETRIC_DEFAULT</code>, and the default <code>KeyUsage</code> value, <code>ENCRYPT_DECRYPT</code> to create a symmetric encryption key. No other key type is supported in a custom key store.</p> <p>To create a KMS key in an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html\\\">CloudHSM key store</a>, use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.</p> <p>To create a KMS key in an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html\\\">external key store</a>, use the <code>Origin</code> parameter with a value of <code>EXTERNAL_KEY_STORE</code> and an <code>XksKeyId</code> parameter that identifies an existing external key.</p> <note> <p>Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.</p> </note> </dd> </dl> <p> <b>Cross-account use</b>: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:CreateKey</a> (IAM policy). To use the <code>Tags</code> parameter, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:TagResource</a> (IAM policy). For examples and information about related permissions, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key\\\">Allow a user to create KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DescribeKey</a> </p> </li> <li> <p> <a>ListKeys</a> </p> </li> <li> <p> <a>ScheduleKeyDeletion</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"Decrypt\":{\
\"name\":\"Decrypt\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DecryptRequest\"},\
\"output\":{\"shape\":\"DecryptResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidCiphertextException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"IncorrectKeyException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:</p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> </ul> <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The <code>Decrypt</code> operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the <a href=\\\"https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/\\\">Amazon Web Services Encryption SDK</a> or <a href=\\\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html\\\">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with KMS.</p> <p>If the ciphertext was encrypted under a symmetric encryption KMS key, the <code>KeyId</code> parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the <code>Decrypt</code> operation fails. This practice ensures that you use the KMS key that you intend.</p> <p>Whenever possible, use key policies to give users permission to call the <code>Decrypt</code> operation on a particular KMS key, instead of using &IAM; policies. Otherwise, you might create an &IAM; policy that gives the user <code>Decrypt</code> permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for <code>Decrypt</code> permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices\\\">Best practices for IAM policies</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <code>Decrypt</code> also supports <a href=\\\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html\\\">Amazon Web Services Nitro Enclaves</a>, which provide an isolated compute environment in Amazon EC2. To call <code>Decrypt</code> for a Nitro enclave, use the <a href=\\\"https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk\\\">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the attestation document for the enclave. Instead of the plaintext data, the response includes the plaintext data encrypted with the public key from the attestation document (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html\\\">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. If you use the <code>KeyId</code> parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:Decrypt</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>ReEncrypt</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DeleteAlias\":{\
\"name\":\"DeleteAlias\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DeleteAliasRequest\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Deletes the specified alias. </p> <note> <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/abac.html\\\">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> </note> <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p> <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different KMS key, call <a>UpdateAlias</a>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p> <p> <b>Required permissions</b> </p> <ul> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DeleteAlias</a> on the alias (IAM policy).</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DeleteAlias</a> on the KMS key (key policy).</p> </li> </ul> <p>For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access\\\">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateAlias</a> </p> </li> <li> <p> <a>ListAliases</a> </p> </li> <li> <p> <a>UpdateAlias</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DeleteCustomKeyStore\":{\
\"name\":\"DeleteCustomKeyStore\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DeleteCustomKeyStoreRequest\"},\
\"output\":{\"shape\":\"DeleteCustomKeyStoreResponse\"},\
\"errors\":[\
{\"shape\":\"CustomKeyStoreHasCMKsException\"},\
{\"shape\":\"CustomKeyStoreInvalidStateException\"},\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"KMSInternalException\"}\
],\
\"documentation\":\"<p>Deletes a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys.</p> <p> This operation is part of the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.</p> <p>The custom key store that you delete cannot contain any <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys\\\">KMS keys</a>. Before deleting the key store, verify that you will never need to use any of the KMS keys in the key store for any <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\\\">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the KMS keys from the key store. After the required waiting period expires and all KMS keys are deleted from the custom key store, use <a>DisconnectCustomKeyStore</a> to disconnect the key store from KMS. Then, you can delete the custom key store.</p> <p>For keys in an CloudHSM key store, the <code>ScheduleKeyDeletion</code> operation makes a best effort to delete the key material from the associated cluster. However, you might need to manually <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key\\\">delete the orphaned key material</a> from the cluster and its backups. KMS never creates, manages, or deletes cryptographic keys in the external key manager associated with an external key store. You must manage them using your external key manager tools.</p> <p>Instead of deleting the custom key store, consider using the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store from its backing key store. While the key store is disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected custom key store at any time.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DeleteCustomKeyStore</a> (IAM policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ConnectCustomKeyStore</a> </p> </li> <li> <p> <a>CreateCustomKeyStore</a> </p> </li> <li> <p> <a>DescribeCustomKeyStores</a> </p> </li> <li> <p> <a>DisconnectCustomKeyStore</a> </p> </li> <li> <p> <a>UpdateCustomKeyStore</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DeleteImportedKeyMaterial\":{\
\"name\":\"DeleteImportedKeyMaterial\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DeleteImportedKeyMaterialRequest\"},\
\"errors\":[\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing Key Material</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to <code>PendingImport</code>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DeleteImportedKeyMaterial</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GetParametersForImport</a> </p> </li> <li> <p> <a>ImportKeyMaterial</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DeriveSharedSecret\":{\
\"name\":\"DeriveSharedSecret\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DeriveSharedSecretRequest\"},\
\"output\":{\"shape\":\"DeriveSharedSecretResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Derives a shared secret using a key agreement algorithm.</p> <note> <p>You must use an asymmetric NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) KMS key pair with a <code>KeyUsage</code> value of <code>KEY_AGREEMENT</code> to call DeriveSharedSecret.</p> </note> <p>DeriveSharedSecret uses the <a href=\\\"https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar3.pdf#page=60\\\">Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive</a> (ECDH) to establish a key agreement between two peers by deriving a shared secret from their elliptic curve public-private key pairs. You can use the raw shared secret that DeriveSharedSecret returns to derive a symmetric key that can encrypt and decrypt data that is sent between the two peers, or that can generate and verify HMACs. KMS recommends that you follow <a href=\\\"https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Cr2.pdf\\\">NIST recommendations for key derivation</a> when using the raw shared secret to derive a symmetric key.</p> <p>The following workflow demonstrates how to establish key agreement over an insecure communication channel using DeriveSharedSecret.</p> <ol> <li> <p> <b>Alice</b> calls <a>CreateKey</a> to create an asymmetric KMS key pair with a <code>KeyUsage</code> value of <code>KEY_AGREEMENT</code>.</p> <p>The asymmetric KMS key must use a NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key spec.</p> </li> <li> <p> <b>Bob</b> creates an elliptic curve key pair.</p> <p>Bob can call <a>CreateKey</a> to create an asymmetric KMS key pair or generate a key pair outside of KMS. Bob's key pair must use the same NIST-recommended elliptic curve (ECC) or SM2 (China Regions ony) curve as Alice.</p> </li> <li> <p>Alice and Bob <b>exchange their public keys</b> through an insecure communication channel (like the internet).</p> <p>Use <a>GetPublicKey</a> to download the public key of your asymmetric KMS key pair.</p> <note> <p>KMS strongly recommends verifying that the public key you receive came from the expected party before using it to derive a shared secret.</p> </note> </li> <li> <p> <b>Alice</b> calls DeriveSharedSecret.</p> <p>KMS uses the private key from the KMS key pair generated in <b>Step 1</b>, Bob's public key, and the Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive to derive the shared secret. The private key in your KMS key pair never leaves KMS unencrypted. DeriveSharedSecret returns the raw shared secret.</p> </li> <li> <p> <b>Bob</b> uses the Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive to calculate the same raw secret using his private key and Alice's public key.</p> </li> </ol> <p>To derive a shared secret you must provide a key agreement algorithm, the private key of the caller's asymmetric NIST-recommended elliptic curve or SM2 (China Regions only) KMS key pair, and the public key from your peer's NIST-recommended elliptic curve or SM2 (China Regions only) key pair. The public key can be from another asymmetric KMS key pair or from a key pair generated outside of KMS, but both key pairs must be on the same elliptic curve.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DeriveSharedSecret</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>GetPublicKey</a> </p> </li> <li> <p> <a>DescribeKey</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DescribeCustomKeyStores\":{\
\"name\":\"DescribeCustomKeyStores\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DescribeCustomKeyStoresRequest\"},\
\"output\":{\"shape\":\"DescribeCustomKeyStoresResponse\"},\
\"errors\":[\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"InvalidMarkerException\"},\
{\"shape\":\"KMSInternalException\"}\
],\
\"documentation\":\"<p>Gets information about <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> in the account and Region.</p> <p> This operation is part of the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.</p> <p>By default, this operation returns information about all custom key stores in the account and Region. To get only information about a particular custom key store, use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not both).</p> <p>To determine whether the custom key store is connected to its CloudHSM cluster or external key store proxy, use the <code>ConnectionState</code> element in the response. If an attempt to connect the custom key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has never been connected or you used the <a>DisconnectCustomKeyStore</a> operation to disconnect it. Otherwise, the connection state is CONNECTED. If your custom key store connection state is <code>CONNECTED</code> but you are having trouble using it, verify that the backing store is active and available. For an CloudHSM key store, verify that the associated CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For an external key store, verify that the external key store proxy and its associated external key manager are reachable and enabled.</p> <p> For help repairing your CloudHSM key store, see the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\\\">Troubleshooting CloudHSM key stores</a>. For help repairing your external key store, see the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html\\\">Troubleshooting external key stores</a>. Both topics are in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DescribeCustomKeyStores</a> (IAM policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ConnectCustomKeyStore</a> </p> </li> <li> <p> <a>CreateCustomKeyStore</a> </p> </li> <li> <p> <a>DeleteCustomKeyStore</a> </p> </li> <li> <p> <a>DisconnectCustomKeyStore</a> </p> </li> <li> <p> <a>UpdateCustomKeyStore</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DescribeKey\":{\
\"name\":\"DescribeKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DescribeKeyRequest\"},\
\"output\":{\"shape\":\"DescribeKeyResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"}\
],\
\"documentation\":\"<p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed key</a> or an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed key</a>.</p> <p>This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. It includes fields, like <code>KeySpec</code>, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports. </p> <p>For <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\\\">multi-Region keys</a>, <code>DescribeKey</code> displays the primary key and all related replica keys. For KMS keys in <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html\\\">CloudHSM key stores</a>, it includes information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html\\\">external key stores</a>, it includes the custom key store ID and the ID of the external key.</p> <p> <code>DescribeKey</code> does not return the following information:</p> <ul> <li> <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p> </li> <li> <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from being automatically rotated. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works\\\">How Automatic Key Rotation Works</a> in the <i>Key Management Service Developer Guide</i>.</p> </li> <li> <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p> </li> <li> <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p> </li> </ul> <p>In general, <code>DescribeKey</code> is a non-mutating operation. It returns data about KMS keys, but doesn't change them. However, Amazon Web Services services use <code>DescribeKey</code> to create <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed keys</a> from a <i>predefined Amazon Web Services alias</i> with no key ID.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DescribeKey</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GetKeyPolicy</a> </p> </li> <li> <p> <a>GetKeyRotationStatus</a> </p> </li> <li> <p> <a>ListAliases</a> </p> </li> <li> <p> <a>ListGrants</a> </p> </li> <li> <p> <a>ListKeys</a> </p> </li> <li> <p> <a>ListResourceTags</a> </p> </li> <li> <p> <a>ListRetirableGrants</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DisableKey\":{\
\"name\":\"DisableKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DisableKeyRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\\\">cryptographic operations</a>. </p> <p>For more information about how key state affects the use of a KMS key, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DisableKey</a> (key policy)</p> <p> <b>Related operations</b>: <a>EnableKey</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DisableKeyRotation\":{\
\"name\":\"DisableKeyRotation\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DisableKeyRotationRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"}\
],\
\"documentation\":\"<p>Disables <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\\\">automatic rotation of the key material</a> of the specified symmetric encryption KMS key.</p> <p>Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">asymmetric KMS keys</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html\\\">HMAC KMS keys</a>, KMS keys with <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">imported key material</a>, or KMS keys in a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. To enable or disable automatic rotation of a set of related <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate\\\">multi-Region keys</a>, set the property on the primary key.</p> <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation of the key material in <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed KMS keys</a>. Key material rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed KMS keys</a> is not configurable. KMS always rotates the key material for every year. Rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk\\\">Amazon Web Services owned KMS keys</a> varies.</p> <note> <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see <a>EnableKeyRotation</a>.</p> </note> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DisableKeyRotation</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>EnableKeyRotation</a> </p> </li> <li> <p> <a>GetKeyRotationStatus</a> </p> </li> <li> <p> <a>ListKeyRotations</a> </p> </li> <li> <p> <a>RotateKeyOnDemand</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"DisconnectCustomKeyStore\":{\
\"name\":\"DisconnectCustomKeyStore\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"DisconnectCustomKeyStoreRequest\"},\
\"output\":{\"shape\":\"DisconnectCustomKeyStoreResponse\"},\
\"errors\":[\
{\"shape\":\"CustomKeyStoreInvalidStateException\"},\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"KMSInternalException\"}\
],\
\"documentation\":\"<p>Disconnects the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a> from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager.</p> <p> This operation is part of the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key stores</a> feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.</p> <p>While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any time.</p> <note> <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\\\">cryptographic operations</a> will fail. This action can prevent users from storing and accessing sensitive data.</p> </note> <p>When you disconnect a custom key store, its <code>ConnectionState</code> changes to <code>Disconnected</code>. To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation. To reconnect a custom key store, use the <a>ConnectCustomKeyStore</a> operation.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:DisconnectCustomKeyStore</a> (IAM policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ConnectCustomKeyStore</a> </p> </li> <li> <p> <a>CreateCustomKeyStore</a> </p> </li> <li> <p> <a>DeleteCustomKeyStore</a> </p> </li> <li> <p> <a>DescribeCustomKeyStores</a> </p> </li> <li> <p> <a>UpdateCustomKeyStore</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"EnableKey\":{\
\"name\":\"EnableKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"EnableKeyRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\\\">cryptographic operations</a>. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:EnableKey</a> (key policy)</p> <p> <b>Related operations</b>: <a>DisableKey</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"EnableKeyRotation\":{\
\"name\":\"EnableKeyRotation\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"EnableKeyRotationRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"}\
],\
\"documentation\":\"<p>Enables <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable\\\">automatic rotation of the key material</a> of the specified symmetric encryption KMS key. </p> <p>By default, when you enable automatic rotation of a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed KMS key</a>, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can use the optional <code>RotationPeriodInDays</code> parameter to specify a custom rotation period when you enable key rotation, or you can use <code>RotationPeriodInDays</code> to modify the rotation period of a key that you previously enabled automatic key rotation on.</p> <p>You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the <a>DisableKeyRotation</a> operation. You can use the <a>GetKeyRotationStatus</a> operation to identify any in progress rotations. You can use the <a>ListKeyRotations</a> operation to view the details of completed rotations.</p> <p>Automatic key rotation is supported only on <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks\\\">symmetric encryption KMS keys</a>. You cannot enable automatic rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">asymmetric KMS keys</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html\\\">HMAC KMS keys</a>, KMS keys with <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">imported key material</a>, or KMS keys in a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. To enable or disable automatic rotation of a set of related <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate\\\">multi-Region keys</a>, set the property on the primary key. </p> <p>You cannot enable or disable automatic rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed KMS keys</a>. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk\\\">Amazon Web Services owned KMS keys</a> is managed by the Amazon Web Services service that owns the key.</p> <note> <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).</p> <p>New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter. </p> <p>Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.</p> </note> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:EnableKeyRotation</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DisableKeyRotation</a> </p> </li> <li> <p> <a>GetKeyRotationStatus</a> </p> </li> <li> <p> <a>ListKeyRotations</a> </p> </li> <li> <p> <a>RotateKeyOnDemand</a> </p> <note> <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.</p> </note> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"Encrypt\":{\
\"name\":\"Encrypt\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"EncryptRequest\"},\
\"output\":{\"shape\":\"EncryptResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or asymmetric KMS key with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>.</p> <p>You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a plaintext data key and an encrypted copy of that data key.</p> <p>If you use a symmetric encryption KMS key, you can use an encryption context to add additional security to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">Encryption Context</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The algorithm must be compatible with the KMS key spec.</p> <important> <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the encryption algorithm that you choose.</p> <ul> <li> <p>Symmetric encryption KMS keys</p> <ul> <li> <p> <code>SYMMETRIC_DEFAULT</code>: 4096 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_2048</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 214 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 190 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_3072</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 342 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 318 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_4096</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 470 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 446 bytes</p> </li> </ul> </li> <li> <p> <code>SM2PKE</code>: 1024 bytes (China Regions only)</p> </li> </ul> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:Encrypt</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateDataKey\":{\
\"name\":\"GenerateDataKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateDataKeyRequest\"},\
\"output\":{\"shape\":\"GenerateDataKeyResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.</p> <p>To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the <a>DescribeKey</a> operation.</p> <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter.</p> <p>To generate a 128-bit SM4 data key (China Regions only), specify a <code>KeySpec</code> value of <code>AES_128</code> or a <code>NumberOfBytes</code> value of <code>16</code>. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.</p> <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure random byte string, use <a>GenerateRandom</a>.</p> <p>You can use an optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">Encryption Context</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <code>GenerateDataKey</code> also supports <a href=\\\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html\\\">Amazon Web Services Nitro Enclaves</a>, which provide an isolated compute environment in Amazon EC2. To call <code>GenerateDataKey</code> for an Amazon Web Services Nitro enclave, use the <a href=\\\"https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk\\\">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the attestation document for the enclave. <code>GenerateDataKey</code> returns a copy of the data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the data key, the response includes a copy of the data key encrypted under the public key from the attestation document (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html\\\">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>How to use your data key</b> </p> <p>We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the <a href=\\\"https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/\\\">Amazon Web Services Encryption SDK</a>, the <a href=\\\"https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/\\\">Amazon DynamoDB Encryption Client</a>, or <a href=\\\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html\\\">Amazon S3 client-side encryption</a> to do these tasks for you.</p> <p>To encrypt data outside of KMS:</p> <ol> <li> <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p> </li> <li> <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the response) with the encrypted data.</p> </li> </ol> <p>To decrypt data outside of KMS:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.</p> </li> </ol> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateDataKey</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateDataKeyPair\":{\
\"name\":\"GenerateDataKeyPair\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateDataKeyPairRequest\"},\
\"output\":{\"shape\":\"GenerateDataKeyPairResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key. </p> <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p>To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p> <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.</p> <p>If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation. <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key pair.</p> <p> <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in <a href=\\\"https://tools.ietf.org/html/rfc5280\\\">RFC 5280</a>. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href=\\\"https://tools.ietf.org/html/rfc5958\\\">RFC 5958</a>.</p> <p> <code>GenerateDataKeyPair</code> also supports <a href=\\\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html\\\">Amazon Web Services Nitro Enclaves</a>, which provide an isolated compute environment in Amazon EC2. To call <code>GenerateDataKeyPair</code> for an Amazon Web Services Nitro enclave, use the <a href=\\\"https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk\\\">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the attestation document for the enclave. <code>GenerateDataKeyPair</code> returns the public data key and a copy of the private data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the private data key (<code>PrivateKeyPlaintext</code>), the response includes a copy of the private data key encrypted under the public key from the attestation document (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html\\\">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p> <p>You can use an optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">Encryption Context</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateDataKeyPair</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateDataKeyPairWithoutPlaintext\":{\
\"name\":\"GenerateDataKeyPairWithoutPlaintext\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateDataKeyPairWithoutPlaintextRequest\"},\
\"output\":{\"shape\":\"GenerateDataKeyPairWithoutPlaintextResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key. </p> <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p>To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p> <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.</p> <p> <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in <a href=\\\"https://tools.ietf.org/html/rfc5280\\\">RFC 5280</a>.</p> <p>You can use an optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">Encryption Context</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateDataKeyPairWithoutPlaintext</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateDataKeyWithoutPlaintext\":{\
\"name\":\"GenerateDataKeyWithoutPlaintext\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateDataKeyWithoutPlaintextRequest\"},\
\"output\":{\"shape\":\"GenerateDataKeyWithoutPlaintextResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Returns a unique symmetric data key for use outside of KMS. This operation returns a data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the key are random; they are not related to the caller or to the KMS key.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that it does not return a plaintext copy of the data key. </p> <p>This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the <a>Decrypt</a> operation on the encrypted copy of the key.</p> <p>It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.</p> <p>To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p> <p>To generate a data key, you must specify the symmetric encryption KMS key that is used to encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the type of your KMS key, use the <a>DescribeKey</a> operation.</p> <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter.</p> <p>To generate an SM4 data key (China Regions only), specify a <code>KeySpec</code> value of <code>AES_128</code> or <code>NumberOfBytes</code> value of <code>16</code>. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.</p> <p>If the operation succeeds, you will find the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>You can use an optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">Encryption Context</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateDataKeyWithoutPlaintext</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateMac\":{\
\"name\":\"GenerateMac\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateMacRequest\"},\
\"output\":{\"shape\":\"GenerateMacResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in <a href=\\\"https://datatracker.ietf.org/doc/html/rfc2104\\\">RFC 2104</a>.</p> <p>You can use value that GenerateMac returns in the <a>VerifyMac</a> operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. You can also use the raw result to implement HMAC-based algorithms such as key derivation functions. This operation is part of KMS support for HMAC KMS keys. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html\\\">HMAC keys in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> <note> <p>Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC. </p> </note> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateMac</a> (key policy)</p> <p> <b>Related operations</b>: <a>VerifyMac</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GenerateRandom\":{\
\"name\":\"GenerateRandom\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GenerateRandomRequest\"},\
\"output\":{\"shape\":\"GenerateRandomResponse\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"CustomKeyStoreInvalidStateException\"}\
],\
\"documentation\":\"<p>Returns a random byte string that is cryptographically secure.</p> <p>You must use the <code>NumberOfBytes</code> parameter to specify the length of the random byte string. There is no default value for string length.</p> <p>By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster associated with an CloudHSM key store, use the <code>CustomKeyStoreId</code> parameter.</p> <p> <code>GenerateRandom</code> also supports <a href=\\\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html\\\">Amazon Web Services Nitro Enclaves</a>, which provide an isolated compute environment in Amazon EC2. To call <code>GenerateRandom</code> for a Nitro enclave, use the <a href=\\\"https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk\\\">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the attestation document for the enclave. Instead of plaintext bytes, the response includes the plaintext bytes encrypted under the public key from the attestation document (<code>CiphertextForRecipient</code>).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html\\\">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>For more information about entropy and random number generation, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/cryptographic-details/\\\">Key Management Service Cryptographic Details</a>.</p> <p> <b>Cross-account use</b>: Not applicable. <code>GenerateRandom</code> does not use any account-specific resources, such as KMS keys.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GenerateRandom</a> (IAM policy)</p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GetKeyPolicy\":{\
\"name\":\"GetKeyPolicy\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GetKeyPolicyRequest\"},\
\"output\":{\"shape\":\"GetKeyPolicyResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Gets a key policy attached to the specified KMS key.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GetKeyPolicy</a> (key policy)</p> <p> <b>Related operations</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html\\\">PutKeyPolicy</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GetKeyRotationStatus\":{\
\"name\":\"GetKeyRotationStatus\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GetKeyRotationStatusRequest\"},\
\"output\":{\"shape\":\"GetKeyRotationStatusResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"}\
],\
\"documentation\":\"<p>Provides detailed information about the rotation status for a KMS key, including whether <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\\\">automatic rotation of the key material</a> is enabled for the specified KMS key, the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period\\\">rotation period</a>, and the next scheduled rotation date.</p> <p>Automatic key rotation is supported only on <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks\\\">symmetric encryption KMS keys</a>. You cannot enable automatic rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">asymmetric KMS keys</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html\\\">HMAC KMS keys</a>, KMS keys with <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">imported key material</a>, or KMS keys in a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. To enable or disable automatic rotation of a set of related <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate\\\">multi-Region keys</a>, set the property on the primary key..</p> <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation (<a>DisableKeyRotation</a>) of the key material in customer managed KMS keys. Key material rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed KMS keys</a> is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always <code>true</code>.</p> <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use <a>ListKeyRotations</a> to view the details of completed rotations.</p> <note> <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see <a>EnableKeyRotation</a>.</p> </note> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <ul> <li> <p>Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.</p> </li> <li> <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is <code>false</code> and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to <code>true</code>.</p> </li> </ul> <p> <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GetKeyRotationStatus</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DisableKeyRotation</a> </p> </li> <li> <p> <a>EnableKeyRotation</a> </p> </li> <li> <p> <a>ListKeyRotations</a> </p> </li> <li> <p> <a>RotateKeyOnDemand</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GetParametersForImport\":{\
\"name\":\"GetParametersForImport\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GetParametersForImportRequest\"},\
\"output\":{\"shape\":\"GetParametersForImportResponse\"},\
\"errors\":[\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Returns the public key and an import token you need to import or reimport key material for a KMS key. </p> <p>By default, KMS keys are created with key material that KMS generates. This operation supports <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing key material</a>, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing key material</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>Before calling <code>GetParametersForImport</code>, use the <a>CreateKey</a> operation with an <code>Origin</code> value of <code>EXTERNAL</code> to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\\\">multi-Region key</a> of any supported type. However, you can't import key material into a KMS key in a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. You can also use <code>GetParametersForImport</code> to get a public key and import token to <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material\\\">reimport the original key material</a> into a KMS key whose key material expired or was deleted.</p> <p> <code>GetParametersForImport</code> returns the items that you need to import your key material.</p> <ul> <li> <p>The public key (or \\\"wrapping key\\\") of an RSA key pair that KMS generates.</p> <p>You will use this public key to encrypt (\\\"wrap\\\") your key material while it's in transit to KMS. </p> </li> <li> <p>A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.</p> </li> </ul> <p>The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the <code>ParametersValidTo</code> field in the <code>GetParametersForImport</code> response. You cannot use an expired public key or import token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another <code>GetParametersForImport</code> request.</p> <p> <code>GetParametersForImport</code> requires the following information:</p> <ul> <li> <p>The key ID of the KMS key for which you are importing the key material.</p> </li> <li> <p>The key spec of the public key (\\\"wrapping key\\\") that you will use to encrypt your key material during import.</p> </li> <li> <p>The wrapping algorithm that you will use with the public key to encrypt your key material.</p> </li> </ul> <p>You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GetParametersForImport</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>ImportKeyMaterial</a> </p> </li> <li> <p> <a>DeleteImportedKeyMaterial</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"GetPublicKey\":{\
\"name\":\"GetPublicKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"GetPublicKeyRequest\"},\
\"output\":{\"shape\":\"GetPublicKeyResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>You do not need to download the public key. Instead, you can use the public key within KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the public key within KMS, you benefit from the authentication, authorization, and logging that are part of every KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of KMS.</p> <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns important information about the public key in the response, including:</p> <ul> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec\\\">KeySpec</a>: The type of key material in the public key, such as <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage\\\">KeyUsage</a>: Whether the key is used for encryption, signing, or deriving a shared secret.</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms\\\">EncryptionAlgorithms</a> or <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms\\\">SigningAlgorithms</a>: A list of the encryption algorithms or the signing algorithms for the key.</p> </li> </ul> <p>Although KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.</p> <p>To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses <code>1234567812345678</code> as the distinguishing ID. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification\\\">Offline verification with SM2 key pairs</a>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:GetPublicKey</a> (key policy)</p> <p> <b>Related operations</b>: <a>CreateKey</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ImportKeyMaterial\":{\
\"name\":\"ImportKeyMaterial\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ImportKeyMaterialRequest\"},\
\"output\":{\"shape\":\"ImportKeyMaterialResponse\"},\
\"errors\":[\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"InvalidCiphertextException\"},\
{\"shape\":\"IncorrectKeyMaterialException\"},\
{\"shape\":\"ExpiredImportTokenException\"},\
{\"shape\":\"InvalidImportTokenException\"}\
],\
\"documentation\":\"<p>Imports or reimports key material into an existing KMS key that was created without key material. <code>ImportKeyMaterial</code> also sets the expiration model and expiration date of the imported key material.</p> <p>By default, KMS keys are created with key material that KMS generates. This operation supports <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing key material</a>, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">Importing key material</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>After you successfully import key material into a KMS key, you can <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material\\\">reimport the same key material</a> into that KMS key, but you cannot import different key material. You might reimport key material to replace key material that expired or key material that you deleted. You might also reimport key material to change the expiration model or expiration date of the key material. </p> <p>Each time you import key material into KMS, you can determine whether (<code>ExpirationModel</code>) and when (<code>ValidTo</code>) the key material expires. To change the expiration of your key material, you must import it again, either by calling <code>ImportKeyMaterial</code> or using the <a href=\\\"kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-import-key-material-console\\\">import features</a> of the KMS console.</p> <p>Before calling <code>ImportKeyMaterial</code>:</p> <ul> <li> <p>Create or identify a KMS key with no key material. The KMS key must have an <code>Origin</code> value of <code>EXTERNAL</code>, which indicates that the KMS key is designed for imported key material. </p> <p>To create an new KMS key for imported key material, call the <a>CreateKey</a> operation with an <code>Origin</code> value of <code>EXTERNAL</code>. You can create a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a <a href=\\\"kms/latest/developerguide/multi-region-keys-overview.html\\\">multi-Region key</a> of any supported type. However, you can't import key material into a KMS key in a <a href=\\\"kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>.</p> </li> <li> <p>Use the <a>DescribeKey</a> operation to verify that the <code>KeyState</code> of the KMS key is <code>PendingImport</code>, which indicates that the KMS key has no key material. </p> <p>If you are reimporting the same key material into an existing KMS key, you might need to call the <a>DeleteImportedKeyMaterial</a> to delete its existing key material.</p> </li> <li> <p>Call the <a>GetParametersForImport</a> operation to get a public key and import token set for importing key material. </p> </li> <li> <p>Use the public key in the <a>GetParametersForImport</a> response to encrypt your key material.</p> </li> </ul> <p> Then, in an <code>ImportKeyMaterial</code> request, you submit your encrypted key material and import token. When calling this operation, you must specify the following values:</p> <ul> <li> <p>The key ID or key ARN of the KMS key to associate with the imported key material. Its <code>Origin</code> must be <code>EXTERNAL</code> and its <code>KeyState</code> must be <code>PendingImport</code>. You cannot perform this operation on a KMS key in a <a href=\\\"kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>, or on a KMS key in a different Amazon Web Services account. To get the <code>Origin</code> and <code>KeyState</code> of a KMS key, call <a>DescribeKey</a>.</p> </li> <li> <p>The encrypted key material. </p> </li> <li> <p>The import token that <a>GetParametersForImport</a> returned. You must use a public key and token from the same <code>GetParametersForImport</code> response.</p> </li> <li> <p>Whether the key material expires (<code>ExpirationModel</code>) and, if so, when (<code>ValidTo</code>). For help with this choice, see <a href=\\\"https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration\\\">Setting an expiration time</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>If you set an expiration date, KMS deletes the key material from the KMS key on the specified date, making the KMS key unusable. To use the KMS key in cryptographic operations again, you must reimport the same key material. However, you can delete and reimport the key material at any time, including before the key material expires. Each time you reimport, you can eliminate or reset the expiration time.</p> </li> </ul> <p>When this operation is successful, the key state of the KMS key changes from <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key in cryptographic operations.</p> <p>If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key and repeat the import procedure. For help, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview\\\">How To Import Key Material</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ImportKeyMaterial</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DeleteImportedKeyMaterial</a> </p> </li> <li> <p> <a>GetParametersForImport</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListAliases\":{\
\"name\":\"ListAliases\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListAliasesRequest\"},\
\"output\":{\"shape\":\"ListAliasesResponse\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidMarkerException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"NotFoundException\"}\
],\
\"documentation\":\"<p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and region. To get only the aliases associated with a particular KMS key, use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against your <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit\\\">KMS aliases quota</a>.</p> <p> <b>Cross-account use</b>: No. <code>ListAliases</code> does not return aliases in other Amazon Web Services accounts.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListAliases</a> (IAM policy)</p> <p>For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access\\\">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateAlias</a> </p> </li> <li> <p> <a>DeleteAlias</a> </p> </li> <li> <p> <a>UpdateAlias</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListGrants\":{\
\"name\":\"ListGrants\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListGrantsRequest\"},\
\"output\":{\"shape\":\"ListGrantsResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidMarkerException\"},\
{\"shape\":\"InvalidGrantIdException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Gets a list of all grants for the specified KMS key. </p> <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal.</p> <p>For detailed information about grants, including grant terminology, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html\\\">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of working with grants in several programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html\\\">Programming grants</a>. </p> <note> <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href=\\\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services\\\">service principal</a>, which might represent several different grantee principals.</p> </note> <p> <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListGrants</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateGrant</a> </p> </li> <li> <p> <a>ListRetirableGrants</a> </p> </li> <li> <p> <a>RetireGrant</a> </p> </li> <li> <p> <a>RevokeGrant</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListKeyPolicies\":{\
\"name\":\"ListKeyPolicies\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListKeyPoliciesRequest\"},\
\"output\":{\"shape\":\"ListKeyPoliciesResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation. However, the only valid policy name is <code>default</code>. </p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListKeyPolicies</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GetKeyPolicy</a> </p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html\\\">PutKeyPolicy</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListKeyRotations\":{\
\"name\":\"ListKeyRotations\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListKeyRotationsRequest\"},\
\"output\":{\"shape\":\"ListKeyRotationsResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"InvalidMarkerException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"}\
],\
\"documentation\":\"<p>Returns information about all completed key material rotations for the specified KMS key.</p> <p>You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.</p> <p>For detailed information about automatic and on-demand key rotations, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\\\">Rotating KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListKeyRotations</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>EnableKeyRotation</a> </p> </li> <li> <p> <a>DisableKeyRotation</a> </p> </li> <li> <p> <a>GetKeyRotationStatus</a> </p> </li> <li> <p> <a>RotateKeyOnDemand</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListKeys\":{\
\"name\":\"ListKeys\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListKeysRequest\"},\
\"output\":{\"shape\":\"ListKeysResponse\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"InvalidMarkerException\"}\
],\
\"documentation\":\"<p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListKeys</a> (IAM policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>DescribeKey</a> </p> </li> <li> <p> <a>ListAliases</a> </p> </li> <li> <p> <a>ListResourceTags</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListResourceTags\":{\
\"name\":\"ListResourceTags\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListResourceTagsRequest\"},\
\"output\":{\"shape\":\"ListResourceTagsResponse\"},\
\"errors\":[\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"InvalidMarkerException\"}\
],\
\"documentation\":\"<p>Returns all tags on the specified KMS key.</p> <p>For general information about tags, including the format and syntax, see <a href=\\\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\\\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. For information about using tags in KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html\\\">Tagging keys</a>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListResourceTags</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>ReplicateKey</a> </p> </li> <li> <p> <a>TagResource</a> </p> </li> <li> <p> <a>UntagResource</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ListRetirableGrants\":{\
\"name\":\"ListRetirableGrants\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ListRetirableGrantsRequest\"},\
\"output\":{\"shape\":\"ListGrantsResponse\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidMarkerException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"}\
],\
\"documentation\":\"<p>Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal. </p> <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p> <p>For detailed information about grants, including grant terminology, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html\\\">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of working with grants in several programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html\\\">Programming grants</a>. </p> <p> <b>Cross-account use</b>: You must specify a principal in your Amazon Web Services account. This operation returns a list of grants where the retiring principal specified in the <code>ListRetirableGrants</code> request is the same retiring principal on the grant. This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any Amazon Web Services account other than your own.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ListRetirableGrants</a> (IAM policy) in your Amazon Web Services account.</p> <note> <p>KMS authorizes <code>ListRetirableGrants</code> requests by evaluating the caller account's kms:ListRetirableGrants permissions. The authorized resource in <code>ListRetirableGrants</code> calls is the retiring principal specified in the request. KMS does not evaluate the caller's permissions to verify their access to any KMS keys or grants that might be returned by the <code>ListRetirableGrants</code> call.</p> </note> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateGrant</a> </p> </li> <li> <p> <a>ListGrants</a> </p> </li> <li> <p> <a>RetireGrant</a> </p> </li> <li> <p> <a>RevokeGrant</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"PutKeyPolicy\":{\
\"name\":\"PutKeyPolicy\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"PutKeyPolicyRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"MalformedPolicyDocumentException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Attaches a key policy to the specified KMS key. </p> <p>For more information about key policies, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\\\">Key Policies</a> in the <i>Key Management Service Developer Guide</i>. For help writing and formatting a JSON policy document, see the <a href=\\\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html\\\">IAM JSON Policy Reference</a> in the <i> <i>Identity and Access Management User Guide</i> </i>. For examples of adding a key policy in multiple programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy\\\">Setting a key policy</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:PutKeyPolicy</a> (key policy)</p> <p> <b>Related operations</b>: <a>GetKeyPolicy</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ReEncrypt\":{\
\"name\":\"ReEncrypt\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ReEncryptRequest\"},\
\"output\":{\"shape\":\"ReEncryptResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidCiphertextException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"IncorrectKeyException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually\\\">manually rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\\\">encryption context</a> of a ciphertext.</p> <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using a KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the public key of an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks\\\">asymmetric KMS key</a> outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the <a href=\\\"https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/\\\">Amazon Web Services Encryption SDK</a> or <a href=\\\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html\\\">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with KMS.</p> <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.</p> <ul> <li> <p>If your ciphertext was encrypted under an asymmetric KMS key, you must use the <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.</p> </li> <li> <p>If your ciphertext was encrypted under a symmetric encryption KMS key, the <code>SourceKeyId</code> parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the <code>SourceKeyId</code> parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the <code>ReEncrypt</code> operation fails. This practice ensures that you use the KMS key that you intend.</p> </li> <li> <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter to specify the KMS key that re-encrypts the data after it is decrypted. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key.</p> <important> <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> </li> </ul> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, you must use its key ARN or alias ARN.</p> <p> <b>Required permissions</b>:</p> <ul> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ReEncryptFrom</a> permission on the source KMS key (key policy)</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:ReEncryptTo</a> permission on the destination KMS key (key policy)</p> </li> </ul> <p>To permit reencryption from or to a KMS key, include the <code>\\\"kms:ReEncrypt*\\\"</code> permission in your <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\\\">key policy</a>. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ReplicateKey\":{\
\"name\":\"ReplicateKey\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ReplicateKeyRequest\"},\
\"output\":{\"shape\":\"ReplicateKeyResponse\"},\
\"errors\":[\
{\"shape\":\"AlreadyExistsException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"MalformedPolicyDocumentException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"TagException\"},\
{\"shape\":\"UnsupportedOperationException\"}\
],\
\"documentation\":\"<p>Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the <a>CreateKey</a> operation.</p> <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\\\">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>A <i>replica key</i> is a fully-functional KMS key that can be used independently of its primary and peer replica keys. A primary key and its replica keys share properties that make them interoperable. They have the same <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id\\\">key ID</a> and key material. They also have the same <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec\\\">key spec</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage\\\">key usage</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin\\\">key material origin</a>, and <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\\\">automatic key rotation status</a>. KMS automatically synchronizes these shared properties among related multi-Region keys. All other properties of a replica key can differ, including its <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\\\">key policy</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html\\\">tags</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html\\\">aliases</a>, and <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica key.</p> <p>When this operation completes, the new replica key has a transient key state of <code>Creating</code>. This key state changes to <code>Enabled</code> (or <code>PendingImport</code>) after a few seconds when the process of creating the new replica key is complete. While the key state is <code>Creating</code>, you can manage key, but you cannot yet use it in cryptographic operations. If you are creating and using the replica key programmatically, retry on <code>KMSInvalidStateException</code> or call <code>DescribeKey</code> to check its <code>KeyState</code> value before using it. For details about the <code>Creating</code> key state, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>You cannot create more than one replica of a primary key in any Region. If the Region already includes a replica of the key you're trying to replicate, <code>ReplicateKey</code> returns an <code>AlreadyExistsException</code> error. If the key state of the existing replica is <code>PendingDeletion</code>, you can cancel the scheduled key deletion (<a>CancelKeyDeletion</a>) or wait for the key to be deleted. The new replica key you create will have the same <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties\\\">shared properties</a> as the original replica key.</p> <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p> <p>If you replicate a multi-Region primary key with imported key material, the replica key is created with no key material. You must import the same key material that you imported into the primary key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html\\\">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a> operation.</p> <note> <p> <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code> and <code>Tags</code> parameters than those used in the KMS console. For details, see the parameter descriptions.</p> </note> <p> <b>Cross-account use</b>: No. You cannot use this operation to create a replica key in a different Amazon Web Services account. </p> <p> <b>Required permissions</b>: </p> <ul> <li> <p> <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region). Include this permission in the primary key's key policy.</p> </li> <li> <p> <code>kms:CreateKey</code> in an IAM policy in the replica Region.</p> </li> <li> <p>To use the <code>Tags</code> parameter, <code>kms:TagResource</code> in an IAM policy in the replica Region.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>UpdatePrimaryRegion</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"RetireGrant\":{\
\"name\":\"RetireGrant\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"RetireGrantRequest\"},\
\"errors\":[\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"InvalidGrantIdException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token\\\">grant token</a>, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation returns both values.</p> <p>This operation can be called by the <i>retiring principal</i> for a grant, by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code> operation, and by the Amazon Web Services account in which the grant is created. It can also be called by principals to whom permission for retiring a grant is delegated. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete\\\">Retiring and revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>For detailed information about grants, including grant terminology, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html\\\">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of working with grants in several programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html\\\">Programming grants</a>. </p> <p> <b>Cross-account use</b>: Yes. You can retire a grant on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: Permission to retire a grant is determined primarily by the grant. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete\\\">Retiring and revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateGrant</a> </p> </li> <li> <p> <a>ListGrants</a> </p> </li> <li> <p> <a>ListRetirableGrants</a> </p> </li> <li> <p> <a>RevokeGrant</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"RevokeGrant\":{\
\"name\":\"RevokeGrant\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"RevokeGrantRequest\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"InvalidGrantIdException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete\\\">Retiring and revoking grants</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency\\\">Eventual consistency</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. </p> <p>For detailed information about grants, including grant terminology, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/grants.html\\\">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of working with grants in several programming languages, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html\\\">Programming grants</a>. </p> <p> <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:RevokeGrant</a> (key policy).</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateGrant</a> </p> </li> <li> <p> <a>ListGrants</a> </p> </li> <li> <p> <a>ListRetirableGrants</a> </p> </li> <li> <p> <a>RetireGrant</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"RotateKeyOnDemand\":{\
\"name\":\"RotateKeyOnDemand\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"RotateKeyOnDemandRequest\"},\
\"output\":{\"shape\":\"RotateKeyOnDemandResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"UnsupportedOperationException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"ConflictException\"}\
],\
\"documentation\":\"<p>Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.</p> <p>You can perform <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand\\\">on-demand rotation</a> of the key material in customer managed KMS keys, regardless of whether or not <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable\\\">automatic key rotation</a> is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.</p> <note> <p>You can perform on-demand key rotation a <b>maximum of 10 times</b> per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.</p> </note> <p>You can use <a>GetKeyRotationStatus</a> to identify any in progress on-demand rotations. You can use <a>ListKeyRotations</a> to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.</p> <p>On-demand key rotation is supported only on <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks\\\">symmetric encryption KMS keys</a>. You cannot perform on-demand rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">asymmetric KMS keys</a>, <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html\\\">HMAC KMS keys</a>, KMS keys with <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\\\">imported key material</a>, or KMS keys in a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\\\">custom key store</a>. To perform on-demand rotation of a set of related <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate\\\">multi-Region keys</a>, invoke the on-demand rotation on the primary key.</p> <p>You cannot initiate on-demand rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed KMS keys</a>. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk\\\">Amazon Web Services owned KMS keys</a> is managed by the Amazon Web Services service that owns the key.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:RotateKeyOnDemand</a> (key policy)</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>EnableKeyRotation</a> </p> </li> <li> <p> <a>DisableKeyRotation</a> </p> </li> <li> <p> <a>GetKeyRotationStatus</a> </p> </li> <li> <p> <a>ListKeyRotations</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"ScheduleKeyDeletion\":{\
\"name\":\"ScheduleKeyDeletion\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"ScheduleKeyDeletionRequest\"},\
\"output\":{\"shape\":\"ScheduleKeyDeletionResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.</p> <important> <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html\\\">multi-Region replica key</a>, or an <a href=\\\"kms/latest/developerguide/importing-keys-managing.html#import-delete-key\\\">asymmetric or HMAC KMS key with imported key material</a>.) To prevent the use of a KMS key without deleting it, use <a>DisableKey</a>. </p> </important> <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to <code>PendingReplicaDeletion</code> and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>) begins. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html\\\">Deleting multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>When KMS <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html\\\">deletes a KMS key from an CloudHSM key store</a>, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key\\\">delete the orphaned key material</a> from the cluster and its backups. <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html\\\">Deleting a KMS key from an external key store</a> has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.</p> <p>For more information about scheduling a KMS key for deletion, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\\\">Deleting KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: kms:ScheduleKeyDeletion (key policy)</p> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CancelKeyDeletion</a> </p> </li> <li> <p> <a>DisableKey</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"Sign\":{\
\"name\":\"Sign\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"SignRequest\"},\
\"output\":{\"shape\":\"SignResponse\"},\
\"errors\":[\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"DisabledException\"},\
{\"shape\":\"KeyUnavailableException\"},\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"InvalidKeyUsageException\"},\
{\"shape\":\"InvalidGrantTokenException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"DryRunOperationException\"}\
],\
\"documentation\":\"<p>Creates a <a href=\\\"https://en.wikipedia.org/wiki/Digital_signature\\\">digital signature</a> for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the <a>Verify</a> operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\\\">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. </p> <p>To use the <code>Sign</code> operation, provide the following information:</p> <ul> <li> <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a> operation. The caller must have <code>kms:Sign</code> permission on the KMS key.</p> </li> <li> <p>Use the <code>Message</code> parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the <code>Message</code> parameter. To indicate whether the message is a full message or a digest, use the <code>MessageType</code> parameter.</p> </li> <li> <p>Choose a signing algorithm that is compatible with the KMS key. </p> </li> </ul> <important> <p>When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature.</p> </important> <note> <p>Best practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message to help you detect when its time to refresh the signature. </p> </note> <p>To verify the signature that this operation generates, use the <a>Verify</a> operation. Or use the <a>GetPublicKey</a> operation to download the public key and then use the public key to verify the signature outside of KMS. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:Sign</a> (key policy)</p> <p> <b>Related operations</b>: <a>Verify</a> </p> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"TagResource\":{\
\"name\":\"TagResource\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"TagResourceRequest\"},\
\"errors\":[\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"TagException\"}\
],\
\"documentation\":\"<p>Adds or edits tags on a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed key</a>.</p> <note> <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/abac.html\\\">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> </note> <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.</p> <p>You can use this operation to tag a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed key</a>, but you cannot tag an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\\\">Amazon Web Services managed key</a>, an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk\\\">Amazon Web Services owned key</a>, a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept\\\">custom key store</a>, or an <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept\\\">alias</a>.</p> <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or replicating it (<a>ReplicateKey</a>).</p> <p>For information about using tags in KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html\\\">Tagging keys</a>. For general information about tags, including the format and syntax, see <a href=\\\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\\\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:TagResource</a> (key policy)</p> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>ListResourceTags</a> </p> </li> <li> <p> <a>ReplicateKey</a> </p> </li> <li> <p> <a>UntagResource</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"UntagResource\":{\
\"name\":\"UntagResource\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"UntagResourceRequest\"},\
\"errors\":[\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"InvalidArnException\"},\
{\"shape\":\"KMSInvalidStateException\"},\
{\"shape\":\"TagException\"}\
],\
\"documentation\":\"<p>Deletes tags from a <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\\\">customer managed key</a>. To delete a tag, specify the tag key and the KMS key.</p> <note> <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/abac.html\\\">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> </note> <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output. Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p> <p>For information about using tags in KMS, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html\\\">Tagging keys</a>. For general information about tags, including the format and syntax, see <a href=\\\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\\\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p> <p> <b>Required permissions</b>: <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:UntagResource</a> (key policy)</p> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>ListResourceTags</a> </p> </li> <li> <p> <a>ReplicateKey</a> </p> </li> <li> <p> <a>TagResource</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"UpdateAlias\":{\
\"name\":\"UpdateAlias\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"UpdateAliasRequest\"},\
\"errors\":[\
{\"shape\":\"DependencyTimeoutException\"},\
{\"shape\":\"NotFoundException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"LimitExceededException\"},\
{\"shape\":\"KMSInvalidStateException\"}\
],\
\"documentation\":\"<p>Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.</p> <note> <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/abac.html\\\">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p> </note> <p>The current and new KMS key must be the same type (both symmetric or both asymmetric or both HMAC), and they must have the same key usage. This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>Because an alias is not a property of a KMS key, you can create, update, and delete the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys in the account, use the <a>ListAliases</a> operation. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\\\">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p> <p> <b>Required permissions</b> </p> <ul> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:UpdateAlias</a> on the alias (IAM policy).</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:UpdateAlias</a> on the current KMS key (key policy).</p> </li> <li> <p> <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\\\">kms:UpdateAlias</a> on the new KMS key (key policy).</p> </li> </ul> <p>For details, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access\\\">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateAlias</a> </p> </li> <li> <p> <a>DeleteAlias</a> </p> </li> <li> <p> <a>ListAliases</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href=\\\"https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html\\\">KMS eventual consistency</a>.</p>\"\
},\
\"UpdateCustomKeyStore\":{\
\"name\":\"UpdateCustomKeyStore\",\
\"http\":{\
\"method\":\"POST\",\
\"requestUri\":\"/\"\
},\
\"input\":{\"shape\":\"UpdateCustomKeyStoreRequest\"},\
\"output\":{\"shape\":\"UpdateCustomKeyStoreResponse\"},\
\"errors\":[\
{\"shape\":\"CustomKeyStoreNotFoundException\"},\
{\"shape\":\"CustomKeyStoreNameInUseException\"},\
{\"shape\":\"CloudHsmClusterNotFoundException\"},\
{\"shape\":\"CloudHsmClusterNotRelatedException\"},\
{\"shape\":\"CustomKeyStoreInvalidStateException\"},\
{\"shape\":\"KMSInternalException\"},\
{\"shape\":\"CloudHsmClusterNotActiveException\"},\
{\"shape\":\"CloudHsmClusterInvalidConfigurationException\"},\
{\"shape\":\"XksProxyUriInUseException\"},\
{\"shape\":\"XksProxyUriEndpointInUseException\"},\
{\"shape\":\"XksProxyUriUnreachableException\"},\
{\"shape\":\"XksProxyIncorrectAuthenticationCredentialException\"},\
{\"shape\":\"XksProxyVpcEndpointServiceInUseException\"},\