aws-sdk-kms 1.73.0 → 1.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kms/client.rb +269 -54
- data/lib/aws-sdk-kms/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-kms/plugins/endpoints.rb +3 -2
- data/lib/aws-sdk-kms/types.rb +36 -32
- data/lib/aws-sdk-kms.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kms/client.rb
CHANGED
@@ -417,11 +417,15 @@ module Aws::KMS
|
|
417
417
|
#
|
418
418
|
# **Related operations**: ScheduleKeyDeletion
|
419
419
|
#
|
420
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
421
|
+
# model. For more information, see [KMS eventual consistency][4].
|
422
|
+
#
|
420
423
|
#
|
421
424
|
#
|
422
425
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
|
423
426
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
424
427
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
428
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
425
429
|
#
|
426
430
|
# @option params [required, String] :key_id
|
427
431
|
# Identifies the KMS key whose deletion is being canceled.
|
@@ -564,6 +568,9 @@ module Aws::KMS
|
|
564
568
|
#
|
565
569
|
# * UpdateCustomKeyStore
|
566
570
|
#
|
571
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
572
|
+
# model. For more information, see [KMS eventual consistency][8].
|
573
|
+
#
|
567
574
|
#
|
568
575
|
#
|
569
576
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
@@ -573,6 +580,7 @@ module Aws::KMS
|
|
573
580
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
|
574
581
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
|
575
582
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
583
|
+
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
576
584
|
#
|
577
585
|
# @option params [required, String] :custom_key_store_id
|
578
586
|
# Enter the key store ID of the custom key store that you want to
|
@@ -664,6 +672,9 @@ module Aws::KMS
|
|
664
672
|
#
|
665
673
|
# * UpdateAlias
|
666
674
|
#
|
675
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
676
|
+
# model. For more information, see [KMS eventual consistency][7].
|
677
|
+
#
|
667
678
|
#
|
668
679
|
#
|
669
680
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
|
@@ -672,6 +683,7 @@ module Aws::KMS
|
|
672
683
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
673
684
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
674
685
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
|
686
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
675
687
|
#
|
676
688
|
# @option params [required, String] :alias_name
|
677
689
|
# Specifies the alias name. This value must begin with `alias/` followed
|
@@ -829,6 +841,9 @@ module Aws::KMS
|
|
829
841
|
#
|
830
842
|
# * UpdateCustomKeyStore
|
831
843
|
#
|
844
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
845
|
+
# model. For more information, see [KMS eventual consistency][10].
|
846
|
+
#
|
832
847
|
#
|
833
848
|
#
|
834
849
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
@@ -840,6 +855,7 @@ module Aws::KMS
|
|
840
855
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
|
841
856
|
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
|
842
857
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
858
|
+
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
843
859
|
#
|
844
860
|
# @option params [required, String] :custom_key_store_name
|
845
861
|
# Specifies a friendly name for the custom key store. The name must be
|
@@ -936,7 +952,7 @@ module Aws::KMS
|
|
936
952
|
#
|
937
953
|
# * An external key store with `PUBLIC_ENDPOINT` connectivity cannot use
|
938
954
|
# the same `XksProxyUriEndpoint` value as an external key store with
|
939
|
-
# `VPC_ENDPOINT_SERVICE` connectivity in
|
955
|
+
# `VPC_ENDPOINT_SERVICE` connectivity in this Amazon Web Services
|
940
956
|
# Region.
|
941
957
|
#
|
942
958
|
# * Each external key store with `VPC_ENDPOINT_SERVICE` connectivity
|
@@ -1184,6 +1200,9 @@ module Aws::KMS
|
|
1184
1200
|
#
|
1185
1201
|
# * RevokeGrant
|
1186
1202
|
#
|
1203
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
1204
|
+
# model. For more information, see [KMS eventual consistency][6].
|
1205
|
+
#
|
1187
1206
|
#
|
1188
1207
|
#
|
1189
1208
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
|
@@ -1191,6 +1210,7 @@ module Aws::KMS
|
|
1191
1210
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
|
1192
1211
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
1193
1212
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
1213
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
1194
1214
|
#
|
1195
1215
|
# @option params [required, String] :key_id
|
1196
1216
|
# Identifies the KMS key for the grant. The grant gives principals
|
@@ -1609,6 +1629,9 @@ module Aws::KMS
|
|
1609
1629
|
#
|
1610
1630
|
# * ScheduleKeyDeletion
|
1611
1631
|
#
|
1632
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
1633
|
+
# model. For more information, see [KMS eventual consistency][12].
|
1634
|
+
#
|
1612
1635
|
#
|
1613
1636
|
#
|
1614
1637
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys
|
@@ -1622,6 +1645,7 @@ module Aws::KMS
|
|
1622
1645
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
|
1623
1646
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
1624
1647
|
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key
|
1648
|
+
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
1625
1649
|
#
|
1626
1650
|
# @option params [String] :policy
|
1627
1651
|
# The key policy to attach to the KMS key.
|
@@ -1843,12 +1867,13 @@ module Aws::KMS
|
|
1843
1867
|
# Management Service Developer Guide*.
|
1844
1868
|
#
|
1845
1869
|
# Use this parameter only when you intend to prevent the principal that
|
1846
|
-
# is making the request from making a subsequent PutKeyPolicy
|
1847
|
-
# the KMS key.
|
1870
|
+
# is making the request from making a subsequent [PutKeyPolicy][2]
|
1871
|
+
# request on the KMS key.
|
1848
1872
|
#
|
1849
1873
|
#
|
1850
1874
|
#
|
1851
1875
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
1876
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
|
1852
1877
|
#
|
1853
1878
|
# @option params [Array<Types::Tag>] :tags
|
1854
1879
|
# Assigns one or more tags to the KMS key. Use this parameter to tag the
|
@@ -2350,10 +2375,10 @@ module Aws::KMS
|
|
2350
2375
|
# parameter to provide the attestation document for the enclave. Instead
|
2351
2376
|
# of the plaintext data, the response includes the plaintext data
|
2352
2377
|
# encrypted with the public key from the attestation document
|
2353
|
-
# (`CiphertextForRecipient`).For information about the interaction
|
2378
|
+
# (`CiphertextForRecipient`). For information about the interaction
|
2354
2379
|
# between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon
|
2355
2380
|
# Web Services Nitro Enclaves uses KMS][7] in the *Key Management
|
2356
|
-
# Service Developer Guide
|
2381
|
+
# Service Developer Guide*.
|
2357
2382
|
#
|
2358
2383
|
# The KMS key that you use for this operation must be in a compatible
|
2359
2384
|
# key state. For details, see [Key states of KMS keys][8] in the *Key
|
@@ -2375,6 +2400,9 @@ module Aws::KMS
|
|
2375
2400
|
#
|
2376
2401
|
# * ReEncrypt
|
2377
2402
|
#
|
2403
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
2404
|
+
# model. For more information, see [KMS eventual consistency][10].
|
2405
|
+
#
|
2378
2406
|
#
|
2379
2407
|
#
|
2380
2408
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
@@ -2386,6 +2414,7 @@ module Aws::KMS
|
|
2386
2414
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
|
2387
2415
|
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
2388
2416
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
2417
|
+
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
2389
2418
|
#
|
2390
2419
|
# @option params [required, String, StringIO, File] :ciphertext_blob
|
2391
2420
|
# Ciphertext to be decrypted. The blob includes metadata.
|
@@ -2492,7 +2521,7 @@ module Aws::KMS
|
|
2492
2521
|
#
|
2493
2522
|
#
|
2494
2523
|
#
|
2495
|
-
# [1]: https://docs.aws.amazon.com/
|
2524
|
+
# [1]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc
|
2496
2525
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
2497
2526
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
|
2498
2527
|
#
|
@@ -2643,11 +2672,15 @@ module Aws::KMS
|
|
2643
2672
|
#
|
2644
2673
|
# * UpdateAlias
|
2645
2674
|
#
|
2675
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
2676
|
+
# model. For more information, see [KMS eventual consistency][4].
|
2677
|
+
#
|
2646
2678
|
#
|
2647
2679
|
#
|
2648
2680
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
|
2649
2681
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
2650
2682
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
|
2683
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
2651
2684
|
#
|
2652
2685
|
# @option params [required, String] :alias_name
|
2653
2686
|
# The alias to be deleted. The alias name must begin with `alias/`
|
@@ -2734,6 +2767,9 @@ module Aws::KMS
|
|
2734
2767
|
#
|
2735
2768
|
# * UpdateCustomKeyStore
|
2736
2769
|
#
|
2770
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
2771
|
+
# model. For more information, see [KMS eventual consistency][6].
|
2772
|
+
#
|
2737
2773
|
#
|
2738
2774
|
#
|
2739
2775
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
@@ -2741,6 +2777,7 @@ module Aws::KMS
|
|
2741
2777
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
|
2742
2778
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key
|
2743
2779
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
2780
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
2744
2781
|
#
|
2745
2782
|
# @option params [required, String] :custom_key_store_id
|
2746
2783
|
# Enter the ID of the custom key store you want to delete. To find the
|
@@ -2804,11 +2841,15 @@ module Aws::KMS
|
|
2804
2841
|
#
|
2805
2842
|
# * ImportKeyMaterial
|
2806
2843
|
#
|
2844
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
2845
|
+
# model. For more information, see [KMS eventual consistency][4].
|
2846
|
+
#
|
2807
2847
|
#
|
2808
2848
|
#
|
2809
2849
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
2810
2850
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
2811
2851
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
2852
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
2812
2853
|
#
|
2813
2854
|
# @option params [required, String] :key_id
|
2814
2855
|
# Identifies the KMS key from which you are deleting imported key
|
@@ -2905,12 +2946,16 @@ module Aws::KMS
|
|
2905
2946
|
#
|
2906
2947
|
# * UpdateCustomKeyStore
|
2907
2948
|
#
|
2949
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
2950
|
+
# model. For more information, see [KMS eventual consistency][5].
|
2951
|
+
#
|
2908
2952
|
#
|
2909
2953
|
#
|
2910
2954
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
2911
2955
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
|
2912
2956
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
|
2913
2957
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
2958
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
2914
2959
|
#
|
2915
2960
|
# @option params [String] :custom_key_store_id
|
2916
2961
|
# Gets only information about the specified custom key store. Enter the
|
@@ -3094,15 +3139,11 @@ module Aws::KMS
|
|
3094
3139
|
# also displays the key usage (encryption, signing, or generating and
|
3095
3140
|
# verifying MACs) and the algorithms that the KMS key supports.
|
3096
3141
|
#
|
3097
|
-
# For [multi-Region
|
3098
|
-
# keys]
|
3099
|
-
#
|
3100
|
-
# For KMS keys in [
|
3101
|
-
#
|
3102
|
-
# information about the key store, such as the key store ID and the
|
3103
|
-
# CloudHSM cluster ID. For KMS keys in [external key
|
3104
|
-
# stores](kms/latest/developerguide/keystore-external.html), it includes
|
3105
|
-
# the custom key store ID and the ID of the external key.
|
3142
|
+
# For [multi-Region keys][3], `DescribeKey` displays the primary key and
|
3143
|
+
# all related replica keys. For KMS keys in [CloudHSM key stores][4], it
|
3144
|
+
# includes information about the key store, such as the key store ID and
|
3145
|
+
# the CloudHSM cluster ID. For KMS keys in [external key stores][5], it
|
3146
|
+
# includes the custom key store ID and the ID of the external key.
|
3106
3147
|
#
|
3107
3148
|
# `DescribeKey` does not return the following information:
|
3108
3149
|
#
|
@@ -3112,7 +3153,7 @@ module Aws::KMS
|
|
3112
3153
|
# * Whether automatic key rotation is enabled on the KMS key. To get
|
3113
3154
|
# this information, use GetKeyRotationStatus. Also, some key states
|
3114
3155
|
# prevent a KMS key from being automatically rotated. For details, see
|
3115
|
-
# [How Automatic Key Rotation Works][
|
3156
|
+
# [How Automatic Key Rotation Works][6] in the *Key Management Service
|
3116
3157
|
# Developer Guide*.
|
3117
3158
|
#
|
3118
3159
|
# * Tags on the KMS key. To get this information, use ListResourceTags.
|
@@ -3129,7 +3170,7 @@ module Aws::KMS
|
|
3129
3170
|
# in a different Amazon Web Services account, specify the key ARN or
|
3130
3171
|
# alias ARN in the value of the `KeyId` parameter.
|
3131
3172
|
#
|
3132
|
-
# **Required permissions**: [kms:DescribeKey][
|
3173
|
+
# **Required permissions**: [kms:DescribeKey][7] (key policy)
|
3133
3174
|
#
|
3134
3175
|
# **Related operations:**
|
3135
3176
|
#
|
@@ -3147,12 +3188,19 @@ module Aws::KMS
|
|
3147
3188
|
#
|
3148
3189
|
# * ListRetirableGrants
|
3149
3190
|
#
|
3191
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3192
|
+
# model. For more information, see [KMS eventual consistency][8].
|
3193
|
+
#
|
3150
3194
|
#
|
3151
3195
|
#
|
3152
3196
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
3153
3197
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
3154
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
3155
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
3198
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
3199
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html
|
3200
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
|
3201
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works
|
3202
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3203
|
+
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3156
3204
|
#
|
3157
3205
|
# @option params [required, String] :key_id
|
3158
3206
|
# Describes the specified KMS key.
|
@@ -3483,11 +3531,15 @@ module Aws::KMS
|
|
3483
3531
|
#
|
3484
3532
|
# **Related operations**: EnableKey
|
3485
3533
|
#
|
3534
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3535
|
+
# model. For more information, see [KMS eventual consistency][4].
|
3536
|
+
#
|
3486
3537
|
#
|
3487
3538
|
#
|
3488
3539
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
|
3489
3540
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
3490
3541
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3542
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3491
3543
|
#
|
3492
3544
|
# @option params [required, String] :key_id
|
3493
3545
|
# Identifies the KMS key to disable.
|
@@ -3567,6 +3619,9 @@ module Aws::KMS
|
|
3567
3619
|
#
|
3568
3620
|
# * GetKeyRotationStatus
|
3569
3621
|
#
|
3622
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3623
|
+
# model. For more information, see [KMS eventual consistency][12].
|
3624
|
+
#
|
3570
3625
|
#
|
3571
3626
|
#
|
3572
3627
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
|
@@ -3580,6 +3635,7 @@ module Aws::KMS
|
|
3580
3635
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk
|
3581
3636
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
3582
3637
|
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3638
|
+
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3583
3639
|
#
|
3584
3640
|
# @option params [required, String] :key_id
|
3585
3641
|
# Identifies a symmetric encryption KMS key. You cannot enable or
|
@@ -3679,11 +3735,15 @@ module Aws::KMS
|
|
3679
3735
|
#
|
3680
3736
|
# * UpdateCustomKeyStore
|
3681
3737
|
#
|
3738
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3739
|
+
# model. For more information, see [KMS eventual consistency][4].
|
3740
|
+
#
|
3682
3741
|
#
|
3683
3742
|
#
|
3684
3743
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
3685
3744
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
|
3686
3745
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3746
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3687
3747
|
#
|
3688
3748
|
# @option params [required, String] :custom_key_store_id
|
3689
3749
|
# Enter the ID of the custom key store you want to disconnect. To find
|
@@ -3737,11 +3797,15 @@ module Aws::KMS
|
|
3737
3797
|
#
|
3738
3798
|
# **Related operations**: DisableKey
|
3739
3799
|
#
|
3800
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3801
|
+
# model. For more information, see [KMS eventual consistency][4].
|
3802
|
+
#
|
3740
3803
|
#
|
3741
3804
|
#
|
3742
3805
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
|
3743
3806
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
3744
3807
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3808
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3745
3809
|
#
|
3746
3810
|
# @option params [required, String] :key_id
|
3747
3811
|
# Identifies the KMS key to enable.
|
@@ -3787,7 +3851,7 @@ module Aws::KMS
|
|
3787
3851
|
# Enables [automatic rotation of the key material][1] of the specified
|
3788
3852
|
# symmetric encryption KMS key.
|
3789
3853
|
#
|
3790
|
-
# When you enable automatic rotation of a[customer managed KMS key][2],
|
3854
|
+
# When you enable automatic rotation of a [customer managed KMS key][2],
|
3791
3855
|
# KMS rotates the key material of the KMS key one year (approximately
|
3792
3856
|
# 365 days) from the enable date and every year thereafter. You can
|
3793
3857
|
# monitor rotation of the key material for your KMS keys in CloudTrail
|
@@ -3833,6 +3897,9 @@ module Aws::KMS
|
|
3833
3897
|
#
|
3834
3898
|
# * GetKeyRotationStatus
|
3835
3899
|
#
|
3900
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
3901
|
+
# model. For more information, see [KMS eventual consistency][13].
|
3902
|
+
#
|
3836
3903
|
#
|
3837
3904
|
#
|
3838
3905
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
|
@@ -3847,6 +3914,7 @@ module Aws::KMS
|
|
3847
3914
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk
|
3848
3915
|
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
3849
3916
|
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
3917
|
+
# [13]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3850
3918
|
#
|
3851
3919
|
# @option params [required, String] :key_id
|
3852
3920
|
# Identifies a symmetric encryption KMS key. You cannot enable automatic
|
@@ -3983,11 +4051,15 @@ module Aws::KMS
|
|
3983
4051
|
#
|
3984
4052
|
# * GenerateDataKeyPair
|
3985
4053
|
#
|
4054
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
4055
|
+
# model. For more information, see [KMS eventual consistency][4].
|
4056
|
+
#
|
3986
4057
|
#
|
3987
4058
|
#
|
3988
4059
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
3989
4060
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
3990
4061
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
4062
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
3991
4063
|
#
|
3992
4064
|
# @option params [required, String] :key_id
|
3993
4065
|
# Identifies the KMS key to use in the encryption operation. The KMS key
|
@@ -4247,6 +4319,9 @@ module Aws::KMS
|
|
4247
4319
|
#
|
4248
4320
|
# * GenerateDataKeyWithoutPlaintext
|
4249
4321
|
#
|
4322
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
4323
|
+
# model. For more information, see [KMS eventual consistency][10].
|
4324
|
+
#
|
4250
4325
|
#
|
4251
4326
|
#
|
4252
4327
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
@@ -4258,6 +4333,7 @@ module Aws::KMS
|
|
4258
4333
|
# [7]: https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/
|
4259
4334
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
|
4260
4335
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
4336
|
+
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
4261
4337
|
#
|
4262
4338
|
# @option params [required, String] :key_id
|
4263
4339
|
# Specifies the symmetric encryption KMS key that encrypts the data key.
|
@@ -4464,8 +4540,9 @@ module Aws::KMS
|
|
4464
4540
|
# a copy of the private key that is encrypted under the symmetric
|
4465
4541
|
# encryption KMS key you specify. You can use the data key pair to
|
4466
4542
|
# perform asymmetric cryptography and implement digital signatures
|
4467
|
-
# outside of KMS. The bytes in the keys are random; they not related
|
4468
|
-
# the caller or to the KMS key that is used to encrypt the private
|
4543
|
+
# outside of KMS. The bytes in the keys are random; they are not related
|
4544
|
+
# to the caller or to the KMS key that is used to encrypt the private
|
4545
|
+
# key.
|
4469
4546
|
#
|
4470
4547
|
# You can use the public key that `GenerateDataKeyPair` returns to
|
4471
4548
|
# encrypt data or verify a signature outside of KMS. Then, store the
|
@@ -4546,6 +4623,9 @@ module Aws::KMS
|
|
4546
4623
|
#
|
4547
4624
|
# * GenerateDataKeyWithoutPlaintext
|
4548
4625
|
#
|
4626
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
4627
|
+
# model. For more information, see [KMS eventual consistency][9].
|
4628
|
+
#
|
4549
4629
|
#
|
4550
4630
|
#
|
4551
4631
|
# [1]: https://tools.ietf.org/html/rfc5280
|
@@ -4556,6 +4636,7 @@ module Aws::KMS
|
|
4556
4636
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
4557
4637
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
4558
4638
|
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
4639
|
+
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
4559
4640
|
#
|
4560
4641
|
# @option params [Hash<String,String>] :encryption_context
|
4561
4642
|
# Specifies the encryption context that will be used when encrypting the
|
@@ -4819,12 +4900,16 @@ module Aws::KMS
|
|
4819
4900
|
#
|
4820
4901
|
# * GenerateDataKeyWithoutPlaintext
|
4821
4902
|
#
|
4903
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
4904
|
+
# model. For more information, see [KMS eventual consistency][5].
|
4905
|
+
#
|
4822
4906
|
#
|
4823
4907
|
#
|
4824
4908
|
# [1]: https://tools.ietf.org/html/rfc5280
|
4825
4909
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
4826
4910
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
4827
4911
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
4912
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
4828
4913
|
#
|
4829
4914
|
# @option params [Hash<String,String>] :encryption_context
|
4830
4915
|
# Specifies the encryption context that will be used when encrypting the
|
@@ -5035,11 +5120,15 @@ module Aws::KMS
|
|
5035
5120
|
#
|
5036
5121
|
# * GenerateDataKeyPairWithoutPlaintext
|
5037
5122
|
#
|
5123
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5124
|
+
# model. For more information, see [KMS eventual consistency][4].
|
5125
|
+
#
|
5038
5126
|
#
|
5039
5127
|
#
|
5040
5128
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
5041
5129
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
5042
5130
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5131
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5043
5132
|
#
|
5044
5133
|
# @option params [required, String] :key_id
|
5045
5134
|
# Specifies the symmetric encryption KMS key that encrypts the data key.
|
@@ -5207,12 +5296,16 @@ module Aws::KMS
|
|
5207
5296
|
#
|
5208
5297
|
# **Related operations**: VerifyMac
|
5209
5298
|
#
|
5299
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5300
|
+
# model. For more information, see [KMS eventual consistency][5].
|
5301
|
+
#
|
5210
5302
|
#
|
5211
5303
|
#
|
5212
5304
|
# [1]: https://datatracker.ietf.org/doc/html/rfc2104
|
5213
5305
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
5214
5306
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
5215
5307
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5308
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5216
5309
|
#
|
5217
5310
|
# @option params [required, String, StringIO, File] :message
|
5218
5311
|
# The message to be hashed. Specify a message of up to 4,096 bytes.
|
@@ -5343,6 +5436,9 @@ module Aws::KMS
|
|
5343
5436
|
#
|
5344
5437
|
# **Required permissions**: [kms:GenerateRandom][5] (IAM policy)
|
5345
5438
|
#
|
5439
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5440
|
+
# model. For more information, see [KMS eventual consistency][6].
|
5441
|
+
#
|
5346
5442
|
#
|
5347
5443
|
#
|
5348
5444
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html
|
@@ -5350,6 +5446,7 @@ module Aws::KMS
|
|
5350
5446
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
|
5351
5447
|
# [4]: https://docs.aws.amazon.com/kms/latest/cryptographic-details/
|
5352
5448
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5449
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5353
5450
|
#
|
5354
5451
|
# @option params [Integer] :number_of_bytes
|
5355
5452
|
# The length of the random byte string. This parameter is required.
|
@@ -5460,11 +5557,16 @@ module Aws::KMS
|
|
5460
5557
|
#
|
5461
5558
|
# **Required permissions**: [kms:GetKeyPolicy][1] (key policy)
|
5462
5559
|
#
|
5463
|
-
# **Related operations**: PutKeyPolicy
|
5560
|
+
# **Related operations**: [PutKeyPolicy][2]
|
5561
|
+
#
|
5562
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5563
|
+
# model. For more information, see [KMS eventual consistency][3].
|
5464
5564
|
#
|
5465
5565
|
#
|
5466
5566
|
#
|
5467
5567
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5568
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
|
5569
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5468
5570
|
#
|
5469
5571
|
# @option params [required, String] :key_id
|
5470
5572
|
# Gets the key policy for the specified KMS key.
|
@@ -5583,6 +5685,9 @@ module Aws::KMS
|
|
5583
5685
|
#
|
5584
5686
|
# * EnableKeyRotation
|
5585
5687
|
#
|
5688
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5689
|
+
# model. For more information, see [KMS eventual consistency][12].
|
5690
|
+
#
|
5586
5691
|
#
|
5587
5692
|
#
|
5588
5693
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
|
@@ -5596,6 +5701,7 @@ module Aws::KMS
|
|
5596
5701
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
5597
5702
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
5598
5703
|
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5704
|
+
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5599
5705
|
#
|
5600
5706
|
# @option params [required, String] :key_id
|
5601
5707
|
# Gets the rotation status for the specified KMS key.
|
@@ -5665,14 +5771,11 @@ module Aws::KMS
|
|
5665
5771
|
# material. You can import key material for a symmetric encryption KMS
|
5666
5772
|
# key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric
|
5667
5773
|
# signing KMS key. You can also import key material into a [multi-Region
|
5668
|
-
# key]
|
5669
|
-
#
|
5670
|
-
#
|
5671
|
-
#
|
5672
|
-
#
|
5673
|
-
# token to [reimport the original key
|
5674
|
-
# material](kms/latest/developerguide/importing-keys.html#reimport-key-material)
|
5675
|
-
# into a KMS key whose key material expired or was deleted.
|
5774
|
+
# key][2] of any supported type. However, you can't import key material
|
5775
|
+
# into a KMS key in a [custom key store][3]. You can also use
|
5776
|
+
# `GetParametersForImport` to get a public key and import token to
|
5777
|
+
# [reimport the original key material][4] into a KMS key whose key
|
5778
|
+
# material expired or was deleted.
|
5676
5779
|
#
|
5677
5780
|
# `GetParametersForImport` returns the items that you need to import
|
5678
5781
|
# your key material.
|
@@ -5709,13 +5812,13 @@ module Aws::KMS
|
|
5709
5812
|
# algorithm each time you import or reimport the same key material.
|
5710
5813
|
#
|
5711
5814
|
# The KMS key that you use for this operation must be in a compatible
|
5712
|
-
# key state. For details, see [Key states of KMS keys][
|
5815
|
+
# key state. For details, see [Key states of KMS keys][5] in the *Key
|
5713
5816
|
# Management Service Developer Guide*.
|
5714
5817
|
#
|
5715
5818
|
# **Cross-account use**: No. You cannot perform this operation on a KMS
|
5716
5819
|
# key in a different Amazon Web Services account.
|
5717
5820
|
#
|
5718
|
-
# **Required permissions**: [kms:GetParametersForImport][
|
5821
|
+
# **Required permissions**: [kms:GetParametersForImport][6] (key policy)
|
5719
5822
|
#
|
5720
5823
|
# **Related operations:**
|
5721
5824
|
#
|
@@ -5723,11 +5826,18 @@ module Aws::KMS
|
|
5723
5826
|
#
|
5724
5827
|
# * DeleteImportedKeyMaterial
|
5725
5828
|
#
|
5829
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
5830
|
+
# model. For more information, see [KMS eventual consistency][7].
|
5831
|
+
#
|
5726
5832
|
#
|
5727
5833
|
#
|
5728
5834
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
5729
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
5730
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
5835
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
5836
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
5837
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material
|
5838
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
5839
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
5840
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5731
5841
|
#
|
5732
5842
|
# @option params [required, String] :key_id
|
5733
5843
|
# The identifier of the KMS key that will be associated with the
|
@@ -5782,8 +5892,8 @@ module Aws::KMS
|
|
5782
5892
|
# You cannot use the RSAES\_OAEP\_SHA\_1 wrapping algorithm with the
|
5783
5893
|
# RSA\_2048 wrapping key spec to wrap ECC\_NIST\_P521 key material.
|
5784
5894
|
#
|
5785
|
-
# * **RSAES\_PKCS1\_V1\_5** (Deprecated) —
|
5786
|
-
#
|
5895
|
+
# * **RSAES\_PKCS1\_V1\_5** (Deprecated) — As of October 10, 2023, KMS
|
5896
|
+
# does not support the RSAES\_PKCS1\_V1\_5 wrapping algorithm.
|
5787
5897
|
#
|
5788
5898
|
# @option params [required, String] :wrapping_key_spec
|
5789
5899
|
# The type of RSA public key to return in the response. You will use
|
@@ -5959,6 +6069,9 @@ module Aws::KMS
|
|
5959
6069
|
#
|
5960
6070
|
# **Related operations**: CreateKey
|
5961
6071
|
#
|
6072
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6073
|
+
# model. For more information, see [KMS eventual consistency][9].
|
6074
|
+
#
|
5962
6075
|
#
|
5963
6076
|
#
|
5964
6077
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
@@ -5969,6 +6082,7 @@ module Aws::KMS
|
|
5969
6082
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
|
5970
6083
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
5971
6084
|
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6085
|
+
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
5972
6086
|
#
|
5973
6087
|
# @option params [required, String] :key_id
|
5974
6088
|
# Identifies the asymmetric KMS key that includes the public key.
|
@@ -6179,6 +6293,9 @@ module Aws::KMS
|
|
6179
6293
|
#
|
6180
6294
|
# * GetParametersForImport
|
6181
6295
|
#
|
6296
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6297
|
+
# model. For more information, see [KMS eventual consistency][7].
|
6298
|
+
#
|
6182
6299
|
#
|
6183
6300
|
#
|
6184
6301
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
@@ -6187,6 +6304,7 @@ module Aws::KMS
|
|
6187
6304
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview
|
6188
6305
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
6189
6306
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6307
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6190
6308
|
#
|
6191
6309
|
# @option params [required, String] :key_id
|
6192
6310
|
# The identifier of the KMS key that will be associated with the
|
@@ -6343,11 +6461,15 @@ module Aws::KMS
|
|
6343
6461
|
#
|
6344
6462
|
# * UpdateAlias
|
6345
6463
|
#
|
6464
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6465
|
+
# model. For more information, see [KMS eventual consistency][4].
|
6466
|
+
#
|
6346
6467
|
#
|
6347
6468
|
#
|
6348
6469
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit
|
6349
6470
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6350
6471
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
|
6472
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6351
6473
|
#
|
6352
6474
|
# @option params [String] :key_id
|
6353
6475
|
# Lists only aliases that are associated with the specified KMS key.
|
@@ -6507,12 +6629,16 @@ module Aws::KMS
|
|
6507
6629
|
#
|
6508
6630
|
# * RevokeGrant
|
6509
6631
|
#
|
6632
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6633
|
+
# model. For more information, see [KMS eventual consistency][5].
|
6634
|
+
#
|
6510
6635
|
#
|
6511
6636
|
#
|
6512
6637
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
|
6513
6638
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
|
6514
6639
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
|
6515
6640
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6641
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6516
6642
|
#
|
6517
6643
|
# @option params [Integer] :limit
|
6518
6644
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -6679,11 +6805,16 @@ module Aws::KMS
|
|
6679
6805
|
#
|
6680
6806
|
# * GetKeyPolicy
|
6681
6807
|
#
|
6682
|
-
# * PutKeyPolicy
|
6808
|
+
# * [PutKeyPolicy][2]
|
6809
|
+
#
|
6810
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6811
|
+
# model. For more information, see [KMS eventual consistency][3].
|
6683
6812
|
#
|
6684
6813
|
#
|
6685
6814
|
#
|
6686
6815
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6816
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
|
6817
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6687
6818
|
#
|
6688
6819
|
# @option params [required, String] :key_id
|
6689
6820
|
# Gets the names of key policies for the specified KMS key.
|
@@ -6783,9 +6914,13 @@ module Aws::KMS
|
|
6783
6914
|
#
|
6784
6915
|
# * ListResourceTags
|
6785
6916
|
#
|
6917
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
6918
|
+
# model. For more information, see [KMS eventual consistency][2].
|
6919
|
+
#
|
6786
6920
|
#
|
6787
6921
|
#
|
6788
6922
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
6923
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6789
6924
|
#
|
6790
6925
|
# @option params [Integer] :limit
|
6791
6926
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -6898,11 +7033,15 @@ module Aws::KMS
|
|
6898
7033
|
#
|
6899
7034
|
# * UntagResource
|
6900
7035
|
#
|
7036
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
7037
|
+
# model. For more information, see [KMS eventual consistency][4].
|
7038
|
+
#
|
6901
7039
|
#
|
6902
7040
|
#
|
6903
7041
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6904
7042
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
|
6905
7043
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
7044
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
6906
7045
|
#
|
6907
7046
|
# @option params [required, String] :key_id
|
6908
7047
|
# Gets tags on the specified KMS key.
|
@@ -7011,14 +7150,25 @@ module Aws::KMS
|
|
7011
7150
|
# programming languages, see [Programming grants][2].
|
7012
7151
|
#
|
7013
7152
|
# **Cross-account use**: You must specify a principal in your Amazon Web
|
7014
|
-
# Services account.
|
7015
|
-
#
|
7016
|
-
#
|
7017
|
-
#
|
7153
|
+
# Services account. This operation returns a list of grants where the
|
7154
|
+
# retiring principal specified in the `ListRetirableGrants` request is
|
7155
|
+
# the same retiring principal on the grant. This can include grants on
|
7156
|
+
# KMS keys owned by other Amazon Web Services accounts, but you do not
|
7157
|
+
# need `kms:ListRetirableGrants` permission (or any other additional
|
7158
|
+
# permission) in any Amazon Web Services account other than your own.
|
7018
7159
|
#
|
7019
7160
|
# **Required permissions**: [kms:ListRetirableGrants][3] (IAM policy) in
|
7020
7161
|
# your Amazon Web Services account.
|
7021
7162
|
#
|
7163
|
+
# <note markdown="1"> KMS authorizes `ListRetirableGrants` requests by evaluating the caller
|
7164
|
+
# account's kms:ListRetirableGrants permissions. The authorized
|
7165
|
+
# resource in `ListRetirableGrants` calls is the retiring principal
|
7166
|
+
# specified in the request. KMS does not evaluate the caller's
|
7167
|
+
# permissions to verify their access to any KMS keys or grants that
|
7168
|
+
# might be returned by the `ListRetirableGrants` call.
|
7169
|
+
#
|
7170
|
+
# </note>
|
7171
|
+
#
|
7022
7172
|
# **Related operations:**
|
7023
7173
|
#
|
7024
7174
|
# * CreateGrant
|
@@ -7029,11 +7179,15 @@ module Aws::KMS
|
|
7029
7179
|
#
|
7030
7180
|
# * RevokeGrant
|
7031
7181
|
#
|
7182
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
7183
|
+
# model. For more information, see [KMS eventual consistency][4].
|
7184
|
+
#
|
7032
7185
|
#
|
7033
7186
|
#
|
7034
7187
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
|
7035
7188
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
|
7036
7189
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
7190
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
7037
7191
|
#
|
7038
7192
|
# @option params [Integer] :limit
|
7039
7193
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -7153,12 +7307,16 @@ module Aws::KMS
|
|
7153
7307
|
#
|
7154
7308
|
# **Related operations**: GetKeyPolicy
|
7155
7309
|
#
|
7310
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
7311
|
+
# model. For more information, see [KMS eventual consistency][5].
|
7312
|
+
#
|
7156
7313
|
#
|
7157
7314
|
#
|
7158
7315
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
7159
7316
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
|
7160
7317
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy
|
7161
7318
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
7319
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
7162
7320
|
#
|
7163
7321
|
# @option params [required, String] :key_id
|
7164
7322
|
# Sets the key policy on the specified KMS key.
|
@@ -7233,12 +7391,13 @@ module Aws::KMS
|
|
7233
7391
|
# Management Service Developer Guide*.
|
7234
7392
|
#
|
7235
7393
|
# Use this parameter only when you intend to prevent the principal that
|
7236
|
-
# is making the request from making a subsequent PutKeyPolicy
|
7237
|
-
# the KMS key.
|
7394
|
+
# is making the request from making a subsequent [PutKeyPolicy][2]
|
7395
|
+
# request on the KMS key.
|
7238
7396
|
#
|
7239
7397
|
#
|
7240
7398
|
#
|
7241
7399
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
7400
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
|
7242
7401
|
#
|
7243
7402
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
7244
7403
|
#
|
@@ -7363,6 +7522,9 @@ module Aws::KMS
|
|
7363
7522
|
#
|
7364
7523
|
# * GenerateDataKeyPair
|
7365
7524
|
#
|
7525
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
7526
|
+
# model. For more information, see [KMS eventual consistency][9].
|
7527
|
+
#
|
7366
7528
|
#
|
7367
7529
|
#
|
7368
7530
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually
|
@@ -7373,6 +7535,7 @@ module Aws::KMS
|
|
7373
7535
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
7374
7536
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
7375
7537
|
# [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
7538
|
+
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
7376
7539
|
#
|
7377
7540
|
# @option params [required, String, StringIO, File] :ciphertext_blob
|
7378
7541
|
# Ciphertext of the data to reencrypt.
|
@@ -7643,9 +7806,8 @@ module Aws::KMS
|
|
7643
7806
|
# If you replicate a multi-Region primary key with imported key
|
7644
7807
|
# material, the replica key is created with no key material. You must
|
7645
7808
|
# import the same key material that you imported into the primary key.
|
7646
|
-
# For details, see [Importing key material into multi-Region
|
7647
|
-
#
|
7648
|
-
# *Key Management Service Developer Guide*.
|
7809
|
+
# For details, see [Importing key material into multi-Region keys][12]
|
7810
|
+
# in the *Key Management Service Developer Guide*.
|
7649
7811
|
#
|
7650
7812
|
# To convert a replica key to a primary key, use the UpdatePrimaryRegion
|
7651
7813
|
# operation.
|
@@ -7675,6 +7837,9 @@ module Aws::KMS
|
|
7675
7837
|
#
|
7676
7838
|
# * UpdatePrimaryRegion
|
7677
7839
|
#
|
7840
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
7841
|
+
# model. For more information, see [KMS eventual consistency][13].
|
7842
|
+
#
|
7678
7843
|
#
|
7679
7844
|
#
|
7680
7845
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
@@ -7688,6 +7853,8 @@ module Aws::KMS
|
|
7688
7853
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html
|
7689
7854
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
7690
7855
|
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties
|
7856
|
+
# [12]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html
|
7857
|
+
# [13]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
7691
7858
|
#
|
7692
7859
|
# @option params [required, String] :key_id
|
7693
7860
|
# Identifies the multi-Region primary key that is being replicated. To
|
@@ -7806,12 +7973,13 @@ module Aws::KMS
|
|
7806
7973
|
# Management Service Developer Guide*.
|
7807
7974
|
#
|
7808
7975
|
# Use this parameter only when you intend to prevent the principal that
|
7809
|
-
# is making the request from making a subsequent PutKeyPolicy
|
7810
|
-
# the KMS key.
|
7976
|
+
# is making the request from making a subsequent [PutKeyPolicy][2]
|
7977
|
+
# request on the KMS key.
|
7811
7978
|
#
|
7812
7979
|
#
|
7813
7980
|
#
|
7814
7981
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
7982
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
|
7815
7983
|
#
|
7816
7984
|
# @option params [String] :description
|
7817
7985
|
# A description of the KMS key. The default value is an empty string (no
|
@@ -8002,7 +8170,7 @@ module Aws::KMS
|
|
8002
8170
|
# **Cross-account use**: Yes. You can retire a grant on a KMS key in a
|
8003
8171
|
# different Amazon Web Services account.
|
8004
8172
|
#
|
8005
|
-
# **Required permissions
|
8173
|
+
# **Required permissions**: Permission to retire a grant is determined
|
8006
8174
|
# primarily by the grant. For details, see [Retiring and revoking
|
8007
8175
|
# grants][2] in the *Key Management Service Developer Guide*.
|
8008
8176
|
#
|
@@ -8016,12 +8184,16 @@ module Aws::KMS
|
|
8016
8184
|
#
|
8017
8185
|
# * RevokeGrant
|
8018
8186
|
#
|
8187
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8188
|
+
# model. For more information, see [KMS eventual consistency][5].
|
8189
|
+
#
|
8019
8190
|
#
|
8020
8191
|
#
|
8021
8192
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
8022
8193
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete
|
8023
8194
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
|
8024
8195
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
|
8196
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8025
8197
|
#
|
8026
8198
|
# @option params [String] :grant_token
|
8027
8199
|
# Identifies the grant to be retired. You can use a grant token to
|
@@ -8125,6 +8297,9 @@ module Aws::KMS
|
|
8125
8297
|
#
|
8126
8298
|
# * RetireGrant
|
8127
8299
|
#
|
8300
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8301
|
+
# model. For more information, see [KMS eventual consistency][6].
|
8302
|
+
#
|
8128
8303
|
#
|
8129
8304
|
#
|
8130
8305
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete
|
@@ -8132,6 +8307,7 @@ module Aws::KMS
|
|
8132
8307
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
|
8133
8308
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
|
8134
8309
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
8310
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8135
8311
|
#
|
8136
8312
|
# @option params [required, String] :key_id
|
8137
8313
|
# A unique identifier for the KMS key associated with the grant. To get
|
@@ -8208,9 +8384,8 @@ module Aws::KMS
|
|
8208
8384
|
# Deleting a KMS key is a destructive and potentially dangerous
|
8209
8385
|
# operation. When a KMS key is deleted, all data that was encrypted
|
8210
8386
|
# under the KMS key is unrecoverable. (The only exception is a
|
8211
|
-
# [multi-Region replica
|
8212
|
-
# key
|
8213
|
-
# [asymmetric or HMAC KMS key with imported key
|
8387
|
+
# [multi-Region replica key][1], or an [asymmetric or HMAC KMS key with
|
8388
|
+
# imported key
|
8214
8389
|
# material](kms/latest/developerguide/importing-keys-managing.html#import-delete-key).)
|
8215
8390
|
# To prevent the use of a KMS key without deleting it, use DisableKey.
|
8216
8391
|
#
|
@@ -8256,6 +8431,9 @@ module Aws::KMS
|
|
8256
8431
|
#
|
8257
8432
|
# * DisableKey
|
8258
8433
|
#
|
8434
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8435
|
+
# model. For more information, see [KMS eventual consistency][7].
|
8436
|
+
#
|
8259
8437
|
#
|
8260
8438
|
#
|
8261
8439
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html
|
@@ -8264,6 +8442,7 @@ module Aws::KMS
|
|
8264
8442
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html
|
8265
8443
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
|
8266
8444
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
8445
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8267
8446
|
#
|
8268
8447
|
# @option params [required, String] :key_id
|
8269
8448
|
# The unique identifier of the KMS key to delete.
|
@@ -8403,12 +8582,16 @@ module Aws::KMS
|
|
8403
8582
|
#
|
8404
8583
|
# **Related operations**: Verify
|
8405
8584
|
#
|
8585
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8586
|
+
# model. For more information, see [KMS eventual consistency][5].
|
8587
|
+
#
|
8406
8588
|
#
|
8407
8589
|
#
|
8408
8590
|
# [1]: https://en.wikipedia.org/wiki/Digital_signature
|
8409
8591
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
8410
8592
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
8411
8593
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
8594
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8412
8595
|
#
|
8413
8596
|
# @option params [required, String] :key_id
|
8414
8597
|
# Identifies an asymmetric KMS key. KMS uses the private key in the
|
@@ -8632,6 +8815,9 @@ module Aws::KMS
|
|
8632
8815
|
#
|
8633
8816
|
# * UntagResource
|
8634
8817
|
#
|
8818
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8819
|
+
# model. For more information, see [KMS eventual consistency][11].
|
8820
|
+
#
|
8635
8821
|
#
|
8636
8822
|
#
|
8637
8823
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
@@ -8644,6 +8830,7 @@ module Aws::KMS
|
|
8644
8830
|
# [8]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
8645
8831
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
8646
8832
|
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
8833
|
+
# [11]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8647
8834
|
#
|
8648
8835
|
# @option params [required, String] :key_id
|
8649
8836
|
# Identifies a customer managed key in the account and Region.
|
@@ -8748,6 +8935,9 @@ module Aws::KMS
|
|
8748
8935
|
#
|
8749
8936
|
# * TagResource
|
8750
8937
|
#
|
8938
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
8939
|
+
# model. For more information, see [KMS eventual consistency][7].
|
8940
|
+
#
|
8751
8941
|
#
|
8752
8942
|
#
|
8753
8943
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
@@ -8756,6 +8946,7 @@ module Aws::KMS
|
|
8756
8946
|
# [4]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
8757
8947
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
8758
8948
|
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
8949
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8759
8950
|
#
|
8760
8951
|
# @option params [required, String] :key_id
|
8761
8952
|
# Identifies the KMS key from which you are removing tags.
|
@@ -8859,12 +9050,16 @@ module Aws::KMS
|
|
8859
9050
|
#
|
8860
9051
|
# * ListAliases
|
8861
9052
|
#
|
9053
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9054
|
+
# model. For more information, see [KMS eventual consistency][5].
|
9055
|
+
#
|
8862
9056
|
#
|
8863
9057
|
#
|
8864
9058
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
|
8865
9059
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
8866
9060
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
8867
9061
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
|
9062
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
8868
9063
|
#
|
8869
9064
|
# @option params [required, String] :alias_name
|
8870
9065
|
# Identifies the alias that is changing its KMS key. This value must
|
@@ -9030,10 +9225,14 @@ module Aws::KMS
|
|
9030
9225
|
#
|
9031
9226
|
# * DisconnectCustomKeyStore
|
9032
9227
|
#
|
9228
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9229
|
+
# model. For more information, see [KMS eventual consistency][3].
|
9230
|
+
#
|
9033
9231
|
#
|
9034
9232
|
#
|
9035
9233
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
|
9036
9234
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
9235
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
9037
9236
|
#
|
9038
9237
|
# @option params [required, String] :custom_key_store_id
|
9039
9238
|
# Identifies the custom key store that you want to update. Enter the ID
|
@@ -9304,10 +9503,14 @@ module Aws::KMS
|
|
9304
9503
|
#
|
9305
9504
|
# * DescribeKey
|
9306
9505
|
#
|
9506
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9507
|
+
# model. For more information, see [KMS eventual consistency][3].
|
9508
|
+
#
|
9307
9509
|
#
|
9308
9510
|
#
|
9309
9511
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
9310
9512
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
9513
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
9311
9514
|
#
|
9312
9515
|
# @option params [required, String] :key_id
|
9313
9516
|
# Updates the description of the specified KMS key.
|
@@ -9431,6 +9634,9 @@ module Aws::KMS
|
|
9431
9634
|
#
|
9432
9635
|
# * ReplicateKey
|
9433
9636
|
#
|
9637
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9638
|
+
# model. For more information, see [KMS eventual consistency][10].
|
9639
|
+
#
|
9434
9640
|
#
|
9435
9641
|
#
|
9436
9642
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update
|
@@ -9442,6 +9648,7 @@ module Aws::KMS
|
|
9442
9648
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
|
9443
9649
|
# [8]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html
|
9444
9650
|
# [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
9651
|
+
# [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
9445
9652
|
#
|
9446
9653
|
# @option params [required, String] :key_id
|
9447
9654
|
# Identifies the current primary key. When the operation completes, this
|
@@ -9550,12 +9757,16 @@ module Aws::KMS
|
|
9550
9757
|
#
|
9551
9758
|
# **Related operations**: Sign
|
9552
9759
|
#
|
9760
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9761
|
+
# model. For more information, see [KMS eventual consistency][5].
|
9762
|
+
#
|
9553
9763
|
#
|
9554
9764
|
#
|
9555
9765
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
9556
9766
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
|
9557
9767
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
9558
9768
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
9769
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
9559
9770
|
#
|
9560
9771
|
# @option params [required, String] :key_id
|
9561
9772
|
# Identifies the asymmetric KMS key that will be used to verify the
|
@@ -9767,12 +9978,16 @@ module Aws::KMS
|
|
9767
9978
|
#
|
9768
9979
|
# **Related operations**: GenerateMac
|
9769
9980
|
#
|
9981
|
+
# **Eventual consistency**: The KMS API follows an eventual consistency
|
9982
|
+
# model. For more information, see [KMS eventual consistency][5].
|
9983
|
+
#
|
9770
9984
|
#
|
9771
9985
|
#
|
9772
9986
|
# [1]: https://datatracker.ietf.org/doc/html/rfc2104
|
9773
9987
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
9774
9988
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
9775
9989
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
|
9990
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
9776
9991
|
#
|
9777
9992
|
# @option params [required, String, StringIO, File] :message
|
9778
9993
|
# The message that will be used in the verification. Enter the same
|
@@ -9888,7 +10103,7 @@ module Aws::KMS
|
|
9888
10103
|
params: params,
|
9889
10104
|
config: config)
|
9890
10105
|
context[:gem_name] = 'aws-sdk-kms'
|
9891
|
-
context[:gem_version] = '1.
|
10106
|
+
context[:gem_version] = '1.76.0'
|
9892
10107
|
Seahorse::Client::Request.new(handlers, context)
|
9893
10108
|
end
|
9894
10109
|
|