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
@@ -156,7 +156,7 @@ module Aws::KMS
|
|
156
156
|
CreateGrantRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
|
157
157
|
CreateGrantRequest.add_member(:grantee_principal, Shapes::ShapeRef.new(shape: PrincipalIdType, required: true, location_name: "GranteePrincipal"))
|
158
158
|
CreateGrantRequest.add_member(:retiring_principal, Shapes::ShapeRef.new(shape: PrincipalIdType, location_name: "RetiringPrincipal"))
|
159
|
-
CreateGrantRequest.add_member(:operations, Shapes::ShapeRef.new(shape: GrantOperationList, location_name: "Operations"))
|
159
|
+
CreateGrantRequest.add_member(:operations, Shapes::ShapeRef.new(shape: GrantOperationList, required: true, location_name: "Operations"))
|
160
160
|
CreateGrantRequest.add_member(:constraints, Shapes::ShapeRef.new(shape: GrantConstraints, location_name: "Constraints"))
|
161
161
|
CreateGrantRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
|
162
162
|
CreateGrantRequest.add_member(:name, Shapes::ShapeRef.new(shape: GrantNameType, location_name: "Name"))
|
data/lib/aws-sdk-kms/types.rb
CHANGED
@@ -42,16 +42,17 @@ module Aws::KMS
|
|
42
42
|
# The unique identifier for the customer master key (CMK) for which to
|
43
43
|
# cancel deletion.
|
44
44
|
#
|
45
|
-
#
|
46
|
-
# Name (ARN) of the CMK. Examples:
|
45
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
47
46
|
#
|
48
|
-
#
|
47
|
+
# For example:
|
48
|
+
#
|
49
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
49
50
|
#
|
50
51
|
# * Key ARN:
|
51
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
52
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
52
53
|
#
|
53
|
-
# To
|
54
|
-
#
|
54
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
55
|
+
# DescribeKey.
|
55
56
|
# @return [String]
|
56
57
|
#
|
57
58
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletionRequest AWS API Documentation
|
@@ -88,15 +89,20 @@ module Aws::KMS
|
|
88
89
|
# @return [String]
|
89
90
|
#
|
90
91
|
# @!attribute [rw] target_key_id
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
92
|
+
# Identifies the CMK for which you are creating the alias. This value
|
93
|
+
# cannot be an alias.
|
94
|
+
#
|
95
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
96
|
+
#
|
97
|
+
# For example:
|
94
98
|
#
|
95
|
-
# * Key
|
96
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
99
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
97
100
|
#
|
98
|
-
# *
|
99
|
-
#
|
101
|
+
# * Key ARN:
|
102
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
103
|
+
#
|
104
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
105
|
+
# DescribeKey.
|
100
106
|
# @return [String]
|
101
107
|
#
|
102
108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest AWS API Documentation
|
@@ -114,7 +120,7 @@ module Aws::KMS
|
|
114
120
|
# key_id: "KeyIdType", # required
|
115
121
|
# grantee_principal: "PrincipalIdType", # required
|
116
122
|
# retiring_principal: "PrincipalIdType",
|
117
|
-
# operations: ["Decrypt"], # accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
|
123
|
+
# operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
|
118
124
|
# constraints: {
|
119
125
|
# encryption_context_subset: {
|
120
126
|
# "EncryptionContextKey" => "EncryptionContextValue",
|
@@ -131,13 +137,18 @@ module Aws::KMS
|
|
131
137
|
# The unique identifier for the customer master key (CMK) that the
|
132
138
|
# grant applies to.
|
133
139
|
#
|
134
|
-
#
|
135
|
-
#
|
140
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
141
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
136
142
|
#
|
137
|
-
#
|
143
|
+
# For example:
|
144
|
+
#
|
145
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
138
146
|
#
|
139
147
|
# * Key ARN:
|
140
|
-
# arn:aws:kms:us-
|
148
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
149
|
+
#
|
150
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
151
|
+
# DescribeKey.
|
141
152
|
# @return [String]
|
142
153
|
#
|
143
154
|
# @!attribute [rw] grantee_principal
|
@@ -298,7 +309,7 @@ module Aws::KMS
|
|
298
309
|
# policy to the CMK. For more information, see [Default Key Policy][3]
|
299
310
|
# in the *AWS Key Management Service Developer Guide*.
|
300
311
|
#
|
301
|
-
# The policy size limit is 32
|
312
|
+
# The policy size limit is 32 kilobytes (32768 bytes).
|
302
313
|
#
|
303
314
|
#
|
304
315
|
#
|
@@ -445,9 +456,8 @@ module Aws::KMS
|
|
445
456
|
# @return [String]
|
446
457
|
#
|
447
458
|
# @!attribute [rw] plaintext
|
448
|
-
# Decrypted plaintext data.
|
449
|
-
#
|
450
|
-
# permission to use it.
|
459
|
+
# Decrypted plaintext data. When you use the HTTP API or the AWS CLI,
|
460
|
+
# the value is Base64-encoded. Otherwise, it is not encoded.
|
451
461
|
# @return [String]
|
452
462
|
#
|
453
463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse AWS API Documentation
|
@@ -468,7 +478,7 @@ module Aws::KMS
|
|
468
478
|
# @!attribute [rw] alias_name
|
469
479
|
# The alias to be deleted. The name must start with the word "alias"
|
470
480
|
# followed by a forward slash (alias/). Aliases that begin with
|
471
|
-
# "alias/
|
481
|
+
# "alias/aws" are reserved.
|
472
482
|
# @return [String]
|
473
483
|
#
|
474
484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasRequest AWS API Documentation
|
@@ -489,13 +499,17 @@ module Aws::KMS
|
|
489
499
|
# The identifier of the CMK whose key material to delete. The CMK's
|
490
500
|
# `Origin` must be `EXTERNAL`.
|
491
501
|
#
|
492
|
-
#
|
493
|
-
#
|
502
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
503
|
+
#
|
504
|
+
# For example:
|
494
505
|
#
|
495
|
-
# *
|
506
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
496
507
|
#
|
497
508
|
# * Key ARN:
|
498
509
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
510
|
+
#
|
511
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
512
|
+
# DescribeKey.
|
499
513
|
# @return [String]
|
500
514
|
#
|
501
515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialRequest AWS API Documentation
|
@@ -514,20 +528,26 @@ module Aws::KMS
|
|
514
528
|
# }
|
515
529
|
#
|
516
530
|
# @!attribute [rw] key_id
|
517
|
-
# A unique identifier for the customer master key.
|
518
|
-
# globally unique identifier, a fully specified ARN to either an alias
|
519
|
-
# or a key, or an alias name prefixed by "alias/".
|
531
|
+
# A unique identifier for the customer master key (CMK).
|
520
532
|
#
|
521
|
-
#
|
522
|
-
#
|
533
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
534
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
535
|
+
# "alias/". To specify a CMK in a different AWS account, you must
|
536
|
+
# use the key ARN or alias ARN.
|
523
537
|
#
|
524
|
-
#
|
525
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
538
|
+
# For example:
|
526
539
|
#
|
527
|
-
# *
|
528
|
-
# 12345678-1234-1234-1234-123456789012
|
540
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
529
541
|
#
|
530
|
-
# *
|
542
|
+
# * Key ARN:
|
543
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
544
|
+
#
|
545
|
+
# * Alias name: `alias/ExampleAlias`
|
546
|
+
#
|
547
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
548
|
+
#
|
549
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
550
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
531
551
|
# @return [String]
|
532
552
|
#
|
533
553
|
# @!attribute [rw] grant_tokens
|
@@ -568,15 +588,19 @@ module Aws::KMS
|
|
568
588
|
# }
|
569
589
|
#
|
570
590
|
# @!attribute [rw] key_id
|
571
|
-
# A unique identifier for the CMK.
|
591
|
+
# A unique identifier for the customer master key (CMK).
|
592
|
+
#
|
593
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
572
594
|
#
|
573
|
-
# Use the CMK's unique identifier or its Amazon Resource Name (ARN).
|
574
595
|
# For example:
|
575
596
|
#
|
576
|
-
# *
|
597
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
598
|
+
#
|
599
|
+
# * Key ARN:
|
600
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
577
601
|
#
|
578
|
-
#
|
579
|
-
#
|
602
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
603
|
+
# DescribeKey.
|
580
604
|
# @return [String]
|
581
605
|
#
|
582
606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRequest AWS API Documentation
|
@@ -594,14 +618,19 @@ module Aws::KMS
|
|
594
618
|
# }
|
595
619
|
#
|
596
620
|
# @!attribute [rw] key_id
|
597
|
-
# A unique identifier for the customer master key.
|
598
|
-
# globally unique identifier or the fully specified ARN to a key.
|
621
|
+
# A unique identifier for the customer master key (CMK).
|
599
622
|
#
|
600
|
-
#
|
601
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
623
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
602
624
|
#
|
603
|
-
#
|
604
|
-
#
|
625
|
+
# For example:
|
626
|
+
#
|
627
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
628
|
+
#
|
629
|
+
# * Key ARN:
|
630
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
631
|
+
#
|
632
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
633
|
+
# DescribeKey.
|
605
634
|
# @return [String]
|
606
635
|
#
|
607
636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationRequest AWS API Documentation
|
@@ -619,14 +648,19 @@ module Aws::KMS
|
|
619
648
|
# }
|
620
649
|
#
|
621
650
|
# @!attribute [rw] key_id
|
622
|
-
# A unique identifier for the customer master key.
|
623
|
-
#
|
651
|
+
# A unique identifier for the customer master key (CMK).
|
652
|
+
#
|
653
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
654
|
+
#
|
655
|
+
# For example:
|
624
656
|
#
|
625
|
-
# * Key
|
626
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
657
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
627
658
|
#
|
628
|
-
# *
|
629
|
-
#
|
659
|
+
# * Key ARN:
|
660
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
661
|
+
#
|
662
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
663
|
+
# DescribeKey.
|
630
664
|
# @return [String]
|
631
665
|
#
|
632
666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRequest AWS API Documentation
|
@@ -644,14 +678,19 @@ module Aws::KMS
|
|
644
678
|
# }
|
645
679
|
#
|
646
680
|
# @!attribute [rw] key_id
|
647
|
-
# A unique identifier for the customer master key.
|
648
|
-
# globally unique identifier or the fully specified ARN to a key.
|
681
|
+
# A unique identifier for the customer master key (CMK).
|
649
682
|
#
|
650
|
-
#
|
651
|
-
#
|
683
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
684
|
+
#
|
685
|
+
# For example:
|
686
|
+
#
|
687
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
688
|
+
#
|
689
|
+
# * Key ARN:
|
690
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
652
691
|
#
|
653
|
-
#
|
654
|
-
#
|
692
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
693
|
+
# DescribeKey.
|
655
694
|
# @return [String]
|
656
695
|
#
|
657
696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotationRequest AWS API Documentation
|
@@ -674,20 +713,26 @@ module Aws::KMS
|
|
674
713
|
# }
|
675
714
|
#
|
676
715
|
# @!attribute [rw] key_id
|
677
|
-
# A unique identifier for the customer master key.
|
678
|
-
# globally unique identifier, a fully specified ARN to either an alias
|
679
|
-
# or a key, or an alias name prefixed by "alias/".
|
716
|
+
# A unique identifier for the customer master key (CMK).
|
680
717
|
#
|
681
|
-
#
|
682
|
-
#
|
718
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
719
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
720
|
+
# "alias/". To specify a CMK in a different AWS account, you must
|
721
|
+
# use the key ARN or alias ARN.
|
683
722
|
#
|
684
|
-
#
|
685
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
723
|
+
# For example:
|
686
724
|
#
|
687
|
-
# *
|
688
|
-
# 12345678-1234-1234-1234-123456789012
|
725
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
689
726
|
#
|
690
|
-
# *
|
727
|
+
# * Key ARN:
|
728
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
729
|
+
#
|
730
|
+
# * Alias name: `alias/ExampleAlias`
|
731
|
+
#
|
732
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
733
|
+
#
|
734
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
735
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
691
736
|
# @return [String]
|
692
737
|
#
|
693
738
|
# @!attribute [rw] plaintext
|
@@ -727,8 +772,8 @@ module Aws::KMS
|
|
727
772
|
end
|
728
773
|
|
729
774
|
# @!attribute [rw] ciphertext_blob
|
730
|
-
# The encrypted plaintext.
|
731
|
-
# Base64
|
775
|
+
# The encrypted plaintext. When you use the HTTP API or the AWS CLI,
|
776
|
+
# the value is Base64-encoded. Otherwise, it is not encoded.
|
732
777
|
# @return [String]
|
733
778
|
#
|
734
779
|
# @!attribute [rw] key_id
|
@@ -760,18 +805,24 @@ module Aws::KMS
|
|
760
805
|
# The identifier of the CMK under which to generate and encrypt the
|
761
806
|
# data encryption key.
|
762
807
|
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
808
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
809
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
810
|
+
# "alias/". To specify a CMK in a different AWS account, you must
|
811
|
+
# use the key ARN or alias ARN.
|
812
|
+
#
|
813
|
+
# For example:
|
766
814
|
#
|
767
|
-
# *
|
815
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
768
816
|
#
|
769
|
-
# *
|
817
|
+
# * Key ARN:
|
770
818
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
771
819
|
#
|
772
820
|
# * Alias name: `alias/ExampleAlias`
|
773
821
|
#
|
774
822
|
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
823
|
+
#
|
824
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
825
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
775
826
|
# @return [String]
|
776
827
|
#
|
777
828
|
# @!attribute [rw] encryption_context
|
@@ -822,12 +873,15 @@ module Aws::KMS
|
|
822
873
|
end
|
823
874
|
|
824
875
|
# @!attribute [rw] ciphertext_blob
|
825
|
-
# The encrypted data encryption key.
|
876
|
+
# The encrypted data encryption key. When you use the HTTP API or the
|
877
|
+
# AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
|
826
878
|
# @return [String]
|
827
879
|
#
|
828
880
|
# @!attribute [rw] plaintext
|
829
|
-
# The data encryption key.
|
830
|
-
#
|
881
|
+
# The data encryption key. When you use the HTTP API or the AWS CLI,
|
882
|
+
# the value is Base64-encoded. Otherwise, it is not encoded. Use this
|
883
|
+
# data key for local encryption and decryption, then remove it from
|
884
|
+
# memory as soon as possible.
|
831
885
|
# @return [String]
|
832
886
|
#
|
833
887
|
# @!attribute [rw] key_id
|
@@ -858,21 +912,27 @@ module Aws::KMS
|
|
858
912
|
# }
|
859
913
|
#
|
860
914
|
# @!attribute [rw] key_id
|
861
|
-
# The identifier of the CMK under which to
|
862
|
-
# data encryption key.
|
915
|
+
# The identifier of the customer master key (CMK) under which to
|
916
|
+
# generate and encrypt the data encryption key.
|
863
917
|
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
918
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
919
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
920
|
+
# "alias/". To specify a CMK in a different AWS account, you must
|
921
|
+
# use the key ARN or alias ARN.
|
867
922
|
#
|
868
|
-
#
|
923
|
+
# For example:
|
924
|
+
#
|
925
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
869
926
|
#
|
870
|
-
# *
|
927
|
+
# * Key ARN:
|
871
928
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
872
929
|
#
|
873
930
|
# * Alias name: `alias/ExampleAlias`
|
874
931
|
#
|
875
932
|
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
933
|
+
#
|
934
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
935
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
876
936
|
# @return [String]
|
877
937
|
#
|
878
938
|
# @!attribute [rw] encryption_context
|
@@ -923,7 +983,8 @@ module Aws::KMS
|
|
923
983
|
end
|
924
984
|
|
925
985
|
# @!attribute [rw] ciphertext_blob
|
926
|
-
# The encrypted data encryption key.
|
986
|
+
# The encrypted data encryption key. When you use the HTTP API or the
|
987
|
+
# AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
|
927
988
|
# @return [String]
|
928
989
|
#
|
929
990
|
# @!attribute [rw] key_id
|
@@ -958,7 +1019,8 @@ module Aws::KMS
|
|
958
1019
|
end
|
959
1020
|
|
960
1021
|
# @!attribute [rw] plaintext
|
961
|
-
# The random byte string.
|
1022
|
+
# The random byte string. When you use the HTTP API or the AWS CLI,
|
1023
|
+
# the value is Base64-encoded. Otherwise, it is not encoded.
|
962
1024
|
# @return [String]
|
963
1025
|
#
|
964
1026
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse AWS API Documentation
|
@@ -977,20 +1039,24 @@ module Aws::KMS
|
|
977
1039
|
# }
|
978
1040
|
#
|
979
1041
|
# @!attribute [rw] key_id
|
980
|
-
# A unique identifier for the customer master key.
|
981
|
-
# globally unique identifier or the fully specified ARN to a key.
|
1042
|
+
# A unique identifier for the customer master key (CMK).
|
982
1043
|
#
|
983
|
-
#
|
984
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
1044
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
985
1045
|
#
|
986
|
-
#
|
987
|
-
#
|
1046
|
+
# For example:
|
1047
|
+
#
|
1048
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1049
|
+
#
|
1050
|
+
# * Key ARN:
|
1051
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1052
|
+
#
|
1053
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1054
|
+
# DescribeKey.
|
988
1055
|
# @return [String]
|
989
1056
|
#
|
990
1057
|
# @!attribute [rw] policy_name
|
991
|
-
#
|
992
|
-
#
|
993
|
-
# ListKeyPolicies.
|
1058
|
+
# Specifies the name of the policy. The only valid name is `default`.
|
1059
|
+
# To get the names of key policies, use ListKeyPolicies.
|
994
1060
|
# @return [String]
|
995
1061
|
#
|
996
1062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest AWS API Documentation
|
@@ -1020,14 +1086,20 @@ module Aws::KMS
|
|
1020
1086
|
# }
|
1021
1087
|
#
|
1022
1088
|
# @!attribute [rw] key_id
|
1023
|
-
# A unique identifier for the customer master key.
|
1024
|
-
#
|
1089
|
+
# A unique identifier for the customer master key (CMK).
|
1090
|
+
#
|
1091
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
1092
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
1093
|
+
#
|
1094
|
+
# For example:
|
1025
1095
|
#
|
1026
|
-
# * Key
|
1027
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
1096
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1028
1097
|
#
|
1029
|
-
# *
|
1030
|
-
#
|
1098
|
+
# * Key ARN:
|
1099
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1100
|
+
#
|
1101
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1102
|
+
# DescribeKey.
|
1031
1103
|
# @return [String]
|
1032
1104
|
#
|
1033
1105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusRequest AWS API Documentation
|
@@ -1061,13 +1133,17 @@ module Aws::KMS
|
|
1061
1133
|
# The identifier of the CMK into which you will import key material.
|
1062
1134
|
# The CMK's `Origin` must be `EXTERNAL`.
|
1063
1135
|
#
|
1064
|
-
#
|
1065
|
-
#
|
1136
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1137
|
+
#
|
1138
|
+
# For example:
|
1066
1139
|
#
|
1067
|
-
# *
|
1140
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1068
1141
|
#
|
1069
1142
|
# * Key ARN:
|
1070
1143
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1144
|
+
#
|
1145
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1146
|
+
# DescribeKey.
|
1071
1147
|
# @return [String]
|
1072
1148
|
#
|
1073
1149
|
# @!attribute [rw] wrapping_algorithm
|
@@ -1114,7 +1190,7 @@ module Aws::KMS
|
|
1114
1190
|
# The time at which the import token and public key are no longer
|
1115
1191
|
# valid. After this time, you cannot use them to make an
|
1116
1192
|
# ImportKeyMaterial request and you must send another
|
1117
|
-
# `GetParametersForImport` request to
|
1193
|
+
# `GetParametersForImport` request to get new ones.
|
1118
1194
|
# @return [Time]
|
1119
1195
|
#
|
1120
1196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportResponse AWS API Documentation
|
@@ -1254,13 +1330,17 @@ module Aws::KMS
|
|
1254
1330
|
# The identifier of the CMK to import the key material into. The
|
1255
1331
|
# CMK's `Origin` must be `EXTERNAL`.
|
1256
1332
|
#
|
1257
|
-
#
|
1258
|
-
#
|
1333
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1334
|
+
#
|
1335
|
+
# For example:
|
1259
1336
|
#
|
1260
|
-
# *
|
1337
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1261
1338
|
#
|
1262
1339
|
# * Key ARN:
|
1263
1340
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1341
|
+
#
|
1342
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1343
|
+
# DescribeKey.
|
1264
1344
|
# @return [String]
|
1265
1345
|
#
|
1266
1346
|
# @!attribute [rw] import_token
|
@@ -1469,7 +1549,7 @@ module Aws::KMS
|
|
1469
1549
|
end
|
1470
1550
|
|
1471
1551
|
# @!attribute [rw] aliases
|
1472
|
-
# A list of
|
1552
|
+
# A list of aliases.
|
1473
1553
|
# @return [Array<Types::AliasListEntry>]
|
1474
1554
|
#
|
1475
1555
|
# @!attribute [rw] next_marker
|
@@ -1479,9 +1559,9 @@ module Aws::KMS
|
|
1479
1559
|
#
|
1480
1560
|
# @!attribute [rw] truncated
|
1481
1561
|
# A flag that indicates whether there are more items in the list. When
|
1482
|
-
# this value is true, the list in this response is truncated. To
|
1483
|
-
#
|
1484
|
-
#
|
1562
|
+
# this value is true, the list in this response is truncated. To get
|
1563
|
+
# more items, pass the value of the `NextMarker` element in this
|
1564
|
+
# response to the `Marker` parameter in a subsequent request.
|
1485
1565
|
# @return [Boolean]
|
1486
1566
|
#
|
1487
1567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesResponse AWS API Documentation
|
@@ -1519,14 +1599,20 @@ module Aws::KMS
|
|
1519
1599
|
# @return [String]
|
1520
1600
|
#
|
1521
1601
|
# @!attribute [rw] key_id
|
1522
|
-
# A unique identifier for the customer master key.
|
1523
|
-
# globally unique identifier or the fully specified ARN to a key.
|
1602
|
+
# A unique identifier for the customer master key (CMK).
|
1524
1603
|
#
|
1525
|
-
#
|
1526
|
-
#
|
1604
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
1605
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
1527
1606
|
#
|
1528
|
-
#
|
1529
|
-
#
|
1607
|
+
# For example:
|
1608
|
+
#
|
1609
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1610
|
+
#
|
1611
|
+
# * Key ARN:
|
1612
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1613
|
+
#
|
1614
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1615
|
+
# DescribeKey.
|
1530
1616
|
# @return [String]
|
1531
1617
|
#
|
1532
1618
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest AWS API Documentation
|
@@ -1549,9 +1635,9 @@ module Aws::KMS
|
|
1549
1635
|
#
|
1550
1636
|
# @!attribute [rw] truncated
|
1551
1637
|
# A flag that indicates whether there are more items in the list. When
|
1552
|
-
# this value is true, the list in this response is truncated. To
|
1553
|
-
#
|
1554
|
-
#
|
1638
|
+
# this value is true, the list in this response is truncated. To get
|
1639
|
+
# more items, pass the value of the `NextMarker` element in this
|
1640
|
+
# response to the `Marker` parameter in a subsequent request.
|
1555
1641
|
# @return [Boolean]
|
1556
1642
|
#
|
1557
1643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsResponse AWS API Documentation
|
@@ -1573,14 +1659,19 @@ module Aws::KMS
|
|
1573
1659
|
# }
|
1574
1660
|
#
|
1575
1661
|
# @!attribute [rw] key_id
|
1576
|
-
# A unique identifier for the customer master key (CMK).
|
1577
|
-
#
|
1578
|
-
#
|
1662
|
+
# A unique identifier for the customer master key (CMK).
|
1663
|
+
#
|
1664
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1665
|
+
#
|
1666
|
+
# For example:
|
1579
1667
|
#
|
1580
|
-
# *
|
1668
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1581
1669
|
#
|
1582
1670
|
# * Key ARN:
|
1583
1671
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1672
|
+
#
|
1673
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1674
|
+
# DescribeKey.
|
1584
1675
|
# @return [String]
|
1585
1676
|
#
|
1586
1677
|
# @!attribute [rw] limit
|
@@ -1622,9 +1713,9 @@ module Aws::KMS
|
|
1622
1713
|
#
|
1623
1714
|
# @!attribute [rw] truncated
|
1624
1715
|
# A flag that indicates whether there are more items in the list. When
|
1625
|
-
# this value is true, the list in this response is truncated. To
|
1626
|
-
#
|
1627
|
-
#
|
1716
|
+
# this value is true, the list in this response is truncated. To get
|
1717
|
+
# more items, pass the value of the `NextMarker` element in this
|
1718
|
+
# response to the `Marker` parameter in a subsequent request.
|
1628
1719
|
# @return [Boolean]
|
1629
1720
|
#
|
1630
1721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesResponse AWS API Documentation
|
@@ -1669,7 +1760,7 @@ module Aws::KMS
|
|
1669
1760
|
end
|
1670
1761
|
|
1671
1762
|
# @!attribute [rw] keys
|
1672
|
-
# A list of keys.
|
1763
|
+
# A list of customer master keys (CMKs).
|
1673
1764
|
# @return [Array<Types::KeyListEntry>]
|
1674
1765
|
#
|
1675
1766
|
# @!attribute [rw] next_marker
|
@@ -1679,9 +1770,9 @@ module Aws::KMS
|
|
1679
1770
|
#
|
1680
1771
|
# @!attribute [rw] truncated
|
1681
1772
|
# A flag that indicates whether there are more items in the list. When
|
1682
|
-
# this value is true, the list in this response is truncated. To
|
1683
|
-
#
|
1684
|
-
#
|
1773
|
+
# this value is true, the list in this response is truncated. To get
|
1774
|
+
# more items, pass the value of the `NextMarker` element in this
|
1775
|
+
# response to the `Marker` parameter in a subsequent request.
|
1685
1776
|
# @return [Boolean]
|
1686
1777
|
#
|
1687
1778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysResponse AWS API Documentation
|
@@ -1703,14 +1794,19 @@ module Aws::KMS
|
|
1703
1794
|
# }
|
1704
1795
|
#
|
1705
1796
|
# @!attribute [rw] key_id
|
1706
|
-
# A unique identifier for the
|
1707
|
-
#
|
1708
|
-
#
|
1797
|
+
# A unique identifier for the customer master key (CMK).
|
1798
|
+
#
|
1799
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1709
1800
|
#
|
1710
|
-
#
|
1801
|
+
# For example:
|
1802
|
+
#
|
1803
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1711
1804
|
#
|
1712
1805
|
# * Key ARN:
|
1713
1806
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1807
|
+
#
|
1808
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1809
|
+
# DescribeKey.
|
1714
1810
|
# @return [String]
|
1715
1811
|
#
|
1716
1812
|
# @!attribute [rw] limit
|
@@ -1753,9 +1849,9 @@ module Aws::KMS
|
|
1753
1849
|
#
|
1754
1850
|
# @!attribute [rw] truncated
|
1755
1851
|
# A flag that indicates whether there are more items in the list. When
|
1756
|
-
# this value is true, the list in this response is truncated. To
|
1757
|
-
#
|
1758
|
-
#
|
1852
|
+
# this value is true, the list in this response is truncated. To get
|
1853
|
+
# more items, pass the value of the `NextMarker` element in this
|
1854
|
+
# response to the `Marker` parameter in a subsequent request.
|
1759
1855
|
# @return [Boolean]
|
1760
1856
|
#
|
1761
1857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsResponse AWS API Documentation
|
@@ -1828,21 +1924,23 @@ module Aws::KMS
|
|
1828
1924
|
# }
|
1829
1925
|
#
|
1830
1926
|
# @!attribute [rw] key_id
|
1831
|
-
# A unique identifier for the CMK.
|
1927
|
+
# A unique identifier for the customer master key (CMK).
|
1928
|
+
#
|
1929
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
1832
1930
|
#
|
1833
|
-
# Use the CMK's unique identifier or its Amazon Resource Name (ARN).
|
1834
1931
|
# For example:
|
1835
1932
|
#
|
1836
|
-
# *
|
1933
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1934
|
+
#
|
1935
|
+
# * Key ARN:
|
1936
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1837
1937
|
#
|
1838
|
-
#
|
1839
|
-
#
|
1938
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
1939
|
+
# DescribeKey.
|
1840
1940
|
# @return [String]
|
1841
1941
|
#
|
1842
1942
|
# @!attribute [rw] policy_name
|
1843
|
-
# The name of the key policy.
|
1844
|
-
#
|
1845
|
-
# This value must be `default`.
|
1943
|
+
# The name of the key policy. The only valid value is `default`.
|
1846
1944
|
# @return [String]
|
1847
1945
|
#
|
1848
1946
|
# @!attribute [rw] policy
|
@@ -1866,7 +1964,7 @@ module Aws::KMS
|
|
1866
1964
|
# more information, see [Changes that I make are not always
|
1867
1965
|
# immediately visible][2] in the *IAM User Guide*.
|
1868
1966
|
#
|
1869
|
-
# The policy size limit is 32
|
1967
|
+
# The policy size limit is 32 kilobytes (32768 bytes).
|
1870
1968
|
#
|
1871
1969
|
#
|
1872
1970
|
#
|
@@ -1932,20 +2030,26 @@ module Aws::KMS
|
|
1932
2030
|
# @return [Hash<String,String>]
|
1933
2031
|
#
|
1934
2032
|
# @!attribute [rw] destination_key_id
|
1935
|
-
# A unique identifier for the CMK
|
1936
|
-
#
|
1937
|
-
#
|
2033
|
+
# A unique identifier for the CMK that is used to reencrypt the data.
|
2034
|
+
#
|
2035
|
+
# To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
|
2036
|
+
# name, or alias ARN. When using an alias name, prefix it with
|
2037
|
+
# "alias/". To specify a CMK in a different AWS account, you must
|
2038
|
+
# use the key ARN or alias ARN.
|
1938
2039
|
#
|
1939
|
-
#
|
1940
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
2040
|
+
# For example:
|
1941
2041
|
#
|
1942
|
-
# *
|
1943
|
-
# arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
|
2042
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1944
2043
|
#
|
1945
|
-
# *
|
1946
|
-
#
|
2044
|
+
# * Key ARN:
|
2045
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2046
|
+
#
|
2047
|
+
# * Alias name: `alias/ExampleAlias`
|
2048
|
+
#
|
2049
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
1947
2050
|
#
|
1948
|
-
#
|
2051
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2052
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
1949
2053
|
# @return [String]
|
1950
2054
|
#
|
1951
2055
|
# @!attribute [rw] destination_encryption_context
|
@@ -1975,7 +2079,8 @@ module Aws::KMS
|
|
1975
2079
|
end
|
1976
2080
|
|
1977
2081
|
# @!attribute [rw] ciphertext_blob
|
1978
|
-
# The reencrypted data.
|
2082
|
+
# The reencrypted data. When you use the HTTP API or the AWS CLI, the
|
2083
|
+
# value is Base64-encoded. Otherwise, it is not encoded.
|
1979
2084
|
# @return [String]
|
1980
2085
|
#
|
1981
2086
|
# @!attribute [rw] source_key_id
|
@@ -2009,12 +2114,10 @@ module Aws::KMS
|
|
2009
2114
|
# @return [String]
|
2010
2115
|
#
|
2011
2116
|
# @!attribute [rw] key_id
|
2012
|
-
# The Amazon Resource Name of the CMK associated with the grant.
|
2013
|
-
# Example:
|
2117
|
+
# The Amazon Resource Name (ARN) of the CMK associated with the grant.
|
2014
2118
|
#
|
2015
|
-
#
|
2016
|
-
#
|
2017
|
-
# ^
|
2119
|
+
# For example:
|
2120
|
+
# `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2018
2121
|
# @return [String]
|
2019
2122
|
#
|
2020
2123
|
# @!attribute [rw] grant_id
|
@@ -2046,14 +2149,20 @@ module Aws::KMS
|
|
2046
2149
|
#
|
2047
2150
|
# @!attribute [rw] key_id
|
2048
2151
|
# A unique identifier for the customer master key associated with the
|
2049
|
-
# grant.
|
2050
|
-
# specified ARN to a key.
|
2152
|
+
# grant.
|
2051
2153
|
#
|
2052
|
-
#
|
2053
|
-
#
|
2154
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
|
2155
|
+
# specify a CMK in a different AWS account, you must use the key ARN.
|
2156
|
+
#
|
2157
|
+
# For example:
|
2158
|
+
#
|
2159
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2160
|
+
#
|
2161
|
+
# * Key ARN:
|
2162
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2054
2163
|
#
|
2055
|
-
#
|
2056
|
-
#
|
2164
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2165
|
+
# DescribeKey.
|
2057
2166
|
# @return [String]
|
2058
2167
|
#
|
2059
2168
|
# @!attribute [rw] grant_id
|
@@ -2077,18 +2186,19 @@ module Aws::KMS
|
|
2077
2186
|
# }
|
2078
2187
|
#
|
2079
2188
|
# @!attribute [rw] key_id
|
2080
|
-
# The unique identifier
|
2189
|
+
# The unique identifier of the customer master key (CMK) to delete.
|
2081
2190
|
#
|
2082
|
-
#
|
2083
|
-
# Name (ARN) of the CMK. Examples:
|
2191
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2084
2192
|
#
|
2085
|
-
#
|
2193
|
+
# For example:
|
2194
|
+
#
|
2195
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2086
2196
|
#
|
2087
2197
|
# * Key ARN:
|
2088
|
-
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
2198
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2089
2199
|
#
|
2090
|
-
# To
|
2091
|
-
#
|
2200
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2201
|
+
# DescribeKey.
|
2092
2202
|
# @return [String]
|
2093
2203
|
#
|
2094
2204
|
# @!attribute [rw] pending_window_in_days
|
@@ -2129,6 +2239,14 @@ module Aws::KMS
|
|
2129
2239
|
# keys and tag values are both required, but tag values can be empty
|
2130
2240
|
# (null) strings.
|
2131
2241
|
#
|
2242
|
+
# For information about the rules that apply to tag keys and tag values,
|
2243
|
+
# see [User-Defined Tag Restrictions][1] in the *AWS Billing and Cost
|
2244
|
+
# Management User Guide*.
|
2245
|
+
#
|
2246
|
+
#
|
2247
|
+
#
|
2248
|
+
# [1]: http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
2249
|
+
#
|
2132
2250
|
# @note When making an API call, you may pass Tag
|
2133
2251
|
# data as a hash:
|
2134
2252
|
#
|
@@ -2167,14 +2285,19 @@ module Aws::KMS
|
|
2167
2285
|
# }
|
2168
2286
|
#
|
2169
2287
|
# @!attribute [rw] key_id
|
2170
|
-
# A unique identifier for the CMK you are tagging.
|
2171
|
-
#
|
2172
|
-
#
|
2288
|
+
# A unique identifier for the CMK you are tagging.
|
2289
|
+
#
|
2290
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2291
|
+
#
|
2292
|
+
# For example:
|
2173
2293
|
#
|
2174
|
-
# *
|
2294
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2175
2295
|
#
|
2176
2296
|
# * Key ARN:
|
2177
2297
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2298
|
+
#
|
2299
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2300
|
+
# DescribeKey.
|
2178
2301
|
# @return [String]
|
2179
2302
|
#
|
2180
2303
|
# @!attribute [rw] tags
|
@@ -2199,13 +2322,18 @@ module Aws::KMS
|
|
2199
2322
|
#
|
2200
2323
|
# @!attribute [rw] key_id
|
2201
2324
|
# A unique identifier for the CMK from which you are removing tags.
|
2202
|
-
# You can use the unique key ID or the Amazon Resource Name (ARN) of
|
2203
|
-
# the CMK. Examples:
|
2204
2325
|
#
|
2205
|
-
#
|
2326
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2327
|
+
#
|
2328
|
+
# For example:
|
2329
|
+
#
|
2330
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2206
2331
|
#
|
2207
2332
|
# * Key ARN:
|
2208
2333
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2334
|
+
#
|
2335
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2336
|
+
# DescribeKey.
|
2209
2337
|
# @return [String]
|
2210
2338
|
#
|
2211
2339
|
# @!attribute [rw] tag_keys
|
@@ -2236,17 +2364,22 @@ module Aws::KMS
|
|
2236
2364
|
#
|
2237
2365
|
# @!attribute [rw] target_key_id
|
2238
2366
|
# Unique identifier of the customer master key to be mapped to the
|
2239
|
-
# alias.
|
2240
|
-
#
|
2367
|
+
# alias.
|
2368
|
+
#
|
2369
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2370
|
+
#
|
2371
|
+
# For example:
|
2241
2372
|
#
|
2242
|
-
# * Key
|
2243
|
-
# arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
|
2373
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2244
2374
|
#
|
2245
|
-
# *
|
2246
|
-
#
|
2375
|
+
# * Key ARN:
|
2376
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2377
|
+
#
|
2378
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2379
|
+
# DescribeKey.
|
2247
2380
|
#
|
2248
|
-
#
|
2249
|
-
#
|
2381
|
+
# To verify that the alias is mapped to the correct CMK, use
|
2382
|
+
# ListAliases.
|
2250
2383
|
# @return [String]
|
2251
2384
|
#
|
2252
2385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest AWS API Documentation
|
@@ -2266,14 +2399,19 @@ module Aws::KMS
|
|
2266
2399
|
# }
|
2267
2400
|
#
|
2268
2401
|
# @!attribute [rw] key_id
|
2269
|
-
# A unique identifier for the
|
2270
|
-
# identifier or the fully specified ARN to a key.
|
2402
|
+
# A unique identifier for the customer master key (CMK).
|
2271
2403
|
#
|
2272
|
-
#
|
2273
|
-
#
|
2404
|
+
# Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
|
2405
|
+
#
|
2406
|
+
# For example:
|
2407
|
+
#
|
2408
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2409
|
+
#
|
2410
|
+
# * Key ARN:
|
2411
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2274
2412
|
#
|
2275
|
-
#
|
2276
|
-
#
|
2413
|
+
# To get the key ID and key ARN for a CMK, use ListKeys or
|
2414
|
+
# DescribeKey.
|
2277
2415
|
# @return [String]
|
2278
2416
|
#
|
2279
2417
|
# @!attribute [rw] description
|