aws-sdk-kms 1.2.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kms.rb +1 -1
- data/lib/aws-sdk-kms/client.rb +500 -270
- data/lib/aws-sdk-kms/client_api.rb +1 -1
- data/lib/aws-sdk-kms/types.rb +338 -200
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ccbfd96a2bbd42fa8033c0813d07dfb7081aa59c
|
4
|
+
data.tar.gz: c880a357714e7a9d132d2a2ed3065e97deedf991
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6d9dd353274e67852e1e154abd08ed67d3aeb9870567a5b0806da5d7c39574e2000d659f47e0e5efa341a2575719fbf6209206f42d9127fe5d33a473276f00b6
|
7
|
+
data.tar.gz: 1461631a9f78a18a44938c72e794f33b14a4539712bbaaf028ca8cb9563ab271441b2548a1844924ccc6c3ba535f3124ae6f8ac4f4fc38fe70c2d46c09781d10
|
data/lib/aws-sdk-kms.rb
CHANGED
data/lib/aws-sdk-kms/client.rb
CHANGED
@@ -157,7 +157,8 @@ module Aws::KMS
|
|
157
157
|
|
158
158
|
# Cancels the deletion of a customer master key (CMK). When this
|
159
159
|
# operation is successful, the CMK is set to the `Disabled` state. To
|
160
|
-
# enable a CMK, use EnableKey.
|
160
|
+
# enable a CMK, use EnableKey. You cannot perform this operation on a
|
161
|
+
# CMK in a different AWS account.
|
161
162
|
#
|
162
163
|
# For more information about scheduling and canceling deletion of a CMK,
|
163
164
|
# see [Deleting Customer Master Keys][1] in the *AWS Key Management
|
@@ -171,16 +172,16 @@ module Aws::KMS
|
|
171
172
|
# The unique identifier for the customer master key (CMK) for which to
|
172
173
|
# cancel deletion.
|
173
174
|
#
|
174
|
-
#
|
175
|
-
# Name (ARN) of the CMK. Examples:
|
175
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
176
176
|
#
|
177
|
-
#
|
177
|
+
# For example:
|
178
|
+
#
|
179
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
178
180
|
#
|
179
181
|
# * Key ARN:
|
180
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
182
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
181
183
|
#
|
182
|
-
# To
|
183
|
-
# or DescribeKey.
|
184
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
184
185
|
#
|
185
186
|
# @return [Types::CancelKeyDeletionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
186
187
|
#
|
@@ -219,19 +220,31 @@ module Aws::KMS
|
|
219
220
|
req.send_request(options)
|
220
221
|
end
|
221
222
|
|
222
|
-
# Creates a display name for a customer master key.
|
223
|
-
# to identify a
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
223
|
+
# Creates a display name for a customer master key (CMK). You can use an
|
224
|
+
# alias to identify a CMK in selected operations, such as Encrypt and
|
225
|
+
# GenerateDataKey.
|
226
|
+
#
|
227
|
+
# Each CMK can have multiple aliases, but each alias points to only one
|
228
|
+
# CMK. The alias name must be unique in the AWS account and region. To
|
229
|
+
# simplify code that runs in multiple regions, use the same alias name,
|
230
|
+
# but point it to a different CMK in each region.
|
231
|
+
#
|
232
|
+
# Because an alias is not a property of a CMK, you can delete and change
|
233
|
+
# the aliases of a CMK without affecting the CMK. Also, aliases do not
|
234
|
+
# appear in the response from the DescribeKey operation. To get the
|
235
|
+
# aliases of all CMKs, use the ListAliases operation.
|
236
|
+
#
|
237
|
+
# An alias must start with the word `alias` followed by a forward slash
|
238
|
+
# (`alias/`). The alias name can contain only alphanumeric characters,
|
239
|
+
# forward slashes (/), underscores (\_), and dashes (-). Alias names
|
240
|
+
# cannot begin with `aws`; that alias name prefix is reserved by Amazon
|
229
241
|
# Web Services (AWS).
|
230
242
|
#
|
231
|
-
# The alias and the
|
232
|
-
# and the same region.
|
243
|
+
# The alias and the CMK it is mapped to must be in the same AWS account
|
244
|
+
# and the same region. You cannot perform this operation on an alias in
|
245
|
+
# a different AWS account.
|
233
246
|
#
|
234
|
-
# To map an alias to a different
|
247
|
+
# To map an existing alias to a different CMK, call UpdateAlias.
|
235
248
|
#
|
236
249
|
# @option params [required, String] :alias_name
|
237
250
|
# String that contains the display name. The name must start with the
|
@@ -239,15 +252,19 @@ module Aws::KMS
|
|
239
252
|
# begin with "alias/AWS" are reserved.
|
240
253
|
#
|
241
254
|
# @option params [required, String] :target_key_id
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
255
|
+
# Identifies the CMK for which you are creating the alias. This value
|
256
|
+
# cannot be an alias.
|
257
|
+
#
|
258
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
259
|
+
#
|
260
|
+
# For example:
|
245
261
|
#
|
246
|
-
# * Key
|
247
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
262
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
248
263
|
#
|
249
|
-
# *
|
250
|
-
#
|
264
|
+
# * Key ARN:
|
265
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
266
|
+
#
|
267
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
251
268
|
#
|
252
269
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
253
270
|
#
|
@@ -277,12 +294,14 @@ module Aws::KMS
|
|
277
294
|
req.send_request(options)
|
278
295
|
end
|
279
296
|
|
280
|
-
# Adds a grant to a
|
281
|
-
#
|
282
|
-
# policies.
|
297
|
+
# Adds a grant to a customer master key (CMK). The grant specifies who
|
298
|
+
# can use the CMK and under what conditions. When setting permissions,
|
299
|
+
# grants are an alternative to key policies.
|
283
300
|
#
|
284
|
-
#
|
285
|
-
#
|
301
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
302
|
+
# the key ARN in the value of the KeyId parameter. For more information
|
303
|
+
# about grants, see [Grants][1] in the *AWS Key Management Service
|
304
|
+
# Developer Guide*.
|
286
305
|
#
|
287
306
|
#
|
288
307
|
#
|
@@ -292,13 +311,17 @@ module Aws::KMS
|
|
292
311
|
# The unique identifier for the customer master key (CMK) that the grant
|
293
312
|
# applies to.
|
294
313
|
#
|
295
|
-
#
|
296
|
-
#
|
314
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
315
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
316
|
+
#
|
317
|
+
# For example:
|
297
318
|
#
|
298
|
-
# *
|
319
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
299
320
|
#
|
300
321
|
# * Key ARN:
|
301
|
-
# arn:aws:kms:us-
|
322
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
323
|
+
#
|
324
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
302
325
|
#
|
303
326
|
# @option params [required, String] :grantee_principal
|
304
327
|
# The principal that is given permission to perform the operations that
|
@@ -332,7 +355,7 @@ module Aws::KMS
|
|
332
355
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
333
356
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
|
334
357
|
#
|
335
|
-
# @option params [Array<String>] :operations
|
358
|
+
# @option params [required, Array<String>] :operations
|
336
359
|
# A list of operations that the grant permits.
|
337
360
|
#
|
338
361
|
# @option params [Types::GrantConstraints] :constraints
|
@@ -403,7 +426,7 @@ module Aws::KMS
|
|
403
426
|
# key_id: "KeyIdType", # required
|
404
427
|
# grantee_principal: "PrincipalIdType", # required
|
405
428
|
# retiring_principal: "PrincipalIdType",
|
406
|
-
# operations: ["Decrypt"], # accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
|
429
|
+
# operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
|
407
430
|
# constraints: {
|
408
431
|
# encryption_context_subset: {
|
409
432
|
# "EncryptionContextKey" => "EncryptionContextValue",
|
@@ -430,7 +453,7 @@ module Aws::KMS
|
|
430
453
|
req.send_request(options)
|
431
454
|
end
|
432
455
|
|
433
|
-
# Creates a customer master key (CMK).
|
456
|
+
# Creates a customer master key (CMK) in the caller's AWS account.
|
434
457
|
#
|
435
458
|
# You can use a CMK to encrypt small amounts of data (4 KiB or less)
|
436
459
|
# directly, but CMKs are more commonly used to encrypt data encryption
|
@@ -443,6 +466,9 @@ module Aws::KMS
|
|
443
466
|
# * [AWS Key Management Service Concepts][1] in the *AWS Key Management
|
444
467
|
# Service Developer Guide*
|
445
468
|
#
|
469
|
+
# You cannot use this operation to create a CMK in a different AWS
|
470
|
+
# account.
|
471
|
+
#
|
446
472
|
#
|
447
473
|
#
|
448
474
|
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
|
@@ -472,7 +498,7 @@ module Aws::KMS
|
|
472
498
|
# to the CMK. For more information, see [Default Key Policy][3] in the
|
473
499
|
# *AWS Key Management Service Developer Guide*.
|
474
500
|
#
|
475
|
-
# The policy size limit is 32
|
501
|
+
# The policy size limit is 32 kilobytes (32768 bytes).
|
476
502
|
#
|
477
503
|
#
|
478
504
|
#
|
@@ -560,10 +586,11 @@ module Aws::KMS
|
|
560
586
|
# key_metadata: {
|
561
587
|
# aws_account_id: "111122223333",
|
562
588
|
# arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
563
|
-
# creation_date: Time.parse("2017-
|
589
|
+
# creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
|
564
590
|
# description: "",
|
565
591
|
# enabled: true,
|
566
592
|
# key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
|
593
|
+
# key_manager: "CUSTOMER",
|
567
594
|
# key_state: "Enabled",
|
568
595
|
# key_usage: "ENCRYPT_DECRYPT",
|
569
596
|
# origin: "AWS_KMS",
|
@@ -612,7 +639,7 @@ module Aws::KMS
|
|
612
639
|
end
|
613
640
|
|
614
641
|
# Decrypts ciphertext. Ciphertext is plaintext that has been previously
|
615
|
-
# encrypted by using any of the following
|
642
|
+
# encrypted by using any of the following operations:
|
616
643
|
#
|
617
644
|
# * GenerateDataKey
|
618
645
|
#
|
@@ -696,13 +723,23 @@ module Aws::KMS
|
|
696
723
|
req.send_request(options)
|
697
724
|
end
|
698
725
|
|
699
|
-
# Deletes the specified alias.
|
700
|
-
#
|
726
|
+
# Deletes the specified alias. You cannot perform this operation on an
|
727
|
+
# alias in a different AWS account.
|
728
|
+
#
|
729
|
+
# Because an alias is not a property of a CMK, you can delete and change
|
730
|
+
# the aliases of a CMK without affecting the CMK. Also, aliases do not
|
731
|
+
# appear in the response from the DescribeKey operation. To get the
|
732
|
+
# aliases of all CMKs, use the ListAliases operation.
|
733
|
+
#
|
734
|
+
# Each CMK can have multiple aliases. To change the alias of a CMK, use
|
735
|
+
# DeleteAlias to delete the current alias and CreateAlias to create a
|
736
|
+
# new alias. To associate an existing alias with a different customer
|
737
|
+
# master key (CMK), call UpdateAlias.
|
701
738
|
#
|
702
739
|
# @option params [required, String] :alias_name
|
703
740
|
# The alias to be deleted. The name must start with the word "alias"
|
704
741
|
# followed by a forward slash (alias/). Aliases that begin with
|
705
|
-
# "alias/
|
742
|
+
# "alias/aws" are reserved.
|
706
743
|
#
|
707
744
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
708
745
|
#
|
@@ -730,10 +767,11 @@ module Aws::KMS
|
|
730
767
|
req.send_request(options)
|
731
768
|
end
|
732
769
|
|
733
|
-
# Deletes key material that you previously imported
|
734
|
-
# specified customer master key (CMK) unusable. For more
|
735
|
-
# about importing key material into AWS KMS, see [Importing
|
736
|
-
# Material][1] in the *AWS Key Management Service Developer Guide*.
|
770
|
+
# Deletes key material that you previously imported. This operation
|
771
|
+
# makes the specified customer master key (CMK) unusable. For more
|
772
|
+
# information about importing key material into AWS KMS, see [Importing
|
773
|
+
# Key Material][1] in the *AWS Key Management Service Developer Guide*.
|
774
|
+
# You cannot perform this operation on a CMK in a different AWS account.
|
737
775
|
#
|
738
776
|
# When the specified CMK is in the `PendingDeletion` state, this
|
739
777
|
# operation does not change the CMK's state. Otherwise, it changes the
|
@@ -750,14 +788,17 @@ module Aws::KMS
|
|
750
788
|
# The identifier of the CMK whose key material to delete. The CMK's
|
751
789
|
# `Origin` must be `EXTERNAL`.
|
752
790
|
#
|
753
|
-
#
|
754
|
-
#
|
791
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
792
|
+
#
|
793
|
+
# For example:
|
755
794
|
#
|
756
|
-
# *
|
795
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
757
796
|
#
|
758
797
|
# * Key ARN:
|
759
798
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
760
799
|
#
|
800
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
801
|
+
#
|
761
802
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
762
803
|
#
|
763
804
|
#
|
@@ -784,23 +825,33 @@ module Aws::KMS
|
|
784
825
|
req.send_request(options)
|
785
826
|
end
|
786
827
|
|
787
|
-
# Provides detailed information about the specified customer master key
|
828
|
+
# Provides detailed information about the specified customer master key
|
829
|
+
# (CMK).
|
830
|
+
#
|
831
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
832
|
+
# the key ARN or alias ARN in the value of the KeyId parameter.
|
788
833
|
#
|
789
834
|
# @option params [required, String] :key_id
|
790
|
-
# A unique identifier for the customer master key.
|
791
|
-
#
|
792
|
-
#
|
835
|
+
# A unique identifier for the customer master key (CMK).
|
836
|
+
#
|
837
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
838
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
839
|
+
# "alias/". To specify a CMK in a different AWS account, you must use
|
840
|
+
# the key ARN or alias ARN.
|
793
841
|
#
|
794
|
-
#
|
795
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
842
|
+
# For example:
|
796
843
|
#
|
797
|
-
# *
|
798
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
844
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
799
845
|
#
|
800
|
-
# *
|
801
|
-
#
|
846
|
+
# * Key ARN:
|
847
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
802
848
|
#
|
803
|
-
# * Alias
|
849
|
+
# * Alias name: `alias/ExampleAlias`
|
850
|
+
#
|
851
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
852
|
+
#
|
853
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
854
|
+
# To get the alias name and alias ARN, use ListAliases.
|
804
855
|
#
|
805
856
|
# @option params [Array<String>] :grant_tokens
|
806
857
|
# A list of grant tokens.
|
@@ -829,11 +880,12 @@ module Aws::KMS
|
|
829
880
|
# {
|
830
881
|
# key_metadata: {
|
831
882
|
# aws_account_id: "111122223333",
|
832
|
-
# arn: "arn:aws:kms:us-
|
833
|
-
# creation_date: Time.parse("
|
883
|
+
# arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
884
|
+
# creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
|
834
885
|
# description: "",
|
835
886
|
# enabled: true,
|
836
887
|
# key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
|
888
|
+
# key_manager: "CUSTOMER",
|
837
889
|
# key_state: "Enabled",
|
838
890
|
# key_usage: "ENCRYPT_DECRYPT",
|
839
891
|
# origin: "AWS_KMS",
|
@@ -873,25 +925,30 @@ module Aws::KMS
|
|
873
925
|
end
|
874
926
|
|
875
927
|
# Sets the state of a customer master key (CMK) to disabled, thereby
|
876
|
-
# preventing its use for cryptographic operations.
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
928
|
+
# preventing its use for cryptographic operations. You cannot perform
|
929
|
+
# this operation on a CMK in a different AWS account.
|
930
|
+
#
|
931
|
+
# For more information about how key state affects the use of a CMK, see
|
932
|
+
# [How Key State Affects the Use of a Customer Master Key][1] in the
|
933
|
+
# *AWS Key Management Service Developer Guide*.
|
880
934
|
#
|
881
935
|
#
|
882
936
|
#
|
883
937
|
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
|
884
938
|
#
|
885
939
|
# @option params [required, String] :key_id
|
886
|
-
# A unique identifier for the CMK.
|
940
|
+
# A unique identifier for the customer master key (CMK).
|
941
|
+
#
|
942
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
887
943
|
#
|
888
|
-
# Use the CMK's unique identifier or its Amazon Resource Name (ARN).
|
889
944
|
# For example:
|
890
945
|
#
|
891
|
-
# *
|
946
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
947
|
+
#
|
948
|
+
# * Key ARN:
|
949
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
892
950
|
#
|
893
|
-
#
|
894
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
951
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
895
952
|
#
|
896
953
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
897
954
|
#
|
@@ -919,17 +976,23 @@ module Aws::KMS
|
|
919
976
|
req.send_request(options)
|
920
977
|
end
|
921
978
|
|
922
|
-
# Disables rotation of the specified
|
979
|
+
# Disables automatic rotation of the key material for the specified
|
980
|
+
# customer master key (CMK). You cannot perform this operation on a CMK
|
981
|
+
# in a different AWS account.
|
923
982
|
#
|
924
983
|
# @option params [required, String] :key_id
|
925
|
-
# A unique identifier for the customer master key.
|
926
|
-
#
|
984
|
+
# A unique identifier for the customer master key (CMK).
|
985
|
+
#
|
986
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
927
987
|
#
|
928
|
-
#
|
929
|
-
#
|
988
|
+
# For example:
|
989
|
+
#
|
990
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
991
|
+
#
|
992
|
+
# * Key ARN:
|
993
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
930
994
|
#
|
931
|
-
#
|
932
|
-
# 12345678-1234-1234-1234-123456789012
|
995
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
933
996
|
#
|
934
997
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
935
998
|
#
|
@@ -957,17 +1020,23 @@ module Aws::KMS
|
|
957
1020
|
req.send_request(options)
|
958
1021
|
end
|
959
1022
|
|
960
|
-
#
|
1023
|
+
# Sets the state of a customer master key (CMK) to enabled, thereby
|
1024
|
+
# permitting its use for cryptographic operations. You cannot perform
|
1025
|
+
# this operation on a CMK in a different AWS account.
|
961
1026
|
#
|
962
1027
|
# @option params [required, String] :key_id
|
963
|
-
# A unique identifier for the customer master key.
|
964
|
-
# globally unique identifier or the fully specified ARN to a key.
|
1028
|
+
# A unique identifier for the customer master key (CMK).
|
965
1029
|
#
|
966
|
-
#
|
967
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
1030
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
968
1031
|
#
|
969
|
-
#
|
970
|
-
#
|
1032
|
+
# For example:
|
1033
|
+
#
|
1034
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1035
|
+
#
|
1036
|
+
# * Key ARN:
|
1037
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1038
|
+
#
|
1039
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
971
1040
|
#
|
972
1041
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
973
1042
|
#
|
@@ -995,17 +1064,23 @@ module Aws::KMS
|
|
995
1064
|
req.send_request(options)
|
996
1065
|
end
|
997
1066
|
|
998
|
-
# Enables rotation of the
|
1067
|
+
# Enables automatic rotation of the key material for the specified
|
1068
|
+
# customer master key (CMK). You cannot perform this operation on a CMK
|
1069
|
+
# in a different AWS account.
|
999
1070
|
#
|
1000
1071
|
# @option params [required, String] :key_id
|
1001
|
-
# A unique identifier for the customer master key.
|
1002
|
-
# globally unique identifier or the fully specified ARN to a key.
|
1072
|
+
# A unique identifier for the customer master key (CMK).
|
1003
1073
|
#
|
1004
|
-
#
|
1005
|
-
#
|
1074
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1075
|
+
#
|
1076
|
+
# For example:
|
1077
|
+
#
|
1078
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1079
|
+
#
|
1080
|
+
# * Key ARN:
|
1081
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1006
1082
|
#
|
1007
|
-
#
|
1008
|
-
# 12345678-1234-1234-1234-123456789012
|
1083
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1009
1084
|
#
|
1010
1085
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1011
1086
|
#
|
@@ -1033,45 +1108,54 @@ module Aws::KMS
|
|
1033
1108
|
req.send_request(options)
|
1034
1109
|
end
|
1035
1110
|
|
1036
|
-
# Encrypts plaintext into ciphertext by using a customer master key
|
1037
|
-
# `Encrypt`
|
1111
|
+
# Encrypts plaintext into ciphertext by using a customer master key
|
1112
|
+
# (CMK). The `Encrypt` operation has two primary use cases:
|
1038
1113
|
#
|
1039
|
-
# * You can encrypt up to 4
|
1040
|
-
# database password, or other sensitive
|
1114
|
+
# * You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data
|
1115
|
+
# such as an RSA key, a database password, or other sensitive
|
1116
|
+
# information.
|
1041
1117
|
#
|
1042
|
-
# *
|
1043
|
-
#
|
1118
|
+
# * To move encrypted data from one AWS region to another, you can use
|
1119
|
+
# this operation to encrypt in the new region the plaintext data key
|
1044
1120
|
# that was used to encrypt the data in the original region. This
|
1045
1121
|
# provides you with an encrypted copy of the data key that can be
|
1046
1122
|
# decrypted in the new region and used there to decrypt the encrypted
|
1047
1123
|
# data.
|
1048
1124
|
#
|
1125
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
1126
|
+
# the key ARN or alias ARN in the value of the KeyId parameter.
|
1127
|
+
#
|
1049
1128
|
# Unless you are moving encrypted data from one region to another, you
|
1050
|
-
# don't use this
|
1051
|
-
# region.
|
1052
|
-
# GenerateDataKey or GenerateDataKeyWithoutPlaintext
|
1053
|
-
# don't need to be encrypted again by calling `Encrypt`.
|
1129
|
+
# don't use this operation to encrypt a generated data key within a
|
1130
|
+
# region. To get data keys that are already encrypted, call the
|
1131
|
+
# GenerateDataKey or GenerateDataKeyWithoutPlaintext operation. Data
|
1132
|
+
# keys don't need to be encrypted again by calling `Encrypt`.
|
1054
1133
|
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
# key
|
1058
|
-
# (CMK) of your choosing.
|
1134
|
+
# To encrypt data locally in your application, use the GenerateDataKey
|
1135
|
+
# operation to return a plaintext data encryption key and a copy of the
|
1136
|
+
# key encrypted under the CMK of your choosing.
|
1059
1137
|
#
|
1060
1138
|
# @option params [required, String] :key_id
|
1061
|
-
# A unique identifier for the customer master key.
|
1062
|
-
#
|
1063
|
-
#
|
1139
|
+
# A unique identifier for the customer master key (CMK).
|
1140
|
+
#
|
1141
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
1142
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
1143
|
+
# "alias/". To specify a CMK in a different AWS account, you must use
|
1144
|
+
# the key ARN or alias ARN.
|
1064
1145
|
#
|
1065
|
-
#
|
1066
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
1146
|
+
# For example:
|
1067
1147
|
#
|
1068
|
-
# *
|
1069
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
1148
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1070
1149
|
#
|
1071
|
-
# *
|
1072
|
-
#
|
1150
|
+
# * Key ARN:
|
1151
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1073
1152
|
#
|
1074
|
-
# * Alias
|
1153
|
+
# * Alias name: `alias/ExampleAlias`
|
1154
|
+
#
|
1155
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
1156
|
+
#
|
1157
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1158
|
+
# To get the alias name and alias ARN, use ListAliases.
|
1075
1159
|
#
|
1076
1160
|
# @option params [required, String, IO] :plaintext
|
1077
1161
|
# Data to be encrypted.
|
@@ -1149,7 +1233,9 @@ module Aws::KMS
|
|
1149
1233
|
# the data key. You must also specify the length of the data key using
|
1150
1234
|
# either the `KeySpec` or `NumberOfBytes` field. You must specify one
|
1151
1235
|
# field or the other, but not both. For common key lengths (128-bit and
|
1152
|
-
# 256-bit symmetric keys), we recommend that you use `KeySpec`.
|
1236
|
+
# 256-bit symmetric keys), we recommend that you use `KeySpec`. To
|
1237
|
+
# perform this operation on a CMK in a different AWS account, specify
|
1238
|
+
# the key ARN or alias ARN in the value of the KeyId parameter.
|
1153
1239
|
#
|
1154
1240
|
# This operation returns a plaintext copy of the data key in the
|
1155
1241
|
# `Plaintext` field of the response, and an encrypted copy of the data
|
@@ -1159,8 +1245,8 @@ module Aws::KMS
|
|
1159
1245
|
# We recommend that you use the following pattern to encrypt data
|
1160
1246
|
# locally in your application:
|
1161
1247
|
#
|
1162
|
-
# 1. Use this operation (`GenerateDataKey`) to
|
1163
|
-
#
|
1248
|
+
# 1. Use this operation (`GenerateDataKey`) to get a data encryption
|
1249
|
+
# key.
|
1164
1250
|
#
|
1165
1251
|
# 2. Use the plaintext data encryption key (returned in the `Plaintext`
|
1166
1252
|
# field of the response) to encrypt data locally, then erase the
|
@@ -1197,19 +1283,25 @@ module Aws::KMS
|
|
1197
1283
|
# The identifier of the CMK under which to generate and encrypt the data
|
1198
1284
|
# encryption key.
|
1199
1285
|
#
|
1200
|
-
#
|
1201
|
-
#
|
1202
|
-
#
|
1286
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
1287
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
1288
|
+
# "alias/". To specify a CMK in a different AWS account, you must use
|
1289
|
+
# the key ARN or alias ARN.
|
1290
|
+
#
|
1291
|
+
# For example:
|
1203
1292
|
#
|
1204
|
-
# *
|
1293
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1205
1294
|
#
|
1206
|
-
# *
|
1295
|
+
# * Key ARN:
|
1207
1296
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1208
1297
|
#
|
1209
1298
|
# * Alias name: `alias/ExampleAlias`
|
1210
1299
|
#
|
1211
1300
|
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
1212
1301
|
#
|
1302
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1303
|
+
# To get the alias name and alias ARN, use ListAliases.
|
1304
|
+
#
|
1213
1305
|
# @option params [Hash<String,String>] :encryption_context
|
1214
1306
|
# A set of key-value pairs that represents additional authenticated
|
1215
1307
|
# data.
|
@@ -1297,6 +1389,9 @@ module Aws::KMS
|
|
1297
1389
|
# (CMK). This operation is identical to GenerateDataKey but returns only
|
1298
1390
|
# the encrypted copy of the data key.
|
1299
1391
|
#
|
1392
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
1393
|
+
# the key ARN or alias ARN in the value of the KeyId parameter.
|
1394
|
+
#
|
1300
1395
|
# This operation is useful in a system that has multiple components with
|
1301
1396
|
# different degrees of trust. For example, consider a system that stores
|
1302
1397
|
# encrypted data in containers. Each container stores the encrypted data
|
@@ -1312,22 +1407,28 @@ module Aws::KMS
|
|
1312
1407
|
# In this system, the control plane never sees the plaintext data key.
|
1313
1408
|
#
|
1314
1409
|
# @option params [required, String] :key_id
|
1315
|
-
# The identifier of the CMK under which to
|
1316
|
-
# encryption key.
|
1410
|
+
# The identifier of the customer master key (CMK) under which to
|
1411
|
+
# generate and encrypt the data encryption key.
|
1317
1412
|
#
|
1318
|
-
#
|
1319
|
-
#
|
1320
|
-
#
|
1413
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
1414
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
1415
|
+
# "alias/". To specify a CMK in a different AWS account, you must use
|
1416
|
+
# the key ARN or alias ARN.
|
1321
1417
|
#
|
1322
|
-
#
|
1418
|
+
# For example:
|
1323
1419
|
#
|
1324
|
-
# *
|
1420
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1421
|
+
#
|
1422
|
+
# * Key ARN:
|
1325
1423
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1326
1424
|
#
|
1327
1425
|
# * Alias name: `alias/ExampleAlias`
|
1328
1426
|
#
|
1329
1427
|
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
1330
1428
|
#
|
1429
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1430
|
+
# To get the alias name and alias ARN, use ListAliases.
|
1431
|
+
#
|
1331
1432
|
# @option params [Hash<String,String>] :encryption_context
|
1332
1433
|
# A set of key-value pairs that represents additional authenticated
|
1333
1434
|
# data.
|
@@ -1457,22 +1558,26 @@ module Aws::KMS
|
|
1457
1558
|
req.send_request(options)
|
1458
1559
|
end
|
1459
1560
|
|
1460
|
-
#
|
1561
|
+
# Gets a key policy attached to the specified customer master key (CMK).
|
1562
|
+
# You cannot perform this operation on a CMK in a different AWS account.
|
1461
1563
|
#
|
1462
1564
|
# @option params [required, String] :key_id
|
1463
|
-
# A unique identifier for the customer master key.
|
1464
|
-
#
|
1565
|
+
# A unique identifier for the customer master key (CMK).
|
1566
|
+
#
|
1567
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1568
|
+
#
|
1569
|
+
# For example:
|
1570
|
+
#
|
1571
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1465
1572
|
#
|
1466
|
-
# * Key ARN
|
1467
|
-
# arn:aws:kms:us-east-
|
1573
|
+
# * Key ARN:
|
1574
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1468
1575
|
#
|
1469
|
-
#
|
1470
|
-
# 12345678-1234-1234-1234-123456789012
|
1576
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1471
1577
|
#
|
1472
1578
|
# @option params [required, String] :policy_name
|
1473
|
-
#
|
1474
|
-
#
|
1475
|
-
# ListKeyPolicies.
|
1579
|
+
# Specifies the name of the policy. The only valid name is `default`. To
|
1580
|
+
# get the names of key policies, use ListKeyPolicies.
|
1476
1581
|
#
|
1477
1582
|
# @return [Types::GetKeyPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1478
1583
|
#
|
@@ -1513,18 +1618,26 @@ module Aws::KMS
|
|
1513
1618
|
req.send_request(options)
|
1514
1619
|
end
|
1515
1620
|
|
1516
|
-
#
|
1517
|
-
# enabled for the specified key.
|
1621
|
+
# Gets a Boolean value that indicates whether automatic rotation of the
|
1622
|
+
# key material is enabled for the specified customer master key (CMK).
|
1623
|
+
#
|
1624
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
1625
|
+
# the key ARN in the value of the KeyId parameter.
|
1518
1626
|
#
|
1519
1627
|
# @option params [required, String] :key_id
|
1520
|
-
# A unique identifier for the customer master key.
|
1521
|
-
#
|
1628
|
+
# A unique identifier for the customer master key (CMK).
|
1629
|
+
#
|
1630
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
1631
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
1522
1632
|
#
|
1523
|
-
#
|
1524
|
-
#
|
1633
|
+
# For example:
|
1634
|
+
#
|
1635
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1636
|
+
#
|
1637
|
+
# * Key ARN:
|
1638
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1525
1639
|
#
|
1526
|
-
#
|
1527
|
-
# 12345678-1234-1234-1234-123456789012
|
1640
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1528
1641
|
#
|
1529
1642
|
# @return [Types::GetKeyRotationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1530
1643
|
#
|
@@ -1572,14 +1685,15 @@ module Aws::KMS
|
|
1572
1685
|
# which you will import key material. This CMK's `Origin` must be
|
1573
1686
|
# `EXTERNAL`. You must also specify the wrapping algorithm and type of
|
1574
1687
|
# wrapping key (public key) that you will use to encrypt the key
|
1575
|
-
# material.
|
1688
|
+
# material. You cannot perform this operation on a CMK in a different
|
1689
|
+
# AWS account.
|
1576
1690
|
#
|
1577
1691
|
# This operation returns a public key and an import token. Use the
|
1578
1692
|
# public key to encrypt the key material. Store the import token to send
|
1579
1693
|
# with a subsequent ImportKeyMaterial request. The public key and import
|
1580
1694
|
# token from the same response must be used together. These items are
|
1581
|
-
# valid for 24 hours
|
1582
|
-
# ImportKeyMaterial request. To
|
1695
|
+
# valid for 24 hours. When they expire, they cannot be used for a
|
1696
|
+
# subsequent ImportKeyMaterial request. To get new ones, send another
|
1583
1697
|
# `GetParametersForImport` request.
|
1584
1698
|
#
|
1585
1699
|
#
|
@@ -1590,14 +1704,17 @@ module Aws::KMS
|
|
1590
1704
|
# The identifier of the CMK into which you will import key material. The
|
1591
1705
|
# CMK's `Origin` must be `EXTERNAL`.
|
1592
1706
|
#
|
1593
|
-
#
|
1594
|
-
#
|
1707
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1708
|
+
#
|
1709
|
+
# For example:
|
1595
1710
|
#
|
1596
|
-
# *
|
1711
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1597
1712
|
#
|
1598
1713
|
# * Key ARN:
|
1599
1714
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1600
1715
|
#
|
1716
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1717
|
+
#
|
1601
1718
|
# @option params [required, String] :wrapping_algorithm
|
1602
1719
|
# The algorithm you will use to encrypt the key material before
|
1603
1720
|
# importing it with ImportKeyMaterial. For more information, see
|
@@ -1662,29 +1779,46 @@ module Aws::KMS
|
|
1662
1779
|
req.send_request(options)
|
1663
1780
|
end
|
1664
1781
|
|
1665
|
-
# Imports key material into an AWS KMS customer master key
|
1666
|
-
#
|
1667
|
-
#
|
1668
|
-
#
|
1782
|
+
# Imports key material into an existing AWS KMS customer master key
|
1783
|
+
# (CMK) that was created without key material. You cannot perform this
|
1784
|
+
# operation on a CMK in a different AWS account. For more information
|
1785
|
+
# about creating CMKs with no key material and then importing key
|
1786
|
+
# material, see [Importing Key Material][1] in the *AWS Key Management
|
1787
|
+
# Service Developer Guide*.
|
1788
|
+
#
|
1789
|
+
# Before using this operation, call GetParametersForImport. Its response
|
1790
|
+
# includes a public key and an import token. Use the public key to
|
1791
|
+
# encrypt the key material. Then, submit the import token from the same
|
1792
|
+
# `GetParametersForImport` response.
|
1669
1793
|
#
|
1670
|
-
#
|
1671
|
-
# into. This CMK's `Origin` must be `EXTERNAL`. You must also send an
|
1672
|
-
# import token and the encrypted key material. Send the import token
|
1673
|
-
# that you received in the same GetParametersForImport response that
|
1674
|
-
# contained the public key that you used to encrypt the key material.
|
1675
|
-
# You must also specify whether the key material expires and if so,
|
1676
|
-
# when. When the key material expires, AWS KMS deletes the key material
|
1677
|
-
# and the CMK becomes unusable. To use the CMK again, you can reimport
|
1678
|
-
# the same key material. If you set an expiration date, you can change
|
1679
|
-
# it only by reimporting the same key material and specifying a new
|
1680
|
-
# expiration date.
|
1794
|
+
# When calling this operation, you must specify the following values:
|
1681
1795
|
#
|
1682
|
-
#
|
1683
|
-
#
|
1796
|
+
# * The key ID or key ARN of a CMK with no key material. Its `Origin`
|
1797
|
+
# must be `EXTERNAL`.
|
1684
1798
|
#
|
1685
|
-
#
|
1686
|
-
#
|
1687
|
-
#
|
1799
|
+
# To create a CMK with no key material, call CreateKey and set the
|
1800
|
+
# value of its `Origin` parameter to `EXTERNAL`. To get the `Origin`
|
1801
|
+
# of a CMK, call DescribeKey.)
|
1802
|
+
#
|
1803
|
+
# * The encrypted key material. To get the public key to encrypt the key
|
1804
|
+
# material, call GetParametersForImport.
|
1805
|
+
#
|
1806
|
+
# * The import token that GetParametersForImport returned. This token
|
1807
|
+
# and the public key used to encrypt the key material must have come
|
1808
|
+
# from the same response.
|
1809
|
+
#
|
1810
|
+
# * Whether the key material expires and if so, when. If you set an
|
1811
|
+
# expiration date, you can change it only by reimporting the same key
|
1812
|
+
# material and specifying a new expiration date. If the key material
|
1813
|
+
# expires, AWS KMS deletes the key material and the CMK becomes
|
1814
|
+
# unusable. To use the CMK again, you must reimport the same key
|
1815
|
+
# material.
|
1816
|
+
#
|
1817
|
+
# When this operation is successful, the CMK's key state changes from
|
1818
|
+
# `PendingImport` to `Enabled`, and you can use the CMK. After you
|
1819
|
+
# successfully import key material into a CMK, you can reimport the same
|
1820
|
+
# key material into that CMK, but you cannot import different key
|
1821
|
+
# material.
|
1688
1822
|
#
|
1689
1823
|
#
|
1690
1824
|
#
|
@@ -1694,14 +1828,17 @@ module Aws::KMS
|
|
1694
1828
|
# The identifier of the CMK to import the key material into. The CMK's
|
1695
1829
|
# `Origin` must be `EXTERNAL`.
|
1696
1830
|
#
|
1697
|
-
#
|
1698
|
-
# (ARN) of the CMK. Examples:
|
1831
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1699
1832
|
#
|
1700
|
-
#
|
1833
|
+
# For example:
|
1834
|
+
#
|
1835
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1701
1836
|
#
|
1702
1837
|
# * Key ARN:
|
1703
1838
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1704
1839
|
#
|
1840
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1841
|
+
#
|
1705
1842
|
# @option params [required, String, IO] :import_token
|
1706
1843
|
# The import token that you received in the response to a previous
|
1707
1844
|
# GetParametersForImport request. It must be from the same response that
|
@@ -1759,7 +1896,19 @@ module Aws::KMS
|
|
1759
1896
|
req.send_request(options)
|
1760
1897
|
end
|
1761
1898
|
|
1762
|
-
#
|
1899
|
+
# Gets a list of all aliases in the caller's AWS account and region.
|
1900
|
+
# You cannot list aliases in other accounts. For more information about
|
1901
|
+
# aliases, see CreateAlias.
|
1902
|
+
#
|
1903
|
+
# The response might include several aliases that do not have a
|
1904
|
+
# `TargetKeyId` field because they are not associated with a CMK. These
|
1905
|
+
# are predefined aliases that are reserved for CMKs managed by AWS
|
1906
|
+
# services. If an alias is not associated with a CMK, the alias does not
|
1907
|
+
# count against the [alias limit][1] for your account.
|
1908
|
+
#
|
1909
|
+
#
|
1910
|
+
#
|
1911
|
+
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit
|
1763
1912
|
#
|
1764
1913
|
# @option params [Integer] :limit
|
1765
1914
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -1860,7 +2009,10 @@ module Aws::KMS
|
|
1860
2009
|
req.send_request(options)
|
1861
2010
|
end
|
1862
2011
|
|
1863
|
-
#
|
2012
|
+
# Gets a list of all grants for the specified customer master key (CMK).
|
2013
|
+
#
|
2014
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
2015
|
+
# the key ARN in the value of the KeyId parameter.
|
1864
2016
|
#
|
1865
2017
|
# @option params [Integer] :limit
|
1866
2018
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -1876,14 +2028,19 @@ module Aws::KMS
|
|
1876
2028
|
# from the truncated response you just received.
|
1877
2029
|
#
|
1878
2030
|
# @option params [required, String] :key_id
|
1879
|
-
# A unique identifier for the customer master key.
|
1880
|
-
#
|
2031
|
+
# A unique identifier for the customer master key (CMK).
|
2032
|
+
#
|
2033
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
2034
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
1881
2035
|
#
|
1882
|
-
#
|
1883
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
2036
|
+
# For example:
|
1884
2037
|
#
|
1885
|
-
# *
|
1886
|
-
#
|
2038
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2039
|
+
#
|
2040
|
+
# * Key ARN:
|
2041
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2042
|
+
#
|
2043
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
1887
2044
|
#
|
1888
2045
|
# @return [Types::ListGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1889
2046
|
#
|
@@ -1994,17 +2151,26 @@ module Aws::KMS
|
|
1994
2151
|
req.send_request(options)
|
1995
2152
|
end
|
1996
2153
|
|
1997
|
-
#
|
2154
|
+
# Gets the names of the key policies that are attached to a customer
|
2155
|
+
# master key (CMK). This operation is designed to get policy names that
|
2156
|
+
# you can use in a GetKeyPolicy operation. However, the only valid
|
2157
|
+
# policy name is `default`. You cannot perform this operation on a CMK
|
2158
|
+
# in a different AWS account.
|
1998
2159
|
#
|
1999
2160
|
# @option params [required, String] :key_id
|
2000
|
-
# A unique identifier for the customer master key (CMK).
|
2001
|
-
#
|
2161
|
+
# A unique identifier for the customer master key (CMK).
|
2162
|
+
#
|
2163
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2002
2164
|
#
|
2003
|
-
#
|
2165
|
+
# For example:
|
2166
|
+
#
|
2167
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2004
2168
|
#
|
2005
2169
|
# * Key ARN:
|
2006
2170
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2007
2171
|
#
|
2172
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2173
|
+
#
|
2008
2174
|
# @option params [Integer] :limit
|
2009
2175
|
# Use this parameter to specify the maximum number of items to return.
|
2010
2176
|
# When this value is present, AWS KMS does not return more than the
|
@@ -2068,7 +2234,8 @@ module Aws::KMS
|
|
2068
2234
|
req.send_request(options)
|
2069
2235
|
end
|
2070
2236
|
|
2071
|
-
#
|
2237
|
+
# Gets a list of all customer master keys (CMKs) in the caller's AWS
|
2238
|
+
# account and region.
|
2072
2239
|
#
|
2073
2240
|
# @option params [Integer] :limit
|
2074
2241
|
# Use this parameter to specify the maximum number of items to return.
|
@@ -2160,16 +2327,22 @@ module Aws::KMS
|
|
2160
2327
|
# Returns a list of all tags for the specified customer master key
|
2161
2328
|
# (CMK).
|
2162
2329
|
#
|
2330
|
+
# You cannot perform this operation on a CMK in a different AWS account.
|
2331
|
+
#
|
2163
2332
|
# @option params [required, String] :key_id
|
2164
|
-
# A unique identifier for the
|
2165
|
-
#
|
2166
|
-
#
|
2333
|
+
# A unique identifier for the customer master key (CMK).
|
2334
|
+
#
|
2335
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2167
2336
|
#
|
2168
|
-
#
|
2337
|
+
# For example:
|
2338
|
+
#
|
2339
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2169
2340
|
#
|
2170
2341
|
# * Key ARN:
|
2171
2342
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2172
2343
|
#
|
2344
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2345
|
+
#
|
2173
2346
|
# @option params [Integer] :limit
|
2174
2347
|
# Use this parameter to specify the maximum number of items to return.
|
2175
2348
|
# When this value is present, AWS KMS does not return more than the
|
@@ -2349,7 +2522,8 @@ module Aws::KMS
|
|
2349
2522
|
req.send_request(options)
|
2350
2523
|
end
|
2351
2524
|
|
2352
|
-
# Attaches a key policy to the specified customer master key (CMK).
|
2525
|
+
# Attaches a key policy to the specified customer master key (CMK). You
|
2526
|
+
# cannot perform this operation on a CMK in a different AWS account.
|
2353
2527
|
#
|
2354
2528
|
# For more information about key policies, see [Key Policies][1] in the
|
2355
2529
|
# *AWS Key Management Service Developer Guide*.
|
@@ -2359,20 +2533,21 @@ module Aws::KMS
|
|
2359
2533
|
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
2360
2534
|
#
|
2361
2535
|
# @option params [required, String] :key_id
|
2362
|
-
# A unique identifier for the CMK.
|
2536
|
+
# A unique identifier for the customer master key (CMK).
|
2537
|
+
#
|
2538
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2363
2539
|
#
|
2364
|
-
# Use the CMK's unique identifier or its Amazon Resource Name (ARN).
|
2365
2540
|
# For example:
|
2366
2541
|
#
|
2367
|
-
# *
|
2542
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2543
|
+
#
|
2544
|
+
# * Key ARN:
|
2545
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2368
2546
|
#
|
2369
|
-
#
|
2370
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
2547
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2371
2548
|
#
|
2372
2549
|
# @option params [required, String] :policy_name
|
2373
|
-
# The name of the key policy.
|
2374
|
-
#
|
2375
|
-
# This value must be `default`.
|
2550
|
+
# The name of the key policy. The only valid value is `default`.
|
2376
2551
|
#
|
2377
2552
|
# @option params [required, String] :policy
|
2378
2553
|
# The key policy to attach to the CMK.
|
@@ -2394,7 +2569,7 @@ module Aws::KMS
|
|
2394
2569
|
# information, see [Changes that I make are not always immediately
|
2395
2570
|
# visible][2] in the *IAM User Guide*.
|
2396
2571
|
#
|
2397
|
-
# The policy size limit is 32
|
2572
|
+
# The policy size limit is 32 kilobytes (32768 bytes).
|
2398
2573
|
#
|
2399
2574
|
#
|
2400
2575
|
#
|
@@ -2458,6 +2633,8 @@ module Aws::KMS
|
|
2458
2633
|
# data is first decrypted and then reencrypted. You can also use this
|
2459
2634
|
# operation to change the encryption context of a ciphertext.
|
2460
2635
|
#
|
2636
|
+
# You can reencrypt data using CMKs in different AWS accounts.
|
2637
|
+
#
|
2461
2638
|
# Unlike other operations, `ReEncrypt` is authorized twice, once as
|
2462
2639
|
# `ReEncryptFrom` on the source CMK and once as `ReEncryptTo` on the
|
2463
2640
|
# destination CMK. We recommend that you include the `"kms:ReEncrypt*"`
|
@@ -2479,20 +2656,26 @@ module Aws::KMS
|
|
2479
2656
|
# the `CiphertextBlob` parameter.
|
2480
2657
|
#
|
2481
2658
|
# @option params [required, String] :destination_key_id
|
2482
|
-
# A unique identifier for the CMK
|
2483
|
-
# value can be a globally unique identifier, a fully specified ARN to
|
2484
|
-
# either an alias or a key, or an alias name prefixed by "alias/".
|
2659
|
+
# A unique identifier for the CMK that is used to reencrypt the data.
|
2485
2660
|
#
|
2486
|
-
#
|
2487
|
-
#
|
2661
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
2662
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
2663
|
+
# "alias/". To specify a CMK in a different AWS account, you must use
|
2664
|
+
# the key ARN or alias ARN.
|
2488
2665
|
#
|
2489
|
-
#
|
2490
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
2666
|
+
# For example:
|
2491
2667
|
#
|
2492
|
-
# *
|
2493
|
-
# 12345678-1234-1234-1234-123456789012
|
2668
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2494
2669
|
#
|
2495
|
-
# *
|
2670
|
+
# * Key ARN:
|
2671
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2672
|
+
#
|
2673
|
+
# * Alias name: `alias/ExampleAlias`
|
2674
|
+
#
|
2675
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
2676
|
+
#
|
2677
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2678
|
+
# To get the alias name and alias ARN, use ListAliases.
|
2496
2679
|
#
|
2497
2680
|
# @option params [Hash<String,String>] :destination_encryption_context
|
2498
2681
|
# Encryption context to use when the data is reencrypted.
|
@@ -2581,12 +2764,10 @@ module Aws::KMS
|
|
2581
2764
|
# Token that identifies the grant to be retired.
|
2582
2765
|
#
|
2583
2766
|
# @option params [String] :key_id
|
2584
|
-
# The Amazon Resource Name of the CMK associated with the grant.
|
2585
|
-
# Example:
|
2767
|
+
# The Amazon Resource Name (ARN) of the CMK associated with the grant.
|
2586
2768
|
#
|
2587
|
-
#
|
2588
|
-
#
|
2589
|
-
# ^
|
2769
|
+
# For example:
|
2770
|
+
# `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2590
2771
|
#
|
2591
2772
|
# @option params [String] :grant_id
|
2592
2773
|
# Unique identifier of the grant to retire. The grant ID is returned in
|
@@ -2626,19 +2807,28 @@ module Aws::KMS
|
|
2626
2807
|
req.send_request(options)
|
2627
2808
|
end
|
2628
2809
|
|
2629
|
-
# Revokes
|
2630
|
-
# that depend
|
2810
|
+
# Revokes the specified grant for the specified customer master key
|
2811
|
+
# (CMK). You can revoke a grant to actively deny operations that depend
|
2812
|
+
# on it.
|
2813
|
+
#
|
2814
|
+
# To perform this operation on a CMK in a different AWS account, specify
|
2815
|
+
# the key ARN in the value of the KeyId parameter.
|
2631
2816
|
#
|
2632
2817
|
# @option params [required, String] :key_id
|
2633
2818
|
# A unique identifier for the customer master key associated with the
|
2634
|
-
# grant.
|
2635
|
-
#
|
2819
|
+
# grant.
|
2820
|
+
#
|
2821
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
2822
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
2823
|
+
#
|
2824
|
+
# For example:
|
2825
|
+
#
|
2826
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2636
2827
|
#
|
2637
|
-
# * Key ARN
|
2638
|
-
# arn:aws:kms:us-east-
|
2828
|
+
# * Key ARN:
|
2829
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2639
2830
|
#
|
2640
|
-
#
|
2641
|
-
# 12345678-1234-1234-1234-123456789012
|
2831
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2642
2832
|
#
|
2643
2833
|
# @option params [required, String] :grant_id
|
2644
2834
|
# Identifier of the grant to be revoked.
|
@@ -2680,6 +2870,8 @@ module Aws::KMS
|
|
2680
2870
|
# period ends, AWS KMS deletes the CMK and all AWS KMS data associated
|
2681
2871
|
# with it, including all aliases that refer to it.
|
2682
2872
|
#
|
2873
|
+
# You cannot perform this operation on a CMK in a different AWS account.
|
2874
|
+
#
|
2683
2875
|
# Deleting a CMK is a destructive and potentially dangerous operation.
|
2684
2876
|
# When a CMK is deleted, all data that was encrypted under the CMK is
|
2685
2877
|
# rendered unrecoverable. To restrict the use of a CMK without deleting
|
@@ -2694,18 +2886,18 @@ module Aws::KMS
|
|
2694
2886
|
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
|
2695
2887
|
#
|
2696
2888
|
# @option params [required, String] :key_id
|
2697
|
-
# The unique identifier
|
2889
|
+
# The unique identifier of the customer master key (CMK) to delete.
|
2698
2890
|
#
|
2699
|
-
#
|
2700
|
-
# Name (ARN) of the CMK. Examples:
|
2891
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2701
2892
|
#
|
2702
|
-
#
|
2893
|
+
# For example:
|
2894
|
+
#
|
2895
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2703
2896
|
#
|
2704
2897
|
# * Key ARN:
|
2705
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
2898
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2706
2899
|
#
|
2707
|
-
# To
|
2708
|
-
# or DescribeKey.
|
2900
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2709
2901
|
#
|
2710
2902
|
# @option params [Integer] :pending_window_in_days
|
2711
2903
|
# The waiting period, specified in number of days. After the waiting
|
@@ -2757,7 +2949,8 @@ module Aws::KMS
|
|
2757
2949
|
end
|
2758
2950
|
|
2759
2951
|
# Adds or overwrites one or more tags for the specified customer master
|
2760
|
-
# key (CMK).
|
2952
|
+
# key (CMK). You cannot perform this operation on a CMK in a different
|
2953
|
+
# AWS account.
|
2761
2954
|
#
|
2762
2955
|
# Each tag consists of a tag key and a tag value. Tag keys and tag
|
2763
2956
|
# values are both required, but tag values can be empty (null) strings.
|
@@ -2769,15 +2962,28 @@ module Aws::KMS
|
|
2769
2962
|
# second tag. Instead, the original tag is overwritten with the new tag
|
2770
2963
|
# value.
|
2771
2964
|
#
|
2965
|
+
# For information about the rules that apply to tag keys and tag values,
|
2966
|
+
# see [User-Defined Tag Restrictions][1] in the *AWS Billing and Cost
|
2967
|
+
# Management User Guide*.
|
2968
|
+
#
|
2969
|
+
#
|
2970
|
+
#
|
2971
|
+
# [1]: http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
2972
|
+
#
|
2772
2973
|
# @option params [required, String] :key_id
|
2773
|
-
# A unique identifier for the CMK you are tagging.
|
2774
|
-
#
|
2974
|
+
# A unique identifier for the CMK you are tagging.
|
2975
|
+
#
|
2976
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2775
2977
|
#
|
2776
|
-
#
|
2978
|
+
# For example:
|
2979
|
+
#
|
2980
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2777
2981
|
#
|
2778
2982
|
# * Key ARN:
|
2779
2983
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2780
2984
|
#
|
2985
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2986
|
+
#
|
2781
2987
|
# @option params [required, Array<Types::Tag>] :tags
|
2782
2988
|
# One or more tags. Each tag consists of a tag key and a tag value.
|
2783
2989
|
#
|
@@ -2820,22 +3026,27 @@ module Aws::KMS
|
|
2820
3026
|
end
|
2821
3027
|
|
2822
3028
|
# Removes the specified tag or tags from the specified customer master
|
2823
|
-
# key (CMK).
|
3029
|
+
# key (CMK). You cannot perform this operation on a CMK in a different
|
3030
|
+
# AWS account.
|
2824
3031
|
#
|
2825
3032
|
# To remove a tag, you specify the tag key for each tag to remove. You
|
2826
3033
|
# do not specify the tag value. To overwrite the tag value for an
|
2827
3034
|
# existing tag, use TagResource.
|
2828
3035
|
#
|
2829
3036
|
# @option params [required, String] :key_id
|
2830
|
-
# A unique identifier for the CMK from which you are removing tags.
|
2831
|
-
#
|
2832
|
-
# CMK.
|
3037
|
+
# A unique identifier for the CMK from which you are removing tags.
|
3038
|
+
#
|
3039
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
3040
|
+
#
|
3041
|
+
# For example:
|
2833
3042
|
#
|
2834
|
-
# *
|
3043
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2835
3044
|
#
|
2836
3045
|
# * Key ARN:
|
2837
3046
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2838
3047
|
#
|
3048
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
3049
|
+
#
|
2839
3050
|
# @option params [required, Array<String>] :tag_keys
|
2840
3051
|
# One or more tag keys. Specify only the tag keys, not the tag values.
|
2841
3052
|
#
|
@@ -2870,20 +3081,28 @@ module Aws::KMS
|
|
2870
3081
|
req.send_request(options)
|
2871
3082
|
end
|
2872
3083
|
|
2873
|
-
#
|
3084
|
+
# Associates an existing alias with a different customer master key
|
3085
|
+
# (CMK). Each CMK can have multiple aliases, but the aliases must be
|
3086
|
+
# unique within the account and region. You cannot perform this
|
3087
|
+
# operation on an alias in a different AWS account.
|
3088
|
+
#
|
3089
|
+
# This operation works only on existing aliases. To change the alias of
|
3090
|
+
# a CMK to a new value, use CreateAlias to create a new alias and
|
3091
|
+
# DeleteAlias to delete the old alias.
|
2874
3092
|
#
|
2875
|
-
#
|
2876
|
-
#
|
2877
|
-
#
|
3093
|
+
# Because an alias is not a property of a CMK, you can create, update,
|
3094
|
+
# and delete the aliases of a CMK without affecting the CMK. Also,
|
3095
|
+
# aliases do not appear in the response from the DescribeKey operation.
|
3096
|
+
# To get the aliases of all CMKs in the account, use the ListAliases
|
3097
|
+
# operation.
|
2878
3098
|
#
|
2879
3099
|
# An alias name can contain only alphanumeric characters, forward
|
2880
3100
|
# slashes (/), underscores (\_), and dashes (-). An alias must start
|
2881
|
-
# with the word
|
2882
|
-
#
|
2883
|
-
#
|
2884
|
-
#
|
2885
|
-
#
|
2886
|
-
# and the same region.
|
3101
|
+
# with the word `alias` followed by a forward slash (`alias/`). The
|
3102
|
+
# alias name can contain only alphanumeric characters, forward slashes
|
3103
|
+
# (/), underscores (\_), and dashes (-). Alias names cannot begin with
|
3104
|
+
# `aws`; that alias name prefix is reserved by Amazon Web Services
|
3105
|
+
# (AWS).
|
2887
3106
|
#
|
2888
3107
|
# @option params [required, String] :alias_name
|
2889
3108
|
# String that contains the name of the alias to be modified. The name
|
@@ -2892,17 +3111,21 @@ module Aws::KMS
|
|
2892
3111
|
#
|
2893
3112
|
# @option params [required, String] :target_key_id
|
2894
3113
|
# Unique identifier of the customer master key to be mapped to the
|
2895
|
-
# alias.
|
2896
|
-
#
|
3114
|
+
# alias.
|
3115
|
+
#
|
3116
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
3117
|
+
#
|
3118
|
+
# For example:
|
3119
|
+
#
|
3120
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2897
3121
|
#
|
2898
|
-
# * Key ARN
|
2899
|
-
# arn:aws:kms:us-east-
|
3122
|
+
# * Key ARN:
|
3123
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2900
3124
|
#
|
2901
|
-
#
|
2902
|
-
# 12345678-1234-1234-1234-123456789012
|
3125
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2903
3126
|
#
|
2904
|
-
#
|
2905
|
-
#
|
3127
|
+
# To verify that the alias is mapped to the correct CMK, use
|
3128
|
+
# ListAliases.
|
2906
3129
|
#
|
2907
3130
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2908
3131
|
#
|
@@ -2932,17 +3155,24 @@ module Aws::KMS
|
|
2932
3155
|
req.send_request(options)
|
2933
3156
|
end
|
2934
3157
|
|
2935
|
-
# Updates the description of a customer master key (CMK).
|
3158
|
+
# Updates the description of a customer master key (CMK). To see the
|
3159
|
+
# decription of a CMK, use DescribeKey.
|
3160
|
+
#
|
3161
|
+
# You cannot perform this operation on a CMK in a different AWS account.
|
2936
3162
|
#
|
2937
3163
|
# @option params [required, String] :key_id
|
2938
|
-
# A unique identifier for the
|
2939
|
-
#
|
3164
|
+
# A unique identifier for the customer master key (CMK).
|
3165
|
+
#
|
3166
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2940
3167
|
#
|
2941
|
-
#
|
2942
|
-
#
|
3168
|
+
# For example:
|
3169
|
+
#
|
3170
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
3171
|
+
#
|
3172
|
+
# * Key ARN:
|
3173
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2943
3174
|
#
|
2944
|
-
#
|
2945
|
-
# 12345678-1234-1234-1234-123456789012
|
3175
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
|
2946
3176
|
#
|
2947
3177
|
# @option params [required, String] :description
|
2948
3178
|
# New description for the CMK.
|
@@ -2988,7 +3218,7 @@ module Aws::KMS
|
|
2988
3218
|
params: params,
|
2989
3219
|
config: config)
|
2990
3220
|
context[:gem_name] = 'aws-sdk-kms'
|
2991
|
-
context[:gem_version] = '1.
|
3221
|
+
context[:gem_version] = '1.3.0'
|
2992
3222
|
Seahorse::Client::Request.new(handlers, context)
|
2993
3223
|
end
|
2994
3224
|
|