aws-sdk-kms 1.88.0 → 1.145.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +285 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kms/client.rb +2264 -915
- data/lib/aws-sdk-kms/client_api.rb +168 -8
- data/lib/aws-sdk-kms/customizations.rb +0 -8
- data/lib/aws-sdk-kms/endpoint_parameters.rb +13 -10
- data/lib/aws-sdk-kms/endpoint_provider.rb +13 -17
- data/lib/aws-sdk-kms/endpoints.rb +2 -740
- data/lib/aws-sdk-kms/plugins/endpoints.rb +19 -118
- data/lib/aws-sdk-kms/types.rb +1400 -424
- data/lib/aws-sdk-kms.rb +15 -11
- data/sig/client.rbs +116 -35
- data/sig/errors.rbs +48 -48
- data/sig/resource.rbs +6 -0
- data/sig/types.rbs +117 -21
- metadata +6 -9
data/lib/aws-sdk-kms/types.rb
CHANGED
|
@@ -291,7 +291,7 @@ module Aws::KMS
|
|
|
291
291
|
#
|
|
292
292
|
#
|
|
293
293
|
#
|
|
294
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-
|
|
294
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key
|
|
295
295
|
# @return [String]
|
|
296
296
|
#
|
|
297
297
|
# @!attribute [rw] target_key_id
|
|
@@ -301,7 +301,7 @@ module Aws::KMS
|
|
|
301
301
|
# A valid key ID is required. If you supply a null or empty string
|
|
302
302
|
# value, this operation returns an error.
|
|
303
303
|
#
|
|
304
|
-
# For help finding the key ID and ARN, see [
|
|
304
|
+
# For help finding the key ID and ARN, see [Find the key ID and key
|
|
305
305
|
# ARN][2] in the <i> <i>Key Management Service Developer Guide</i>
|
|
306
306
|
# </i>.
|
|
307
307
|
#
|
|
@@ -319,8 +319,8 @@ module Aws::KMS
|
|
|
319
319
|
#
|
|
320
320
|
#
|
|
321
321
|
#
|
|
322
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-
|
|
323
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
322
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key
|
|
323
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/find-cmk-id-arn.html
|
|
324
324
|
# @return [String]
|
|
325
325
|
#
|
|
326
326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest AWS API Documentation
|
|
@@ -387,7 +387,7 @@ module Aws::KMS
|
|
|
387
387
|
#
|
|
388
388
|
#
|
|
389
389
|
#
|
|
390
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
390
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html#concept-kmsuser
|
|
391
391
|
# @return [String]
|
|
392
392
|
#
|
|
393
393
|
# @!attribute [rw] custom_key_store_type
|
|
@@ -485,6 +485,14 @@ module Aws::KMS
|
|
|
485
485
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements
|
|
486
486
|
# @return [String]
|
|
487
487
|
#
|
|
488
|
+
# @!attribute [rw] xks_proxy_vpc_endpoint_service_owner
|
|
489
|
+
# Specifies the Amazon Web Services account ID that owns the Amazon
|
|
490
|
+
# VPC service endpoint for the interface that is used to communicate
|
|
491
|
+
# with your external key store proxy (XKS proxy). This parameter is
|
|
492
|
+
# optional. If not provided, the Amazon Web Services account ID
|
|
493
|
+
# calling the action will be used.
|
|
494
|
+
# @return [String]
|
|
495
|
+
#
|
|
488
496
|
# @!attribute [rw] xks_proxy_authentication_credential
|
|
489
497
|
# Specifies an authentication credential for the external key store
|
|
490
498
|
# proxy (XKS proxy). This parameter is required for all custom key
|
|
@@ -494,7 +502,7 @@ module Aws::KMS
|
|
|
494
502
|
# `RawSecretAccessKey`, a secret key, and `AccessKeyId`, a unique
|
|
495
503
|
# identifier for the `RawSecretAccessKey`. For character requirements,
|
|
496
504
|
# see
|
|
497
|
-
# [XksProxyAuthenticationCredentialType](
|
|
505
|
+
# [XksProxyAuthenticationCredentialType](API_XksProxyAuthenticationCredentialType.html).
|
|
498
506
|
#
|
|
499
507
|
# KMS uses this authentication credential to sign requests to the
|
|
500
508
|
# external key store proxy on your behalf. This credential is
|
|
@@ -535,7 +543,7 @@ module Aws::KMS
|
|
|
535
543
|
#
|
|
536
544
|
#
|
|
537
545
|
#
|
|
538
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
546
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/choose-xks-connectivity.html
|
|
539
547
|
# @return [String]
|
|
540
548
|
#
|
|
541
549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStoreRequest AWS API Documentation
|
|
@@ -549,6 +557,7 @@ module Aws::KMS
|
|
|
549
557
|
:xks_proxy_uri_endpoint,
|
|
550
558
|
:xks_proxy_uri_path,
|
|
551
559
|
:xks_proxy_vpc_endpoint_service_name,
|
|
560
|
+
:xks_proxy_vpc_endpoint_service_owner,
|
|
552
561
|
:xks_proxy_authentication_credential,
|
|
553
562
|
:xks_proxy_connectivity)
|
|
554
563
|
SENSITIVE = [:key_store_password]
|
|
@@ -596,6 +605,9 @@ module Aws::KMS
|
|
|
596
605
|
# see [IAM ARNs][1] in the <i> <i>Identity and Access Management User
|
|
597
606
|
# Guide</i> </i>.
|
|
598
607
|
#
|
|
608
|
+
# You must specify either `GranteePrincipal` or
|
|
609
|
+
# `GranteeServicePrincipal`, but not both.
|
|
610
|
+
#
|
|
599
611
|
#
|
|
600
612
|
#
|
|
601
613
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
|
|
@@ -617,11 +629,14 @@ module Aws::KMS
|
|
|
617
629
|
# details, see RevokeGrant and [Retiring and revoking grants][3] in
|
|
618
630
|
# the *Key Management Service Developer Guide*.
|
|
619
631
|
#
|
|
632
|
+
# You can specify either `RetiringPrincipal` or
|
|
633
|
+
# `RetiringServicePrincipal`, but not both.
|
|
634
|
+
#
|
|
620
635
|
#
|
|
621
636
|
#
|
|
622
637
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
623
638
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
|
|
624
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-
|
|
639
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-delete.html
|
|
625
640
|
# @return [String]
|
|
626
641
|
#
|
|
627
642
|
# @!attribute [rw] operations
|
|
@@ -647,40 +662,55 @@ module Aws::KMS
|
|
|
647
662
|
# This field may be displayed in plaintext in CloudTrail logs and
|
|
648
663
|
# other output.
|
|
649
664
|
#
|
|
650
|
-
# KMS supports the
|
|
651
|
-
#
|
|
652
|
-
#
|
|
653
|
-
#
|
|
654
|
-
#
|
|
655
|
-
#
|
|
656
|
-
#
|
|
657
|
-
#
|
|
658
|
-
#
|
|
659
|
-
#
|
|
660
|
-
#
|
|
661
|
-
#
|
|
662
|
-
#
|
|
663
|
-
#
|
|
664
|
-
#
|
|
665
|
-
#
|
|
666
|
-
#
|
|
667
|
-
#
|
|
668
|
-
#
|
|
669
|
-
#
|
|
670
|
-
#
|
|
671
|
-
#
|
|
672
|
-
#
|
|
673
|
-
#
|
|
674
|
-
#
|
|
675
|
-
#
|
|
676
|
-
#
|
|
677
|
-
#
|
|
665
|
+
# KMS supports the following grant constraints.
|
|
666
|
+
#
|
|
667
|
+
# * `EncryptionContextEquals` and `EncryptionContextSubset` — These
|
|
668
|
+
# encryption context grant constraints allow the permissions in the
|
|
669
|
+
# grant only when the encryption context in the request matches
|
|
670
|
+
# (`EncryptionContextEquals`) or includes
|
|
671
|
+
# (`EncryptionContextSubset`) the encryption context specified in
|
|
672
|
+
# the constraint.
|
|
673
|
+
#
|
|
674
|
+
# Encryption context grant constraints are supported only on [grant
|
|
675
|
+
# operations][1] that include an `EncryptionContext` parameter, such
|
|
676
|
+
# as cryptographic operations on symmetric encryption KMS keys. You
|
|
677
|
+
# cannot use an encryption context grant constraint for
|
|
678
|
+
# cryptographic operations with asymmetric KMS keys or HMAC KMS
|
|
679
|
+
# keys. Operations with these keys don't support an encryption
|
|
680
|
+
# context. Grants with encryption context grant constraints can
|
|
681
|
+
# include the DescribeKey and RetireGrant operations, but the
|
|
682
|
+
# constraint doesn't apply to these operations. If a grant with an
|
|
683
|
+
# encryption context grant constraint includes the `CreateGrant`
|
|
684
|
+
# operation, the constraint requires that any grants created with
|
|
685
|
+
# the `CreateGrant` permission have an equally strict or stricter
|
|
686
|
+
# encryption context constraint.
|
|
687
|
+
#
|
|
688
|
+
# Each constraint value can include up to 8 encryption context
|
|
689
|
+
# pairs. The encryption context value in each constraint cannot
|
|
690
|
+
# exceed 384 characters. For more information about encryption
|
|
691
|
+
# context, see [Encryption context][2] in the <i> <i>Key Management
|
|
692
|
+
# Service Developer Guide</i> </i>.
|
|
693
|
+
#
|
|
694
|
+
# * `SourceArn` — This grant constraint allows the permissions in the
|
|
695
|
+
# grant only when the request is made on behalf of a specific Amazon
|
|
696
|
+
# Web Services resource, identified by its [Amazon Resource Name
|
|
697
|
+
# (ARN)][3]. This is effectively the same as having the
|
|
698
|
+
# [aws:SourceArn][4] global condition key in the grant. The
|
|
699
|
+
# SourceArn constraint is supported on grants for all types of KMS
|
|
700
|
+
# keys and can also be applied to the DescribeKey operation when
|
|
701
|
+
# specified in the request. However, it does not apply to
|
|
702
|
+
# RetireGrant operation.
|
|
703
|
+
#
|
|
704
|
+
# For information about grant constraints, see [Using grant
|
|
705
|
+
# constraints][5] in the *Key Management Service Developer Guide*.
|
|
678
706
|
#
|
|
679
707
|
#
|
|
680
708
|
#
|
|
681
709
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
|
|
682
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
683
|
-
# [3]: https://docs.aws.amazon.com/
|
|
710
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
|
|
711
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
712
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn
|
|
713
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints
|
|
684
714
|
# @return [Types::GrantConstraints]
|
|
685
715
|
#
|
|
686
716
|
# @!attribute [rw] grant_tokens
|
|
@@ -694,7 +724,7 @@ module Aws::KMS
|
|
|
694
724
|
#
|
|
695
725
|
#
|
|
696
726
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
697
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
727
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
698
728
|
# @return [Array<String>]
|
|
699
729
|
#
|
|
700
730
|
# @!attribute [rw] name
|
|
@@ -722,14 +752,42 @@ module Aws::KMS
|
|
|
722
752
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
723
753
|
# parameter.
|
|
724
754
|
#
|
|
725
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
726
|
-
#
|
|
755
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
756
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
727
757
|
#
|
|
728
758
|
#
|
|
729
759
|
#
|
|
730
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
760
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
731
761
|
# @return [Boolean]
|
|
732
762
|
#
|
|
763
|
+
# @!attribute [rw] grantee_service_principal
|
|
764
|
+
# The Amazon Web Services [service principal][1] that gets the
|
|
765
|
+
# permissions specified in the grant.
|
|
766
|
+
#
|
|
767
|
+
# When you specify a `GranteeServicePrincipal`, you must also specify
|
|
768
|
+
# a `SourceArn` grant constraint. In addition, you must specify either
|
|
769
|
+
# a `RetiringPrincipal` or a `RetiringServicePrincipal`.
|
|
770
|
+
#
|
|
771
|
+
# You must specify either `GranteePrincipal` or
|
|
772
|
+
# `GranteeServicePrincipal`, but not both.
|
|
773
|
+
#
|
|
774
|
+
#
|
|
775
|
+
#
|
|
776
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
|
|
777
|
+
# @return [String]
|
|
778
|
+
#
|
|
779
|
+
# @!attribute [rw] retiring_service_principal
|
|
780
|
+
# The Amazon Web Services [service principal][1] that has permission
|
|
781
|
+
# to use the RetireGrant operation to retire the grant.
|
|
782
|
+
#
|
|
783
|
+
# You can specify either `RetiringPrincipal` or
|
|
784
|
+
# `RetiringServicePrincipal`, but not both.
|
|
785
|
+
#
|
|
786
|
+
#
|
|
787
|
+
#
|
|
788
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
|
|
789
|
+
# @return [String]
|
|
790
|
+
#
|
|
733
791
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantRequest AWS API Documentation
|
|
734
792
|
#
|
|
735
793
|
class CreateGrantRequest < Struct.new(
|
|
@@ -740,7 +798,9 @@ module Aws::KMS
|
|
|
740
798
|
:constraints,
|
|
741
799
|
:grant_tokens,
|
|
742
800
|
:name,
|
|
743
|
-
:dry_run
|
|
801
|
+
:dry_run,
|
|
802
|
+
:grantee_service_principal,
|
|
803
|
+
:retiring_service_principal)
|
|
744
804
|
SENSITIVE = []
|
|
745
805
|
include Aws::Structure
|
|
746
806
|
end
|
|
@@ -756,7 +816,7 @@ module Aws::KMS
|
|
|
756
816
|
#
|
|
757
817
|
#
|
|
758
818
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
759
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
819
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
760
820
|
# @return [String]
|
|
761
821
|
#
|
|
762
822
|
# @!attribute [rw] grant_id
|
|
@@ -796,22 +856,38 @@ module Aws::KMS
|
|
|
796
856
|
# that I make are not always immediately visible][2] in the *Amazon
|
|
797
857
|
# Web Services Identity and Access Management User Guide*.
|
|
798
858
|
#
|
|
859
|
+
# <note markdown="1"> If either of the required `Resource` or `Action` elements are
|
|
860
|
+
# missing from a key policy statement, the policy statement has no
|
|
861
|
+
# effect. When a key policy statement is missing one of these
|
|
862
|
+
# elements, the KMS console correctly reports an error, but the
|
|
863
|
+
# `CreateKey` and `PutKeyPolicy` API requests succeed, even though the
|
|
864
|
+
# policy statement is ineffective.
|
|
865
|
+
#
|
|
866
|
+
# For more information on required key policy elements, see [Elements
|
|
867
|
+
# in a key policy][3] in the *Key Management Service Developer Guide*.
|
|
868
|
+
#
|
|
869
|
+
# </note>
|
|
870
|
+
#
|
|
799
871
|
# If you do not provide a key policy, KMS attaches a default key
|
|
800
872
|
# policy to the KMS key. For more information, see [Default key
|
|
801
|
-
# policy][
|
|
873
|
+
# policy][4] in the *Key Management Service Developer Guide*.
|
|
802
874
|
#
|
|
803
|
-
#
|
|
875
|
+
# <note markdown="1"> If the key policy exceeds the length constraint, KMS returns a
|
|
876
|
+
# `LimitExceededException`.
|
|
877
|
+
#
|
|
878
|
+
# </note>
|
|
804
879
|
#
|
|
805
880
|
# For help writing and formatting a JSON policy document, see the [IAM
|
|
806
|
-
# JSON Policy Reference][
|
|
881
|
+
# JSON Policy Reference][5] in the <i> <i>Identity and Access
|
|
807
882
|
# Management User Guide</i> </i>.
|
|
808
883
|
#
|
|
809
884
|
#
|
|
810
885
|
#
|
|
811
886
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
|
812
887
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
|
|
813
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-
|
|
814
|
-
# [4]: https://docs.aws.amazon.com/
|
|
888
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-overview.html#key-policy-elements
|
|
889
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html
|
|
890
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
|
|
815
891
|
# @return [String]
|
|
816
892
|
#
|
|
817
893
|
# @!attribute [rw] description
|
|
@@ -831,8 +907,11 @@ module Aws::KMS
|
|
|
831
907
|
# Determines the [cryptographic operations][1] for which you can use
|
|
832
908
|
# the KMS key. The default value is `ENCRYPT_DECRYPT`. This parameter
|
|
833
909
|
# is optional when you are creating a symmetric encryption KMS key;
|
|
834
|
-
# otherwise, it is required. You can't change the `KeyUsage`
|
|
835
|
-
# after the KMS key is created.
|
|
910
|
+
# otherwise, it is required. You can't change the [ `KeyUsage` ][2]
|
|
911
|
+
# value after the KMS key is created. Each KMS key can have only one
|
|
912
|
+
# key usage. This follows key usage best practices according to [NIST
|
|
913
|
+
# SP 800-57 Recommendations for Key Management][3], section 5.2, Key
|
|
914
|
+
# usage.
|
|
836
915
|
#
|
|
837
916
|
# Select only one valid value.
|
|
838
917
|
#
|
|
@@ -844,18 +923,26 @@ module Aws::KMS
|
|
|
844
923
|
# * For asymmetric KMS keys with RSA key pairs, specify
|
|
845
924
|
# `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
|
|
846
925
|
#
|
|
847
|
-
# * For asymmetric KMS keys with NIST-
|
|
926
|
+
# * For asymmetric KMS keys with NIST-standard elliptic curve key
|
|
848
927
|
# pairs, specify `SIGN_VERIFY` or `KEY_AGREEMENT`.
|
|
849
928
|
#
|
|
850
|
-
# * For asymmetric KMS keys with `ECC_SECG_P256K1` key pairs specify
|
|
929
|
+
# * For asymmetric KMS keys with `ECC_SECG_P256K1` key pairs, specify
|
|
851
930
|
# `SIGN_VERIFY`.
|
|
852
931
|
#
|
|
932
|
+
# * For asymmetric KMS keys with ML-DSA key pairs, specify
|
|
933
|
+
# `SIGN_VERIFY`.
|
|
934
|
+
#
|
|
935
|
+
# * For asymmetric KMS keys with ML-KEM key pairs, specify
|
|
936
|
+
# `ENCAPSULATE_DECAPSULATE`.
|
|
937
|
+
#
|
|
853
938
|
# * For asymmetric KMS keys with SM2 key pairs (China Regions only),
|
|
854
939
|
# specify `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `KEY_AGREEMENT`.
|
|
855
940
|
#
|
|
856
941
|
#
|
|
857
942
|
#
|
|
858
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
943
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
944
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#key-usage
|
|
945
|
+
# [3]: https://csrc.nist.gov/pubs/sp/800/57/pt1/r5/final
|
|
859
946
|
# @return [String]
|
|
860
947
|
#
|
|
861
948
|
# @!attribute [rw] customer_master_key_spec
|
|
@@ -872,8 +959,8 @@ module Aws::KMS
|
|
|
872
959
|
# `SYMMETRIC_DEFAULT`, creates a KMS key with a 256-bit AES-GCM key
|
|
873
960
|
# that is used for encryption and decryption, except in China Regions,
|
|
874
961
|
# where it creates a 128-bit symmetric key that uses SM4 encryption.
|
|
875
|
-
# For
|
|
876
|
-
#
|
|
962
|
+
# For a detailed description of all supported key specs, see [Key spec
|
|
963
|
+
# reference][1] in the <i> <i>Key Management Service Developer
|
|
877
964
|
# Guide</i> </i>.
|
|
878
965
|
#
|
|
879
966
|
# The `KeySpec` determines whether the KMS key contains a symmetric
|
|
@@ -882,10 +969,11 @@ module Aws::KMS
|
|
|
882
969
|
# KMS key is created. To further restrict the algorithms that can be
|
|
883
970
|
# used with the KMS key, use a condition key in its key policy or IAM
|
|
884
971
|
# policy. For more information, see [kms:EncryptionAlgorithm][2],
|
|
885
|
-
# [kms:MacAlgorithm][3]
|
|
886
|
-
# <i>Key Management Service
|
|
972
|
+
# [kms:MacAlgorithm][3], [kms:KeyAgreementAlgorithm][4], or
|
|
973
|
+
# [kms:SigningAlgorithm][5] in the <i> <i>Key Management Service
|
|
974
|
+
# Developer Guide</i> </i>.
|
|
887
975
|
#
|
|
888
|
-
# [Amazon Web Services services that are integrated with KMS][
|
|
976
|
+
# [Amazon Web Services services that are integrated with KMS][6] use
|
|
889
977
|
# symmetric encryption KMS keys to protect your data. These services
|
|
890
978
|
# do not support asymmetric KMS keys or HMAC KMS keys.
|
|
891
979
|
#
|
|
@@ -896,7 +984,6 @@ module Aws::KMS
|
|
|
896
984
|
# * `SYMMETRIC_DEFAULT`
|
|
897
985
|
#
|
|
898
986
|
# ^
|
|
899
|
-
#
|
|
900
987
|
# * HMAC keys (symmetric)
|
|
901
988
|
#
|
|
902
989
|
# * `HMAC_224`
|
|
@@ -906,7 +993,6 @@ module Aws::KMS
|
|
|
906
993
|
# * `HMAC_384`
|
|
907
994
|
#
|
|
908
995
|
# * `HMAC_512`
|
|
909
|
-
#
|
|
910
996
|
# * Asymmetric RSA key pairs (encryption and decryption -or- signing
|
|
911
997
|
# and verification)
|
|
912
998
|
#
|
|
@@ -915,8 +1001,7 @@ module Aws::KMS
|
|
|
915
1001
|
# * `RSA_3072`
|
|
916
1002
|
#
|
|
917
1003
|
# * `RSA_4096`
|
|
918
|
-
#
|
|
919
|
-
# * Asymmetric NIST-recommended elliptic curve key pairs (signing and
|
|
1004
|
+
# * Asymmetric NIST-standard elliptic curve key pairs (signing and
|
|
920
1005
|
# verification -or- deriving shared secrets)
|
|
921
1006
|
#
|
|
922
1007
|
# * `ECC_NIST_P256` (secp256r1)
|
|
@@ -925,6 +1010,18 @@ module Aws::KMS
|
|
|
925
1010
|
#
|
|
926
1011
|
# * `ECC_NIST_P521` (secp521r1)
|
|
927
1012
|
#
|
|
1013
|
+
# * `ECC_NIST_EDWARDS25519` (ed25519) - signing and verification
|
|
1014
|
+
# only
|
|
1015
|
+
#
|
|
1016
|
+
# * **Note:** For ECC\_NIST\_EDWARDS25519 KMS keys, the
|
|
1017
|
+
# ED25519\_SHA\_512 signing algorithm requires [
|
|
1018
|
+
# `MessageType:RAW`
|
|
1019
|
+
# ](kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType),
|
|
1020
|
+
# while ED25519\_PH\_SHA\_512 requires [ `MessageType:DIGEST`
|
|
1021
|
+
# ](kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType).
|
|
1022
|
+
# These message types cannot be used interchangeably.
|
|
1023
|
+
#
|
|
1024
|
+
# ^
|
|
928
1025
|
# * Other asymmetric elliptic curve key pairs (signing and
|
|
929
1026
|
# verification)
|
|
930
1027
|
#
|
|
@@ -932,6 +1029,21 @@ module Aws::KMS
|
|
|
932
1029
|
# cryptocurrencies.
|
|
933
1030
|
#
|
|
934
1031
|
# ^
|
|
1032
|
+
# * Asymmetric ML-DSA key pairs (signing and verification)
|
|
1033
|
+
#
|
|
1034
|
+
# * `ML_DSA_44`
|
|
1035
|
+
#
|
|
1036
|
+
# * `ML_DSA_65`
|
|
1037
|
+
#
|
|
1038
|
+
# * `ML_DSA_87`
|
|
1039
|
+
# * Asymmetric ML-KEM key pairs (establishing shared secrets)
|
|
1040
|
+
#
|
|
1041
|
+
# * `ML_KEM_512`
|
|
1042
|
+
#
|
|
1043
|
+
# * `ML_KEM_768`
|
|
1044
|
+
#
|
|
1045
|
+
# * `ML_KEM_1024`
|
|
1046
|
+
# The ML-KEM key specs are not available in China Regions.
|
|
935
1047
|
#
|
|
936
1048
|
# * SM2 key pairs (encryption and decryption -or- signing and
|
|
937
1049
|
# verification -or- deriving shared secrets)
|
|
@@ -942,11 +1054,12 @@ module Aws::KMS
|
|
|
942
1054
|
#
|
|
943
1055
|
#
|
|
944
1056
|
#
|
|
945
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
946
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
947
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
948
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
949
|
-
# [5]:
|
|
1057
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose-key-spec.html
|
|
1058
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-encryption-algorithm
|
|
1059
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-mac-algorithm
|
|
1060
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-key-agreement-algorithm
|
|
1061
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-signing-algorithm
|
|
1062
|
+
# [6]: http://aws.amazon.com/kms/features/#AWS_Service_Integration
|
|
950
1063
|
# @return [String]
|
|
951
1064
|
#
|
|
952
1065
|
# @!attribute [rw] origin
|
|
@@ -999,7 +1112,7 @@ module Aws::KMS
|
|
|
999
1112
|
#
|
|
1000
1113
|
#
|
|
1001
1114
|
#
|
|
1002
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1115
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
1003
1116
|
# @return [String]
|
|
1004
1117
|
#
|
|
1005
1118
|
# @!attribute [rw] bypass_policy_lockout_safety_check
|
|
@@ -1050,7 +1163,7 @@ module Aws::KMS
|
|
|
1050
1163
|
# When you add tags to an Amazon Web Services resource, Amazon Web
|
|
1051
1164
|
# Services generates a cost allocation report with usage and costs
|
|
1052
1165
|
# aggregated by tags. Tags can also be used to control access to a KMS
|
|
1053
|
-
# key. For details, see [
|
|
1166
|
+
# key. For details, see [Tags in KMS][3].
|
|
1054
1167
|
#
|
|
1055
1168
|
#
|
|
1056
1169
|
#
|
|
@@ -1123,7 +1236,7 @@ module Aws::KMS
|
|
|
1123
1236
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
|
|
1124
1237
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
|
|
1125
1238
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy
|
|
1126
|
-
# [4]: https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements
|
|
1239
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html#xks-key-requirements
|
|
1127
1240
|
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption
|
|
1128
1241
|
# @return [String]
|
|
1129
1242
|
#
|
|
@@ -1195,9 +1308,11 @@ module Aws::KMS
|
|
|
1195
1308
|
# This operation is valid for all other `ConnectionState` values.
|
|
1196
1309
|
#
|
|
1197
1310
|
# * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore
|
|
1198
|
-
# operation on a custom key store that is not disconnected.
|
|
1199
|
-
#
|
|
1200
|
-
#
|
|
1311
|
+
# operation on a custom key store that is not disconnected.
|
|
1312
|
+
# `UpdateCustomKeyStore` can be called on a custom key store in the
|
|
1313
|
+
# `CONNECTED` state only to update `NewCustomKeyStoreName`. For all
|
|
1314
|
+
# other properties, the custom key store `ConnectionState` must be
|
|
1315
|
+
# `DISCONNECTED`.
|
|
1201
1316
|
#
|
|
1202
1317
|
# * You requested the GenerateRandom operation in an CloudHSM key store
|
|
1203
1318
|
# that is not connected. This operation is valid only when the
|
|
@@ -1452,7 +1567,6 @@ module Aws::KMS
|
|
|
1452
1567
|
#
|
|
1453
1568
|
# * The [TLS certificate][6] specifies the private DNS hostname at
|
|
1454
1569
|
# which the endpoint is reachable.
|
|
1455
|
-
#
|
|
1456
1570
|
# * `XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND` — KMS can't find the VPC
|
|
1457
1571
|
# endpoint service that it uses to communicate with the external key
|
|
1458
1572
|
# store proxy. Verify that the `XksProxyVpcEndpointServiceName` is
|
|
@@ -1507,8 +1621,114 @@ module Aws::KMS
|
|
|
1507
1621
|
include Aws::Structure
|
|
1508
1622
|
end
|
|
1509
1623
|
|
|
1624
|
+
# @!attribute [rw] key_id
|
|
1625
|
+
# Identifies the asymmetric ML-KEM KMS key whose public key was used
|
|
1626
|
+
# to produce the encapsulated shared secret. KMS uses the private key
|
|
1627
|
+
# in the specified key pair to decapsulate the shared secret.
|
|
1628
|
+
#
|
|
1629
|
+
# To specify a KMS key, use its key ID, key ARN, alias name, or alias
|
|
1630
|
+
# ARN. When using an alias name, prefix it with `"alias/"`. To specify
|
|
1631
|
+
# a KMS key in a different Amazon Web Services account, you must use
|
|
1632
|
+
# the key ARN or alias ARN.
|
|
1633
|
+
#
|
|
1634
|
+
# For example:
|
|
1635
|
+
#
|
|
1636
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
1637
|
+
#
|
|
1638
|
+
# * Key ARN:
|
|
1639
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
1640
|
+
#
|
|
1641
|
+
# * Alias name: `alias/ExampleAlias`
|
|
1642
|
+
#
|
|
1643
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
|
1644
|
+
#
|
|
1645
|
+
# To get the key ID and key ARN for a KMS key, use ListKeys or
|
|
1646
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
1647
|
+
# @return [String]
|
|
1648
|
+
#
|
|
1649
|
+
# @!attribute [rw] shared_secret_ciphertext_blob
|
|
1650
|
+
# The encapsulated (ciphertext) form of the shared secret to recover.
|
|
1651
|
+
# This is the `SharedSecretCiphertextBlob` value that the Encapsulate
|
|
1652
|
+
# operation returns. When you use the HTTP API or the Amazon Web
|
|
1653
|
+
# Services CLI, the value is Base64-encoded. Otherwise, it is not
|
|
1654
|
+
# Base64-encoded.
|
|
1655
|
+
# @return [String]
|
|
1656
|
+
#
|
|
1657
|
+
# @!attribute [rw] encapsulation_algorithm
|
|
1658
|
+
# Specifies the key encapsulation algorithm used to recover the shared
|
|
1659
|
+
# secret. The only valid value is `ML_KEM`.
|
|
1660
|
+
# @return [String]
|
|
1661
|
+
#
|
|
1662
|
+
# @!attribute [rw] grant_tokens
|
|
1663
|
+
# A list of grant tokens.
|
|
1664
|
+
#
|
|
1665
|
+
# Use a grant token when your permission to call this operation comes
|
|
1666
|
+
# from a new grant that has not yet achieved *eventual consistency*.
|
|
1667
|
+
# For more information, see [Grant token][1] and [Using a grant
|
|
1668
|
+
# token][2] in the *Key Management Service Developer Guide*.
|
|
1669
|
+
#
|
|
1670
|
+
#
|
|
1671
|
+
#
|
|
1672
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
1673
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
1674
|
+
# @return [Array<String>]
|
|
1675
|
+
#
|
|
1676
|
+
# @!attribute [rw] dry_run
|
|
1677
|
+
# Checks if your request will succeed. `DryRun` is an optional
|
|
1678
|
+
# parameter.
|
|
1679
|
+
#
|
|
1680
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
1681
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
1682
|
+
#
|
|
1683
|
+
#
|
|
1684
|
+
#
|
|
1685
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
1686
|
+
# @return [Boolean]
|
|
1687
|
+
#
|
|
1688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecapsulateRequest AWS API Documentation
|
|
1689
|
+
#
|
|
1690
|
+
class DecapsulateRequest < Struct.new(
|
|
1691
|
+
:key_id,
|
|
1692
|
+
:shared_secret_ciphertext_blob,
|
|
1693
|
+
:encapsulation_algorithm,
|
|
1694
|
+
:grant_tokens,
|
|
1695
|
+
:dry_run)
|
|
1696
|
+
SENSITIVE = []
|
|
1697
|
+
include Aws::Structure
|
|
1698
|
+
end
|
|
1699
|
+
|
|
1700
|
+
# @!attribute [rw] key_id
|
|
1701
|
+
# The identifier of the ML-KEM KMS key used to decapsulate the shared
|
|
1702
|
+
# secret.
|
|
1703
|
+
# @return [String]
|
|
1704
|
+
#
|
|
1705
|
+
# @!attribute [rw] shared_secret
|
|
1706
|
+
# The plaintext shared secret recovered from the encapsulated form. It
|
|
1707
|
+
# is a 32-byte value that matches the shared secret held by the
|
|
1708
|
+
# encapsulating party. When you use the HTTP API or the Amazon Web
|
|
1709
|
+
# Services CLI, the value is Base64-encoded. Otherwise, it is not
|
|
1710
|
+
# Base64-encoded.
|
|
1711
|
+
# @return [String]
|
|
1712
|
+
#
|
|
1713
|
+
# @!attribute [rw] encapsulation_algorithm
|
|
1714
|
+
# The key encapsulation algorithm used to recover the shared secret.
|
|
1715
|
+
# @return [String]
|
|
1716
|
+
#
|
|
1717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecapsulateResponse AWS API Documentation
|
|
1718
|
+
#
|
|
1719
|
+
class DecapsulateResponse < Struct.new(
|
|
1720
|
+
:key_id,
|
|
1721
|
+
:shared_secret,
|
|
1722
|
+
:encapsulation_algorithm)
|
|
1723
|
+
SENSITIVE = [:shared_secret]
|
|
1724
|
+
include Aws::Structure
|
|
1725
|
+
end
|
|
1726
|
+
|
|
1510
1727
|
# @!attribute [rw] ciphertext_blob
|
|
1511
1728
|
# Ciphertext to be decrypted. The blob includes metadata.
|
|
1729
|
+
#
|
|
1730
|
+
# This parameter is required in all cases except when `DryRun` is
|
|
1731
|
+
# `true` and `DryRunModifiers` is set to `IGNORE_CIPHERTEXT`.
|
|
1512
1732
|
# @return [String]
|
|
1513
1733
|
#
|
|
1514
1734
|
# @!attribute [rw] encryption_context
|
|
@@ -1532,8 +1752,8 @@ module Aws::KMS
|
|
|
1532
1752
|
#
|
|
1533
1753
|
#
|
|
1534
1754
|
#
|
|
1535
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1536
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1755
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
1756
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
1537
1757
|
# @return [Hash<String,String>]
|
|
1538
1758
|
#
|
|
1539
1759
|
# @!attribute [rw] grant_tokens
|
|
@@ -1547,7 +1767,7 @@ module Aws::KMS
|
|
|
1547
1767
|
#
|
|
1548
1768
|
#
|
|
1549
1769
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
1550
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1770
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
1551
1771
|
# @return [Array<String>]
|
|
1552
1772
|
#
|
|
1553
1773
|
# @!attribute [rw] key_id
|
|
@@ -1558,15 +1778,16 @@ module Aws::KMS
|
|
|
1558
1778
|
# operation throws an `IncorrectKeyException`.
|
|
1559
1779
|
#
|
|
1560
1780
|
# This parameter is required only when the ciphertext was encrypted
|
|
1561
|
-
# under an asymmetric KMS key
|
|
1562
|
-
#
|
|
1563
|
-
# symmetric
|
|
1564
|
-
#
|
|
1565
|
-
# you
|
|
1781
|
+
# under an asymmetric KMS key or when `DryRun` is `true` and
|
|
1782
|
+
# `DryRunModifiers` is set to `IGNORE_CIPHERTEXT`. If you used a
|
|
1783
|
+
# symmetric encryption KMS key, KMS can get the KMS key from metadata
|
|
1784
|
+
# that it adds to the symmetric ciphertext blob. However, it is always
|
|
1785
|
+
# recommended as a best practice. This practice ensures that you use
|
|
1786
|
+
# the KMS key that you intend.
|
|
1566
1787
|
#
|
|
1567
1788
|
# To specify a KMS key, use its key ID, key ARN, alias name, or alias
|
|
1568
1789
|
# ARN. When using an alias name, prefix it with `"alias/"`. To specify
|
|
1569
|
-
# a KMS key in a different Amazon Web Services account, you
|
|
1790
|
+
# a KMS key in a different Amazon Web Services account, you should use
|
|
1570
1791
|
# the key ARN or alias ARN.
|
|
1571
1792
|
#
|
|
1572
1793
|
# For example:
|
|
@@ -1598,44 +1819,63 @@ module Aws::KMS
|
|
|
1598
1819
|
#
|
|
1599
1820
|
# @!attribute [rw] recipient
|
|
1600
1821
|
# A signed [attestation document][1] from an Amazon Web Services Nitro
|
|
1601
|
-
# enclave and the encryption algorithm to use with the
|
|
1602
|
-
# public key. The only valid encryption
|
|
1603
|
-
# `RSAES_OAEP_SHA_256`.
|
|
1822
|
+
# enclave or NitroTPM, and the encryption algorithm to use with the
|
|
1823
|
+
# public key in the attestation document. The only valid encryption
|
|
1824
|
+
# algorithm is `RSAES_OAEP_SHA_256`.
|
|
1604
1825
|
#
|
|
1605
|
-
# This parameter
|
|
1606
|
-
#
|
|
1607
|
-
#
|
|
1826
|
+
# This parameter supports the [Amazon Web Services Nitro Enclaves
|
|
1827
|
+
# SDK][2] or any Amazon Web Services SDK for Amazon Web Services Nitro
|
|
1828
|
+
# Enclaves. It supports any Amazon Web Services SDK for Amazon Web
|
|
1829
|
+
# Services NitroTPM.
|
|
1608
1830
|
#
|
|
1609
1831
|
# When you use this parameter, instead of returning the plaintext
|
|
1610
1832
|
# data, KMS encrypts the plaintext data with the public key in the
|
|
1611
1833
|
# attestation document, and returns the resulting ciphertext in the
|
|
1612
1834
|
# `CiphertextForRecipient` field in the response. This ciphertext can
|
|
1613
|
-
# be decrypted only with the private key in the
|
|
1614
|
-
# `Plaintext` field in the response is null or empty.
|
|
1835
|
+
# be decrypted only with the private key in the attested environment.
|
|
1836
|
+
# The `Plaintext` field in the response is null or empty.
|
|
1615
1837
|
#
|
|
1616
1838
|
# For information about the interaction between KMS and Amazon Web
|
|
1617
|
-
# Services Nitro Enclaves
|
|
1618
|
-
#
|
|
1839
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM, see
|
|
1840
|
+
# [Cryptographic attestation support in KMS][3] in the *Key Management
|
|
1841
|
+
# Service Developer Guide*.
|
|
1619
1842
|
#
|
|
1620
1843
|
#
|
|
1621
1844
|
#
|
|
1622
1845
|
# [1]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc
|
|
1623
1846
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
|
1624
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1847
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
1625
1848
|
# @return [Types::RecipientInfo]
|
|
1626
1849
|
#
|
|
1627
1850
|
# @!attribute [rw] dry_run
|
|
1628
1851
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
1629
1852
|
# parameter.
|
|
1630
1853
|
#
|
|
1631
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
1632
|
-
#
|
|
1854
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
1855
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
1633
1856
|
#
|
|
1634
1857
|
#
|
|
1635
1858
|
#
|
|
1636
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1859
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
1637
1860
|
# @return [Boolean]
|
|
1638
1861
|
#
|
|
1862
|
+
# @!attribute [rw] dry_run_modifiers
|
|
1863
|
+
# Specifies the modifiers to apply to the dry run operation.
|
|
1864
|
+
# `DryRunModifiers` is an optional parameter that only applies when
|
|
1865
|
+
# `DryRun` is set to `true`.
|
|
1866
|
+
#
|
|
1867
|
+
# When set to `IGNORE_CIPHERTEXT`, KMS performs only authorization
|
|
1868
|
+
# validation without ciphertext validation. This allows you to test
|
|
1869
|
+
# permissions without requiring a valid ciphertext blob.
|
|
1870
|
+
#
|
|
1871
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
1872
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
1873
|
+
#
|
|
1874
|
+
#
|
|
1875
|
+
#
|
|
1876
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
1877
|
+
# @return [Array<String>]
|
|
1878
|
+
#
|
|
1639
1879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest AWS API Documentation
|
|
1640
1880
|
#
|
|
1641
1881
|
class DecryptRequest < Struct.new(
|
|
@@ -1645,7 +1885,8 @@ module Aws::KMS
|
|
|
1645
1885
|
:key_id,
|
|
1646
1886
|
:encryption_algorithm,
|
|
1647
1887
|
:recipient,
|
|
1648
|
-
:dry_run
|
|
1888
|
+
:dry_run,
|
|
1889
|
+
:dry_run_modifiers)
|
|
1649
1890
|
SENSITIVE = []
|
|
1650
1891
|
include Aws::Structure
|
|
1651
1892
|
end
|
|
@@ -1673,19 +1914,28 @@ module Aws::KMS
|
|
|
1673
1914
|
# @return [String]
|
|
1674
1915
|
#
|
|
1675
1916
|
# @!attribute [rw] ciphertext_for_recipient
|
|
1676
|
-
# The plaintext data encrypted with the public key
|
|
1677
|
-
# document.
|
|
1917
|
+
# The plaintext data encrypted with the public key from the
|
|
1918
|
+
# attestation document. This ciphertext can be decrypted only by using
|
|
1919
|
+
# a private key from the attested environment.
|
|
1678
1920
|
#
|
|
1679
1921
|
# This field is included in the response only when the `Recipient`
|
|
1680
1922
|
# parameter in the request includes a valid attestation document from
|
|
1681
|
-
# an Amazon Web Services Nitro enclave. For information
|
|
1682
|
-
# interaction between KMS and Amazon Web Services Nitro
|
|
1683
|
-
#
|
|
1684
|
-
# Management Service
|
|
1923
|
+
# an Amazon Web Services Nitro enclave or NitroTPM. For information
|
|
1924
|
+
# about the interaction between KMS and Amazon Web Services Nitro
|
|
1925
|
+
# Enclaves or Amazon Web Services NitroTPM, see [Cryptographic
|
|
1926
|
+
# attestation support in KMS][1] in the *Key Management Service
|
|
1927
|
+
# Developer Guide*.
|
|
1928
|
+
#
|
|
1685
1929
|
#
|
|
1686
1930
|
#
|
|
1931
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
1932
|
+
# @return [String]
|
|
1687
1933
|
#
|
|
1688
|
-
#
|
|
1934
|
+
# @!attribute [rw] key_material_id
|
|
1935
|
+
# The identifier of the key material used to decrypt the ciphertext.
|
|
1936
|
+
# This field is present only when the operation uses a symmetric
|
|
1937
|
+
# encryption KMS key. This field is omitted if the request includes
|
|
1938
|
+
# the `Recipient` parameter.
|
|
1689
1939
|
# @return [String]
|
|
1690
1940
|
#
|
|
1691
1941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse AWS API Documentation
|
|
@@ -1694,7 +1944,8 @@ module Aws::KMS
|
|
|
1694
1944
|
:key_id,
|
|
1695
1945
|
:plaintext,
|
|
1696
1946
|
:encryption_algorithm,
|
|
1697
|
-
:ciphertext_for_recipient
|
|
1947
|
+
:ciphertext_for_recipient,
|
|
1948
|
+
:key_material_id)
|
|
1698
1949
|
SENSITIVE = [:plaintext]
|
|
1699
1950
|
include Aws::Structure
|
|
1700
1951
|
end
|
|
@@ -1746,10 +1997,43 @@ module Aws::KMS
|
|
|
1746
1997
|
# DescribeKey.
|
|
1747
1998
|
# @return [String]
|
|
1748
1999
|
#
|
|
2000
|
+
# @!attribute [rw] key_material_id
|
|
2001
|
+
# Identifies the imported key material you are deleting.
|
|
2002
|
+
#
|
|
2003
|
+
# If no KeyMaterialId is specified, KMS deletes the current key
|
|
2004
|
+
# material.
|
|
2005
|
+
#
|
|
2006
|
+
# To get the list of key material IDs associated with a KMS key, use
|
|
2007
|
+
# ListKeyRotations.
|
|
2008
|
+
# @return [String]
|
|
2009
|
+
#
|
|
1749
2010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialRequest AWS API Documentation
|
|
1750
2011
|
#
|
|
1751
2012
|
class DeleteImportedKeyMaterialRequest < Struct.new(
|
|
1752
|
-
:key_id
|
|
2013
|
+
:key_id,
|
|
2014
|
+
:key_material_id)
|
|
2015
|
+
SENSITIVE = []
|
|
2016
|
+
include Aws::Structure
|
|
2017
|
+
end
|
|
2018
|
+
|
|
2019
|
+
# @!attribute [rw] key_id
|
|
2020
|
+
# The Amazon Resource Name ([key ARN][1]) of the KMS key from which
|
|
2021
|
+
# the key material was deleted.
|
|
2022
|
+
#
|
|
2023
|
+
#
|
|
2024
|
+
#
|
|
2025
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
|
2026
|
+
# @return [String]
|
|
2027
|
+
#
|
|
2028
|
+
# @!attribute [rw] key_material_id
|
|
2029
|
+
# Identifies the deleted key material.
|
|
2030
|
+
# @return [String]
|
|
2031
|
+
#
|
|
2032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialResponse AWS API Documentation
|
|
2033
|
+
#
|
|
2034
|
+
class DeleteImportedKeyMaterialResponse < Struct.new(
|
|
2035
|
+
:key_id,
|
|
2036
|
+
:key_material_id)
|
|
1753
2037
|
SENSITIVE = []
|
|
1754
2038
|
include Aws::Structure
|
|
1755
2039
|
end
|
|
@@ -1769,7 +2053,7 @@ module Aws::KMS
|
|
|
1769
2053
|
end
|
|
1770
2054
|
|
|
1771
2055
|
# @!attribute [rw] key_id
|
|
1772
|
-
# Identifies an asymmetric NIST-
|
|
2056
|
+
# Identifies an asymmetric NIST-standard ECC or SM2 (China Regions
|
|
1773
2057
|
# only) KMS key. KMS uses the private key in the specified key pair to
|
|
1774
2058
|
# derive the shared secret. The key usage of the KMS key must be
|
|
1775
2059
|
# `KEY_AGREEMENT`. To find the `KeyUsage` of a KMS key, use the
|
|
@@ -1801,7 +2085,7 @@ module Aws::KMS
|
|
|
1801
2085
|
# @return [String]
|
|
1802
2086
|
#
|
|
1803
2087
|
# @!attribute [rw] public_key
|
|
1804
|
-
# Specifies the public key in your peer's NIST-
|
|
2088
|
+
# Specifies the public key in your peer's NIST-standard elliptic
|
|
1805
2089
|
# curve (ECC) or SM2 (China Regions only) key pair.
|
|
1806
2090
|
#
|
|
1807
2091
|
# The public key must be a DER-encoded X.509 public key, also known as
|
|
@@ -1837,54 +2121,58 @@ module Aws::KMS
|
|
|
1837
2121
|
#
|
|
1838
2122
|
#
|
|
1839
2123
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
1840
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2124
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
1841
2125
|
# @return [Array<String>]
|
|
1842
2126
|
#
|
|
1843
2127
|
# @!attribute [rw] dry_run
|
|
1844
2128
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
1845
2129
|
# parameter.
|
|
1846
2130
|
#
|
|
1847
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
1848
|
-
#
|
|
2131
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
2132
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
1849
2133
|
#
|
|
1850
2134
|
#
|
|
1851
2135
|
#
|
|
1852
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2136
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
1853
2137
|
# @return [Boolean]
|
|
1854
2138
|
#
|
|
1855
2139
|
# @!attribute [rw] recipient
|
|
1856
2140
|
# A signed [attestation document][1] from an Amazon Web Services Nitro
|
|
1857
|
-
# enclave and the encryption algorithm to use with the
|
|
1858
|
-
# public key. The only valid encryption
|
|
1859
|
-
# `RSAES_OAEP_SHA_256`.
|
|
2141
|
+
# enclave or NitroTPM, and the encryption algorithm to use with the
|
|
2142
|
+
# public key in the attestation document. The only valid encryption
|
|
2143
|
+
# algorithm is `RSAES_OAEP_SHA_256`.
|
|
1860
2144
|
#
|
|
1861
2145
|
# This parameter only supports attestation documents for Amazon Web
|
|
1862
|
-
# Services Nitro Enclaves
|
|
1863
|
-
#
|
|
1864
|
-
# Enclaves SDK][2]
|
|
1865
|
-
#
|
|
1866
|
-
#
|
|
2146
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM. To call
|
|
2147
|
+
# DeriveSharedSecret generate an attestation document use either
|
|
2148
|
+
# [Amazon Web Services Nitro Enclaves SDK][2] for an Amazon Web
|
|
2149
|
+
# Services Nitro Enclaves or [Amazon Web Services NitroTPM tools][3]
|
|
2150
|
+
# for Amazon Web Services NitroTPM. Then use the Recipient parameter
|
|
2151
|
+
# from any Amazon Web Services SDK to provide the attestation document
|
|
2152
|
+
# for the attested environment.
|
|
1867
2153
|
#
|
|
1868
2154
|
# When you use this parameter, instead of returning a plaintext copy
|
|
1869
2155
|
# of the shared secret, KMS encrypts the plaintext shared secret under
|
|
1870
2156
|
# the public key in the attestation document, and returns the
|
|
1871
2157
|
# resulting ciphertext in the `CiphertextForRecipient` field in the
|
|
1872
2158
|
# response. This ciphertext can be decrypted only with the private key
|
|
1873
|
-
# in the
|
|
1874
|
-
# the encrypted shared secret derived from the KMS
|
|
1875
|
-
# the `KeyId` parameter and public key specified by
|
|
1876
|
-
# parameter. The `SharedSecret` field in the response
|
|
1877
|
-
# empty.
|
|
2159
|
+
# in the attested environment. The `CiphertextBlob` field in the
|
|
2160
|
+
# response contains the encrypted shared secret derived from the KMS
|
|
2161
|
+
# key specified by the `KeyId` parameter and public key specified by
|
|
2162
|
+
# the `PublicKey` parameter. The `SharedSecret` field in the response
|
|
2163
|
+
# is null or empty.
|
|
1878
2164
|
#
|
|
1879
2165
|
# For information about the interaction between KMS and Amazon Web
|
|
1880
|
-
# Services Nitro Enclaves
|
|
1881
|
-
#
|
|
2166
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM, see
|
|
2167
|
+
# [Cryptographic attestation support in KMS][4] in the *Key Management
|
|
2168
|
+
# Service Developer Guide*.
|
|
1882
2169
|
#
|
|
1883
2170
|
#
|
|
1884
2171
|
#
|
|
1885
2172
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
|
|
1886
2173
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
|
1887
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2174
|
+
# [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/attestation-get-doc.html
|
|
2175
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
1888
2176
|
# @return [Types::RecipientInfo]
|
|
1889
2177
|
#
|
|
1890
2178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeriveSharedSecretRequest AWS API Documentation
|
|
@@ -1913,19 +2201,21 @@ module Aws::KMS
|
|
|
1913
2201
|
# @return [String]
|
|
1914
2202
|
#
|
|
1915
2203
|
# @!attribute [rw] ciphertext_for_recipient
|
|
1916
|
-
# The plaintext shared secret encrypted with the public key
|
|
1917
|
-
# attestation document.
|
|
2204
|
+
# The plaintext shared secret encrypted with the public key from the
|
|
2205
|
+
# attestation document. This ciphertext can be decrypted only by using
|
|
2206
|
+
# a private key from the attested environment.
|
|
1918
2207
|
#
|
|
1919
2208
|
# This field is included in the response only when the `Recipient`
|
|
1920
2209
|
# parameter in the request includes a valid attestation document from
|
|
1921
|
-
# an Amazon Web Services Nitro enclave. For information
|
|
1922
|
-
# interaction between KMS and Amazon Web Services Nitro
|
|
1923
|
-
#
|
|
1924
|
-
# Management Service
|
|
2210
|
+
# an Amazon Web Services Nitro enclave or NitroTPM. For information
|
|
2211
|
+
# about the interaction between KMS and Amazon Web Services Nitro
|
|
2212
|
+
# Enclaves or Amazon Web Services NitroTPM, see [Cryptographic
|
|
2213
|
+
# attestation support in KMS][1] in the *Key Management Service
|
|
2214
|
+
# Developer Guide*.
|
|
1925
2215
|
#
|
|
1926
2216
|
#
|
|
1927
2217
|
#
|
|
1928
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2218
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
1929
2219
|
# @return [String]
|
|
1930
2220
|
#
|
|
1931
2221
|
# @!attribute [rw] key_agreement_algorithm
|
|
@@ -2055,7 +2345,7 @@ module Aws::KMS
|
|
|
2055
2345
|
#
|
|
2056
2346
|
#
|
|
2057
2347
|
#
|
|
2058
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
|
|
2348
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key
|
|
2059
2349
|
# @return [String]
|
|
2060
2350
|
#
|
|
2061
2351
|
# @!attribute [rw] grant_tokens
|
|
@@ -2069,7 +2359,7 @@ module Aws::KMS
|
|
|
2069
2359
|
#
|
|
2070
2360
|
#
|
|
2071
2361
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2072
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2362
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2073
2363
|
# @return [Array<String>]
|
|
2074
2364
|
#
|
|
2075
2365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyRequest AWS API Documentation
|
|
@@ -2140,7 +2430,7 @@ module Aws::KMS
|
|
|
2140
2430
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks
|
|
2141
2431
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
|
2142
2432
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
|
2143
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2433
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
2144
2434
|
# @return [String]
|
|
2145
2435
|
#
|
|
2146
2436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationRequest AWS API Documentation
|
|
@@ -2243,8 +2533,8 @@ module Aws::KMS
|
|
|
2243
2533
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
|
2244
2534
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
|
2245
2535
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
|
2246
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2247
|
-
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2536
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
2537
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate
|
|
2248
2538
|
# @return [String]
|
|
2249
2539
|
#
|
|
2250
2540
|
# @!attribute [rw] rotation_period_in_days
|
|
@@ -2276,6 +2566,116 @@ module Aws::KMS
|
|
|
2276
2566
|
include Aws::Structure
|
|
2277
2567
|
end
|
|
2278
2568
|
|
|
2569
|
+
# @!attribute [rw] key_id
|
|
2570
|
+
# Identifies an asymmetric ML-KEM KMS key. KMS uses the public key in
|
|
2571
|
+
# the specified key pair to encapsulate the shared secret. ML-KEM KMS
|
|
2572
|
+
# keys have a `KeySpec` value of `ML_KEM_512`, `ML_KEM_768`, or
|
|
2573
|
+
# `ML_KEM_1024` and a `KeyUsage` value of `ENCAPSULATE_DECAPSULATE`.
|
|
2574
|
+
# To find the `KeySpec` and `KeyUsage` of a KMS key, use the
|
|
2575
|
+
# DescribeKey operation.
|
|
2576
|
+
#
|
|
2577
|
+
# To specify a KMS key, use its key ID, key ARN, alias name, or alias
|
|
2578
|
+
# ARN. When using an alias name, prefix it with `"alias/"`. To specify
|
|
2579
|
+
# a KMS key in a different Amazon Web Services account, you must use
|
|
2580
|
+
# the key ARN or alias ARN.
|
|
2581
|
+
#
|
|
2582
|
+
# For example:
|
|
2583
|
+
#
|
|
2584
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
2585
|
+
#
|
|
2586
|
+
# * Key ARN:
|
|
2587
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
2588
|
+
#
|
|
2589
|
+
# * Alias name: `alias/ExampleAlias`
|
|
2590
|
+
#
|
|
2591
|
+
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
|
|
2592
|
+
#
|
|
2593
|
+
# To get the key ID and key ARN for a KMS key, use ListKeys or
|
|
2594
|
+
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
2595
|
+
# @return [String]
|
|
2596
|
+
#
|
|
2597
|
+
# @!attribute [rw] encapsulation_algorithm
|
|
2598
|
+
# Specifies the key encapsulation algorithm used to generate the
|
|
2599
|
+
# shared secret and its encapsulated form. The only valid value is
|
|
2600
|
+
# `ML_KEM`.
|
|
2601
|
+
# @return [String]
|
|
2602
|
+
#
|
|
2603
|
+
# @!attribute [rw] grant_tokens
|
|
2604
|
+
# A list of grant tokens.
|
|
2605
|
+
#
|
|
2606
|
+
# Use a grant token when your permission to call this operation comes
|
|
2607
|
+
# from a new grant that has not yet achieved *eventual consistency*.
|
|
2608
|
+
# For more information, see [Grant token][1] and [Using a grant
|
|
2609
|
+
# token][2] in the *Key Management Service Developer Guide*.
|
|
2610
|
+
#
|
|
2611
|
+
#
|
|
2612
|
+
#
|
|
2613
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2614
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2615
|
+
# @return [Array<String>]
|
|
2616
|
+
#
|
|
2617
|
+
# @!attribute [rw] dry_run
|
|
2618
|
+
# Checks if your request will succeed. `DryRun` is an optional
|
|
2619
|
+
# parameter.
|
|
2620
|
+
#
|
|
2621
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
2622
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
2623
|
+
#
|
|
2624
|
+
#
|
|
2625
|
+
#
|
|
2626
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
2627
|
+
# @return [Boolean]
|
|
2628
|
+
#
|
|
2629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncapsulateRequest AWS API Documentation
|
|
2630
|
+
#
|
|
2631
|
+
class EncapsulateRequest < Struct.new(
|
|
2632
|
+
:key_id,
|
|
2633
|
+
:encapsulation_algorithm,
|
|
2634
|
+
:grant_tokens,
|
|
2635
|
+
:dry_run)
|
|
2636
|
+
SENSITIVE = []
|
|
2637
|
+
include Aws::Structure
|
|
2638
|
+
end
|
|
2639
|
+
|
|
2640
|
+
# @!attribute [rw] key_id
|
|
2641
|
+
# The identifier of the ML-KEM KMS key used to encapsulate the shared
|
|
2642
|
+
# secret.
|
|
2643
|
+
# @return [String]
|
|
2644
|
+
#
|
|
2645
|
+
# @!attribute [rw] shared_secret
|
|
2646
|
+
# The plaintext shared secret. It is a 32-byte cryptographically
|
|
2647
|
+
# random value that both parties can use directly as key material or
|
|
2648
|
+
# pass through a key derivation function to generate multiple keys and
|
|
2649
|
+
# nonces. When you use the HTTP API or the Amazon Web Services CLI,
|
|
2650
|
+
# the value is Base64-encoded. Otherwise, it is not Base64-encoded.
|
|
2651
|
+
# @return [String]
|
|
2652
|
+
#
|
|
2653
|
+
# @!attribute [rw] shared_secret_ciphertext_blob
|
|
2654
|
+
# The encapsulated form of the shared secret. Pass this value to the
|
|
2655
|
+
# Decapsulate operation to recover the shared secret. When you use the
|
|
2656
|
+
# HTTP API or the Amazon Web Services CLI, the value is
|
|
2657
|
+
# Base64-encoded. Otherwise, it is not Base64-encoded. The length of
|
|
2658
|
+
# `SharedSecretCiphertextBlob` depends on the ML-KEM key spec. Before
|
|
2659
|
+
# Base64 encoding, the encapsulated shared secret is 768 bytes for
|
|
2660
|
+
# `ML_KEM_512`, 1088 bytes for `ML_KEM_768`, and 1568 bytes for
|
|
2661
|
+
# `ML_KEM_1024`.
|
|
2662
|
+
# @return [String]
|
|
2663
|
+
#
|
|
2664
|
+
# @!attribute [rw] encapsulation_algorithm
|
|
2665
|
+
# The key encapsulation algorithm used to generate the shared secret.
|
|
2666
|
+
# @return [String]
|
|
2667
|
+
#
|
|
2668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncapsulateResponse AWS API Documentation
|
|
2669
|
+
#
|
|
2670
|
+
class EncapsulateResponse < Struct.new(
|
|
2671
|
+
:key_id,
|
|
2672
|
+
:shared_secret,
|
|
2673
|
+
:shared_secret_ciphertext_blob,
|
|
2674
|
+
:encapsulation_algorithm)
|
|
2675
|
+
SENSITIVE = [:shared_secret]
|
|
2676
|
+
include Aws::Structure
|
|
2677
|
+
end
|
|
2678
|
+
|
|
2279
2679
|
# @!attribute [rw] key_id
|
|
2280
2680
|
# Identifies the KMS key to use in the encryption operation. The KMS
|
|
2281
2681
|
# key must have a `KeyUsage` of `ENCRYPT_DECRYPT`. To find the
|
|
@@ -2330,8 +2730,8 @@ module Aws::KMS
|
|
|
2330
2730
|
#
|
|
2331
2731
|
#
|
|
2332
2732
|
#
|
|
2333
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2334
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2733
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
2734
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
2335
2735
|
# @return [Hash<String,String>]
|
|
2336
2736
|
#
|
|
2337
2737
|
# @!attribute [rw] grant_tokens
|
|
@@ -2345,7 +2745,7 @@ module Aws::KMS
|
|
|
2345
2745
|
#
|
|
2346
2746
|
#
|
|
2347
2747
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2348
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2748
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2349
2749
|
# @return [Array<String>]
|
|
2350
2750
|
#
|
|
2351
2751
|
# @!attribute [rw] encryption_algorithm
|
|
@@ -2365,12 +2765,12 @@ module Aws::KMS
|
|
|
2365
2765
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
2366
2766
|
# parameter.
|
|
2367
2767
|
#
|
|
2368
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
2369
|
-
#
|
|
2768
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
2769
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
2370
2770
|
#
|
|
2371
2771
|
#
|
|
2372
2772
|
#
|
|
2373
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2773
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
2374
2774
|
# @return [Boolean]
|
|
2375
2775
|
#
|
|
2376
2776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptRequest AWS API Documentation
|
|
@@ -2453,7 +2853,7 @@ module Aws::KMS
|
|
|
2453
2853
|
#
|
|
2454
2854
|
#
|
|
2455
2855
|
#
|
|
2456
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2856
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
2457
2857
|
# @return [Hash<String,String>]
|
|
2458
2858
|
#
|
|
2459
2859
|
# @!attribute [rw] key_id
|
|
@@ -2487,9 +2887,11 @@ module Aws::KMS
|
|
|
2487
2887
|
#
|
|
2488
2888
|
# The KMS rule that restricts the use of asymmetric RSA and SM2 KMS
|
|
2489
2889
|
# keys to encrypt and decrypt or to sign and verify (but not both),
|
|
2490
|
-
#
|
|
2491
|
-
# verify,
|
|
2492
|
-
#
|
|
2890
|
+
# the rule that permits you to use ECC KMS keys only to sign and
|
|
2891
|
+
# verify, and the rule that permits you to use ML-DSA key pairs to
|
|
2892
|
+
# sign and verify only are not effective on data key pairs, which are
|
|
2893
|
+
# used outside of KMS. The SM2 key spec is only available in China
|
|
2894
|
+
# Regions. The ML-KEM key specs are not available in China Regions.
|
|
2493
2895
|
# @return [String]
|
|
2494
2896
|
#
|
|
2495
2897
|
# @!attribute [rw] grant_tokens
|
|
@@ -2503,53 +2905,57 @@ module Aws::KMS
|
|
|
2503
2905
|
#
|
|
2504
2906
|
#
|
|
2505
2907
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2506
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2908
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2507
2909
|
# @return [Array<String>]
|
|
2508
2910
|
#
|
|
2509
2911
|
# @!attribute [rw] recipient
|
|
2510
2912
|
# A signed [attestation document][1] from an Amazon Web Services Nitro
|
|
2511
|
-
# enclave and the encryption algorithm to use with the
|
|
2512
|
-
# public key. The only valid encryption
|
|
2513
|
-
# `RSAES_OAEP_SHA_256`.
|
|
2913
|
+
# enclave or NitroTPM, and the encryption algorithm to use with the
|
|
2914
|
+
# public key in the attestation document. The only valid encryption
|
|
2915
|
+
# algorithm is `RSAES_OAEP_SHA_256`.
|
|
2514
2916
|
#
|
|
2515
2917
|
# This parameter only supports attestation documents for Amazon Web
|
|
2516
|
-
# Services Nitro Enclaves
|
|
2517
|
-
#
|
|
2518
|
-
# Enclaves SDK][2]
|
|
2519
|
-
#
|
|
2520
|
-
#
|
|
2918
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM. To call
|
|
2919
|
+
# GenerateDataKeyPair generate an attestation document use either
|
|
2920
|
+
# [Amazon Web Services Nitro Enclaves SDK][2] for an Amazon Web
|
|
2921
|
+
# Services Nitro Enclaves or [Amazon Web Services NitroTPM tools][3]
|
|
2922
|
+
# for Amazon Web Services NitroTPM. Then use the Recipient parameter
|
|
2923
|
+
# from any Amazon Web Services SDK to provide the attestation document
|
|
2924
|
+
# for the attested environment.
|
|
2521
2925
|
#
|
|
2522
2926
|
# When you use this parameter, instead of returning a plaintext copy
|
|
2523
2927
|
# of the private data key, KMS encrypts the plaintext private data key
|
|
2524
2928
|
# under the public key in the attestation document, and returns the
|
|
2525
2929
|
# resulting ciphertext in the `CiphertextForRecipient` field in the
|
|
2526
2930
|
# response. This ciphertext can be decrypted only with the private key
|
|
2527
|
-
# in the
|
|
2528
|
-
# a copy of the private data key encrypted under the
|
|
2529
|
-
# by the `KeyId` parameter. The
|
|
2530
|
-
# response is null or empty.
|
|
2931
|
+
# in the attested environment. The `CiphertextBlob` field in the
|
|
2932
|
+
# response contains a copy of the private data key encrypted under the
|
|
2933
|
+
# KMS key specified by the `KeyId` parameter. The
|
|
2934
|
+
# `PrivateKeyPlaintext` field in the response is null or empty.
|
|
2531
2935
|
#
|
|
2532
2936
|
# For information about the interaction between KMS and Amazon Web
|
|
2533
|
-
# Services Nitro Enclaves
|
|
2534
|
-
#
|
|
2937
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM, see
|
|
2938
|
+
# [Cryptographic attestation support in KMS][4] in the *Key Management
|
|
2939
|
+
# Service Developer Guide*.
|
|
2535
2940
|
#
|
|
2536
2941
|
#
|
|
2537
2942
|
#
|
|
2538
2943
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
|
|
2539
2944
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
|
2540
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2945
|
+
# [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/attestation-get-doc.html
|
|
2946
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
2541
2947
|
# @return [Types::RecipientInfo]
|
|
2542
2948
|
#
|
|
2543
2949
|
# @!attribute [rw] dry_run
|
|
2544
2950
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
2545
2951
|
# parameter.
|
|
2546
2952
|
#
|
|
2547
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
2548
|
-
#
|
|
2953
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
2954
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
2549
2955
|
#
|
|
2550
2956
|
#
|
|
2551
2957
|
#
|
|
2552
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2958
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
2553
2959
|
# @return [Boolean]
|
|
2554
2960
|
#
|
|
2555
2961
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairRequest AWS API Documentation
|
|
@@ -2601,19 +3007,24 @@ module Aws::KMS
|
|
|
2601
3007
|
#
|
|
2602
3008
|
# @!attribute [rw] ciphertext_for_recipient
|
|
2603
3009
|
# The plaintext private data key encrypted with the public key from
|
|
2604
|
-
# the
|
|
2605
|
-
# private key
|
|
3010
|
+
# the attestation document. This ciphertext can be decrypted only by
|
|
3011
|
+
# using a private key from the attested environment.
|
|
2606
3012
|
#
|
|
2607
3013
|
# This field is included in the response only when the `Recipient`
|
|
2608
3014
|
# parameter in the request includes a valid attestation document from
|
|
2609
|
-
# an Amazon Web Services Nitro enclave. For information
|
|
2610
|
-
# interaction between KMS and Amazon Web Services Nitro
|
|
2611
|
-
#
|
|
2612
|
-
# Management Service
|
|
3015
|
+
# an Amazon Web Services Nitro enclave or NitroTPM. For information
|
|
3016
|
+
# about the interaction between KMS and Amazon Web Services Nitro
|
|
3017
|
+
# Enclaves or Amazon Web Services NitroTPM, see [Cryptographic
|
|
3018
|
+
# attestation support in KMS][1] in the *Key Management Service
|
|
3019
|
+
# Developer Guide*.
|
|
2613
3020
|
#
|
|
2614
3021
|
#
|
|
2615
3022
|
#
|
|
2616
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3023
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
3024
|
+
# @return [String]
|
|
3025
|
+
#
|
|
3026
|
+
# @!attribute [rw] key_material_id
|
|
3027
|
+
# The identifier of the key material used to encrypt the private key.
|
|
2617
3028
|
# @return [String]
|
|
2618
3029
|
#
|
|
2619
3030
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairResponse AWS API Documentation
|
|
@@ -2624,7 +3035,8 @@ module Aws::KMS
|
|
|
2624
3035
|
:public_key,
|
|
2625
3036
|
:key_id,
|
|
2626
3037
|
:key_pair_spec,
|
|
2627
|
-
:ciphertext_for_recipient
|
|
3038
|
+
:ciphertext_for_recipient,
|
|
3039
|
+
:key_material_id)
|
|
2628
3040
|
SENSITIVE = [:private_key_plaintext]
|
|
2629
3041
|
include Aws::Structure
|
|
2630
3042
|
end
|
|
@@ -2651,7 +3063,7 @@ module Aws::KMS
|
|
|
2651
3063
|
#
|
|
2652
3064
|
#
|
|
2653
3065
|
#
|
|
2654
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3066
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
2655
3067
|
# @return [Hash<String,String>]
|
|
2656
3068
|
#
|
|
2657
3069
|
# @!attribute [rw] key_id
|
|
@@ -2685,9 +3097,11 @@ module Aws::KMS
|
|
|
2685
3097
|
#
|
|
2686
3098
|
# The KMS rule that restricts the use of asymmetric RSA and SM2 KMS
|
|
2687
3099
|
# keys to encrypt and decrypt or to sign and verify (but not both),
|
|
2688
|
-
#
|
|
2689
|
-
# verify,
|
|
2690
|
-
#
|
|
3100
|
+
# the rule that permits you to use ECC KMS keys only to sign and
|
|
3101
|
+
# verify, and the rule that permits you to use ML-DSA key pairs to
|
|
3102
|
+
# sign and verify only are not effective on data key pairs, which are
|
|
3103
|
+
# used outside of KMS. The SM2 key spec is only available in China
|
|
3104
|
+
# Regions. The ML-KEM key specs are not available in China Regions.
|
|
2691
3105
|
# @return [String]
|
|
2692
3106
|
#
|
|
2693
3107
|
# @!attribute [rw] grant_tokens
|
|
@@ -2701,19 +3115,19 @@ module Aws::KMS
|
|
|
2701
3115
|
#
|
|
2702
3116
|
#
|
|
2703
3117
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2704
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3118
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2705
3119
|
# @return [Array<String>]
|
|
2706
3120
|
#
|
|
2707
3121
|
# @!attribute [rw] dry_run
|
|
2708
3122
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
2709
3123
|
# parameter.
|
|
2710
3124
|
#
|
|
2711
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
2712
|
-
#
|
|
3125
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
3126
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
2713
3127
|
#
|
|
2714
3128
|
#
|
|
2715
3129
|
#
|
|
2716
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3130
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
2717
3131
|
# @return [Boolean]
|
|
2718
3132
|
#
|
|
2719
3133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextRequest AWS API Documentation
|
|
@@ -2753,13 +3167,18 @@ module Aws::KMS
|
|
|
2753
3167
|
# The type of data key pair that was generated.
|
|
2754
3168
|
# @return [String]
|
|
2755
3169
|
#
|
|
3170
|
+
# @!attribute [rw] key_material_id
|
|
3171
|
+
# The identifier of the key material used to encrypt the private key.
|
|
3172
|
+
# @return [String]
|
|
3173
|
+
#
|
|
2756
3174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextResponse AWS API Documentation
|
|
2757
3175
|
#
|
|
2758
3176
|
class GenerateDataKeyPairWithoutPlaintextResponse < Struct.new(
|
|
2759
3177
|
:private_key_ciphertext_blob,
|
|
2760
3178
|
:public_key,
|
|
2761
3179
|
:key_id,
|
|
2762
|
-
:key_pair_spec
|
|
3180
|
+
:key_pair_spec,
|
|
3181
|
+
:key_material_id)
|
|
2763
3182
|
SENSITIVE = []
|
|
2764
3183
|
include Aws::Structure
|
|
2765
3184
|
end
|
|
@@ -2812,7 +3231,7 @@ module Aws::KMS
|
|
|
2812
3231
|
#
|
|
2813
3232
|
#
|
|
2814
3233
|
#
|
|
2815
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3234
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
2816
3235
|
# @return [Hash<String,String>]
|
|
2817
3236
|
#
|
|
2818
3237
|
# @!attribute [rw] number_of_bytes
|
|
@@ -2845,18 +3264,19 @@ module Aws::KMS
|
|
|
2845
3264
|
#
|
|
2846
3265
|
#
|
|
2847
3266
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
2848
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3267
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
2849
3268
|
# @return [Array<String>]
|
|
2850
3269
|
#
|
|
2851
3270
|
# @!attribute [rw] recipient
|
|
2852
3271
|
# A signed [attestation document][1] from an Amazon Web Services Nitro
|
|
2853
|
-
# enclave and the encryption algorithm to use with the
|
|
2854
|
-
# public key. The only valid encryption
|
|
2855
|
-
# `RSAES_OAEP_SHA_256`.
|
|
3272
|
+
# enclave or NitroTPM, and the encryption algorithm to use with the
|
|
3273
|
+
# public key in the attestation document. The only valid encryption
|
|
3274
|
+
# algorithm is `RSAES_OAEP_SHA_256`.
|
|
2856
3275
|
#
|
|
2857
|
-
# This parameter
|
|
2858
|
-
#
|
|
2859
|
-
#
|
|
3276
|
+
# This parameter supports the [Amazon Web Services Nitro Enclaves
|
|
3277
|
+
# SDK][2] or any Amazon Web Services SDK for Amazon Web Services Nitro
|
|
3278
|
+
# Enclaves. It supports any Amazon Web Services SDK for Amazon Web
|
|
3279
|
+
# Services NitroTPM.
|
|
2860
3280
|
#
|
|
2861
3281
|
# When you use this parameter, instead of returning the plaintext data
|
|
2862
3282
|
# key, KMS encrypts the plaintext data key under the public key in the
|
|
@@ -2868,26 +3288,27 @@ module Aws::KMS
|
|
|
2868
3288
|
# The `Plaintext` field in the response is null or empty.
|
|
2869
3289
|
#
|
|
2870
3290
|
# For information about the interaction between KMS and Amazon Web
|
|
2871
|
-
# Services Nitro Enclaves
|
|
2872
|
-
#
|
|
3291
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM, see
|
|
3292
|
+
# [Cryptographic attestation support in KMS][3] in the *Key Management
|
|
3293
|
+
# Service Developer Guide*.
|
|
2873
3294
|
#
|
|
2874
3295
|
#
|
|
2875
3296
|
#
|
|
2876
3297
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
|
|
2877
3298
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
|
2878
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3299
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
2879
3300
|
# @return [Types::RecipientInfo]
|
|
2880
3301
|
#
|
|
2881
3302
|
# @!attribute [rw] dry_run
|
|
2882
3303
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
2883
3304
|
# parameter.
|
|
2884
3305
|
#
|
|
2885
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
2886
|
-
#
|
|
3306
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
3307
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
2887
3308
|
#
|
|
2888
3309
|
#
|
|
2889
3310
|
#
|
|
2890
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3311
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
2891
3312
|
# @return [Boolean]
|
|
2892
3313
|
#
|
|
2893
3314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyRequest AWS API Documentation
|
|
@@ -2930,20 +3351,27 @@ module Aws::KMS
|
|
|
2930
3351
|
# @return [String]
|
|
2931
3352
|
#
|
|
2932
3353
|
# @!attribute [rw] ciphertext_for_recipient
|
|
2933
|
-
# The plaintext data key encrypted with the public key from the
|
|
2934
|
-
#
|
|
2935
|
-
# key
|
|
3354
|
+
# The plaintext data key encrypted with the public key from the
|
|
3355
|
+
# attestation document. This ciphertext can be decrypted only by using
|
|
3356
|
+
# a private key from the attested environment.
|
|
2936
3357
|
#
|
|
2937
3358
|
# This field is included in the response only when the `Recipient`
|
|
2938
3359
|
# parameter in the request includes a valid attestation document from
|
|
2939
|
-
# an Amazon Web Services Nitro enclave. For information
|
|
2940
|
-
# interaction between KMS and Amazon Web Services Nitro
|
|
2941
|
-
#
|
|
2942
|
-
# Management Service
|
|
3360
|
+
# an Amazon Web Services Nitro enclave or NitroTPM. For information
|
|
3361
|
+
# about the interaction between KMS and Amazon Web Services Nitro
|
|
3362
|
+
# Enclaves or Amazon Web Services NitroTPM, see [Cryptographic
|
|
3363
|
+
# attestation support in KMS][1] in the *Key Management Service
|
|
3364
|
+
# Developer Guide*.
|
|
2943
3365
|
#
|
|
2944
3366
|
#
|
|
2945
3367
|
#
|
|
2946
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3368
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
3369
|
+
# @return [String]
|
|
3370
|
+
#
|
|
3371
|
+
# @!attribute [rw] key_material_id
|
|
3372
|
+
# The identifier of the key material used to encrypt the data key.
|
|
3373
|
+
# This field is omitted if the request includes the `Recipient`
|
|
3374
|
+
# parameter.
|
|
2947
3375
|
# @return [String]
|
|
2948
3376
|
#
|
|
2949
3377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyResponse AWS API Documentation
|
|
@@ -2952,7 +3380,8 @@ module Aws::KMS
|
|
|
2952
3380
|
:ciphertext_blob,
|
|
2953
3381
|
:plaintext,
|
|
2954
3382
|
:key_id,
|
|
2955
|
-
:ciphertext_for_recipient
|
|
3383
|
+
:ciphertext_for_recipient,
|
|
3384
|
+
:key_material_id)
|
|
2956
3385
|
SENSITIVE = [:plaintext]
|
|
2957
3386
|
include Aws::Structure
|
|
2958
3387
|
end
|
|
@@ -3005,7 +3434,7 @@ module Aws::KMS
|
|
|
3005
3434
|
#
|
|
3006
3435
|
#
|
|
3007
3436
|
#
|
|
3008
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3437
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
3009
3438
|
# @return [Hash<String,String>]
|
|
3010
3439
|
#
|
|
3011
3440
|
# @!attribute [rw] key_spec
|
|
@@ -3031,19 +3460,19 @@ module Aws::KMS
|
|
|
3031
3460
|
#
|
|
3032
3461
|
#
|
|
3033
3462
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
3034
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3463
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
3035
3464
|
# @return [Array<String>]
|
|
3036
3465
|
#
|
|
3037
3466
|
# @!attribute [rw] dry_run
|
|
3038
3467
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
3039
3468
|
# parameter.
|
|
3040
3469
|
#
|
|
3041
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
3042
|
-
#
|
|
3470
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
3471
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
3043
3472
|
#
|
|
3044
3473
|
#
|
|
3045
3474
|
#
|
|
3046
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3475
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
3047
3476
|
# @return [Boolean]
|
|
3048
3477
|
#
|
|
3049
3478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextRequest AWS API Documentation
|
|
@@ -3074,11 +3503,16 @@ module Aws::KMS
|
|
|
3074
3503
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
|
3075
3504
|
# @return [String]
|
|
3076
3505
|
#
|
|
3506
|
+
# @!attribute [rw] key_material_id
|
|
3507
|
+
# The identifier of the key material used to encrypt the data key.
|
|
3508
|
+
# @return [String]
|
|
3509
|
+
#
|
|
3077
3510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextResponse AWS API Documentation
|
|
3078
3511
|
#
|
|
3079
3512
|
class GenerateDataKeyWithoutPlaintextResponse < Struct.new(
|
|
3080
3513
|
:ciphertext_blob,
|
|
3081
|
-
:key_id
|
|
3514
|
+
:key_id,
|
|
3515
|
+
:key_material_id)
|
|
3082
3516
|
SENSITIVE = []
|
|
3083
3517
|
include Aws::Structure
|
|
3084
3518
|
end
|
|
@@ -3123,19 +3557,19 @@ module Aws::KMS
|
|
|
3123
3557
|
#
|
|
3124
3558
|
#
|
|
3125
3559
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
3126
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3560
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
3127
3561
|
# @return [Array<String>]
|
|
3128
3562
|
#
|
|
3129
3563
|
# @!attribute [rw] dry_run
|
|
3130
3564
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
3131
3565
|
# parameter.
|
|
3132
3566
|
#
|
|
3133
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
3134
|
-
#
|
|
3567
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
3568
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
3135
3569
|
#
|
|
3136
3570
|
#
|
|
3137
3571
|
#
|
|
3138
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3572
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
3139
3573
|
# @return [Boolean]
|
|
3140
3574
|
#
|
|
3141
3575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMacRequest AWS API Documentation
|
|
@@ -3195,30 +3629,32 @@ module Aws::KMS
|
|
|
3195
3629
|
#
|
|
3196
3630
|
# @!attribute [rw] recipient
|
|
3197
3631
|
# A signed [attestation document][1] from an Amazon Web Services Nitro
|
|
3198
|
-
# enclave and the encryption algorithm to use with the
|
|
3199
|
-
# public key. The only valid encryption
|
|
3200
|
-
# `RSAES_OAEP_SHA_256`.
|
|
3632
|
+
# enclave or NitroTPM, and the encryption algorithm to use with the
|
|
3633
|
+
# public key in the attestation document. The only valid encryption
|
|
3634
|
+
# algorithm is `RSAES_OAEP_SHA_256`.
|
|
3201
3635
|
#
|
|
3202
|
-
# This parameter
|
|
3203
|
-
#
|
|
3204
|
-
#
|
|
3636
|
+
# This parameter supports the [Amazon Web Services Nitro Enclaves
|
|
3637
|
+
# SDK][2] or any Amazon Web Services SDK for Amazon Web Services Nitro
|
|
3638
|
+
# Enclaves. It supports any Amazon Web Services SDK for Amazon Web
|
|
3639
|
+
# Services NitroTPM.
|
|
3205
3640
|
#
|
|
3206
3641
|
# When you use this parameter, instead of returning plaintext bytes,
|
|
3207
3642
|
# KMS encrypts the plaintext bytes under the public key in the
|
|
3208
3643
|
# attestation document, and returns the resulting ciphertext in the
|
|
3209
3644
|
# `CiphertextForRecipient` field in the response. This ciphertext can
|
|
3210
|
-
# be decrypted only with the private key in the
|
|
3211
|
-
# `Plaintext` field in the response is null or empty.
|
|
3645
|
+
# be decrypted only with the private key in the attested environment.
|
|
3646
|
+
# The `Plaintext` field in the response is null or empty.
|
|
3212
3647
|
#
|
|
3213
3648
|
# For information about the interaction between KMS and Amazon Web
|
|
3214
|
-
# Services Nitro Enclaves
|
|
3215
|
-
#
|
|
3649
|
+
# Services Nitro Enclaves or Amazon Web Services NitroTPM, see
|
|
3650
|
+
# [Cryptographic attestation support in KMS][3] in the *Key Management
|
|
3651
|
+
# Service Developer Guide*.
|
|
3216
3652
|
#
|
|
3217
3653
|
#
|
|
3218
3654
|
#
|
|
3219
3655
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
|
|
3220
3656
|
# [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
|
|
3221
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3657
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
3222
3658
|
# @return [Types::RecipientInfo]
|
|
3223
3659
|
#
|
|
3224
3660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomRequest AWS API Documentation
|
|
@@ -3242,19 +3678,20 @@ module Aws::KMS
|
|
|
3242
3678
|
#
|
|
3243
3679
|
# @!attribute [rw] ciphertext_for_recipient
|
|
3244
3680
|
# The plaintext random bytes encrypted with the public key from the
|
|
3245
|
-
#
|
|
3246
|
-
# private key
|
|
3681
|
+
# attestation document. This ciphertext can be decrypted only by using
|
|
3682
|
+
# a private key from the attested environment.
|
|
3247
3683
|
#
|
|
3248
3684
|
# This field is included in the response only when the `Recipient`
|
|
3249
3685
|
# parameter in the request includes a valid attestation document from
|
|
3250
|
-
# an Amazon Web Services Nitro enclave. For information
|
|
3251
|
-
# interaction between KMS and Amazon Web Services Nitro
|
|
3252
|
-
#
|
|
3253
|
-
# Management Service
|
|
3686
|
+
# an Amazon Web Services Nitro enclave or NitroTPM. For information
|
|
3687
|
+
# about the interaction between KMS and Amazon Web Services Nitro
|
|
3688
|
+
# Enclaves or Amazon Web Services NitroTPM, see [Cryptographic
|
|
3689
|
+
# attestation support in KMS][1] in the *Key Management Service
|
|
3690
|
+
# Developer Guide*.
|
|
3254
3691
|
#
|
|
3255
3692
|
#
|
|
3256
3693
|
#
|
|
3257
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3694
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
3258
3695
|
# @return [String]
|
|
3259
3696
|
#
|
|
3260
3697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse AWS API Documentation
|
|
@@ -3267,7 +3704,62 @@ module Aws::KMS
|
|
|
3267
3704
|
end
|
|
3268
3705
|
|
|
3269
3706
|
# @!attribute [rw] key_id
|
|
3270
|
-
#
|
|
3707
|
+
# Identifies the KMS key to get usage information for. To specify a
|
|
3708
|
+
# KMS key, use its key ID or key ARN. Alias names are not supported.
|
|
3709
|
+
#
|
|
3710
|
+
# Specify the key ID or key ARN of the KMS key.
|
|
3711
|
+
#
|
|
3712
|
+
# For example:
|
|
3713
|
+
#
|
|
3714
|
+
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
3715
|
+
#
|
|
3716
|
+
# * Key ARN:
|
|
3717
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
|
3718
|
+
#
|
|
3719
|
+
# To get the key ID and key ARN for a KMS key, use ListKeys or
|
|
3720
|
+
# DescribeKey.
|
|
3721
|
+
# @return [String]
|
|
3722
|
+
#
|
|
3723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyLastUsageRequest AWS API Documentation
|
|
3724
|
+
#
|
|
3725
|
+
class GetKeyLastUsageRequest < Struct.new(
|
|
3726
|
+
:key_id)
|
|
3727
|
+
SENSITIVE = []
|
|
3728
|
+
include Aws::Structure
|
|
3729
|
+
end
|
|
3730
|
+
|
|
3731
|
+
# @!attribute [rw] key_id
|
|
3732
|
+
# The globally unique identifier for the KMS key.
|
|
3733
|
+
# @return [String]
|
|
3734
|
+
#
|
|
3735
|
+
# @!attribute [rw] key_last_usage
|
|
3736
|
+
# Contains usage information about the last time the KMS key was used
|
|
3737
|
+
# for a successful cryptographic operation. If the key has not been
|
|
3738
|
+
# used since tracking began, this response element is an empty object.
|
|
3739
|
+
# @return [Types::KeyLastUsageData]
|
|
3740
|
+
#
|
|
3741
|
+
# @!attribute [rw] tracking_start_date
|
|
3742
|
+
# The date from which KMS began recording cryptographic activity for
|
|
3743
|
+
# this key, or the date the KMS key was created, whichever is later.
|
|
3744
|
+
# @return [Time]
|
|
3745
|
+
#
|
|
3746
|
+
# @!attribute [rw] key_creation_date
|
|
3747
|
+
# The date and time when the KMS key was created.
|
|
3748
|
+
# @return [Time]
|
|
3749
|
+
#
|
|
3750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyLastUsageResponse AWS API Documentation
|
|
3751
|
+
#
|
|
3752
|
+
class GetKeyLastUsageResponse < Struct.new(
|
|
3753
|
+
:key_id,
|
|
3754
|
+
:key_last_usage,
|
|
3755
|
+
:tracking_start_date,
|
|
3756
|
+
:key_creation_date)
|
|
3757
|
+
SENSITIVE = []
|
|
3758
|
+
include Aws::Structure
|
|
3759
|
+
end
|
|
3760
|
+
|
|
3761
|
+
# @!attribute [rw] key_id
|
|
3762
|
+
# Identifies the KMS key whose key policy you want to get.
|
|
3271
3763
|
#
|
|
3272
3764
|
# Specify the key ID or key ARN of the KMS key.
|
|
3273
3765
|
#
|
|
@@ -3284,8 +3776,12 @@ module Aws::KMS
|
|
|
3284
3776
|
#
|
|
3285
3777
|
# @!attribute [rw] policy_name
|
|
3286
3778
|
# Specifies the name of the key policy. If no policy name is
|
|
3287
|
-
# specified, the default value is `default`.
|
|
3288
|
-
# `default`.
|
|
3779
|
+
# specified, the default value is `default`. Valid values are
|
|
3780
|
+
# `default` and `AWS_RAM`. Use `AWS_RAM` to get the key policy that
|
|
3781
|
+
# RAM manages for a KMS key that you share through RAM. If the KMS key
|
|
3782
|
+
# doesn't have an `AWS_RAM` key policy, the request fails with a
|
|
3783
|
+
# `NotFoundException`. To get the names of key policies, use
|
|
3784
|
+
# ListKeyPolicies.
|
|
3289
3785
|
# @return [String]
|
|
3290
3786
|
#
|
|
3291
3787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest AWS API Documentation
|
|
@@ -3302,7 +3798,16 @@ module Aws::KMS
|
|
|
3302
3798
|
# @return [String]
|
|
3303
3799
|
#
|
|
3304
3800
|
# @!attribute [rw] policy_name
|
|
3305
|
-
# The name of the key policy.
|
|
3801
|
+
# The name of the key policy. Valid values are:
|
|
3802
|
+
#
|
|
3803
|
+
# default
|
|
3804
|
+
#
|
|
3805
|
+
# : The key policy that you manage.
|
|
3806
|
+
#
|
|
3807
|
+
# AWS\_RAM
|
|
3808
|
+
#
|
|
3809
|
+
# : The key policy that RAM manages for KMS keys that you share
|
|
3810
|
+
# through RAM.
|
|
3306
3811
|
# @return [String]
|
|
3307
3812
|
#
|
|
3308
3813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyResponse AWS API Documentation
|
|
@@ -3361,15 +3866,12 @@ module Aws::KMS
|
|
|
3361
3866
|
# Identifies the date and time that an in progress on-demand rotation
|
|
3362
3867
|
# was initiated.
|
|
3363
3868
|
#
|
|
3364
|
-
#
|
|
3365
|
-
#
|
|
3366
|
-
#
|
|
3367
|
-
#
|
|
3368
|
-
# ListKeyRotations to view the details of the on-demand
|
|
3369
|
-
#
|
|
3370
|
-
#
|
|
3371
|
-
#
|
|
3372
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html
|
|
3869
|
+
# KMS uses a background process to perform rotations. As a result,
|
|
3870
|
+
# there might be a slight delay between initiating on-demand key
|
|
3871
|
+
# rotation and the rotation's completion. Once the on-demand rotation
|
|
3872
|
+
# is complete, KMS removes this field from the response. You can use
|
|
3873
|
+
# ListKeyRotations to view the details of the completed on-demand
|
|
3874
|
+
# rotation.
|
|
3373
3875
|
# @return [Time]
|
|
3374
3876
|
#
|
|
3375
3877
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusResponse AWS API Documentation
|
|
@@ -3409,9 +3911,8 @@ module Aws::KMS
|
|
|
3409
3911
|
# @!attribute [rw] wrapping_algorithm
|
|
3410
3912
|
# The algorithm you will use with the RSA public key (`PublicKey`) in
|
|
3411
3913
|
# the response to protect your key material during import. For more
|
|
3412
|
-
# information, see [Select a wrapping
|
|
3413
|
-
#
|
|
3414
|
-
# in the *Key Management Service Developer Guide*.
|
|
3914
|
+
# information, see [Select a wrapping algorithm][1] in the *Key
|
|
3915
|
+
# Management Service Developer Guide*.
|
|
3415
3916
|
#
|
|
3416
3917
|
# For RSA\_AES wrapping algorithms, you encrypt your key material with
|
|
3417
3918
|
# an AES key that you generate, then encrypt your AES key with the RSA
|
|
@@ -3443,6 +3944,10 @@ module Aws::KMS
|
|
|
3443
3944
|
#
|
|
3444
3945
|
# * **RSAES\_PKCS1\_V1\_5** (Deprecated) — As of October 10, 2023, KMS
|
|
3445
3946
|
# does not support the RSAES\_PKCS1\_V1\_5 wrapping algorithm.
|
|
3947
|
+
#
|
|
3948
|
+
#
|
|
3949
|
+
#
|
|
3950
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-get-public-key-and-token.html#select-wrapping-algorithm
|
|
3446
3951
|
# @return [String]
|
|
3447
3952
|
#
|
|
3448
3953
|
# @!attribute [rw] wrapping_key_spec
|
|
@@ -3538,7 +4043,7 @@ module Aws::KMS
|
|
|
3538
4043
|
#
|
|
3539
4044
|
#
|
|
3540
4045
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
3541
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4046
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
3542
4047
|
# @return [Array<String>]
|
|
3543
4048
|
#
|
|
3544
4049
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyRequest AWS API Documentation
|
|
@@ -3619,6 +4124,12 @@ module Aws::KMS
|
|
|
3619
4124
|
# `KEY_AGREEMENT`.
|
|
3620
4125
|
# @return [Array<String>]
|
|
3621
4126
|
#
|
|
4127
|
+
# @!attribute [rw] encapsulation_algorithms
|
|
4128
|
+
# The key encapsulation algorithm used to establish a shared secret.
|
|
4129
|
+
# This field is present only when the KMS key has a `KeyUsage` value
|
|
4130
|
+
# of `ENCAPSULATE_DECAPSULATE`.
|
|
4131
|
+
# @return [Array<String>]
|
|
4132
|
+
#
|
|
3622
4133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyResponse AWS API Documentation
|
|
3623
4134
|
#
|
|
3624
4135
|
class GetPublicKeyResponse < Struct.new(
|
|
@@ -3629,43 +4140,56 @@ module Aws::KMS
|
|
|
3629
4140
|
:key_usage,
|
|
3630
4141
|
:encryption_algorithms,
|
|
3631
4142
|
:signing_algorithms,
|
|
3632
|
-
:key_agreement_algorithms
|
|
4143
|
+
:key_agreement_algorithms,
|
|
4144
|
+
:encapsulation_algorithms)
|
|
3633
4145
|
SENSITIVE = []
|
|
3634
4146
|
include Aws::Structure
|
|
3635
4147
|
end
|
|
3636
4148
|
|
|
3637
4149
|
# Use this structure to allow [cryptographic operations][1] in the grant
|
|
3638
|
-
# only when the operation request
|
|
3639
|
-
#
|
|
3640
|
-
#
|
|
3641
|
-
#
|
|
3642
|
-
#
|
|
3643
|
-
#
|
|
3644
|
-
#
|
|
3645
|
-
#
|
|
3646
|
-
#
|
|
3647
|
-
#
|
|
3648
|
-
#
|
|
3649
|
-
#
|
|
3650
|
-
#
|
|
3651
|
-
#
|
|
3652
|
-
#
|
|
3653
|
-
#
|
|
3654
|
-
#
|
|
4150
|
+
# only when the operation request meets the specified constraints.
|
|
4151
|
+
#
|
|
4152
|
+
# KMS supports the following grant constraints:
|
|
4153
|
+
#
|
|
4154
|
+
# * `EncryptionContextEquals` and `EncryptionContextSubset` — These
|
|
4155
|
+
# encryption context constraints apply only to cryptographic
|
|
4156
|
+
# operations that support an encryption context, that is, all
|
|
4157
|
+
# cryptographic operations with a symmetric KMS key. Encryption
|
|
4158
|
+
# context grant constraints are not applied to operations that do not
|
|
4159
|
+
# support an encryption context, such as cryptographic operations with
|
|
4160
|
+
# asymmetric KMS keys and management operations, such as DescribeKey
|
|
4161
|
+
# or RetireGrant.
|
|
4162
|
+
#
|
|
4163
|
+
# In a cryptographic operation, the encryption context in the
|
|
4164
|
+
# decryption operation must be an exact, case-sensitive match for the
|
|
4165
|
+
# keys and values in the encryption context of the encryption
|
|
4166
|
+
# operation. Only the order of the pairs can vary.
|
|
4167
|
+
#
|
|
4168
|
+
# However, in a grant constraint, the key in each key-value pair is
|
|
4169
|
+
# not case sensitive, but the value is case sensitive.
|
|
4170
|
+
#
|
|
4171
|
+
# To avoid confusion, do not use multiple encryption context pairs
|
|
4172
|
+
# that differ only by case. To require a fully case-sensitive
|
|
4173
|
+
# encryption context, use the `kms:EncryptionContext:` and
|
|
4174
|
+
# `kms:EncryptionContextKeys` conditions in an IAM or key policy. For
|
|
4175
|
+
# details, see [kms:EncryptionContext:context-key][2] in the <i>
|
|
4176
|
+
# <i>Key Management Service Developer Guide</i> </i>.
|
|
3655
4177
|
#
|
|
3656
|
-
#
|
|
3657
|
-
#
|
|
3658
|
-
#
|
|
3659
|
-
#
|
|
3660
|
-
#
|
|
3661
|
-
#
|
|
4178
|
+
# * `SourceArn` — This grant constraint allows the permissions in the
|
|
4179
|
+
# grant only when the request is made on behalf of a specific Amazon
|
|
4180
|
+
# Web Services resource, identified by its [Amazon Resource Name
|
|
4181
|
+
# (ARN)][3]. This is effectively the same as having the
|
|
4182
|
+
# [aws:SourceArn][4] global condition key in the grant. The SourceArn
|
|
4183
|
+
# constraint is supported on grants for all types of KMS keys and can
|
|
4184
|
+
# also be applied to the DescribeKey operation when specified in the
|
|
4185
|
+
# request. However, it does not apply to RetireGrant operation.
|
|
3662
4186
|
#
|
|
3663
4187
|
#
|
|
3664
4188
|
#
|
|
3665
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3666
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3667
|
-
# [3]: https://docs.aws.amazon.com/
|
|
3668
|
-
# [4]: https://docs.aws.amazon.com/
|
|
4189
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
4190
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-encryption-context
|
|
4191
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
4192
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn
|
|
3669
4193
|
#
|
|
3670
4194
|
# @!attribute [rw] encryption_context_subset
|
|
3671
4195
|
# A list of key-value pairs that must be included in the encryption
|
|
@@ -3676,7 +4200,7 @@ module Aws::KMS
|
|
|
3676
4200
|
#
|
|
3677
4201
|
#
|
|
3678
4202
|
#
|
|
3679
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4203
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
3680
4204
|
# @return [Hash<String,String>]
|
|
3681
4205
|
#
|
|
3682
4206
|
# @!attribute [rw] encryption_context_equals
|
|
@@ -3687,14 +4211,29 @@ module Aws::KMS
|
|
|
3687
4211
|
#
|
|
3688
4212
|
#
|
|
3689
4213
|
#
|
|
3690
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4214
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
3691
4215
|
# @return [Hash<String,String>]
|
|
3692
4216
|
#
|
|
4217
|
+
# @!attribute [rw] source_arn
|
|
4218
|
+
# The [ Amazon Resource Name (ARN)][1] of an Amazon Web Services
|
|
4219
|
+
# resource on behalf of which the request is made. This is effectively
|
|
4220
|
+
# the same as having the [aws:SourceArn][2] global condition key in
|
|
4221
|
+
# the grant. The SourceArn constraint ensures that the principal can
|
|
4222
|
+
# use the KMS key only when the request is made on behalf of the
|
|
4223
|
+
# specified resource.
|
|
4224
|
+
#
|
|
4225
|
+
#
|
|
4226
|
+
#
|
|
4227
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
4228
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn
|
|
4229
|
+
# @return [String]
|
|
4230
|
+
#
|
|
3693
4231
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantConstraints AWS API Documentation
|
|
3694
4232
|
#
|
|
3695
4233
|
class GrantConstraints < Struct.new(
|
|
3696
4234
|
:encryption_context_subset,
|
|
3697
|
-
:encryption_context_equals
|
|
4235
|
+
:encryption_context_equals,
|
|
4236
|
+
:source_arn)
|
|
3698
4237
|
SENSITIVE = []
|
|
3699
4238
|
include Aws::Structure
|
|
3700
4239
|
end
|
|
@@ -3722,12 +4261,13 @@ module Aws::KMS
|
|
|
3722
4261
|
# @!attribute [rw] grantee_principal
|
|
3723
4262
|
# The identity that gets the permissions in the grant.
|
|
3724
4263
|
#
|
|
3725
|
-
#
|
|
3726
|
-
# contains the user or role designated
|
|
3727
|
-
#
|
|
3728
|
-
# Web Services service, the `GranteePrincipal`
|
|
3729
|
-
# [service principal][1], which
|
|
3730
|
-
# grantee principals
|
|
4264
|
+
# When a grant is created with the `GranteePrincipal` field, the
|
|
4265
|
+
# `ListGrants` response usually contains the user or role designated
|
|
4266
|
+
# as the grantee principal in the grant. However, if the grantee
|
|
4267
|
+
# principal is an Amazon Web Services service, the `GranteePrincipal`
|
|
4268
|
+
# field contains an Amazon Web Services [service principal][1], which
|
|
4269
|
+
# might correspond to several different grantee principals, such as an
|
|
4270
|
+
# IAM user, IAM role, or Amazon Web Services account.
|
|
3731
4271
|
#
|
|
3732
4272
|
#
|
|
3733
4273
|
#
|
|
@@ -3747,10 +4287,28 @@ module Aws::KMS
|
|
|
3747
4287
|
# @return [Array<String>]
|
|
3748
4288
|
#
|
|
3749
4289
|
# @!attribute [rw] constraints
|
|
3750
|
-
#
|
|
3751
|
-
#
|
|
4290
|
+
# The constraints on the grant, such as encryption context pairs or a
|
|
4291
|
+
# SourceArn, that restrict the subsequent operations the grant allows.
|
|
3752
4292
|
# @return [Types::GrantConstraints]
|
|
3753
4293
|
#
|
|
4294
|
+
# @!attribute [rw] grantee_service_principal
|
|
4295
|
+
# The Amazon Web Services [service principal][1] that gets the
|
|
4296
|
+
# permissions in the grant.
|
|
4297
|
+
#
|
|
4298
|
+
#
|
|
4299
|
+
#
|
|
4300
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
|
|
4301
|
+
# @return [String]
|
|
4302
|
+
#
|
|
4303
|
+
# @!attribute [rw] retiring_service_principal
|
|
4304
|
+
# The Amazon Web Services [service principal][1] that can retire the
|
|
4305
|
+
# grant.
|
|
4306
|
+
#
|
|
4307
|
+
#
|
|
4308
|
+
#
|
|
4309
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
|
|
4310
|
+
# @return [String]
|
|
4311
|
+
#
|
|
3754
4312
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantListEntry AWS API Documentation
|
|
3755
4313
|
#
|
|
3756
4314
|
class GrantListEntry < Struct.new(
|
|
@@ -3762,7 +4320,9 @@ module Aws::KMS
|
|
|
3762
4320
|
:retiring_principal,
|
|
3763
4321
|
:issuing_account,
|
|
3764
4322
|
:operations,
|
|
3765
|
-
:constraints
|
|
4323
|
+
:constraints,
|
|
4324
|
+
:grantee_service_principal,
|
|
4325
|
+
:retiring_service_principal)
|
|
3766
4326
|
SENSITIVE = []
|
|
3767
4327
|
include Aws::Structure
|
|
3768
4328
|
end
|
|
@@ -3776,11 +4336,9 @@ module Aws::KMS
|
|
|
3776
4336
|
#
|
|
3777
4337
|
# The KMS key can be a symmetric encryption KMS key, HMAC KMS key,
|
|
3778
4338
|
# asymmetric encryption KMS key, or asymmetric signing KMS key,
|
|
3779
|
-
# including a [multi-Region
|
|
3780
|
-
# key
|
|
3781
|
-
#
|
|
3782
|
-
# in a custom key store, or on a KMS key in a different Amazon Web
|
|
3783
|
-
# Services account.
|
|
4339
|
+
# including a [multi-Region key][1] of any supported type. You cannot
|
|
4340
|
+
# perform this operation on a KMS key in a custom key store, or on a
|
|
4341
|
+
# KMS key in a different Amazon Web Services account.
|
|
3784
4342
|
#
|
|
3785
4343
|
# Specify the key ID or key ARN of the KMS key.
|
|
3786
4344
|
#
|
|
@@ -3793,6 +4351,10 @@ module Aws::KMS
|
|
|
3793
4351
|
#
|
|
3794
4352
|
# To get the key ID and key ARN for a KMS key, use ListKeys or
|
|
3795
4353
|
# DescribeKey.
|
|
4354
|
+
#
|
|
4355
|
+
#
|
|
4356
|
+
#
|
|
4357
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
|
3796
4358
|
# @return [String]
|
|
3797
4359
|
#
|
|
3798
4360
|
# @!attribute [rw] import_token
|
|
@@ -3844,7 +4406,53 @@ module Aws::KMS
|
|
|
3844
4406
|
#
|
|
3845
4407
|
#
|
|
3846
4408
|
#
|
|
3847
|
-
# [1]: https://docs.aws.amazon.com/
|
|
4409
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-expiration
|
|
4410
|
+
# @return [String]
|
|
4411
|
+
#
|
|
4412
|
+
# @!attribute [rw] import_type
|
|
4413
|
+
# Indicates whether the key material being imported is previously
|
|
4414
|
+
# associated with this KMS key or not. This parameter is optional and
|
|
4415
|
+
# only usable with symmetric encryption keys. If no key material has
|
|
4416
|
+
# ever been imported into the KMS key, and this parameter is omitted,
|
|
4417
|
+
# the parameter defaults to `NEW_KEY_MATERIAL`. After the first key
|
|
4418
|
+
# material is imported, if this parameter is omitted then the
|
|
4419
|
+
# parameter defaults to `EXISTING_KEY_MATERIAL`.
|
|
4420
|
+
#
|
|
4421
|
+
# For multi-Region keys, you must first import new key material into
|
|
4422
|
+
# the primary Region key. You should use the `NEW_KEY_MATERIAL` import
|
|
4423
|
+
# type when importing key material into the primary Region key. Then,
|
|
4424
|
+
# you can import the same key material into the replica Region key.
|
|
4425
|
+
# The import type for the replica Region key should be
|
|
4426
|
+
# `EXISTING_KEY_MATERIAL`.
|
|
4427
|
+
# @return [String]
|
|
4428
|
+
#
|
|
4429
|
+
# @!attribute [rw] key_material_description
|
|
4430
|
+
# Description for the key material being imported. This parameter is
|
|
4431
|
+
# optional and only usable with symmetric encryption keys. If you do
|
|
4432
|
+
# not specify a key material description, KMS retains the value you
|
|
4433
|
+
# specified when you last imported the same key material into this KMS
|
|
4434
|
+
# key.
|
|
4435
|
+
# @return [String]
|
|
4436
|
+
#
|
|
4437
|
+
# @!attribute [rw] key_material_id
|
|
4438
|
+
# Identifies the key material being imported. This parameter is
|
|
4439
|
+
# optional and only usable with symmetric encryption keys. You cannot
|
|
4440
|
+
# specify a key material ID with `ImportType` set to
|
|
4441
|
+
# `NEW_KEY_MATERIAL`. Whenever you import key material into a
|
|
4442
|
+
# symmetric encryption key, KMS assigns a unique identifier to the key
|
|
4443
|
+
# material based on the KMS key ID and the imported key material. When
|
|
4444
|
+
# you re-import key material with a specified key material ID, KMS:
|
|
4445
|
+
#
|
|
4446
|
+
# * Computes the identifier for the key material
|
|
4447
|
+
#
|
|
4448
|
+
# * Matches the computed identifier against the specified key material
|
|
4449
|
+
# ID
|
|
4450
|
+
#
|
|
4451
|
+
# * Verifies that the key material ID is already associated with the
|
|
4452
|
+
# KMS key
|
|
4453
|
+
#
|
|
4454
|
+
# To get the list of key material IDs associated with a KMS key, use
|
|
4455
|
+
# ListKeyRotations.
|
|
3848
4456
|
# @return [String]
|
|
3849
4457
|
#
|
|
3850
4458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialRequest AWS API Documentation
|
|
@@ -3854,14 +4462,35 @@ module Aws::KMS
|
|
|
3854
4462
|
:import_token,
|
|
3855
4463
|
:encrypted_key_material,
|
|
3856
4464
|
:valid_to,
|
|
3857
|
-
:expiration_model
|
|
4465
|
+
:expiration_model,
|
|
4466
|
+
:import_type,
|
|
4467
|
+
:key_material_description,
|
|
4468
|
+
:key_material_id)
|
|
3858
4469
|
SENSITIVE = []
|
|
3859
4470
|
include Aws::Structure
|
|
3860
4471
|
end
|
|
3861
4472
|
|
|
4473
|
+
# @!attribute [rw] key_id
|
|
4474
|
+
# The Amazon Resource Name ([key ARN][1]) of the KMS key into which
|
|
4475
|
+
# key material was imported.
|
|
4476
|
+
#
|
|
4477
|
+
#
|
|
4478
|
+
#
|
|
4479
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
|
4480
|
+
# @return [String]
|
|
4481
|
+
#
|
|
4482
|
+
# @!attribute [rw] key_material_id
|
|
4483
|
+
# Identifies the imported key material.
|
|
4484
|
+
# @return [String]
|
|
4485
|
+
#
|
|
3862
4486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialResponse AWS API Documentation
|
|
3863
4487
|
#
|
|
3864
|
-
class ImportKeyMaterialResponse <
|
|
4488
|
+
class ImportKeyMaterialResponse < Struct.new(
|
|
4489
|
+
:key_id,
|
|
4490
|
+
:key_material_id)
|
|
4491
|
+
SENSITIVE = []
|
|
4492
|
+
include Aws::Structure
|
|
4493
|
+
end
|
|
3865
4494
|
|
|
3866
4495
|
# The request was rejected because the specified KMS key cannot decrypt
|
|
3867
4496
|
# the data. The `KeyId` in a Decrypt request and the `SourceKeyId` in a
|
|
@@ -3880,8 +4509,10 @@ module Aws::KMS
|
|
|
3880
4509
|
end
|
|
3881
4510
|
|
|
3882
4511
|
# The request was rejected because the key material in the request is,
|
|
3883
|
-
# expired, invalid, or
|
|
3884
|
-
# imported
|
|
4512
|
+
# expired, invalid, or does not meet expectations. For example, it is
|
|
4513
|
+
# not the same key material that was previously imported or KMS expected
|
|
4514
|
+
# new key material but the key material being imported is already
|
|
4515
|
+
# associated with the KMS key.
|
|
3885
4516
|
#
|
|
3886
4517
|
# @!attribute [rw] message
|
|
3887
4518
|
# @return [String]
|
|
@@ -3952,6 +4583,10 @@ module Aws::KMS
|
|
|
3952
4583
|
# From the ImportKeyMaterial operation, the request was rejected because
|
|
3953
4584
|
# KMS could not decrypt the encrypted (wrapped) key material.
|
|
3954
4585
|
#
|
|
4586
|
+
# From the Decapsulate operation, the request was rejected because the
|
|
4587
|
+
# length of the `SharedSecretCiphertextBlob` is inconsistent with the
|
|
4588
|
+
# specified ML-KEM key spec.
|
|
4589
|
+
#
|
|
3955
4590
|
# @!attribute [rw] message
|
|
3956
4591
|
# @return [String]
|
|
3957
4592
|
#
|
|
@@ -4018,8 +4653,10 @@ module Aws::KMS
|
|
|
4018
4653
|
# messages, the `KeyUsage` must be `SIGN_VERIFY`. For generating and
|
|
4019
4654
|
# verifying message authentication codes (MACs), the `KeyUsage` must be
|
|
4020
4655
|
# `GENERATE_VERIFY_MAC`. For deriving key agreement secrets, the
|
|
4021
|
-
# `KeyUsage` must be `KEY_AGREEMENT`.
|
|
4022
|
-
#
|
|
4656
|
+
# `KeyUsage` must be `KEY_AGREEMENT`. For encapsulating and
|
|
4657
|
+
# decapsulating shared secrets, the `KeyUsage` must be
|
|
4658
|
+
# `ENCAPSULATE_DECAPSULATE`. To find the `KeyUsage` of a KMS key, use
|
|
4659
|
+
# the DescribeKey operation.
|
|
4023
4660
|
#
|
|
4024
4661
|
# To find the encryption or signing algorithms supported for a
|
|
4025
4662
|
# particular KMS key, use the DescribeKey operation.
|
|
@@ -4127,6 +4764,43 @@ module Aws::KMS
|
|
|
4127
4764
|
include Aws::Structure
|
|
4128
4765
|
end
|
|
4129
4766
|
|
|
4767
|
+
# Contains usage information about the last time the KMS key was used
|
|
4768
|
+
# for a successful cryptographic operation.
|
|
4769
|
+
#
|
|
4770
|
+
# @!attribute [rw] operation
|
|
4771
|
+
# The last successful cryptographic operation the KMS key was used
|
|
4772
|
+
# for. Absent if the key has not been used since KMS began tracking.
|
|
4773
|
+
# @return [String]
|
|
4774
|
+
#
|
|
4775
|
+
# @!attribute [rw] timestamp
|
|
4776
|
+
# The date and time when the KMS key was most recently used for a
|
|
4777
|
+
# successful cryptographic operation. Absent if the key has not been
|
|
4778
|
+
# used since KMS began tracking.
|
|
4779
|
+
# @return [Time]
|
|
4780
|
+
#
|
|
4781
|
+
# @!attribute [rw] cloud_trail_event_id
|
|
4782
|
+
# The CloudTrail `eventId` associated with the last successful
|
|
4783
|
+
# cryptographic operation. Absent if the key has not been used since
|
|
4784
|
+
# KMS began tracking.
|
|
4785
|
+
# @return [String]
|
|
4786
|
+
#
|
|
4787
|
+
# @!attribute [rw] kms_request_id
|
|
4788
|
+
# The KMS request ID associated with the last successful cryptographic
|
|
4789
|
+
# operation. Absent if the key has not been used since KMS began
|
|
4790
|
+
# tracking.
|
|
4791
|
+
# @return [String]
|
|
4792
|
+
#
|
|
4793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyLastUsageData AWS API Documentation
|
|
4794
|
+
#
|
|
4795
|
+
class KeyLastUsageData < Struct.new(
|
|
4796
|
+
:operation,
|
|
4797
|
+
:timestamp,
|
|
4798
|
+
:cloud_trail_event_id,
|
|
4799
|
+
:kms_request_id)
|
|
4800
|
+
SENSITIVE = []
|
|
4801
|
+
include Aws::Structure
|
|
4802
|
+
end
|
|
4803
|
+
|
|
4130
4804
|
# Contains information about each entry in the key list.
|
|
4131
4805
|
#
|
|
4132
4806
|
# @!attribute [rw] key_id
|
|
@@ -4188,7 +4862,7 @@ module Aws::KMS
|
|
|
4188
4862
|
#
|
|
4189
4863
|
#
|
|
4190
4864
|
#
|
|
4191
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4865
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations
|
|
4192
4866
|
# @return [String]
|
|
4193
4867
|
#
|
|
4194
4868
|
# @!attribute [rw] key_state
|
|
@@ -4215,11 +4889,12 @@ module Aws::KMS
|
|
|
4215
4889
|
# @return [Time]
|
|
4216
4890
|
#
|
|
4217
4891
|
# @!attribute [rw] valid_to
|
|
4218
|
-
# The time at which
|
|
4219
|
-
#
|
|
4220
|
-
#
|
|
4221
|
-
# `Origin` is `EXTERNAL` and
|
|
4222
|
-
# `KEY_MATERIAL_EXPIRES`, otherwise this
|
|
4892
|
+
# The earliest time at which any imported key material permanently
|
|
4893
|
+
# associated with this KMS key expires. When a key material expires,
|
|
4894
|
+
# KMS deletes the key material and the KMS key becomes unusable. This
|
|
4895
|
+
# value is present only for KMS keys whose `Origin` is `EXTERNAL` and
|
|
4896
|
+
# the `ExpirationModel` is `KEY_MATERIAL_EXPIRES`, otherwise this
|
|
4897
|
+
# value is omitted.
|
|
4223
4898
|
# @return [Time]
|
|
4224
4899
|
#
|
|
4225
4900
|
# @!attribute [rw] origin
|
|
@@ -4238,7 +4913,7 @@ module Aws::KMS
|
|
|
4238
4913
|
#
|
|
4239
4914
|
#
|
|
4240
4915
|
#
|
|
4241
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4916
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
4242
4917
|
# @return [String]
|
|
4243
4918
|
#
|
|
4244
4919
|
# @!attribute [rw] cloud_hsm_cluster_id
|
|
@@ -4250,7 +4925,7 @@ module Aws::KMS
|
|
|
4250
4925
|
#
|
|
4251
4926
|
#
|
|
4252
4927
|
#
|
|
4253
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4928
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
4254
4929
|
# @return [String]
|
|
4255
4930
|
#
|
|
4256
4931
|
# @!attribute [rw] expiration_model
|
|
@@ -4302,6 +4977,12 @@ module Aws::KMS
|
|
|
4302
4977
|
# The key agreement algorithm used to derive a shared secret.
|
|
4303
4978
|
# @return [Array<String>]
|
|
4304
4979
|
#
|
|
4980
|
+
# @!attribute [rw] encapsulation_algorithms
|
|
4981
|
+
# The key encapsulation algorithm that the KMS key supports. This
|
|
4982
|
+
# field appears only for KMS keys with a `KeyUsage` value of
|
|
4983
|
+
# `ENCAPSULATE_DECAPSULATE`.
|
|
4984
|
+
# @return [Array<String>]
|
|
4985
|
+
#
|
|
4305
4986
|
# @!attribute [rw] multi_region
|
|
4306
4987
|
# Indicates whether the KMS key is a multi-Region (`True`) or regional
|
|
4307
4988
|
# (`False`) key. This value is `True` for multi-Region primary and
|
|
@@ -4373,6 +5054,15 @@ module Aws::KMS
|
|
|
4373
5054
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
|
|
4374
5055
|
# @return [Types::XksKeyConfigurationType]
|
|
4375
5056
|
#
|
|
5057
|
+
# @!attribute [rw] current_key_material_id
|
|
5058
|
+
# Identifies the current key material. This value is present for
|
|
5059
|
+
# symmetric encryption keys with `AWS_KMS` or `EXTERNAL` origin. These
|
|
5060
|
+
# KMS keys support automatic or on-demand key rotation and can have
|
|
5061
|
+
# multiple key materials associated with them. KMS uses the current
|
|
5062
|
+
# key material for both encryption and decryption, and the non-current
|
|
5063
|
+
# key material for decryption operations only.
|
|
5064
|
+
# @return [String]
|
|
5065
|
+
#
|
|
4376
5066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata AWS API Documentation
|
|
4377
5067
|
#
|
|
4378
5068
|
class KeyMetadata < Struct.new(
|
|
@@ -4396,11 +5086,13 @@ module Aws::KMS
|
|
|
4396
5086
|
:encryption_algorithms,
|
|
4397
5087
|
:signing_algorithms,
|
|
4398
5088
|
:key_agreement_algorithms,
|
|
5089
|
+
:encapsulation_algorithms,
|
|
4399
5090
|
:multi_region,
|
|
4400
5091
|
:multi_region_configuration,
|
|
4401
5092
|
:pending_deletion_window_in_days,
|
|
4402
5093
|
:mac_algorithms,
|
|
4403
|
-
:xks_key_configuration
|
|
5094
|
+
:xks_key_configuration,
|
|
5095
|
+
:current_key_material_id)
|
|
4404
5096
|
SENSITIVE = []
|
|
4405
5097
|
include Aws::Structure
|
|
4406
5098
|
end
|
|
@@ -4419,9 +5111,9 @@ module Aws::KMS
|
|
|
4419
5111
|
include Aws::Structure
|
|
4420
5112
|
end
|
|
4421
5113
|
|
|
4422
|
-
# The request was rejected because a
|
|
4423
|
-
# information, see [Quotas][1] in the *Key Management
|
|
4424
|
-
# Guide*.
|
|
5114
|
+
# The request was rejected because a length constraint or quota was
|
|
5115
|
+
# exceeded. For more information, see [Quotas][1] in the *Key Management
|
|
5116
|
+
# Service Developer Guide*.
|
|
4425
5117
|
#
|
|
4426
5118
|
#
|
|
4427
5119
|
#
|
|
@@ -4553,6 +5245,18 @@ module Aws::KMS
|
|
|
4553
5245
|
# @!attribute [rw] grantee_principal
|
|
4554
5246
|
# Returns only grants where the specified principal is the grantee
|
|
4555
5247
|
# principal for the grant.
|
|
5248
|
+
#
|
|
5249
|
+
# You can specify either `GranteePrincipal` or
|
|
5250
|
+
# `GranteeServicePrincipal`, but not both.
|
|
5251
|
+
# @return [String]
|
|
5252
|
+
#
|
|
5253
|
+
# @!attribute [rw] grantee_service_principal
|
|
5254
|
+
# Returns only grants where the specified Amazon Web Services service
|
|
5255
|
+
# principal is the grantee service principal for the grant. This
|
|
5256
|
+
# filter is only usable by callers in a service principal.
|
|
5257
|
+
#
|
|
5258
|
+
# You can specify either `GranteePrincipal` or
|
|
5259
|
+
# `GranteeServicePrincipal`, but not both.
|
|
4556
5260
|
# @return [String]
|
|
4557
5261
|
#
|
|
4558
5262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest AWS API Documentation
|
|
@@ -4562,7 +5266,8 @@ module Aws::KMS
|
|
|
4562
5266
|
:marker,
|
|
4563
5267
|
:key_id,
|
|
4564
5268
|
:grant_id,
|
|
4565
|
-
:grantee_principal
|
|
5269
|
+
:grantee_principal,
|
|
5270
|
+
:grantee_service_principal)
|
|
4566
5271
|
SENSITIVE = []
|
|
4567
5272
|
include Aws::Structure
|
|
4568
5273
|
end
|
|
@@ -4618,7 +5323,8 @@ module Aws::KMS
|
|
|
4618
5323
|
# and 1000, inclusive. If you do not include a value, it defaults to
|
|
4619
5324
|
# 100.
|
|
4620
5325
|
#
|
|
4621
|
-
#
|
|
5326
|
+
# A KMS key can have at most two key policies, `default` and
|
|
5327
|
+
# `AWS_RAM`.
|
|
4622
5328
|
# @return [Integer]
|
|
4623
5329
|
#
|
|
4624
5330
|
# @!attribute [rw] marker
|
|
@@ -4638,7 +5344,16 @@ module Aws::KMS
|
|
|
4638
5344
|
end
|
|
4639
5345
|
|
|
4640
5346
|
# @!attribute [rw] policy_names
|
|
4641
|
-
# A list of key policy names.
|
|
5347
|
+
# A list of key policy names. Valid values are:
|
|
5348
|
+
#
|
|
5349
|
+
# default
|
|
5350
|
+
#
|
|
5351
|
+
# : The key policy that you manage.
|
|
5352
|
+
#
|
|
5353
|
+
# AWS\_RAM
|
|
5354
|
+
#
|
|
5355
|
+
# : The key policy that RAM manages for KMS keys that you share
|
|
5356
|
+
# through RAM.
|
|
4642
5357
|
# @return [Array<String>]
|
|
4643
5358
|
#
|
|
4644
5359
|
# @!attribute [rw] next_marker
|
|
@@ -4679,6 +5394,18 @@ module Aws::KMS
|
|
|
4679
5394
|
# DescribeKey.
|
|
4680
5395
|
# @return [String]
|
|
4681
5396
|
#
|
|
5397
|
+
# @!attribute [rw] include_key_material
|
|
5398
|
+
# Use this optional parameter to control which key materials
|
|
5399
|
+
# associated with this key are listed in the response. The default
|
|
5400
|
+
# value of this parameter is `ROTATIONS_ONLY`. If you omit this
|
|
5401
|
+
# parameter, KMS returns information on the key materials created by
|
|
5402
|
+
# automatic or on-demand key rotation. When you specify a value of
|
|
5403
|
+
# `ALL_KEY_MATERIAL`, KMS adds the first key material and any imported
|
|
5404
|
+
# key material pending rotation to the response. This parameter can
|
|
5405
|
+
# only be used with KMS keys that support automatic or on-demand key
|
|
5406
|
+
# rotation.
|
|
5407
|
+
# @return [String]
|
|
5408
|
+
#
|
|
4682
5409
|
# @!attribute [rw] limit
|
|
4683
5410
|
# Use this parameter to specify the maximum number of items to return.
|
|
4684
5411
|
# When this value is present, KMS does not return more than the
|
|
@@ -4699,6 +5426,7 @@ module Aws::KMS
|
|
|
4699
5426
|
#
|
|
4700
5427
|
class ListKeyRotationsRequest < Struct.new(
|
|
4701
5428
|
:key_id,
|
|
5429
|
+
:include_key_material,
|
|
4702
5430
|
:limit,
|
|
4703
5431
|
:marker)
|
|
4704
5432
|
SENSITIVE = []
|
|
@@ -4706,7 +5434,10 @@ module Aws::KMS
|
|
|
4706
5434
|
end
|
|
4707
5435
|
|
|
4708
5436
|
# @!attribute [rw] rotations
|
|
4709
|
-
# A list of completed key material rotations.
|
|
5437
|
+
# A list of completed key material rotations. When the optional input
|
|
5438
|
+
# parameter `IncludeKeyMaterial` is specified with a value of
|
|
5439
|
+
# `ALL_KEY_MATERIAL`, this list includes the first key material and
|
|
5440
|
+
# any imported key material pending rotation.
|
|
4710
5441
|
# @return [Array<Types::RotationsListEntry>]
|
|
4711
5442
|
#
|
|
4712
5443
|
# @!attribute [rw] next_marker
|
|
@@ -4747,17 +5478,61 @@ module Aws::KMS
|
|
|
4747
5478
|
# from the truncated response you just received.
|
|
4748
5479
|
# @return [String]
|
|
4749
5480
|
#
|
|
5481
|
+
# @!attribute [rw] resource_owners
|
|
5482
|
+
# Specifies whose KMS keys to list. Use this parameter to list KMS
|
|
5483
|
+
# keys that other Amazon Web Services accounts shared with your Amazon
|
|
5484
|
+
# Web Services account through Resource Access Manager (RAM).
|
|
5485
|
+
#
|
|
5486
|
+
# Specify one or two values. Valid values are:
|
|
5487
|
+
#
|
|
5488
|
+
# SELF
|
|
5489
|
+
#
|
|
5490
|
+
# : Lists the KMS keys in your Amazon Web Services account and Region.
|
|
5491
|
+
#
|
|
5492
|
+
# OTHER\_ACCOUNTS\_VIA\_RAM
|
|
5493
|
+
#
|
|
5494
|
+
# : Lists the KMS keys in the Region that other Amazon Web Services
|
|
5495
|
+
# accounts currently share with your Amazon Web Services account
|
|
5496
|
+
# through RAM. This list doesn't include KMS keys that your Amazon
|
|
5497
|
+
# Web Services account owns. For each of these KMS keys, the key ARN
|
|
5498
|
+
# in the response contains the account ID of the Amazon Web Services
|
|
5499
|
+
# account that owns the KMS key.
|
|
5500
|
+
#
|
|
5501
|
+
# If you omit this parameter, `ListKeys` lists only the KMS keys in
|
|
5502
|
+
# your Amazon Web Services account. If you specify both values, in
|
|
5503
|
+
# either order, `ListKeys` returns the KMS keys in your Amazon Web
|
|
5504
|
+
# Services account first, and then the KMS keys that other Amazon Web
|
|
5505
|
+
# Services accounts shared with you. A single response doesn't
|
|
5506
|
+
# contain both kinds of KMS keys.
|
|
5507
|
+
#
|
|
5508
|
+
# When `ResourceOwners` includes `OTHER_ACCOUNTS_VIA_RAM`, a response
|
|
5509
|
+
# can contain fewer KMS keys than the `Limit` value, or none, even
|
|
5510
|
+
# when `Truncated` is true. To get all of the KMS keys, continue
|
|
5511
|
+
# calling `ListKeys` with the `NextMarker` value from each response
|
|
5512
|
+
# until `Truncated` is false. Use a `NextMarker` value only in a
|
|
5513
|
+
# request that has the same `ResourceOwners` value as the request that
|
|
5514
|
+
# returned it. Otherwise, the request can fail with an
|
|
5515
|
+
# `InvalidMarkerException`.
|
|
5516
|
+
#
|
|
5517
|
+
# KMS keys that other Amazon Web Services accounts share with you can
|
|
5518
|
+
# take some time to appear in or disappear from the results after
|
|
5519
|
+
# changes to resource shares.
|
|
5520
|
+
# @return [Array<String>]
|
|
5521
|
+
#
|
|
4750
5522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysRequest AWS API Documentation
|
|
4751
5523
|
#
|
|
4752
5524
|
class ListKeysRequest < Struct.new(
|
|
4753
5525
|
:limit,
|
|
4754
|
-
:marker
|
|
5526
|
+
:marker,
|
|
5527
|
+
:resource_owners)
|
|
4755
5528
|
SENSITIVE = []
|
|
4756
5529
|
include Aws::Structure
|
|
4757
5530
|
end
|
|
4758
5531
|
|
|
4759
5532
|
# @!attribute [rw] keys
|
|
4760
|
-
# A list of KMS keys.
|
|
5533
|
+
# A list of KMS keys. For a KMS key that another Amazon Web Services
|
|
5534
|
+
# account shared with you through RAM, the key ARN contains the
|
|
5535
|
+
# account ID of the Amazon Web Services account that owns the KMS key.
|
|
4761
5536
|
# @return [Array<Types::KeyListEntry>]
|
|
4762
5537
|
#
|
|
4763
5538
|
# @!attribute [rw] next_marker
|
|
@@ -4891,18 +5666,30 @@ module Aws::KMS
|
|
|
4891
5666
|
# syntax for a principal, see [IAM ARNs][2] in the <i> <i>Identity and
|
|
4892
5667
|
# Access Management User Guide</i> </i>.
|
|
4893
5668
|
#
|
|
5669
|
+
# You must specify either `RetiringPrincipal` or
|
|
5670
|
+
# `RetiringServicePrincipal`, but not both.
|
|
5671
|
+
#
|
|
4894
5672
|
#
|
|
4895
5673
|
#
|
|
4896
5674
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
4897
5675
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
|
|
4898
5676
|
# @return [String]
|
|
4899
5677
|
#
|
|
5678
|
+
# @!attribute [rw] retiring_service_principal
|
|
5679
|
+
# The retiring service principal for which to list grants. This filter
|
|
5680
|
+
# is only usable by callers in a service principal.
|
|
5681
|
+
#
|
|
5682
|
+
# You must specify either `RetiringPrincipal` or
|
|
5683
|
+
# `RetiringServicePrincipal`, but not both.
|
|
5684
|
+
# @return [String]
|
|
5685
|
+
#
|
|
4900
5686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrantsRequest AWS API Documentation
|
|
4901
5687
|
#
|
|
4902
5688
|
class ListRetirableGrantsRequest < Struct.new(
|
|
4903
5689
|
:limit,
|
|
4904
5690
|
:marker,
|
|
4905
|
-
:retiring_principal
|
|
5691
|
+
:retiring_principal,
|
|
5692
|
+
:retiring_service_principal)
|
|
4906
5693
|
SENSITIVE = []
|
|
4907
5694
|
include Aws::Structure
|
|
4908
5695
|
end
|
|
@@ -5005,7 +5792,12 @@ module Aws::KMS
|
|
|
5005
5792
|
#
|
|
5006
5793
|
# @!attribute [rw] policy_name
|
|
5007
5794
|
# The name of the key policy. If no policy name is specified, the
|
|
5008
|
-
# default value is `default`.
|
|
5795
|
+
# default value is `default`. Valid values are `default` and
|
|
5796
|
+
# `AWS_RAM`, but you can set only the `default` key policy. RAM
|
|
5797
|
+
# manages the `AWS_RAM` key policy for KMS keys that you share through
|
|
5798
|
+
# RAM. If you specify `AWS_RAM`, the request fails with a
|
|
5799
|
+
# `ValidationException`, or with an `AccessDeniedException` if you
|
|
5800
|
+
# don't have permission to call `PutKeyPolicy` with that policy name.
|
|
5009
5801
|
# @return [String]
|
|
5010
5802
|
#
|
|
5011
5803
|
# @!attribute [rw] policy
|
|
@@ -5029,6 +5821,18 @@ module Aws::KMS
|
|
|
5029
5821
|
# that I make are not always immediately visible][2] in the *Amazon
|
|
5030
5822
|
# Web Services Identity and Access Management User Guide*.
|
|
5031
5823
|
#
|
|
5824
|
+
# <note markdown="1"> If either of the required `Resource` or `Action` elements are
|
|
5825
|
+
# missing from a key policy statement, the policy statement has no
|
|
5826
|
+
# effect. When a key policy statement is missing one of these
|
|
5827
|
+
# elements, the KMS console correctly reports an error, but the
|
|
5828
|
+
# `PutKeyPolicy` API request succeeds, even though the policy
|
|
5829
|
+
# statement is ineffective.
|
|
5830
|
+
#
|
|
5831
|
+
# For more information on required key policy elements, see [Elements
|
|
5832
|
+
# in a key policy][3] in the *Key Management Service Developer Guide*.
|
|
5833
|
+
#
|
|
5834
|
+
# </note>
|
|
5835
|
+
#
|
|
5032
5836
|
# A key policy document can include only the following characters:
|
|
5033
5837
|
#
|
|
5034
5838
|
# * Printable ASCII characters from the space character (`\u0020`)
|
|
@@ -5040,18 +5844,24 @@ module Aws::KMS
|
|
|
5040
5844
|
# * The tab (`\u0009`), line feed (`\u000A`), and carriage return
|
|
5041
5845
|
# (`\u000D`) special characters
|
|
5042
5846
|
#
|
|
5043
|
-
#
|
|
5847
|
+
# <note markdown="1"> If the key policy exceeds the length constraint, KMS returns a
|
|
5848
|
+
# `LimitExceededException`.
|
|
5849
|
+
#
|
|
5850
|
+
# </note>
|
|
5851
|
+
#
|
|
5852
|
+
# For information about key policies, see [Key policies in KMS][4] in
|
|
5044
5853
|
# the *Key Management Service Developer Guide*.For help writing and
|
|
5045
5854
|
# formatting a JSON policy document, see the [IAM JSON Policy
|
|
5046
|
-
# Reference][
|
|
5855
|
+
# Reference][5] in the <i> <i>Identity and Access Management User
|
|
5047
5856
|
# Guide</i> </i>.
|
|
5048
5857
|
#
|
|
5049
5858
|
#
|
|
5050
5859
|
#
|
|
5051
5860
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
|
5052
5861
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
|
|
5053
|
-
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-
|
|
5054
|
-
# [4]: https://docs.aws.amazon.com/
|
|
5862
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-overview.html#key-policy-elements
|
|
5863
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
|
5864
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
|
|
5055
5865
|
# @return [String]
|
|
5056
5866
|
#
|
|
5057
5867
|
# @!attribute [rw] bypass_policy_lockout_safety_check
|
|
@@ -5069,6 +5879,12 @@ module Aws::KMS
|
|
|
5069
5879
|
# that is making the request from making a subsequent
|
|
5070
5880
|
# [PutKeyPolicy][2] request on the KMS key.
|
|
5071
5881
|
#
|
|
5882
|
+
# The key policy lockout safety check and the
|
|
5883
|
+
# `BypassPolicyLockoutSafetyCheck` parameter apply only to the
|
|
5884
|
+
# `default` key policy. The check evaluates only the new `default` key
|
|
5885
|
+
# policy, with `kms:PolicyName` set to `default`. It doesn't consider
|
|
5886
|
+
# permissions in the `AWS_RAM` key policy.
|
|
5887
|
+
#
|
|
5072
5888
|
#
|
|
5073
5889
|
#
|
|
5074
5890
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
|
@@ -5088,6 +5904,9 @@ module Aws::KMS
|
|
|
5088
5904
|
|
|
5089
5905
|
# @!attribute [rw] ciphertext_blob
|
|
5090
5906
|
# Ciphertext of the data to reencrypt.
|
|
5907
|
+
#
|
|
5908
|
+
# This parameter is required in all cases except when `DryRun` is
|
|
5909
|
+
# `true` and `DryRunModifiers` is set to `IGNORE_CIPHERTEXT`.
|
|
5091
5910
|
# @return [String]
|
|
5092
5911
|
#
|
|
5093
5912
|
# @!attribute [rw] source_encryption_context
|
|
@@ -5109,7 +5928,7 @@ module Aws::KMS
|
|
|
5109
5928
|
#
|
|
5110
5929
|
#
|
|
5111
5930
|
#
|
|
5112
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
5931
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
5113
5932
|
# @return [Hash<String,String>]
|
|
5114
5933
|
#
|
|
5115
5934
|
# @!attribute [rw] source_key_id
|
|
@@ -5121,15 +5940,16 @@ module Aws::KMS
|
|
|
5121
5940
|
# operation throws an `IncorrectKeyException`.
|
|
5122
5941
|
#
|
|
5123
5942
|
# This parameter is required only when the ciphertext was encrypted
|
|
5124
|
-
# under an asymmetric KMS key
|
|
5125
|
-
#
|
|
5126
|
-
# symmetric
|
|
5127
|
-
#
|
|
5128
|
-
# you
|
|
5943
|
+
# under an asymmetric KMS key or when `DryRun` is `true` and
|
|
5944
|
+
# `DryRunModifiers` is set to `IGNORE_CIPHERTEXT`. If you used a
|
|
5945
|
+
# symmetric encryption KMS key, KMS can get the KMS key from metadata
|
|
5946
|
+
# that it adds to the symmetric ciphertext blob. However, it is always
|
|
5947
|
+
# recommended as a best practice. This practice ensures that you use
|
|
5948
|
+
# the KMS key that you intend.
|
|
5129
5949
|
#
|
|
5130
5950
|
# To specify a KMS key, use its key ID, key ARN, alias name, or alias
|
|
5131
5951
|
# ARN. When using an alias name, prefix it with `"alias/"`. To specify
|
|
5132
|
-
# a KMS key in a different Amazon Web Services account, you
|
|
5952
|
+
# a KMS key in a different Amazon Web Services account, you should use
|
|
5133
5953
|
# the key ARN or alias ARN.
|
|
5134
5954
|
#
|
|
5135
5955
|
# For example:
|
|
@@ -5199,7 +6019,7 @@ module Aws::KMS
|
|
|
5199
6019
|
#
|
|
5200
6020
|
#
|
|
5201
6021
|
#
|
|
5202
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6022
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html
|
|
5203
6023
|
# @return [Hash<String,String>]
|
|
5204
6024
|
#
|
|
5205
6025
|
# @!attribute [rw] source_encryption_algorithm
|
|
@@ -5236,21 +6056,38 @@ module Aws::KMS
|
|
|
5236
6056
|
#
|
|
5237
6057
|
#
|
|
5238
6058
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
5239
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6059
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
5240
6060
|
# @return [Array<String>]
|
|
5241
6061
|
#
|
|
5242
6062
|
# @!attribute [rw] dry_run
|
|
5243
6063
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
5244
6064
|
# parameter.
|
|
5245
6065
|
#
|
|
5246
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
5247
|
-
#
|
|
6066
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
6067
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
5248
6068
|
#
|
|
5249
6069
|
#
|
|
5250
6070
|
#
|
|
5251
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6071
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
5252
6072
|
# @return [Boolean]
|
|
5253
6073
|
#
|
|
6074
|
+
# @!attribute [rw] dry_run_modifiers
|
|
6075
|
+
# Specifies the modifiers to apply to the dry run operation.
|
|
6076
|
+
# `DryRunModifiers` is an optional parameter that only applies when
|
|
6077
|
+
# `DryRun` is set to `true`.
|
|
6078
|
+
#
|
|
6079
|
+
# When set to `IGNORE_CIPHERTEXT`, KMS performs only authorization
|
|
6080
|
+
# validation without ciphertext validation. This allows you to test
|
|
6081
|
+
# permissions without requiring a valid ciphertext blob.
|
|
6082
|
+
#
|
|
6083
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
6084
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
6085
|
+
#
|
|
6086
|
+
#
|
|
6087
|
+
#
|
|
6088
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
6089
|
+
# @return [Array<String>]
|
|
6090
|
+
#
|
|
5254
6091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest AWS API Documentation
|
|
5255
6092
|
#
|
|
5256
6093
|
class ReEncryptRequest < Struct.new(
|
|
@@ -5262,7 +6099,8 @@ module Aws::KMS
|
|
|
5262
6099
|
:source_encryption_algorithm,
|
|
5263
6100
|
:destination_encryption_algorithm,
|
|
5264
6101
|
:grant_tokens,
|
|
5265
|
-
:dry_run
|
|
6102
|
+
:dry_run,
|
|
6103
|
+
:dry_run_modifiers)
|
|
5266
6104
|
SENSITIVE = []
|
|
5267
6105
|
include Aws::Structure
|
|
5268
6106
|
end
|
|
@@ -5296,6 +6134,18 @@ module Aws::KMS
|
|
|
5296
6134
|
# The encryption algorithm that was used to reencrypt the data.
|
|
5297
6135
|
# @return [String]
|
|
5298
6136
|
#
|
|
6137
|
+
# @!attribute [rw] source_key_material_id
|
|
6138
|
+
# The identifier of the key material used to originally encrypt the
|
|
6139
|
+
# data. This field is present only when the original encryption used a
|
|
6140
|
+
# symmetric encryption KMS key.
|
|
6141
|
+
# @return [String]
|
|
6142
|
+
#
|
|
6143
|
+
# @!attribute [rw] destination_key_material_id
|
|
6144
|
+
# The identifier of the key material used to reencrypt the data. This
|
|
6145
|
+
# field is present only when data is reencrypted using a symmetric
|
|
6146
|
+
# encryption KMS key.
|
|
6147
|
+
# @return [String]
|
|
6148
|
+
#
|
|
5299
6149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptResponse AWS API Documentation
|
|
5300
6150
|
#
|
|
5301
6151
|
class ReEncryptResponse < Struct.new(
|
|
@@ -5303,7 +6153,9 @@ module Aws::KMS
|
|
|
5303
6153
|
:source_key_id,
|
|
5304
6154
|
:key_id,
|
|
5305
6155
|
:source_encryption_algorithm,
|
|
5306
|
-
:destination_encryption_algorithm
|
|
6156
|
+
:destination_encryption_algorithm,
|
|
6157
|
+
:source_key_material_id,
|
|
6158
|
+
:destination_key_material_id)
|
|
5307
6159
|
SENSITIVE = []
|
|
5308
6160
|
include Aws::Structure
|
|
5309
6161
|
end
|
|
@@ -5312,24 +6164,26 @@ module Aws::KMS
|
|
|
5312
6164
|
# the API operation.
|
|
5313
6165
|
#
|
|
5314
6166
|
# This data type is designed to support Amazon Web Services Nitro
|
|
5315
|
-
# Enclaves, which lets you create an
|
|
5316
|
-
# Amazon EC2. For information about the
|
|
5317
|
-
#
|
|
5318
|
-
#
|
|
6167
|
+
# Enclaves and Amazon Web Services NitroTPM, which lets you create an
|
|
6168
|
+
# attested environment in Amazon EC2. For information about the
|
|
6169
|
+
# interaction between KMS and Amazon Web Services Nitro Enclaves or
|
|
6170
|
+
# Amazon Web Services NitroTPM, see [Cryptographic attestation support
|
|
6171
|
+
# in KMS][1] in the *Key Management Service Developer Guide*.
|
|
5319
6172
|
#
|
|
5320
6173
|
#
|
|
5321
6174
|
#
|
|
5322
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6175
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html
|
|
5323
6176
|
#
|
|
5324
6177
|
# @!attribute [rw] key_encryption_algorithm
|
|
5325
6178
|
# The encryption algorithm that KMS should use with the public key for
|
|
5326
|
-
# an Amazon Web Services Nitro Enclave to encrypt
|
|
5327
|
-
# the response. The only valid value is
|
|
6179
|
+
# an Amazon Web Services Nitro Enclave or NitroTPM to encrypt
|
|
6180
|
+
# plaintext values for the response. The only valid value is
|
|
6181
|
+
# `RSAES_OAEP_SHA_256`.
|
|
5328
6182
|
# @return [String]
|
|
5329
6183
|
#
|
|
5330
6184
|
# @!attribute [rw] attestation_document
|
|
5331
|
-
# The attestation document for an Amazon Web Services Nitro Enclave
|
|
5332
|
-
# This document includes the enclave's public key.
|
|
6185
|
+
# The attestation document for an Amazon Web Services Nitro Enclave or
|
|
6186
|
+
# a NitroTPM. This document includes the enclave's public key.
|
|
5333
6187
|
# @return [String]
|
|
5334
6188
|
#
|
|
5335
6189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RecipientInfo AWS API Documentation
|
|
@@ -5369,33 +6223,23 @@ module Aws::KMS
|
|
|
5369
6223
|
# [KMS service endpoints][1] in the *Amazon Web Services General
|
|
5370
6224
|
# Reference*.
|
|
5371
6225
|
#
|
|
5372
|
-
# <note markdown="1"> HMAC KMS keys are not supported in all Amazon Web Services Regions.
|
|
5373
|
-
# If you try to replicate an HMAC KMS key in an Amazon Web Services
|
|
5374
|
-
# Region in which HMAC keys are not supported, the `ReplicateKey`
|
|
5375
|
-
# operation returns an `UnsupportedOperationException`. For a list of
|
|
5376
|
-
# Regions in which HMAC KMS keys are supported, see [HMAC keys in
|
|
5377
|
-
# KMS][2] in the *Key Management Service Developer Guide*.
|
|
5378
|
-
#
|
|
5379
|
-
# </note>
|
|
5380
|
-
#
|
|
5381
6226
|
# The replica must be in a different Amazon Web Services Region than
|
|
5382
6227
|
# its primary key and other replicas of that primary key, but in the
|
|
5383
6228
|
# same Amazon Web Services partition. KMS must be available in the
|
|
5384
6229
|
# replica Region. If the Region is not enabled by default, the Amazon
|
|
5385
6230
|
# Web Services account must be enabled in the Region. For information
|
|
5386
6231
|
# about Amazon Web Services partitions, see [Amazon Resource Names
|
|
5387
|
-
# (ARNs)][
|
|
6232
|
+
# (ARNs)][2] in the *Amazon Web Services General Reference*. For
|
|
5388
6233
|
# information about enabling and disabling Regions, see [Enabling a
|
|
5389
|
-
# Region][
|
|
6234
|
+
# Region][3] and [Disabling a Region][4] in the *Amazon Web Services
|
|
5390
6235
|
# General Reference*.
|
|
5391
6236
|
#
|
|
5392
6237
|
#
|
|
5393
6238
|
#
|
|
5394
6239
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region
|
|
5395
|
-
# [2]: https://docs.aws.amazon.com/
|
|
5396
|
-
# [3]: https://docs.aws.amazon.com/general/latest/gr/
|
|
5397
|
-
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-
|
|
5398
|
-
# [5]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable
|
|
6240
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
6241
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
|
|
6242
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable
|
|
5399
6243
|
# @return [String]
|
|
5400
6244
|
#
|
|
5401
6245
|
# @!attribute [rw] policy
|
|
@@ -5445,7 +6289,7 @@ module Aws::KMS
|
|
|
5445
6289
|
#
|
|
5446
6290
|
#
|
|
5447
6291
|
#
|
|
5448
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-
|
|
6292
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html
|
|
5449
6293
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
|
|
5450
6294
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
|
|
5451
6295
|
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
|
@@ -5518,7 +6362,7 @@ module Aws::KMS
|
|
|
5518
6362
|
# When you add tags to an Amazon Web Services resource, Amazon Web
|
|
5519
6363
|
# Services generates a cost allocation report with usage and costs
|
|
5520
6364
|
# aggregated by tags. Tags can also be used to control access to a KMS
|
|
5521
|
-
# key. For details, see [
|
|
6365
|
+
# key. For details, see [Tags in KMS][3].
|
|
5522
6366
|
#
|
|
5523
6367
|
#
|
|
5524
6368
|
#
|
|
@@ -5609,12 +6453,12 @@ module Aws::KMS
|
|
|
5609
6453
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
5610
6454
|
# parameter.
|
|
5611
6455
|
#
|
|
5612
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
5613
|
-
#
|
|
6456
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
6457
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
5614
6458
|
#
|
|
5615
6459
|
#
|
|
5616
6460
|
#
|
|
5617
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6461
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
5618
6462
|
# @return [Boolean]
|
|
5619
6463
|
#
|
|
5620
6464
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantRequest AWS API Documentation
|
|
@@ -5657,12 +6501,12 @@ module Aws::KMS
|
|
|
5657
6501
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
5658
6502
|
# parameter.
|
|
5659
6503
|
#
|
|
5660
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
5661
|
-
#
|
|
6504
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
6505
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
5662
6506
|
#
|
|
5663
6507
|
#
|
|
5664
6508
|
#
|
|
5665
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6509
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
5666
6510
|
# @return [Boolean]
|
|
5667
6511
|
#
|
|
5668
6512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantRequest AWS API Documentation
|
|
@@ -5678,10 +6522,10 @@ module Aws::KMS
|
|
|
5678
6522
|
# @!attribute [rw] key_id
|
|
5679
6523
|
# Identifies a symmetric encryption KMS key. You cannot perform
|
|
5680
6524
|
# on-demand rotation of [asymmetric KMS keys][1], [HMAC KMS keys][2],
|
|
5681
|
-
# KMS keys with [imported key material][3], or KMS keys
|
|
5682
|
-
# key store][4]. To perform on-demand rotation of a set
|
|
5683
|
-
# [multi-Region keys][5], invoke the on-demand rotation on
|
|
5684
|
-
# key.
|
|
6525
|
+
# multi-Region KMS keys with [imported key material][3], or KMS keys
|
|
6526
|
+
# in a [custom key store][4]. To perform on-demand rotation of a set
|
|
6527
|
+
# of related [multi-Region keys][5], invoke the on-demand rotation on
|
|
6528
|
+
# the primary key.
|
|
5685
6529
|
#
|
|
5686
6530
|
# Specify the key ID or key ARN of the KMS key.
|
|
5687
6531
|
#
|
|
@@ -5700,8 +6544,8 @@ module Aws::KMS
|
|
|
5700
6544
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
|
5701
6545
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
|
|
5702
6546
|
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
|
5703
|
-
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
5704
|
-
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6547
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html
|
|
6548
|
+
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate
|
|
5705
6549
|
# @return [String]
|
|
5706
6550
|
#
|
|
5707
6551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotateKeyOnDemandRequest AWS API Documentation
|
|
@@ -5725,31 +6569,97 @@ module Aws::KMS
|
|
|
5725
6569
|
include Aws::Structure
|
|
5726
6570
|
end
|
|
5727
6571
|
|
|
5728
|
-
#
|
|
6572
|
+
# Each entry contains information about one of the key materials
|
|
6573
|
+
# associated with a KMS key.
|
|
5729
6574
|
#
|
|
5730
6575
|
# @!attribute [rw] key_id
|
|
5731
6576
|
# Unique identifier of the key.
|
|
5732
6577
|
# @return [String]
|
|
5733
6578
|
#
|
|
6579
|
+
# @!attribute [rw] key_material_id
|
|
6580
|
+
# Unique identifier of the key material.
|
|
6581
|
+
# @return [String]
|
|
6582
|
+
#
|
|
6583
|
+
# @!attribute [rw] key_material_description
|
|
6584
|
+
# User-specified description of the key material. This field is only
|
|
6585
|
+
# present for symmetric encryption KMS keys with `EXTERNAL` origin.
|
|
6586
|
+
# @return [String]
|
|
6587
|
+
#
|
|
6588
|
+
# @!attribute [rw] import_state
|
|
6589
|
+
# Indicates if the key material is currently imported into KMS. It has
|
|
6590
|
+
# two possible values: `IMPORTED` or `PENDING_IMPORT`. This field is
|
|
6591
|
+
# only present for symmetric encryption KMS keys with `EXTERNAL`
|
|
6592
|
+
# origin.
|
|
6593
|
+
# @return [String]
|
|
6594
|
+
#
|
|
6595
|
+
# @!attribute [rw] key_material_state
|
|
6596
|
+
# There are four possible values for this field: `CURRENT`,
|
|
6597
|
+
# `NON_CURRENT`, `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` and
|
|
6598
|
+
# `PENDING_ROTATION`. KMS uses `CURRENT` key material for both
|
|
6599
|
+
# encryption and decryption and `NON_CURRENT` key material only for
|
|
6600
|
+
# decryption. `PENDING_ROTATION` identifies key material that has been
|
|
6601
|
+
# imported for on-demand key rotation but the rotation hasn't
|
|
6602
|
+
# completed. The key material state
|
|
6603
|
+
# `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` is unique to
|
|
6604
|
+
# multi-region, symmetric encryption keys with imported key material.
|
|
6605
|
+
# It indicates key material that has been imported into the primary
|
|
6606
|
+
# Region key but not all of the replica Region keys. When this key
|
|
6607
|
+
# material is imported in to all of the replica Region keys, the key
|
|
6608
|
+
# material state will change to `PENDING_ROTATION`. Key material in
|
|
6609
|
+
# `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` or `PENDING_ROTATION`
|
|
6610
|
+
# state is not permanently associated with the KMS key. You can delete
|
|
6611
|
+
# this key material and import different key material in its place.
|
|
6612
|
+
# The `PENDING_MULTI_REGION_IMPORT_AND_ROTATION` and
|
|
6613
|
+
# `PENDING_ROTATION` values are only used in symmetric encryption keys
|
|
6614
|
+
# with imported key material. The other values, `CURRENT` and
|
|
6615
|
+
# `NON_CURRENT`, are used for all KMS keys that support automatic or
|
|
6616
|
+
# on-demand key rotation.
|
|
6617
|
+
# @return [String]
|
|
6618
|
+
#
|
|
6619
|
+
# @!attribute [rw] expiration_model
|
|
6620
|
+
# Indicates if the key material is configured to automatically expire.
|
|
6621
|
+
# There are two possible values for this field: `KEY_MATERIAL_EXPIRES`
|
|
6622
|
+
# and `KEY_MATERIAL_DOES_NOT_EXPIRE`. For any key material that
|
|
6623
|
+
# expires, the expiration date and time is indicated in `ValidTo`.
|
|
6624
|
+
# This field is only present for symmetric encryption KMS keys with
|
|
6625
|
+
# `EXTERNAL` origin.
|
|
6626
|
+
# @return [String]
|
|
6627
|
+
#
|
|
6628
|
+
# @!attribute [rw] valid_to
|
|
6629
|
+
# Date and time at which the key material expires. This field is only
|
|
6630
|
+
# present for symmetric encryption KMS keys with `EXTERNAL` origin in
|
|
6631
|
+
# rotation list entries with an `ExpirationModel` value of
|
|
6632
|
+
# `KEY_MATERIAL_EXPIRES`.
|
|
6633
|
+
# @return [Time]
|
|
6634
|
+
#
|
|
5734
6635
|
# @!attribute [rw] rotation_date
|
|
5735
6636
|
# Date and time that the key material rotation completed. Formatted as
|
|
5736
|
-
# Unix time.
|
|
6637
|
+
# Unix time. This field is not present for the first key material or
|
|
6638
|
+
# an imported key material in `PENDING_ROTATION` state.
|
|
5737
6639
|
# @return [Time]
|
|
5738
6640
|
#
|
|
5739
6641
|
# @!attribute [rw] rotation_type
|
|
5740
6642
|
# Identifies whether the key material rotation was a scheduled
|
|
5741
|
-
# [automatic rotation][1] or an [on-demand rotation][2].
|
|
6643
|
+
# [automatic rotation][1] or an [on-demand rotation][2]. This field is
|
|
6644
|
+
# not present for the first key material or an imported key material
|
|
6645
|
+
# in `PENDING_ROTATION` state.
|
|
5742
6646
|
#
|
|
5743
6647
|
#
|
|
5744
6648
|
#
|
|
5745
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
5746
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6649
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html
|
|
6650
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-on-demand.html
|
|
5747
6651
|
# @return [String]
|
|
5748
6652
|
#
|
|
5749
6653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotationsListEntry AWS API Documentation
|
|
5750
6654
|
#
|
|
5751
6655
|
class RotationsListEntry < Struct.new(
|
|
5752
6656
|
:key_id,
|
|
6657
|
+
:key_material_id,
|
|
6658
|
+
:key_material_description,
|
|
6659
|
+
:import_state,
|
|
6660
|
+
:key_material_state,
|
|
6661
|
+
:expiration_model,
|
|
6662
|
+
:valid_to,
|
|
5753
6663
|
:rotation_date,
|
|
5754
6664
|
:rotation_type)
|
|
5755
6665
|
SENSITIVE = []
|
|
@@ -5887,27 +6797,46 @@ module Aws::KMS
|
|
|
5887
6797
|
# Tells KMS whether the value of the `Message` parameter should be
|
|
5888
6798
|
# hashed as part of the signing algorithm. Use `RAW` for unhashed
|
|
5889
6799
|
# messages; use `DIGEST` for message digests, which are already
|
|
5890
|
-
# hashed
|
|
6800
|
+
# hashed; use `EXTERNAL_MU` for 64-byte representative μ used in
|
|
6801
|
+
# ML-DSA signing as defined in NIST FIPS 204 Section 6.2.
|
|
5891
6802
|
#
|
|
5892
6803
|
# When the value of `MessageType` is `RAW`, KMS uses the standard
|
|
5893
6804
|
# signing algorithm, which begins with a hash function. When the value
|
|
5894
6805
|
# is `DIGEST`, KMS skips the hashing step in the signing algorithm.
|
|
6806
|
+
# When the value is `EXTERNAL_MU` KMS skips the concatenated hashing
|
|
6807
|
+
# of the public key hash and the message done in the ML-DSA signing
|
|
6808
|
+
# algorithm.
|
|
6809
|
+
#
|
|
6810
|
+
# Use the `DIGEST` or `EXTERNAL_MU` value only when the value of the
|
|
6811
|
+
# `Message` parameter is a message digest. If you use the `DIGEST`
|
|
6812
|
+
# value with an unhashed message, the security of the signing
|
|
6813
|
+
# operation can be compromised.
|
|
6814
|
+
#
|
|
6815
|
+
# When using ECC\_NIST\_EDWARDS25519 KMS keys:
|
|
6816
|
+
#
|
|
6817
|
+
# * ED25519\_SHA\_512 signing algorithm requires KMS `MessageType:RAW`
|
|
6818
|
+
#
|
|
6819
|
+
# * ED25519\_PH\_SHA\_512 signing algorithm requires KMS
|
|
6820
|
+
# `MessageType:DIGEST`
|
|
5895
6821
|
#
|
|
5896
|
-
#
|
|
5897
|
-
#
|
|
5898
|
-
#
|
|
5899
|
-
#
|
|
6822
|
+
# When you specify the ED25519\_PH\_SHA\_512 signing algorithm with
|
|
6823
|
+
# `MessageType:DIGEST`, KMS still performs the SHA-512 prehash
|
|
6824
|
+
# described in [Step 1 of Section 7.8.1 in FIPS 186-5][1]. This means
|
|
6825
|
+
# the input is hashed twice: once by you and once by KMS.
|
|
5900
6826
|
#
|
|
5901
|
-
# When the value of `MessageType`is `DIGEST`, the length of the
|
|
6827
|
+
# When the value of `MessageType` is `DIGEST`, the length of the
|
|
5902
6828
|
# `Message` value must match the length of hashed messages for the
|
|
5903
6829
|
# specified signing algorithm.
|
|
5904
6830
|
#
|
|
6831
|
+
# When the value of `MessageType` is `EXTERNAL_MU` the length of the
|
|
6832
|
+
# `Message` value must be 64 bytes.
|
|
6833
|
+
#
|
|
5905
6834
|
# You can submit a message digest and omit the `MessageType` or
|
|
5906
6835
|
# specify `RAW` so the digest is hashed again while signing. However,
|
|
5907
6836
|
# this can cause verification failures when verifying with a system
|
|
5908
6837
|
# that assumes a single hash.
|
|
5909
6838
|
#
|
|
5910
|
-
# The hashing algorithm
|
|
6839
|
+
# The hashing algorithm that `Sign` uses is based on the
|
|
5911
6840
|
# `SigningAlgorithm` value.
|
|
5912
6841
|
#
|
|
5913
6842
|
# * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
|
|
@@ -5919,12 +6848,16 @@ module Aws::KMS
|
|
|
5919
6848
|
# * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
|
|
5920
6849
|
# algorithm.
|
|
5921
6850
|
#
|
|
6851
|
+
# * Signing algorithms that end in SHAKE\_256 use the SHAKE\_256
|
|
6852
|
+
# hashing algorithm.
|
|
6853
|
+
#
|
|
5922
6854
|
# * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
|
|
5923
|
-
# verification with SM2 key pairs][
|
|
6855
|
+
# verification with SM2 key pairs][2].
|
|
5924
6856
|
#
|
|
5925
6857
|
#
|
|
5926
6858
|
#
|
|
5927
|
-
# [1]: https://
|
|
6859
|
+
# [1]: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf#page=39
|
|
6860
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/offline-operations.html#key-spec-sm-offline-verification
|
|
5928
6861
|
# @return [String]
|
|
5929
6862
|
#
|
|
5930
6863
|
# @!attribute [rw] grant_tokens
|
|
@@ -5938,7 +6871,7 @@ module Aws::KMS
|
|
|
5938
6871
|
#
|
|
5939
6872
|
#
|
|
5940
6873
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
5941
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6874
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
5942
6875
|
# @return [Array<String>]
|
|
5943
6876
|
#
|
|
5944
6877
|
# @!attribute [rw] signing_algorithm
|
|
@@ -5954,12 +6887,12 @@ module Aws::KMS
|
|
|
5954
6887
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
5955
6888
|
# parameter.
|
|
5956
6889
|
#
|
|
5957
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
5958
|
-
#
|
|
6890
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
6891
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
5959
6892
|
#
|
|
5960
6893
|
#
|
|
5961
6894
|
#
|
|
5962
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
6895
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
5963
6896
|
# @return [Boolean]
|
|
5964
6897
|
#
|
|
5965
6898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/SignRequest AWS API Documentation
|
|
@@ -6184,8 +7117,8 @@ module Aws::KMS
|
|
|
6184
7117
|
#
|
|
6185
7118
|
#
|
|
6186
7119
|
#
|
|
6187
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-
|
|
6188
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-
|
|
7120
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key
|
|
7121
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key
|
|
6189
7122
|
# @return [String]
|
|
6190
7123
|
#
|
|
6191
7124
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest AWS API Documentation
|
|
@@ -6212,8 +7145,8 @@ module Aws::KMS
|
|
|
6212
7145
|
# This field may be displayed in plaintext in CloudTrail logs and
|
|
6213
7146
|
# other output.
|
|
6214
7147
|
#
|
|
6215
|
-
# To change this value,
|
|
6216
|
-
#
|
|
7148
|
+
# To change this value, the custom key store can be connected or
|
|
7149
|
+
# disconnected.
|
|
6217
7150
|
# @return [String]
|
|
6218
7151
|
#
|
|
6219
7152
|
# @!attribute [rw] key_store_password
|
|
@@ -6299,6 +7232,16 @@ module Aws::KMS
|
|
|
6299
7232
|
# To change this value, the external key store must be disconnected.
|
|
6300
7233
|
# @return [String]
|
|
6301
7234
|
#
|
|
7235
|
+
# @!attribute [rw] xks_proxy_vpc_endpoint_service_owner
|
|
7236
|
+
# Changes the Amazon Web Services account ID that KMS uses to identify
|
|
7237
|
+
# the Amazon VPC endpoint service for your external key store proxy
|
|
7238
|
+
# (XKS proxy). This parameter is optional. If not specified, the
|
|
7239
|
+
# current Amazon Web Services account ID for the VPC endpoint service
|
|
7240
|
+
# will not be updated.
|
|
7241
|
+
#
|
|
7242
|
+
# To change this value, the external key store must be disconnected.
|
|
7243
|
+
# @return [String]
|
|
7244
|
+
#
|
|
6302
7245
|
# @!attribute [rw] xks_proxy_authentication_credential
|
|
6303
7246
|
# Changes the credentials that KMS uses to sign requests to the
|
|
6304
7247
|
# external key store proxy (XKS proxy). This parameter is valid only
|
|
@@ -6346,6 +7289,7 @@ module Aws::KMS
|
|
|
6346
7289
|
:xks_proxy_uri_endpoint,
|
|
6347
7290
|
:xks_proxy_uri_path,
|
|
6348
7291
|
:xks_proxy_vpc_endpoint_service_name,
|
|
7292
|
+
:xks_proxy_vpc_endpoint_service_owner,
|
|
6349
7293
|
:xks_proxy_authentication_credential,
|
|
6350
7294
|
:xks_proxy_connectivity)
|
|
6351
7295
|
SENSITIVE = [:key_store_password]
|
|
@@ -6464,19 +7408,19 @@ module Aws::KMS
|
|
|
6464
7408
|
#
|
|
6465
7409
|
#
|
|
6466
7410
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
6467
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
7411
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
6468
7412
|
# @return [Array<String>]
|
|
6469
7413
|
#
|
|
6470
7414
|
# @!attribute [rw] dry_run
|
|
6471
7415
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
6472
7416
|
# parameter.
|
|
6473
7417
|
#
|
|
6474
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
6475
|
-
#
|
|
7418
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
7419
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
6476
7420
|
#
|
|
6477
7421
|
#
|
|
6478
7422
|
#
|
|
6479
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
7423
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
6480
7424
|
# @return [Boolean]
|
|
6481
7425
|
#
|
|
6482
7426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMacRequest AWS API Documentation
|
|
@@ -6560,28 +7504,47 @@ module Aws::KMS
|
|
|
6560
7504
|
# Tells KMS whether the value of the `Message` parameter should be
|
|
6561
7505
|
# hashed as part of the signing algorithm. Use `RAW` for unhashed
|
|
6562
7506
|
# messages; use `DIGEST` for message digests, which are already
|
|
6563
|
-
# hashed
|
|
7507
|
+
# hashed; use `EXTERNAL_MU` for 64-byte representative μ used in
|
|
7508
|
+
# ML-DSA signing as defined in NIST FIPS 204 Section 6.2.
|
|
6564
7509
|
#
|
|
6565
7510
|
# When the value of `MessageType` is `RAW`, KMS uses the standard
|
|
6566
7511
|
# signing algorithm, which begins with a hash function. When the value
|
|
6567
7512
|
# is `DIGEST`, KMS skips the hashing step in the signing algorithm.
|
|
7513
|
+
# When the value is `EXTERNAL_MU` KMS skips the concatenated hashing
|
|
7514
|
+
# of the public key hash and the message done in the ML-DSA signing
|
|
7515
|
+
# algorithm.
|
|
7516
|
+
#
|
|
7517
|
+
# Use the `DIGEST` or `EXTERNAL_MU` value only when the value of the
|
|
7518
|
+
# `Message` parameter is a message digest. If you use the `DIGEST`
|
|
7519
|
+
# value with an unhashed message, the security of the signing
|
|
7520
|
+
# operation can be compromised.
|
|
7521
|
+
#
|
|
7522
|
+
# When using ECC\_NIST\_EDWARDS25519 KMS keys:
|
|
6568
7523
|
#
|
|
6569
|
-
#
|
|
6570
|
-
# parameter is a message digest. If you use the `DIGEST` value with an
|
|
6571
|
-
# unhashed message, the security of the verification operation can be
|
|
6572
|
-
# compromised.
|
|
7524
|
+
# * ED25519\_SHA\_512 signing algorithm requires KMS `MessageType:RAW`
|
|
6573
7525
|
#
|
|
6574
|
-
#
|
|
7526
|
+
# * ED25519\_PH\_SHA\_512 signing algorithm requires KMS
|
|
7527
|
+
# `MessageType:DIGEST`
|
|
7528
|
+
#
|
|
7529
|
+
# When you specify the ED25519\_PH\_SHA\_512 signing algorithm with
|
|
7530
|
+
# `MessageType:DIGEST`, KMS still performs the SHA-512 prehash
|
|
7531
|
+
# described in [Step 1 of Section 7.8.1 in FIPS 186-5][1]. This means
|
|
7532
|
+
# the input is hashed twice: once by you and once by KMS.
|
|
7533
|
+
#
|
|
7534
|
+
# When the value of `MessageType` is `DIGEST`, the length of the
|
|
6575
7535
|
# `Message` value must match the length of hashed messages for the
|
|
6576
7536
|
# specified signing algorithm.
|
|
6577
7537
|
#
|
|
7538
|
+
# When the value of `MessageType` is `EXTERNAL_MU` the length of the
|
|
7539
|
+
# `Message` value must be 64 bytes.
|
|
7540
|
+
#
|
|
6578
7541
|
# You can submit a message digest and omit the `MessageType` or
|
|
6579
7542
|
# specify `RAW` so the digest is hashed again while signing. However,
|
|
6580
7543
|
# if the signed message is hashed once while signing, but twice while
|
|
6581
7544
|
# verifying, verification fails, even when the message hasn't
|
|
6582
7545
|
# changed.
|
|
6583
7546
|
#
|
|
6584
|
-
# The hashing algorithm
|
|
7547
|
+
# The hashing algorithm that `Verify` uses is based on the
|
|
6585
7548
|
# `SigningAlgorithm` value.
|
|
6586
7549
|
#
|
|
6587
7550
|
# * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
|
|
@@ -6593,12 +7556,16 @@ module Aws::KMS
|
|
|
6593
7556
|
# * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
|
|
6594
7557
|
# algorithm.
|
|
6595
7558
|
#
|
|
7559
|
+
# * Signing algorithms that end in SHAKE\_256 use the SHAKE\_256
|
|
7560
|
+
# hashing algorithm.
|
|
7561
|
+
#
|
|
6596
7562
|
# * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
|
|
6597
|
-
# verification with SM2 key pairs][
|
|
7563
|
+
# verification with SM2 key pairs][2].
|
|
6598
7564
|
#
|
|
6599
7565
|
#
|
|
6600
7566
|
#
|
|
6601
|
-
# [1]: https://
|
|
7567
|
+
# [1]: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf#page=39
|
|
7568
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/offline-operations.html#key-spec-sm-offline-verification
|
|
6602
7569
|
# @return [String]
|
|
6603
7570
|
#
|
|
6604
7571
|
# @!attribute [rw] signature
|
|
@@ -6621,19 +7588,19 @@ module Aws::KMS
|
|
|
6621
7588
|
#
|
|
6622
7589
|
#
|
|
6623
7590
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
|
|
6624
|
-
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
7591
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html
|
|
6625
7592
|
# @return [Array<String>]
|
|
6626
7593
|
#
|
|
6627
7594
|
# @!attribute [rw] dry_run
|
|
6628
7595
|
# Checks if your request will succeed. `DryRun` is an optional
|
|
6629
7596
|
# parameter.
|
|
6630
7597
|
#
|
|
6631
|
-
# To learn more about how to use this parameter, see [Testing your
|
|
6632
|
-
#
|
|
7598
|
+
# To learn more about how to use this parameter, see [Testing your
|
|
7599
|
+
# permissions][1] in the *Key Management Service Developer Guide*.
|
|
6633
7600
|
#
|
|
6634
7601
|
#
|
|
6635
7602
|
#
|
|
6636
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
7603
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html
|
|
6637
7604
|
# @return [Boolean]
|
|
6638
7605
|
#
|
|
6639
7606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyRequest AWS API Documentation
|
|
@@ -6834,6 +7801,13 @@ module Aws::KMS
|
|
|
6834
7801
|
# with KMS.
|
|
6835
7802
|
# @return [String]
|
|
6836
7803
|
#
|
|
7804
|
+
# @!attribute [rw] vpc_endpoint_service_owner
|
|
7805
|
+
# The Amazon Web Services account ID that owns the Amazon VPC endpoint
|
|
7806
|
+
# service used to communicate with the external key store proxy (XKS).
|
|
7807
|
+
# This field appears only when the XKS uses an VPC endpoint service to
|
|
7808
|
+
# communicate with KMS.
|
|
7809
|
+
# @return [String]
|
|
7810
|
+
#
|
|
6837
7811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyConfigurationType AWS API Documentation
|
|
6838
7812
|
#
|
|
6839
7813
|
class XksProxyConfigurationType < Struct.new(
|
|
@@ -6841,7 +7815,8 @@ module Aws::KMS
|
|
|
6841
7815
|
:access_key_id,
|
|
6842
7816
|
:uri_endpoint,
|
|
6843
7817
|
:uri_path,
|
|
6844
|
-
:vpc_endpoint_service_name
|
|
7818
|
+
:vpc_endpoint_service_name,
|
|
7819
|
+
:vpc_endpoint_service_owner)
|
|
6845
7820
|
SENSITIVE = [:access_key_id]
|
|
6846
7821
|
include Aws::Structure
|
|
6847
7822
|
end
|
|
@@ -7003,3 +7978,4 @@ module Aws::KMS
|
|
|
7003
7978
|
|
|
7004
7979
|
end
|
|
7005
7980
|
end
|
|
7981
|
+
|