New Upstream Release - ruby-aws-sdk-kms
Ready changes
Summary
Merged new upstream version: 1.71.0 (was: 1.61.0).
Diff
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..6c36c01
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,436 @@
+Unreleased Changes
+------------------
+
+1.71.0 (2023-07-11)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.70.0 (2023-07-06)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.69.0 (2023-07-05)
+------------------
+
+* Feature - Added Dry Run Feature to cryptographic and cross-account mutating KMS APIs (14 in all). This feature allows users to test their permissions and parameters before making the actual API call.
+
+1.68.0 (2023-06-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.67.0 (2023-06-15)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.66.0 (2023-06-05)
+------------------
+
+* Feature - This release includes feature to import customer's asymmetric (RSA and ECC) and HMAC keys into KMS. It also includes feature to allow customers to specify number of days to schedule a KMS key deletion as a policy condition key.
+
+1.65.0 (2023-05-31)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.64.0 (2023-05-01)
+------------------
+
+* Feature - This release makes the NitroEnclave request parameter Recipient and the response field for CiphertextForRecipient available in AWS SDKs. It also adds the regex pattern for CloudHsmClusterId validation.
+
+1.63.0 (2023-02-28)
+------------------
+
+* Feature - AWS KMS is deprecating the RSAES_PKCS1_V1_5 wrapping algorithm option in the GetParametersForImport API that is used in the AWS KMS Import Key Material feature. AWS KMS will end support for this wrapping algorithm by October 1, 2023.
+
+1.62.0 (2023-01-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+* Issue - Replace runtime endpoint resolution approach with generated ruby code.
+
+1.61.0 (2022-12-07)
+------------------
+
+* Feature - Updated examples and exceptions for External Key Store (XKS).
+
+1.60.0 (2022-11-29)
+------------------
+
+* Feature - AWS KMS introduces the External Key Store (XKS), a new feature for customers who want to protect their data with encryption keys stored in an external key management system under their control.
+
+1.59.0 (2022-10-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.58.0 (2022-07-18)
+------------------
+
+* Feature - Added support for the SM2 KeySpec in China Partition Regions
+
+1.57.0 (2022-05-17)
+------------------
+
+* Feature - Add HMAC best practice tip, annual rotation of AWS managed keys.
+
+1.56.0 (2022-04-19)
+------------------
+
+* Feature - Adds support for KMS keys and APIs that generate and verify HMAC codes
+
+1.55.0 (2022-02-24)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.54.0 (2022-02-03)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.53.0 (2021-12-21)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.52.0 (2021-11-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.51.0 (2021-11-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.50.0 (2021-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.49.0 (2021-10-04)
+------------------
+
+* Feature - Added SDK examples for ConnectCustomKeyStore, CreateCustomKeyStore, CreateKey, DeleteCustomKeyStore, DescribeCustomKeyStores, DisconnectCustomKeyStore, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GetPublicKey, ReplicateKey, Sign, UpdateCustomKeyStore and Verify APIs
+
+1.48.0 (2021-09-01)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.47.0 (2021-08-30)
+------------------
+
+* Feature - This release has changes to KMS nomenclature to remove the word master from both the "Customer master key" and "CMK" abbreviation and replace those naming conventions with "KMS key".
+
+1.46.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.45.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.44.0 (2021-06-16)
+------------------
+
+* Feature - Adds support for multi-Region keys
+
+1.43.0 (2021-03-10)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.42.0 (2021-02-02)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.41.0 (2021-01-11)
+------------------
+
+* Feature - Adds support for filtering grants by grant ID and grantee principal in ListGrants requests to AWS KMS.
+
+1.40.0 (2020-12-17)
+------------------
+
+* Feature - Added CreationDate and LastUpdatedDate timestamps to ListAliases API response
+
+1.39.0 (2020-09-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.38.0 (2020-09-15)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.37.0 (2020-08-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.36.0 (2020-07-02)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.35.0 (2020-06-23)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.34.1 (2020-06-11)
+------------------
+
+* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
+
+1.34.0 (2020-06-10)
+------------------
+
+* Issue - This version has been yanked. (#2327).
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.33.0 (2020-06-01)
+------------------
+
+* Feature - AWS Key Management Service (AWS KMS): If the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext APIs are called on a CMK in a custom key store (origin == AWS_CLOUDHSM), they return an UnsupportedOperationException. If a call to UpdateAlias causes a customer to exceed the Alias resource quota, the UpdateAlias API returns a LimitExceededException.
+
+1.32.0 (2020-05-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.31.0 (2020-05-07)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.30.0 (2020-03-09)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.29.0 (2020-02-10)
+------------------
+
+* Feature - The ConnectCustomKeyStore API now provides a new error code (SUBNET_NOT_FOUND) for customers to better troubleshoot if their "connect-custom-key-store" operation fails.
+
+1.28.0 (2020-01-20)
+------------------
+
+* Feature - The ConnectCustomKeyStore operation now provides new error codes (USER_LOGGED_IN and USER_NOT_FOUND) for customers to better troubleshoot if their connect custom key store operation fails. Password length validation during CreateCustomKeyStore now also occurs on the client side.
+
+1.27.0 (2019-12-09)
+------------------
+
+* Feature - The Verify operation now returns KMSInvalidSignatureException on invalid signatures. The Sign and Verify operations now return KMSInvalidStateException when a request is made against a CMK pending deletion.
+
+1.26.0 (2019-11-25)
+------------------
+
+* Feature - AWS Key Management Service (KMS) now enables creation and use of asymmetric Customer Master Keys (CMKs) and the generation of asymmetric data key pairs.
+
+1.25.0 (2019-10-23)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.24.0 (2019-07-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.23.0 (2019-07-01)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.22.0 (2019-06-17)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.21.0 (2019-05-21)
+------------------
+
+* Feature - API update.
+
+1.20.0 (2019-05-15)
+------------------
+
+* Feature - API update.
+
+1.19.0 (2019-05-14)
+------------------
+
+* Feature - API update.
+
+1.18.0 (2019-05-02)
+------------------
+
+* Feature - API update.
+
+1.17.0 (2019-04-19)
+------------------
+
+* Feature - API update.
+
+1.16.0 (2019-03-21)
+------------------
+
+* Feature - API update.
+
+1.15.0 (2019-03-18)
+------------------
+
+* Feature - API update.
+
+1.14.0 (2019-03-14)
+------------------
+
+* Feature - API update.
+
+1.13.0 (2018-11-27)
+------------------
+
+* Feature - API update.
+
+1.12.0 (2018-11-20)
+------------------
+
+* Feature - API update.
+
+1.11.0 (2018-10-24)
+------------------
+
+* Feature - API update.
+
+1.10.0 (2018-10-23)
+------------------
+
+* Feature - API update.
+
+1.9.0 (2018-09-06)
+------------------
+
+* Feature - Adds code paths and plugins for future SDK instrumentation and telemetry.
+
+1.8.0 (2018-09-05)
+------------------
+
+* Feature - API update.
+
+1.7.0 (2018-07-31)
+------------------
+
+* Feature - API update.
+
+1.6.0 (2018-06-26)
+------------------
+
+* Feature - API update.
+
+1.5.0 (2018-02-12)
+------------------
+
+* Feature - API update.
+
+1.4.0 (2018-01-09)
+------------------
+
+* Feature - API update.
+
+1.3.0 (2017-11-07)
+------------------
+
+* Feature - API update.
+
+1.2.0 (2017-09-13)
+------------------
+
+* Feature - API update.
+
+1.1.0 (2017-09-06)
+------------------
+
+* Feature - API update.
+
+* Issue - Compact long string in KMS shared examples causing hanging for jruby
+* Issue - Update `aws-sdk-kms` gemspec metadata.
+
+1.0.0 (2017-08-29)
+------------------
+
+1.0.0.rc13 (2017-08-15)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc12 (2017-08-01)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc11 (2017-07-25)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc10 (2017-07-13)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc9 (2017-07-06)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc8 (2017-06-29)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc7 (2017-05-23)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc6 (2017-05-09)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc5 (2017-05-09)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc4 (2017-04-21)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc3 (2017-03-07)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc2 (2017-01-24)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc1 (2016-12-05)
+------------------
+
+* Feature - Initial preview release of the `aws-sdk-kms` gem.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..df484cb
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+1.71.0
diff --git a/aws-sdk-kms.gemspec b/aws-sdk-kms.gemspec
index d434afc..747cae1 100644
--- a/aws-sdk-kms.gemspec
+++ b/aws-sdk-kms.gemspec
@@ -2,37 +2,35 @@
# This file has been automatically generated by gem2tgz #
#########################################################
# -*- encoding: utf-8 -*-
-# stub: aws-sdk-kms 1.24.0 ruby lib
+# stub: aws-sdk-kms 1.71.0 ruby lib
Gem::Specification.new do |s|
s.name = "aws-sdk-kms".freeze
- s.version = "1.24.0"
+ s.version = "1.71.0"
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
- s.metadata = { "changelog_uri" => "https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kms/CHANGELOG.md", "source_code_uri" => "https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kms" } if s.respond_to? :metadata=
+ s.metadata = { "changelog_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-kms/CHANGELOG.md", "source_code_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-kms" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Amazon Web Services".freeze]
- s.date = "2019-07-25"
+ s.date = "2023-07-11"
s.description = "Official AWS Ruby gem for AWS Key Management Service (KMS). This gem is part of the AWS SDK for Ruby.".freeze
- s.email = ["trevrowe@amazon.com".freeze]
- s.files = ["lib/aws-sdk-kms.rb".freeze, "lib/aws-sdk-kms/client.rb".freeze, "lib/aws-sdk-kms/client_api.rb".freeze, "lib/aws-sdk-kms/customizations.rb".freeze, "lib/aws-sdk-kms/errors.rb".freeze, "lib/aws-sdk-kms/resource.rb".freeze, "lib/aws-sdk-kms/types.rb".freeze]
+ s.email = ["aws-dr-rubygems@amazon.com".freeze]
+ s.files = ["CHANGELOG.md".freeze, "LICENSE.txt".freeze, "VERSION".freeze, "lib/aws-sdk-kms.rb".freeze, "lib/aws-sdk-kms/client.rb".freeze, "lib/aws-sdk-kms/client_api.rb".freeze, "lib/aws-sdk-kms/customizations.rb".freeze, "lib/aws-sdk-kms/endpoint_parameters.rb".freeze, "lib/aws-sdk-kms/endpoint_provider.rb".freeze, "lib/aws-sdk-kms/endpoints.rb".freeze, "lib/aws-sdk-kms/errors.rb".freeze, "lib/aws-sdk-kms/plugins/endpoints.rb".freeze, "lib/aws-sdk-kms/resource.rb".freeze, "lib/aws-sdk-kms/types.rb".freeze]
s.homepage = "https://github.com/aws/aws-sdk-ruby".freeze
s.licenses = ["Apache-2.0".freeze]
- s.rubygems_version = "2.5.2.1".freeze
+ s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
+ s.rubygems_version = "3.2.5".freeze
s.summary = "AWS SDK for Ruby - KMS".freeze
if s.respond_to? :specification_version then
s.specification_version = 4
+ end
- if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
- s.add_runtime_dependency(%q<aws-sdk-core>.freeze, [">= 3.61.1", "~> 3"])
- s.add_runtime_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
- else
- s.add_dependency(%q<aws-sdk-core>.freeze, [">= 3.61.1", "~> 3"])
- s.add_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
- end
+ if s.respond_to? :add_runtime_dependency then
+ s.add_runtime_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.177.0"])
+ s.add_runtime_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
else
- s.add_dependency(%q<aws-sdk-core>.freeze, [">= 3.61.1", "~> 3"])
+ s.add_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.177.0"])
s.add_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
end
end
diff --git a/debian/changelog b/debian/changelog
index 177aee3..ddaafca 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+ruby-aws-sdk-kms (1.71.0-1) UNRELEASED; urgency=low
+
+ * New upstream release.
+ * New upstream release.
+
+ -- Debian Janitor <janitor@jelmer.uk> Sun, 30 Jul 2023 07:21:24 -0000
+
ruby-aws-sdk-kms (1.24.0-3) unstable; urgency=medium
* Team upload.
diff --git a/lib/aws-sdk-kms.rb b/lib/aws-sdk-kms.rb
index 7ab215f..ca71a97 100644
--- a/lib/aws-sdk-kms.rb
+++ b/lib/aws-sdk-kms.rb
@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
+
require 'aws-sdk-core'
require 'aws-sigv4'
require_relative 'aws-sdk-kms/types'
require_relative 'aws-sdk-kms/client_api'
+require_relative 'aws-sdk-kms/plugins/endpoints.rb'
require_relative 'aws-sdk-kms/client'
require_relative 'aws-sdk-kms/errors'
require_relative 'aws-sdk-kms/resource'
+require_relative 'aws-sdk-kms/endpoint_parameters'
+require_relative 'aws-sdk-kms/endpoint_provider'
+require_relative 'aws-sdk-kms/endpoints'
require_relative 'aws-sdk-kms/customizations'
# This module provides support for AWS Key Management Service. This module is available in the
@@ -24,24 +31,27 @@ require_relative 'aws-sdk-kms/customizations'
# methods each accept a hash of request parameters and return a response
# structure.
#
+# kms = Aws::KMS::Client.new
+# resp = kms.cancel_key_deletion(params)
+#
# See {Client} for more information.
#
# # Errors
#
-# Errors returned from AWS Key Management Service all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Key Management Service are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
#
# begin
# # do stuff
# rescue Aws::KMS::Errors::ServiceError
-# # rescues all service API errors
+# # rescues all AWS Key Management Service API errors
# end
#
# See {Errors} for more information.
#
-# @service
+# @!group service
module Aws::KMS
- GEM_VERSION = '1.24.0'
+ GEM_VERSION = '1.71.0'
end
diff --git a/lib/aws-sdk-kms/client.rb b/lib/aws-sdk-kms/client.rb
index 928c5aa..f6c2c7c 100644
--- a/lib/aws-sdk-kms/client.rb
+++ b/lib/aws-sdk-kms/client.rb
@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -24,12 +26,29 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
-require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/checksum_algorithm.rb'
+require 'aws-sdk-core/plugins/request_compression.rb'
+require 'aws-sdk-core/plugins/defaults_mode.rb'
+require 'aws-sdk-core/plugins/recursion_detection.rb'
+require 'aws-sdk-core/plugins/sign.rb'
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:kms)
module Aws::KMS
+ # An API client for KMS. To construct a client, you need to configure a `:region` and `:credentials`.
+ #
+ # client = Aws::KMS::Client.new(
+ # region: region_name,
+ # credentials: credentials,
+ # # ...
+ # )
+ #
+ # For details on configuring region and credentials see
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+ #
+ # See {#initialize} for a full list of supported configuration options.
class Client < Seahorse::Client::Base
include Aws::ClientStubs
@@ -57,8 +76,14 @@ module Aws::KMS
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
- add_plugin(Aws::Plugins::SignatureV4)
+ add_plugin(Aws::Plugins::HttpChecksum)
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
+ add_plugin(Aws::Plugins::RequestCompression)
+ add_plugin(Aws::Plugins::DefaultsMode)
+ add_plugin(Aws::Plugins::RecursionDetection)
+ add_plugin(Aws::Plugins::Sign)
add_plugin(Aws::Plugins::Protocols::JsonRpc)
+ add_plugin(Aws::KMS::Plugins::Endpoints)
# @overload initialize(options)
# @param [Hash] options
@@ -69,13 +94,28 @@ module Aws::KMS
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
+ # shared file, such as `~/.aws/config`.
+ #
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+ #
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+ # assume a role after providing credentials via the web.
+ #
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+ # access token generated from `aws login`.
+ #
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
+ # process that outputs to stdout.
+ #
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
- # * `Aws::SharedCredentials` - Used for loading credentials from a
- # shared file, such as `~/.aws/config`.
+ # * `Aws::ECSCredentials` - Used for loading credentials from
+ # instances running in ECS.
#
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+ # from the Cognito Identity service.
#
# When `:credentials` are not configured directly, the following
# locations will be searched for credentials:
@@ -85,15 +125,17 @@ module Aws::KMS
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
# * `~/.aws/credentials`
# * `~/.aws/config`
- # * EC2 IMDS instance profile - When used by default, the timeouts are
- # very aggressive. Construct and pass an instance of
- # `Aws::InstanceProfileCredentails` to enable retries and extended
- # timeouts.
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
+ # are very aggressive. Construct and pass an instance of
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+ # enable retries and extended timeouts. Instance profile credential
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+ # to true.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
# used to determine the service `:endpoint`. When not passed,
- # a default `:region` is search for in the following locations:
+ # a default `:region` is searched for in the following locations:
#
# * `Aws.config[:region]`
# * `ENV['AWS_REGION']`
@@ -108,6 +150,12 @@ module Aws::KMS
# When set to `true`, a thread polling for endpoints will be running in
# the background every 60 secs (default). Defaults to `false`.
#
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+ # Used only in `adaptive` retry mode. When true, the request will sleep
+ # until there is sufficent client side capacity to retry the request.
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
+ # not retry instead of sleeping.
+ #
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
@@ -132,14 +180,26 @@ module Aws::KMS
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
+ # @option options [Boolean] :correct_clock_skew (true)
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
+ # a clock skew correction and retry requests with skewed client clocks.
+ #
+ # @option options [String] :defaults_mode ("legacy")
+ # See {Aws::DefaultsModeConfiguration} for a list of the
+ # accepted modes and the configuration defaults that are included.
+ #
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
+ # @option options [Boolean] :disable_request_compression (false)
+ # When set to 'true' the request body will not be compressed
+ # for supported operations.
+ #
# @option options [String] :endpoint
# The client endpoint is normally constructed from the `:region`
# option. You should only configure an `:endpoint` when connecting
- # to test endpoints. This should be avalid HTTP(S) URI.
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
#
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +214,11 @@ module Aws::KMS
# requests fetching endpoints information. Defaults to 60 sec.
#
# @option options [Boolean] :endpoint_discovery (false)
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
+ #
+ # @option options [Boolean] :ignore_configured_endpoint_urls
+ # Setting to true disables use of endpoint URLs provided via environment
+ # variables and the shared configuration file.
#
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
@@ -166,15 +230,34 @@ module Aws::KMS
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
+ # @option options [Integer] :max_attempts (3)
+ # An integer representing the maximum number attempts that will be made for
+ # a single request, including the initial attempt. For example,
+ # setting this value to 5 will result in a request being retried up to
+ # 4 times. Used in `standard` and `adaptive` retry modes.
+ #
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
+ # The minimum size in bytes that triggers compression for request
+ # bodies. The value must be non-negative integer value between 0
+ # and 10485780 bytes inclusive.
+ #
+ # @option options [Proc] :retry_backoff
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+ # This option is only used in the `legacy` retry mode.
+ #
# @option options [Float] :retry_base_delay (0.3)
- # The base delay in seconds used by the default backoff function.
+ # The base delay in seconds used by the default backoff function. This option
+ # is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (:none)
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+ # A delay randomiser function used by the default backoff function.
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
+ # otherwise a Proc that takes and returns a number. This option is only used
+ # in the `legacy` retry mode.
#
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
#
@@ -182,11 +265,35 @@ module Aws::KMS
# The maximum number of times to retry failed requests. Only
# ~ 500 level server errors and certain ~ 400 level client errors
# are retried. Generally, these are throttling errors, data
- # checksum errors, networking errors, timeout errors and auth
- # errors from expired credentials.
+ # checksum errors, networking errors, timeout errors, auth errors,
+ # endpoint discovery, and errors from expired credentials.
+ # This option is only used in the `legacy` retry mode.
#
# @option options [Integer] :retry_max_delay (0)
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+ # The maximum number of seconds to delay between retries (0 for no limit)
+ # used by the default backoff function. This option is only used in the
+ # `legacy` retry mode.
+ #
+ # @option options [String] :retry_mode ("legacy")
+ # Specifies which retry algorithm to use. Values are:
+ #
+ # * `legacy` - The pre-existing retry behavior. This is default value if
+ # no retry mode is provided.
+ #
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
+ # This includes support for retry quotas, which limit the number of
+ # unsuccessful retries a client can make.
+ #
+ # * `adaptive` - An experimental retry mode that includes all the
+ # functionality of `standard` mode along with automatic client side
+ # throttling. This is a provisional mode that may change behavior
+ # in the future.
+ #
+ #
+ # @option options [String] :sdk_ua_app_id
+ # A unique and opaque application ID that is appended to the
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
+ # maximum length of 50.
#
# @option options [String] :secret_access_key
#
@@ -211,24 +318,48 @@ module Aws::KMS
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
+ # @option options [Aws::TokenProvider] :token_provider
+ # A Bearer Token Provider. This can be an instance of any one of the
+ # following classes:
+ #
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+ # tokens.
+ #
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+ # access token generated from `aws login`.
+ #
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+ # will be used to search for tokens configured for your profile in shared configuration files.
+ #
+ # @option options [Boolean] :use_dualstack_endpoint
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
+ # will be used if available.
+ #
+ # @option options [Boolean] :use_fips_endpoint
+ # When set to `true`, fips compatible endpoints will be used if available.
+ # When a `fips` region is used, the region is normalized and this config
+ # is set to `true`.
+ #
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
+ # @option options [Aws::KMS::EndpointProvider] :endpoint_provider
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::KMS::EndpointParameters`
+ #
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
- # seconds to wait when opening a HTTP session before rasing a
+ # seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
- # @option options [Integer] :http_read_timeout (60) The default
+ # @option options [Float] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
- # safely be set
- # per-request on the session yeidled by {#session_for}.
+ # safely be set per-request on the session.
#
# @option options [Float] :http_idle_timeout (5) The number of
- # seconds a connection is allowed to sit idble before it is
+ # seconds a connection is allowed to sit idle before it is
# considered stale. Stale connections are closed and removed
# from the pool before making a request.
#
@@ -237,7 +368,10 @@ module Aws::KMS
# request body. This option has no effect unless the request has
# "Expect" header set to "100-continue". Defaults to `nil` which
# disables this behaviour. This value can safely be set per
- # request on the session yeidled by {#session_for}.
+ # request on the session.
+ #
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
+ # in seconds.
#
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
@@ -264,29 +398,35 @@ module Aws::KMS
# @!group API Operations
- # Cancels the deletion of a customer master key (CMK). When this
- # operation is successful, the CMK is set to the `Disabled` state. To
- # enable a CMK, use EnableKey. You cannot perform this operation on a
- # CMK in a different AWS account.
+ # Cancels the deletion of a KMS key. When this operation succeeds, the
+ # key state of the KMS key is `Disabled`. To enable the KMS key, use
+ # EnableKey.
#
- # For more information about scheduling and canceling deletion of a CMK,
- # see [Deleting Customer Master Keys][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # For more information about scheduling and canceling deletion of a KMS
+ # key, see [Deleting KMS keys][1] in the *Key Management Service
+ # Developer Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:CancelKeyDeletion][3] (key policy)
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Related operations**: ScheduleKeyDeletion
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # The unique identifier for the customer master key (CMK) for which to
- # cancel deletion.
+ # Identifies the KMS key whose deletion is being canceled.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -295,24 +435,25 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
# @return [Types::CancelKeyDeletionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CancelKeyDeletionResponse#key_id #key_id} => String
#
#
- # @example Example: To cancel deletion of a customer master key (CMK)
+ # @example Example: To cancel deletion of a KMS key
#
- # # The following example cancels deletion of the specified CMK.
+ # # The following example cancels deletion of the specified KMS key.
#
# resp = client.cancel_key_deletion({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
# resp.to_h outputs the following:
# {
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK whose deletion you canceled.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key whose deletion you canceled.
# }
#
# @example Request syntax with placeholder values
@@ -334,31 +475,27 @@ module Aws::KMS
req.send_request(options)
end
- # Connects or reconnects a [custom key store][1] to its associated AWS
- # CloudHSM cluster.
- #
- # The custom key store must be connected before you can create customer
- # master keys (CMKs) in the key store or use the CMKs it contains. You
- # can disconnect and reconnect a custom key store at any time.
- #
- # To connect a custom key store, its associated AWS CloudHSM cluster
- # must have at least one active HSM. To get the number of active HSMs in
- # a cluster, use the [DescribeClusters][2] operation. To add HSMs to the
- # cluster, use the [CreateHsm][3] operation.
- #
- # The connection process can take an extended amount of time to
- # complete; up to 20 minutes. This operation starts the connection
+ # Connects or reconnects a [custom key store][1] to its backing key
+ # store. For an CloudHSM key store, `ConnectCustomKeyStore` connects the
+ # key store to its associated CloudHSM cluster. For an external key
+ # store, `ConnectCustomKeyStore` connects the key store to the external
+ # key store proxy that communicates with your external key manager.
+ #
+ # The custom key store must be connected before you can create KMS keys
+ # in the key store or use the KMS keys it contains. You can disconnect
+ # and reconnect a custom key store at any time.
+ #
+ # The connection process for a custom key store can take an extended
+ # amount of time to complete. This operation starts the connection
# process, but it does not wait for it to complete. When it succeeds,
# this operation quickly returns an HTTP 200 response and a JSON object
# with no properties. However, this response does not indicate that the
# custom key store is connected. To get the connection state of the
# custom key store, use the DescribeCustomKeyStores operation.
#
- # During the connection process, AWS KMS finds the AWS CloudHSM cluster
- # that is associated with the custom key store, creates the connection
- # infrastructure, connects to the cluster, logs into the AWS CloudHSM
- # client as the [ `kmsuser` crypto user][4] (CU), and rotates its
- # password.
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
#
# The `ConnectCustomKeyStore` operation might fail for various reasons.
# To find the reason, use the DescribeCustomKeyStores operation and see
@@ -370,10 +507,63 @@ module Aws::KMS
# UpdateCustomKeyStore operation if necessary, and then use
# `ConnectCustomKeyStore` again.
#
- # If you are having trouble connecting or disconnecting a custom key
- # store, see [Troubleshooting a Custom Key Store][5] in the *AWS Key
+ # **CloudHSM key store**
+ #
+ # During the connection process for an CloudHSM key store, KMS finds the
+ # CloudHSM cluster that is associated with the custom key store, creates
+ # the connection infrastructure, connects to the cluster, logs into the
+ # CloudHSM client as the `kmsuser` CU, and rotates its password.
+ #
+ # To connect an CloudHSM key store, its associated CloudHSM cluster must
+ # have at least one active HSM. To get the number of active HSMs in a
+ # cluster, use the [DescribeClusters][2] operation. To add HSMs to the
+ # cluster, use the [CreateHsm][3] operation. Also, the [ `kmsuser`
+ # crypto user][4] (CU) must not be logged into the cluster. This
+ # prevents KMS from using this account to log in.
+ #
+ # If you are having trouble connecting or disconnecting a CloudHSM key
+ # store, see [Troubleshooting an CloudHSM key store][5] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **External key store**
+ #
+ # When you connect an external key store that uses public endpoint
+ # connectivity, KMS tests its ability to communicate with your external
+ # key manager by sending a request via the external key store proxy.
+ #
+ # When you connect to an external key store that uses VPC endpoint
+ # service connectivity, KMS establishes the networking elements that it
+ # needs to communicate with your external key manager via the external
+ # key store proxy. This includes creating an interface endpoint to the
+ # VPC endpoint service and a private hosted zone for traffic between KMS
+ # and the VPC endpoint service.
+ #
+ # To connect an external key store, KMS must be able to connect to the
+ # external key store proxy, the external key store proxy must be able to
+ # communicate with your external key manager, and the external key
+ # manager must be available for cryptographic operations.
+ #
+ # If you are having trouble connecting or disconnecting an external key
+ # store, see [Troubleshooting an external key store][6] in the *Key
# Management Service Developer Guide*.
#
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:ConnectCustomKeyStore][7] (IAM policy)
+ #
+ # **Related operations**
+ #
+ # * CreateCustomKeyStore
+ #
+ # * DeleteCustomKeyStore
+ #
+ # * DescribeCustomKeyStores
+ #
+ # * DisconnectCustomKeyStore
+ #
+ # * UpdateCustomKeyStore
+ #
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
@@ -381,6 +571,8 @@ module Aws::KMS
# [3]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html
# [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser
# [5]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :custom_key_store_id
# Enter the key store ID of the custom key store that you want to
@@ -389,6 +581,22 @@ module Aws::KMS
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
+ #
+ # @example Example: To connect a custom key store
+ #
+ # # This example connects an AWS KMS custom key store to its backing key store. For an AWS CloudHSM key store, it connects
+ # # the key store to its AWS CloudHSM cluster. For an external key store, it connects the key store to the external key
+ # # store proxy that communicates with your external key manager. This operation does not return any data. To verify that
+ # # the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation.
+ #
+ # resp = client.connect_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the AWS KMS custom key store.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # }
+ #
# @example Request syntax with placeholder values
#
# resp = client.connect_custom_key_store({
@@ -404,67 +612,122 @@ module Aws::KMS
req.send_request(options)
end
- # Creates a display name for a customer managed customer master key
- # (CMK). You can use an alias to identify a CMK in selected operations,
- # such as Encrypt and GenerateDataKey.
+ # Creates a friendly name for a KMS key.
+ #
+ # <note markdown="1"> Adding, deleting, or updating an alias can allow or deny permission to
+ # the KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
#
- # Each CMK can have multiple aliases, but each alias points to only one
- # CMK. The alias name must be unique in the AWS account and region. To
- # simplify code that runs in multiple regions, use the same alias name,
- # but point it to a different CMK in each region.
+ # </note>
#
- # Because an alias is not a property of a CMK, you can delete and change
- # the aliases of a CMK without affecting the CMK. Also, aliases do not
- # appear in the response from the DescribeKey operation. To get the
- # aliases of all CMKs, use the ListAliases operation.
+ # You can use an alias to identify a KMS key in the KMS console, in the
+ # DescribeKey operation and in [cryptographic operations][2], such as
+ # Encrypt and GenerateDataKey. You can also change the KMS key that's
+ # associated with the alias (UpdateAlias) or delete the alias
+ # (DeleteAlias) at any time. These operations don't affect the
+ # underlying KMS key.
+ #
+ # You can associate the alias with any customer managed key in the same
+ # Amazon Web Services Region. Each alias is associated with only one KMS
+ # key at a time, but a KMS key can have multiple aliases. A valid KMS
+ # key is required. You can't create an alias without a KMS key.
+ #
+ # The alias must be unique in the account and Region, but you can have
+ # aliases with the same name in different Regions. For detailed
+ # information about aliases, see [Using aliases][3] in the *Key
+ # Management Service Developer Guide*.
#
- # The alias name must begin with `alias/` followed by a name, such as
- # `alias/ExampleAlias`. It can contain only alphanumeric characters,
- # forward slashes (/), underscores (\_), and dashes (-). The alias name
- # cannot begin with `alias/aws/`. The `alias/aws/` prefix is reserved
- # for [AWS managed CMKs][1].
+ # This operation does not return a response. To get the alias that you
+ # created, use the ListAliases operation.
#
- # The alias and the CMK it is mapped to must be in the same AWS account
- # and the same region. You cannot perform this operation on an alias in
- # a different AWS account.
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][4] in the *Key
+ # Management Service Developer Guide*.
#
- # To map an existing alias to a different CMK, call UpdateAlias.
+ # **Cross-account use**: No. You cannot perform this operation on an
+ # alias in a different Amazon Web Services account.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Required permissions**
#
+ # * [kms:CreateAlias][5] on the alias (IAM policy).
#
+ # * [kms:CreateAlias][5] on the KMS key (key policy).
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # For details, see [Controlling access to aliases][6] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Related operations:**
+ #
+ # * DeleteAlias
+ #
+ # * ListAliases
+ #
+ # * UpdateAlias
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
#
# @option params [required, String] :alias_name
# Specifies the alias name. This value must begin with `alias/` followed
- # by a name, such as `alias/ExampleAlias`. The alias name cannot begin
- # with `alias/aws/`. The `alias/aws/` prefix is reserved for AWS managed
- # CMKs.
+ # by a name, such as `alias/ExampleAlias`.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # The `AliasName` value must be string of 1-256 characters. It can
+ # contain only alphanumeric characters, forward slashes (/), underscores
+ # (\_), and dashes (-). The alias name cannot begin with `alias/aws/`.
+ # The `alias/aws/` prefix is reserved for [Amazon Web Services managed
+ # keys][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
#
# @option params [required, String] :target_key_id
- # Identifies the CMK to which the alias refers. Specify the key ID or
- # the Amazon Resource Name (ARN) of the CMK. You cannot specify another
- # alias. For help finding the key ID and ARN, see [Finding the Key ID
- # and ARN][1] in the *AWS Key Management Service Developer Guide*.
+ # Associates the alias with the specified [customer managed key][1]. The
+ # KMS key must be in the same Amazon Web Services Region.
+ #
+ # A valid key ID is required. If you supply a null or empty string
+ # value, this operation returns an error.
+ #
+ # For help finding the key ID and ARN, see [Finding the Key ID and
+ # ARN][2] in the <i> <i>Key Management Service Developer Guide</i> </i>.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To create an alias
#
- # # The following example creates an alias for the specified customer master key (CMK).
+ # # The following example creates an alias for the specified KMS key.
#
# resp = client.create_alias({
# alias_name: "alias/ExampleAlias", # The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.
- # target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
# @example Request syntax with placeholder values
@@ -483,83 +746,376 @@ module Aws::KMS
req.send_request(options)
end
- # Creates a [custom key store][1] that is associated with an [AWS
- # CloudHSM cluster][2] that you own and manage.
+ # Creates a [custom key store][1] backed by a key store that you own and
+ # manage. When you use a KMS key in a custom key store for a
+ # cryptographic operation, the cryptographic operation is actually
+ # performed in your key store using your keys. KMS supports [CloudHSM
+ # key stores][2] backed by an [CloudHSM cluster][3] and [external key
+ # stores][4] backed by an external key store proxy and external key
+ # manager outside of Amazon Web Services.
+ #
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
+ #
+ # Before you create the custom key store, the required elements must be
+ # in place and operational. We recommend that you use the test tools
+ # that KMS provides to verify the configuration your external key store
+ # proxy. For details about the required elements and verification tests,
+ # see [Assemble the prerequisites (for CloudHSM key stores)][5] or
+ # [Assemble the prerequisites (for external key stores)][6] in the *Key
+ # Management Service Developer Guide*.
#
- # This operation is part of the [Custom Key Store feature][1] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # To create a custom key store, use the following parameters.
#
- # Before you create the custom key store, you must assemble the required
- # elements, including an AWS CloudHSM cluster that fulfills the
- # requirements for a custom key store. For details about the required
- # elements, see [Assemble the Prerequisites][3] in the *AWS Key
- # Management Service Developer Guide*.
+ # * To create an CloudHSM key store, specify the `CustomKeyStoreName`,
+ # `CloudHsmClusterId`, `KeyStorePassword`, and
+ # `TrustAnchorCertificate`. The `CustomKeyStoreType` parameter is
+ # optional for CloudHSM key stores. If you include it, set it to the
+ # default value, `AWS_CLOUDHSM`. For help with failures, see
+ # [Troubleshooting an CloudHSM key store][7] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # * To create an external key store, specify the `CustomKeyStoreName`
+ # and a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`. Also, specify
+ # values for `XksProxyConnectivity`,
+ # `XksProxyAuthenticationCredential`, `XksProxyUriEndpoint`, and
+ # `XksProxyUriPath`. If your `XksProxyConnectivity` value is
+ # `VPC_ENDPOINT_SERVICE`, specify the `XksProxyVpcEndpointServiceName`
+ # parameter. For help with failures, see [Troubleshooting an external
+ # key store][8] in the *Key Management Service Developer Guide*.
+ #
+ # <note markdown="1"> For external key stores:
+ #
+ # Some external key managers provide a simpler method for creating an
+ # external key store. For details, see your external key manager
+ # documentation.
+ #
+ # When creating an external key store in the KMS console, you can upload
+ # a JSON-based proxy configuration file with the desired values. You
+ # cannot use a proxy configuration with the `CreateCustomKeyStore`
+ # operation. However, you can use the values in the file to help you
+ # determine the correct values for the `CreateCustomKeyStore`
+ # parameters.
+ #
+ # </note>
#
# When the operation completes successfully, it returns the ID of the
# new custom key store. Before you can use your new custom key store,
- # you need to use the ConnectCustomKeyStore operation to connect the new
- # key store to its AWS CloudHSM cluster. Even if you are not going to
- # use your custom key store immediately, you might want to connect it to
- # verify that all settings are correct and then disconnect it until you
- # are ready to use it.
+ # you need to use the ConnectCustomKeyStore operation to connect a new
+ # CloudHSM key store to its CloudHSM cluster, or to connect a new
+ # external key store to the external key store proxy for your external
+ # key manager. Even if you are not going to use your custom key store
+ # immediately, you might want to connect it to verify that all settings
+ # are correct and then disconnect it until you are ready to use it.
+ #
+ # For help with failures, see [Troubleshooting a custom key store][7] in
+ # the *Key Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
#
- # For help with failures, see [Troubleshooting a Custom Key Store][4] in
- # the *AWS Key Management Service Developer Guide*.
+ # **Required permissions**: [kms:CreateCustomKeyStore][9] (IAM policy).
+ #
+ # **Related operations:**
+ #
+ # * ConnectCustomKeyStore
+ #
+ # * DeleteCustomKeyStore
+ #
+ # * DescribeCustomKeyStores
+ #
+ # * DisconnectCustomKeyStore
+ #
+ # * UpdateCustomKeyStore
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [2]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
- # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html
+ # [3]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :custom_key_store_name
# Specifies a friendly name for the custom key store. The name must be
- # unique in your AWS account.
+ # unique in your Amazon Web Services account and Region. This parameter
+ # is required for all custom key stores.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # @option params [String] :cloud_hsm_cluster_id
+ # Identifies the CloudHSM cluster for an CloudHSM key store. This
+ # parameter is required for custom key stores with `CustomKeyStoreType`
+ # of `AWS_CLOUDHSM`.
#
- # @option params [required, String] :cloud_hsm_cluster_id
- # Identifies the AWS CloudHSM cluster for the custom key store. Enter
- # the cluster ID of any active AWS CloudHSM cluster that is not already
- # associated with a custom key store. To find the cluster ID, use the
- # [DescribeClusters][1] operation.
+ # Enter the cluster ID of any active CloudHSM cluster that is not
+ # already associated with a custom key store. To find the cluster ID,
+ # use the [DescribeClusters][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html
#
- # @option params [required, String] :trust_anchor_certificate
- # Enter the content of the trust anchor certificate for the cluster.
- # This is the content of the `customerCA.crt` file that you created when
- # you [initialized the cluster][1].
+ # @option params [String] :trust_anchor_certificate
+ # Specifies the certificate for an CloudHSM key store. This parameter is
+ # required for custom key stores with a `CustomKeyStoreType` of
+ # `AWS_CLOUDHSM`.
+ #
+ # Enter the content of the trust anchor certificate for the CloudHSM
+ # cluster. This is the content of the `customerCA.crt` file that you
+ # created when you [initialized the cluster][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html
#
- # @option params [required, String] :key_store_password
+ # @option params [String] :key_store_password
+ # Specifies the `kmsuser` password for an CloudHSM key store. This
+ # parameter is required for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
+ #
# Enter the password of the [ `kmsuser` crypto user (CU) account][1] in
- # the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as
- # this user to manage key material on your behalf.
+ # the specified CloudHSM cluster. KMS logs into the cluster as this user
+ # to manage key material on your behalf.
#
- # This parameter tells AWS KMS the `kmsuser` account password; it does
- # not change the password in the AWS CloudHSM cluster.
+ # The password must be a string of 7 to 32 characters. Its value is case
+ # sensitive.
+ #
+ # This parameter tells KMS the `kmsuser` account password; it does not
+ # change the password in the CloudHSM cluster.
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser
#
+ # @option params [String] :custom_key_store_type
+ # Specifies the type of custom key store. The default value is
+ # `AWS_CLOUDHSM`.
+ #
+ # For a custom key store backed by an CloudHSM cluster, omit the
+ # parameter or enter `AWS_CLOUDHSM`. For a custom key store backed by an
+ # external key manager outside of Amazon Web Services, enter
+ # `EXTERNAL_KEY_STORE`. You cannot change this property after the key
+ # store is created.
+ #
+ # @option params [String] :xks_proxy_uri_endpoint
+ # Specifies the endpoint that KMS uses to send requests to the external
+ # key store proxy (XKS proxy). This parameter is required for custom key
+ # stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # The protocol must be HTTPS. KMS communicates on port 443. Do not
+ # specify the port in the `XksProxyUriEndpoint` value.
+ #
+ # For external key stores with `XksProxyConnectivity` value of
+ # `VPC_ENDPOINT_SERVICE`, specify `https://` followed by the private DNS
+ # name of the VPC endpoint service.
+ #
+ # For external key stores with `PUBLIC_ENDPOINT` connectivity, this
+ # endpoint must be reachable before you create the custom key store. KMS
+ # connects to the external key store proxy while creating the custom key
+ # store. For external key stores with `VPC_ENDPOINT_SERVICE`
+ # connectivity, KMS connects when you call the ConnectCustomKeyStore
+ # operation.
+ #
+ # The value of this parameter must begin with `https://`. The remainder
+ # can contain upper and lower case letters (A-Z and a-z), numbers (0-9),
+ # dots (`.`), and hyphens (`-`). Additional slashes (`/` and ``) are
+ # not permitted.
+ #
+ # <b>Uniqueness requirements: </b>
+ #
+ # * The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
+ #
+ # * An external key store with `PUBLIC_ENDPOINT` connectivity cannot use
+ # the same `XksProxyUriEndpoint` value as an external key store with
+ # `VPC_ENDPOINT_SERVICE` connectivity in the same Amazon Web Services
+ # Region.
+ #
+ # * Each external key store with `VPC_ENDPOINT_SERVICE` connectivity
+ # must have its own private DNS name. The `XksProxyUriEndpoint` value
+ # for external key stores with `VPC_ENDPOINT_SERVICE` connectivity
+ # (private DNS name) must be unique in the Amazon Web Services account
+ # and Region.
+ #
+ # @option params [String] :xks_proxy_uri_path
+ # Specifies the base path to the proxy APIs for this external key store.
+ # To find this value, see the documentation for your external key store
+ # proxy. This parameter is required for all custom key stores with a
+ # `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # The value must start with `/` and must end with `/kms/xks/v1` where
+ # `v1` represents the version of the KMS external key store proxy API.
+ # This path can include an optional prefix between the required elements
+ # such as `/prefix/kms/xks/v1`.
+ #
+ # <b>Uniqueness requirements: </b>
+ #
+ # * The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
+ #
+ # ^
+ #
+ # @option params [String] :xks_proxy_vpc_endpoint_service_name
+ # Specifies the name of the Amazon VPC endpoint service for interface
+ # endpoints that is used to communicate with your external key store
+ # proxy (XKS proxy). This parameter is required when the value of
+ # `CustomKeyStoreType` is `EXTERNAL_KEY_STORE` and the value of
+ # `XksProxyConnectivity` is `VPC_ENDPOINT_SERVICE`.
+ #
+ # The Amazon VPC endpoint service must [fulfill all requirements][1] for
+ # use with an external key store.
+ #
+ # **Uniqueness requirements:**
+ #
+ # * External key stores with `VPC_ENDPOINT_SERVICE` connectivity can
+ # share an Amazon VPC, but each external key store must have its own
+ # VPC endpoint service and private DNS name.
+ #
+ # ^
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements
+ #
+ # @option params [Types::XksProxyAuthenticationCredentialType] :xks_proxy_authentication_credential
+ # Specifies an authentication credential for the external key store
+ # proxy (XKS proxy). This parameter is required for all custom key
+ # stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # The `XksProxyAuthenticationCredential` has two required elements:
+ # `RawSecretAccessKey`, a secret key, and `AccessKeyId`, a unique
+ # identifier for the `RawSecretAccessKey`. For character requirements,
+ # see
+ # [XksProxyAuthenticationCredentialType](kms/latest/APIReference/API_XksProxyAuthenticationCredentialType.html).
+ #
+ # KMS uses this authentication credential to sign requests to the
+ # external key store proxy on your behalf. This credential is unrelated
+ # to Identity and Access Management (IAM) and Amazon Web Services
+ # credentials.
+ #
+ # This parameter doesn't set or change the authentication credentials
+ # on the XKS proxy. It just tells KMS the credential that you
+ # established on your external key store proxy. If you rotate your proxy
+ # authentication credential, use the UpdateCustomKeyStore operation to
+ # provide the new credential to KMS.
+ #
+ # @option params [String] :xks_proxy_connectivity
+ # Indicates how KMS communicates with the external key store proxy. This
+ # parameter is required for custom key stores with a
+ # `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # If the external key store proxy uses a public endpoint, specify
+ # `PUBLIC_ENDPOINT`. If the external key store proxy uses a Amazon VPC
+ # endpoint service for communication with KMS, specify
+ # `VPC_ENDPOINT_SERVICE`. For help making this choice, see [Choosing a
+ # connectivity option][1] in the *Key Management Service Developer
+ # Guide*.
+ #
+ # An Amazon VPC endpoint service keeps your communication with KMS in a
+ # private address space entirely within Amazon Web Services, but it
+ # requires more configuration, including establishing a Amazon VPC with
+ # multiple subnets, a VPC endpoint service, a network load balancer, and
+ # a verified private DNS name. A public endpoint is simpler to set up,
+ # but it might be slower and might not fulfill your security
+ # requirements. You might consider testing with a public endpoint, and
+ # then establishing a VPC endpoint service for production tasks. Note
+ # that this choice does not determine the location of the external key
+ # store proxy. Even if you choose a VPC endpoint service, the proxy can
+ # be hosted within the VPC or outside of Amazon Web Services such as in
+ # your corporate data center.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity
+ #
# @return [Types::CreateCustomKeyStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateCustomKeyStoreResponse#custom_key_store_id #custom_key_store_id} => String
#
+ #
+ # @example Example: To create an AWS CloudHSM key store
+ #
+ # # This example creates a custom key store that is associated with an AWS CloudHSM cluster.
+ #
+ # resp = client.create_custom_key_store({
+ # cloud_hsm_cluster_id: "cluster-234abcdefABC", # The ID of the CloudHSM cluster.
+ # custom_key_store_name: "ExampleKeyStore", # A friendly name for the custom key store.
+ # key_store_password: "kmsPswd", # The password for the kmsuser CU account in the specified cluster.
+ # trust_anchor_certificate: "<certificate-goes-here>", # The content of the customerCA.crt file that you created when you initialized the cluster.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the new custom key store.
+ # }
+ #
+ # @example Example: To create an external key store with VPC endpoint service connectivity
+ #
+ # # This example creates an external key store that uses an Amazon VPC endpoint service to communicate with AWS KMS.
+ #
+ # resp = client.create_custom_key_store({
+ # custom_key_store_name: "ExampleVPCEndpointKeyStore", # A friendly name for the custom key store
+ # custom_key_store_type: "EXTERNAL_KEY_STORE", # For external key stores, the value must be EXTERNAL_KEY_STORE
+ # xks_proxy_authentication_credential: {
+ # access_key_id: "ABCDE12345670EXAMPLE",
+ # raw_secret_access_key: "DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=",
+ # }, # The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
+ # xks_proxy_connectivity: "VPC_ENDPOINT_SERVICE", # Indicates how AWS KMS communicates with the external key store proxy
+ # xks_proxy_uri_endpoint: "https://myproxy-private.xks.example.com", # The URI that AWS KMS uses to connect to the external key store proxy
+ # xks_proxy_uri_path: "/example-prefix/kms/xks/v1", # The URI path to the external key store proxy APIs
+ # xks_proxy_vpc_endpoint_service_name: "com.amazonaws.vpce.us-east-1.vpce-svc-example1", # The VPC endpoint service that KMS uses to communicate with the external key store proxy
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the new custom key store.
+ # }
+ #
+ # @example Example: To create an external key store with public endpoint connectivity
+ #
+ # # This example creates an external key store with public endpoint connectivity.
+ #
+ # resp = client.create_custom_key_store({
+ # custom_key_store_name: "ExamplePublicEndpointKeyStore", # A friendly name for the custom key store
+ # custom_key_store_type: "EXTERNAL_KEY_STORE", # For external key stores, the value must be EXTERNAL_KEY_STORE
+ # xks_proxy_authentication_credential: {
+ # access_key_id: "ABCDE12345670EXAMPLE",
+ # raw_secret_access_key: "DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=",
+ # }, # The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
+ # xks_proxy_connectivity: "PUBLIC_ENDPOINT", # Indicates how AWS KMS communicates with the external key store proxy
+ # xks_proxy_uri_endpoint: "https://myproxy.xks.example.com", # The URI that AWS KMS uses to connect to the external key store proxy
+ # xks_proxy_uri_path: "/kms/xks/v1", # The URI path to your external key store proxy API
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_store_id: "cks-987654321abcdef0", # The ID of the new custom key store.
+ # }
+ #
# @example Request syntax with placeholder values
#
# resp = client.create_custom_key_store({
# custom_key_store_name: "CustomKeyStoreNameType", # required
- # cloud_hsm_cluster_id: "CloudHsmClusterIdType", # required
- # trust_anchor_certificate: "TrustAnchorCertificateType", # required
- # key_store_password: "KeyStorePasswordType", # required
+ # cloud_hsm_cluster_id: "CloudHsmClusterIdType",
+ # trust_anchor_certificate: "TrustAnchorCertificateType",
+ # key_store_password: "KeyStorePasswordType",
+ # custom_key_store_type: "AWS_CLOUDHSM", # accepts AWS_CLOUDHSM, EXTERNAL_KEY_STORE
+ # xks_proxy_uri_endpoint: "XksProxyUriEndpointType",
+ # xks_proxy_uri_path: "XksProxyUriPathType",
+ # xks_proxy_vpc_endpoint_service_name: "XksProxyVpcEndpointServiceNameType",
+ # xks_proxy_authentication_credential: {
+ # access_key_id: "XksProxyAuthenticationAccessKeyIdType", # required
+ # raw_secret_access_key: "XksProxyAuthenticationRawSecretAccessKeyType", # required
+ # },
+ # xks_proxy_connectivity: "PUBLIC_ENDPOINT", # accepts PUBLIC_ENDPOINT, VPC_ENDPOINT_SERVICE
# })
#
# @example Response structure
@@ -575,36 +1131,73 @@ module Aws::KMS
req.send_request(options)
end
- # Adds a grant to a customer master key (CMK). The grant allows the
- # grantee principal to use the CMK when the conditions specified in the
- # grant are met. When setting permissions, grants are an alternative to
- # key policies.
+ # Adds a grant to a KMS key.
+ #
+ # A *grant* is a policy instrument that allows Amazon Web Services
+ # principals to use KMS keys in cryptographic operations. It also can
+ # allow them to view a KMS key (DescribeKey) and create and manage
+ # grants. When authorizing access to a KMS key, grants are considered
+ # along with key policies and IAM policies. Grants are often used for
+ # temporary permissions because you can create one, use its permissions,
+ # and delete it without changing your key policies or IAM policies.
+ #
+ # For detailed information about grants, including grant terminology,
+ # see [Grants in KMS][1] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>. For examples of working with grants in several
+ # programming languages, see [Programming grants][2].
+ #
+ # The `CreateGrant` operation returns a `GrantToken` and a `GrantId`.
+ #
+ # * When you create, retire, or revoke a grant, there might be a brief
+ # delay, usually less than five minutes, until the grant is available
+ # throughout KMS. This state is known as *eventual consistency*. Once
+ # the grant has achieved eventual consistency, the grantee principal
+ # can use the permissions in the grant without identifying the grant.
+ #
+ # However, to use the permissions in the grant immediately, use the
+ # `GrantToken` that `CreateGrant` returns. For details, see [Using a
+ # grant token][3] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>.
#
- # To create a grant that allows a cryptographic operation only when the
- # encryption context in the operation request matches or includes a
- # specified encryption context, use the `Constraints` parameter. For
- # details, see GrantConstraints.
+ # * The `CreateGrant` operation also returns a `GrantId`. You can use
+ # the `GrantId` and a key identifier to identify the grant in the
+ # RetireGrant and RevokeGrant operations. To find the grant ID, use
+ # the ListGrants or ListRetirableGrants operations.
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN in the value of the `KeyId` parameter. For more
- # information about grants, see [Grants][1] in the <i> <i>AWS Key
- # Management Service Developer Guide</i> </i>.
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][4] in the *Key
+ # Management Service Developer Guide*.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Cross-account use**: Yes. To perform this operation on a KMS key in
+ # a different Amazon Web Services account, specify the key ARN in the
+ # value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:CreateGrant][5] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * ListGrants
+ #
+ # * ListRetirableGrants
+ #
+ # * RetireGrant
+ #
+ # * RevokeGrant
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # The unique identifier for the customer master key (CMK) that the grant
- # applies to.
+ # Identifies the KMS key for the grant. The grant gives principals
+ # permission to use this KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key in
+ # a different Amazon Web Services account, you must use the key ARN.
#
# For example:
#
@@ -613,68 +1206,121 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
# @option params [required, String] :grantee_principal
- # The principal that is given permission to perform the operations that
- # the grant permits.
+ # The identity that gets the permissions specified in the grant.
#
- # To specify the principal, use the [Amazon Resource Name (ARN)][1] of
- # an AWS principal. Valid AWS principals include AWS accounts (root),
- # IAM users, IAM roles, federated users, and assumed role users. For
- # examples of the ARN syntax to use for specifying a principal, see [AWS
- # Identity and Access Management (IAM)][2] in the Example ARNs section
- # of the *AWS General Reference*.
+ # To specify the grantee principal, use the Amazon Resource Name (ARN)
+ # of an Amazon Web Services principal. Valid principals include Amazon
+ # Web Services accounts, IAM users, IAM roles, federated users, and
+ # assumed role users. For help with the ARN syntax for a principal, see
+ # [IAM ARNs][1] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
#
#
#
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
#
# @option params [String] :retiring_principal
- # The principal that is given permission to retire the grant by using
- # RetireGrant operation.
+ # The principal that has permission to use the RetireGrant operation to
+ # retire the grant.
#
# To specify the principal, use the [Amazon Resource Name (ARN)][1] of
- # an AWS principal. Valid AWS principals include AWS accounts (root),
- # IAM users, federated users, and assumed role users. For examples of
- # the ARN syntax to use for specifying a principal, see [AWS Identity
- # and Access Management (IAM)][2] in the Example ARNs section of the
- # *AWS General Reference*.
+ # an Amazon Web Services principal. Valid principals include Amazon Web
+ # Services accounts, IAM users, IAM roles, federated users, and assumed
+ # role users. For help with the ARN syntax for a principal, see [IAM
+ # ARNs][2] in the <i> <i>Identity and Access Management User Guide</i>
+ # </i>.
+ #
+ # The grant determines the retiring principal. Other principals might
+ # have permission to retire the grant or revoke the grant. For details,
+ # see RevokeGrant and [Retiring and revoking grants][3] in the *Key
+ # Management Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete
#
# @option params [required, Array<String>] :operations
# A list of operations that the grant permits.
#
- # @option params [Types::GrantConstraints] :constraints
- # Allows a cryptographic operation only when the encryption context
- # matches or includes the encryption context specified in this
- # structure. For more information about encryption context, see
- # [Encryption Context][1] in the <i> <i>AWS Key Management Service
- # Developer Guide</i> </i>.
+ # This list must include only operations that are permitted in a grant.
+ # Also, the operation must be supported on the KMS key. For example, you
+ # cannot create a grant for a symmetric encryption KMS key that allows
+ # the Sign operation, or a grant for an asymmetric KMS key that allows
+ # the GenerateDataKey operation. If you try, KMS returns a
+ # `ValidationError` exception. For details, see [Grant operations][1] in
+ # the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
+ #
+ # @option params [Types::GrantConstraints] :constraints
+ # Specifies a grant constraint.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # KMS supports the `EncryptionContextEquals` and
+ # `EncryptionContextSubset` grant constraints, which allow the
+ # permissions in the grant only when the encryption context in the
+ # request matches (`EncryptionContextEquals`) or includes
+ # (`EncryptionContextSubset`) the encryption context specified in the
+ # constraint.
+ #
+ # The encryption context grant constraints are supported only on [grant
+ # operations][1] that include an `EncryptionContext` parameter, such as
+ # cryptographic operations on symmetric encryption KMS keys. Grants with
+ # grant constraints can include the DescribeKey and RetireGrant
+ # operations, but the constraint doesn't apply to these operations. If
+ # a grant with a grant constraint includes the `CreateGrant` operation,
+ # the constraint requires that any grants created with the `CreateGrant`
+ # permission have an equally strict or stricter encryption context
+ # constraint.
+ #
+ # You cannot use an encryption context grant constraint for
+ # cryptographic operations with asymmetric KMS keys or HMAC KMS keys.
+ # Operations with these keys don't support an encryption context.
+ #
+ # Each constraint value can include up to 8 encryption context pairs.
+ # The encryption context value in each constraint cannot exceed 384
+ # characters. For information about grant constraints, see [Using grant
+ # constraints][2] in the *Key Management Service Developer Guide*. For
+ # more information about encryption context, see [Encryption context][3]
+ # in the <i> <i>Key Management Service Developer Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
#
# @option params [Array<String>] :grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
#
# @option params [String] :name
- # A friendly name for identifying the grant. Use this value to prevent
- # the unintended creation of duplicate grants when retrying this
- # request.
+ # A friendly name for the grant. Use this value to prevent the
+ # unintended creation of duplicate grants when retrying this request.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
# When this value is absent, all `CreateGrant` requests result in a new
# grant with a unique `GrantId` even if all the supplied parameters are
@@ -685,8 +1331,19 @@ module Aws::KMS
# identical parameters; if the grant already exists, the original
# `GrantId` is returned without creating a new grant. Note that the
# returned grant token is unique with every `CreateGrant` request, even
- # when a duplicate `GrantId` is returned. All grant tokens obtained in
- # this way can be used interchangeably.
+ # when a duplicate `GrantId` is returned. All grant tokens for the same
+ # grant ID can be used interchangeably.
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
#
# @return [Types::CreateGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -696,12 +1353,11 @@ module Aws::KMS
#
# @example Example: To create a grant
#
- # # The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer
- # # master key (CMK).
+ # # The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key.
#
# resp = client.create_grant({
# grantee_principal: "arn:aws:iam::111122223333:role/ExampleRole", # The identity that is given permission to perform the operations specified in the grant.
- # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# operations: [
# "Encrypt",
# "Decrypt",
@@ -720,7 +1376,7 @@ module Aws::KMS
# key_id: "KeyIdType", # required
# grantee_principal: "PrincipalIdType", # required
# retiring_principal: "PrincipalIdType",
- # operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
+ # operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, Sign, Verify, GetPublicKey, CreateGrant, RetireGrant, DescribeKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GenerateMac, VerifyMac
# constraints: {
# encryption_context_subset: {
# "EncryptionContextKey" => "EncryptionContextValue",
@@ -731,6 +1387,7 @@ module Aws::KMS
# },
# grant_tokens: ["GrantTokenType"],
# name: "GrantNameType",
+ # dry_run: false,
# })
#
# @example Response structure
@@ -747,653 +1404,766 @@ module Aws::KMS
req.send_request(options)
end
- # Creates a customer managed [customer master key][1] (CMK) in your AWS
- # account.
+ # Creates a unique customer managed [KMS key][1] in your Amazon Web
+ # Services account and Region. You can use a KMS key in cryptographic
+ # operations, such as encryption and signing. Some Amazon Web Services
+ # services let you use KMS keys that you create and manage to protect
+ # your service resources.
+ #
+ # A KMS key is a logical representation of a cryptographic key. In
+ # addition to the key material used in cryptographic operations, a KMS
+ # key includes metadata, such as the key ID, key policy, creation date,
+ # description, and key state. For details, see [Managing keys][2] in the
+ # *Key Management Service Developer Guide*
+ #
+ # Use the parameters of `CreateKey` to specify the type of KMS key, the
+ # source of its key material, its key policy, description, tags, and
+ # other properties.
+ #
+ # <note markdown="1"> KMS has replaced the term *customer master key (CMK)* with *KMS key*
+ # and *KMS key*. The concept has not changed. To prevent breaking
+ # changes, KMS is keeping some variations of this term.
#
- # You can use a CMK to encrypt small amounts of data (up to 4096 bytes)
- # directly. But CMKs are more commonly used to encrypt the [data
- # keys][2] that are used to encrypt data.
+ # </note>
#
- # To create a CMK for imported key material, use the `Origin` parameter
- # with a value of `EXTERNAL`.
+ # To create different types of KMS keys, use the following guidance:
#
- # To create a CMK in a [custom key store][3], use the `CustomKeyStoreId`
- # parameter to specify the custom key store. You must also use the
- # `Origin` parameter with a value of `AWS_CLOUDHSM`. The AWS CloudHSM
- # cluster that is associated with the custom key store must have at
- # least two active HSMs in different Availability Zones in the AWS
- # Region.
+ # Symmetric encryption KMS key
#
- # You cannot use this operation to create a CMK in a different AWS
- # account.
+ # : By default, `CreateKey` creates a symmetric encryption KMS key with
+ # key material that KMS generates. This is the basic and most widely
+ # used type of KMS key, and provides the best performance.
#
+ # To create a symmetric encryption KMS key, you don't need to specify
+ # any parameters. The default value for `KeySpec`,
+ # `SYMMETRIC_DEFAULT`, the default value for `KeyUsage`,
+ # `ENCRYPT_DECRYPT`, and the default value for `Origin`, `AWS_KMS`,
+ # create a symmetric encryption KMS key with KMS key material.
#
+ # If you need a key for basic encryption and decryption or you are
+ # creating a KMS key to protect your resources in an Amazon Web
+ # Services service, create a symmetric encryption KMS key. The key
+ # material in a symmetric encryption key never leaves KMS unencrypted.
+ # You can use a symmetric encryption KMS key to encrypt and decrypt
+ # data up to 4,096 bytes, but they are typically used to generate data
+ # keys and data keys pairs. For details, see GenerateDataKey and
+ # GenerateDataKeyPair.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
#
- # @option params [String] :policy
- # The key policy to attach to the CMK.
#
- # If you provide a key policy, it must meet the following criteria:
+ # Asymmetric KMS keys
#
- # * If you don't set `BypassPolicyLockoutSafetyCheck` to true, the key
- # policy must allow the principal that is making the `CreateKey`
- # request to make a subsequent PutKeyPolicy request on the CMK. This
- # reduces the risk that the CMK becomes unmanageable. For more
- # information, refer to the scenario in the [Default Key Policy][1]
- # section of the <i> <i>AWS Key Management Service Developer Guide</i>
- # </i>.
+ # : To create an asymmetric KMS key, use the `KeySpec` parameter to
+ # specify the type of key material in the KMS key. Then, use the
+ # `KeyUsage` parameter to determine whether the KMS key will be used
+ # to encrypt and decrypt or sign and verify. You can't change these
+ # properties after the KMS key is created.
#
- # * Each statement in the key policy must contain one or more
- # principals. The principals in the key policy must exist and be
- # visible to AWS KMS. When you create a new AWS principal (for
- # example, an IAM user or role), you might need to enforce a delay
- # before including the new principal in a key policy because the new
- # principal might not be immediately visible to AWS KMS. For more
- # information, see [Changes that I make are not always immediately
- # visible][2] in the *AWS Identity and Access Management User Guide*.
+ # Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC)
+ # key pair, or an SM2 key pair (China Regions only). The private key
+ # in an asymmetric KMS key never leaves KMS unencrypted. However, you
+ # can use the GetPublicKey operation to download the public key so it
+ # can be used outside of KMS. KMS keys with RSA or SM2 key pairs can
+ # be used to encrypt or decrypt data or sign and verify messages (but
+ # not both). KMS keys with ECC key pairs can be used only to sign and
+ # verify messages. For information about asymmetric KMS keys, see
+ # [Asymmetric KMS keys][3] in the *Key Management Service Developer
+ # Guide*.
#
- # If you do not provide a key policy, AWS KMS attaches a default key
- # policy to the CMK. For more information, see [Default Key Policy][3]
- # in the *AWS Key Management Service Developer Guide*.
#
- # The key policy size limit is 32 kilobytes (32768 bytes).
#
+ # HMAC KMS key
#
+ # : To create an HMAC KMS key, set the `KeySpec` parameter to a key spec
+ # value for HMAC KMS keys. Then set the `KeyUsage` parameter to
+ # `GENERATE_VERIFY_MAC`. You must set the key usage even though
+ # `GENERATE_VERIFY_MAC` is the only valid key usage value for HMAC KMS
+ # keys. You can't change these properties after the KMS key is
+ # created.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default
+ # HMAC KMS keys are symmetric keys that never leave KMS unencrypted.
+ # You can use HMAC keys to generate (GenerateMac) and verify
+ # (VerifyMac) HMAC codes for messages up to 4096 bytes.
#
- # @option params [String] :description
- # A description of the CMK.
#
- # Use a description that helps you decide whether the CMK is appropriate
- # for a task.
#
- # @option params [String] :key_usage
- # The cryptographic operations for which you can use the CMK. The only
- # valid value is `ENCRYPT_DECRYPT`, which means you can use the CMK to
- # encrypt and decrypt data.
+ # Multi-Region primary keys
+ # Imported key material
#
- # @option params [String] :origin
- # The source of the key material for the CMK. You cannot change the
- # origin after you create the CMK.
+ # : To create a multi-Region *primary key* in the local Amazon Web
+ # Services Region, use the `MultiRegion` parameter with a value of
+ # `True`. To create a multi-Region *replica key*, that is, a KMS key
+ # with the same key ID and key material as a primary key, but in a
+ # different Amazon Web Services Region, use the ReplicateKey
+ # operation. To change a replica key to a primary key, and its primary
+ # key to a replica key, use the UpdatePrimaryRegion operation.
#
- # The default is `AWS_KMS`, which means AWS KMS creates the key material
- # in its own key store.
+ # You can create multi-Region KMS keys for all supported KMS key
+ # types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric
+ # encryption KMS keys, and asymmetric signing KMS keys. You can also
+ # create multi-Region keys with imported key material. However, you
+ # can't create multi-Region keys in a custom key store.
#
- # When the parameter value is `EXTERNAL`, AWS KMS creates a CMK without
- # key material so that you can import key material from your existing
- # key management infrastructure. For more information about importing
- # key material into AWS KMS, see [Importing Key Material][1] in the *AWS
- # Key Management Service Developer Guide*.
+ # This operation supports *multi-Region keys*, an KMS feature that
+ # lets you create multiple interoperable KMS keys in different Amazon
+ # Web Services Regions. Because these KMS keys have the same key ID,
+ # key material, and other metadata, you can use them interchangeably
+ # to encrypt data in one Amazon Web Services Region and decrypt it in
+ # a different Amazon Web Services Region without re-encrypting the
+ # data or making a cross-Region call. For more information about
+ # multi-Region keys, see [Multi-Region keys in KMS][4] in the *Key
+ # Management Service Developer Guide*.
#
- # When the parameter value is `AWS_CLOUDHSM`, AWS KMS creates the CMK in
- # an AWS KMS [custom key store][2] and creates its key material in the
- # associated AWS CloudHSM cluster. You must also use the
- # `CustomKeyStoreId` parameter to identify the custom key store.
#
#
+ # : To import your own key material into a KMS key, begin by creating a
+ # KMS key with no key material. To do this, use the `Origin` parameter
+ # of `CreateKey` with a value of `EXTERNAL`. Next, use
+ # GetParametersForImport operation to get a public key and import
+ # token. Use the wrapping public key to encrypt your key material.
+ # Then, use ImportKeyMaterial with your import token to import the key
+ # material. For step-by-step instructions, see [Importing Key
+ # Material][5] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # You can import key material into KMS keys of all supported KMS key
+ # types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric
+ # encryption KMS keys, and asymmetric signing KMS keys. You can also
+ # create multi-Region keys with imported key material. However, you
+ # can't import key material into a KMS key in a custom key store.
+ #
+ # To create a multi-Region primary key with imported key material, use
+ # the `Origin` parameter of `CreateKey` with a value of `EXTERNAL` and
+ # the `MultiRegion` parameter with a value of `True`. To create
+ # replicas of the multi-Region primary key, use the ReplicateKey
+ # operation. For instructions, see [Importing key material into
+ # multi-Region keys][6]. For more information about multi-Region keys,
+ # see [Multi-Region keys in KMS][4] in the *Key Management Service
+ # Developer Guide*.
#
- # @option params [String] :custom_key_store_id
- # Creates the CMK in the specified [custom key store][1] and the key
- # material in its associated AWS CloudHSM cluster. To create a CMK in a
- # custom key store, you must also specify the `Origin` parameter with a
- # value of `AWS_CLOUDHSM`. The AWS CloudHSM cluster that is associated
- # with the custom key store must have at least two active HSMs, each in
- # a different Availability Zone in the Region.
- #
- # To find the ID of a custom key store, use the DescribeCustomKeyStores
- # operation.
#
- # The response includes the custom key store ID and the ID of the AWS
- # CloudHSM cluster.
#
- # This operation is part of the [Custom Key Store feature][1] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # Custom key store
#
+ # : A [custom key store][7] lets you protect your Amazon Web Services
+ # resources using keys in a backing key store that you own and manage.
+ # When you request a cryptographic operation with a KMS key in a
+ # custom key store, the operation is performed in the backing key
+ # store using its cryptographic keys.
#
+ # KMS supports [CloudHSM key stores][8] backed by an CloudHSM cluster
+ # and [external key stores][9] backed by an external key manager
+ # outside of Amazon Web Services. When you create a KMS key in an
+ # CloudHSM key store, KMS generates an encryption key in the CloudHSM
+ # cluster and associates it with the KMS key. When you create a KMS
+ # key in an external key store, you specify an existing encryption key
+ # in the external key manager.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # <note markdown="1"> Some external key managers provide a simpler method for creating a
+ # KMS key in an external key store. For details, see your external key
+ # manager documentation.
#
- # @option params [Boolean] :bypass_policy_lockout_safety_check
- # A flag to indicate whether to bypass the key policy lockout safety
- # check.
+ # </note>
#
- # Setting this value to true increases the risk that the CMK becomes
- # unmanageable. Do not set this value to true indiscriminately.
+ # Before you create a KMS key in a custom key store, the
+ # `ConnectionState` of the key store must be `CONNECTED`. To connect
+ # the custom key store, use the ConnectCustomKeyStore operation. To
+ # find the `ConnectionState`, use the DescribeCustomKeyStores
+ # operation.
#
- # For more information, refer to the scenario in the [Default Key
- # Policy][1] section in the <i> <i>AWS Key Management Service Developer
- # Guide</i> </i>.
+ # To create a KMS key in a custom key store, use the
+ # `CustomKeyStoreId`. Use the default `KeySpec` value,
+ # `SYMMETRIC_DEFAULT`, and the default `KeyUsage` value,
+ # `ENCRYPT_DECRYPT` to create a symmetric encryption key. No other key
+ # type is supported in a custom key store.
#
- # Use this parameter only when you include a policy in the request and
- # you intend to prevent the principal that is making the request from
- # making a subsequent PutKeyPolicy request on the CMK.
+ # To create a KMS key in an [CloudHSM key store][8], use the `Origin`
+ # parameter with a value of `AWS_CLOUDHSM`. The CloudHSM cluster that
+ # is associated with the custom key store must have at least two
+ # active HSMs in different Availability Zones in the Amazon Web
+ # Services Region.
#
- # The default value is false.
+ # To create a KMS key in an [external key store][9], use the `Origin`
+ # parameter with a value of `EXTERNAL_KEY_STORE` and an `XksKeyId`
+ # parameter that identifies an existing external key.
#
+ # <note markdown="1"> Some external key managers provide a simpler method for creating a
+ # KMS key in an external key store. For details, see your external key
+ # manager documentation.
#
+ # </note>
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
+ # **Cross-account use**: No. You cannot use this operation to create a
+ # KMS key in a different Amazon Web Services account.
#
- # @option params [Array<Types::Tag>] :tags
- # One or more tags. Each tag consists of a tag key and a tag value. Tag
- # keys and tag values are both required, but tag values can be empty
- # (null) strings.
+ # **Required permissions**: [kms:CreateKey][10] (IAM policy). To use the
+ # `Tags` parameter, [kms:TagResource][10] (IAM policy). For examples and
+ # information about related permissions, see [Allow a user to create KMS
+ # keys][11] in the *Key Management Service Developer Guide*.
#
- # Use this parameter to tag the CMK when it is created. Alternately, you
- # can omit this parameter and instead tag the CMK after it is created
- # using TagResource.
+ # **Related operations:**
#
- # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # * DescribeKey
#
- # * {Types::CreateKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata
+ # * ListKeys
#
+ # * ScheduleKeyDeletion
#
- # @example Example: To create a customer master key (CMK)
#
- # # The following example creates a CMK.
#
- # resp = client.create_key({
- # tags: [
- # {
- # tag_key: "CreatedBy",
- # tag_value: "ExampleUser",
- # },
- # ], # One or more tags. Each tag consists of a tag key and a tag value.
- # })
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key
#
- # resp.to_h outputs the following:
- # {
- # key_metadata: {
- # aws_account_id: "111122223333",
- # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
- # description: "",
- # enabled: true,
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
- # key_manager: "CUSTOMER",
- # key_state: "Enabled",
- # key_usage: "ENCRYPT_DECRYPT",
- # origin: "AWS_KMS",
- # }, # An object that contains information about the CMK created by this operation.
- # }
- #
- # @example Request syntax with placeholder values
- #
- # resp = client.create_key({
- # policy: "PolicyType",
- # description: "DescriptionType",
- # key_usage: "ENCRYPT_DECRYPT", # accepts ENCRYPT_DECRYPT
- # origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL, AWS_CLOUDHSM
- # custom_key_store_id: "CustomKeyStoreIdType",
- # bypass_policy_lockout_safety_check: false,
- # tags: [
- # {
- # tag_key: "TagKeyType", # required
- # tag_value: "TagValueType", # required
- # },
- # ],
- # })
- #
- # @example Response structure
- #
- # resp.key_metadata.aws_account_id #=> String
- # resp.key_metadata.key_id #=> String
- # resp.key_metadata.arn #=> String
- # resp.key_metadata.creation_date #=> Time
- # resp.key_metadata.enabled #=> Boolean
- # resp.key_metadata.description #=> String
- # resp.key_metadata.key_usage #=> String, one of "ENCRYPT_DECRYPT"
- # resp.key_metadata.key_state #=> String, one of "Enabled", "Disabled", "PendingDeletion", "PendingImport", "Unavailable"
- # resp.key_metadata.deletion_date #=> Time
- # resp.key_metadata.valid_to #=> Time
- # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM"
- # resp.key_metadata.custom_key_store_id #=> String
- # resp.key_metadata.cloud_hsm_cluster_id #=> String
- # resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
- # resp.key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey AWS API Documentation
- #
- # @overload create_key(params = {})
- # @param [Hash] params ({})
- def create_key(params = {}, options = {})
- req = build_request(:create_key, params)
- req.send_request(options)
- end
-
- # Decrypts ciphertext. Ciphertext is plaintext that has been previously
- # encrypted by using any of the following operations:
+ # @option params [String] :policy
+ # The key policy to attach to the KMS key.
#
- # * GenerateDataKey
+ # If you provide a key policy, it must meet the following criteria:
#
- # * GenerateDataKeyWithoutPlaintext
+ # * The key policy must allow the calling principal to make a subsequent
+ # `PutKeyPolicy` request on the KMS key. This reduces the risk that
+ # the KMS key becomes unmanageable. For more information, see [Default
+ # key policy][1] in the *Key Management Service Developer Guide*. (To
+ # omit this condition, set `BypassPolicyLockoutSafetyCheck` to true.)
#
- # * Encrypt
+ # * Each statement in the key policy must contain one or more
+ # principals. The principals in the key policy must exist and be
+ # visible to KMS. When you create a new Amazon Web Services principal,
+ # you might need to enforce a delay before including the new principal
+ # in a key policy because the new principal might not be immediately
+ # visible to KMS. For more information, see [Changes that I make are
+ # not always immediately visible][2] in the *Amazon Web Services
+ # Identity and Access Management User Guide*.
#
- # Whenever possible, use key policies to give users permission to call
- # the Decrypt operation on the CMK, instead of IAM policies. Otherwise,
- # you might create an IAM user policy that gives the user Decrypt
- # permission on all CMKs. This user could decrypt ciphertext that was
- # encrypted by CMKs in other accounts if the key policy for the
- # cross-account CMK permits it. If you must use an IAM policy for
- # `Decrypt` permissions, limit the user to particular CMKs or particular
- # trusted accounts.
+ # If you do not provide a key policy, KMS attaches a default key policy
+ # to the KMS key. For more information, see [Default key policy][3] in
+ # the *Key Management Service Developer Guide*.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # The key policy size quota is 32 kilobytes (32768 bytes).
#
+ # For help writing and formatting a JSON policy document, see the [IAM
+ # JSON Policy Reference][4] in the <i> <i>Identity and Access Management
+ # User Guide</i> </i>.
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
#
- # @option params [required, String, IO] :ciphertext_blob
- # Ciphertext to be decrypted. The blob includes metadata.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default
+ # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
#
- # @option params [Hash<String,String>] :encryption_context
- # The encryption context. If this was specified in the Encrypt function,
- # it must be specified here or the decryption operation will fail. For
- # more information, see [Encryption Context][1].
+ # @option params [String] :description
+ # A description of the KMS key. Use a description that helps you decide
+ # whether the KMS key is appropriate for a task. The default value is an
+ # empty string (no description).
#
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
+ # To set or change the description after the key is created, use
+ # UpdateKeyDescription.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @option params [String] :key_usage
+ # Determines the [cryptographic operations][1] for which you can use the
+ # KMS key. The default value is `ENCRYPT_DECRYPT`. This parameter is
+ # optional when you are creating a symmetric encryption KMS key;
+ # otherwise, it is required. You can't change the `KeyUsage` value
+ # after the KMS key is created.
#
- # @option params [Array<String>] :grant_tokens
- # A list of grant tokens.
+ # Select only one valid value.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # * For symmetric encryption KMS keys, omit the parameter or specify
+ # `ENCRYPT_DECRYPT`.
#
+ # * For HMAC KMS keys (symmetric), specify `GENERATE_VERIFY_MAC`.
#
+ # * For asymmetric KMS keys with RSA key material, specify
+ # `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # * For asymmetric KMS keys with ECC key material, specify
+ # `SIGN_VERIFY`.
#
- # @return [Types::DecryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # * For asymmetric KMS keys with SM2 key material (China Regions only),
+ # specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
#
- # * {Types::DecryptResponse#key_id #key_id} => String
- # * {Types::DecryptResponse#plaintext #plaintext} => String
#
#
- # @example Example: To decrypt data
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
#
- # # The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.
+ # @option params [String] :customer_master_key_spec
+ # Instead, use the `KeySpec` parameter.
#
- # resp = client.decrypt({
- # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
- # })
+ # The `KeySpec` and `CustomerMasterKeySpec` parameters work the same
+ # way. Only the names differ. We recommend that you use `KeySpec`
+ # parameter in your code. However, to avoid breaking changes, KMS
+ # supports both parameters.
#
- # resp.to_h outputs the following:
- # {
- # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.
- # plaintext: "<binary data>", # The decrypted (plaintext) data.
- # }
+ # @option params [String] :key_spec
+ # Specifies the type of KMS key to create. The default value,
+ # `SYMMETRIC_DEFAULT`, creates a KMS key with a 256-bit AES-GCM key that
+ # is used for encryption and decryption, except in China Regions, where
+ # it creates a 128-bit symmetric key that uses SM4 encryption. For help
+ # choosing a key spec for your KMS key, see [Choosing a KMS key type][1]
+ # in the <i> <i>Key Management Service Developer Guide</i> </i>.
+ #
+ # The `KeySpec` determines whether the KMS key contains a symmetric key
+ # or an asymmetric key pair. It also determines the algorithms that the
+ # KMS key supports. You can't change the `KeySpec` after the KMS key is
+ # created. To further restrict the algorithms that can be used with the
+ # KMS key, use a condition key in its key policy or IAM policy. For more
+ # information, see [kms:EncryptionAlgorithm][2], [kms:MacAlgorithm][3]
+ # or [kms:Signing Algorithm][4] in the <i> <i>Key Management Service
+ # Developer Guide</i> </i>.
#
- # @example Request syntax with placeholder values
+ # [Amazon Web Services services that are integrated with KMS][5] use
+ # symmetric encryption KMS keys to protect your data. These services do
+ # not support asymmetric KMS keys or HMAC KMS keys.
#
- # resp = client.decrypt({
- # ciphertext_blob: "data", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
- # })
+ # KMS supports the following key specs for KMS keys:
#
- # @example Response structure
+ # * Symmetric encryption key (default)
#
- # resp.key_id #=> String
- # resp.plaintext #=> String
+ # * `SYMMETRIC_DEFAULT`
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt AWS API Documentation
+ # ^
#
- # @overload decrypt(params = {})
- # @param [Hash] params ({})
- def decrypt(params = {}, options = {})
- req = build_request(:decrypt, params)
- req.send_request(options)
- end
-
- # Deletes the specified alias. You cannot perform this operation on an
- # alias in a different AWS account.
+ # * HMAC keys (symmetric)
#
- # Because an alias is not a property of a CMK, you can delete and change
- # the aliases of a CMK without affecting the CMK. Also, aliases do not
- # appear in the response from the DescribeKey operation. To get the
- # aliases of all CMKs, use the ListAliases operation.
+ # * `HMAC_224`
#
- # Each CMK can have multiple aliases. To change the alias of a CMK, use
- # DeleteAlias to delete the current alias and CreateAlias to create a
- # new alias. To associate an existing alias with a different customer
- # master key (CMK), call UpdateAlias.
+ # * `HMAC_256`
#
- # @option params [required, String] :alias_name
- # The alias to be deleted. The alias name must begin with `alias/`
- # followed by the alias name, such as `alias/ExampleAlias`.
+ # * `HMAC_384`
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # * `HMAC_512`
#
+ # * Asymmetric RSA key pairs
#
- # @example Example: To delete an alias
+ # * `RSA_2048`
#
- # # The following example deletes the specified alias.
+ # * `RSA_3072`
#
- # resp = client.delete_alias({
- # alias_name: "alias/ExampleAlias", # The alias to delete.
- # })
+ # * `RSA_4096`
#
- # @example Request syntax with placeholder values
+ # * Asymmetric NIST-recommended elliptic curve key pairs
#
- # resp = client.delete_alias({
- # alias_name: "AliasNameType", # required
- # })
+ # * `ECC_NIST_P256` (secp256r1)
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias AWS API Documentation
+ # * `ECC_NIST_P384` (secp384r1)
#
- # @overload delete_alias(params = {})
- # @param [Hash] params ({})
- def delete_alias(params = {}, options = {})
- req = build_request(:delete_alias, params)
- req.send_request(options)
- end
-
- # Deletes a [custom key store][1]. This operation does not delete the
- # AWS CloudHSM cluster that is associated with the custom key store, or
- # affect any users or keys in the cluster.
- #
- # The custom key store that you delete cannot contain any AWS KMS
- # [customer master keys (CMKs)][2]. Before deleting the key store,
- # verify that you will never need to use any of the CMKs in the key
- # store for any cryptographic operations. Then, use ScheduleKeyDeletion
- # to delete the AWS KMS customer master keys (CMKs) from the key store.
- # When the scheduled waiting period expires, the `ScheduleKeyDeletion`
- # operation deletes the CMKs. Then it makes a best effort to delete the
- # key material from the associated cluster. However, you might need to
- # manually [delete the orphaned key material][3] from the cluster and
- # its backups.
- #
- # After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore
- # to disconnect the key store from AWS KMS. Then, you can delete the
- # custom key store.
- #
- # Instead of deleting the custom key store, consider using
- # DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key
- # store is disconnected, you cannot create or use the CMKs in the key
- # store. But, you do not need to delete CMKs and you can reconnect a
- # disconnected custom key store at any time.
+ # * `ECC_NIST_P521` (secp521r1)
#
- # If the operation succeeds, it returns a JSON object with no
- # properties.
+ # * Other asymmetric elliptic curve key pairs
#
- # This operation is part of the [Custom Key Store feature][1] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # * `ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies.
#
+ # ^
#
+ # * SM2 key pairs (China Regions only)
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key
+ # * `SM2`
#
- # @option params [required, String] :custom_key_store_id
- # Enter the ID of the custom key store you want to delete. To find the
- # ID of a custom key store, use the DescribeCustomKeyStores operation.
+ # ^
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
- # @example Request syntax with placeholder values
#
- # resp = client.delete_custom_key_store({
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # })
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm
+ # [5]: http://aws.amazon.com/kms/features/#AWS_Service_Integration
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStore AWS API Documentation
+ # @option params [String] :origin
+ # The source of the key material for the KMS key. You cannot change the
+ # origin after you create the KMS key. The default is `AWS_KMS`, which
+ # means that KMS creates the key material.
#
- # @overload delete_custom_key_store(params = {})
- # @param [Hash] params ({})
- def delete_custom_key_store(params = {}, options = {})
- req = build_request(:delete_custom_key_store, params)
- req.send_request(options)
- end
-
- # Deletes key material that you previously imported. This operation
- # makes the specified customer master key (CMK) unusable. For more
- # information about importing key material into AWS KMS, see [Importing
- # Key Material][1] in the *AWS Key Management Service Developer Guide*.
- # You cannot perform this operation on a CMK in a different AWS account.
+ # To [create a KMS key with no key material][1] (for imported key
+ # material), set this value to `EXTERNAL`. For more information about
+ # importing key material into KMS, see [Importing Key Material][2] in
+ # the *Key Management Service Developer Guide*. The `EXTERNAL` origin
+ # value is valid only for symmetric KMS keys.
#
- # When the specified CMK is in the `PendingDeletion` state, this
- # operation does not change the CMK's state. Otherwise, it changes the
- # CMK's state to `PendingImport`.
+ # To [create a KMS key in an CloudHSM key store][3] and create its key
+ # material in the associated CloudHSM cluster, set this value to
+ # `AWS_CLOUDHSM`. You must also use the `CustomKeyStoreId` parameter to
+ # identify the CloudHSM key store. The `KeySpec` value must be
+ # `SYMMETRIC_DEFAULT`.
#
- # After you delete key material, you can use ImportKeyMaterial to
- # reimport the same key material into the CMK.
+ # To [create a KMS key in an external key store][4], set this value to
+ # `EXTERNAL_KEY_STORE`. You must also use the `CustomKeyStoreId`
+ # parameter to identify the external key store and the `XksKeyId`
+ # parameter to identify the associated external key. The `KeySpec` value
+ # must be `SYMMETRIC_DEFAULT`.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
#
#
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # @option params [String] :custom_key_store_id
+ # Creates the KMS key in the specified [custom key store][1]. The
+ # `ConnectionState` of the custom key store must be `CONNECTED`. To find
+ # the CustomKeyStoreID and ConnectionState use the
+ # DescribeCustomKeyStores operation.
#
- # @option params [required, String] :key_id
- # Identifies the CMK from which you are deleting imported key material.
- # The `Origin` of the CMK must be `EXTERNAL`.
+ # This parameter is valid only for symmetric encryption KMS keys in a
+ # single Region. You cannot create any other type of KMS key in a custom
+ # key store.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # When you create a KMS key in an CloudHSM key store, KMS generates a
+ # non-exportable 256-bit symmetric key in its associated CloudHSM
+ # cluster and associates it with the KMS key. When you create a KMS key
+ # in an external key store, you must use the `XksKeyId` parameter to
+ # specify an external key that serves as key material for the KMS key.
#
- # For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # @option params [Boolean] :bypass_policy_lockout_safety_check
+ # Skips ("bypasses") the key policy lockout safety check. The default
+ # value is false.
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # Setting this value to true increases the risk that the KMS key becomes
+ # unmanageable. Do not set this value to true indiscriminately.
#
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
#
- # @example Example: To delete imported key material
+ # Use this parameter only when you intend to prevent the principal that
+ # is making the request from making a subsequent PutKeyPolicy request on
+ # the KMS key.
#
- # # The following example deletes the imported key material from the specified customer master key (CMK).
#
- # resp = client.delete_imported_key_material({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # })
#
- # @example Request syntax with placeholder values
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
#
- # resp = client.delete_imported_key_material({
- # key_id: "KeyIdType", # required
- # })
+ # @option params [Array<Types::Tag>] :tags
+ # Assigns one or more tags to the KMS key. Use this parameter to tag the
+ # KMS key when it is created. To tag an existing KMS key, use the
+ # TagResource operation.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial AWS API Documentation
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
- # @overload delete_imported_key_material(params = {})
- # @param [Hash] params ({})
- def delete_imported_key_material(params = {}, options = {})
- req = build_request(:delete_imported_key_material, params)
- req.send_request(options)
- end
-
- # Gets information about [custom key stores][1] in the account and
- # region.
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the KMS
+ # key. For details, see [ABAC for KMS][1] in the *Key Management Service
+ # Developer Guide*.
#
- # This operation is part of the [Custom Key Store feature][1] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # </note>
#
- # By default, this operation returns information about all custom key
- # stores in the account and region. To get only information about a
- # particular custom key store, use either the `CustomKeyStoreName` or
- # `CustomKeyStoreId` parameter (but not both).
+ # To use this parameter, you must have [kms:TagResource][2] permission
+ # in an IAM policy.
#
- # To determine whether the custom key store is connected to its AWS
- # CloudHSM cluster, use the `ConnectionState` element in the response.
- # If an attempt to connect the custom key store failed, the
- # `ConnectionState` value is `FAILED` and the `ConnectionErrorCode`
- # element in the response indicates the cause of the failure. For help
- # interpreting the `ConnectionErrorCode`, see CustomKeyStoresListEntry.
+ # Each tag consists of a tag key and a tag value. Both the tag key and
+ # the tag value are required, but the tag value can be an empty (null)
+ # string. You cannot have more than one tag on a KMS key with the same
+ # tag key. If you specify an existing tag key with a different tag
+ # value, KMS replaces the current tag value with the specified one.
#
- # Custom key stores have a `DISCONNECTED` connection state if the key
- # store has never been connected or you use the DisconnectCustomKeyStore
- # operation to disconnect it. If your custom key store state is
- # `CONNECTED` but you are having trouble using it, make sure that its
- # associated AWS CloudHSM cluster is active and contains the minimum
- # number of HSMs required for the operation, if any.
- #
- # For help repairing your custom key store, see the [Troubleshooting
- # Custom Key Stores][2] topic in the *AWS Key Management Service
- # Developer Guide*.
+ # When you add tags to an Amazon Web Services resource, Amazon Web
+ # Services generates a cost allocation report with usage and costs
+ # aggregated by tags. Tags can also be used to control access to a KMS
+ # key. For details, see [Tagging Keys][3].
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
#
- # @option params [String] :custom_key_store_id
- # Gets only information about the specified custom key store. Enter the
- # key store ID.
+ # @option params [Boolean] :multi_region
+ # Creates a multi-Region primary key that you can replicate into other
+ # Amazon Web Services Regions. You cannot change this value after you
+ # create the KMS key.
#
- # By default, this operation gets information about all custom key
- # stores in the account and region. To limit the output to a particular
- # custom key store, you can use either the `CustomKeyStoreId` or
- # `CustomKeyStoreName` parameter, but not both.
+ # For a multi-Region key, set this parameter to `True`. For a
+ # single-Region KMS key, omit this parameter or set it to `False`. The
+ # default value is `False`.
#
- # @option params [String] :custom_key_store_name
- # Gets only information about the specified custom key store. Enter the
- # friendly name of the custom key store.
+ # This operation supports *multi-Region keys*, an KMS feature that lets
+ # you create multiple interoperable KMS keys in different Amazon Web
+ # Services Regions. Because these KMS keys have the same key ID, key
+ # material, and other metadata, you can use them interchangeably to
+ # encrypt data in one Amazon Web Services Region and decrypt it in a
+ # different Amazon Web Services Region without re-encrypting the data or
+ # making a cross-Region call. For more information about multi-Region
+ # keys, see [Multi-Region keys in KMS][1] in the *Key Management Service
+ # Developer Guide*.
#
- # By default, this operation gets information about all custom key
- # stores in the account and region. To limit the output to a particular
- # custom key store, you can use either the `CustomKeyStoreId` or
- # `CustomKeyStoreName` parameter, but not both.
+ # This value creates a *primary key*, not a replica. To create a
+ # *replica key*, use the ReplicateKey operation.
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # You can create a symmetric or asymmetric multi-Region key, and you can
+ # create a multi-Region key with imported key material. However, you
+ # cannot create a multi-Region key in a custom key store.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
#
- # @return [Types::DescribeCustomKeyStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::DescribeCustomKeyStoresResponse#custom_key_stores #custom_key_stores} => Array<Types::CustomKeyStoresListEntry>
- # * {Types::DescribeCustomKeyStoresResponse#next_marker #next_marker} => String
- # * {Types::DescribeCustomKeyStoresResponse#truncated #truncated} => Boolean
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
#
- # @example Request syntax with placeholder values
+ # @option params [String] :xks_key_id
+ # Identifies the [external key][1] that serves as key material for the
+ # KMS key in an [external key store][2]. Specify the ID that the
+ # [external key store proxy][3] uses to refer to the external key. For
+ # help, see the documentation for your external key store proxy.
#
- # resp = client.describe_custom_key_stores({
- # custom_key_store_id: "CustomKeyStoreIdType",
- # custom_key_store_name: "CustomKeyStoreNameType",
- # limit: 1,
- # marker: "MarkerType",
- # })
+ # This parameter is required for a KMS key with an `Origin` value of
+ # `EXTERNAL_KEY_STORE`. It is not valid for KMS keys with any other
+ # `Origin` value.
#
- # @example Response structure
+ # The external key must be an existing 256-bit AES symmetric encryption
+ # key hosted outside of Amazon Web Services in an external key manager
+ # associated with the external key store specified by the
+ # `CustomKeyStoreId` parameter. This key must be enabled and configured
+ # to perform encryption and decryption. Each KMS key in an external key
+ # store must use a different external key. For details, see
+ # [Requirements for a KMS key in an external key store][4] in the *Key
+ # Management Service Developer Guide*.
#
- # resp.custom_key_stores #=> Array
- # resp.custom_key_stores[0].custom_key_store_id #=> String
- # resp.custom_key_stores[0].custom_key_store_name #=> String
- # resp.custom_key_stores[0].cloud_hsm_cluster_id #=> String
- # resp.custom_key_stores[0].trust_anchor_certificate #=> String
- # resp.custom_key_stores[0].connection_state #=> String, one of "CONNECTED", "CONNECTING", "FAILED", "DISCONNECTED", "DISCONNECTING"
- # resp.custom_key_stores[0].connection_error_code #=> String, one of "INVALID_CREDENTIALS", "CLUSTER_NOT_FOUND", "NETWORK_ERRORS", "INTERNAL_ERROR", "INSUFFICIENT_CLOUDHSM_HSMS", "USER_LOCKED_OUT"
- # resp.custom_key_stores[0].creation_date #=> Time
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # Each KMS key in an external key store is associated two backing keys.
+ # One is key material that KMS generates. The other is the external key
+ # specified by this parameter. When you use the KMS key in an external
+ # key store to encrypt data, the encryption operation is performed first
+ # by KMS using the KMS key material, and then by the external key
+ # manager using the specified external key, a process known as *double
+ # encryption*. For details, see [Double encryption][5] in the *Key
+ # Management Service Developer Guide*.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStores AWS API Documentation
#
- # @overload describe_custom_key_stores(params = {})
- # @param [Hash] params ({})
- def describe_custom_key_stores(params = {}, options = {})
- req = build_request(:describe_custom_key_stores, params)
- req.send_request(options)
- end
-
- # Provides detailed information about the specified customer master key
- # (CMK).
#
- # You can use `DescribeKey` on a predefined AWS alias, that is, an AWS
- # alias with no key ID. When you do, AWS KMS associates the alias with
- # an [AWS managed CMK][1] and returns its `KeyId` and `Arn` in the
- # response.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy
+ # [4]: https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN or alias ARN in the value of the KeyId parameter.
+ # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::CreateKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
+ # @example Example: To create a KMS key
#
- # @option params [required, String] :key_id
- # Describes the specified customer master key (CMK).
+ # # The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this
+ # # operation.
#
- # If you specify a predefined AWS alias (an AWS alias with no key ID),
- # KMS associates the alias with an [AWS managed CMK][1] and returns its
- # `KeyId` and `Arn` in the response.
+ # resp = client.create_key({
+ # })
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must use
- # the key ARN or alias ARN.
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
#
- # For example:
+ # @example Example: To create an asymmetric RSA KMS key for encryption and decryption
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # # This example creates a KMS key that contains an asymmetric RSA key pair for encryption and decryption. The key spec and
+ # # key usage can't be changed after the key is created.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # resp = client.create_key({
+ # key_spec: "RSA_4096", # Describes the type of key material in the KMS key.
+ # key_usage: "ENCRYPT_DECRYPT", # The cryptographic operations for which you can use the KMS key.
+ # })
#
- # * Alias name: `alias/ExampleAlias`
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2021-04-05T14:04:55-07:00"),
+ # customer_master_key_spec: "RSA_4096",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "RSAES_OAEP_SHA_1",
+ # "RSAES_OAEP_SHA_256",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "RSA_4096",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
#
- # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ # @example Example: To create an asymmetric elliptic curve KMS key for signing and verification
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- # To get the alias name and alias ARN, use ListAliases.
+ # # This example creates a KMS key that contains an asymmetric elliptic curve (ECC) key pair for signing and verification.
+ # # The key usage is required even though "SIGN_VERIFY" is the only valid value for ECC KMS keys. The key spec and key usage
+ # # can't be changed after the key is created.
#
+ # resp = client.create_key({
+ # key_spec: "ECC_NIST_P521", # Describes the type of key material in the KMS key.
+ # key_usage: "SIGN_VERIFY", # The cryptographic operations for which you can use the KMS key.
+ # })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2019-12-02T07:48:55-07:00"),
+ # customer_master_key_spec: "ECC_NIST_P521",
+ # description: "",
+ # enabled: true,
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "ECC_NIST_P521",
+ # key_state: "Enabled",
+ # key_usage: "SIGN_VERIFY",
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # signing_algorithms: [
+ # "ECDSA_SHA_512",
+ # ],
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
+ # @example Example: To create an HMAC KMS key
#
- # @option params [Array<String>] :grant_tokens
- # A list of grant tokens.
+ # # This example creates a 384-bit symmetric HMAC KMS key. The GENERATE_VERIFY_MAC key usage value is required even though
+ # # it's the only valid value for HMAC KMS keys. The key spec and key usage can't be changed after the key is created.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # resp = client.create_key({
+ # key_spec: "HMAC_384", # Describes the type of key material in the KMS key.
+ # key_usage: "GENERATE_VERIFY_MAC", # The cryptographic operations for which you can use the KMS key.
+ # })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2022-04-05T14:04:55-07:00"),
+ # customer_master_key_spec: "HMAC_384",
+ # description: "",
+ # enabled: true,
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "HMAC_384",
+ # key_state: "Enabled",
+ # key_usage: "GENERATE_VERIFY_MAC",
+ # mac_algorithms: [
+ # "HMAC_SHA_384",
+ # ],
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
#
+ # @example Example: To create a multi-Region primary KMS key
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # # This example creates a multi-Region primary symmetric encryption key. Because the default values for all parameters
+ # # create a symmetric encryption key, only the MultiRegion parameter is required for this KMS key.
#
- # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # resp = client.create_key({
+ # multi_region: true, # Indicates whether the KMS key is a multi-Region (True) or regional (False) key.
+ # })
#
- # * {Types::DescribeKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab",
+ # creation_date: Time.parse("2021-09-02T016:15:21-09:00"),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "mrk-1234abcd12ab34cd56ef12345678990ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: true,
+ # multi_region_configuration: {
+ # multi_region_key_type: "PRIMARY",
+ # primary_key: {
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab",
+ # region: "us-west-2",
+ # },
+ # replica_keys: [
+ # ],
+ # },
+ # origin: "AWS_KMS",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
+ #
+ # @example Example: To create a KMS key for imported key material
+ #
+ # # This example creates a symmetric KMS key with no key material. When the operation is complete, you can import your own
+ # # key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.
#
+ # resp = client.create_key({
+ # origin: "EXTERNAL", # The source of the key material for the KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2019-12-02T07:48:55-07:00"),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: false,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "PendingImport",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "EXTERNAL",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
#
- # @example Example: To obtain information about a customer master key (CMK)
+ # @example Example: To create a KMS key in an AWS CloudHSM key store
#
- # # The following example returns information (metadata) about the specified CMK.
+ # # This example creates a KMS key in the specified AWS CloudHSM key store. The operation creates the KMS key and its
+ # # metadata in AWS KMS and creates the key material in the AWS CloudHSM cluster associated with the custom key store. This
+ # # example requires the CustomKeyStoreId and Origin parameters.
#
- # resp = client.describe_key({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # resp = client.create_key({
+ # custom_key_store_id: "cks-1234567890abcdef0", # Identifies the custom key store that hosts the KMS key.
+ # origin: "AWS_CLOUDHSM", # Indicates the source of the key material for the KMS key.
# })
#
# resp.to_h outputs the following:
@@ -1401,22 +2171,82 @@ module Aws::KMS
# key_metadata: {
# aws_account_id: "111122223333",
# arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
+ # cloud_hsm_cluster_id: "cluster-234abcdefABC",
+ # creation_date: Time.parse("2019-12-02T07:48:55-07:00"),
+ # custom_key_store_id: "cks-1234567890abcdef0",
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
# description: "",
# enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
# key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
# key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
# key_state: "Enabled",
# key_usage: "ENCRYPT_DECRYPT",
- # origin: "AWS_KMS",
- # }, # An object that contains information about the specified CMK.
+ # multi_region: false,
+ # origin: "AWS_CLOUDHSM",
+ # }, # Detailed information about the KMS key that this operation creates.
+ # }
+ #
+ # @example Example: To create a KMS key in an external key store
+ #
+ # # This example creates a KMS key in the specified external key store. It uses the XksKeyId parameter to associate the KMS
+ # # key with an existing symmetric encryption key in your external key manager. This CustomKeyStoreId, Origin, and XksKeyId
+ # # parameters are required in this operation.
+ #
+ # resp = client.create_key({
+ # custom_key_store_id: "cks-9876543210fedcba9", # Identifies the custom key store that hosts the KMS key.
+ # origin: "EXTERNAL_KEY_STORE", # Indicates the source of the key material for the KMS key.
+ # xks_key_id: "bb8562717f809024", # Identifies the encryption key in your external key manager that is associated with the KMS key
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
+ # creation_date: Time.parse("2022-02-02T07:48:55-07:00"),
+ # custom_key_store_id: "cks-9876543210fedcba9",
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "0987dcba-09fe-87dc-65ba-ab0987654321",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "EXTERNAL_KEY_STORE",
+ # xks_key_configuration: {
+ # id: "bb8562717f809024",
+ # },
+ # }, # Detailed information about the KMS key that this operation creates.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.describe_key({
- # key_id: "KeyIdType", # required
- # grant_tokens: ["GrantTokenType"],
+ # resp = client.create_key({
+ # policy: "PolicyType",
+ # description: "DescriptionType",
+ # key_usage: "SIGN_VERIFY", # accepts SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC
+ # customer_master_key_spec: "RSA_2048", # accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2
+ # key_spec: "RSA_2048", # accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2
+ # origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL, AWS_CLOUDHSM, EXTERNAL_KEY_STORE
+ # custom_key_store_id: "CustomKeyStoreIdType",
+ # bypass_policy_lockout_safety_check: false,
+ # tags: [
+ # {
+ # tag_key: "TagKeyType", # required
+ # tag_value: "TagValueType", # required
+ # },
+ # ],
+ # multi_region: false,
+ # xks_key_id: "XksKeyIdType",
# })
#
# @example Response structure
@@ -1427,98 +2257,193 @@ module Aws::KMS
# resp.key_metadata.creation_date #=> Time
# resp.key_metadata.enabled #=> Boolean
# resp.key_metadata.description #=> String
- # resp.key_metadata.key_usage #=> String, one of "ENCRYPT_DECRYPT"
- # resp.key_metadata.key_state #=> String, one of "Enabled", "Disabled", "PendingDeletion", "PendingImport", "Unavailable"
+ # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC"
+ # resp.key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating"
# resp.key_metadata.deletion_date #=> Time
# resp.key_metadata.valid_to #=> Time
- # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM"
+ # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE"
# resp.key_metadata.custom_key_store_id #=> String
# resp.key_metadata.cloud_hsm_cluster_id #=> String
# resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
# resp.key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
+ # resp.key_metadata.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_metadata.key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_metadata.encryption_algorithms #=> Array
+ # resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.key_metadata.signing_algorithms #=> Array
+ # resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
+ # resp.key_metadata.multi_region #=> Boolean
+ # resp.key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
+ # resp.key_metadata.multi_region_configuration.primary_key.arn #=> String
+ # resp.key_metadata.multi_region_configuration.primary_key.region #=> String
+ # resp.key_metadata.multi_region_configuration.replica_keys #=> Array
+ # resp.key_metadata.multi_region_configuration.replica_keys[0].arn #=> String
+ # resp.key_metadata.multi_region_configuration.replica_keys[0].region #=> String
+ # resp.key_metadata.pending_deletion_window_in_days #=> Integer
+ # resp.key_metadata.mac_algorithms #=> Array
+ # resp.key_metadata.mac_algorithms[0] #=> String, one of "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512"
+ # resp.key_metadata.xks_key_configuration.id #=> String
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey AWS API Documentation
#
- # @overload describe_key(params = {})
+ # @overload create_key(params = {})
# @param [Hash] params ({})
- def describe_key(params = {}, options = {})
- req = build_request(:describe_key, params)
+ def create_key(params = {}, options = {})
+ req = build_request(:create_key, params)
req.send_request(options)
end
- # Sets the state of a customer master key (CMK) to disabled, thereby
- # preventing its use for cryptographic operations. You cannot perform
- # this operation on a CMK in a different AWS account.
+ # Decrypts ciphertext that was encrypted by a KMS key using any of the
+ # following operations:
#
- # For more information about how key state affects the use of a CMK, see
- # [How Key State Affects the Use of a Customer Master Key][1] in the <i>
- # <i>AWS Key Management Service Developer Guide</i> </i>.
+ # * Encrypt
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # * GenerateDataKey
#
+ # * GenerateDataKeyPair
#
+ # * GenerateDataKeyWithoutPlaintext
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # * GenerateDataKeyPairWithoutPlaintext
+ #
+ # You can use this operation to decrypt ciphertext that was encrypted
+ # under a symmetric encryption KMS key or an asymmetric encryption KMS
+ # key. When the KMS key is asymmetric, you must specify the KMS key and
+ # the encryption algorithm that was used to encrypt the ciphertext. For
+ # information about asymmetric KMS keys, see [Asymmetric KMS keys][1] in
+ # the *Key Management Service Developer Guide*.
+ #
+ # The `Decrypt` operation also decrypts ciphertext that was encrypted
+ # outside of KMS by the public key in an KMS asymmetric KMS key.
+ # However, it cannot decrypt symmetric ciphertext produced by other
+ # libraries, such as the [Amazon Web Services Encryption SDK][2] or
+ # [Amazon S3 client-side encryption][3]. These libraries return a
+ # ciphertext format that is incompatible with KMS.
+ #
+ # If the ciphertext was encrypted under a symmetric encryption KMS key,
+ # the `KeyId` parameter is optional. KMS can get this information from
+ # metadata that it adds to the symmetric ciphertext blob. This feature
+ # adds durability to your implementation by ensuring that authorized
+ # users can decrypt ciphertext decades after it was encrypted, even if
+ # they've lost track of the key ID. However, specifying the KMS key is
+ # always recommended as a best practice. When you use the `KeyId`
+ # parameter to specify a KMS key, KMS only uses the KMS key you specify.
+ # If the ciphertext was encrypted under a different KMS key, the
+ # `Decrypt` operation fails. This practice ensures that you use the KMS
+ # key that you intend.
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # Whenever possible, use key policies to give users permission to call
+ # the `Decrypt` operation on a particular KMS key, instead of using
+ # &IAM; policies. Otherwise, you might create an &IAM; policy
+ # that gives the user `Decrypt` permission on all KMS keys. This user
+ # could decrypt ciphertext that was encrypted by KMS keys in other
+ # accounts if the key policy for the cross-account KMS key permits it.
+ # If you must use an IAM policy for `Decrypt` permissions, limit the
+ # user to particular KMS keys or particular trusted accounts. For
+ # details, see [Best practices for IAM policies][4] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # `Decrypt` also supports [Amazon Web Services Nitro Enclaves][5], which
+ # provide an isolated compute environment in Amazon EC2. To call
+ # `Decrypt` for a Nitro enclave, use the [Amazon Web Services Nitro
+ # Enclaves SDK][6] or any Amazon Web Services SDK. Use the `Recipient`
+ # parameter to provide the attestation document for the enclave. Instead
+ # of the plaintext data, the response includes the plaintext data
+ # encrypted with the public key from the attestation document
+ # (`CiphertextForRecipient`).For information about the interaction
+ # between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon
+ # Web Services Nitro Enclaves uses KMS][7] in the *Key Management
+ # Service Developer Guide*..
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][8] in the *Key
+ # Management Service Developer Guide*.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # **Cross-account use**: Yes. If you use the `KeyId` parameter to
+ # identify a KMS key in a different Amazon Web Services account, specify
+ # the key ARN or the alias ARN of the KMS key.
#
- # For example:
+ # **Required permissions**: [kms:Decrypt][9] (key policy)
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # **Related operations:**
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * Encrypt
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * GenerateDataKey
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # * GenerateDataKeyPair
#
+ # * ReEncrypt
#
- # @example Example: To disable a customer master key (CMK)
#
- # # The following example disables the specified CMK.
#
- # resp = client.disable_key({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to disable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # })
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [2]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices
+ # [5]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html
+ # [6]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
- # @example Request syntax with placeholder values
+ # @option params [required, String, StringIO, File] :ciphertext_blob
+ # Ciphertext to be decrypted. The blob includes metadata.
#
- # resp = client.disable_key({
- # key_id: "KeyIdType", # required
- # })
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context to use when decrypting the data. An
+ # encryption context is valid only for [cryptographic operations][1]
+ # with a symmetric encryption KMS key. The standard asymmetric
+ # encryption algorithms and HMAC algorithms that KMS uses do not support
+ # an encryption context.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][2] in the *Key
+ # Management Service Developer Guide*.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey AWS API Documentation
#
- # @overload disable_key(params = {})
- # @param [Hash] params ({})
- def disable_key(params = {}, options = {})
- req = build_request(:disable_key, params)
- req.send_request(options)
- end
-
- # Disables [automatic rotation of the key material][1] for the specified
- # customer master key (CMK). You cannot perform this operation on a CMK
- # in a different AWS account.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
#
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
#
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [String] :key_id
+ # Specifies the KMS key that KMS uses to decrypt the ciphertext.
+ #
+ # Enter a key ID of the KMS key that was used to encrypt the ciphertext.
+ # If you identify a different KMS key, the `Decrypt` operation throws an
+ # `IncorrectKeyException`.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. If you used a symmetric encryption KMS
+ # key, KMS can get the KMS key from metadata that it adds to the
+ # symmetric ciphertext blob. However, it is always recommended as a best
+ # practice. This practice ensures that you use the KMS key that you
+ # intend.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
#
# For example:
#
@@ -1527,159 +2452,369 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
#
- # @example Example: To disable automatic rotation of key material
+ # @option params [String] :encryption_algorithm
+ # Specifies the encryption algorithm that will be used to decrypt the
+ # ciphertext. Specify the same algorithm that was used to encrypt the
+ # data. If you specify a different algorithm, the `Decrypt` operation
+ # fails.
#
- # # The following example disables automatic annual rotation of the key material for the specified CMK.
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. The default value, `SYMMETRIC_DEFAULT`,
+ # represents the only supported algorithm that is valid for symmetric
+ # encryption KMS keys.
#
- # resp = client.disable_key_rotation({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # })
+ # @option params [Types::RecipientInfo] :recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's public
+ # key. The only valid encryption algorithm is `RSAES_OAEP_SHA_256`.
#
- # @example Request syntax with placeholder values
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
#
- # resp = client.disable_key_rotation({
- # key_id: "KeyIdType", # required
- # })
+ # When you use this parameter, instead of returning the plaintext data,
+ # KMS encrypts the plaintext data with the public key in the attestation
+ # document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can be
+ # decrypted only with the private key in the enclave. The `Plaintext`
+ # field in the response is null or empty.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation AWS API Documentation
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
#
- # @overload disable_key_rotation(params = {})
- # @param [Hash] params ({})
- def disable_key_rotation(params = {}, options = {})
- req = build_request(:disable_key_rotation, params)
- req.send_request(options)
- end
-
- # Disconnects the [custom key store][1] from its associated AWS CloudHSM
- # cluster. While a custom key store is disconnected, you can manage the
- # custom key store and its customer master keys (CMKs), but you cannot
- # create or use CMKs in the custom key store. You can reconnect the
- # custom key store at any time.
#
- # <note markdown="1"> While a custom key store is disconnected, all attempts to create
- # customer master keys (CMKs) in the custom key store or to use existing
- # CMKs in cryptographic operations will fail. This action can prevent
- # users from storing and accessing sensitive data.
#
- # </note>
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
#
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # To find the connection state of a custom key store, use the
- # DescribeCustomKeyStores operation. To reconnect a custom key store,
- # use the ConnectCustomKeyStore operation.
#
- # If the operation succeeds, it returns a JSON object with no
- # properties.
#
- # This operation is part of the [Custom Key Store feature][1] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
#
+ # @return [Types::DecryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::DecryptResponse#key_id #key_id} => String
+ # * {Types::DecryptResponse#plaintext #plaintext} => String
+ # * {Types::DecryptResponse#encryption_algorithm #encryption_algorithm} => String
+ # * {Types::DecryptResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
#
- # @option params [required, String] :custom_key_store_id
- # Enter the ID of the custom key store you want to disconnect. To find
- # the ID of a custom key store, use the DescribeCustomKeyStores
- # operation.
+ # @example Example: To decrypt data with a symmetric encryption KMS key
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # # The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required
+ # # when decrypting with a symmetric encryption key, but it is a best practice.
+ #
+ # resp = client.decrypt({
+ # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # A key identifier for the KMS key to use to decrypt the data.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # encryption_algorithm: "SYMMETRIC_DEFAULT", # The encryption algorithm that was used to decrypt the ciphertext. SYMMETRIC_DEFAULT is the only valid value for symmetric encryption in AWS KMS.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.
+ # plaintext: "<binary data>", # The decrypted (plaintext) data.
+ # }
+ #
+ # @example Example: To decrypt data with an asymmetric encryption KMS key
+ #
+ # # The following example decrypts data that was encrypted with an asymmetric encryption KMS key. When the KMS encryption
+ # # key is asymmetric, you must specify the KMS key ID and the encryption algorithm that was used to encrypt the data.
+ #
+ # resp = client.decrypt({
+ # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
+ # encryption_algorithm: "RSAES_OAEP_SHA_256", # The encryption algorithm that was used to encrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
+ # key_id: "0987dcba-09fe-87dc-65ba-ab0987654321", # A key identifier for the KMS key to use to decrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # encryption_algorithm: "RSAES_OAEP_SHA_256", # The encryption algorithm that was used to decrypt the ciphertext.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.
+ # plaintext: "<binary data>", # The decrypted (plaintext) data.
+ # }
+ #
+ # @example Example: To decrypt data for a Nitro enclave
+ #
+ # # The following Decrypt example includes the Recipient parameter with a signed attestation document from an AWS Nitro
+ # # enclave. Instead of returning the decrypted data in plaintext (Plaintext), the operation returns the decrypted data
+ # # encrypted by the public key from the attestation document (CiphertextForRecipient).
+ #
+ # resp = client.decrypt({
+ # ciphertext_blob: "<binary data>", # The encrypted data. This ciphertext was encrypted with the KMS key
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The KMS key to use to decrypt the ciphertext
+ # recipient: {
+ # attestation_document: "<attestation document>",
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256",
+ # }, # Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_for_recipient: "<binary data>", # The decrypted CiphertextBlob encrypted with the public key from the attestation document
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The KMS key that was used to decrypt the encrypted data (CiphertextBlob)
+ # plaintext: "", # This field is null or empty
+ # }
#
# @example Request syntax with placeholder values
#
- # resp = client.disconnect_custom_key_store({
- # custom_key_store_id: "CustomKeyStoreIdType", # required
+ # resp = client.decrypt({
+ # ciphertext_blob: "data", # required
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # grant_tokens: ["GrantTokenType"],
+ # key_id: "KeyIdType",
+ # encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE
+ # recipient: {
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256", # accepts RSAES_OAEP_SHA_256
+ # attestation_document: "data",
+ # },
+ # dry_run: false,
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStore AWS API Documentation
+ # @example Response structure
#
- # @overload disconnect_custom_key_store(params = {})
+ # resp.key_id #=> String
+ # resp.plaintext #=> String
+ # resp.encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.ciphertext_for_recipient #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt AWS API Documentation
+ #
+ # @overload decrypt(params = {})
# @param [Hash] params ({})
- def disconnect_custom_key_store(params = {}, options = {})
- req = build_request(:disconnect_custom_key_store, params)
+ def decrypt(params = {}, options = {})
+ req = build_request(:decrypt, params)
req.send_request(options)
end
- # Sets the key state of a customer master key (CMK) to enabled. This
- # allows you to use the CMK for cryptographic operations. You cannot
- # perform this operation on a CMK in a different AWS account.
+ # Deletes the specified alias.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # <note markdown="1"> Adding, deleting, or updating an alias can allow or deny permission to
+ # the KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
#
+ # </note>
#
+ # Because an alias is not a property of a KMS key, you can delete and
+ # change the aliases of a KMS key without affecting the KMS key. Also,
+ # aliases do not appear in the response from the DescribeKey operation.
+ # To get the aliases of all KMS keys, use the ListAliases operation.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # Each KMS key can have multiple aliases. To change the alias of a KMS
+ # key, use DeleteAlias to delete the current alias and CreateAlias to
+ # create a new alias. To associate an existing alias with a different
+ # KMS key, call UpdateAlias.
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # **Cross-account use**: No. You cannot perform this operation on an
+ # alias in a different Amazon Web Services account.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # **Required permissions**
#
- # For example:
+ # * [kms:DeleteAlias][2] on the alias (IAM policy).
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * [kms:DeleteAlias][2] on the KMS key (key policy).
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # For details, see [Controlling access to aliases][3] in the *Key
+ # Management Service Developer Guide*.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # **Related operations:**
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # * CreateAlias
#
+ # * ListAliases
#
- # @example Example: To enable a customer master key (CMK)
+ # * UpdateAlias
#
- # # The following example enables the specified CMK.
#
- # resp = client.enable_key({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to enable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
+ #
+ # @option params [required, String] :alias_name
+ # The alias to be deleted. The alias name must begin with `alias/`
+ # followed by the alias name, such as `alias/ExampleAlias`.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To delete an alias
+ #
+ # # The following example deletes the specified alias.
+ #
+ # resp = client.delete_alias({
+ # alias_name: "alias/ExampleAlias", # The alias to delete.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.enable_key({
- # key_id: "KeyIdType", # required
+ # resp = client.delete_alias({
+ # alias_name: "AliasNameType", # required
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias AWS API Documentation
#
- # @overload enable_key(params = {})
+ # @overload delete_alias(params = {})
# @param [Hash] params ({})
- def enable_key(params = {}, options = {})
- req = build_request(:enable_key, params)
+ def delete_alias(params = {}, options = {})
+ req = build_request(:delete_alias, params)
req.send_request(options)
end
- # Enables [automatic rotation of the key material][1] for the specified
- # customer master key (CMK). You cannot perform this operation on a CMK
- # in a different AWS account.
+ # Deletes a [custom key store][1]. This operation does not affect any
+ # backing elements of the custom key store. It does not delete the
+ # CloudHSM cluster that is associated with an CloudHSM key store, or
+ # affect any users or keys in the cluster. For an external key store, it
+ # does not affect the external key store proxy, external key manager, or
+ # any external keys.
+ #
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
+ #
+ # The custom key store that you delete cannot contain any [KMS keys][2].
+ # Before deleting the key store, verify that you will never need to use
+ # any of the KMS keys in the key store for any [cryptographic
+ # operations][3]. Then, use ScheduleKeyDeletion to delete the KMS keys
+ # from the key store. After the required waiting period expires and all
+ # KMS keys are deleted from the custom key store, use
+ # DisconnectCustomKeyStore to disconnect the key store from KMS. Then,
+ # you can delete the custom key store.
+ #
+ # For keys in an CloudHSM key store, the `ScheduleKeyDeletion` operation
+ # makes a best effort to delete the key material from the associated
+ # cluster. However, you might need to manually [delete the orphaned key
+ # material][4] from the cluster and its backups. KMS never creates,
+ # manages, or deletes cryptographic keys in the external key manager
+ # associated with an external key store. You must manage them using your
+ # external key manager tools.
+ #
+ # Instead of deleting the custom key store, consider using the
+ # DisconnectCustomKeyStore operation to disconnect the custom key store
+ # from its backing key store. While the key store is disconnected, you
+ # cannot create or use the KMS keys in the key store. But, you do not
+ # need to delete KMS keys and you can reconnect a disconnected custom
+ # key store at any time.
#
- # You cannot enable automatic rotation of CMKs with imported key
- # material or CMKs in a [custom key store][2].
+ # If the operation succeeds, it returns a JSON object with no
+ # properties.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][3]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
#
+ # **Required permissions**: [kms:DeleteCustomKeyStore][5] (IAM policy)
#
+ # **Related operations:**
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # * ConnectCustomKeyStore
+ #
+ # * CreateCustomKeyStore
+ #
+ # * DescribeCustomKeyStores
+ #
+ # * DisconnectCustomKeyStore
+ #
+ # * UpdateCustomKeyStore
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :custom_key_store_id
+ # Enter the ID of the custom key store you want to delete. To find the
+ # ID of a custom key store, use the DescribeCustomKeyStores operation.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To delete a custom key store from AWS KMS
+ #
+ # # This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a
+ # # CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To
+ # # verify that the operation was successful, use the DescribeCustomKeyStores operation.
+ #
+ # resp = client.delete_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store to be deleted.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.delete_custom_key_store({
+ # custom_key_store_id: "CustomKeyStoreIdType", # required
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStore AWS API Documentation
+ #
+ # @overload delete_custom_key_store(params = {})
+ # @param [Hash] params ({})
+ def delete_custom_key_store(params = {}, options = {})
+ req = build_request(:delete_custom_key_store, params)
+ req.send_request(options)
+ end
+
+ # Deletes key material that was previously imported. This operation
+ # makes the specified KMS key temporarily unusable. To restore the
+ # usability of the KMS key, reimport the same key material. For more
+ # information about importing key material into KMS, see [Importing Key
+ # Material][1] in the *Key Management Service Developer Guide*.
+ #
+ # When the specified KMS key is in the `PendingDeletion` state, this
+ # operation does not change the KMS key's state. Otherwise, it changes
+ # the KMS key's state to `PendingImport`.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:DeleteImportedKeyMaterial][3] (key
+ # policy)
+ #
+ # **Related operations:**
+ #
+ # * GetParametersForImport
+ #
+ # * ImportKeyMaterial
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies the KMS key from which you are deleting imported key
+ # material. The `Origin` of the KMS key must be `EXTERNAL`.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1688,229 +2823,349 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To enable automatic rotation of key material
+ # @example Example: To delete imported key material
#
- # # The following example enables automatic annual rotation of the key material for the specified CMK.
+ # # The following example deletes the imported key material from the specified KMS key.
#
- # resp = client.enable_key_rotation({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # resp = client.delete_imported_key_material({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.enable_key_rotation({
+ # resp = client.delete_imported_key_material({
# key_id: "KeyIdType", # required
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial AWS API Documentation
#
- # @overload enable_key_rotation(params = {})
+ # @overload delete_imported_key_material(params = {})
# @param [Hash] params ({})
- def enable_key_rotation(params = {}, options = {})
- req = build_request(:enable_key_rotation, params)
+ def delete_imported_key_material(params = {}, options = {})
+ req = build_request(:delete_imported_key_material, params)
req.send_request(options)
end
- # Encrypts plaintext into ciphertext by using a customer master key
- # (CMK). The `Encrypt` operation has two primary use cases:
+ # Gets information about [custom key stores][1] in the account and
+ # Region.
#
- # * You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data
- # such as an RSA key, a database password, or other sensitive
- # information.
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
#
- # * You can use the `Encrypt` operation to move encrypted data from one
- # AWS region to another. In the first region, generate a data key and
- # use the plaintext key to encrypt the data. Then, in the new region,
- # call the `Encrypt` method on same plaintext data key. Now, you can
- # safely move the encrypted data and encrypted data key to the new
- # region, and decrypt in the new region when necessary.
+ # By default, this operation returns information about all custom key
+ # stores in the account and Region. To get only information about a
+ # particular custom key store, use either the `CustomKeyStoreName` or
+ # `CustomKeyStoreId` parameter (but not both).
#
- # You don't need use this operation to encrypt a data key within a
- # region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext
- # operations return an encrypted data key.
+ # To determine whether the custom key store is connected to its CloudHSM
+ # cluster or external key store proxy, use the `ConnectionState` element
+ # in the response. If an attempt to connect the custom key store failed,
+ # the `ConnectionState` value is `FAILED` and the `ConnectionErrorCode`
+ # element in the response indicates the cause of the failure. For help
+ # interpreting the `ConnectionErrorCode`, see CustomKeyStoresListEntry.
#
- # Also, you don't need to use this operation to encrypt data in your
- # application. You can use the plaintext and encrypted data keys that
- # the `GenerateDataKey` operation returns.
+ # Custom key stores have a `DISCONNECTED` connection state if the key
+ # store has never been connected or you used the
+ # DisconnectCustomKeyStore operation to disconnect it. Otherwise, the
+ # connection state is CONNECTED. If your custom key store connection
+ # state is `CONNECTED` but you are having trouble using it, verify that
+ # the backing store is active and available. For an CloudHSM key store,
+ # verify that the associated CloudHSM cluster is active and contains the
+ # minimum number of HSMs required for the operation, if any. For an
+ # external key store, verify that the external key store proxy and its
+ # associated external key manager are reachable and enabled.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # For help repairing your CloudHSM key store, see the [Troubleshooting
+ # CloudHSM key stores][2]. For help repairing your external key store,
+ # see the [Troubleshooting external key stores][3]. Both topics are in
+ # the *Key Management Service Developer Guide*.
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN or alias ARN in the value of the KeyId parameter.
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
#
+ # **Required permissions**: [kms:DescribeCustomKeyStores][4] (IAM
+ # policy)
#
+ # **Related operations:**
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # * ConnectCustomKeyStore
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # * CreateCustomKeyStore
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must use
- # the key ARN or alias ARN.
+ # * DeleteCustomKeyStore
#
- # For example:
+ # * DisconnectCustomKeyStore
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * UpdateCustomKeyStore
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # * Alias name: `alias/ExampleAlias`
#
- # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- # To get the alias name and alias ARN, use ListAliases.
+ # @option params [String] :custom_key_store_id
+ # Gets only information about the specified custom key store. Enter the
+ # key store ID.
#
- # @option params [required, String, IO] :plaintext
- # Data to be encrypted.
+ # By default, this operation gets information about all custom key
+ # stores in the account and Region. To limit the output to a particular
+ # custom key store, provide either the `CustomKeyStoreId` or
+ # `CustomKeyStoreName` parameter, but not both.
#
- # @option params [Hash<String,String>] :encryption_context
- # Name-value pair that specifies the encryption context to be used for
- # authenticated encryption. If used here, the same value must be
- # supplied to the `Decrypt` API or decryption will fail. For more
- # information, see [Encryption Context][1].
+ # @option params [String] :custom_key_store_name
+ # Gets only information about the specified custom key store. Enter the
+ # friendly name of the custom key store.
+ #
+ # By default, this operation gets information about all custom key
+ # stores in the account and Region. To limit the output to a particular
+ # custom key store, provide either the `CustomKeyStoreId` or
+ # `CustomKeyStoreName` parameter, but not both.
#
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
#
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Types::DescribeCustomKeyStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # @option params [Array<String>] :grant_tokens
- # A list of grant tokens.
+ # * {Types::DescribeCustomKeyStoresResponse#custom_key_stores #custom_key_stores} => Array<Types::CustomKeyStoresListEntry>
+ # * {Types::DescribeCustomKeyStoresResponse#next_marker #next_marker} => String
+ # * {Types::DescribeCustomKeyStoresResponse#truncated #truncated} => Boolean
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
+ # @example Example: To get detailed information about custom key stores in the account and Region
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # # This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key
+ # # stores, do not enter a custom key store name or ID.
#
- # @return [Types::EncryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # resp = client.describe_custom_key_stores({
+ # })
#
- # * {Types::EncryptResponse#ciphertext_blob #ciphertext_blob} => String
- # * {Types::EncryptResponse#key_id #key_id} => String
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_stores: [
+ # ], # Details about each custom key store in the account and Region.
+ # }
#
+ # @example Example: To get detailed information about an AWS CloudHSM key store by specifying its friendly name
#
- # @example Example: To encrypt data
+ # # This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To
+ # # limit the output to a particular custom key store, provide either the custom key store name or ID.
#
- # # The following example encrypts data with the specified customer master key (CMK).
+ # resp = client.describe_custom_key_stores({
+ # custom_key_store_name: "ExampleKeyStore", # The friendly name of the custom key store.
+ # })
#
- # resp = client.encrypt({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
- # plaintext: "<binary data>", # The data to encrypt.
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_stores: [
+ # {
+ # cloud_hsm_cluster_id: "cluster-234abcdefABC",
+ # connection_state: "CONNECTED",
+ # creation_date: Time.parse("1.499288695918E9"),
+ # custom_key_store_id: "cks-1234567890abcdef0",
+ # custom_key_store_name: "ExampleKeyStore",
+ # custom_key_store_type: "AWS_CLOUDHSM",
+ # trust_anchor_certificate: "<certificate appears here>",
+ # },
+ # ], # Detailed information about the specified custom key store.
+ # }
+ #
+ # @example Example: To get detailed information about an external key store by specifying its ID
+ #
+ # # This example gets detailed information about an external key store by specifying its ID. The example external key store
+ # # proxy uses public endpoint connectivity.
+ #
+ # resp = client.describe_custom_key_stores({
+ # custom_key_store_id: "cks-9876543210fedcba9", # The ID of the custom key store.
# })
#
# resp.to_h outputs the following:
# {
- # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
- # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data.
+ # custom_key_stores: [
+ # {
+ # connection_state: "CONNECTED",
+ # creation_date: Time.parse("1.599288695918E9"),
+ # custom_key_store_id: "cks-9876543210fedcba9",
+ # custom_key_store_name: "ExampleExternalKeyStore",
+ # custom_key_store_type: "EXTERNAL_KEY_STORE",
+ # xks_proxy_configuration: {
+ # access_key_id: "ABCDE12345670EXAMPLE",
+ # connectivity: "PUBLIC_ENDPOINT",
+ # uri_endpoint: "https://myproxy.xks.example.com",
+ # uri_path: "/kms/xks/v1",
+ # },
+ # },
+ # ], # Detailed information about the specified custom key store.
+ # }
+ #
+ # @example Example: To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name
+ #
+ # # This example gets detailed information about a particular external key store by specifying its friendly name. To limit
+ # # the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this
+ # # external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint
+ # # connectivity, the response includes the associated VPC endpoint service name.
+ #
+ # resp = client.describe_custom_key_stores({
+ # custom_key_store_name: "VPCExternalKeystore",
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # custom_key_stores: [
+ # {
+ # connection_state: "CONNECTED",
+ # creation_date: Time.parse("1.643057863.842"),
+ # custom_key_store_id: "cks-876543210fedcba98",
+ # custom_key_store_name: "ExampleVPCExternalKeyStore",
+ # custom_key_store_type: "EXTERNAL_KEY_STORE",
+ # xks_proxy_configuration: {
+ # access_key_id: "ABCDE12345670EXAMPLE",
+ # connectivity: "VPC_ENDPOINT_SERVICE",
+ # uri_endpoint: "https://myproxy-private.xks.example.com",
+ # uri_path: "/example-prefix/kms/xks/v1",
+ # vpc_endpoint_service_name: "com.amazonaws.vpce.us-east-1.vpce-svc-example1",
+ # },
+ # },
+ # ], # Detailed information about the specified custom key store.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.encrypt({
- # key_id: "KeyIdType", # required
- # plaintext: "data", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
+ # resp = client.describe_custom_key_stores({
+ # custom_key_store_id: "CustomKeyStoreIdType",
+ # custom_key_store_name: "CustomKeyStoreNameType",
+ # limit: 1,
+ # marker: "MarkerType",
# })
#
# @example Response structure
#
- # resp.ciphertext_blob #=> String
- # resp.key_id #=> String
+ # resp.custom_key_stores #=> Array
+ # resp.custom_key_stores[0].custom_key_store_id #=> String
+ # resp.custom_key_stores[0].custom_key_store_name #=> String
+ # resp.custom_key_stores[0].cloud_hsm_cluster_id #=> String
+ # resp.custom_key_stores[0].trust_anchor_certificate #=> String
+ # resp.custom_key_stores[0].connection_state #=> String, one of "CONNECTED", "CONNECTING", "FAILED", "DISCONNECTED", "DISCONNECTING"
+ # resp.custom_key_stores[0].connection_error_code #=> String, one of "INVALID_CREDENTIALS", "CLUSTER_NOT_FOUND", "NETWORK_ERRORS", "INTERNAL_ERROR", "INSUFFICIENT_CLOUDHSM_HSMS", "USER_LOCKED_OUT", "USER_NOT_FOUND", "USER_LOGGED_IN", "SUBNET_NOT_FOUND", "INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET", "XKS_PROXY_ACCESS_DENIED", "XKS_PROXY_NOT_REACHABLE", "XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND", "XKS_PROXY_INVALID_RESPONSE", "XKS_PROXY_INVALID_CONFIGURATION", "XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION", "XKS_PROXY_TIMED_OUT", "XKS_PROXY_INVALID_TLS_CONFIGURATION"
+ # resp.custom_key_stores[0].creation_date #=> Time
+ # resp.custom_key_stores[0].custom_key_store_type #=> String, one of "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE"
+ # resp.custom_key_stores[0].xks_proxy_configuration.connectivity #=> String, one of "PUBLIC_ENDPOINT", "VPC_ENDPOINT_SERVICE"
+ # resp.custom_key_stores[0].xks_proxy_configuration.access_key_id #=> String
+ # resp.custom_key_stores[0].xks_proxy_configuration.uri_endpoint #=> String
+ # resp.custom_key_stores[0].xks_proxy_configuration.uri_path #=> String
+ # resp.custom_key_stores[0].xks_proxy_configuration.vpc_endpoint_service_name #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStores AWS API Documentation
#
- # @overload encrypt(params = {})
+ # @overload describe_custom_key_stores(params = {})
# @param [Hash] params ({})
- def encrypt(params = {}, options = {})
- req = build_request(:encrypt, params)
+ def describe_custom_key_stores(params = {}, options = {})
+ req = build_request(:describe_custom_key_stores, params)
req.send_request(options)
end
- # Generates a unique data key. This operation returns a plaintext copy
- # of the data key and a copy that is encrypted under a customer master
- # key (CMK) that you specify. You can use the plaintext key to encrypt
- # your data outside of KMS and store the encrypted data key with the
- # encrypted data.
+ # Provides detailed information about a KMS key. You can run
+ # `DescribeKey` on a [customer managed key][1] or an [Amazon Web
+ # Services managed key][2].
+ #
+ # This detailed information includes the key ARN, creation date (and
+ # deletion date, if applicable), the key state, and the origin and
+ # expiration date (if any) of the key material. It includes fields, like
+ # `KeySpec`, that help you distinguish different types of KMS keys. It
+ # also displays the key usage (encryption, signing, or generating and
+ # verifying MACs) and the algorithms that the KMS key supports.
+ #
+ # For [multi-Region
+ # keys](kms/latest/developerguide/multi-region-keys-overview.html),
+ # `DescribeKey` displays the primary key and all related replica keys.
+ # For KMS keys in [CloudHSM key
+ # stores](kms/latest/developerguide/keystore-cloudhsm.html), it includes
+ # information about the key store, such as the key store ID and the
+ # CloudHSM cluster ID. For KMS keys in [external key
+ # stores](kms/latest/developerguide/keystore-external.html), it includes
+ # the custom key store ID and the ID of the external key.
+ #
+ # `DescribeKey` does not return the following information:
+ #
+ # * Aliases associated with the KMS key. To get this information, use
+ # ListAliases.
#
- # `GenerateDataKey` returns a unique data key for each request. The
- # bytes in the key are not related to the caller or CMK that is used to
- # encrypt the data key.
+ # * Whether automatic key rotation is enabled on the KMS key. To get
+ # this information, use GetKeyRotationStatus. Also, some key states
+ # prevent a KMS key from being automatically rotated. For details, see
+ # [How Automatic Key Rotation Works][3] in the *Key Management Service
+ # Developer Guide*.
#
- # To generate a data key, you need to specify the customer master key
- # (CMK) that will be used to encrypt the data key. You must also specify
- # the length of the data key using either the `KeySpec` or
- # `NumberOfBytes` field (but not both). For common key lengths (128-bit
- # and 256-bit symmetric keys), we recommend that you use `KeySpec`. To
- # perform this operation on a CMK in a different AWS account, specify
- # the key ARN or alias ARN in the value of the KeyId parameter.
+ # * Tags on the KMS key. To get this information, use ListResourceTags.
#
- # You will find the plaintext copy of the data key in the `Plaintext`
- # field of the response, and the encrypted copy of the data key in the
- # `CiphertextBlob` field.
+ # * Key policies and grants on the KMS key. To get this information, use
+ # GetKeyPolicy and ListGrants.
#
- # We recommend that you use the following pattern to encrypt data
- # locally in your application:
+ # In general, `DescribeKey` is a non-mutating operation. It returns data
+ # about KMS keys, but doesn't change them. However, Amazon Web Services
+ # services use `DescribeKey` to create [Amazon Web Services managed
+ # keys][2] from a *predefined Amazon Web Services alias* with no key ID.
#
- # 1. Use the `GenerateDataKey` operation to get a data encryption key.
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
#
- # 2. Use the plaintext data key (returned in the `Plaintext` field of
- # the response) to encrypt data locally, then erase the plaintext
- # data key from memory.
+ # **Required permissions**: [kms:DescribeKey][4] (key policy)
#
- # 3. Store the encrypted data key (returned in the `CiphertextBlob`
- # field of the response) alongside the locally encrypted data.
+ # **Related operations:**
#
- # To decrypt data locally:
+ # * GetKeyPolicy
#
- # 1. Use the Decrypt operation to decrypt the encrypted data key. The
- # operation returns a plaintext copy of the data key.
+ # * GetKeyRotationStatus
#
- # 2. Use the plaintext data key to decrypt data locally, then erase the
- # plaintext data key from memory.
+ # * ListAliases
#
- # To get only an encrypted copy of the data key, use
- # GenerateDataKeyWithoutPlaintext. To get a cryptographically secure
- # random byte string, use GenerateRandom.
- #
- # You can use the optional encryption context to add additional security
- # to your encryption operation. When you specify an `EncryptionContext`
- # in the `GenerateDataKey` operation, you must specify the same
- # encryption context (a case-sensitive exact match) in your request to
- # Decrypt the data key. Otherwise, the request to decrypt fails with an
- # `InvalidCiphertextException`. For more information, see [Encryption
- # Context][1] in the <i> <i>AWS Key Management Service Developer
- # Guide</i> </i>.
+ # * ListGrants
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # * ListKeys
#
+ # * ListResourceTags
#
+ # * ListRetirableGrants
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # An identifier for the CMK that encrypts the data key.
+ # Describes the specified KMS key.
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must use
- # the key ARN or alias ARN.
+ # If you specify a predefined Amazon Web Services alias (an Amazon Web
+ # Services alias with no key ID), KMS associates the alias with an
+ # [Amazon Web Services managed key][1] and returns its `KeyId` and `Arn`
+ # in the response.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
#
# For example:
#
@@ -1923,296 +3178,416 @@ module Aws::KMS
#
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- # To get the alias name and alias ARN, use ListAliases.
- #
- # @option params [Hash<String,String>] :encryption_context
- # A set of key-value pairs that represents additional authenticated
- # data.
- #
- # For more information, see [Encryption Context][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
- #
- # @option params [Integer] :number_of_bytes
- # The length of the data key in bytes. For example, use the value 64 to
- # generate a 512-bit data key (64 bytes is 512 bits). For common key
- # lengths (128-bit and 256-bit symmetric keys), we recommend that you
- # use the `KeySpec` field instead of this one.
- #
- # @option params [String] :key_spec
- # The length of the data key. Use `AES_128` to generate a 128-bit
- # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk
#
# @option params [Array<String>] :grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
#
- # @return [Types::GenerateDataKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::GenerateDataKeyResponse#ciphertext_blob #ciphertext_blob} => String
- # * {Types::GenerateDataKeyResponse#plaintext #plaintext} => String
- # * {Types::GenerateDataKeyResponse#key_id #key_id} => String
+ # * {Types::DescribeKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata
#
#
- # @example Example: To generate a data key
+ # @example Example: To get details about a KMS key
#
- # # The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the
- # # unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK).
+ # # The following example gets metadata for a symmetric encryption KMS key.
#
- # resp = client.generate_data_key({
- # key_id: "alias/ExampleAlias", # The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
- # key_spec: "AES_256", # Specifies the type of data key to return.
+ # resp = client.describe_key({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
# })
#
# resp.to_h outputs the following:
# {
- # ciphertext_blob: "<binary data>", # The encrypted data key.
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data key.
- # plaintext: "<binary data>", # The unencrypted (plaintext) data key.
- # }
- #
- # @example Request syntax with placeholder values
- #
- # resp = client.generate_data_key({
- # key_id: "KeyIdType", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # number_of_bytes: 1,
- # key_spec: "AES_256", # accepts AES_256, AES_128
- # grant_tokens: ["GrantTokenType"],
- # })
- #
- # @example Response structure
- #
- # resp.ciphertext_blob #=> String
- # resp.plaintext #=> String
- # resp.key_id #=> String
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey AWS API Documentation
- #
- # @overload generate_data_key(params = {})
- # @param [Hash] params ({})
- def generate_data_key(params = {}, options = {})
- req = build_request(:generate_data_key, params)
- req.send_request(options)
- end
-
- # Generates a unique data key. This operation returns a data key that is
- # encrypted under a customer master key (CMK) that you specify.
- # `GenerateDataKeyWithoutPlaintext` is identical to GenerateDataKey
- # except that returns only the encrypted copy of the data key.
- #
- # Like `GenerateDataKey`, `GenerateDataKeyWithoutPlaintext` returns a
- # unique data key for each request. The bytes in the key are not related
- # to the caller or CMK that is used to encrypt the data key.
- #
- # This operation is useful for systems that need to encrypt data at some
- # point, but not immediately. When you need to encrypt the data, you
- # call the Decrypt operation on the encrypted copy of the key.
- #
- # It's also useful in distributed systems with different levels of
- # trust. For example, you might store encrypted data in containers. One
- # component of your system creates new containers and stores an
- # encrypted data key with each container. Then, a different component
- # puts the data into the containers. That component first decrypts the
- # data key, uses the plaintext data key to encrypt data, puts the
- # encrypted data into the container, and then destroys the plaintext
- # data key. In this system, the component that creates the containers
- # never sees the plaintext data key.
- #
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
- #
- #
- #
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
- #
- # @option params [required, String] :key_id
- # The identifier of the customer master key (CMK) that encrypts the data
- # key.
- #
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must use
- # the key ARN or alias ARN.
- #
- # For example:
- #
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
- #
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
- #
- # * Alias name: `alias/ExampleAlias`
- #
- # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse("2017-07-05T14:04:55-07:00"),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # }, # An object that contains information about the specified KMS key.
+ # }
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- # To get the alias name and alias ARN, use ListAliases.
+ # @example Example: To get details about an RSA asymmetric KMS key
#
- # @option params [Hash<String,String>] :encryption_context
- # A set of key-value pairs that represents additional authenticated
- # data.
+ # # The following example gets metadata for an asymmetric RSA KMS key used for signing and verification.
#
- # For more information, see [Encryption Context][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # resp = client.describe_key({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
+ # })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse(1571767572.317),
+ # customer_master_key_spec: "RSA_2048",
+ # description: "",
+ # enabled: false,
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "RSA_2048",
+ # key_state: "Disabled",
+ # key_usage: "SIGN_VERIFY",
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # signing_algorithms: [
+ # "RSASSA_PKCS1_V1_5_SHA_256",
+ # "RSASSA_PKCS1_V1_5_SHA_384",
+ # "RSASSA_PKCS1_V1_5_SHA_512",
+ # "RSASSA_PSS_SHA_256",
+ # "RSASSA_PSS_SHA_384",
+ # "RSASSA_PSS_SHA_512",
+ # ],
+ # }, # An object that contains information about the specified KMS key.
+ # }
#
+ # @example Example: To get details about a multi-Region key
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # # The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key.
+ # # DescribeKey returns information about the primary key and all of its replicas.
#
- # @option params [String] :key_spec
- # The length of the data key. Use `AES_128` to generate a 128-bit
- # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
+ # resp = client.describe_key({
+ # key_id: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
+ # })
#
- # @option params [Integer] :number_of_bytes
- # The length of the data key in bytes. For example, use the value 64 to
- # generate a 512-bit data key (64 bytes is 512 bits). For common key
- # lengths (128-bit and 256-bit symmetric keys), we recommend that you
- # use the `KeySpec` field instead of this one.
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # creation_date: Time.parse(1586329200.918),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "mrk-1234abcd12ab34cd56ef1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: true,
+ # multi_region_configuration: {
+ # multi_region_key_type: "PRIMARY",
+ # primary_key: {
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "us-west-2",
+ # },
+ # replica_keys: [
+ # {
+ # arn: "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "eu-west-1",
+ # },
+ # {
+ # arn: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "ap-northeast-1",
+ # },
+ # {
+ # arn: "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "sa-east-1",
+ # },
+ # ],
+ # },
+ # origin: "AWS_KMS",
+ # }, # An object that contains information about the specified KMS key.
+ # }
#
- # @option params [Array<String>] :grant_tokens
- # A list of grant tokens.
+ # @example Example: To get details about an HMAC KMS key
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # # The following example gets the metadata of an HMAC KMS key.
#
+ # resp = client.describe_key({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
+ # })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "123456789012",
+ # arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse(1566160362.664),
+ # customer_master_key_spec: "HMAC_256",
+ # description: "Development test key",
+ # enabled: true,
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_state: "Enabled",
+ # key_usage: "GENERATE_VERIFY_MAC",
+ # mac_algorithms: [
+ # "HMAC_SHA_256",
+ # ],
+ # multi_region: false,
+ # origin: "AWS_KMS",
+ # }, # An object that contains information about the specified KMS key.
+ # }
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # @example Example: To get details about a KMS key in an AWS CloudHSM key store
#
- # @return [Types::GenerateDataKeyWithoutPlaintextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # # The following example gets the metadata of a KMS key in an AWS CloudHSM key store.
#
- # * {Types::GenerateDataKeyWithoutPlaintextResponse#ciphertext_blob #ciphertext_blob} => String
- # * {Types::GenerateDataKeyWithoutPlaintextResponse#key_id #key_id} => String
+ # resp = client.describe_key({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
+ # })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_metadata: {
+ # aws_account_id: "123456789012",
+ # arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # cloud_hsm_cluster_id: "cluster-234abcdefABC",
+ # creation_date: Time.parse(1646160362.664),
+ # custom_key_store_id: "cks-1234567890abcdef0",
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "CloudHSM key store test key",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "AWS_CLOUDHSM",
+ # }, # An object that contains information about the specified KMS key.
+ # }
#
- # @example Example: To generate an encrypted data key
+ # @example Example: To get details about a KMS key in an external key store
#
- # # The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is
- # # encrypted with the specified customer master key (CMK).
+ # # The following example gets the metadata of a KMS key in an external key store.
#
- # resp = client.generate_data_key_without_plaintext({
- # key_id: "alias/ExampleAlias", # The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
- # key_spec: "AES_256", # Specifies the type of data key to return.
+ # resp = client.describe_key({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
# })
#
# resp.to_h outputs the following:
# {
- # ciphertext_blob: "<binary data>", # The encrypted data key.
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data key.
+ # key_metadata: {
+ # aws_account_id: "123456789012",
+ # arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # creation_date: Time.parse(1646160362.664),
+ # custom_key_store_id: "cks-1234567890abcdef0",
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "External key store test key",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_spec: "SYMMETRIC_DEFAULT",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: false,
+ # origin: "EXTERNAL_KEY_STORE",
+ # xks_key_configuration: {
+ # id: "bb8562717f809024",
+ # },
+ # }, # An object that contains information about the specified KMS key.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.generate_data_key_without_plaintext({
+ # resp = client.describe_key({
# key_id: "KeyIdType", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # key_spec: "AES_256", # accepts AES_256, AES_128
- # number_of_bytes: 1,
# grant_tokens: ["GrantTokenType"],
# })
#
# @example Response structure
#
- # resp.ciphertext_blob #=> String
- # resp.key_id #=> String
+ # resp.key_metadata.aws_account_id #=> String
+ # resp.key_metadata.key_id #=> String
+ # resp.key_metadata.arn #=> String
+ # resp.key_metadata.creation_date #=> Time
+ # resp.key_metadata.enabled #=> Boolean
+ # resp.key_metadata.description #=> String
+ # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC"
+ # resp.key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating"
+ # resp.key_metadata.deletion_date #=> Time
+ # resp.key_metadata.valid_to #=> Time
+ # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE"
+ # resp.key_metadata.custom_key_store_id #=> String
+ # resp.key_metadata.cloud_hsm_cluster_id #=> String
+ # resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
+ # resp.key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
+ # resp.key_metadata.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_metadata.key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_metadata.encryption_algorithms #=> Array
+ # resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.key_metadata.signing_algorithms #=> Array
+ # resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
+ # resp.key_metadata.multi_region #=> Boolean
+ # resp.key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
+ # resp.key_metadata.multi_region_configuration.primary_key.arn #=> String
+ # resp.key_metadata.multi_region_configuration.primary_key.region #=> String
+ # resp.key_metadata.multi_region_configuration.replica_keys #=> Array
+ # resp.key_metadata.multi_region_configuration.replica_keys[0].arn #=> String
+ # resp.key_metadata.multi_region_configuration.replica_keys[0].region #=> String
+ # resp.key_metadata.pending_deletion_window_in_days #=> Integer
+ # resp.key_metadata.mac_algorithms #=> Array
+ # resp.key_metadata.mac_algorithms[0] #=> String, one of "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512"
+ # resp.key_metadata.xks_key_configuration.id #=> String
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey AWS API Documentation
#
- # @overload generate_data_key_without_plaintext(params = {})
+ # @overload describe_key(params = {})
# @param [Hash] params ({})
- def generate_data_key_without_plaintext(params = {}, options = {})
- req = build_request(:generate_data_key_without_plaintext, params)
+ def describe_key(params = {}, options = {})
+ req = build_request(:describe_key, params)
req.send_request(options)
end
- # Returns a random byte string that is cryptographically secure.
+ # Sets the state of a KMS key to disabled. This change temporarily
+ # prevents use of the KMS key for [cryptographic operations][1].
#
- # By default, the random byte string is generated in AWS KMS. To
- # generate the byte string in the AWS CloudHSM cluster that is
- # associated with a [custom key store][1], specify the custom key store
- # ID.
+ # For more information about how key state affects the use of a KMS key,
+ # see [Key states of KMS keys][2] in the <i> <i>Key Management Service
+ # Developer Guide</i> </i>.
#
- # For more information about entropy and random number generation, see
- # the [AWS Key Management Service Cryptographic Details][2] whitepaper.
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
#
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
+ # **Required permissions**: [kms:DisableKey][3] (key policy)
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [2]: https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf
+ # **Related operations**: EnableKey
#
- # @option params [Integer] :number_of_bytes
- # The length of the byte string.
#
- # @option params [String] :custom_key_store_id
- # Generates the random byte string in the AWS CloudHSM cluster that is
- # associated with the specified [custom key store][1]. To find the ID of
- # a custom key store, use the DescribeCustomKeyStores operation.
#
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
+ # @option params [required, String] :key_id
+ # Identifies the KMS key to disable.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # Specify the key ID or key ARN of the KMS key.
#
- # @return [Types::GenerateRandomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # For example:
#
- # * {Types::GenerateRandomResponse#plaintext #plaintext} => String
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # @example Example: To generate random data
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # # The following example uses AWS KMS to generate 32 bytes of random data.
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
- # resp = client.generate_random({
- # number_of_bytes: 32, # The length of the random data, specified in number of bytes.
- # })
#
- # resp.to_h outputs the following:
- # {
- # plaintext: "<binary data>", # The random data.
- # }
+ # @example Example: To disable a KMS key
#
- # @example Request syntax with placeholder values
+ # # The following example disables the specified KMS key.
#
- # resp = client.generate_random({
- # number_of_bytes: 1,
- # custom_key_store_id: "CustomKeyStoreIdType",
+ # resp = client.disable_key({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to disable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
- # @example Response structure
+ # @example Request syntax with placeholder values
#
- # resp.plaintext #=> String
+ # resp = client.disable_key({
+ # key_id: "KeyIdType", # required
+ # })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey AWS API Documentation
#
- # @overload generate_random(params = {})
+ # @overload disable_key(params = {})
# @param [Hash] params ({})
- def generate_random(params = {}, options = {})
- req = build_request(:generate_random, params)
+ def disable_key(params = {}, options = {})
+ req = build_request(:disable_key, params)
req.send_request(options)
end
- # Gets a key policy attached to the specified customer master key (CMK).
- # You cannot perform this operation on a CMK in a different AWS account.
+ # Disables [automatic rotation of the key material][1] of the specified
+ # symmetric encryption KMS key.
+ #
+ # Automatic key rotation is supported only on symmetric encryption KMS
+ # keys. You cannot enable automatic rotation of [asymmetric KMS
+ # keys][2], [HMAC KMS keys][3], KMS keys with [imported key
+ # material][4], or KMS keys in a [custom key store][5]. To enable or
+ # disable automatic rotation of a set of related [multi-Region keys][6],
+ # set the property on the primary key.
+ #
+ # You can enable (EnableKeyRotation) and disable automatic rotation of
+ # the key material in [customer managed KMS keys][7]. Key material
+ # rotation of [Amazon Web Services managed KMS keys][8] is not
+ # configurable. KMS always rotates the key material for every year.
+ # Rotation of [Amazon Web Services owned KMS keys][9] varies.
+ #
+ # <note markdown="1"> In May 2022, KMS changed the rotation schedule for Amazon Web Services
+ # managed keys from every three years to every year. For details, see
+ # EnableKeyRotation.
+ #
+ # </note>
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][10] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:DisableKeyRotation][11] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * EnableKeyRotation
+ #
+ # * GetKeyRotationStatus
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies a symmetric encryption KMS key. You cannot enable or
+ # disable automatic rotation of [asymmetric KMS keys][1], [HMAC KMS
+ # keys][2], KMS keys with [imported key material][3], or KMS keys in a
+ # [custom key store][4].
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2221,162 +3596,157 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # @option params [required, String] :policy_name
- # Specifies the name of the key policy. The only valid name is
- # `default`. To get the names of key policies, use ListKeyPolicies.
#
- # @return [Types::GetKeyPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::GetKeyPolicyResponse#policy #policy} => String
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
#
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
- # @example Example: To retrieve a key policy
#
- # # The following example retrieves the key policy for the specified customer master key (CMK).
+ # @example Example: To disable automatic rotation of key material
#
- # resp = client.get_key_policy({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # policy_name: "default", # The name of the key policy to retrieve.
- # })
+ # # The following example disables automatic annual rotation of the key material for the specified KMS key.
#
- # resp.to_h outputs the following:
- # {
- # policy: "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",\n \"Statement\" : [ {\n \"Sid\" : \"Enable IAM User Permissions\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::111122223333:root\"\n },\n \"Action\" : \"kms:*\",\n \"Resource\" : \"*\"\n } ]\n}", # The key policy document.
- # }
+ # resp = client.disable_key_rotation({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
#
# @example Request syntax with placeholder values
#
- # resp = client.get_key_policy({
+ # resp = client.disable_key_rotation({
# key_id: "KeyIdType", # required
- # policy_name: "PolicyNameType", # required
# })
#
- # @example Response structure
- #
- # resp.policy #=> String
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation AWS API Documentation
#
- # @overload get_key_policy(params = {})
+ # @overload disable_key_rotation(params = {})
# @param [Hash] params ({})
- def get_key_policy(params = {}, options = {})
- req = build_request(:get_key_policy, params)
+ def disable_key_rotation(params = {}, options = {})
+ req = build_request(:disable_key_rotation, params)
req.send_request(options)
end
- # Gets a Boolean value that indicates whether [automatic rotation of the
- # key material][1] is enabled for the specified customer master key
- # (CMK).
+ # Disconnects the [custom key store][1] from its backing key store. This
+ # operation disconnects an CloudHSM key store from its associated
+ # CloudHSM cluster or disconnects an external key store from the
+ # external key store proxy that communicates with your external key
+ # manager.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
#
- # * Disabled: The key rotation status does not change when you disable a
- # CMK. However, while the CMK is disabled, AWS KMS does not rotate the
- # backing key.
+ # While a custom key store is disconnected, you can manage the custom
+ # key store and its KMS keys, but you cannot create or use its KMS keys.
+ # You can reconnect the custom key store at any time.
+ #
+ # <note markdown="1"> While a custom key store is disconnected, all attempts to create KMS
+ # keys in the custom key store or to use existing KMS keys in
+ # [cryptographic operations][2] will fail. This action can prevent users
+ # from storing and accessing sensitive data.
#
- # * Pending deletion: While a CMK is pending deletion, its key rotation
- # status is `false` and AWS KMS does not rotate the backing key. If
- # you cancel the deletion, the original key rotation status is
- # restored.
+ # </note>
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN in the value of the `KeyId` parameter.
+ # When you disconnect a custom key store, its `ConnectionState` changes
+ # to `Disconnected`. To find the connection state of a custom key store,
+ # use the DescribeCustomKeyStores operation. To reconnect a custom key
+ # store, use the ConnectCustomKeyStore operation.
#
+ # If the operation succeeds, it returns a JSON object with no
+ # properties.
#
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # **Required permissions**: [kms:DisconnectCustomKeyStore][3] (IAM
+ # policy)
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # **Related operations:**
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # * ConnectCustomKeyStore
#
- # For example:
+ # * CreateCustomKeyStore
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * DeleteCustomKeyStore
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * DescribeCustomKeyStores
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * UpdateCustomKeyStore
#
- # @return [Types::GetKeyRotationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::GetKeyRotationStatusResponse#key_rotation_enabled #key_rotation_enabled} => Boolean
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :custom_key_store_id
+ # Enter the ID of the custom key store you want to disconnect. To find
+ # the ID of a custom key store, use the DescribeCustomKeyStores
+ # operation.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To retrieve the rotation status for a customer master key (CMK)
+ # @example Example: To disconnect a custom key store from its CloudHSM cluster
#
- # # The following example retrieves the status of automatic annual rotation of the key material for the specified CMK.
+ # # This example disconnects an AWS KMS custom key store from its backing key store. For an AWS CloudHSM key store, it
+ # # disconnects the key store from its AWS CloudHSM cluster. For an external key store, it disconnects the key store from
+ # # the external key store proxy that communicates with your external key manager. This operation doesn't return any data.
+ # # To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation.
#
- # resp = client.get_key_rotation_status({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # resp = client.disconnect_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store.
# })
#
# resp.to_h outputs the following:
# {
- # key_rotation_enabled: true, # A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.get_key_rotation_status({
- # key_id: "KeyIdType", # required
+ # resp = client.disconnect_custom_key_store({
+ # custom_key_store_id: "CustomKeyStoreIdType", # required
# })
#
- # @example Response structure
- #
- # resp.key_rotation_enabled #=> Boolean
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStore AWS API Documentation
#
- # @overload get_key_rotation_status(params = {})
+ # @overload disconnect_custom_key_store(params = {})
# @param [Hash] params ({})
- def get_key_rotation_status(params = {}, options = {})
- req = build_request(:get_key_rotation_status, params)
+ def disconnect_custom_key_store(params = {}, options = {})
+ req = build_request(:disconnect_custom_key_store, params)
req.send_request(options)
end
- # Returns the items you need in order to import key material into AWS
- # KMS from your existing key management infrastructure. For more
- # information about importing key material into AWS KMS, see [Importing
- # Key Material][1] in the *AWS Key Management Service Developer Guide*.
+ # Sets the key state of a KMS key to enabled. This allows you to use the
+ # KMS key for [cryptographic operations][1].
#
- # You must specify the key ID of the customer master key (CMK) into
- # which you will import key material. This CMK's `Origin` must be
- # `EXTERNAL`. You must also specify the wrapping algorithm and type of
- # wrapping key (public key) that you will use to encrypt the key
- # material. You cannot perform this operation on a CMK in a different
- # AWS account.
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
#
- # This operation returns a public key and an import token. Use the
- # public key to encrypt the key material. Store the import token to send
- # with a subsequent ImportKeyMaterial request. The public key and import
- # token from the same response must be used together. These items are
- # valid for 24 hours. When they expire, they cannot be used for a
- # subsequent ImportKeyMaterial request. To get new ones, send another
- # `GetParametersForImport` request.
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Required permissions**: [kms:EnableKey][3] (key policy)
#
+ # **Related operations**: DisableKey
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # The identifier of the CMK into which you will import key material. The
- # CMK's `Origin` must be `EXTERNAL`.
+ # Identifies the KMS key to enable.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2385,127 +3755,107 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- #
- # @option params [required, String] :wrapping_algorithm
- # The algorithm you will use to encrypt the key material before
- # importing it with ImportKeyMaterial. For more information, see
- # [Encrypt the Key Material][1] in the *AWS Key Management Service
- # Developer Guide*.
- #
- #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html
- #
- # @option params [required, String] :wrapping_key_spec
- # The type of wrapping key (public key) to return in the response. Only
- # 2048-bit RSA public keys are supported.
- #
- # @return [Types::GetParametersForImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
- #
- # * {Types::GetParametersForImportResponse#key_id #key_id} => String
- # * {Types::GetParametersForImportResponse#import_token #import_token} => String
- # * {Types::GetParametersForImportResponse#public_key #public_key} => String
- # * {Types::GetParametersForImportResponse#parameters_valid_to #parameters_valid_to} => Time
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To retrieve the public key and import token for a customer master key (CMK)
+ # @example Example: To enable a KMS key
#
- # # The following example retrieves the public key and import token for the specified CMK.
+ # # The following example enables the specified KMS key.
#
- # resp = client.get_parameters_for_import({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # wrapping_algorithm: "RSAES_OAEP_SHA_1", # The algorithm that you will use to encrypt the key material before importing it.
- # wrapping_key_spec: "RSA_2048", # The type of wrapping key (public key) to return in the response.
+ # resp = client.enable_key({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to enable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
- # resp.to_h outputs the following:
- # {
- # import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.
- # parameters_valid_to: Time.parse("2016-12-01T14:52:17-08:00"), # The time at which the import token and public key are no longer valid.
- # public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
- # }
- #
# @example Request syntax with placeholder values
#
- # resp = client.get_parameters_for_import({
+ # resp = client.enable_key({
# key_id: "KeyIdType", # required
- # wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
- # wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048
# })
#
- # @example Response structure
- #
- # resp.key_id #=> String
- # resp.import_token #=> String
- # resp.public_key #=> String
- # resp.parameters_valid_to #=> Time
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey AWS API Documentation
#
- # @overload get_parameters_for_import(params = {})
+ # @overload enable_key(params = {})
# @param [Hash] params ({})
- def get_parameters_for_import(params = {}, options = {})
- req = build_request(:get_parameters_for_import, params)
+ def enable_key(params = {}, options = {})
+ req = build_request(:enable_key, params)
req.send_request(options)
end
- # Imports key material into an existing AWS KMS customer master key
- # (CMK) that was created without key material. You cannot perform this
- # operation on a CMK in a different AWS account. For more information
- # about creating CMKs with no key material and then importing key
- # material, see [Importing Key Material][1] in the *AWS Key Management
- # Service Developer Guide*.
- #
- # Before using this operation, call GetParametersForImport. Its response
- # includes a public key and an import token. Use the public key to
- # encrypt the key material. Then, submit the import token from the same
- # `GetParametersForImport` response.
- #
- # When calling this operation, you must specify the following values:
+ # Enables [automatic rotation of the key material][1] of the specified
+ # symmetric encryption KMS key.
+ #
+ # When you enable automatic rotation of a[customer managed KMS key][2],
+ # KMS rotates the key material of the KMS key one year (approximately
+ # 365 days) from the enable date and every year thereafter. You can
+ # monitor rotation of the key material for your KMS keys in CloudTrail
+ # and Amazon CloudWatch. To disable rotation of the key material in a
+ # customer managed KMS key, use the DisableKeyRotation operation.
+ #
+ # Automatic key rotation is supported only on [symmetric encryption KMS
+ # keys][3]. You cannot enable automatic rotation of [asymmetric KMS
+ # keys][4], [HMAC KMS keys][5], KMS keys with [imported key
+ # material][6], or KMS keys in a [custom key store][7]. To enable or
+ # disable automatic rotation of a set of related [multi-Region keys][8],
+ # set the property on the primary key.
+ #
+ # You cannot enable or disable automatic rotation [Amazon Web Services
+ # managed KMS keys][9]. KMS always rotates the key material of Amazon
+ # Web Services managed keys every year. Rotation of [Amazon Web Services
+ # owned KMS keys][10] varies.
+ #
+ # <note markdown="1"> In May 2022, KMS changed the rotation schedule for Amazon Web Services
+ # managed keys from every three years (approximately 1,095 days) to
+ # every year (approximately 365 days).
+ #
+ # New Amazon Web Services managed keys are automatically rotated one
+ # year after they are created, and approximately every year thereafter.
+ #
+ # Existing Amazon Web Services managed keys are automatically rotated
+ # one year after their most recent rotation, and every year thereafter.
#
- # * The key ID or key ARN of a CMK with no key material. Its `Origin`
- # must be `EXTERNAL`.
+ # </note>
#
- # To create a CMK with no key material, call CreateKey and set the
- # value of its `Origin` parameter to `EXTERNAL`. To get the `Origin`
- # of a CMK, call DescribeKey.)
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][11] in the *Key
+ # Management Service Developer Guide*.
#
- # * The encrypted key material. To get the public key to encrypt the key
- # material, call GetParametersForImport.
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # * The import token that GetParametersForImport returned. This token
- # and the public key used to encrypt the key material must have come
- # from the same response.
+ # **Required permissions**: [kms:EnableKeyRotation][12] (key policy)
#
- # * Whether the key material expires and if so, when. If you set an
- # expiration date, you can change it only by reimporting the same key
- # material and specifying a new expiration date. If the key material
- # expires, AWS KMS deletes the key material and the CMK becomes
- # unusable. To use the CMK again, you must reimport the same key
- # material.
+ # **Related operations:**
#
- # When this operation is successful, the key state of the CMK changes
- # from `PendingImport` to `Enabled`, and you can use the CMK. After you
- # successfully import key material into a CMK, you can reimport the same
- # key material into that CMK, but you cannot import different key
- # material.
+ # * DisableKeyRotation
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # * GetKeyRotationStatus
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk
+ # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # The identifier of the CMK to import the key material into. The CMK's
- # `Origin` must be `EXTERNAL`.
+ # Identifies a symmetric encryption KMS key. You cannot enable automatic
+ # rotation of [asymmetric KMS keys][1], [HMAC KMS keys][2], KMS keys
+ # with [imported key material][3], or KMS keys in a [custom key
+ # store][4]. To enable or disable automatic rotation of a set of related
+ # [multi-Region keys][5], set the property on the primary key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2514,221 +3864,140 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- #
- # @option params [required, String, IO] :import_token
- # The import token that you received in the response to a previous
- # GetParametersForImport request. It must be from the same response that
- # contained the public key that you used to encrypt the key material.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # @option params [required, String, IO] :encrypted_key_material
- # The encrypted key material to import. It must be encrypted with the
- # public key that you received in the response to a previous
- # GetParametersForImport request, using the wrapping algorithm that you
- # specified in that request.
#
- # @option params [Time,DateTime,Date,Integer,String] :valid_to
- # The time at which the imported key material expires. When the key
- # material expires, AWS KMS deletes the key material and the CMK becomes
- # unusable. You must omit this parameter when the `ExpirationModel`
- # parameter is set to `KEY_MATERIAL_DOES_NOT_EXPIRE`. Otherwise it is
- # required.
#
- # @option params [String] :expiration_model
- # Specifies whether the key material expires. The default is
- # `KEY_MATERIAL_EXPIRES`, in which case you must include the `ValidTo`
- # parameter. When this parameter is set to
- # `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo` parameter.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To import key material into a customer master key (CMK)
+ # @example Example: To enable automatic rotation of key material
#
- # # The following example imports key material into the specified CMK.
+ # # The following example enables automatic annual rotation of the key material for the specified KMS key.
#
- # resp = client.import_key_material({
- # encrypted_key_material: "<binary data>", # The encrypted key material to import.
- # expiration_model: "KEY_MATERIAL_DOES_NOT_EXPIRE", # A value that specifies whether the key material expires.
- # import_token: "<binary data>", # The import token that you received in the response to a previous GetParametersForImport request.
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # resp = client.enable_key_rotation({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.import_key_material({
+ # resp = client.enable_key_rotation({
# key_id: "KeyIdType", # required
- # import_token: "data", # required
- # encrypted_key_material: "data", # required
- # valid_to: Time.now,
- # expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation AWS API Documentation
#
- # @overload import_key_material(params = {})
+ # @overload enable_key_rotation(params = {})
# @param [Hash] params ({})
- def import_key_material(params = {}, options = {})
- req = build_request(:import_key_material, params)
+ def enable_key_rotation(params = {}, options = {})
+ req = build_request(:enable_key_rotation, params)
req.send_request(options)
end
- # Gets a list of aliases in the caller's AWS account and region. You
- # cannot list aliases in other accounts. For more information about
- # aliases, see CreateAlias.
- #
- # By default, the ListAliases command returns all aliases in the account
- # and region. To get only the aliases that point to a particular
- # customer master key (CMK), use the `KeyId` parameter.
- #
- # The `ListAliases` response can include aliases that you created and
- # associated with your customer managed CMKs, and aliases that AWS
- # created and associated with AWS managed CMKs in your account. You can
- # recognize AWS aliases because their names have the format
- # `aws/<service-name>`, such as `aws/dynamodb`.
- #
- # The response might also include aliases that have no `TargetKeyId`
- # field. These are predefined aliases that AWS has created but has not
- # yet associated with a CMK. Aliases that AWS creates in your account,
- # including predefined aliases, do not count against your [AWS KMS
- # aliases limit][1].
- #
- #
- #
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit
- #
- # @option params [String] :key_id
- # Lists only aliases that refer to the specified CMK. The value of this
- # parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the
- # caller's account and region. You cannot use an alias name or alias
- # ARN in this value.
+ # Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a
+ # symmetric or asymmetric KMS key with a `KeyUsage` of
+ # `ENCRYPT_DECRYPT`.
+ #
+ # You can use this operation to encrypt small amounts of arbitrary data,
+ # such as a personal identifier or database password, or other sensitive
+ # information. You don't need to use the `Encrypt` operation to encrypt
+ # a data key. The GenerateDataKey and GenerateDataKeyPair operations
+ # return a plaintext data key and an encrypted copy of that data key.
+ #
+ # If you use a symmetric encryption KMS key, you can use an encryption
+ # context to add additional security to your encryption operation. If
+ # you specify an `EncryptionContext` when encrypting data, you must
+ # specify the same encryption context (a case-sensitive exact match)
+ # when decrypting the data. Otherwise, the request to decrypt fails with
+ # an `InvalidCiphertextException`. For more information, see [Encryption
+ # Context][1] in the *Key Management Service Developer Guide*.
+ #
+ # If you specify an asymmetric KMS key, you must also specify the
+ # encryption algorithm. The algorithm must be compatible with the KMS
+ # key spec.
+ #
+ # When you use an asymmetric KMS key to encrypt or reencrypt data, be
+ # sure to record the KMS key and encryption algorithm that you choose.
+ # You will be required to provide the same KMS key and encryption
+ # algorithm when you decrypt the data. If the KMS key and algorithm do
+ # not match the values used to encrypt the data, the decrypt operation
+ # fails.
+ #
+ # You are not required to supply the key ID and encryption algorithm
+ # when you decrypt with symmetric encryption KMS keys because KMS stores
+ # this information in the ciphertext blob. KMS cannot store metadata in
+ # ciphertext generated with asymmetric keys. The standard format for
+ # asymmetric key ciphertext does not include configurable fields.
+ #
+ # The maximum size of the data that you can encrypt varies with the type
+ # of KMS key and the encryption algorithm that you choose.
+ #
+ # * Symmetric encryption KMS keys
+ #
+ # * `SYMMETRIC_DEFAULT`: 4096 bytes
#
- # This parameter is optional. If you omit it, `ListAliases` returns all
- # aliases in the account and region.
+ # ^
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # * `RSA_2048`
#
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to 50.
+ # * `RSAES_OAEP_SHA_1`: 214 bytes
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # * `RSAES_OAEP_SHA_256`: 190 bytes
#
- # @return [Types::ListAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # * `RSA_3072`
#
- # * {Types::ListAliasesResponse#aliases #aliases} => Array<Types::AliasListEntry>
- # * {Types::ListAliasesResponse#next_marker #next_marker} => String
- # * {Types::ListAliasesResponse#truncated #truncated} => Boolean
+ # * `RSAES_OAEP_SHA_1`: 342 bytes
#
+ # * `RSAES_OAEP_SHA_256`: 318 bytes
#
- # @example Example: To list aliases
+ # * `RSA_4096`
#
- # # The following example lists aliases.
+ # * `RSAES_OAEP_SHA_1`: 470 bytes
#
- # resp = client.list_aliases({
- # })
+ # * `RSAES_OAEP_SHA_256`: 446 bytes
#
- # resp.to_h outputs the following:
- # {
- # aliases: [
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
- # alias_name: "alias/aws/acm",
- # target_key_id: "da03f6f7-d279-427a-9cae-de48d07e5b66",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
- # alias_name: "alias/aws/ebs",
- # target_key_id: "25a217e7-7170-4b8c-8bf6-045ea5f70e5b",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
- # alias_name: "alias/aws/rds",
- # target_key_id: "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
- # alias_name: "alias/aws/redshift",
- # target_key_id: "08f7a25a-69e2-4fb5-8f10-393db27326fa",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
- # alias_name: "alias/aws/s3",
- # target_key_id: "d2b0f1a3-580d-4f79-b836-bc983be8cfa5",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example1",
- # alias_name: "alias/example1",
- # target_key_id: "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example2",
- # alias_name: "alias/example2",
- # target_key_id: "f32fef59-2cc2-445b-8573-2d73328acbee",
- # },
- # {
- # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example3",
- # alias_name: "alias/example3",
- # target_key_id: "1374ef38-d34e-4d5f-b2c9-4e0daee38855",
- # },
- # ], # A list of aliases, including the key ID of the customer master key (CMK) that each alias refers to.
- # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
- # }
+ # * `SM2PKE`: 1024 bytes (China Regions only)
#
- # @example Request syntax with placeholder values
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
#
- # resp = client.list_aliases({
- # key_id: "KeyIdType",
- # limit: 1,
- # marker: "MarkerType",
- # })
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
#
- # @example Response structure
+ # **Required permissions**: [kms:Encrypt][3] (key policy)
#
- # resp.aliases #=> Array
- # resp.aliases[0].alias_name #=> String
- # resp.aliases[0].alias_arn #=> String
- # resp.aliases[0].target_key_id #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # **Related operations:**
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases AWS API Documentation
+ # * Decrypt
#
- # @overload list_aliases(params = {})
- # @param [Hash] params ({})
- def list_aliases(params = {}, options = {})
- req = build_request(:list_aliases, params)
- req.send_request(options)
- end
-
- # Gets a list of all grants for the specified customer master key (CMK).
+ # * GenerateDataKey
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN in the value of the `KeyId` parameter.
+ # * GenerateDataKeyPair
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
#
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to 50.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies the KMS key to use in the encryption operation. The KMS key
+ # must have a `KeyUsage` of `ENCRYPT_DECRYPT`. To find the `KeyUsage` of
+ # a KMS key, use the DescribeKey operation.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
#
# For example:
#
@@ -2737,127 +4006,4139 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
#
- # @return [Types::ListGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # * {Types::ListGrantsResponse#grants #grants} => Array<Types::GrantListEntry>
- # * {Types::ListGrantsResponse#next_marker #next_marker} => String
- # * {Types::ListGrantsResponse#truncated #truncated} => Boolean
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [required, String, StringIO, File] :plaintext
+ # Data to be encrypted.
+ #
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context that will be used to encrypt the
+ # data. An encryption context is valid only for [cryptographic
+ # operations][1] with a symmetric encryption KMS key. The standard
+ # asymmetric encryption algorithms and HMAC algorithms that KMS uses do
+ # not support an encryption context.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [String] :encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to encrypt the
+ # plaintext message. The algorithm must be compatible with the KMS key
+ # that you specify.
+ #
+ # This parameter is required only for asymmetric KMS keys. The default
+ # value, `SYMMETRIC_DEFAULT`, is the algorithm used for symmetric
+ # encryption KMS keys. If you are using an asymmetric KMS key, we
+ # recommend RSAES\_OAEP\_SHA\_256.
+ #
+ # The SM2PKE algorithm is only available in China Regions.
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::EncryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::EncryptResponse#ciphertext_blob #ciphertext_blob} => String
+ # * {Types::EncryptResponse#key_id #key_id} => String
+ # * {Types::EncryptResponse#encryption_algorithm #encryption_algorithm} => String
+ #
+ #
+ # @example Example: To encrypt data with a symmetric encryption KMS key
+ #
+ # # The following example encrypts data with the specified symmetric encryption KMS key.
+ #
+ # resp = client.encrypt({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
+ # plaintext: "<binary data>", # The data to encrypt.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
+ # encryption_algorithm: "SYMMETRIC_DEFAULT", # The encryption algorithm that was used in the operation. For symmetric encryption keys, the encryption algorithm is always SYMMETRIC_DEFAULT.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that was used to encrypt the data.
+ # }
+ #
+ # @example Example: To encrypt data with an asymmetric encryption KMS key
+ #
+ # # The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key,
+ # # you must specify the encryption algorithm.
+ #
+ # resp = client.encrypt({
+ # encryption_algorithm: "RSAES_OAEP_SHA_256", # The encryption algorithm to use in the operation.
+ # key_id: "0987dcba-09fe-87dc-65ba-ab0987654321", # The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
+ # plaintext: "<binary data>", # The data to encrypt.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
+ # encryption_algorithm: "RSAES_OAEP_SHA_256", # The encryption algorithm that was used in the operation.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The ARN of the KMS key that was used to encrypt the data.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.encrypt({
+ # key_id: "KeyIdType", # required
+ # plaintext: "data", # required
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # grant_tokens: ["GrantTokenType"],
+ # encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.ciphertext_blob #=> String
+ # resp.key_id #=> String
+ # resp.encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt AWS API Documentation
+ #
+ # @overload encrypt(params = {})
+ # @param [Hash] params ({})
+ def encrypt(params = {}, options = {})
+ req = build_request(:encrypt, params)
+ req.send_request(options)
+ end
+
+ # Returns a unique symmetric data key for use outside of KMS. This
+ # operation returns a plaintext copy of the data key and a copy that is
+ # encrypted under a symmetric encryption KMS key that you specify. The
+ # bytes in the plaintext key are random; they are not related to the
+ # caller or the KMS key. You can use the plaintext key to encrypt your
+ # data outside of KMS and store the encrypted data key with the
+ # encrypted data.
+ #
+ # To generate a data key, specify the symmetric encryption KMS key that
+ # will be used to encrypt the data key. You cannot use an asymmetric KMS
+ # key to encrypt data keys. To get the type of your KMS key, use the
+ # DescribeKey operation.
+ #
+ # You must also specify the length of the data key. Use either the
+ # `KeySpec` or `NumberOfBytes` parameters (but not both). For 128-bit
+ # and 256-bit data keys, use the `KeySpec` parameter.
+ #
+ # To generate a 128-bit SM4 data key (China Regions only), specify a
+ # `KeySpec` value of `AES_128` or a `NumberOfBytes` value of `16`. The
+ # symmetric encryption key used in China Regions to encrypt your data
+ # key is an SM4 encryption key.
+ #
+ # To get only an encrypted copy of the data key, use
+ # GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key
+ # pair, use the GenerateDataKeyPair or
+ # GenerateDataKeyPairWithoutPlaintext operation. To get a
+ # cryptographically secure random byte string, use GenerateRandom.
+ #
+ # You can use an optional encryption context to add additional security
+ # to the encryption operation. If you specify an `EncryptionContext`,
+ # you must specify the same encryption context (a case-sensitive exact
+ # match) when decrypting the encrypted data key. Otherwise, the request
+ # to decrypt fails with an `InvalidCiphertextException`. For more
+ # information, see [Encryption Context][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # `GenerateDataKey` also supports [Amazon Web Services Nitro
+ # Enclaves][2], which provide an isolated compute environment in Amazon
+ # EC2. To call `GenerateDataKey` for an Amazon Web Services Nitro
+ # enclave, use the [Amazon Web Services Nitro Enclaves SDK][3] or any
+ # Amazon Web Services SDK. Use the `Recipient` parameter to provide the
+ # attestation document for the enclave. `GenerateDataKey` returns a copy
+ # of the data key encrypted under the specified KMS key, as usual. But
+ # instead of a plaintext copy of the data key, the response includes a
+ # copy of the data key encrypted under the public key from the
+ # attestation document (`CiphertextForRecipient`). For information about
+ # the interaction between KMS and Amazon Web Services Nitro Enclaves,
+ # see [How Amazon Web Services Nitro Enclaves uses KMS][4] in the *Key
+ # Management Service Developer Guide*..
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][5] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **How to use your data key**
+ #
+ # We recommend that you use the following pattern to encrypt data
+ # locally in your application. You can write your own code or use a
+ # client-side encryption library, such as the [Amazon Web Services
+ # Encryption SDK][6], the [Amazon DynamoDB Encryption Client][7], or
+ # [Amazon S3 client-side encryption][8] to do these tasks for you.
+ #
+ # To encrypt data outside of KMS:
+ #
+ # 1. Use the `GenerateDataKey` operation to get a data key.
+ #
+ # 2. Use the plaintext data key (in the `Plaintext` field of the
+ # response) to encrypt your data outside of KMS. Then erase the
+ # plaintext data key from memory.
+ #
+ # 3. Store the encrypted data key (in the `CiphertextBlob` field of the
+ # response) with the encrypted data.
+ #
+ # To decrypt data outside of KMS:
+ #
+ # 1. Use the Decrypt operation to decrypt the encrypted data key. The
+ # operation returns a plaintext copy of the data key.
+ #
+ # 2. Use the plaintext data key to decrypt data outside of KMS, then
+ # erase the plaintext data key from memory.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GenerateDataKey][9] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * Decrypt
+ #
+ # * Encrypt
+ #
+ # * GenerateDataKeyPair
+ #
+ # * GenerateDataKeyPairWithoutPlaintext
+ #
+ # * GenerateDataKeyWithoutPlaintext
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html
+ # [3]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [6]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/
+ # [7]: https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/
+ # [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Specifies the symmetric encryption KMS key that encrypts the data key.
+ # You cannot specify an asymmetric KMS key or a KMS key in a custom key
+ # store. To get the type and origin of your KMS key, use the DescribeKey
+ # operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context that will be used when encrypting the
+ # data key.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [Integer] :number_of_bytes
+ # Specifies the length of the data key in bytes. For example, use the
+ # value 64 to generate a 512-bit data key (64 bytes is 512 bits). For
+ # 128-bit (16-byte) and 256-bit (32-byte) data keys, use the `KeySpec`
+ # parameter.
+ #
+ # You must specify either the `KeySpec` or the `NumberOfBytes` parameter
+ # (but not both) in every `GenerateDataKey` request.
+ #
+ # @option params [String] :key_spec
+ # Specifies the length of the data key. Use `AES_128` to generate a
+ # 128-bit symmetric key, or `AES_256` to generate a 256-bit symmetric
+ # key.
+ #
+ # You must specify either the `KeySpec` or the `NumberOfBytes` parameter
+ # (but not both) in every `GenerateDataKey` request.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Types::RecipientInfo] :recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's public
+ # key. The only valid encryption algorithm is `RSAES_OAEP_SHA_256`.
+ #
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
+ #
+ # When you use this parameter, instead of returning the plaintext data
+ # key, KMS encrypts the plaintext data key under the public key in the
+ # attestation document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can be
+ # decrypted only with the private key in the enclave. The
+ # `CiphertextBlob` field in the response contains a copy of the data key
+ # encrypted under the KMS key specified by the `KeyId` parameter. The
+ # `Plaintext` field in the response is null or empty.
+ #
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::GenerateDataKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateDataKeyResponse#ciphertext_blob #ciphertext_blob} => String
+ # * {Types::GenerateDataKeyResponse#plaintext #plaintext} => String
+ # * {Types::GenerateDataKeyResponse#key_id #key_id} => String
+ # * {Types::GenerateDataKeyResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String
+ #
+ #
+ # @example Example: To generate a data key
+ #
+ # # The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the
+ # # unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.
+ #
+ # resp = client.generate_data_key({
+ # key_id: "alias/ExampleAlias", # The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
+ # key_spec: "AES_256", # Specifies the type of data key to return.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The encrypted data key.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that was used to encrypt the data key.
+ # plaintext: "<binary data>", # The unencrypted (plaintext) data key.
+ # }
+ #
+ # @example Example: To generate a data key pair for a Nitro enclave
+ #
+ # # The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave.
+ # # Instead of returning a copy of the data key encrypted by the KMS key and a plaintext copy of the data key,
+ # # GenerateDataKey returns one copy of the data key encrypted by the KMS key (CiphertextBlob) and one copy of the data key
+ # # encrypted by the public key from the attestation document (CiphertextForRecipient). The operation doesn't return a
+ # # plaintext data key.
+ #
+ # resp = client.generate_data_key({
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # Identifies the KMS key used to encrypt the encrypted data key (CiphertextBlob)
+ # key_spec: "AES_256", # Specifies the type of data key to return
+ # recipient: {
+ # attestation_document: "<attestation document>",
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256",
+ # }, # Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The data key encrypted by the specified KMS key
+ # ciphertext_for_recipient: "<binary data>", # The plaintext data key encrypted by the public key from the attestation document
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The KMS key used to encrypt the CiphertextBlob (encrypted data key)
+ # plaintext: "", # This field is null or empty
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_data_key({
+ # key_id: "KeyIdType", # required
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # number_of_bytes: 1,
+ # key_spec: "AES_256", # accepts AES_256, AES_128
+ # grant_tokens: ["GrantTokenType"],
+ # recipient: {
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256", # accepts RSAES_OAEP_SHA_256
+ # attestation_document: "data",
+ # },
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.ciphertext_blob #=> String
+ # resp.plaintext #=> String
+ # resp.key_id #=> String
+ # resp.ciphertext_for_recipient #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey AWS API Documentation
+ #
+ # @overload generate_data_key(params = {})
+ # @param [Hash] params ({})
+ def generate_data_key(params = {}, options = {})
+ req = build_request(:generate_data_key, params)
+ req.send_request(options)
+ end
+
+ # Returns a unique asymmetric data key pair for use outside of KMS. This
+ # operation returns a plaintext public key, a plaintext private key, and
+ # a copy of the private key that is encrypted under the symmetric
+ # encryption KMS key you specify. You can use the data key pair to
+ # perform asymmetric cryptography and implement digital signatures
+ # outside of KMS. The bytes in the keys are random; they not related to
+ # the caller or to the KMS key that is used to encrypt the private key.
+ #
+ # You can use the public key that `GenerateDataKeyPair` returns to
+ # encrypt data or verify a signature outside of KMS. Then, store the
+ # encrypted private key with the data. When you are ready to decrypt
+ # data or sign a message, you can use the Decrypt operation to decrypt
+ # the encrypted private key.
+ #
+ # To generate a data key pair, you must specify a symmetric encryption
+ # KMS key to encrypt the private key in a data key pair. You cannot use
+ # an asymmetric KMS key or a KMS key in a custom key store. To get the
+ # type and origin of your KMS key, use the DescribeKey operation.
+ #
+ # Use the `KeyPairSpec` parameter to choose an RSA or Elliptic Curve
+ # (ECC) data key pair. In China Regions, you can also choose an SM2 data
+ # key pair. KMS recommends that you use ECC key pairs for signing, and
+ # use RSA and SM2 key pairs for either encryption or signing, but not
+ # both. However, KMS cannot enforce any restrictions on the use of data
+ # key pairs outside of KMS.
+ #
+ # If you are using the data key pair to encrypt data, or for any
+ # operation where you don't immediately need a private key, consider
+ # using the GenerateDataKeyPairWithoutPlaintext operation.
+ # `GenerateDataKeyPairWithoutPlaintext` returns a plaintext public key
+ # and an encrypted private key, but omits the plaintext private key that
+ # you need only to decrypt ciphertext or sign a message. Later, when you
+ # need to decrypt the data or sign a message, use the Decrypt operation
+ # to decrypt the encrypted private key in the data key pair.
+ #
+ # `GenerateDataKeyPair` returns a unique data key pair for each request.
+ # The bytes in the keys are random; they are not related to the caller
+ # or the KMS key that is used to encrypt the private key. The public key
+ # is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in [RFC
+ # 5280][1]. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as
+ # specified in [RFC 5958][2].
+ #
+ # `GenerateDataKeyPair` also supports [Amazon Web Services Nitro
+ # Enclaves][3], which provide an isolated compute environment in Amazon
+ # EC2. To call `GenerateDataKeyPair` for an Amazon Web Services Nitro
+ # enclave, use the [Amazon Web Services Nitro Enclaves SDK][4] or any
+ # Amazon Web Services SDK. Use the `Recipient` parameter to provide the
+ # attestation document for the enclave. `GenerateDataKeyPair` returns
+ # the public data key and a copy of the private data key encrypted under
+ # the specified KMS key, as usual. But instead of a plaintext copy of
+ # the private data key (`PrivateKeyPlaintext`), the response includes a
+ # copy of the private data key encrypted under the public key from the
+ # attestation document (`CiphertextForRecipient`). For information about
+ # the interaction between KMS and Amazon Web Services Nitro Enclaves,
+ # see [How Amazon Web Services Nitro Enclaves uses KMS][5] in the *Key
+ # Management Service Developer Guide*..
+ #
+ # You can use an optional encryption context to add additional security
+ # to the encryption operation. If you specify an `EncryptionContext`,
+ # you must specify the same encryption context (a case-sensitive exact
+ # match) when decrypting the encrypted data key. Otherwise, the request
+ # to decrypt fails with an `InvalidCiphertextException`. For more
+ # information, see [Encryption Context][6] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][7] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GenerateDataKeyPair][8] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * Decrypt
+ #
+ # * Encrypt
+ #
+ # * GenerateDataKey
+ #
+ # * GenerateDataKeyPairWithoutPlaintext
+ #
+ # * GenerateDataKeyWithoutPlaintext
+ #
+ #
+ #
+ # [1]: https://tools.ietf.org/html/rfc5280
+ # [2]: https://tools.ietf.org/html/rfc5958
+ # [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html
+ # [4]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context that will be used when encrypting the
+ # private key in the data key pair.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [required, String] :key_id
+ # Specifies the symmetric encryption KMS key that encrypts the private
+ # key in the data key pair. You cannot specify an asymmetric KMS key or
+ # a KMS key in a custom key store. To get the type and origin of your
+ # KMS key, use the DescribeKey operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [required, String] :key_pair_spec
+ # Determines the type of data key pair that is generated.
+ #
+ # The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys
+ # to encrypt and decrypt or to sign and verify (but not both), and the
+ # rule that permits you to use ECC KMS keys only to sign and verify, are
+ # not effective on data key pairs, which are used outside of KMS. The
+ # SM2 key spec is only available in China Regions.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Types::RecipientInfo] :recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's public
+ # key. The only valid encryption algorithm is `RSAES_OAEP_SHA_256`.
+ #
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
+ #
+ # When you use this parameter, instead of returning a plaintext copy of
+ # the private data key, KMS encrypts the plaintext private data key
+ # under the public key in the attestation document, and returns the
+ # resulting ciphertext in the `CiphertextForRecipient` field in the
+ # response. This ciphertext can be decrypted only with the private key
+ # in the enclave. The `CiphertextBlob` field in the response contains a
+ # copy of the private data key encrypted under the KMS key specified by
+ # the `KeyId` parameter. The `PrivateKeyPlaintext` field in the response
+ # is null or empty.
+ #
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::GenerateDataKeyPairResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateDataKeyPairResponse#private_key_ciphertext_blob #private_key_ciphertext_blob} => String
+ # * {Types::GenerateDataKeyPairResponse#private_key_plaintext #private_key_plaintext} => String
+ # * {Types::GenerateDataKeyPairResponse#public_key #public_key} => String
+ # * {Types::GenerateDataKeyPairResponse#key_id #key_id} => String
+ # * {Types::GenerateDataKeyPairResponse#key_pair_spec #key_pair_spec} => String
+ # * {Types::GenerateDataKeyPairResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String
+ #
+ #
+ # @example Example: To generate an RSA key pair for encryption and decryption
+ #
+ # # This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key
+ # # and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.
+ #
+ # resp = client.generate_data_key_pair({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
+ # key_pair_spec: "RSA_3072", # The requested key spec of the RSA data key pair.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the symmetric encryption KMS key that was used to encrypt the private key.
+ # key_pair_spec: "RSA_3072", # The actual key spec of the RSA data key pair.
+ # private_key_ciphertext_blob: "<binary data>", # The encrypted private key of the RSA data key pair.
+ # private_key_plaintext: "<binary data>", # The plaintext private key of the RSA data key pair.
+ # public_key: "<binary data>", # The public key (plaintext) of the RSA data key pair.
+ # }
+ #
+ # @example Example: To generate a data key pair for a Nitro enclave
+ #
+ # # The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave.
+ # # Instead of returning a plaintext copy of the private data key, GenerateDataKeyPair returns a copy of the private data
+ # # key encrypted by the public key from the attestation document (CiphertextForRecipient). It returns the public data key
+ # # (PublicKey) and a copy of private data key encrypted under the specified KMS key (PrivateKeyCiphertextBlob), as usual,
+ # # but plaintext private data key field (PrivateKeyPlaintext) is null or empty.
+ #
+ # resp = client.generate_data_key_pair({
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
+ # key_pair_spec: "RSA_3072", # The requested key spec of the RSA data key pair.
+ # recipient: {
+ # attestation_document: "<attestation document>",
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256",
+ # }, # Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_for_recipient: "<binary data>", # The private key of the RSA data key pair encrypted by the public key from the attestation document
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the symmetric encryption KMS key that was used to encrypt the PrivateKeyCiphertextBlob.
+ # key_pair_spec: "RSA_3072", # The actual key spec of the RSA data key pair.
+ # private_key_ciphertext_blob: "<binary data>", # The private key of the RSA data key pair encrypted by the KMS key.
+ # private_key_plaintext: "", # This field is null or empty
+ # public_key: "<binary data>", # The public key (plaintext) of the RSA data key pair.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_data_key_pair({
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # key_id: "KeyIdType", # required
+ # key_pair_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2
+ # grant_tokens: ["GrantTokenType"],
+ # recipient: {
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256", # accepts RSAES_OAEP_SHA_256
+ # attestation_document: "data",
+ # },
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.private_key_ciphertext_blob #=> String
+ # resp.private_key_plaintext #=> String
+ # resp.public_key #=> String
+ # resp.key_id #=> String
+ # resp.key_pair_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SM2"
+ # resp.ciphertext_for_recipient #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPair AWS API Documentation
+ #
+ # @overload generate_data_key_pair(params = {})
+ # @param [Hash] params ({})
+ def generate_data_key_pair(params = {}, options = {})
+ req = build_request(:generate_data_key_pair, params)
+ req.send_request(options)
+ end
+
+ # Returns a unique asymmetric data key pair for use outside of KMS. This
+ # operation returns a plaintext public key and a copy of the private key
+ # that is encrypted under the symmetric encryption KMS key you specify.
+ # Unlike GenerateDataKeyPair, this operation does not return a plaintext
+ # private key. The bytes in the keys are random; they are not related to
+ # the caller or to the KMS key that is used to encrypt the private key.
+ #
+ # You can use the public key that `GenerateDataKeyPairWithoutPlaintext`
+ # returns to encrypt data or verify a signature outside of KMS. Then,
+ # store the encrypted private key with the data. When you are ready to
+ # decrypt data or sign a message, you can use the Decrypt operation to
+ # decrypt the encrypted private key.
+ #
+ # To generate a data key pair, you must specify a symmetric encryption
+ # KMS key to encrypt the private key in a data key pair. You cannot use
+ # an asymmetric KMS key or a KMS key in a custom key store. To get the
+ # type and origin of your KMS key, use the DescribeKey operation.
+ #
+ # Use the `KeyPairSpec` parameter to choose an RSA or Elliptic Curve
+ # (ECC) data key pair. In China Regions, you can also choose an SM2 data
+ # key pair. KMS recommends that you use ECC key pairs for signing, and
+ # use RSA and SM2 key pairs for either encryption or signing, but not
+ # both. However, KMS cannot enforce any restrictions on the use of data
+ # key pairs outside of KMS.
+ #
+ # `GenerateDataKeyPairWithoutPlaintext` returns a unique data key pair
+ # for each request. The bytes in the key are not related to the caller
+ # or KMS key that is used to encrypt the private key. The public key is
+ # a DER-encoded X.509 SubjectPublicKeyInfo, as specified in [RFC
+ # 5280][1].
+ #
+ # You can use an optional encryption context to add additional security
+ # to the encryption operation. If you specify an `EncryptionContext`,
+ # you must specify the same encryption context (a case-sensitive exact
+ # match) when decrypting the encrypted data key. Otherwise, the request
+ # to decrypt fails with an `InvalidCiphertextException`. For more
+ # information, see [Encryption Context][2] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][3] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GenerateDataKeyPairWithoutPlaintext][4]
+ # (key policy)
+ #
+ # **Related operations:**
+ #
+ # * Decrypt
+ #
+ # * Encrypt
+ #
+ # * GenerateDataKey
+ #
+ # * GenerateDataKeyPair
+ #
+ # * GenerateDataKeyWithoutPlaintext
+ #
+ #
+ #
+ # [1]: https://tools.ietf.org/html/rfc5280
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context that will be used when encrypting the
+ # private key in the data key pair.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [required, String] :key_id
+ # Specifies the symmetric encryption KMS key that encrypts the private
+ # key in the data key pair. You cannot specify an asymmetric KMS key or
+ # a KMS key in a custom key store. To get the type and origin of your
+ # KMS key, use the DescribeKey operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [required, String] :key_pair_spec
+ # Determines the type of data key pair that is generated.
+ #
+ # The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys
+ # to encrypt and decrypt or to sign and verify (but not both), and the
+ # rule that permits you to use ECC KMS keys only to sign and verify, are
+ # not effective on data key pairs, which are used outside of KMS. The
+ # SM2 key spec is only available in China Regions.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::GenerateDataKeyPairWithoutPlaintextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateDataKeyPairWithoutPlaintextResponse#private_key_ciphertext_blob #private_key_ciphertext_blob} => String
+ # * {Types::GenerateDataKeyPairWithoutPlaintextResponse#public_key #public_key} => String
+ # * {Types::GenerateDataKeyPairWithoutPlaintextResponse#key_id #key_id} => String
+ # * {Types::GenerateDataKeyPairWithoutPlaintextResponse#key_pair_spec #key_pair_spec} => String
+ #
+ #
+ # @example Example: To generate an asymmetric data key pair without a plaintext key
+ #
+ # # This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric
+ # # encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key.
+ #
+ # resp = client.generate_data_key_pair_without_plaintext({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The symmetric encryption KMS key that encrypts the private key of the ECC data key pair.
+ # key_pair_spec: "ECC_NIST_P521", # The requested key spec of the ECC asymmetric data key pair.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the symmetric encryption KMS key that encrypted the private key in the ECC asymmetric data key pair.
+ # key_pair_spec: "ECC_NIST_P521", # The actual key spec of the ECC asymmetric data key pair.
+ # private_key_ciphertext_blob: "<binary data>", # The encrypted private key of the asymmetric ECC data key pair.
+ # public_key: "<binary data>", # The public key (plaintext).
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_data_key_pair_without_plaintext({
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # key_id: "KeyIdType", # required
+ # key_pair_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.private_key_ciphertext_blob #=> String
+ # resp.public_key #=> String
+ # resp.key_id #=> String
+ # resp.key_pair_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SM2"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintext AWS API Documentation
+ #
+ # @overload generate_data_key_pair_without_plaintext(params = {})
+ # @param [Hash] params ({})
+ def generate_data_key_pair_without_plaintext(params = {}, options = {})
+ req = build_request(:generate_data_key_pair_without_plaintext, params)
+ req.send_request(options)
+ end
+
+ # Returns a unique symmetric data key for use outside of KMS. This
+ # operation returns a data key that is encrypted under a symmetric
+ # encryption KMS key that you specify. The bytes in the key are random;
+ # they are not related to the caller or to the KMS key.
+ #
+ # `GenerateDataKeyWithoutPlaintext` is identical to the GenerateDataKey
+ # operation except that it does not return a plaintext copy of the data
+ # key.
+ #
+ # This operation is useful for systems that need to encrypt data at some
+ # point, but not immediately. When you need to encrypt the data, you
+ # call the Decrypt operation on the encrypted copy of the key.
+ #
+ # It's also useful in distributed systems with different levels of
+ # trust. For example, you might store encrypted data in containers. One
+ # component of your system creates new containers and stores an
+ # encrypted data key with each container. Then, a different component
+ # puts the data into the containers. That component first decrypts the
+ # data key, uses the plaintext data key to encrypt data, puts the
+ # encrypted data into the container, and then destroys the plaintext
+ # data key. In this system, the component that creates the containers
+ # never sees the plaintext data key.
+ #
+ # To request an asymmetric data key pair, use the GenerateDataKeyPair or
+ # GenerateDataKeyPairWithoutPlaintext operations.
+ #
+ # To generate a data key, you must specify the symmetric encryption KMS
+ # key that is used to encrypt the data key. You cannot use an asymmetric
+ # KMS key or a key in a custom key store to generate a data key. To get
+ # the type of your KMS key, use the DescribeKey operation.
+ #
+ # You must also specify the length of the data key. Use either the
+ # `KeySpec` or `NumberOfBytes` parameters (but not both). For 128-bit
+ # and 256-bit data keys, use the `KeySpec` parameter.
+ #
+ # To generate an SM4 data key (China Regions only), specify a `KeySpec`
+ # value of `AES_128` or `NumberOfBytes` value of `16`. The symmetric
+ # encryption key used in China Regions to encrypt your data key is an
+ # SM4 encryption key.
+ #
+ # If the operation succeeds, you will find the encrypted copy of the
+ # data key in the `CiphertextBlob` field.
+ #
+ # You can use an optional encryption context to add additional security
+ # to the encryption operation. If you specify an `EncryptionContext`,
+ # you must specify the same encryption context (a case-sensitive exact
+ # match) when decrypting the encrypted data key. Otherwise, the request
+ # to decrypt fails with an `InvalidCiphertextException`. For more
+ # information, see [Encryption Context][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GenerateDataKeyWithoutPlaintext][3]
+ # (key policy)
+ #
+ # **Related operations:**
+ #
+ # * Decrypt
+ #
+ # * Encrypt
+ #
+ # * GenerateDataKey
+ #
+ # * GenerateDataKeyPair
+ #
+ # * GenerateDataKeyPairWithoutPlaintext
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Specifies the symmetric encryption KMS key that encrypts the data key.
+ # You cannot specify an asymmetric KMS key or a KMS key in a custom key
+ # store. To get the type and origin of your KMS key, use the DescribeKey
+ # operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [Hash<String,String>] :encryption_context
+ # Specifies the encryption context that will be used when encrypting the
+ # data key.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [String] :key_spec
+ # The length of the data key. Use `AES_128` to generate a 128-bit
+ # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
+ #
+ # @option params [Integer] :number_of_bytes
+ # The length of the data key in bytes. For example, use the value 64 to
+ # generate a 512-bit data key (64 bytes is 512 bits). For common key
+ # lengths (128-bit and 256-bit symmetric keys), we recommend that you
+ # use the `KeySpec` field instead of this one.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::GenerateDataKeyWithoutPlaintextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateDataKeyWithoutPlaintextResponse#ciphertext_blob #ciphertext_blob} => String
+ # * {Types::GenerateDataKeyWithoutPlaintextResponse#key_id #key_id} => String
+ #
+ #
+ # @example Example: To generate an encrypted data key
+ #
+ # # The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is
+ # # encrypted with the specified KMS key.
+ #
+ # resp = client.generate_data_key_without_plaintext({
+ # key_id: "alias/ExampleAlias", # The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
+ # key_spec: "AES_256", # Specifies the type of data key to return.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The encrypted data key.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that was used to encrypt the data key.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_data_key_without_plaintext({
+ # key_id: "KeyIdType", # required
+ # encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # key_spec: "AES_256", # accepts AES_256, AES_128
+ # number_of_bytes: 1,
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.ciphertext_blob #=> String
+ # resp.key_id #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext AWS API Documentation
+ #
+ # @overload generate_data_key_without_plaintext(params = {})
+ # @param [Hash] params ({})
+ def generate_data_key_without_plaintext(params = {}, options = {})
+ req = build_request(:generate_data_key_without_plaintext, params)
+ req.send_request(options)
+ end
+
+ # Generates a hash-based message authentication code (HMAC) for a
+ # message using an HMAC KMS key and a MAC algorithm that the key
+ # supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform
+ # to industry standards defined in [RFC 2104][1].
+ #
+ # You can use value that GenerateMac returns in the VerifyMac operation
+ # to demonstrate that the original message has not changed. Also,
+ # because a secret key is used to create the hash, you can verify that
+ # the party that generated the hash has the required secret key. You can
+ # also use the raw result to implement HMAC-based algorithms such as key
+ # derivation functions. This operation is part of KMS support for HMAC
+ # KMS keys. For details, see [HMAC keys in KMS][2] in the <i> <i>Key
+ # Management Service Developer Guide</i> </i>.
+ #
+ # <note markdown="1"> Best practices recommend that you limit the time during which any
+ # signing mechanism, including an HMAC, is effective. This deters an
+ # attack where the actor uses a signed message to establish validity
+ # repeatedly or long after the message is superseded. HMAC tags do not
+ # include a timestamp, but you can include a timestamp in the token or
+ # message to help you detect when its time to refresh the HMAC.
+ #
+ # </note>
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][3] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GenerateMac][4] (key policy)
+ #
+ # **Related operations**: VerifyMac
+ #
+ #
+ #
+ # [1]: https://datatracker.ietf.org/doc/html/rfc2104
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String, StringIO, File] :message
+ # The message to be hashed. Specify a message of up to 4,096 bytes.
+ #
+ # `GenerateMac` and VerifyMac do not provide special handling for
+ # message digests. If you generate an HMAC for a hash digest of a
+ # message, you must verify the HMAC of the same hash digest.
+ #
+ # @option params [required, String] :key_id
+ # The HMAC KMS key to use in the operation. The MAC algorithm computes
+ # the HMAC for the message and the key as described in [RFC 2104][1].
+ #
+ # To identify an HMAC KMS key, use the DescribeKey operation and see the
+ # `KeySpec` field in the response.
+ #
+ #
+ #
+ # [1]: https://datatracker.ietf.org/doc/html/rfc2104
+ #
+ # @option params [required, String] :mac_algorithm
+ # The MAC algorithm used in the operation.
+ #
+ # The algorithm must be compatible with the HMAC KMS key that you
+ # specify. To find the MAC algorithms that your HMAC KMS key supports,
+ # use the DescribeKey operation and see the `MacAlgorithms` field in the
+ # `DescribeKey` response.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::GenerateMacResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateMacResponse#mac #mac} => String
+ # * {Types::GenerateMacResponse#mac_algorithm #mac_algorithm} => String
+ # * {Types::GenerateMacResponse#key_id #key_id} => String
+ #
+ #
+ # @example Example: To generate an HMAC for a message
+ #
+ # # This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by
+ # # the specified HMAC KMS key.
+ #
+ # resp = client.generate_mac({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The HMAC KMS key input to the HMAC algorithm.
+ # mac_algorithm: "HMAC_SHA_384", # The HMAC algorithm requested for the operation.
+ # message: "Hello World", # The message input to the HMAC algorithm.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the HMAC KMS key used in the operation.
+ # mac: "<HMAC_TAG>", # The HMAC tag that results from this operation.
+ # mac_algorithm: "HMAC_SHA_384", # The HMAC algorithm used in the operation.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_mac({
+ # message: "data", # required
+ # key_id: "KeyIdType", # required
+ # mac_algorithm: "HMAC_SHA_224", # required, accepts HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.mac #=> String
+ # resp.mac_algorithm #=> String, one of "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512"
+ # resp.key_id #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMac AWS API Documentation
+ #
+ # @overload generate_mac(params = {})
+ # @param [Hash] params ({})
+ def generate_mac(params = {}, options = {})
+ req = build_request(:generate_mac, params)
+ req.send_request(options)
+ end
+
+ # Returns a random byte string that is cryptographically secure.
+ #
+ # You must use the `NumberOfBytes` parameter to specify the length of
+ # the random byte string. There is no default value for string length.
+ #
+ # By default, the random byte string is generated in KMS. To generate
+ # the byte string in the CloudHSM cluster associated with an CloudHSM
+ # key store, use the `CustomKeyStoreId` parameter.
+ #
+ # `GenerateRandom` also supports [Amazon Web Services Nitro
+ # Enclaves][1], which provide an isolated compute environment in Amazon
+ # EC2. To call `GenerateRandom` for a Nitro enclave, use the [Amazon Web
+ # Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK. Use
+ # the `Recipient` parameter to provide the attestation document for the
+ # enclave. Instead of plaintext bytes, the response includes the
+ # plaintext bytes encrypted under the public key from the attestation
+ # document (`CiphertextForRecipient`).For information about the
+ # interaction between KMS and Amazon Web Services Nitro Enclaves, see
+ # [How Amazon Web Services Nitro Enclaves uses KMS][3] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # For more information about entropy and random number generation, see
+ # [Key Management Service Cryptographic Details][4].
+ #
+ # **Cross-account use**: Not applicable. `GenerateRandom` does not use
+ # any account-specific resources, such as KMS keys.
+ #
+ # **Required permissions**: [kms:GenerateRandom][5] (IAM policy)
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/cryptographic-details/
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Integer] :number_of_bytes
+ # The length of the random byte string. This parameter is required.
+ #
+ # @option params [String] :custom_key_store_id
+ # Generates the random byte string in the CloudHSM cluster that is
+ # associated with the specified CloudHSM key store. To find the ID of a
+ # custom key store, use the DescribeCustomKeyStores operation.
+ #
+ # External key store IDs are not valid for this parameter. If you
+ # specify the ID of an external key store, `GenerateRandom` throws an
+ # `UnsupportedOperationException`.
+ #
+ # @option params [Types::RecipientInfo] :recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's public
+ # key. The only valid encryption algorithm is `RSAES_OAEP_SHA_256`.
+ #
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
+ #
+ # When you use this parameter, instead of returning plaintext bytes, KMS
+ # encrypts the plaintext bytes under the public key in the attestation
+ # document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can be
+ # decrypted only with the private key in the enclave. The `Plaintext`
+ # field in the response is null or empty.
+ #
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ #
+ # @return [Types::GenerateRandomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GenerateRandomResponse#plaintext #plaintext} => String
+ # * {Types::GenerateRandomResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String
+ #
+ #
+ # @example Example: To generate random data
+ #
+ # # The following example generates 32 bytes of random data.
+ #
+ # resp = client.generate_random({
+ # number_of_bytes: 32, # The length of the random data, specified in number of bytes.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # plaintext: "<binary data>", # The random data.
+ # }
+ #
+ # @example Example: To generate random data
+ #
+ # # The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave.
+ # # Instead of returning a plaintext (unencrypted) byte string, GenerateRandom returns the byte string encrypted by the
+ # # public key from the enclave's attestation document.
+ #
+ # resp = client.generate_random({
+ # number_of_bytes: 1024, # The length of the random byte string
+ # recipient: {
+ # attestation_document: "<attestation document>",
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256",
+ # }, # Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_for_recipient: "<binary data>", # The random data encrypted under the public key from the attestation document
+ # plaintext: "", # This field is null or empty
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.generate_random({
+ # number_of_bytes: 1,
+ # custom_key_store_id: "CustomKeyStoreIdType",
+ # recipient: {
+ # key_encryption_algorithm: "RSAES_OAEP_SHA_256", # accepts RSAES_OAEP_SHA_256
+ # attestation_document: "data",
+ # },
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.plaintext #=> String
+ # resp.ciphertext_for_recipient #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom AWS API Documentation
+ #
+ # @overload generate_random(params = {})
+ # @param [Hash] params ({})
+ def generate_random(params = {}, options = {})
+ req = build_request(:generate_random, params)
+ req.send_request(options)
+ end
+
+ # Gets a key policy attached to the specified KMS key.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:GetKeyPolicy][1] (key policy)
+ #
+ # **Related operations**: PutKeyPolicy
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Gets the key policy for the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, String] :policy_name
+ # Specifies the name of the key policy. The only valid name is
+ # `default`. To get the names of key policies, use ListKeyPolicies.
+ #
+ # @return [Types::GetKeyPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetKeyPolicyResponse#policy #policy} => String
+ #
+ #
+ # @example Example: To retrieve a key policy
+ #
+ # # The following example retrieves the key policy for the specified KMS key.
+ #
+ # resp = client.get_key_policy({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # policy_name: "default", # The name of the key policy to retrieve.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # policy: "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",\n \"Statement\" : [ {\n \"Sid\" : \"Enable IAM User Permissions\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::111122223333:root\"\n },\n \"Action\" : \"kms:*\",\n \"Resource\" : \"*\"\n } ]\n}", # The key policy document.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_key_policy({
+ # key_id: "KeyIdType", # required
+ # policy_name: "PolicyNameType", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.policy #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy AWS API Documentation
+ #
+ # @overload get_key_policy(params = {})
+ # @param [Hash] params ({})
+ def get_key_policy(params = {}, options = {})
+ req = build_request(:get_key_policy, params)
+ req.send_request(options)
+ end
+
+ # Gets a Boolean value that indicates whether [automatic rotation of the
+ # key material][1] is enabled for the specified KMS key.
+ #
+ # When you enable automatic rotation for [customer managed KMS keys][2],
+ # KMS rotates the key material of the KMS key one year (approximately
+ # 365 days) from the enable date and every year thereafter. You can
+ # monitor rotation of the key material for your KMS keys in CloudTrail
+ # and Amazon CloudWatch.
+ #
+ # Automatic key rotation is supported only on [symmetric encryption KMS
+ # keys][3]. You cannot enable automatic rotation of [asymmetric KMS
+ # keys][4], [HMAC KMS keys][5], KMS keys with [imported key
+ # material][6], or KMS keys in a [custom key store][7]. To enable or
+ # disable automatic rotation of a set of related [multi-Region keys][8],
+ # set the property on the primary key..
+ #
+ # You can enable (EnableKeyRotation) and disable automatic rotation
+ # (DisableKeyRotation) of the key material in customer managed KMS keys.
+ # Key material rotation of [Amazon Web Services managed KMS keys][9] is
+ # not configurable. KMS always rotates the key material in Amazon Web
+ # Services managed KMS keys every year. The key rotation status for
+ # Amazon Web Services managed KMS keys is always `true`.
+ #
+ # <note markdown="1"> In May 2022, KMS changed the rotation schedule for Amazon Web Services
+ # managed keys from every three years to every year. For details, see
+ # EnableKeyRotation.
+ #
+ # </note>
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][10] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # * Disabled: The key rotation status does not change when you disable a
+ # KMS key. However, while the KMS key is disabled, KMS does not rotate
+ # the key material. When you re-enable the KMS key, rotation resumes.
+ # If the key material in the re-enabled KMS key hasn't been rotated
+ # in one year, KMS rotates it immediately, and every year thereafter.
+ # If it's been less than a year since the key material in the
+ # re-enabled KMS key was rotated, the KMS key resumes its prior
+ # rotation schedule.
+ #
+ # * Pending deletion: While a KMS key is pending deletion, its key
+ # rotation status is `false` and KMS does not rotate the key material.
+ # If you cancel the deletion, the original key rotation status returns
+ # to `true`.
+ #
+ # **Cross-account use**: Yes. To perform this operation on a KMS key in
+ # a different Amazon Web Services account, specify the key ARN in the
+ # value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GetKeyRotationStatus][11] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * DisableKeyRotation
+ #
+ # * EnableKeyRotation
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Gets the rotation status for the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key in
+ # a different Amazon Web Services account, you must use the key ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @return [Types::GetKeyRotationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetKeyRotationStatusResponse#key_rotation_enabled #key_rotation_enabled} => Boolean
+ #
+ #
+ # @example Example: To retrieve the rotation status for a KMS key
+ #
+ # # The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.
+ #
+ # resp = client.get_key_rotation_status({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_rotation_enabled: true, # A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_key_rotation_status({
+ # key_id: "KeyIdType", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.key_rotation_enabled #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus AWS API Documentation
+ #
+ # @overload get_key_rotation_status(params = {})
+ # @param [Hash] params ({})
+ def get_key_rotation_status(params = {}, options = {})
+ req = build_request(:get_key_rotation_status, params)
+ req.send_request(options)
+ end
+
+ # Returns the public key and an import token you need to import or
+ # reimport key material for a KMS key.
+ #
+ # By default, KMS keys are created with key material that KMS generates.
+ # This operation supports [Importing key material][1], an advanced
+ # feature that lets you generate and import the cryptographic key
+ # material for a KMS key. For more information about importing key
+ # material into KMS, see [Importing key material][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # Before calling `GetParametersForImport`, use the CreateKey operation
+ # with an `Origin` value of `EXTERNAL` to create a KMS key with no key
+ # material. You can import key material for a symmetric encryption KMS
+ # key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric
+ # signing KMS key. You can also import key material into a [multi-Region
+ # key](kms/latest/developerguide/multi-region-keys-overview.html) of any
+ # supported type. However, you can't import key material into a KMS key
+ # in a [custom key
+ # store](kms/latest/developerguide/custom-key-store-overview.html). You
+ # can also use `GetParametersForImport` to get a public key and import
+ # token to [reimport the original key
+ # material](kms/latest/developerguide/importing-keys.html#reimport-key-material)
+ # into a KMS key whose key material expired or was deleted.
+ #
+ # `GetParametersForImport` returns the items that you need to import
+ # your key material.
+ #
+ # * The public key (or "wrapping key") of an RSA key pair that KMS
+ # generates.
+ #
+ # You will use this public key to encrypt ("wrap") your key material
+ # while it's in transit to KMS.
+ #
+ # * A import token that ensures that KMS can decrypt your key material
+ # and associate it with the correct KMS key.
+ #
+ # The public key and its import token are permanently linked and must be
+ # used together. Each public key and import token set is valid for 24
+ # hours. The expiration date and time appear in the `ParametersValidTo`
+ # field in the `GetParametersForImport` response. You cannot use an
+ # expired public key or import token in an ImportKeyMaterial request. If
+ # your key and token expire, send another `GetParametersForImport`
+ # request.
+ #
+ # `GetParametersForImport` requires the following information:
+ #
+ # * The key ID of the KMS key for which you are importing the key
+ # material.
+ #
+ # * The key spec of the public key ("wrapping key") that you will use
+ # to encrypt your key material during import.
+ #
+ # * The wrapping algorithm that you will use with the public key to
+ # encrypt your key material.
+ #
+ # You can use the same or a different public key spec and wrapping
+ # algorithm each time you import or reimport the same key material.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:GetParametersForImport][3] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * ImportKeyMaterial
+ #
+ # * DeleteImportedKeyMaterial
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # The identifier of the KMS key that will be associated with the
+ # imported key material. The `Origin` of the KMS key must be `EXTERNAL`.
+ #
+ # All KMS key types are supported, including multi-Region keys. However,
+ # you cannot import key material into a KMS key in a custom key store.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, String] :wrapping_algorithm
+ # The algorithm you will use with the RSA public key (`PublicKey`) in
+ # the response to protect your key material during import. For more
+ # information, see [Select a wrapping
+ # algorithm](kms/latest/developerguide/importing-keys-get-public-key-and-token.html#select-wrapping-algorithm)
+ # in the *Key Management Service Developer Guide*.
+ #
+ # For RSA\_AES wrapping algorithms, you encrypt your key material with
+ # an AES key that you generate, then encrypt your AES key with the RSA
+ # public key from KMS. For RSAES wrapping algorithms, you encrypt your
+ # key material directly with the RSA public key from KMS.
+ #
+ # The wrapping algorithms that you can use depend on the type of key
+ # material that you are importing. To import an RSA private key, you
+ # must use an RSA\_AES wrapping algorithm.
+ #
+ # * **RSA\_AES\_KEY\_WRAP\_SHA\_256** — Supported for wrapping RSA and
+ # ECC key material.
+ #
+ # * **RSA\_AES\_KEY\_WRAP\_SHA\_1** — Supported for wrapping RSA and ECC
+ # key material.
+ #
+ # * **RSAES\_OAEP\_SHA\_256** — Supported for all types of key material,
+ # except RSA key material (private key).
+ #
+ # You cannot use the RSAES\_OAEP\_SHA\_256 wrapping algorithm with the
+ # RSA\_2048 wrapping key spec to wrap ECC\_NIST\_P521 key material.
+ #
+ # * **RSAES\_OAEP\_SHA\_1** — Supported for all types of key material,
+ # except RSA key material (private key).
+ #
+ # You cannot use the RSAES\_OAEP\_SHA\_1 wrapping algorithm with the
+ # RSA\_2048 wrapping key spec to wrap ECC\_NIST\_P521 key material.
+ #
+ # * **RSAES\_PKCS1\_V1\_5** (Deprecated) — Supported only for symmetric
+ # encryption key material (and only in legacy mode).
+ #
+ # @option params [required, String] :wrapping_key_spec
+ # The type of RSA public key to return in the response. You will use
+ # this wrapping key with the specified wrapping algorithm to protect
+ # your key material during import.
+ #
+ # Use the longest RSA wrapping key that is practical.
+ #
+ # You cannot use an RSA\_2048 public key to directly wrap an
+ # ECC\_NIST\_P521 private key. Instead, use an RSA\_AES wrapping
+ # algorithm or choose a longer RSA public key.
+ #
+ # @return [Types::GetParametersForImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetParametersForImportResponse#key_id #key_id} => String
+ # * {Types::GetParametersForImportResponse#import_token #import_token} => String
+ # * {Types::GetParametersForImportResponse#public_key #public_key} => String
+ # * {Types::GetParametersForImportResponse#parameters_valid_to #parameters_valid_to} => Time
+ #
+ #
+ # @example Example: To download the public key and import token for a symmetric encryption KMS key
+ #
+ # # The following example downloads a public key and import token to import symmetric encryption key material. It uses the
+ # # default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.
+ #
+ # resp = client.get_parameters_for_import({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # wrapping_algorithm: "RSAES_OAEP_SHA_1", # The algorithm that you will use to encrypt the key material before importing it.
+ # wrapping_key_spec: "RSA_2048", # The type of wrapping key (public key) to return in the response.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that will be associated with the imported key material.
+ # parameters_valid_to: Time.parse("2023-02-01T14:52:17-08:00"), # The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
+ # public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
+ # }
+ #
+ # @example Example: To download the public key and import token for an RSA asymmetric KMS key
+ #
+ # # The following example downloads a public key and import token to import an RSA private key. It uses a required RSA_AES
+ # # wrapping algorithm and the largest supported private key.
+ #
+ # resp = client.get_parameters_for_import({
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # wrapping_algorithm: "RSA_AES_KEY_WRAP_SHA_256", # The algorithm that you will use to encrypt the key material before importing it.
+ # wrapping_key_spec: "RSA_4096", # The type of wrapping key (public key) to return in the response.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that will be associated with the imported key material.
+ # parameters_valid_to: Time.parse("2023-03-08T13:02:02-07:00"), # The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
+ # public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
+ # }
+ #
+ # @example Example: To download the public key and import token for an elliptic curve (ECC) asymmetric KMS key
+ #
+ # # The following example downloads a public key and import token to import an ECC_NIST_P521 (secp521r1) private key. You
+ # # cannot directly wrap this ECC key under an RSA_2048 public key, although you can use an RSA_2048 public key with an
+ # # RSA_AES wrapping algorithm to wrap any supported key material. This example requests an RSA_3072 public key for use with
+ # # the RSAES_OAEP_SHA_256.
+ #
+ # resp = client.get_parameters_for_import({
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # wrapping_algorithm: "RSAES_OAEP_SHA_256", # The algorithm that you will use to encrypt the key material before importing it.
+ # wrapping_key_spec: "RSA_3072", # The type of wrapping key (public key) to return in the response.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that will be associated with the imported key material.
+ # parameters_valid_to: Time.parse("2023-09-12T03:15:01-20:00"), # The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
+ # public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
+ # }
+ #
+ # @example Example: To download the public key and import token for an HMAC KMS key
+ #
+ # # The following example downloads a public key and import token to import an HMAC key. It uses the RSAES_OAEP_SHA_256
+ # # wrapping algorithm and an RSA_4096 private key.
+ #
+ # resp = client.get_parameters_for_import({
+ # key_id: "2468abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # wrapping_algorithm: "RSAES_OAEP_SHA_256", # The algorithm that you will use to encrypt the key material before importing it.
+ # wrapping_key_spec: "RSA_4096", # The type of wrapping key (public key) to return in the response.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/2468abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that will be associated with the imported key material.
+ # parameters_valid_to: Time.parse("2023-04-02T13:02:02-07:00"), # The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
+ # public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_parameters_for_import({
+ # key_id: "KeyIdType", # required
+ # wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, RSA_AES_KEY_WRAP_SHA_1, RSA_AES_KEY_WRAP_SHA_256
+ # wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.key_id #=> String
+ # resp.import_token #=> String
+ # resp.public_key #=> String
+ # resp.parameters_valid_to #=> Time
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport AWS API Documentation
+ #
+ # @overload get_parameters_for_import(params = {})
+ # @param [Hash] params ({})
+ def get_parameters_for_import(params = {}, options = {})
+ req = build_request(:get_parameters_for_import, params)
+ req.send_request(options)
+ end
+
+ # Returns the public key of an asymmetric KMS key. Unlike the private
+ # key of a asymmetric KMS key, which never leaves KMS unencrypted,
+ # callers with `kms:GetPublicKey` permission can download the public key
+ # of an asymmetric KMS key. You can share the public key to allow others
+ # to encrypt messages and verify signatures outside of KMS. For
+ # information about asymmetric KMS keys, see [Asymmetric KMS keys][1] in
+ # the *Key Management Service Developer Guide*.
+ #
+ # You do not need to download the public key. Instead, you can use the
+ # public key within KMS by calling the Encrypt, ReEncrypt, or Verify
+ # operations with the identifier of an asymmetric KMS key. When you use
+ # the public key within KMS, you benefit from the authentication,
+ # authorization, and logging that are part of every KMS operation. You
+ # also reduce of risk of encrypting data that cannot be decrypted. These
+ # features are not effective outside of KMS.
+ #
+ # To help you use the public key safely outside of KMS, `GetPublicKey`
+ # returns important information about the public key in the response,
+ # including:
+ #
+ # * [KeySpec][2]: The type of key material in the public key, such as
+ # `RSA_4096` or `ECC_NIST_P521`.
+ #
+ # * [KeyUsage][3]: Whether the key is used for encryption or signing.
+ #
+ # * [EncryptionAlgorithms][4] or [SigningAlgorithms][5]: A list of the
+ # encryption algorithms or the signing algorithms for the key.
+ #
+ # Although KMS cannot enforce these restrictions on external operations,
+ # it is crucial that you use this information to prevent the public key
+ # from being used improperly. For example, you can prevent a public
+ # signing key from being used encrypt data, or prevent a public key from
+ # being used with an encryption algorithm that is not supported by KMS.
+ # You can also avoid errors, such as using the wrong signing algorithm
+ # in a verification operation.
+ #
+ # To verify a signature outside of KMS with an SM2 public key (China
+ # Regions only), you must specify the distinguishing ID. By default, KMS
+ # uses `1234567812345678` as the distinguishing ID. For more
+ # information, see [Offline verification with SM2 key pairs][6].
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][7] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:GetPublicKey][8] (key policy)
+ #
+ # **Related operations**: CreateKey
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec
+ # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage
+ # [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms
+ # [5]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Identifies the asymmetric KMS key that includes the public key.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @return [Types::GetPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetPublicKeyResponse#key_id #key_id} => String
+ # * {Types::GetPublicKeyResponse#public_key #public_key} => String
+ # * {Types::GetPublicKeyResponse#customer_master_key_spec #customer_master_key_spec} => String
+ # * {Types::GetPublicKeyResponse#key_spec #key_spec} => String
+ # * {Types::GetPublicKeyResponse#key_usage #key_usage} => String
+ # * {Types::GetPublicKeyResponse#encryption_algorithms #encryption_algorithms} => Array<String>
+ # * {Types::GetPublicKeyResponse#signing_algorithms #signing_algorithms} => Array<String>
+ #
+ #
+ # @example Example: To download the public key of an asymmetric KMS key
+ #
+ # # This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns
+ # # the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS
+ # # KMS.
+ #
+ # resp = client.get_public_key({
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The key ARN of the asymmetric KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # customer_master_key_spec: "RSA_4096", # The key spec of the asymmetric KMS key from which the public key was downloaded.
+ # encryption_algorithms: [
+ # "RSAES_OAEP_SHA_1",
+ # "RSAES_OAEP_SHA_256",
+ # ], # The encryption algorithms supported by the asymmetric KMS key that was downloaded.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The key ARN of the asymmetric KMS key from which the public key was downloaded.
+ # key_usage: "ENCRYPT_DECRYPT", # The key usage of the asymmetric KMS key from which the public key was downloaded.
+ # public_key: "<binary data>", # The public key (plaintext) of the asymmetric KMS key.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_public_key({
+ # key_id: "KeyIdType", # required
+ # grant_tokens: ["GrantTokenType"],
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.key_id #=> String
+ # resp.public_key #=> String
+ # resp.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC"
+ # resp.encryption_algorithms #=> Array
+ # resp.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.signing_algorithms #=> Array
+ # resp.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKey AWS API Documentation
+ #
+ # @overload get_public_key(params = {})
+ # @param [Hash] params ({})
+ def get_public_key(params = {}, options = {})
+ req = build_request(:get_public_key, params)
+ req.send_request(options)
+ end
+
+ # Imports or reimports key material into an existing KMS key that was
+ # created without key material. `ImportKeyMaterial` also sets the
+ # expiration model and expiration date of the imported key material.
+ #
+ # By default, KMS keys are created with key material that KMS generates.
+ # This operation supports [Importing key material][1], an advanced
+ # feature that lets you generate and import the cryptographic key
+ # material for a KMS key. For more information about importing key
+ # material into KMS, see [Importing key material][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # After you successfully import key material into a KMS key, you can
+ # [reimport the same key material][2] into that KMS key, but you cannot
+ # import different key material. You might reimport key material to
+ # replace key material that expired or key material that you deleted.
+ # You might also reimport key material to change the expiration model or
+ # expiration date of the key material. Before reimporting key material,
+ # if necessary, call DeleteImportedKeyMaterial to delete the current
+ # imported key material.
+ #
+ # Each time you import key material into KMS, you can determine whether
+ # (`ExpirationModel`) and when (`ValidTo`) the key material expires. To
+ # change the expiration of your key material, you must import it again,
+ # either by calling `ImportKeyMaterial` or using the [import
+ # features](kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-import-key-material-console)
+ # of the KMS console.
+ #
+ # Before calling `ImportKeyMaterial`:
+ #
+ # * Create or identify a KMS key with no key material. The KMS key must
+ # have an `Origin` value of `EXTERNAL`, which indicates that the KMS
+ # key is designed for imported key material.
+ #
+ # To create an new KMS key for imported key material, call the
+ # CreateKey operation with an `Origin` value of `EXTERNAL`. You can
+ # create a symmetric encryption KMS key, HMAC KMS key, asymmetric
+ # encryption KMS key, or asymmetric signing KMS key. You can also
+ # import key material into a [multi-Region
+ # key](kms/latest/developerguide/multi-region-keys-overview.html) of
+ # any supported type. However, you can't import key material into a
+ # KMS key in a [custom key
+ # store](kms/latest/developerguide/custom-key-store-overview.html).
+ #
+ # * Use the DescribeKey operation to verify that the `KeyState` of the
+ # KMS key is `PendingImport`, which indicates that the KMS key has no
+ # key material.
+ #
+ # If you are reimporting the same key material into an existing KMS
+ # key, you might need to call the DeleteImportedKeyMaterial to delete
+ # its existing key material.
+ #
+ # * Call the GetParametersForImport operation to get a public key and
+ # import token set for importing key material.
+ #
+ # * Use the public key in the GetParametersForImport response to encrypt
+ # your key material.
+ #
+ # Then, in an `ImportKeyMaterial` request, you submit your encrypted key
+ # material and import token. When calling this operation, you must
+ # specify the following values:
+ #
+ # * The key ID or key ARN of the KMS key to associate with the imported
+ # key material. Its `Origin` must be `EXTERNAL` and its `KeyState`
+ # must be `PendingImport`. You cannot perform this operation on a KMS
+ # key in a [custom key
+ # store](kms/latest/developerguide/custom-key-store-overview.html), or
+ # on a KMS key in a different Amazon Web Services account. To get the
+ # `Origin` and `KeyState` of a KMS key, call DescribeKey.
+ #
+ # * The encrypted key material.
+ #
+ # * The import token that GetParametersForImport returned. You must use
+ # a public key and token from the same `GetParametersForImport`
+ # response.
+ #
+ # * Whether the key material expires (`ExpirationModel`) and, if so,
+ # when (`ValidTo`). For help with this choice, see [Setting an
+ # expiration time][3] in the *Key Management Service Developer Guide*.
+ #
+ # If you set an expiration date, KMS deletes the key material from the
+ # KMS key on the specified date, making the KMS key unusable. To use
+ # the KMS key in cryptographic operations again, you must reimport the
+ # same key material. However, you can delete and reimport the key
+ # material at any time, including before the key material expires.
+ # Each time you reimport, you can eliminate or reset the expiration
+ # time.
+ #
+ # When this operation is successful, the key state of the KMS key
+ # changes from `PendingImport` to `Enabled`, and you can use the KMS key
+ # in cryptographic operations.
+ #
+ # If this operation fails, use the exception to help determine the
+ # problem. If the error is related to the key material, the import
+ # token, or wrapping key, use GetParametersForImport to get a new public
+ # key and import token for the KMS key and repeat the import procedure.
+ # For help, see [How To Import Key Material][4] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][5] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:ImportKeyMaterial][6] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * DeleteImportedKeyMaterial
+ #
+ # * GetParametersForImport
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material
+ # [3]: https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # The identifier of the KMS key that will be associated with the
+ # imported key material. This must be the same KMS key specified in the
+ # `KeyID` parameter of the corresponding GetParametersForImport request.
+ # The `Origin` of the KMS key must be `EXTERNAL` and its `KeyState` must
+ # be `PendingImport`.
+ #
+ # The KMS key can be a symmetric encryption KMS key, HMAC KMS key,
+ # asymmetric encryption KMS key, or asymmetric signing KMS key,
+ # including a [multi-Region
+ # key](kms/latest/developerguide/multi-region-keys-overview.html) of any
+ # supported type. You cannot perform this operation on a KMS key in a
+ # custom key store, or on a KMS key in a different Amazon Web Services
+ # account.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, String, StringIO, File] :import_token
+ # The import token that you received in the response to a previous
+ # GetParametersForImport request. It must be from the same response that
+ # contained the public key that you used to encrypt the key material.
+ #
+ # @option params [required, String, StringIO, File] :encrypted_key_material
+ # The encrypted key material to import. The key material must be
+ # encrypted under the public wrapping key that GetParametersForImport
+ # returned, using the wrapping algorithm that you specified in the same
+ # `GetParametersForImport` request.
+ #
+ # @option params [Time,DateTime,Date,Integer,String] :valid_to
+ # The date and time when the imported key material expires. This
+ # parameter is required when the value of the `ExpirationModel`
+ # parameter is `KEY_MATERIAL_EXPIRES`. Otherwise it is not valid.
+ #
+ # The value of this parameter must be a future date and time. The
+ # maximum value is 365 days from the request date.
+ #
+ # When the key material expires, KMS deletes the key material from the
+ # KMS key. Without its key material, the KMS key is unusable. To use the
+ # KMS key in cryptographic operations, you must reimport the same key
+ # material.
+ #
+ # You cannot change the `ExpirationModel` or `ValidTo` values for the
+ # current import after the request completes. To change either value,
+ # you must delete (DeleteImportedKeyMaterial) and reimport the key
+ # material.
+ #
+ # @option params [String] :expiration_model
+ # Specifies whether the key material expires. The default is
+ # `KEY_MATERIAL_EXPIRES`. For help with this choice, see [Setting an
+ # expiration time][1] in the *Key Management Service Developer Guide*.
+ #
+ # When the value of `ExpirationModel` is `KEY_MATERIAL_EXPIRES`, you
+ # must specify a value for the `ValidTo` parameter. When value is
+ # `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo` parameter.
+ #
+ # You cannot change the `ExpirationModel` or `ValidTo` values for the
+ # current import after the request completes. To change either value,
+ # you must reimport the key material.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To import key material into a KMS key
+ #
+ # # The following example imports key material into the specified KMS key.
+ #
+ # resp = client.import_key_material({
+ # encrypted_key_material: "<binary data>", # The encrypted key material to import.
+ # expiration_model: "KEY_MATERIAL_DOES_NOT_EXPIRE", # A value that specifies whether the key material expires.
+ # import_token: "<binary data>", # The import token that you received in the response to a previous GetParametersForImport request.
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # @example Example: To import key material into a KMS key
+ #
+ # # The following example imports key material that expires in 3 days. It might be part of an application that frequently
+ # # reimports the same key material to comply with business rules or regulations.
+ #
+ # resp = client.import_key_material({
+ # encrypted_key_material: "<binary data>", # The encrypted key material to import.
+ # expiration_model: "KEY_MATERIAL_EXPIRES", # A value that specifies whether the key material expires.
+ # import_token: "<binary data>", # The import token that you received in the response to a previous GetParametersForImport request.
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # valid_to: Time.parse("2023-09-30T00:00:00-00:00"), # Specifies the date and time when the imported key material expires.
+ # })
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.import_key_material({
+ # key_id: "KeyIdType", # required
+ # import_token: "data", # required
+ # encrypted_key_material: "data", # required
+ # valid_to: Time.now,
+ # expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial AWS API Documentation
+ #
+ # @overload import_key_material(params = {})
+ # @param [Hash] params ({})
+ def import_key_material(params = {}, options = {})
+ req = build_request(:import_key_material, params)
+ req.send_request(options)
+ end
+
+ # Gets a list of aliases in the caller's Amazon Web Services account
+ # and region. For more information about aliases, see CreateAlias.
+ #
+ # By default, the `ListAliases` operation returns all aliases in the
+ # account and region. To get only the aliases associated with a
+ # particular KMS key, use the `KeyId` parameter.
+ #
+ # The `ListAliases` response can include aliases that you created and
+ # associated with your customer managed keys, and aliases that Amazon
+ # Web Services created and associated with Amazon Web Services managed
+ # keys in your account. You can recognize Amazon Web Services aliases
+ # because their names have the format `aws/<service-name>`, such as
+ # `aws/dynamodb`.
+ #
+ # The response might also include aliases that have no `TargetKeyId`
+ # field. These are predefined aliases that Amazon Web Services has
+ # created but has not yet associated with a KMS key. Aliases that Amazon
+ # Web Services creates in your account, including predefined aliases, do
+ # not count against your [KMS aliases quota][1].
+ #
+ # **Cross-account use**: No. `ListAliases` does not return aliases in
+ # other Amazon Web Services accounts.
+ #
+ # **Required permissions**: [kms:ListAliases][2] (IAM policy)
+ #
+ # For details, see [Controlling access to aliases][3] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Related operations:**
+ #
+ # * CreateAlias
+ #
+ # * DeleteAlias
+ #
+ # * UpdateAlias
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
+ #
+ # @option params [String] :key_id
+ # Lists only aliases that are associated with the specified KMS key.
+ # Enter a KMS key in your Amazon Web Services account.
+ #
+ # This parameter is optional. If you omit it, `ListAliases` returns all
+ # aliases in the account and Region.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to 50.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # @return [Types::ListAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListAliasesResponse#aliases #aliases} => Array<Types::AliasListEntry>
+ # * {Types::ListAliasesResponse#next_marker #next_marker} => String
+ # * {Types::ListAliasesResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list aliases
+ #
+ # # The following example lists aliases.
+ #
+ # resp = client.list_aliases({
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # aliases: [
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
+ # alias_name: "alias/aws/acm",
+ # target_key_id: "da03f6f7-d279-427a-9cae-de48d07e5b66",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
+ # alias_name: "alias/aws/ebs",
+ # target_key_id: "25a217e7-7170-4b8c-8bf6-045ea5f70e5b",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
+ # alias_name: "alias/aws/rds",
+ # target_key_id: "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
+ # alias_name: "alias/aws/redshift",
+ # target_key_id: "08f7a25a-69e2-4fb5-8f10-393db27326fa",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
+ # alias_name: "alias/aws/s3",
+ # target_key_id: "d2b0f1a3-580d-4f79-b836-bc983be8cfa5",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example1",
+ # alias_name: "alias/example1",
+ # target_key_id: "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example2",
+ # alias_name: "alias/example2",
+ # target_key_id: "f32fef59-2cc2-445b-8573-2d73328acbee",
+ # },
+ # {
+ # alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example3",
+ # alias_name: "alias/example3",
+ # target_key_id: "1374ef38-d34e-4d5f-b2c9-4e0daee38855",
+ # },
+ # ], # A list of aliases, including the key ID of the KMS key that each alias refers to.
+ # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_aliases({
+ # key_id: "KeyIdType",
+ # limit: 1,
+ # marker: "MarkerType",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.aliases #=> Array
+ # resp.aliases[0].alias_name #=> String
+ # resp.aliases[0].alias_arn #=> String
+ # resp.aliases[0].target_key_id #=> String
+ # resp.aliases[0].creation_date #=> Time
+ # resp.aliases[0].last_updated_date #=> Time
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases AWS API Documentation
+ #
+ # @overload list_aliases(params = {})
+ # @param [Hash] params ({})
+ def list_aliases(params = {}, options = {})
+ req = build_request(:list_aliases, params)
+ req.send_request(options)
+ end
+
+ # Gets a list of all grants for the specified KMS key.
+ #
+ # You must specify the KMS key in all requests. You can filter the grant
+ # list by grant ID or grantee principal.
+ #
+ # For detailed information about grants, including grant terminology,
+ # see [Grants in KMS][1] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>. For examples of working with grants in several
+ # programming languages, see [Programming grants][2].
+ #
+ # <note markdown="1"> The `GranteePrincipal` field in the `ListGrants` response usually
+ # contains the user or role designated as the grantee principal in the
+ # grant. However, when the grantee principal in the grant is an Amazon
+ # Web Services service, the `GranteePrincipal` field contains the
+ # [service principal][3], which might represent several different
+ # grantee principals.
+ #
+ # </note>
+ #
+ # **Cross-account use**: Yes. To perform this operation on a KMS key in
+ # a different Amazon Web Services account, specify the key ARN in the
+ # value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:ListGrants][4] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * CreateGrant
+ #
+ # * ListRetirableGrants
+ #
+ # * RetireGrant
+ #
+ # * RevokeGrant
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
+ # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to 50.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # @option params [required, String] :key_id
+ # Returns only grants for the specified KMS key. This parameter is
+ # required.
+ #
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key in
+ # a different Amazon Web Services account, you must use the key ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [String] :grant_id
+ # Returns only the grant with the specified grant ID. The grant ID
+ # uniquely identifies the grant.
+ #
+ # @option params [String] :grantee_principal
+ # Returns only grants where the specified principal is the grantee
+ # principal for the grant.
+ #
+ # @return [Types::ListGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListGrantsResponse#grants #grants} => Array<Types::GrantListEntry>
+ # * {Types::ListGrantsResponse#next_marker #next_marker} => String
+ # * {Types::ListGrantsResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list grants for a KMS key
+ #
+ # # The following example lists grants for the specified KMS key.
+ #
+ # resp = client.list_grants({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # grants: [
+ # {
+ # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
+ # grant_id: "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172",
+ # grantee_principal: "acm.us-east-2.amazonaws.com",
+ # issuing_account: "arn:aws:iam::111122223333:root",
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # operations: [
+ # "Encrypt",
+ # "ReEncryptFrom",
+ # "ReEncryptTo",
+ # ],
+ # retiring_principal: "acm.us-east-2.amazonaws.com",
+ # },
+ # {
+ # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
+ # grant_id: "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200",
+ # grantee_principal: "acm.us-east-2.amazonaws.com",
+ # issuing_account: "arn:aws:iam::111122223333:root",
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # operations: [
+ # "ReEncryptFrom",
+ # "ReEncryptTo",
+ # ],
+ # retiring_principal: "acm.us-east-2.amazonaws.com",
+ # },
+ # {
+ # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
+ # grant_id: "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f",
+ # grantee_principal: "acm.us-east-2.amazonaws.com",
+ # issuing_account: "arn:aws:iam::111122223333:root",
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # operations: [
+ # "Encrypt",
+ # "ReEncryptFrom",
+ # "ReEncryptTo",
+ # ],
+ # retiring_principal: "acm.us-east-2.amazonaws.com",
+ # },
+ # {
+ # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
+ # grant_id: "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c",
+ # grantee_principal: "acm.us-east-2.amazonaws.com",
+ # issuing_account: "arn:aws:iam::111122223333:root",
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # operations: [
+ # "Encrypt",
+ # "ReEncryptFrom",
+ # "ReEncryptTo",
+ # ],
+ # retiring_principal: "acm.us-east-2.amazonaws.com",
+ # },
+ # ], # A list of grants.
+ # truncated: true, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_grants({
+ # limit: 1,
+ # marker: "MarkerType",
+ # key_id: "KeyIdType", # required
+ # grant_id: "GrantIdType",
+ # grantee_principal: "PrincipalIdType",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.grants #=> Array
+ # resp.grants[0].key_id #=> String
+ # resp.grants[0].grant_id #=> String
+ # resp.grants[0].name #=> String
+ # resp.grants[0].creation_date #=> Time
+ # resp.grants[0].grantee_principal #=> String
+ # resp.grants[0].retiring_principal #=> String
+ # resp.grants[0].issuing_account #=> String
+ # resp.grants[0].operations #=> Array
+ # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac"
+ # resp.grants[0].constraints.encryption_context_subset #=> Hash
+ # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
+ # resp.grants[0].constraints.encryption_context_equals #=> Hash
+ # resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants AWS API Documentation
+ #
+ # @overload list_grants(params = {})
+ # @param [Hash] params ({})
+ def list_grants(params = {}, options = {})
+ req = build_request(:list_grants, params)
+ req.send_request(options)
+ end
+
+ # Gets the names of the key policies that are attached to a KMS key.
+ # This operation is designed to get policy names that you can use in a
+ # GetKeyPolicy operation. However, the only valid policy name is
+ # `default`.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:ListKeyPolicies][1] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * GetKeyPolicy
+ #
+ # * PutKeyPolicy
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Gets the names of key policies for the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 1000, inclusive. If you do not include a value, it defaults to
+ # 100.
+ #
+ # Only one policy can be attached to a key.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # @return [Types::ListKeyPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListKeyPoliciesResponse#policy_names #policy_names} => Array<String>
+ # * {Types::ListKeyPoliciesResponse#next_marker #next_marker} => String
+ # * {Types::ListKeyPoliciesResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list key policies for a KMS key
+ #
+ # # The following example lists key policies for the specified KMS key.
+ #
+ # resp = client.list_key_policies({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # policy_names: [
+ # "default",
+ # ], # A list of key policy names.
+ # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_key_policies({
+ # key_id: "KeyIdType", # required
+ # limit: 1,
+ # marker: "MarkerType",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.policy_names #=> Array
+ # resp.policy_names[0] #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies AWS API Documentation
+ #
+ # @overload list_key_policies(params = {})
+ # @param [Hash] params ({})
+ def list_key_policies(params = {}, options = {})
+ req = build_request(:list_key_policies, params)
+ req.send_request(options)
+ end
+
+ # Gets a list of all KMS keys in the caller's Amazon Web Services
+ # account and Region.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:ListKeys][1] (IAM policy)
+ #
+ # **Related operations:**
+ #
+ # * CreateKey
+ #
+ # * DescribeKey
+ #
+ # * ListAliases
+ #
+ # * ListResourceTags
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 1000, inclusive. If you do not include a value, it defaults to
+ # 100.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListKeysResponse#keys #keys} => Array<Types::KeyListEntry>
+ # * {Types::ListKeysResponse#next_marker #next_marker} => String
+ # * {Types::ListKeysResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list KMS keys
+ #
+ # # The following example lists KMS keys.
+ #
+ # resp = client.list_keys({
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # keys: [
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e",
+ # key_id: "0d990263-018e-4e65-a703-eff731de951e",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841",
+ # key_id: "144be297-0ae1-44ac-9c8f-93cd8c82f841",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571",
+ # key_id: "21184251-b765-428e-b852-2c7353e72571",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c",
+ # key_id: "214fe92f-5b03-4ae1-b350-db2a45dbe10c",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458",
+ # key_id: "339963f2-e523-49d3-af24-a0fe752aa458",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a",
+ # key_id: "b776a44b-df37-4438-9be4-a27494e4271a",
+ # },
+ # {
+ # key_arn: "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
+ # key_id: "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
+ # },
+ # ], # A list of KMS keys, including the key ID and Amazon Resource Name (ARN) of each one.
+ # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_keys({
+ # limit: 1,
+ # marker: "MarkerType",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.keys #=> Array
+ # resp.keys[0].key_id #=> String
+ # resp.keys[0].key_arn #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys AWS API Documentation
+ #
+ # @overload list_keys(params = {})
+ # @param [Hash] params ({})
+ def list_keys(params = {}, options = {})
+ req = build_request(:list_keys, params)
+ req.send_request(options)
+ end
+
+ # Returns all tags on the specified KMS key.
+ #
+ # For general information about tags, including the format and syntax,
+ # see [Tagging Amazon Web Services resources][1] in the *Amazon Web
+ # Services General Reference*. For information about using tags in KMS,
+ # see [Tagging keys][2].
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:ListResourceTags][3] (key policy)
+ #
+ # **Related operations:**
+ #
+ # * CreateKey
+ #
+ # * ReplicateKey
+ #
+ # * TagResource
+ #
+ # * UntagResource
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Gets tags on the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 50, inclusive. If you do not include a value, it defaults to 50.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # Do not attempt to construct this value. Use only the value of
+ # `NextMarker` from the truncated response you just received.
+ #
+ # @return [Types::ListResourceTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListResourceTagsResponse#tags #tags} => Array<Types::Tag>
+ # * {Types::ListResourceTagsResponse#next_marker #next_marker} => String
+ # * {Types::ListResourceTagsResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list tags for a KMS key
+ #
+ # # The following example lists tags for a KMS key.
+ #
+ # resp = client.list_resource_tags({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # tags: [
+ # {
+ # tag_key: "CostCenter",
+ # tag_value: "87654",
+ # },
+ # {
+ # tag_key: "CreatedBy",
+ # tag_value: "ExampleUser",
+ # },
+ # {
+ # tag_key: "Purpose",
+ # tag_value: "Test",
+ # },
+ # ], # A list of tags.
+ # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_resource_tags({
+ # key_id: "KeyIdType", # required
+ # limit: 1,
+ # marker: "MarkerType",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.tags #=> Array
+ # resp.tags[0].tag_key #=> String
+ # resp.tags[0].tag_value #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags AWS API Documentation
+ #
+ # @overload list_resource_tags(params = {})
+ # @param [Hash] params ({})
+ def list_resource_tags(params = {}, options = {})
+ req = build_request(:list_resource_tags, params)
+ req.send_request(options)
+ end
+
+ # Returns information about all grants in the Amazon Web Services
+ # account and Region that have the specified retiring principal.
+ #
+ # You can specify any principal in your Amazon Web Services account. The
+ # grants that are returned include grants for KMS keys in your Amazon
+ # Web Services account and other Amazon Web Services accounts. You might
+ # use this operation to determine which grants you may retire. To retire
+ # a grant, use the RetireGrant operation.
+ #
+ # For detailed information about grants, including grant terminology,
+ # see [Grants in KMS][1] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>. For examples of working with grants in several
+ # programming languages, see [Programming grants][2].
+ #
+ # **Cross-account use**: You must specify a principal in your Amazon Web
+ # Services account. However, this operation can return grants in any
+ # Amazon Web Services account. You do not need `kms:ListRetirableGrants`
+ # permission (or any other additional permission) in any Amazon Web
+ # Services account other than your own.
+ #
+ # **Required permissions**: [kms:ListRetirableGrants][3] (IAM policy) in
+ # your Amazon Web Services account.
+ #
+ # **Related operations:**
+ #
+ # * CreateGrant
+ #
+ # * ListGrants
+ #
+ # * RetireGrant
+ #
+ # * RevokeGrant
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [Integer] :limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to 50.
+ #
+ # @option params [String] :marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # @option params [required, String] :retiring_principal
+ # The retiring principal for which to list grants. Enter a principal in
+ # your Amazon Web Services account.
+ #
+ # To specify the retiring principal, use the [Amazon Resource Name
+ # (ARN)][1] of an Amazon Web Services principal. Valid principals
+ # include Amazon Web Services accounts, IAM users, IAM roles, federated
+ # users, and assumed role users. For help with the ARN syntax for a
+ # principal, see [IAM ARNs][2] in the <i> <i>Identity and Access
+ # Management User Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
+ #
+ # @return [Types::ListGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListGrantsResponse#grants #grants} => Array<Types::GrantListEntry>
+ # * {Types::ListGrantsResponse#next_marker #next_marker} => String
+ # * {Types::ListGrantsResponse#truncated #truncated} => Boolean
+ #
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
+ #
+ # @example Example: To list grants that the specified principal can retire
+ #
+ # # The following example lists the grants that the specified principal (identity) can retire.
+ #
+ # resp = client.list_retirable_grants({
+ # retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole", # The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of a principal such as an AWS account (root), IAM user, federated user, or assumed role user.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # grants: [
+ # {
+ # creation_date: Time.parse("2016-12-07T11:09:35-08:00"),
+ # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
+ # grantee_principal: "arn:aws:iam::111122223333:role/ExampleRole",
+ # issuing_account: "arn:aws:iam::444455556666:root",
+ # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ # operations: [
+ # "Decrypt",
+ # "Encrypt",
+ # ],
+ # retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole",
+ # },
+ # ], # A list of grants that the specified principal can retire.
+ # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.list_retirable_grants({
+ # limit: 1,
+ # marker: "MarkerType",
+ # retiring_principal: "PrincipalIdType", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.grants #=> Array
+ # resp.grants[0].key_id #=> String
+ # resp.grants[0].grant_id #=> String
+ # resp.grants[0].name #=> String
+ # resp.grants[0].creation_date #=> Time
+ # resp.grants[0].grantee_principal #=> String
+ # resp.grants[0].retiring_principal #=> String
+ # resp.grants[0].issuing_account #=> String
+ # resp.grants[0].operations #=> Array
+ # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac"
+ # resp.grants[0].constraints.encryption_context_subset #=> Hash
+ # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
+ # resp.grants[0].constraints.encryption_context_equals #=> Hash
+ # resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
+ # resp.next_marker #=> String
+ # resp.truncated #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants AWS API Documentation
+ #
+ # @overload list_retirable_grants(params = {})
+ # @param [Hash] params ({})
+ def list_retirable_grants(params = {}, options = {})
+ req = build_request(:list_retirable_grants, params)
+ req.send_request(options)
+ end
+
+ # Attaches a key policy to the specified KMS key.
+ #
+ # For more information about key policies, see [Key Policies][1] in the
+ # *Key Management Service Developer Guide*. For help writing and
+ # formatting a JSON policy document, see the [IAM JSON Policy
+ # Reference][2] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>. For examples of adding a key policy in multiple
+ # programming languages, see [Setting a key policy][3] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: [kms:PutKeyPolicy][4] (key policy)
+ #
+ # **Related operations**: GetKeyPolicy
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Sets the key policy on the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, String] :policy_name
+ # The name of the key policy. The only valid value is `default`.
+ #
+ # @option params [required, String] :policy
+ # The key policy to attach to the KMS key.
+ #
+ # The key policy must meet the following criteria:
+ #
+ # * The key policy must allow the calling principal to make a subsequent
+ # `PutKeyPolicy` request on the KMS key. This reduces the risk that
+ # the KMS key becomes unmanageable. For more information, see [Default
+ # key policy][1] in the *Key Management Service Developer Guide*. (To
+ # omit this condition, set `BypassPolicyLockoutSafetyCheck` to true.)
+ #
+ # * Each statement in the key policy must contain one or more
+ # principals. The principals in the key policy must exist and be
+ # visible to KMS. When you create a new Amazon Web Services principal,
+ # you might need to enforce a delay before including the new principal
+ # in a key policy because the new principal might not be immediately
+ # visible to KMS. For more information, see [Changes that I make are
+ # not always immediately visible][2] in the *Amazon Web Services
+ # Identity and Access Management User Guide*.
+ #
+ # A key policy document can include only the following characters:
+ #
+ # * Printable ASCII characters from the space character (`\u0020`)
+ # through the end of the ASCII character range.
+ #
+ # * Printable characters in the Basic Latin and Latin-1 Supplement
+ # character set (through `\u00FF`).
+ #
+ # * The tab (`\u0009`), line feed (`\u000A`), and carriage return
+ # (`\u000D`) special characters
+ #
+ # For information about key policies, see [Key policies in KMS][3] in
+ # the *Key Management Service Developer Guide*.For help writing and
+ # formatting a JSON policy document, see the [IAM JSON Policy
+ # Reference][4] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+ #
+ # @option params [Boolean] :bypass_policy_lockout_safety_check
+ # Skips ("bypasses") the key policy lockout safety check. The default
+ # value is false.
+ #
+ # Setting this value to true increases the risk that the KMS key becomes
+ # unmanageable. Do not set this value to true indiscriminately.
+ #
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # Use this parameter only when you intend to prevent the principal that
+ # is making the request from making a subsequent PutKeyPolicy request on
+ # the KMS key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To attach a key policy to a KMS key
+ #
+ # # The following example attaches a key policy to the specified KMS key.
+ #
+ # resp = client.put_key_policy({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # policy: "{\"Version\":\"2012-10-17\",\"Id\":\"custom-policy-2016-12-07\",\"Statement\":[{\"Sid\":\"EnableIAMUserPermissions\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"kms:*\",\"Resource\":\"*\"},{\"Sid\":\"AllowaccessforKeyAdministrators\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:user/ExampleAdminUser\",\"arn:aws:iam::111122223333:role/ExampleAdminRole\"]},\"Action\":[\"kms:Create*\",\"kms:Describe*\",\"kms:Enable*\",\"kms:List*\",\"kms:Put*\",\"kms:Update*\",\"kms:Revoke*\",\"kms:Disable*\",\"kms:Get*\",\"kms:Delete*\",\"kms:ScheduleKeyDeletion\",\"kms:CancelKeyDeletion\"],\"Resource\":\"*\"},{\"Sid\":\"Allowuseofthekey\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:Encrypt\",\"kms:Decrypt\",\"kms:ReEncrypt*\",\"kms:GenerateDataKey*\",\"kms:DescribeKey\"],\"Resource\":\"*\"},{\"Sid\":\"Allowattachmentofpersistentresources\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:CreateGrant\",\"kms:ListGrants\",\"kms:RevokeGrant\"],\"Resource\":\"*\",\"Condition\":{\"Bool\":{\"kms:GrantIsForAWSResource\":\"true\"}}}]}", # The key policy document.
+ # policy_name: "default", # The name of the key policy.
+ # })
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.put_key_policy({
+ # key_id: "KeyIdType", # required
+ # policy_name: "PolicyNameType", # required
+ # policy: "PolicyType", # required
+ # bypass_policy_lockout_safety_check: false,
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy AWS API Documentation
+ #
+ # @overload put_key_policy(params = {})
+ # @param [Hash] params ({})
+ def put_key_policy(params = {}, options = {})
+ req = build_request(:put_key_policy, params)
+ req.send_request(options)
+ end
+
+ # Decrypts ciphertext and then reencrypts it entirely within KMS. You
+ # can use this operation to change the KMS key under which data is
+ # encrypted, such as when you [manually rotate][1] a KMS key or change
+ # the KMS key that protects a ciphertext. You can also use it to
+ # reencrypt ciphertext under the same KMS key, such as to change the
+ # [encryption context][2] of a ciphertext.
+ #
+ # The `ReEncrypt` operation can decrypt ciphertext that was encrypted by
+ # using a KMS key in an KMS operation, such as Encrypt or
+ # GenerateDataKey. It can also decrypt ciphertext that was encrypted by
+ # using the public key of an [asymmetric KMS key][3] outside of KMS.
+ # However, it cannot decrypt ciphertext produced by other libraries,
+ # such as the [Amazon Web Services Encryption SDK][4] or [Amazon S3
+ # client-side encryption][5]. These libraries return a ciphertext format
+ # that is incompatible with KMS.
+ #
+ # When you use the `ReEncrypt` operation, you need to provide
+ # information for the decrypt operation and the subsequent encrypt
+ # operation.
+ #
+ # * If your ciphertext was encrypted under an asymmetric KMS key, you
+ # must use the `SourceKeyId` parameter to identify the KMS key that
+ # encrypted the ciphertext. You must also supply the encryption
+ # algorithm that was used. This information is required to decrypt the
+ # data.
+ #
+ # * If your ciphertext was encrypted under a symmetric encryption KMS
+ # key, the `SourceKeyId` parameter is optional. KMS can get this
+ # information from metadata that it adds to the symmetric ciphertext
+ # blob. This feature adds durability to your implementation by
+ # ensuring that authorized users can decrypt ciphertext decades after
+ # it was encrypted, even if they've lost track of the key ID.
+ # However, specifying the source KMS key is always recommended as a
+ # best practice. When you use the `SourceKeyId` parameter to specify a
+ # KMS key, KMS uses only the KMS key you specify. If the ciphertext
+ # was encrypted under a different KMS key, the `ReEncrypt` operation
+ # fails. This practice ensures that you use the KMS key that you
+ # intend.
+ #
+ # * To reencrypt the data, you must use the `DestinationKeyId` parameter
+ # to specify the KMS key that re-encrypts the data after it is
+ # decrypted. If the destination KMS key is an asymmetric KMS key, you
+ # must also provide the encryption algorithm. The algorithm that you
+ # choose must be compatible with the KMS key.
+ #
+ # When you use an asymmetric KMS key to encrypt or reencrypt data, be
+ # sure to record the KMS key and encryption algorithm that you choose.
+ # You will be required to provide the same KMS key and encryption
+ # algorithm when you decrypt the data. If the KMS key and algorithm do
+ # not match the values used to encrypt the data, the decrypt operation
+ # fails.
+ #
+ # You are not required to supply the key ID and encryption algorithm
+ # when you decrypt with symmetric encryption KMS keys because KMS
+ # stores this information in the ciphertext blob. KMS cannot store
+ # metadata in ciphertext generated with asymmetric keys. The standard
+ # format for asymmetric key ciphertext does not include configurable
+ # fields.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][6] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: Yes. The source KMS key and destination KMS key
+ # can be in different Amazon Web Services accounts. Either or both KMS
+ # keys can be in a different account than the caller. To specify a KMS
+ # key in a different account, you must use its key ARN or alias ARN.
+ #
+ # **Required permissions**:
+ #
+ # * [kms:ReEncryptFrom][7] permission on the source KMS key (key policy)
+ #
+ # * [kms:ReEncryptTo][7] permission on the destination KMS key (key
+ # policy)
+ #
+ # To permit reencryption from or to a KMS key, include the
+ # `"kms:ReEncrypt*"` permission in your [key policy][8]. This permission
+ # is automatically included in the key policy when you use the console
+ # to create a KMS key. But you must include it manually when you create
+ # a KMS key programmatically or when you use the PutKeyPolicy operation
+ # to set a key policy.
+ #
+ # **Related operations:**
+ #
+ # * Decrypt
+ #
+ # * Encrypt
+ #
+ # * GenerateDataKey
+ #
+ # * GenerateDataKeyPair
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks
+ # [4]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/
+ # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ #
+ # @option params [required, String, StringIO, File] :ciphertext_blob
+ # Ciphertext of the data to reencrypt.
+ #
+ # @option params [Hash<String,String>] :source_encryption_context
+ # Specifies the encryption context to use to decrypt the ciphertext.
+ # Enter the same encryption context that was used to encrypt the
+ # ciphertext.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [String] :source_key_id
+ # Specifies the KMS key that KMS will use to decrypt the ciphertext
+ # before it is re-encrypted.
+ #
+ # Enter a key ID of the KMS key that was used to encrypt the ciphertext.
+ # If you identify a different KMS key, the `ReEncrypt` operation throws
+ # an `IncorrectKeyException`.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. If you used a symmetric encryption KMS
+ # key, KMS can get the KMS key from metadata that it adds to the
+ # symmetric ciphertext blob. However, it is always recommended as a best
+ # practice. This practice ensures that you use the KMS key that you
+ # intend.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [required, String] :destination_key_id
+ # A unique identifier for the KMS key that is used to reencrypt the
+ # data. Specify a symmetric encryption KMS key or an asymmetric KMS key
+ # with a `KeyUsage` value of `ENCRYPT_DECRYPT`. To find the `KeyUsage`
+ # value of a KMS key, use the DescribeKey operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ #
+ # @option params [Hash<String,String>] :destination_encryption_context
+ # Specifies that encryption context to use when the reencrypting the
+ # data.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # A destination encryption context is valid only when the destination
+ # KMS key is a symmetric encryption KMS key. The standard ciphertext
+ # format for asymmetric KMS keys does not include fields for metadata.
+ #
+ # An *encryption context* is a collection of non-secret key-value pairs
+ # that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data. An
+ # encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS keys,
+ # an encryption context is optional, but it is strongly recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ #
+ # @option params [String] :source_encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to decrypt the
+ # ciphertext before it is reencrypted. The default value,
+ # `SYMMETRIC_DEFAULT`, represents the algorithm used for symmetric
+ # encryption KMS keys.
+ #
+ # Specify the same algorithm that was used to encrypt the ciphertext. If
+ # you specify a different algorithm, the decrypt attempt fails.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key.
+ #
+ # @option params [String] :destination_encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to reecrypt the
+ # data after it has decrypted it. The default value,
+ # `SYMMETRIC_DEFAULT`, represents the encryption algorithm used for
+ # symmetric encryption KMS keys.
+ #
+ # This parameter is required only when the destination KMS key is an
+ # asymmetric KMS key.
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::ReEncryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ReEncryptResponse#ciphertext_blob #ciphertext_blob} => String
+ # * {Types::ReEncryptResponse#source_key_id #source_key_id} => String
+ # * {Types::ReEncryptResponse#key_id #key_id} => String
+ # * {Types::ReEncryptResponse#source_encryption_algorithm #source_encryption_algorithm} => String
+ # * {Types::ReEncryptResponse#destination_encryption_algorithm #destination_encryption_algorithm} => String
+ #
+ #
+ # @example Example: To reencrypt data
+ #
+ # # The following example reencrypts data with the specified KMS key.
+ #
+ # resp = client.re_encrypt({
+ # ciphertext_blob: "<binary data>", # The data to reencrypt.
+ # destination_key_id: "0987dcba-09fe-87dc-65ba-ab0987654321", # The identifier of the KMS key to use to reencrypt the data. You can use any valid key identifier.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # ciphertext_blob: "<binary data>", # The reencrypted data.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The ARN of the KMS key that was used to reencrypt the data.
+ # source_key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that was originally used to encrypt the data.
+ # }
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.re_encrypt({
+ # ciphertext_blob: "data", # required
+ # source_encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # source_key_id: "KeyIdType",
+ # destination_key_id: "KeyIdType", # required
+ # destination_encryption_context: {
+ # "EncryptionContextKey" => "EncryptionContextValue",
+ # },
+ # source_encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE
+ # destination_encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.ciphertext_blob #=> String
+ # resp.source_key_id #=> String
+ # resp.key_id #=> String
+ # resp.source_encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.destination_encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt AWS API Documentation
+ #
+ # @overload re_encrypt(params = {})
+ # @param [Hash] params ({})
+ def re_encrypt(params = {}, options = {})
+ req = build_request(:re_encrypt, params)
+ req.send_request(options)
+ end
+
+ # Replicates a multi-Region key into the specified Region. This
+ # operation creates a multi-Region replica key based on a multi-Region
+ # primary key in a different Region of the same Amazon Web Services
+ # partition. You can create multiple replicas of a primary key, but each
+ # must be in a different Region. To create a multi-Region primary key,
+ # use the CreateKey operation.
+ #
+ # This operation supports *multi-Region keys*, an KMS feature that lets
+ # you create multiple interoperable KMS keys in different Amazon Web
+ # Services Regions. Because these KMS keys have the same key ID, key
+ # material, and other metadata, you can use them interchangeably to
+ # encrypt data in one Amazon Web Services Region and decrypt it in a
+ # different Amazon Web Services Region without re-encrypting the data or
+ # making a cross-Region call. For more information about multi-Region
+ # keys, see [Multi-Region keys in KMS][1] in the *Key Management Service
+ # Developer Guide*.
+ #
+ # A *replica key* is a fully-functional KMS key that can be used
+ # independently of its primary and peer replica keys. A primary key and
+ # its replica keys share properties that make them interoperable. They
+ # have the same [key ID][2] and key material. They also have the same
+ # [key spec][3], [key usage][4], [key material origin][5], and
+ # [automatic key rotation status][6]. KMS automatically synchronizes
+ # these shared properties among related multi-Region keys. All other
+ # properties of a replica key can differ, including its [key policy][7],
+ # [tags][8], [aliases][9], and [Key states of KMS keys][10]. KMS pricing
+ # and quotas for KMS keys apply to each primary key and replica key.
+ #
+ # When this operation completes, the new replica key has a transient key
+ # state of `Creating`. This key state changes to `Enabled` (or
+ # `PendingImport`) after a few seconds when the process of creating the
+ # new replica key is complete. While the key state is `Creating`, you
+ # can manage key, but you cannot yet use it in cryptographic operations.
+ # If you are creating and using the replica key programmatically, retry
+ # on `KMSInvalidStateException` or call `DescribeKey` to check its
+ # `KeyState` value before using it. For details about the `Creating` key
+ # state, see [Key states of KMS keys][10] in the *Key Management Service
+ # Developer Guide*.
+ #
+ # You cannot create more than one replica of a primary key in any
+ # Region. If the Region already includes a replica of the key you're
+ # trying to replicate, `ReplicateKey` returns an
+ # `AlreadyExistsException` error. If the key state of the existing
+ # replica is `PendingDeletion`, you can cancel the scheduled key
+ # deletion (CancelKeyDeletion) or wait for the key to be deleted. The
+ # new replica key you create will have the same [shared properties][11]
+ # as the original replica key.
+ #
+ # The CloudTrail log of a `ReplicateKey` operation records a
+ # `ReplicateKey` operation in the primary key's Region and a CreateKey
+ # operation in the replica key's Region.
+ #
+ # If you replicate a multi-Region primary key with imported key
+ # material, the replica key is created with no key material. You must
+ # import the same key material that you imported into the primary key.
+ # For details, see [Importing key material into multi-Region
+ # keys](kms/latest/developerguide/multi-region-keys-import.html) in the
+ # *Key Management Service Developer Guide*.
+ #
+ # To convert a replica key to a primary key, use the UpdatePrimaryRegion
+ # operation.
+ #
+ # <note markdown="1"> `ReplicateKey` uses different default values for the `KeyPolicy` and
+ # `Tags` parameters than those used in the KMS console. For details, see
+ # the parameter descriptions.
+ #
+ # </note>
+ #
+ # **Cross-account use**: No. You cannot use this operation to create a
+ # replica key in a different Amazon Web Services account.
+ #
+ # **Required permissions**:
+ #
+ # * `kms:ReplicateKey` on the primary key (in the primary key's
+ # Region). Include this permission in the primary key's key policy.
+ #
+ # * `kms:CreateKey` in an IAM policy in the replica Region.
+ #
+ # * To use the `Tags` parameter, `kms:TagResource` in an IAM policy in
+ # the replica Region.
+ #
+ # **Related operations**
+ #
+ # * CreateKey
+ #
+ # * UpdatePrimaryRegion
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties
+ #
+ # @option params [required, String] :key_id
+ # Identifies the multi-Region primary key that is being replicated. To
+ # determine whether a KMS key is a multi-Region primary key, use the
+ # DescribeKey operation to check the value of the `MultiRegionKeyType`
+ # property.
+ #
+ # Specify the key ID or key ARN of a multi-Region primary key.
+ #
+ # For example:
+ #
+ # * Key ID: `mrk-1234abcd12ab34cd56ef1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, String] :replica_region
+ # The Region ID of the Amazon Web Services Region for this replica key.
+ #
+ # Enter the Region ID, such as `us-east-1` or `ap-southeast-2`. For a
+ # list of Amazon Web Services Regions in which KMS is supported, see
+ # [KMS service endpoints][1] in the *Amazon Web Services General
+ # Reference*.
+ #
+ # <note markdown="1"> HMAC KMS keys are not supported in all Amazon Web Services Regions. If
+ # you try to replicate an HMAC KMS key in an Amazon Web Services Region
+ # in which HMAC keys are not supported, the `ReplicateKey` operation
+ # returns an `UnsupportedOperationException`. For a list of Regions in
+ # which HMAC KMS keys are supported, see [HMAC keys in KMS][2] in the
+ # *Key Management Service Developer Guide*.
+ #
+ # </note>
+ #
+ # The replica must be in a different Amazon Web Services Region than its
+ # primary key and other replicas of that primary key, but in the same
+ # Amazon Web Services partition. KMS must be available in the replica
+ # Region. If the Region is not enabled by default, the Amazon Web
+ # Services account must be enabled in the Region. For information about
+ # Amazon Web Services partitions, see [Amazon Resource Names (ARNs)][3]
+ # in the *Amazon Web Services General Reference*. For information about
+ # enabling and disabling Regions, see [Enabling a Region][4] and
+ # [Disabling a Region][5] in the *Amazon Web Services General
+ # Reference*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
+ # [5]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable
+ #
+ # @option params [String] :policy
+ # The key policy to attach to the KMS key. This parameter is optional.
+ # If you do not provide a key policy, KMS attaches the [default key
+ # policy][1] to the KMS key.
+ #
+ # The key policy is not a shared property of multi-Region keys. You can
+ # specify the same key policy or a different key policy for each key in
+ # a set of related multi-Region keys. KMS does not synchronize this
+ # property.
+ #
+ # If you provide a key policy, it must meet the following criteria:
+ #
+ # * The key policy must allow the calling principal to make a subsequent
+ # `PutKeyPolicy` request on the KMS key. This reduces the risk that
+ # the KMS key becomes unmanageable. For more information, see [Default
+ # key policy][2] in the *Key Management Service Developer Guide*. (To
+ # omit this condition, set `BypassPolicyLockoutSafetyCheck` to true.)
+ #
+ # * Each statement in the key policy must contain one or more
+ # principals. The principals in the key policy must exist and be
+ # visible to KMS. When you create a new Amazon Web Services principal,
+ # you might need to enforce a delay before including the new principal
+ # in a key policy because the new principal might not be immediately
+ # visible to KMS. For more information, see [Changes that I make are
+ # not always immediately visible][3] in the *Amazon Web Services
+ # Identity and Access Management User Guide*.
+ #
+ # A key policy document can include only the following characters:
+ #
+ # * Printable ASCII characters from the space character (`\u0020`)
+ # through the end of the ASCII character range.
+ #
+ # * Printable characters in the Basic Latin and Latin-1 Supplement
+ # character set (through `\u00FF`).
+ #
+ # * The tab (`\u0009`), line feed (`\u000A`), and carriage return
+ # (`\u000D`) special characters
+ #
+ # For information about key policies, see [Key policies in KMS][4] in
+ # the *Key Management Service Developer Guide*. For help writing and
+ # formatting a JSON policy document, see the [IAM JSON Policy
+ # Reference][5] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+ #
+ # @option params [Boolean] :bypass_policy_lockout_safety_check
+ # Skips ("bypasses") the key policy lockout safety check. The default
+ # value is false.
+ #
+ # Setting this value to true increases the risk that the KMS key becomes
+ # unmanageable. Do not set this value to true indiscriminately.
+ #
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # Use this parameter only when you intend to prevent the principal that
+ # is making the request from making a subsequent PutKeyPolicy request on
+ # the KMS key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ #
+ # @option params [String] :description
+ # A description of the KMS key. The default value is an empty string (no
+ # description).
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # The description is not a shared property of multi-Region keys. You can
+ # specify the same description or a different description for each key
+ # in a set of related multi-Region keys. KMS does not synchronize this
+ # property.
+ #
+ # @option params [Array<Types::Tag>] :tags
+ # Assigns one or more tags to the replica key. Use this parameter to tag
+ # the KMS key when it is created. To tag an existing KMS key, use the
+ # TagResource operation.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the KMS
+ # key. For details, see [ABAC for KMS][1] in the *Key Management Service
+ # Developer Guide*.
+ #
+ # </note>
+ #
+ # To use this parameter, you must have [kms:TagResource][2] permission
+ # in an IAM policy.
+ #
+ # Tags are not a shared property of multi-Region keys. You can specify
+ # the same tags or different tags for each key in a set of related
+ # multi-Region keys. KMS does not synchronize this property.
+ #
+ # Each tag consists of a tag key and a tag value. Both the tag key and
+ # the tag value are required, but the tag value can be an empty (null)
+ # string. You cannot have more than one tag on a KMS key with the same
+ # tag key. If you specify an existing tag key with a different tag
+ # value, KMS replaces the current tag value with the specified one.
+ #
+ # When you add tags to an Amazon Web Services resource, Amazon Web
+ # Services generates a cost allocation report with usage and costs
+ # aggregated by tags. Tags can also be used to control access to a KMS
+ # key. For details, see [Tagging Keys][3].
#
#
- # @example Example: To list grants for a customer master key (CMK)
#
- # # The following example lists grants for the specified CMK.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
#
- # resp = client.list_grants({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # @return [Types::ReplicateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ReplicateKeyResponse#replica_key_metadata #replica_key_metadata} => Types::KeyMetadata
+ # * {Types::ReplicateKeyResponse#replica_policy #replica_policy} => String
+ # * {Types::ReplicateKeyResponse#replica_tags #replica_tags} => Array<Types::Tag>
+ #
+ #
+ # @example Example: To replicate a multi-Region key in a different AWS Region
+ #
+ # # This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
+ #
+ # resp = client.replicate_key({
+ # key_id: "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", # The key ID or key ARN of the multi-Region primary key
+ # replica_region: "us-west-2", # The Region of the new replica.
# })
#
# resp.to_h outputs the following:
# {
- # grants: [
- # {
- # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
- # grant_id: "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172",
- # grantee_principal: "acm.us-east-2.amazonaws.com",
- # issuing_account: "arn:aws:iam::111122223333:root",
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # operations: [
- # "Encrypt",
- # "ReEncryptFrom",
- # "ReEncryptTo",
- # ],
- # retiring_principal: "acm.us-east-2.amazonaws.com",
- # },
- # {
- # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
- # grant_id: "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200",
- # grantee_principal: "acm.us-east-2.amazonaws.com",
- # issuing_account: "arn:aws:iam::111122223333:root",
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # operations: [
- # "ReEncryptFrom",
- # "ReEncryptTo",
- # ],
- # retiring_principal: "acm.us-east-2.amazonaws.com",
- # },
- # {
- # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
- # grant_id: "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f",
- # grantee_principal: "acm.us-east-2.amazonaws.com",
- # issuing_account: "arn:aws:iam::111122223333:root",
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # operations: [
- # "Encrypt",
- # "ReEncryptFrom",
- # "ReEncryptTo",
- # ],
- # retiring_principal: "acm.us-east-2.amazonaws.com",
- # },
- # {
- # creation_date: Time.parse("2016-10-25T14:37:41-07:00"),
- # grant_id: "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c",
- # grantee_principal: "acm.us-east-2.amazonaws.com",
- # issuing_account: "arn:aws:iam::111122223333:root",
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # operations: [
- # "Encrypt",
- # "ReEncryptFrom",
- # "ReEncryptTo",
+ # replica_key_metadata: {
+ # aws_account_id: "111122223333",
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # creation_date: Time.parse(1607472987.918),
+ # customer_master_key_spec: "SYMMETRIC_DEFAULT",
+ # description: "",
+ # enabled: true,
+ # encryption_algorithms: [
+ # "SYMMETRIC_DEFAULT",
+ # ],
+ # key_id: "mrk-1234abcd12ab34cd56ef1234567890ab",
+ # key_manager: "CUSTOMER",
+ # key_state: "Enabled",
+ # key_usage: "ENCRYPT_DECRYPT",
+ # multi_region: true,
+ # multi_region_configuration: {
+ # multi_region_key_type: "REPLICA",
+ # primary_key: {
+ # arn: "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "us-east-1",
+ # },
+ # replica_keys: [
+ # {
+ # arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ # region: "us-west-2",
+ # },
# ],
- # retiring_principal: "acm.us-east-2.amazonaws.com",
# },
- # ], # A list of grants.
- # truncated: true, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # origin: "AWS_KMS",
+ # }, # An object that displays detailed information about the replica key.
+ # replica_policy: "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",...}", # The key policy of the replica key. If you don't specify a key policy, the replica key gets the default key policy for a KMS key.
+ # replica_tags: [
+ # ], # The tags on the replica key, if any.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.list_grants({
- # limit: 1,
- # marker: "MarkerType",
+ # resp = client.replicate_key({
# key_id: "KeyIdType", # required
+ # replica_region: "RegionType", # required
+ # policy: "PolicyType",
+ # bypass_policy_lockout_safety_check: false,
+ # description: "DescriptionType",
+ # tags: [
+ # {
+ # tag_key: "TagKeyType", # required
+ # tag_value: "TagValueType", # required
+ # },
+ # ],
# })
#
# @example Response structure
#
- # resp.grants #=> Array
- # resp.grants[0].key_id #=> String
- # resp.grants[0].grant_id #=> String
- # resp.grants[0].name #=> String
- # resp.grants[0].creation_date #=> Time
- # resp.grants[0].grantee_principal #=> String
- # resp.grants[0].retiring_principal #=> String
- # resp.grants[0].issuing_account #=> String
- # resp.grants[0].operations #=> Array
- # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "CreateGrant", "RetireGrant", "DescribeKey"
- # resp.grants[0].constraints.encryption_context_subset #=> Hash
- # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
- # resp.grants[0].constraints.encryption_context_equals #=> Hash
- # resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # resp.replica_key_metadata.aws_account_id #=> String
+ # resp.replica_key_metadata.key_id #=> String
+ # resp.replica_key_metadata.arn #=> String
+ # resp.replica_key_metadata.creation_date #=> Time
+ # resp.replica_key_metadata.enabled #=> Boolean
+ # resp.replica_key_metadata.description #=> String
+ # resp.replica_key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC"
+ # resp.replica_key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating"
+ # resp.replica_key_metadata.deletion_date #=> Time
+ # resp.replica_key_metadata.valid_to #=> Time
+ # resp.replica_key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE"
+ # resp.replica_key_metadata.custom_key_store_id #=> String
+ # resp.replica_key_metadata.cloud_hsm_cluster_id #=> String
+ # resp.replica_key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
+ # resp.replica_key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
+ # resp.replica_key_metadata.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.replica_key_metadata.key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2"
+ # resp.replica_key_metadata.encryption_algorithms #=> Array
+ # resp.replica_key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE"
+ # resp.replica_key_metadata.signing_algorithms #=> Array
+ # resp.replica_key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
+ # resp.replica_key_metadata.multi_region #=> Boolean
+ # resp.replica_key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
+ # resp.replica_key_metadata.multi_region_configuration.primary_key.arn #=> String
+ # resp.replica_key_metadata.multi_region_configuration.primary_key.region #=> String
+ # resp.replica_key_metadata.multi_region_configuration.replica_keys #=> Array
+ # resp.replica_key_metadata.multi_region_configuration.replica_keys[0].arn #=> String
+ # resp.replica_key_metadata.multi_region_configuration.replica_keys[0].region #=> String
+ # resp.replica_key_metadata.pending_deletion_window_in_days #=> Integer
+ # resp.replica_key_metadata.mac_algorithms #=> Array
+ # resp.replica_key_metadata.mac_algorithms[0] #=> String, one of "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512"
+ # resp.replica_key_metadata.xks_key_configuration.id #=> String
+ # resp.replica_policy #=> String
+ # resp.replica_tags #=> Array
+ # resp.replica_tags[0].tag_key #=> String
+ # resp.replica_tags[0].tag_value #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKey AWS API Documentation
+ #
+ # @overload replicate_key(params = {})
+ # @param [Hash] params ({})
+ def replicate_key(params = {}, options = {})
+ req = build_request(:replicate_key, params)
+ req.send_request(options)
+ end
+
+ # Deletes a grant. Typically, you retire a grant when you no longer need
+ # its permissions. To identify the grant to retire, use a [grant
+ # token][1], or both the grant ID and a key identifier (key ID or key
+ # ARN) of the KMS key. The CreateGrant operation returns both values.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants AWS API Documentation
+ # This operation can be called by the *retiring principal* for a grant,
+ # by the *grantee principal* if the grant allows the `RetireGrant`
+ # operation, and by the Amazon Web Services account in which the grant
+ # is created. It can also be called by principals to whom permission for
+ # retiring a grant is delegated. For details, see [Retiring and revoking
+ # grants][2] in the *Key Management Service Developer Guide*.
#
- # @overload list_grants(params = {})
+ # For detailed information about grants, including grant terminology,
+ # see [Grants in KMS][3] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>. For examples of working with grants in several
+ # programming languages, see [Programming grants][4].
+ #
+ # **Cross-account use**: Yes. You can retire a grant on a KMS key in a
+ # different Amazon Web Services account.
+ #
+ # **Required permissions:**:Permission to retire a grant is determined
+ # primarily by the grant. For details, see [Retiring and revoking
+ # grants][2] in the *Key Management Service Developer Guide*.
+ #
+ # **Related operations:**
+ #
+ # * CreateGrant
+ #
+ # * ListGrants
+ #
+ # * ListRetirableGrants
+ #
+ # * RevokeGrant
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
+ #
+ # @option params [String] :grant_token
+ # Identifies the grant to be retired. You can use a grant token to
+ # identify a new grant even before it has achieved eventual consistency.
+ #
+ # Only the CreateGrant operation returns a grant token. For details, see
+ # [Grant token][1] and [Eventual consistency][2] in the *Key Management
+ # Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency
+ #
+ # @option params [String] :key_id
+ # The key ARN KMS key associated with the grant. To find the key ARN,
+ # use the ListKeys operation.
+ #
+ # For example:
+ # `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # @option params [String] :grant_id
+ # Identifies the grant to retire. To get the grant ID, use CreateGrant,
+ # ListGrants, or ListRetirableGrants.
+ #
+ # * Grant ID Example -
+ # 0123456789012345678901234567890123456789012345678901234567890123
+ #
+ # ^
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To retire a grant
+ #
+ # # The following example retires a grant.
+ #
+ # resp = client.retire_grant({
+ # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to retire.
+ # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the KMS key associated with the grant.
+ # })
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.retire_grant({
+ # grant_token: "GrantTokenType",
+ # key_id: "KeyIdType",
+ # grant_id: "GrantIdType",
+ # dry_run: false,
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant AWS API Documentation
+ #
+ # @overload retire_grant(params = {})
# @param [Hash] params ({})
- def list_grants(params = {}, options = {})
- req = build_request(:list_grants, params)
+ def retire_grant(params = {}, options = {})
+ req = build_request(:retire_grant, params)
req.send_request(options)
end
- # Gets the names of the key policies that are attached to a customer
- # master key (CMK). This operation is designed to get policy names that
- # you can use in a GetKeyPolicy operation. However, the only valid
- # policy name is `default`. You cannot perform this operation on a CMK
- # in a different AWS account.
+ # Deletes the specified grant. You revoke a grant to terminate the
+ # permissions that the grant allows. For more information, see [Retiring
+ # and revoking grants][1] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>.
+ #
+ # When you create, retire, or revoke a grant, there might be a brief
+ # delay, usually less than five minutes, until the grant is available
+ # throughout KMS. This state is known as *eventual consistency*. For
+ # details, see [Eventual consistency][2] in the <i> <i>Key Management
+ # Service Developer Guide</i> </i>.
+ #
+ # For detailed information about grants, including grant terminology,
+ # see [Grants in KMS][3] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>. For examples of working with grants in several
+ # programming languages, see [Programming grants][4].
+ #
+ # **Cross-account use**: Yes. To perform this operation on a KMS key in
+ # a different Amazon Web Services account, specify the key ARN in the
+ # value of the `KeyId` parameter.
+ #
+ # **Required permissions**: [kms:RevokeGrant][5] (key policy).
+ #
+ # **Related operations:**
+ #
+ # * CreateGrant
+ #
+ # * ListGrants
+ #
+ # * ListRetirableGrants
+ #
+ # * RetireGrant
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # A unique identifier for the KMS key associated with the grant. To get
+ # the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key in
+ # a different Amazon Web Services account, you must use the key ARN.
#
# For example:
#
@@ -2866,170 +8147,279 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # @option params [required, String] :grant_id
+ # Identifies the grant to revoke. To get the grant ID, use CreateGrant,
+ # ListGrants, or ListRetirableGrants.
#
- # This value is optional. If you include a value, it must be between 1
- # and 1000, inclusive. If you do not include a value, it defaults to
- # 100.
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # Only one policy can be attached to a key.
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
#
- # @return [Types::ListKeyPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::ListKeyPoliciesResponse#policy_names #policy_names} => Array<String>
- # * {Types::ListKeyPoliciesResponse#next_marker #next_marker} => String
- # * {Types::ListKeyPoliciesResponse#truncated #truncated} => Boolean
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
#
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
- # @example Example: To list key policies for a customer master key (CMK)
#
- # # The following example lists key policies for the specified CMK.
+ # @example Example: To revoke a grant
#
- # resp = client.list_key_policies({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # # The following example revokes a grant.
+ #
+ # resp = client.revoke_grant({
+ # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to revoke.
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # })
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.revoke_grant({
+ # key_id: "KeyIdType", # required
+ # grant_id: "GrantIdType", # required
+ # dry_run: false,
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant AWS API Documentation
+ #
+ # @overload revoke_grant(params = {})
+ # @param [Hash] params ({})
+ def revoke_grant(params = {}, options = {})
+ req = build_request(:revoke_grant, params)
+ req.send_request(options)
+ end
+
+ # Schedules the deletion of a KMS key. By default, KMS applies a waiting
+ # period of 30 days, but you can specify a waiting period of 7-30 days.
+ # When this operation is successful, the key state of the KMS key
+ # changes to `PendingDeletion` and the key can't be used in any
+ # cryptographic operations. It remains in this state for the duration of
+ # the waiting period. Before the waiting period ends, you can use
+ # CancelKeyDeletion to cancel the deletion of the KMS key. After the
+ # waiting period ends, KMS deletes the KMS key, its key material, and
+ # all KMS data associated with it, including all aliases that refer to
+ # it.
+ #
+ # Deleting a KMS key is a destructive and potentially dangerous
+ # operation. When a KMS key is deleted, all data that was encrypted
+ # under the KMS key is unrecoverable. (The only exception is a
+ # [multi-Region replica
+ # key](kms/latest/developerguide/multi-region-keys-delete.html), or an
+ # [asymmetric or HMAC KMS key with imported key
+ # material](kms/latest/developerguide/importing-keys-managing.html#import-delete-key).)
+ # To prevent the use of a KMS key without deleting it, use DisableKey.
+ #
+ # You can schedule the deletion of a multi-Region primary key and its
+ # replica keys at any time. However, KMS will not delete a multi-Region
+ # primary key with existing replica keys. If you schedule the deletion
+ # of a primary key with replicas, its key state changes to
+ # `PendingReplicaDeletion` and it cannot be replicated or used in
+ # cryptographic operations. This status can continue indefinitely. When
+ # the last of its replicas keys is deleted (not just scheduled), the key
+ # state of the primary key changes to `PendingDeletion` and its waiting
+ # period (`PendingWindowInDays`) begins. For details, see [Deleting
+ # multi-Region keys][1] in the *Key Management Service Developer Guide*.
+ #
+ # When KMS [deletes a KMS key from an CloudHSM key store][2], it makes a
+ # best effort to delete the associated key material from the associated
+ # CloudHSM cluster. However, you might need to manually [delete the
+ # orphaned key material][3] from the cluster and its backups. [Deleting
+ # a KMS key from an external key store][4] has no effect on the
+ # associated external key. However, for both types of custom key stores,
+ # deleting a KMS key is destructive and irreversible. You cannot decrypt
+ # ciphertext encrypted under the KMS key by using only its associated
+ # external key or CloudHSM key. Also, you cannot recreate a KMS key in
+ # an external key store by creating a new KMS key with the same key
+ # material.
+ #
+ # For more information about scheduling a KMS key for deletion, see
+ # [Deleting KMS keys][5] in the *Key Management Service Developer
+ # Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][6] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
+ #
+ # **Required permissions**: kms:ScheduleKeyDeletion (key policy)
+ #
+ # **Related operations**
+ #
+ # * CancelKeyDeletion
+ #
+ # * DisableKey
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ # @option params [required, String] :key_id
+ # The unique identifier of the KMS key to delete.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [Integer] :pending_window_in_days
+ # The waiting period, specified in number of days. After the waiting
+ # period ends, KMS deletes the KMS key.
+ #
+ # If the KMS key is a multi-Region primary key with replica keys, the
+ # waiting period begins when the last of its replica keys is deleted.
+ # Otherwise, the waiting period begins immediately.
+ #
+ # This value is optional. If you include a value, it must be between 7
+ # and 30, inclusive. If you do not include a value, it defaults to 30.
+ # You can use the [ `kms:ScheduleKeyDeletionPendingWindowInDays` ][1]
+ # condition key to further constrain the values that principals can
+ # specify in the `PendingWindowInDays` parameter.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days
+ #
+ # @return [Types::ScheduleKeyDeletionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ScheduleKeyDeletionResponse#key_id #key_id} => String
+ # * {Types::ScheduleKeyDeletionResponse#deletion_date #deletion_date} => Time
+ # * {Types::ScheduleKeyDeletionResponse#key_state #key_state} => String
+ # * {Types::ScheduleKeyDeletionResponse#pending_window_in_days #pending_window_in_days} => Integer
+ #
+ #
+ # @example Example: To schedule a KMS key for deletion
+ #
+ # # The following example schedules the specified KMS key for deletion.
+ #
+ # resp = client.schedule_key_deletion({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # pending_window_in_days: 7, # The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
# })
#
# resp.to_h outputs the following:
# {
- # policy_names: [
- # "default",
- # ], # A list of key policy names.
- # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # deletion_date: Time.parse("2016-12-17T16:00:00-08:00"), # The date and time after which KMS deletes the KMS key.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the KMS key that is scheduled for deletion.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.list_key_policies({
+ # resp = client.schedule_key_deletion({
# key_id: "KeyIdType", # required
- # limit: 1,
- # marker: "MarkerType",
+ # pending_window_in_days: 1,
# })
#
# @example Response structure
#
- # resp.policy_names #=> Array
- # resp.policy_names[0] #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # resp.key_id #=> String
+ # resp.deletion_date #=> Time
+ # resp.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating"
+ # resp.pending_window_in_days #=> Integer
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion AWS API Documentation
#
- # @overload list_key_policies(params = {})
+ # @overload schedule_key_deletion(params = {})
# @param [Hash] params ({})
- def list_key_policies(params = {}, options = {})
- req = build_request(:list_key_policies, params)
+ def schedule_key_deletion(params = {}, options = {})
+ req = build_request(:schedule_key_deletion, params)
req.send_request(options)
end
- # Gets a list of all customer master keys (CMKs) in the caller's AWS
- # account and region.
- #
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # Creates a [digital signature][1] for a message or message digest by
+ # using the private key in an asymmetric signing KMS key. To verify the
+ # signature, use the Verify operation, or use the public key in the same
+ # asymmetric KMS key outside of KMS. For information about asymmetric
+ # KMS keys, see [Asymmetric KMS keys][2] in the *Key Management Service
+ # Developer Guide*.
#
- # This value is optional. If you include a value, it must be between 1
- # and 1000, inclusive. If you do not include a value, it defaults to
- # 100.
+ # Digital signatures are generated and verified by using asymmetric key
+ # pair, such as an RSA or ECC pair that is represented by an asymmetric
+ # KMS key. The key owner (or an authorized user) uses their private key
+ # to sign a message. Anyone with the public key can verify that the
+ # message was signed with that particular private key and that the
+ # message hasn't changed since it was signed.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # To use the `Sign` operation, provide the following information:
#
- # @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # * Use the `KeyId` parameter to identify an asymmetric KMS key with a
+ # `KeyUsage` value of `SIGN_VERIFY`. To get the `KeyUsage` value of a
+ # KMS key, use the DescribeKey operation. The caller must have
+ # `kms:Sign` permission on the KMS key.
#
- # * {Types::ListKeysResponse#keys #keys} => Array<Types::KeyListEntry>
- # * {Types::ListKeysResponse#next_marker #next_marker} => String
- # * {Types::ListKeysResponse#truncated #truncated} => Boolean
+ # * Use the `Message` parameter to specify the message or message digest
+ # to sign. You can submit messages of up to 4096 bytes. To sign a
+ # larger message, generate a hash digest of the message, and then
+ # provide the hash digest in the `Message` parameter. To indicate
+ # whether the message is a full message or a digest, use the
+ # `MessageType` parameter.
#
+ # * Choose a signing algorithm that is compatible with the KMS key.
#
- # @example Example: To list customer master keys (CMKs)
+ # When signing a message, be sure to record the KMS key and the signing
+ # algorithm. This information is required to verify the signature.
#
- # # The following example lists CMKs.
+ # <note markdown="1"> Best practices recommend that you limit the time during which any
+ # signature is effective. This deters an attack where the actor uses a
+ # signed message to establish validity repeatedly or long after the
+ # message is superseded. Signatures do not include a timestamp, but you
+ # can include a timestamp in the signed message to help you detect when
+ # its time to refresh the signature.
#
- # resp = client.list_keys({
- # })
+ # </note>
#
- # resp.to_h outputs the following:
- # {
- # keys: [
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e",
- # key_id: "0d990263-018e-4e65-a703-eff731de951e",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841",
- # key_id: "144be297-0ae1-44ac-9c8f-93cd8c82f841",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571",
- # key_id: "21184251-b765-428e-b852-2c7353e72571",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c",
- # key_id: "214fe92f-5b03-4ae1-b350-db2a45dbe10c",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458",
- # key_id: "339963f2-e523-49d3-af24-a0fe752aa458",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a",
- # key_id: "b776a44b-df37-4438-9be4-a27494e4271a",
- # },
- # {
- # key_arn: "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
- # key_id: "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
- # },
- # ], # A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.
- # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
- # }
+ # To verify the signature that this operation generates, use the Verify
+ # operation. Or use the GetPublicKey operation to download the public
+ # key and then use the public key to verify the signature outside of
+ # KMS.
#
- # @example Request syntax with placeholder values
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][3] in the *Key
+ # Management Service Developer Guide*.
#
- # resp = client.list_keys({
- # limit: 1,
- # marker: "MarkerType",
- # })
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
#
- # @example Response structure
+ # **Required permissions**: [kms:Sign][4] (key policy)
#
- # resp.keys #=> Array
- # resp.keys[0].key_id #=> String
- # resp.keys[0].key_arn #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # **Related operations**: Verify
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys AWS API Documentation
#
- # @overload list_keys(params = {})
- # @param [Hash] params ({})
- def list_keys(params = {}, options = {})
- req = build_request(:list_keys, params)
- req.send_request(options)
- end
-
- # Returns a list of all tags for the specified customer master key
- # (CMK).
#
- # You cannot perform this operation on a CMK in a different AWS account.
+ # [1]: https://en.wikipedia.org/wiki/Digital_signature
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies an asymmetric KMS key. KMS uses the private key in the
+ # asymmetric KMS key to sign the message. The `KeyUsage` type of the KMS
+ # key must be `SIGN_VERIFY`. To find the `KeyUsage` of a KMS key, use
+ # the DescribeKey operation.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
#
# For example:
#
@@ -3038,660 +8428,891 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # This value is optional. If you include a value, it must be between 1
- # and 50, inclusive. If you do not include a value, it defaults to 50.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # @option params [required, String, StringIO, File] :message
+ # Specifies the message or message digest to sign. Messages can be
+ # 0-4096 bytes. To sign a larger message, provide a message digest.
#
- # Do not attempt to construct this value. Use only the value of
- # `NextMarker` from the truncated response you just received.
+ # If you provide a message digest, use the `DIGEST` value of
+ # `MessageType` to prevent the digest from being hashed again while
+ # signing.
#
- # @return [Types::ListResourceTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # @option params [String] :message_type
+ # Tells KMS whether the value of the `Message` parameter should be
+ # hashed as part of the signing algorithm. Use `RAW` for unhashed
+ # messages; use `DIGEST` for message digests, which are already hashed.
#
- # * {Types::ListResourceTagsResponse#tags #tags} => Array<Types::Tag>
- # * {Types::ListResourceTagsResponse#next_marker #next_marker} => String
- # * {Types::ListResourceTagsResponse#truncated #truncated} => Boolean
+ # When the value of `MessageType` is `RAW`, KMS uses the standard
+ # signing algorithm, which begins with a hash function. When the value
+ # is `DIGEST`, KMS skips the hashing step in the signing algorithm.
#
+ # Use the `DIGEST` value only when the value of the `Message` parameter
+ # is a message digest. If you use the `DIGEST` value with an unhashed
+ # message, the security of the signing operation can be compromised.
#
- # @example Example: To list tags for a customer master key (CMK)
+ # When the value of `MessageType`is `DIGEST`, the length of the
+ # `Message` value must match the length of hashed messages for the
+ # specified signing algorithm.
#
- # # The following example lists tags for a CMK.
+ # You can submit a message digest and omit the `MessageType` or specify
+ # `RAW` so the digest is hashed again while signing. However, this can
+ # cause verification failures when verifying with a system that assumes
+ # a single hash.
#
- # resp = client.list_resource_tags({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # The hashing algorithm in that `Sign` uses is based on the
+ # `SigningAlgorithm` value.
+ #
+ # * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
+ # algorithm.
+ #
+ # * Signing algorithms that end in SHA\_384 use the SHA\_384 hashing
+ # algorithm.
+ #
+ # * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
+ # algorithm.
+ #
+ # * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
+ # verification with SM2 key pairs][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
+ #
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ #
+ # @option params [required, String] :signing_algorithm
+ # Specifies the signing algorithm to use when signing the message.
+ #
+ # Choose an algorithm that is compatible with the type and size of the
+ # specified asymmetric KMS key. When signing with RSA key pairs,
+ # RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1\_5
+ # algorithms for compatibility with existing applications.
+ #
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::SignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::SignResponse#key_id #key_id} => String
+ # * {Types::SignResponse#signature #signature} => String
+ # * {Types::SignResponse#signing_algorithm #signing_algorithm} => String
+ #
+ #
+ # @example Example: To digitally sign a message with an asymmetric KMS key.
+ #
+ # # This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a
+ # # given message.
+ #
+ # resp = client.sign({
+ # key_id: "alias/ECC_signing_key", # The asymmetric KMS key to be used to generate the digital signature. This example uses an alias of the KMS key.
+ # message: "<message to be signed>", # Message to be signed. Use Base-64 for the CLI.
+ # message_type: "RAW", # Indicates whether the message is RAW or a DIGEST.
+ # signing_algorithm: "ECDSA_SHA_384", # The requested signing algorithm. This must be an algorithm that the KMS key supports.
# })
#
# resp.to_h outputs the following:
# {
- # tags: [
- # {
- # tag_key: "CostCenter",
- # tag_value: "87654",
- # },
- # {
- # tag_key: "CreatedBy",
- # tag_value: "ExampleUser",
- # },
- # {
- # tag_key: "Purpose",
- # tag_value: "Test",
- # },
- # ], # A list of tags.
- # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the asymmetric KMS key that was used to sign the message.
+ # signature: "<binary data>", # The digital signature of the message.
+ # signing_algorithm: "ECDSA_SHA_384", # The actual signing algorithm that was used to generate the signature.
+ # }
+ #
+ # @example Example: To digitally sign a message digest with an asymmetric KMS key.
+ #
+ # # This operation uses the private key in an asymmetric RSA signing KMS key to generate a digital signature for a message
+ # # digest. In this example, a large message was hashed and the resulting digest is provided in the Message parameter. To
+ # # tell KMS not to hash the message again, the MessageType field is set to DIGEST
+ #
+ # resp = client.sign({
+ # key_id: "alias/RSA_signing_key", # The asymmetric KMS key to be used to generate the digital signature. This example uses an alias of the KMS key.
+ # message: "<message digest to be signed>", # Message to be signed. Use Base-64 for the CLI.
+ # message_type: "DIGEST", # Indicates whether the message is RAW or a DIGEST. When it is RAW, KMS hashes the message before signing. When it is DIGEST, KMS skips the hashing step and signs the Message value.
+ # signing_algorithm: "RSASSA_PKCS1_V1_5_SHA_256", # The requested signing algorithm. This must be an algorithm that the KMS key supports.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The key ARN of the asymmetric KMS key that was used to sign the message.
+ # signature: "<binary data>", # The digital signature of the message.
+ # signing_algorithm: "RSASSA_PKCS1_V1_5_SHA_256", # The actual signing algorithm that was used to generate the signature.
# }
#
# @example Request syntax with placeholder values
#
- # resp = client.list_resource_tags({
+ # resp = client.sign({
# key_id: "KeyIdType", # required
- # limit: 1,
- # marker: "MarkerType",
+ # message: "data", # required
+ # message_type: "RAW", # accepts RAW, DIGEST
+ # grant_tokens: ["GrantTokenType"],
+ # signing_algorithm: "RSASSA_PSS_SHA_256", # required, accepts RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA
+ # dry_run: false,
# })
#
# @example Response structure
#
- # resp.tags #=> Array
- # resp.tags[0].tag_key #=> String
- # resp.tags[0].tag_value #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # resp.key_id #=> String
+ # resp.signature #=> String
+ # resp.signing_algorithm #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Sign AWS API Documentation
#
- # @overload list_resource_tags(params = {})
+ # @overload sign(params = {})
# @param [Hash] params ({})
- def list_resource_tags(params = {}, options = {})
- req = build_request(:list_resource_tags, params)
+ def sign(params = {}, options = {})
+ req = build_request(:sign, params)
req.send_request(options)
end
- # Returns a list of all grants for which the grant's
- # `RetiringPrincipal` matches the one specified.
+ # Adds or edits tags on a [customer managed key][1].
#
- # A typical use is to list all grants that you are able to retire. To
- # retire a grant, use RetireGrant.
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the KMS
+ # key. For details, see [ABAC for KMS][2] in the *Key Management Service
+ # Developer Guide*.
#
- # @option params [Integer] :limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # </note>
#
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to 50.
+ # Each tag consists of a tag key and a tag value, both of which are
+ # case-sensitive strings. The tag value can be an empty (null) string.
+ # To add a tag, specify a new tag key and a tag value. To edit a tag,
+ # specify an existing tag key and a new tag value.
#
- # @option params [String] :marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # You can use this operation to tag a [customer managed key][1], but you
+ # cannot tag an [Amazon Web Services managed key][3], an [Amazon Web
+ # Services owned key][4], a [custom key store][5], or an [alias][6].
#
- # @option params [required, String] :retiring_principal
- # The retiring principal for which to list grants.
+ # You can also add tags to a KMS key while creating it (CreateKey) or
+ # replicating it (ReplicateKey).
#
- # To specify the retiring principal, use the [Amazon Resource Name
- # (ARN)][1] of an AWS principal. Valid AWS principals include AWS
- # accounts (root), IAM users, federated users, and assumed role users.
- # For examples of the ARN syntax for specifying a principal, see [AWS
- # Identity and Access Management (IAM)][2] in the Example ARNs section
- # of the *Amazon Web Services General Reference*.
+ # For information about using tags in KMS, see [Tagging keys][7]. For
+ # general information about tags, including the format and syntax, see
+ # [Tagging Amazon Web Services resources][8] in the *Amazon Web Services
+ # General Reference*.
#
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][9] in the *Key
+ # Management Service Developer Guide*.
#
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # **Required permissions**: [kms:TagResource][10] (key policy)
#
- # @return [Types::ListGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # **Related operations**
#
- # * {Types::ListGrantsResponse#grants #grants} => Array<Types::GrantListEntry>
- # * {Types::ListGrantsResponse#next_marker #next_marker} => String
- # * {Types::ListGrantsResponse#truncated #truncated} => Boolean
+ # * CreateKey
#
+ # * ListResourceTags
#
- # @example Example: To list grants that the specified principal can retire
+ # * ReplicateKey
#
- # # The following example lists the grants that the specified principal (identity) can retire.
+ # * UntagResource
#
- # resp = client.list_retirable_grants({
- # retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole", # The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of an AWS principal such as an AWS account (root), IAM user, federated user, or assumed role user.
- # })
#
- # resp.to_h outputs the following:
- # {
- # grants: [
- # {
- # creation_date: Time.parse("2016-12-07T11:09:35-08:00"),
- # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
- # grantee_principal: "arn:aws:iam::111122223333:role/ExampleRole",
- # issuing_account: "arn:aws:iam::444455556666:root",
- # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- # operations: [
- # "Decrypt",
- # "Encrypt",
- # ],
- # retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole",
- # },
- # ], # A list of grants that the specified principal can retire.
- # truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
- # }
#
- # @example Request syntax with placeholder values
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
+ # [8]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
- # resp = client.list_retirable_grants({
- # limit: 1,
- # marker: "MarkerType",
- # retiring_principal: "PrincipalIdType", # required
- # })
+ # @option params [required, String] :key_id
+ # Identifies a customer managed key in the account and Region.
#
- # @example Response structure
+ # Specify the key ID or key ARN of the KMS key.
#
- # resp.grants #=> Array
- # resp.grants[0].key_id #=> String
- # resp.grants[0].grant_id #=> String
- # resp.grants[0].name #=> String
- # resp.grants[0].creation_date #=> Time
- # resp.grants[0].grantee_principal #=> String
- # resp.grants[0].retiring_principal #=> String
- # resp.grants[0].issuing_account #=> String
- # resp.grants[0].operations #=> Array
- # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "CreateGrant", "RetireGrant", "DescribeKey"
- # resp.grants[0].constraints.encryption_context_subset #=> Hash
- # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
- # resp.grants[0].constraints.encryption_context_equals #=> Hash
- # resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
- # resp.next_marker #=> String
- # resp.truncated #=> Boolean
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # @option params [required, Array<Types::Tag>] :tags
+ # One or more tags. Each tag consists of a tag key and a tag value. The
+ # tag value can be an empty (null) string.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
+ #
+ # You cannot have more than one tag on a KMS key with the same tag key.
+ # If you specify an existing tag key with a different tag value, KMS
+ # replaces the current tag value with the specified one.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants AWS API Documentation
#
- # @overload list_retirable_grants(params = {})
- # @param [Hash] params ({})
- def list_retirable_grants(params = {}, options = {})
- req = build_request(:list_retirable_grants, params)
- req.send_request(options)
- end
-
- # Attaches a key policy to the specified customer master key (CMK). You
- # cannot perform this operation on a CMK in a different AWS account.
+ # @example Example: To tag a KMS key
#
- # For more information about key policies, see [Key Policies][1] in the
- # *AWS Key Management Service Developer Guide*.
+ # # The following example tags a KMS key.
+ #
+ # resp = client.tag_resource({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
+ # tags: [
+ # {
+ # tag_key: "Purpose",
+ # tag_value: "Test",
+ # },
+ # ], # A list of tags.
+ # })
#
+ # @example Request syntax with placeholder values
#
+ # resp = client.tag_resource({
+ # key_id: "KeyIdType", # required
+ # tags: [ # required
+ # {
+ # tag_key: "TagKeyType", # required
+ # tag_value: "TagValueType", # required
+ # },
+ # ],
+ # })
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource AWS API Documentation
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # @overload tag_resource(params = {})
+ # @param [Hash] params ({})
+ def tag_resource(params = {}, options = {})
+ req = build_request(:tag_resource, params)
+ req.send_request(options)
+ end
+
+ # Deletes tags from a [customer managed key][1]. To delete a tag,
+ # specify the tag key and the KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the KMS
+ # key. For details, see [ABAC for KMS][2] in the *Key Management Service
+ # Developer Guide*.
#
- # For example:
+ # </note>
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # When it succeeds, the `UntagResource` operation doesn't return any
+ # output. Also, if the specified tag key isn't found on the KMS key, it
+ # doesn't throw an exception or return a response. To confirm that the
+ # operation worked, use the ListResourceTags operation.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # For information about using tags in KMS, see [Tagging keys][3]. For
+ # general information about tags, including the format and syntax, see
+ # [Tagging Amazon Web Services resources][4] in the *Amazon Web Services
+ # General Reference*.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][5] in the *Key
+ # Management Service Developer Guide*.
#
- # @option params [required, String] :policy_name
- # The name of the key policy. The only valid value is `default`.
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # @option params [required, String] :policy
- # The key policy to attach to the CMK.
+ # **Required permissions**: [kms:UntagResource][6] (key policy)
#
- # The key policy must meet the following criteria:
+ # **Related operations**
#
- # * If you don't set `BypassPolicyLockoutSafetyCheck` to true, the key
- # policy must allow the principal that is making the `PutKeyPolicy`
- # request to make a subsequent `PutKeyPolicy` request on the CMK. This
- # reduces the risk that the CMK becomes unmanageable. For more
- # information, refer to the scenario in the [Default Key Policy][1]
- # section of the *AWS Key Management Service Developer Guide*.
+ # * CreateKey
#
- # * Each statement in the key policy must contain one or more
- # principals. The principals in the key policy must exist and be
- # visible to AWS KMS. When you create a new AWS principal (for
- # example, an IAM user or role), you might need to enforce a delay
- # before including the new principal in a key policy because the new
- # principal might not be immediately visible to AWS KMS. For more
- # information, see [Changes that I make are not always immediately
- # visible][2] in the *AWS Identity and Access Management User Guide*.
+ # * ListResourceTags
#
- # The key policy size limit is 32 kilobytes (32768 bytes).
+ # * ReplicateKey
#
+ # * TagResource
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
#
- # @option params [Boolean] :bypass_policy_lockout_safety_check
- # A flag to indicate whether to bypass the key policy lockout safety
- # check.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
- # Setting this value to true increases the risk that the CMK becomes
- # unmanageable. Do not set this value to true indiscriminately.
+ # @option params [required, String] :key_id
+ # Identifies the KMS key from which you are removing tags.
#
- # For more information, refer to the scenario in the [Default Key
- # Policy][1] section in the *AWS Key Management Service Developer
- # Guide*.
+ # Specify the key ID or key ARN of the KMS key.
#
- # Use this parameter only when you intend to prevent the principal that
- # is making the request from making a subsequent `PutKeyPolicy` request
- # on the CMK.
+ # For example:
#
- # The default value is false.
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
+ # @option params [required, Array<String>] :tag_keys
+ # One or more tag keys. Specify only the tag keys, not the tag values.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To attach a key policy to a customer master key (CMK)
+ # @example Example: To remove tags from a KMS key
#
- # # The following example attaches a key policy to the specified CMK.
+ # # The following example removes tags from a KMS key.
#
- # resp = client.put_key_policy({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # policy: "{\"Version\":\"2012-10-17\",\"Id\":\"custom-policy-2016-12-07\",\"Statement\":[{\"Sid\":\"EnableIAMUserPermissions\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"kms:*\",\"Resource\":\"*\"},{\"Sid\":\"AllowaccessforKeyAdministrators\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:user/ExampleAdminUser\",\"arn:aws:iam::111122223333:role/ExampleAdminRole\"]},\"Action\":[\"kms:Create*\",\"kms:Describe*\",\"kms:Enable*\",\"kms:List*\",\"kms:Put*\",\"kms:Update*\",\"kms:Revoke*\",\"kms:Disable*\",\"kms:Get*\",\"kms:Delete*\",\"kms:ScheduleKeyDeletion\",\"kms:CancelKeyDeletion\"],\"Resource\":\"*\"},{\"Sid\":\"Allowuseofthekey\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:Encrypt\",\"kms:Decrypt\",\"kms:ReEncrypt*\",\"kms:GenerateDataKey*\",\"kms:DescribeKey\"],\"Resource\":\"*\"},{\"Sid\":\"Allowattachmentofpersistentresources\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:CreateGrant\",\"kms:ListGrants\",\"kms:RevokeGrant\"],\"Resource\":\"*\",\"Condition\":{\"Bool\":{\"kms:GrantIsForAWSResource\":\"true\"}}}]}", # The key policy document.
- # policy_name: "default", # The name of the key policy.
+ # resp = client.untag_resource({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose tags you are removing.
+ # tag_keys: [
+ # "Purpose",
+ # "CostCenter",
+ # ], # A list of tag keys. Provide only the tag keys, not the tag values.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.put_key_policy({
+ # resp = client.untag_resource({
# key_id: "KeyIdType", # required
- # policy_name: "PolicyNameType", # required
- # policy: "PolicyType", # required
- # bypass_policy_lockout_safety_check: false,
+ # tag_keys: ["TagKeyType"], # required
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource AWS API Documentation
#
- # @overload put_key_policy(params = {})
+ # @overload untag_resource(params = {})
# @param [Hash] params ({})
- def put_key_policy(params = {}, options = {})
- req = build_request(:put_key_policy, params)
+ def untag_resource(params = {}, options = {})
+ req = build_request(:untag_resource, params)
req.send_request(options)
end
- # Encrypts data on the server side with a new customer master key (CMK)
- # without exposing the plaintext of the data on the client side. The
- # data is first decrypted and then reencrypted. You can also use this
- # operation to change the encryption context of a ciphertext.
+ # Associates an existing KMS alias with a different KMS key. Each alias
+ # is associated with only one KMS key at a time, although a KMS key can
+ # have multiple aliases. The alias and the KMS key must be in the same
+ # Amazon Web Services account and Region.
#
- # You can reencrypt data using CMKs in different AWS accounts.
+ # <note markdown="1"> Adding, deleting, or updating an alias can allow or deny permission to
+ # the KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
#
- # Unlike other operations, `ReEncrypt` is authorized twice, once as
- # `ReEncryptFrom` on the source CMK and once as `ReEncryptTo` on the
- # destination CMK. We recommend that you include the `"kms:ReEncrypt*"`
- # permission in your [key policies][1] to permit reencryption from or to
- # the CMK. This permission is automatically included in the key policy
- # when you create a CMK through the console. But you must include it
- # manually when you create a CMK programmatically or when you set a key
- # policy with the PutKeyPolicy operation.
+ # </note>
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # The current and new KMS key must be the same type (both symmetric or
+ # both asymmetric or both HMAC), and they must have the same key usage.
+ # This restriction prevents errors in code that uses aliases. If you
+ # must assign an alias to a different type of KMS key, use DeleteAlias
+ # to delete the old alias and CreateAlias to create a new alias.
#
+ # You cannot use `UpdateAlias` to change an alias name. To change an
+ # alias name, use DeleteAlias to delete the old alias and CreateAlias to
+ # create a new alias.
#
+ # Because an alias is not a property of a KMS key, you can create,
+ # update, and delete the aliases of a KMS key without affecting the KMS
+ # key. Also, aliases do not appear in the response from the DescribeKey
+ # operation. To get the aliases of all KMS keys in the account, use the
+ # ListAliases operation.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][2] in the *Key
+ # Management Service Developer Guide*.
#
- # @option params [required, String, IO] :ciphertext_blob
- # Ciphertext of the data to reencrypt.
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # @option params [Hash<String,String>] :source_encryption_context
- # Encryption context used to encrypt and decrypt the data specified in
- # the `CiphertextBlob` parameter.
+ # **Required permissions**
#
- # @option params [required, String] :destination_key_id
- # A unique identifier for the CMK that is used to reencrypt the data.
+ # * [kms:UpdateAlias][3] on the alias (IAM policy).
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must use
- # the key ARN or alias ARN.
+ # * [kms:UpdateAlias][3] on the current KMS key (key policy).
#
- # For example:
+ # * [kms:UpdateAlias][3] on the new KMS key (key policy).
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # For details, see [Controlling access to aliases][4] in the *Key
+ # Management Service Developer Guide*.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # **Related operations:**
#
- # * Alias name: `alias/ExampleAlias`
+ # * CreateAlias
#
- # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ # * DeleteAlias
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
- # To get the alias name and alias ARN, use ListAliases.
+ # * ListAliases
#
- # @option params [Hash<String,String>] :destination_encryption_context
- # Encryption context to use when the data is reencrypted.
#
- # @option params [Array<String>] :grant_tokens
- # A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access
#
+ # @option params [required, String] :alias_name
+ # Identifies the alias that is changing its KMS key. This value must
+ # begin with `alias/` followed by the alias name, such as
+ # `alias/ExampleAlias`. You cannot use `UpdateAlias` to change the alias
+ # name.
#
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # @option params [required, String] :target_key_id
+ # Identifies the [customer managed key][1] to associate with the alias.
+ # You don't have permission to associate an alias with an [Amazon Web
+ # Services managed key][2].
#
- # @return [Types::ReEncryptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # The KMS key must be in the same Amazon Web Services account and Region
+ # as the alias. Also, the new target KMS key must be the same type as
+ # the current target KMS key (both symmetric or both asymmetric or both
+ # HMAC) and they must have the same key usage.
#
- # * {Types::ReEncryptResponse#ciphertext_blob #ciphertext_blob} => String
- # * {Types::ReEncryptResponse#source_key_id #source_key_id} => String
- # * {Types::ReEncryptResponse#key_id #key_id} => String
+ # Specify the key ID or key ARN of the KMS key.
#
+ # For example:
#
- # @example Example: To reencrypt data
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # # The following example reencrypts data with the specified CMK.
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # resp = client.re_encrypt({
- # ciphertext_blob: "<binary data>", # The data to reencrypt.
- # destination_key_id: "0987dcba-09fe-87dc-65ba-ab0987654321", # The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
- # })
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # resp.to_h outputs the following:
- # {
- # ciphertext_blob: "<binary data>", # The reencrypted data.
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The ARN of the CMK that was used to reencrypt the data.
- # source_key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to originally encrypt the data.
- # }
+ # To verify that the alias is mapped to the correct KMS key, use
+ # ListAliases.
#
- # @example Request syntax with placeholder values
#
- # resp = client.re_encrypt({
- # ciphertext_blob: "data", # required
- # source_encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # destination_key_id: "KeyIdType", # required
- # destination_encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ #
+ # @example Example: To update an alias
+ #
+ # # The following example updates the specified alias to refer to the specified KMS key.
+ #
+ # resp = client.update_alias({
+ # alias_name: "alias/ExampleAlias", # The alias to update.
+ # target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
- # @example Response structure
+ # @example Request syntax with placeholder values
#
- # resp.ciphertext_blob #=> String
- # resp.source_key_id #=> String
- # resp.key_id #=> String
+ # resp = client.update_alias({
+ # alias_name: "AliasNameType", # required
+ # target_key_id: "KeyIdType", # required
+ # })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias AWS API Documentation
#
- # @overload re_encrypt(params = {})
+ # @overload update_alias(params = {})
# @param [Hash] params ({})
- def re_encrypt(params = {}, options = {})
- req = build_request(:re_encrypt, params)
+ def update_alias(params = {}, options = {})
+ req = build_request(:update_alias, params)
req.send_request(options)
end
- # Retires a grant. To clean up, you can retire a grant when you're done
- # using it. You should revoke a grant when you intend to actively deny
- # operations that depend on it. The following are permitted to call this
- # API:
+ # Changes the properties of a custom key store. You can use this
+ # operation to change the properties of an CloudHSM key store or an
+ # external key store.
+ #
+ # Use the required `CustomKeyStoreId` parameter to identify the custom
+ # key store. Use the remaining optional parameters to change its
+ # properties. This operation does not return any property values. To
+ # verify the updated property values, use the DescribeCustomKeyStores
+ # operation.
#
- # * The AWS account (root user) under which the grant was created
+ # This operation is part of the [custom key stores][1] feature in KMS,
+ # which combines the convenience and extensive integration of KMS with
+ # the isolation and control of a key store that you own and manage.
+ #
+ # When updating the properties of an external key store, verify that the
+ # updated settings connect your key store, via the external key store
+ # proxy, to the same external key manager as the previous settings, or
+ # to a backup or snapshot of the external key manager with the same
+ # cryptographic keys. If the updated connection settings fail, you can
+ # fix them and retry, although an extended delay might disrupt Amazon
+ # Web Services services. However, if KMS permanently loses its access to
+ # cryptographic keys, ciphertext encrypted under those keys is
+ # unrecoverable.
+ #
+ # <note markdown="1"> For external key stores:
+ #
+ # Some external key managers provide a simpler method for updating an
+ # external key store. For details, see your external key manager
+ # documentation.
+ #
+ # When updating an external key store in the KMS console, you can upload
+ # a JSON-based proxy configuration file with the desired values. You
+ # cannot upload the proxy configuration file to the
+ # `UpdateCustomKeyStore` operation. However, you can use the file to
+ # help you determine the correct values for the `UpdateCustomKeyStore`
+ # parameters.
#
- # * The `RetiringPrincipal`, if present in the grant
+ # </note>
#
- # * The `GranteePrincipal`, if `RetireGrant` is an operation specified
- # in the grant
+ # For an CloudHSM key store, you can use this operation to change the
+ # custom key store friendly name (`NewCustomKeyStoreName`), to tell KMS
+ # about a change to the `kmsuser` crypto user password
+ # (`KeyStorePassword`), or to associate the custom key store with a
+ # different, but related, CloudHSM cluster (`CloudHsmClusterId`). To
+ # update any property of an CloudHSM key store, the `ConnectionState` of
+ # the CloudHSM key store must be `DISCONNECTED`.
+ #
+ # For an external key store, you can use this operation to change the
+ # custom key store friendly name (`NewCustomKeyStoreName`), or to tell
+ # KMS about a change to the external key store proxy authentication
+ # credentials (`XksProxyAuthenticationCredential`), connection method
+ # (`XksProxyConnectivity`), external proxy endpoint
+ # (`XksProxyUriEndpoint`) and path (`XksProxyUriPath`). For external key
+ # stores with an `XksProxyConnectivity` of `VPC_ENDPOINT_SERVICE`, you
+ # can also update the Amazon VPC endpoint service name
+ # (`XksProxyVpcEndpointServiceName`). To update most properties of an
+ # external key store, the `ConnectionState` of the external key store
+ # must be `DISCONNECTED`. However, you can update the
+ # `CustomKeyStoreName`, `XksProxyAuthenticationCredential`, and
+ # `XksProxyUriPath` of an external key store when it is in the CONNECTED
+ # or DISCONNECTED state.
+ #
+ # If your update requires a `DISCONNECTED` state, before using
+ # `UpdateCustomKeyStore`, use the DisconnectCustomKeyStore operation to
+ # disconnect the custom key store. After the `UpdateCustomKeyStore`
+ # operation completes, use the ConnectCustomKeyStore to reconnect the
+ # custom key store. To find the `ConnectionState` of the custom key
+ # store, use the DescribeCustomKeyStores operation.
#
- # You must identify the grant to retire by its grant token or by a
- # combination of the grant ID and the Amazon Resource Name (ARN) of the
- # customer master key (CMK). A grant token is a unique variable-length
- # base64-encoded string. A grant ID is a 64 character unique identifier
- # of a grant. The CreateGrant operation returns both.
#
- # @option params [String] :grant_token
- # Token that identifies the grant to be retired.
#
- # @option params [String] :key_id
- # The Amazon Resource Name (ARN) of the CMK associated with the grant.
+ # Before updating the custom key store, verify that the new values allow
+ # KMS to connect the custom key store to its backing key store. For
+ # example, before you change the `XksProxyUriPath` value, verify that
+ # the external key store proxy is reachable at the new path.
#
- # For example:
- # `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # If the operation succeeds, it returns a JSON object with no
+ # properties.
#
- # @option params [String] :grant_id
- # Unique identifier of the grant to retire. The grant ID is returned in
- # the response to a `CreateGrant` operation.
+ # **Cross-account use**: No. You cannot perform this operation on a
+ # custom key store in a different Amazon Web Services account.
#
- # * Grant ID Example -
- # 0123456789012345678901234567890123456789012345678901234567890123
+ # **Required permissions**: [kms:UpdateCustomKeyStore][2] (IAM policy)
#
- # ^
+ # **Related operations:**
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # * ConnectCustomKeyStore
#
+ # * CreateCustomKeyStore
#
- # @example Example: To retire a grant
+ # * DeleteCustomKeyStore
#
- # # The following example retires a grant.
+ # * DescribeCustomKeyStores
#
- # resp = client.retire_grant({
- # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to retire.
- # key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the customer master key (CMK) associated with the grant.
- # })
+ # * DisconnectCustomKeyStore
#
- # @example Request syntax with placeholder values
#
- # resp = client.retire_grant({
- # grant_token: "GrantTokenType",
- # key_id: "KeyIdType",
- # grant_id: "GrantIdType",
- # })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
- # @overload retire_grant(params = {})
- # @param [Hash] params ({})
- def retire_grant(params = {}, options = {})
- req = build_request(:retire_grant, params)
- req.send_request(options)
- end
-
- # Revokes the specified grant for the specified customer master key
- # (CMK). You can revoke a grant to actively deny operations that depend
- # on it.
+ # @option params [required, String] :custom_key_store_id
+ # Identifies the custom key store that you want to update. Enter the ID
+ # of the custom key store. To find the ID of a custom key store, use the
+ # DescribeCustomKeyStores operation.
#
- # To perform this operation on a CMK in a different AWS account, specify
- # the key ARN in the value of the `KeyId` parameter.
+ # @option params [String] :new_custom_key_store_name
+ # Changes the friendly name of the custom key store to the value that
+ # you specify. The custom key store name must be unique in the Amazon
+ # Web Services account.
#
- # @option params [required, String] :key_id
- # A unique identifier for the customer master key associated with the
- # grant.
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # To change this value, an CloudHSM key store must be disconnected. An
+ # external key store can be connected or disconnected.
#
- # For example:
+ # @option params [String] :key_store_password
+ # Enter the current password of the `kmsuser` crypto user (CU) in the
+ # CloudHSM cluster that is associated with the custom key store. This
+ # parameter is valid only for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # This parameter tells KMS the current password of the `kmsuser` crypto
+ # user (CU). It does not set or change the password of any users in the
+ # CloudHSM cluster.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # To change this value, the CloudHSM key store must be disconnected.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # @option params [String] :cloud_hsm_cluster_id
+ # Associates the custom key store with a related CloudHSM cluster. This
+ # parameter is valid only for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
#
- # @option params [required, String] :grant_id
- # Identifier of the grant to be revoked.
+ # Enter the cluster ID of the cluster that you used to create the custom
+ # key store or a cluster that shares a backup history and has the same
+ # cluster certificate as the original cluster. You cannot use this
+ # parameter to associate a custom key store with an unrelated cluster.
+ # In addition, the replacement cluster must [fulfill the
+ # requirements][1] for a cluster associated with a custom key store. To
+ # view the cluster certificate of a cluster, use the
+ # [DescribeClusters][2] operation.
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # To change this value, the CloudHSM key store must be disconnected.
#
#
- # @example Example: To revoke a grant
#
- # # The following example revokes a grant.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
+ # [2]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html
#
- # resp = client.revoke_grant({
- # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to revoke.
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # })
+ # @option params [String] :xks_proxy_uri_endpoint
+ # Changes the URI endpoint that KMS uses to connect to your external key
+ # store proxy (XKS proxy). This parameter is valid only for custom key
+ # stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
#
- # @example Request syntax with placeholder values
+ # For external key stores with an `XksProxyConnectivity` value of
+ # `PUBLIC_ENDPOINT`, the protocol must be HTTPS.
#
- # resp = client.revoke_grant({
- # key_id: "KeyIdType", # required
- # grant_id: "GrantIdType", # required
- # })
+ # For external key stores with an `XksProxyConnectivity` value of
+ # `VPC_ENDPOINT_SERVICE`, specify `https://` followed by the private DNS
+ # name associated with the VPC endpoint service. Each external key store
+ # must use a different private DNS name.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant AWS API Documentation
+ # The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
#
- # @overload revoke_grant(params = {})
- # @param [Hash] params ({})
- def revoke_grant(params = {}, options = {})
- req = build_request(:revoke_grant, params)
- req.send_request(options)
- end
-
- # Schedules the deletion of a customer master key (CMK). You may provide
- # a waiting period, specified in days, before deletion occurs. If you do
- # not provide a waiting period, the default period of 30 days is used.
- # When this operation is successful, the key state of the CMK changes to
- # `PendingDeletion`. Before the waiting period ends, you can use
- # CancelKeyDeletion to cancel the deletion of the CMK. After the waiting
- # period ends, AWS KMS deletes the CMK and all AWS KMS data associated
- # with it, including all aliases that refer to it.
- #
- # Deleting a CMK is a destructive and potentially dangerous operation.
- # When a CMK is deleted, all data that was encrypted under the CMK is
- # unrecoverable. To prevent the use of a CMK without deleting it, use
- # DisableKey.
- #
- # If you schedule deletion of a CMK from a [custom key store][1], when
- # the waiting period expires, `ScheduleKeyDeletion` deletes the CMK from
- # AWS KMS. Then AWS KMS makes a best effort to delete the key material
- # from the associated AWS CloudHSM cluster. However, you might need to
- # manually [delete the orphaned key material][2] from the cluster and
- # its backups.
- #
- # You cannot perform this operation on a CMK in a different AWS account.
- #
- # For more information about scheduling a CMK for deletion, see
- # [Deleting Customer Master Keys][3] in the *AWS Key Management Service
- # Developer Guide*.
+ # To change this value, the external key store must be disconnected.
+ #
+ # @option params [String] :xks_proxy_uri_path
+ # Changes the base path to the proxy APIs for this external key store.
+ # To find this value, see the documentation for your external key
+ # manager and external key store proxy (XKS proxy). This parameter is
+ # valid only for custom key stores with a `CustomKeyStoreType` of
+ # `EXTERNAL_KEY_STORE`.
+ #
+ # The value must start with `/` and must end with `/kms/xks/v1`, where
+ # `v1` represents the version of the KMS external key store proxy API.
+ # You can include an optional prefix between the required elements such
+ # as `/example/kms/xks/v1`.
+ #
+ # The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
+ #
+ # You can change this value when the external key store is connected or
+ # disconnected.
+ #
+ # @option params [String] :xks_proxy_vpc_endpoint_service_name
+ # Changes the name that KMS uses to identify the Amazon VPC endpoint
+ # service for your external key store proxy (XKS proxy). This parameter
+ # is valid when the `CustomKeyStoreType` is `EXTERNAL_KEY_STORE` and the
+ # `XksProxyConnectivity` is `VPC_ENDPOINT_SERVICE`.
+ #
+ # To change this value, the external key store must be disconnected.
+ #
+ # @option params [Types::XksProxyAuthenticationCredentialType] :xks_proxy_authentication_credential
+ # Changes the credentials that KMS uses to sign requests to the external
+ # key store proxy (XKS proxy). This parameter is valid only for custom
+ # key stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # You must specify both the `AccessKeyId` and `SecretAccessKey` value in
+ # the authentication credential, even if you are only updating one
+ # value.
+ #
+ # This parameter doesn't establish or change your authentication
+ # credentials on the proxy. It just tells KMS the credential that you
+ # established with your external key store proxy. For example, if you
+ # rotate the credential on your external key store proxy, you can use
+ # this parameter to update the credential in KMS.
+ #
+ # You can change this value when the external key store is connected or
+ # disconnected.
+ #
+ # @option params [String] :xks_proxy_connectivity
+ # Changes the connectivity setting for the external key store. To
+ # indicate that the external key store proxy uses a Amazon VPC endpoint
+ # service to communicate with KMS, specify `VPC_ENDPOINT_SERVICE`.
+ # Otherwise, specify `PUBLIC_ENDPOINT`.
+ #
+ # If you change the `XksProxyConnectivity` to `VPC_ENDPOINT_SERVICE`,
+ # you must also change the `XksProxyUriEndpoint` and add an
+ # `XksProxyVpcEndpointServiceName` value.
+ #
+ # If you change the `XksProxyConnectivity` to `PUBLIC_ENDPOINT`, you
+ # must also change the `XksProxyUriEndpoint` and specify a null or empty
+ # string for the `XksProxyVpcEndpointServiceName` value.
+ #
+ # To change this value, the external key store must be disconnected.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][4]
- # in the *AWS Key Management Service Developer Guide*.
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
+ # @example Example: To edit the friendly name of a custom key store
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html
- # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # # This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does
+ # # not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.
#
- # @option params [required, String] :key_id
- # The unique identifier of the customer master key (CMK) to delete.
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store that you are updating.
+ # new_custom_key_store_name: "DevelopmentKeys", # A new friendly name for the custom key store.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # }
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # @example Example: To edit the password of an AWS CloudHSM key store
#
- # For example:
+ # # This example tells AWS KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with
+ # # the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return
+ # # any data.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store that you are updating.
+ # key_store_password: "ExamplePassword", # The password for the kmsuser crypto user in the CloudHSM cluster.
+ # })
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # resp.to_h outputs the following:
+ # {
+ # }
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # @example Example: To associate the custom key store with a different, but related, AWS CloudHSM cluster.
#
- # @option params [Integer] :pending_window_in_days
- # The waiting period, specified in number of days. After the waiting
- # period ends, AWS KMS deletes the customer master key (CMK).
+ # # This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster,
+ # # such as a different backup of the same cluster. This operation does not return any data. To verify that the operation
+ # # worked, use the DescribeCustomKeyStores operation.
#
- # This value is optional. If you include a value, it must be between 7
- # and 30, inclusive. If you do not include a value, it defaults to 30.
+ # resp = client.update_custom_key_store({
+ # cloud_hsm_cluster_id: "cluster-234abcdefABC", # The ID of the AWS CloudHSM cluster that you want to associate with the custom key store. This cluster must be related to the original CloudHSM cluster for this key store.
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store that you are updating.
+ # })
#
- # @return [Types::ScheduleKeyDeletionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # resp.to_h outputs the following:
+ # {
+ # }
#
- # * {Types::ScheduleKeyDeletionResponse#key_id #key_id} => String
- # * {Types::ScheduleKeyDeletionResponse#deletion_date #deletion_date} => Time
+ # @example Example: To update the proxy authentication credential of an external key store
+ #
+ # # To update the proxy authentication credential for your external key store, specify both the
+ # # <code>RawSecretAccessKey</code> and the <code>AccessKeyId</code>, even if you are changing only one of the values. You
+ # # can use this feature to fix an invalid credential or to change the credential when the external key store proxy rotates
+ # # it.
#
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # Identifies the custom key store
+ # xks_proxy_authentication_credential: {
+ # access_key_id: "ABCDE12345670EXAMPLE",
+ # raw_secret_access_key: "DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=",
+ # }, # Specifies the values in the proxy authentication credential
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # }
#
- # @example Example: To schedule a customer master key (CMK) for deletion
+ # @example Example: To edit the proxy URI path of an external key store.
#
- # # The following example schedules the specified CMK for deletion.
+ # # This example updates the proxy URI path for an external key store
#
- # resp = client.schedule_key_deletion({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # pending_window_in_days: 7, # The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK.
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # The ID of the custom key store that you are updating
+ # xks_proxy_uri_path: "/new-path/kms/xks/v1", # The URI path to the external key store proxy APIs
# })
#
# resp.to_h outputs the following:
# {
- # deletion_date: Time.parse("2016-12-17T16:00:00-08:00"), # The date and time after which AWS KMS deletes the CMK.
- # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that is scheduled for deletion.
# }
#
- # @example Request syntax with placeholder values
+ # @example Example: To update the proxy connectivity of an external key store to VPC_ENDPOINT_SERVICE
#
- # resp = client.schedule_key_deletion({
- # key_id: "KeyIdType", # required
- # pending_window_in_days: 1,
+ # # To change the external key store proxy connectivity option from public endpoint connectivity to VPC endpoint service
+ # # connectivity, in addition to changing the <code>XksProxyConnectivity</code> value, you must change the
+ # # <code>XksProxyUriEndpoint</code> value to reflect the private DNS name associated with the VPC endpoint service. You
+ # # must also add an <code>XksProxyVpcEndpointServiceName</code> value.
+ #
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "cks-1234567890abcdef0", # Identifies the custom key store
+ # xks_proxy_connectivity: "VPC_ENDPOINT_SERVICE", # Specifies the connectivity option
+ # xks_proxy_uri_endpoint: "https://myproxy-private.xks.example.com", # Specifies the URI endpoint that AWS KMS uses when communicating with the external key store proxy
+ # xks_proxy_vpc_endpoint_service_name: "com.amazonaws.vpce.us-east-1.vpce-svc-example", # Specifies the name of the VPC endpoint service that the proxy uses for communication
# })
#
- # @example Response structure
+ # resp.to_h outputs the following:
+ # {
+ # }
#
- # resp.key_id #=> String
- # resp.deletion_date #=> Time
+ # @example Request syntax with placeholder values
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion AWS API Documentation
+ # resp = client.update_custom_key_store({
+ # custom_key_store_id: "CustomKeyStoreIdType", # required
+ # new_custom_key_store_name: "CustomKeyStoreNameType",
+ # key_store_password: "KeyStorePasswordType",
+ # cloud_hsm_cluster_id: "CloudHsmClusterIdType",
+ # xks_proxy_uri_endpoint: "XksProxyUriEndpointType",
+ # xks_proxy_uri_path: "XksProxyUriPathType",
+ # xks_proxy_vpc_endpoint_service_name: "XksProxyVpcEndpointServiceNameType",
+ # xks_proxy_authentication_credential: {
+ # access_key_id: "XksProxyAuthenticationAccessKeyIdType", # required
+ # raw_secret_access_key: "XksProxyAuthenticationRawSecretAccessKeyType", # required
+ # },
+ # xks_proxy_connectivity: "PUBLIC_ENDPOINT", # accepts PUBLIC_ENDPOINT, VPC_ENDPOINT_SERVICE
+ # })
#
- # @overload schedule_key_deletion(params = {})
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStore AWS API Documentation
+ #
+ # @overload update_custom_key_store(params = {})
# @param [Hash] params ({})
- def schedule_key_deletion(params = {}, options = {})
- req = build_request(:schedule_key_deletion, params)
+ def update_custom_key_store(params = {}, options = {})
+ req = build_request(:update_custom_key_store, params)
req.send_request(options)
end
- # Adds or edits tags for a customer master key (CMK). You cannot perform
- # this operation on a CMK in a different AWS account.
+ # Updates the description of a KMS key. To see the description of a KMS
+ # key, use DescribeKey.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][1] in the *Key
+ # Management Service Developer Guide*.
#
- # Each tag consists of a tag key and a tag value. Tag keys and tag
- # values are both required, but tag values can be empty (null) strings.
+ # **Cross-account use**: No. You cannot perform this operation on a KMS
+ # key in a different Amazon Web Services account.
#
- # You can only use a tag key once for each CMK. If you use the tag key
- # again, AWS KMS replaces the current tag value with the specified
- # value.
+ # **Required permissions**: [kms:UpdateKeyDescription][2] (key policy)
#
- # For information about the rules that apply to tag keys and tag values,
- # see [User-Defined Tag Restrictions][1] in the *AWS Billing and Cost
- # Management User Guide*.
+ # **Related operations**
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # * CreateKey
#
+ # * DescribeKey
#
#
- # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
#
# @option params [required, String] :key_id
- # A unique identifier for the CMK you are tagging.
+ # Updates the description of the specified KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -3700,152 +9321,252 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # @option params [required, Array<Types::Tag>] :tags
- # One or more tags. Each tag consists of a tag key and a tag value.
+ # @option params [required, String] :description
+ # New description for the KMS key.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To tag a customer master key (CMK)
+ # @example Example: To update the description of a KMS key
#
- # # The following example tags a CMK.
+ # # The following example updates the description of the specified KMS key.
#
- # resp = client.tag_resource({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # tags: [
- # {
- # tag_key: "Purpose",
- # tag_value: "Test",
- # },
- # ], # A list of tags.
+ # resp = client.update_key_description({
+ # description: "Example description that indicates the intended use of this KMS key.", # The updated description.
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.tag_resource({
+ # resp = client.update_key_description({
# key_id: "KeyIdType", # required
- # tags: [ # required
- # {
- # tag_key: "TagKeyType", # required
- # tag_value: "TagValueType", # required
- # },
- # ],
+ # description: "DescriptionType", # required
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription AWS API Documentation
#
- # @overload tag_resource(params = {})
+ # @overload update_key_description(params = {})
# @param [Hash] params ({})
- def tag_resource(params = {}, options = {})
- req = build_request(:tag_resource, params)
+ def update_key_description(params = {}, options = {})
+ req = build_request(:update_key_description, params)
req.send_request(options)
end
- # Removes the specified tags from the specified customer master key
- # (CMK). You cannot perform this operation on a CMK in a different AWS
- # account.
+ # Changes the primary key of a multi-Region key.
+ #
+ # This operation changes the replica key in the specified Region to a
+ # primary key and changes the former primary key to a replica key. For
+ # example, suppose you have a primary key in `us-east-1` and a replica
+ # key in `eu-west-2`. If you run `UpdatePrimaryRegion` with a
+ # `PrimaryRegion` value of `eu-west-2`, the primary key is now the key
+ # in `eu-west-2`, and the key in `us-east-1` becomes a replica key. For
+ # details, see [Updating the primary Region][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # This operation supports *multi-Region keys*, an KMS feature that lets
+ # you create multiple interoperable KMS keys in different Amazon Web
+ # Services Regions. Because these KMS keys have the same key ID, key
+ # material, and other metadata, you can use them interchangeably to
+ # encrypt data in one Amazon Web Services Region and decrypt it in a
+ # different Amazon Web Services Region without re-encrypting the data or
+ # making a cross-Region call. For more information about multi-Region
+ # keys, see [Multi-Region keys in KMS][2] in the *Key Management Service
+ # Developer Guide*.
+ #
+ # The *primary key* of a multi-Region key is the source for properties
+ # that are always shared by primary and replica keys, including the key
+ # material, [key ID][3], [key spec][4], [key usage][5], [key material
+ # origin][6], and [automatic key rotation][7]. It's the only key that
+ # can be replicated. You cannot [delete the primary key][8] until all
+ # replica keys are deleted.
+ #
+ # The key ID and primary Region that you specify uniquely identify the
+ # replica key that will become the primary key. The primary Region must
+ # already have a replica key. This operation does not create a KMS key
+ # in the specified Region. To find the replica keys, use the DescribeKey
+ # operation on the primary key or any replica key. To create a replica
+ # key, use the ReplicateKey operation.
+ #
+ # You can run this operation while using the affected multi-Region keys
+ # in cryptographic operations. This operation should not delay,
+ # interrupt, or cause failures in cryptographic operations.
+ #
+ # Even after this operation completes, the process of updating the
+ # primary Region might still be in progress for a few more seconds.
+ # Operations such as `DescribeKey` might display both the old and new
+ # primary keys as replicas. The old and new primary keys have a
+ # transient key state of `Updating`. The original key state is restored
+ # when the update is complete. While the key state is `Updating`, you
+ # can use the keys in cryptographic operations, but you cannot replicate
+ # the new primary key or perform certain management operations, such as
+ # enabling or disabling these keys. For details about the `Updating` key
+ # state, see [Key states of KMS keys][9] in the *Key Management Service
+ # Developer Guide*.
#
- # To remove a tag, specify the tag key. To change the tag value of an
- # existing tag key, use TagResource.
+ # This operation does not return any output. To verify that primary key
+ # is changed, use the DescribeKey operation.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Cross-account use**: No. You cannot use this operation in a
+ # different Amazon Web Services account.
#
+ # **Required permissions**:
#
+ # * `kms:UpdatePrimaryRegion` on the current primary key (in the primary
+ # key's Region). Include this permission primary key's key policy.
+ #
+ # * `kms:UpdatePrimaryRegion` on the current replica key (in the replica
+ # key's Region). Include this permission in the replica key's key
+ # policy.
+ #
+ # **Related operations**
+ #
+ # * CreateKey
+ #
+ # * ReplicateKey
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage
+ # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin
+ # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
+ # [8]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html
+ # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
#
# @option params [required, String] :key_id
- # A unique identifier for the CMK from which you are removing tags.
+ # Identifies the current primary key. When the operation completes, this
+ # KMS key will be a replica key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of a multi-Region primary key.
#
# For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * Key ID: `mrk-1234abcd12ab34cd56ef1234567890ab`
#
# * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
- # @option params [required, Array<String>] :tag_keys
- # One or more tag keys. Specify only the tag keys, not the tag values.
+ # @option params [required, String] :primary_region
+ # The Amazon Web Services Region of the new primary key. Enter the
+ # Region ID, such as `us-east-1` or `ap-southeast-2`. There must be an
+ # existing replica key in this Region.
+ #
+ # When the operation completes, the multi-Region key in this Region will
+ # be the primary key.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
- # @example Example: To remove tags from a customer master key (CMK)
+ # @example Example: To update the primary Region of a multi-Region KMS key
#
- # # The following example removes tags from a CMK.
+ # # The following UpdatePrimaryRegion example changes the multi-Region replica key in the eu-central-1 Region to the primary
+ # # key. The current primary key in the us-west-1 Region becomes a replica key.
+ # # The KeyId parameter identifies the current primary key in the us-west-1 Region. The PrimaryRegion parameter indicates
+ # # the Region of the replica key that will become the new primary key.
+ # # This operation does not return any output. To verify that primary key is changed, use the DescribeKey operation.
#
- # resp = client.untag_resource({
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose tags you are removing.
- # tag_keys: [
- # "Purpose",
- # "CostCenter",
- # ], # A list of tag keys. Provide only the tag keys, not the tag values.
+ # resp = client.update_primary_region({
+ # key_id: "arn:aws:kms:us-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", # The current primary key.
+ # primary_region: "eu-central-1", # The Region of the replica key that will become the primary key.
# })
#
# @example Request syntax with placeholder values
#
- # resp = client.untag_resource({
+ # resp = client.update_primary_region({
# key_id: "KeyIdType", # required
- # tag_keys: ["TagKeyType"], # required
+ # primary_region: "RegionType", # required
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdatePrimaryRegion AWS API Documentation
#
- # @overload untag_resource(params = {})
+ # @overload update_primary_region(params = {})
# @param [Hash] params ({})
- def untag_resource(params = {}, options = {})
- req = build_request(:untag_resource, params)
+ def update_primary_region(params = {}, options = {})
+ req = build_request(:update_primary_region, params)
req.send_request(options)
end
- # Associates an existing alias with a different customer master key
- # (CMK). Each CMK can have multiple aliases, but the aliases must be
- # unique within the account and region. You cannot perform this
- # operation on an alias in a different AWS account.
+ # Verifies a digital signature that was generated by the Sign operation.
#
- # This operation works only on existing aliases. To change the alias of
- # a CMK to a new value, use CreateAlias to create a new alias and
- # DeleteAlias to delete the old alias.
#
- # Because an alias is not a property of a CMK, you can create, update,
- # and delete the aliases of a CMK without affecting the CMK. Also,
- # aliases do not appear in the response from the DescribeKey operation.
- # To get the aliases of all CMKs in the account, use the ListAliases
- # operation.
#
- # The alias name must begin with `alias/` followed by a name, such as
- # `alias/ExampleAlias`. It can contain only alphanumeric characters,
- # forward slashes (/), underscores (\_), and dashes (-). The alias name
- # cannot begin with `alias/aws/`. The `alias/aws/` prefix is reserved
- # for [AWS managed CMKs][1].
+ # Verification confirms that an authorized user signed the message with
+ # the specified KMS key and signing algorithm, and the message hasn't
+ # changed since it was signed. If the signature is verified, the value
+ # of the `SignatureValid` field in the response is `True`. If the
+ # signature verification fails, the `Verify` operation fails with an
+ # `KMSInvalidSignatureException` exception.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][2]
- # in the *AWS Key Management Service Developer Guide*.
+ # A digital signature is generated by using the private key in an
+ # asymmetric KMS key. The signature is verified by using the public key
+ # in the same asymmetric KMS key. For information about asymmetric KMS
+ # keys, see [Asymmetric KMS keys][1] in the *Key Management Service
+ # Developer Guide*.
#
+ # To use the `Verify` operation, specify the same asymmetric KMS key,
+ # message, and signing algorithm that were used to produce the
+ # signature. The message type does not need to be the same as the one
+ # used for signing, but it must indicate whether the value of the
+ # `Message` parameter should be hashed as part of the verification
+ # process.
+ #
+ # You can also verify the digital signature by using the public key of
+ # the KMS key outside of KMS. Use the GetPublicKey operation to download
+ # the public key in the asymmetric KMS key and then use the public key
+ # to verify the signature outside of KMS. The advantage of using the
+ # `Verify` operation is that it is performed within KMS. As a result,
+ # it's easy to call, the operation is performed within the FIPS
+ # boundary, it is logged in CloudTrail, and you can use key policy and
+ # IAM policy to determine who is authorized to use the KMS key to verify
+ # signatures.
+ #
+ # To verify a signature outside of KMS with an SM2 public key (China
+ # Regions only), you must specify the distinguishing ID. By default, KMS
+ # uses `1234567812345678` as the distinguishing ID. For more
+ # information, see [Offline verification with SM2 key pairs][2].
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][3] in the *Key
+ # Management Service Developer Guide*.
#
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # **Required permissions**: [kms:Verify][4] (key policy)
#
- # @option params [required, String] :alias_name
- # Specifies the name of the alias to change. This value must begin with
- # `alias/` followed by the alias name, such as `alias/ExampleAlias`.
+ # **Related operations**: Sign
#
- # @option params [required, String] :target_key_id
- # Unique identifier of the customer master key (CMK) to be mapped to the
- # alias. When the update operation completes, the alias will point to
- # this CMK.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String] :key_id
+ # Identifies the asymmetric KMS key that will be used to verify the
+ # signature. This must be the same KMS key that was used to generate the
+ # signature. If you specify a different KMS key, the signature
+ # verification fails.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify a
+ # KMS key in a different Amazon Web Services account, you must use the
+ # key ARN or alias ARN.
#
# For example:
#
@@ -3854,196 +9575,303 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
#
- # To verify that the alias is mapped to the correct CMK, use
- # ListAliases.
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
#
+ # @option params [required, String, StringIO, File] :message
+ # Specifies the message that was signed. You can submit a raw message of
+ # up to 4096 bytes, or a hash digest of the message. If you submit a
+ # digest, use the `MessageType` parameter with a value of `DIGEST`.
#
- # @example Example: To update an alias
+ # If the message specified here is different from the message that was
+ # signed, the signature verification fails. A message and its hash
+ # digest are considered to be the same message.
#
- # # The following example updates the specified alias to refer to the specified customer master key (CMK).
+ # @option params [String] :message_type
+ # Tells KMS whether the value of the `Message` parameter should be
+ # hashed as part of the signing algorithm. Use `RAW` for unhashed
+ # messages; use `DIGEST` for message digests, which are already hashed.
#
- # resp = client.update_alias({
- # alias_name: "alias/ExampleAlias", # The alias to update.
- # target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
- # })
+ # When the value of `MessageType` is `RAW`, KMS uses the standard
+ # signing algorithm, which begins with a hash function. When the value
+ # is `DIGEST`, KMS skips the hashing step in the signing algorithm.
#
- # @example Request syntax with placeholder values
+ # Use the `DIGEST` value only when the value of the `Message` parameter
+ # is a message digest. If you use the `DIGEST` value with an unhashed
+ # message, the security of the verification operation can be
+ # compromised.
#
- # resp = client.update_alias({
- # alias_name: "AliasNameType", # required
- # target_key_id: "KeyIdType", # required
- # })
+ # When the value of `MessageType`is `DIGEST`, the length of the
+ # `Message` value must match the length of hashed messages for the
+ # specified signing algorithm.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias AWS API Documentation
+ # You can submit a message digest and omit the `MessageType` or specify
+ # `RAW` so the digest is hashed again while signing. However, if the
+ # signed message is hashed once while signing, but twice while
+ # verifying, verification fails, even when the message hasn't changed.
#
- # @overload update_alias(params = {})
- # @param [Hash] params ({})
- def update_alias(params = {}, options = {})
- req = build_request(:update_alias, params)
- req.send_request(options)
- end
-
- # Changes the properties of a custom key store. Use the
- # `CustomKeyStoreId` parameter to identify the custom key store you want
- # to edit. Use the remaining parameters to change the properties of the
- # custom key store.
+ # The hashing algorithm in that `Verify` uses is based on the
+ # `SigningAlgorithm` value.
#
- # You can only update a custom key store that is disconnected. To
- # disconnect the custom key store, use DisconnectCustomKeyStore. To
- # reconnect the custom key store after the update completes, use
- # ConnectCustomKeyStore. To find the connection state of a custom key
- # store, use the DescribeCustomKeyStores operation.
+ # * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
+ # algorithm.
#
- # Use the parameters of `UpdateCustomKeyStore` to edit your keystore
- # settings.
+ # * Signing algorithms that end in SHA\_384 use the SHA\_384 hashing
+ # algorithm.
#
- # * Use the **NewCustomKeyStoreName** parameter to change the friendly
- # name of the custom key store to the value that you specify.
+ # * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
+ # algorithm.
#
+ # * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
+ # verification with SM2 key pairs][1].
#
#
- # * Use the **KeyStorePassword** parameter tell AWS KMS the current
- # password of the [ `kmsuser` crypto user (CU)][1] in the associated
- # AWS CloudHSM cluster. You can use this parameter to [fix connection
- # failures][2] that occur when AWS KMS cannot log into the associated
- # cluster because the `kmsuser` password has changed. This value does
- # not change the password in the AWS CloudHSM cluster.
#
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
#
+ # @option params [required, String, StringIO, File] :signature
+ # The signature that the `Sign` operation generated.
#
- # * Use the **CloudHsmClusterId** parameter to associate the custom key
- # store with a different, but related, AWS CloudHSM cluster. You can
- # use this parameter to repair a custom key store if its AWS CloudHSM
- # cluster becomes corrupted or is deleted, or when you need to create
- # or restore a cluster from a backup.
+ # @option params [required, String] :signing_algorithm
+ # The signing algorithm that was used to sign the message. If you submit
+ # a different algorithm, the signature verification fails.
#
- # If the operation succeeds, it returns a JSON object with no
- # properties.
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
#
- # This operation is part of the [Custom Key Store feature][3] feature in
- # AWS KMS, which combines the convenience and extensive integration of
- # AWS KMS with the isolation and control of a single-tenant key store.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password
- # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
#
- # @option params [required, String] :custom_key_store_id
- # Identifies the custom key store that you want to update. Enter the ID
- # of the custom key store. To find the ID of a custom key store, use the
- # DescribeCustomKeyStores operation.
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # @option params [String] :new_custom_key_store_name
- # Changes the friendly name of the custom key store to the value that
- # you specify. The custom key store name must be unique in the AWS
- # account.
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @option params [String] :key_store_password
- # Enter the current password of the `kmsuser` crypto user (CU) in the
- # AWS CloudHSM cluster that is associated with the custom key store.
#
- # This parameter tells AWS KMS the current password of the `kmsuser`
- # crypto user (CU). It does not set or change the password of any users
- # in the AWS CloudHSM cluster.
#
- # @option params [String] :cloud_hsm_cluster_id
- # Associates the custom key store with a related AWS CloudHSM cluster.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
#
- # Enter the cluster ID of the cluster that you used to create the custom
- # key store or a cluster that shares a backup history and has the same
- # cluster certificate as the original cluster. You cannot use this
- # parameter to associate a custom key store with an unrelated cluster.
- # In addition, the replacement cluster must [fulfill the
- # requirements][1] for a cluster associated with a custom key store. To
- # view the cluster certificate of a cluster, use the
- # [DescribeClusters][2] operation.
+ # @return [Types::VerifyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::VerifyResponse#key_id #key_id} => String
+ # * {Types::VerifyResponse#signature_valid #signature_valid} => Boolean
+ # * {Types::VerifyResponse#signing_algorithm #signing_algorithm} => String
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
- # [2]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html
+ # @example Example: To use an asymmetric KMS key to verify a digital signature
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ # # This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS
+ # # KMS.
+ #
+ # resp = client.verify({
+ # key_id: "alias/ECC_signing_key", # The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.
+ # message: "<message to be verified>", # The message that was signed.
+ # message_type: "RAW", # Indicates whether the message is RAW or a DIGEST.
+ # signature: "<binary data>", # The signature to be verified.
+ # signing_algorithm: "ECDSA_SHA_384", # The signing algorithm to be used to verify the signature.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the asymmetric KMS key that was used to verify the digital signature.
+ # signature_valid: true, # A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.
+ # signing_algorithm: "ECDSA_SHA_384", # The signing algorithm that was used to verify the signature.
+ # }
+ #
+ # @example Example: To use an asymmetric KMS key to verify a digital signature on a message digest
+ #
+ # # This operation uses the public key in an RSA asymmetric signing key pair to verify the digital signature of a message
+ # # digest. Hashing a message into a digest before sending it to KMS lets you verify messages that exceed the 4096-byte
+ # # message size limit. To indicate that the value of Message is a digest, use the MessageType parameter
+ #
+ # resp = client.verify({
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.
+ # message: "<message digest to be verified>", # The message that was signed.
+ # message_type: "DIGEST", # Indicates whether the message is RAW or a DIGEST. When it is RAW, KMS hashes the message before signing. When it is DIGEST, KMS skips the hashing step and signs the Message value.
+ # signature: "<binary data>", # The signature to be verified.
+ # signing_algorithm: "RSASSA_PSS_SHA_512", # The signing algorithm to be used to verify the signature.
+ # })
+ #
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The key ARN of the asymmetric KMS key that was used to verify the digital signature.
+ # signature_valid: true, # A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.
+ # signing_algorithm: "RSASSA_PSS_SHA_512", # The signing algorithm that was used to verify the signature.
+ # }
#
# @example Request syntax with placeholder values
#
- # resp = client.update_custom_key_store({
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # new_custom_key_store_name: "CustomKeyStoreNameType",
- # key_store_password: "KeyStorePasswordType",
- # cloud_hsm_cluster_id: "CloudHsmClusterIdType",
+ # resp = client.verify({
+ # key_id: "KeyIdType", # required
+ # message: "data", # required
+ # message_type: "RAW", # accepts RAW, DIGEST
+ # signature: "data", # required
+ # signing_algorithm: "RSASSA_PSS_SHA_256", # required, accepts RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStore AWS API Documentation
+ # @example Response structure
#
- # @overload update_custom_key_store(params = {})
+ # resp.key_id #=> String
+ # resp.signature_valid #=> Boolean
+ # resp.signing_algorithm #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Verify AWS API Documentation
+ #
+ # @overload verify(params = {})
# @param [Hash] params ({})
- def update_custom_key_store(params = {}, options = {})
- req = build_request(:update_custom_key_store, params)
+ def verify(params = {}, options = {})
+ req = build_request(:verify, params)
req.send_request(options)
end
- # Updates the description of a customer master key (CMK). To see the
- # description of a CMK, use DescribeKey.
+ # Verifies the hash-based message authentication code (HMAC) for a
+ # specified message, HMAC KMS key, and MAC algorithm. To verify the
+ # HMAC, `VerifyMac` computes an HMAC using the message, HMAC KMS key,
+ # and MAC algorithm that you specify, and compares the computed HMAC to
+ # the HMAC that you specify. If the HMACs are identical, the
+ # verification succeeds; otherwise, it fails. Verification indicates
+ # that the message hasn't changed since the HMAC was calculated, and
+ # the specified key was used to generate and verify the HMAC.
+ #
+ # HMAC KMS keys and the HMAC algorithms that KMS uses conform to
+ # industry standards defined in [RFC 2104][1].
+ #
+ # This operation is part of KMS support for HMAC KMS keys. For details,
+ # see [HMAC keys in KMS][2] in the *Key Management Service Developer
+ # Guide*.
+ #
+ # The KMS key that you use for this operation must be in a compatible
+ # key state. For details, see [Key states of KMS keys][3] in the *Key
+ # Management Service Developer Guide*.
#
- # You cannot perform this operation on a CMK in a different AWS account.
+ # **Cross-account use**: Yes. To perform this operation with a KMS key
+ # in a different Amazon Web Services account, specify the key ARN or
+ # alias ARN in the value of the `KeyId` parameter.
#
- # The result of this operation varies with the key state of the CMK. For
- # details, see [How Key State Affects Use of a Customer Master Key][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # **Required permissions**: [kms:VerifyMac][4] (key policy)
#
+ # **Related operations**: GenerateMac
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ # [1]: https://datatracker.ietf.org/doc/html/rfc2104
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ #
+ # @option params [required, String, StringIO, File] :message
+ # The message that will be used in the verification. Enter the same
+ # message that was used to generate the HMAC.
+ #
+ # GenerateMac and `VerifyMac` do not provide special handling for
+ # message digests. If you generated an HMAC for a hash digest of a
+ # message, you must verify the HMAC for the same hash digest.
#
# @option params [required, String] :key_id
- # A unique identifier for the customer master key (CMK).
+ # The KMS key that will be used in the verification.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Enter a key ID of the KMS key that was used to generate the HMAC. If
+ # you identify a different KMS key, the `VerifyMac` operation fails.
#
- # For example:
+ # @option params [required, String] :mac_algorithm
+ # The MAC algorithm that will be used in the verification. Enter the
+ # same MAC algorithm that was used to compute the HMAC. This algorithm
+ # must be supported by the HMAC KMS key identified by the `KeyId`
+ # parameter.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @option params [required, String, StringIO, File] :mac
+ # The HMAC to verify. Enter the HMAC that was generated by the
+ # GenerateMac operation when you specified the same message, HMAC KMS
+ # key, and MAC algorithm as the values specified in this request.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @option params [Array<String>] :grant_tokens
+ # A list of grant tokens.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*. For
+ # more information, see [Grant token][1] and [Using a grant token][2] in
+ # the *Key Management Service Developer Guide*.
#
- # @option params [required, String] :description
- # New description for the CMK.
#
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
#
- # @example Example: To update the description of a customer master key (CMK)
+ # @option params [Boolean] :dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # # The following example updates the description of the specified CMK.
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # resp = client.update_key_description({
- # description: "Example description that indicates the intended use of this CMK.", # The updated description.
- # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ #
+ # @return [Types::VerifyMacResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::VerifyMacResponse#key_id #key_id} => String
+ # * {Types::VerifyMacResponse#mac_valid #mac_valid} => Boolean
+ # * {Types::VerifyMacResponse#mac_algorithm #mac_algorithm} => String
+ #
+ #
+ # @example Example: To verify an HMAC
+ #
+ # # This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the
+ # # MacValid value in the response indicates that the HMAC is valid.
+ #
+ # resp = client.verify_mac({
+ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The HMAC KMS key input to the HMAC algorithm.
+ # mac: "<HMAC_TAG>", # The HMAC to be verified.
+ # mac_algorithm: "HMAC_SHA_384", # The HMAC algorithm requested for the operation.
+ # message: "Hello World", # The message input to the HMAC algorithm.
# })
#
+ # resp.to_h outputs the following:
+ # {
+ # key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The key ARN of the HMAC key used in the operation.
+ # mac_algorithm: "HMAC_SHA_384", # The HMAC algorithm used in the operation.
+ # mac_valid: true, # A value of 'true' indicates that verification succeeded. If verification fails, the call to VerifyMac fails.
+ # }
+ #
# @example Request syntax with placeholder values
#
- # resp = client.update_key_description({
+ # resp = client.verify_mac({
+ # message: "data", # required
# key_id: "KeyIdType", # required
- # description: "DescriptionType", # required
+ # mac_algorithm: "HMAC_SHA_224", # required, accepts HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512
+ # mac: "data", # required
+ # grant_tokens: ["GrantTokenType"],
+ # dry_run: false,
# })
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription AWS API Documentation
+ # @example Response structure
#
- # @overload update_key_description(params = {})
+ # resp.key_id #=> String
+ # resp.mac_valid #=> Boolean
+ # resp.mac_algorithm #=> String, one of "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMac AWS API Documentation
+ #
+ # @overload verify_mac(params = {})
# @param [Hash] params ({})
- def update_key_description(params = {}, options = {})
- req = build_request(:update_key_description, params)
+ def verify_mac(params = {}, options = {})
+ req = build_request(:verify_mac, params)
req.send_request(options)
end
@@ -4060,7 +9888,7 @@ module Aws::KMS
params: params,
config: config)
context[:gem_name] = 'aws-sdk-kms'
- context[:gem_version] = '1.24.0'
+ context[:gem_version] = '1.71.0'
Seahorse::Client::Request.new(handlers, context)
end
diff --git a/lib/aws-sdk-kms/client_api.rb b/lib/aws-sdk-kms/client_api.rb
index 1d5abf4..48f3975 100644
--- a/lib/aws-sdk-kms/client_api.rb
+++ b/lib/aws-sdk-kms/client_api.rb
@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -18,6 +20,7 @@ module Aws::KMS
AliasNameType = Shapes::StringShape.new(name: 'AliasNameType')
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
ArnType = Shapes::StringShape.new(name: 'ArnType')
+ AttestationDocumentType = Shapes::BlobShape.new(name: 'AttestationDocumentType')
BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
CancelKeyDeletionRequest = Shapes::StructureShape.new(name: 'CancelKeyDeletionRequest')
CancelKeyDeletionResponse = Shapes::StructureShape.new(name: 'CancelKeyDeletionResponse')
@@ -45,8 +48,11 @@ module Aws::KMS
CustomKeyStoreNameInUseException = Shapes::StructureShape.new(name: 'CustomKeyStoreNameInUseException')
CustomKeyStoreNameType = Shapes::StringShape.new(name: 'CustomKeyStoreNameType')
CustomKeyStoreNotFoundException = Shapes::StructureShape.new(name: 'CustomKeyStoreNotFoundException')
+ CustomKeyStoreType = Shapes::StringShape.new(name: 'CustomKeyStoreType')
CustomKeyStoresList = Shapes::ListShape.new(name: 'CustomKeyStoresList')
CustomKeyStoresListEntry = Shapes::StructureShape.new(name: 'CustomKeyStoresListEntry')
+ CustomerMasterKeySpec = Shapes::StringShape.new(name: 'CustomerMasterKeySpec')
+ DataKeyPairSpec = Shapes::StringShape.new(name: 'DataKeyPairSpec')
DataKeySpec = Shapes::StringShape.new(name: 'DataKeySpec')
DateType = Shapes::TimestampShape.new(name: 'DateType')
DecryptRequest = Shapes::StructureShape.new(name: 'DecryptRequest')
@@ -66,20 +72,29 @@ module Aws::KMS
DisabledException = Shapes::StructureShape.new(name: 'DisabledException')
DisconnectCustomKeyStoreRequest = Shapes::StructureShape.new(name: 'DisconnectCustomKeyStoreRequest')
DisconnectCustomKeyStoreResponse = Shapes::StructureShape.new(name: 'DisconnectCustomKeyStoreResponse')
+ DryRunOperationException = Shapes::StructureShape.new(name: 'DryRunOperationException')
EnableKeyRequest = Shapes::StructureShape.new(name: 'EnableKeyRequest')
EnableKeyRotationRequest = Shapes::StructureShape.new(name: 'EnableKeyRotationRequest')
EncryptRequest = Shapes::StructureShape.new(name: 'EncryptRequest')
EncryptResponse = Shapes::StructureShape.new(name: 'EncryptResponse')
+ EncryptionAlgorithmSpec = Shapes::StringShape.new(name: 'EncryptionAlgorithmSpec')
+ EncryptionAlgorithmSpecList = Shapes::ListShape.new(name: 'EncryptionAlgorithmSpecList')
EncryptionContextKey = Shapes::StringShape.new(name: 'EncryptionContextKey')
EncryptionContextType = Shapes::MapShape.new(name: 'EncryptionContextType')
EncryptionContextValue = Shapes::StringShape.new(name: 'EncryptionContextValue')
ErrorMessageType = Shapes::StringShape.new(name: 'ErrorMessageType')
ExpirationModelType = Shapes::StringShape.new(name: 'ExpirationModelType')
ExpiredImportTokenException = Shapes::StructureShape.new(name: 'ExpiredImportTokenException')
+ GenerateDataKeyPairRequest = Shapes::StructureShape.new(name: 'GenerateDataKeyPairRequest')
+ GenerateDataKeyPairResponse = Shapes::StructureShape.new(name: 'GenerateDataKeyPairResponse')
+ GenerateDataKeyPairWithoutPlaintextRequest = Shapes::StructureShape.new(name: 'GenerateDataKeyPairWithoutPlaintextRequest')
+ GenerateDataKeyPairWithoutPlaintextResponse = Shapes::StructureShape.new(name: 'GenerateDataKeyPairWithoutPlaintextResponse')
GenerateDataKeyRequest = Shapes::StructureShape.new(name: 'GenerateDataKeyRequest')
GenerateDataKeyResponse = Shapes::StructureShape.new(name: 'GenerateDataKeyResponse')
GenerateDataKeyWithoutPlaintextRequest = Shapes::StructureShape.new(name: 'GenerateDataKeyWithoutPlaintextRequest')
GenerateDataKeyWithoutPlaintextResponse = Shapes::StructureShape.new(name: 'GenerateDataKeyWithoutPlaintextResponse')
+ GenerateMacRequest = Shapes::StructureShape.new(name: 'GenerateMacRequest')
+ GenerateMacResponse = Shapes::StructureShape.new(name: 'GenerateMacResponse')
GenerateRandomRequest = Shapes::StructureShape.new(name: 'GenerateRandomRequest')
GenerateRandomResponse = Shapes::StructureShape.new(name: 'GenerateRandomResponse')
GetKeyPolicyRequest = Shapes::StructureShape.new(name: 'GetKeyPolicyRequest')
@@ -88,6 +103,8 @@ module Aws::KMS
GetKeyRotationStatusResponse = Shapes::StructureShape.new(name: 'GetKeyRotationStatusResponse')
GetParametersForImportRequest = Shapes::StructureShape.new(name: 'GetParametersForImportRequest')
GetParametersForImportResponse = Shapes::StructureShape.new(name: 'GetParametersForImportResponse')
+ GetPublicKeyRequest = Shapes::StructureShape.new(name: 'GetPublicKeyRequest')
+ GetPublicKeyResponse = Shapes::StructureShape.new(name: 'GetPublicKeyResponse')
GrantConstraints = Shapes::StructureShape.new(name: 'GrantConstraints')
GrantIdType = Shapes::StringShape.new(name: 'GrantIdType')
GrantList = Shapes::ListShape.new(name: 'GrantList')
@@ -99,6 +116,7 @@ module Aws::KMS
GrantTokenType = Shapes::StringShape.new(name: 'GrantTokenType')
ImportKeyMaterialRequest = Shapes::StructureShape.new(name: 'ImportKeyMaterialRequest')
ImportKeyMaterialResponse = Shapes::StructureShape.new(name: 'ImportKeyMaterialResponse')
+ IncorrectKeyException = Shapes::StructureShape.new(name: 'IncorrectKeyException')
IncorrectKeyMaterialException = Shapes::StructureShape.new(name: 'IncorrectKeyMaterialException')
IncorrectTrustAnchorException = Shapes::StructureShape.new(name: 'IncorrectTrustAnchorException')
InvalidAliasNameException = Shapes::StructureShape.new(name: 'InvalidAliasNameException')
@@ -110,12 +128,16 @@ module Aws::KMS
InvalidKeyUsageException = Shapes::StructureShape.new(name: 'InvalidKeyUsageException')
InvalidMarkerException = Shapes::StructureShape.new(name: 'InvalidMarkerException')
KMSInternalException = Shapes::StructureShape.new(name: 'KMSInternalException')
+ KMSInvalidMacException = Shapes::StructureShape.new(name: 'KMSInvalidMacException')
+ KMSInvalidSignatureException = Shapes::StructureShape.new(name: 'KMSInvalidSignatureException')
KMSInvalidStateException = Shapes::StructureShape.new(name: 'KMSInvalidStateException')
+ KeyEncryptionMechanism = Shapes::StringShape.new(name: 'KeyEncryptionMechanism')
KeyIdType = Shapes::StringShape.new(name: 'KeyIdType')
KeyList = Shapes::ListShape.new(name: 'KeyList')
KeyListEntry = Shapes::StructureShape.new(name: 'KeyListEntry')
KeyManagerType = Shapes::StringShape.new(name: 'KeyManagerType')
KeyMetadata = Shapes::StructureShape.new(name: 'KeyMetadata')
+ KeySpec = Shapes::StringShape.new(name: 'KeySpec')
KeyState = Shapes::StringShape.new(name: 'KeyState')
KeyStorePasswordType = Shapes::StringShape.new(name: 'KeyStorePasswordType')
KeyUnavailableException = Shapes::StructureShape.new(name: 'KeyUnavailableException')
@@ -133,9 +155,17 @@ module Aws::KMS
ListResourceTagsRequest = Shapes::StructureShape.new(name: 'ListResourceTagsRequest')
ListResourceTagsResponse = Shapes::StructureShape.new(name: 'ListResourceTagsResponse')
ListRetirableGrantsRequest = Shapes::StructureShape.new(name: 'ListRetirableGrantsRequest')
+ MacAlgorithmSpec = Shapes::StringShape.new(name: 'MacAlgorithmSpec')
+ MacAlgorithmSpecList = Shapes::ListShape.new(name: 'MacAlgorithmSpecList')
MalformedPolicyDocumentException = Shapes::StructureShape.new(name: 'MalformedPolicyDocumentException')
MarkerType = Shapes::StringShape.new(name: 'MarkerType')
+ MessageType = Shapes::StringShape.new(name: 'MessageType')
+ MultiRegionConfiguration = Shapes::StructureShape.new(name: 'MultiRegionConfiguration')
+ MultiRegionKey = Shapes::StructureShape.new(name: 'MultiRegionKey')
+ MultiRegionKeyList = Shapes::ListShape.new(name: 'MultiRegionKeyList')
+ MultiRegionKeyType = Shapes::StringShape.new(name: 'MultiRegionKeyType')
NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
+ NullableBooleanType = Shapes::BooleanShape.new(name: 'NullableBooleanType')
NumberOfBytesType = Shapes::IntegerShape.new(name: 'NumberOfBytesType')
OriginType = Shapes::StringShape.new(name: 'OriginType')
PendingWindowInDaysType = Shapes::IntegerShape.new(name: 'PendingWindowInDaysType')
@@ -144,13 +174,22 @@ module Aws::KMS
PolicyNameType = Shapes::StringShape.new(name: 'PolicyNameType')
PolicyType = Shapes::StringShape.new(name: 'PolicyType')
PrincipalIdType = Shapes::StringShape.new(name: 'PrincipalIdType')
+ PublicKeyType = Shapes::BlobShape.new(name: 'PublicKeyType')
PutKeyPolicyRequest = Shapes::StructureShape.new(name: 'PutKeyPolicyRequest')
ReEncryptRequest = Shapes::StructureShape.new(name: 'ReEncryptRequest')
ReEncryptResponse = Shapes::StructureShape.new(name: 'ReEncryptResponse')
+ RecipientInfo = Shapes::StructureShape.new(name: 'RecipientInfo')
+ RegionType = Shapes::StringShape.new(name: 'RegionType')
+ ReplicateKeyRequest = Shapes::StructureShape.new(name: 'ReplicateKeyRequest')
+ ReplicateKeyResponse = Shapes::StructureShape.new(name: 'ReplicateKeyResponse')
RetireGrantRequest = Shapes::StructureShape.new(name: 'RetireGrantRequest')
RevokeGrantRequest = Shapes::StructureShape.new(name: 'RevokeGrantRequest')
ScheduleKeyDeletionRequest = Shapes::StructureShape.new(name: 'ScheduleKeyDeletionRequest')
ScheduleKeyDeletionResponse = Shapes::StructureShape.new(name: 'ScheduleKeyDeletionResponse')
+ SignRequest = Shapes::StructureShape.new(name: 'SignRequest')
+ SignResponse = Shapes::StructureShape.new(name: 'SignResponse')
+ SigningAlgorithmSpec = Shapes::StringShape.new(name: 'SigningAlgorithmSpec')
+ SigningAlgorithmSpecList = Shapes::ListShape.new(name: 'SigningAlgorithmSpecList')
Tag = Shapes::StructureShape.new(name: 'Tag')
TagException = Shapes::StructureShape.new(name: 'TagException')
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
@@ -165,13 +204,42 @@ module Aws::KMS
UpdateCustomKeyStoreRequest = Shapes::StructureShape.new(name: 'UpdateCustomKeyStoreRequest')
UpdateCustomKeyStoreResponse = Shapes::StructureShape.new(name: 'UpdateCustomKeyStoreResponse')
UpdateKeyDescriptionRequest = Shapes::StructureShape.new(name: 'UpdateKeyDescriptionRequest')
+ UpdatePrimaryRegionRequest = Shapes::StructureShape.new(name: 'UpdatePrimaryRegionRequest')
+ VerifyMacRequest = Shapes::StructureShape.new(name: 'VerifyMacRequest')
+ VerifyMacResponse = Shapes::StructureShape.new(name: 'VerifyMacResponse')
+ VerifyRequest = Shapes::StructureShape.new(name: 'VerifyRequest')
+ VerifyResponse = Shapes::StructureShape.new(name: 'VerifyResponse')
WrappingKeySpec = Shapes::StringShape.new(name: 'WrappingKeySpec')
+ XksKeyAlreadyInUseException = Shapes::StructureShape.new(name: 'XksKeyAlreadyInUseException')
+ XksKeyConfigurationType = Shapes::StructureShape.new(name: 'XksKeyConfigurationType')
+ XksKeyIdType = Shapes::StringShape.new(name: 'XksKeyIdType')
+ XksKeyInvalidConfigurationException = Shapes::StructureShape.new(name: 'XksKeyInvalidConfigurationException')
+ XksKeyNotFoundException = Shapes::StructureShape.new(name: 'XksKeyNotFoundException')
+ XksProxyAuthenticationAccessKeyIdType = Shapes::StringShape.new(name: 'XksProxyAuthenticationAccessKeyIdType')
+ XksProxyAuthenticationCredentialType = Shapes::StructureShape.new(name: 'XksProxyAuthenticationCredentialType')
+ XksProxyAuthenticationRawSecretAccessKeyType = Shapes::StringShape.new(name: 'XksProxyAuthenticationRawSecretAccessKeyType')
+ XksProxyConfigurationType = Shapes::StructureShape.new(name: 'XksProxyConfigurationType')
+ XksProxyConnectivityType = Shapes::StringShape.new(name: 'XksProxyConnectivityType')
+ XksProxyIncorrectAuthenticationCredentialException = Shapes::StructureShape.new(name: 'XksProxyIncorrectAuthenticationCredentialException')
+ XksProxyInvalidConfigurationException = Shapes::StructureShape.new(name: 'XksProxyInvalidConfigurationException')
+ XksProxyInvalidResponseException = Shapes::StructureShape.new(name: 'XksProxyInvalidResponseException')
+ XksProxyUriEndpointInUseException = Shapes::StructureShape.new(name: 'XksProxyUriEndpointInUseException')
+ XksProxyUriEndpointType = Shapes::StringShape.new(name: 'XksProxyUriEndpointType')
+ XksProxyUriInUseException = Shapes::StructureShape.new(name: 'XksProxyUriInUseException')
+ XksProxyUriPathType = Shapes::StringShape.new(name: 'XksProxyUriPathType')
+ XksProxyUriUnreachableException = Shapes::StructureShape.new(name: 'XksProxyUriUnreachableException')
+ XksProxyVpcEndpointServiceInUseException = Shapes::StructureShape.new(name: 'XksProxyVpcEndpointServiceInUseException')
+ XksProxyVpcEndpointServiceInvalidConfigurationException = Shapes::StructureShape.new(name: 'XksProxyVpcEndpointServiceInvalidConfigurationException')
+ XksProxyVpcEndpointServiceNameType = Shapes::StringShape.new(name: 'XksProxyVpcEndpointServiceNameType')
+ XksProxyVpcEndpointServiceNotFoundException = Shapes::StructureShape.new(name: 'XksProxyVpcEndpointServiceNotFoundException')
AliasList.member = Shapes::ShapeRef.new(shape: AliasListEntry)
AliasListEntry.add_member(:alias_name, Shapes::ShapeRef.new(shape: AliasNameType, location_name: "AliasName"))
AliasListEntry.add_member(:alias_arn, Shapes::ShapeRef.new(shape: ArnType, location_name: "AliasArn"))
AliasListEntry.add_member(:target_key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "TargetKeyId"))
+ AliasListEntry.add_member(:creation_date, Shapes::ShapeRef.new(shape: DateType, location_name: "CreationDate"))
+ AliasListEntry.add_member(:last_updated_date, Shapes::ShapeRef.new(shape: DateType, location_name: "LastUpdatedDate"))
AliasListEntry.struct_class = Types::AliasListEntry
AlreadyExistsException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
@@ -208,9 +276,15 @@ module Aws::KMS
CreateAliasRequest.struct_class = Types::CreateAliasRequest
CreateCustomKeyStoreRequest.add_member(:custom_key_store_name, Shapes::ShapeRef.new(shape: CustomKeyStoreNameType, required: true, location_name: "CustomKeyStoreName"))
- CreateCustomKeyStoreRequest.add_member(:cloud_hsm_cluster_id, Shapes::ShapeRef.new(shape: CloudHsmClusterIdType, required: true, location_name: "CloudHsmClusterId"))
- CreateCustomKeyStoreRequest.add_member(:trust_anchor_certificate, Shapes::ShapeRef.new(shape: TrustAnchorCertificateType, required: true, location_name: "TrustAnchorCertificate"))
- CreateCustomKeyStoreRequest.add_member(:key_store_password, Shapes::ShapeRef.new(shape: KeyStorePasswordType, required: true, location_name: "KeyStorePassword"))
+ CreateCustomKeyStoreRequest.add_member(:cloud_hsm_cluster_id, Shapes::ShapeRef.new(shape: CloudHsmClusterIdType, location_name: "CloudHsmClusterId"))
+ CreateCustomKeyStoreRequest.add_member(:trust_anchor_certificate, Shapes::ShapeRef.new(shape: TrustAnchorCertificateType, location_name: "TrustAnchorCertificate"))
+ CreateCustomKeyStoreRequest.add_member(:key_store_password, Shapes::ShapeRef.new(shape: KeyStorePasswordType, location_name: "KeyStorePassword"))
+ CreateCustomKeyStoreRequest.add_member(:custom_key_store_type, Shapes::ShapeRef.new(shape: CustomKeyStoreType, location_name: "CustomKeyStoreType"))
+ CreateCustomKeyStoreRequest.add_member(:xks_proxy_uri_endpoint, Shapes::ShapeRef.new(shape: XksProxyUriEndpointType, location_name: "XksProxyUriEndpoint"))
+ CreateCustomKeyStoreRequest.add_member(:xks_proxy_uri_path, Shapes::ShapeRef.new(shape: XksProxyUriPathType, location_name: "XksProxyUriPath"))
+ CreateCustomKeyStoreRequest.add_member(:xks_proxy_vpc_endpoint_service_name, Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceNameType, location_name: "XksProxyVpcEndpointServiceName"))
+ CreateCustomKeyStoreRequest.add_member(:xks_proxy_authentication_credential, Shapes::ShapeRef.new(shape: XksProxyAuthenticationCredentialType, location_name: "XksProxyAuthenticationCredential"))
+ CreateCustomKeyStoreRequest.add_member(:xks_proxy_connectivity, Shapes::ShapeRef.new(shape: XksProxyConnectivityType, location_name: "XksProxyConnectivity"))
CreateCustomKeyStoreRequest.struct_class = Types::CreateCustomKeyStoreRequest
CreateCustomKeyStoreResponse.add_member(:custom_key_store_id, Shapes::ShapeRef.new(shape: CustomKeyStoreIdType, location_name: "CustomKeyStoreId"))
@@ -223,6 +297,7 @@ module Aws::KMS
CreateGrantRequest.add_member(:constraints, Shapes::ShapeRef.new(shape: GrantConstraints, location_name: "Constraints"))
CreateGrantRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
CreateGrantRequest.add_member(:name, Shapes::ShapeRef.new(shape: GrantNameType, location_name: "Name"))
+ CreateGrantRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
CreateGrantRequest.struct_class = Types::CreateGrantRequest
CreateGrantResponse.add_member(:grant_token, Shapes::ShapeRef.new(shape: GrantTokenType, location_name: "GrantToken"))
@@ -232,10 +307,14 @@ module Aws::KMS
CreateKeyRequest.add_member(:policy, Shapes::ShapeRef.new(shape: PolicyType, location_name: "Policy"))
CreateKeyRequest.add_member(:description, Shapes::ShapeRef.new(shape: DescriptionType, location_name: "Description"))
CreateKeyRequest.add_member(:key_usage, Shapes::ShapeRef.new(shape: KeyUsageType, location_name: "KeyUsage"))
+ CreateKeyRequest.add_member(:customer_master_key_spec, Shapes::ShapeRef.new(shape: CustomerMasterKeySpec, deprecated: true, location_name: "CustomerMasterKeySpec", metadata: {"deprecatedMessage"=>"This parameter has been deprecated. Instead, use the KeySpec parameter."}))
+ CreateKeyRequest.add_member(:key_spec, Shapes::ShapeRef.new(shape: KeySpec, location_name: "KeySpec"))
CreateKeyRequest.add_member(:origin, Shapes::ShapeRef.new(shape: OriginType, location_name: "Origin"))
CreateKeyRequest.add_member(:custom_key_store_id, Shapes::ShapeRef.new(shape: CustomKeyStoreIdType, location_name: "CustomKeyStoreId"))
CreateKeyRequest.add_member(:bypass_policy_lockout_safety_check, Shapes::ShapeRef.new(shape: BooleanType, location_name: "BypassPolicyLockoutSafetyCheck"))
CreateKeyRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+ CreateKeyRequest.add_member(:multi_region, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "MultiRegion"))
+ CreateKeyRequest.add_member(:xks_key_id, Shapes::ShapeRef.new(shape: XksKeyIdType, location_name: "XksKeyId"))
CreateKeyRequest.struct_class = Types::CreateKeyRequest
CreateKeyResponse.add_member(:key_metadata, Shapes::ShapeRef.new(shape: KeyMetadata, location_name: "KeyMetadata"))
@@ -262,15 +341,23 @@ module Aws::KMS
CustomKeyStoresListEntry.add_member(:connection_state, Shapes::ShapeRef.new(shape: ConnectionStateType, location_name: "ConnectionState"))
CustomKeyStoresListEntry.add_member(:connection_error_code, Shapes::ShapeRef.new(shape: ConnectionErrorCodeType, location_name: "ConnectionErrorCode"))
CustomKeyStoresListEntry.add_member(:creation_date, Shapes::ShapeRef.new(shape: DateType, location_name: "CreationDate"))
+ CustomKeyStoresListEntry.add_member(:custom_key_store_type, Shapes::ShapeRef.new(shape: CustomKeyStoreType, location_name: "CustomKeyStoreType"))
+ CustomKeyStoresListEntry.add_member(:xks_proxy_configuration, Shapes::ShapeRef.new(shape: XksProxyConfigurationType, location_name: "XksProxyConfiguration"))
CustomKeyStoresListEntry.struct_class = Types::CustomKeyStoresListEntry
DecryptRequest.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, required: true, location_name: "CiphertextBlob"))
DecryptRequest.add_member(:encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContext"))
DecryptRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ DecryptRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ DecryptRequest.add_member(:encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "EncryptionAlgorithm"))
+ DecryptRequest.add_member(:recipient, Shapes::ShapeRef.new(shape: RecipientInfo, location_name: "Recipient"))
+ DecryptRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
DecryptRequest.struct_class = Types::DecryptRequest
DecryptResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
DecryptResponse.add_member(:plaintext, Shapes::ShapeRef.new(shape: PlaintextType, location_name: "Plaintext"))
+ DecryptResponse.add_member(:encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "EncryptionAlgorithm"))
+ DecryptResponse.add_member(:ciphertext_for_recipient, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextForRecipient"))
DecryptResponse.struct_class = Types::DecryptResponse
DeleteAliasRequest.add_member(:alias_name, Shapes::ShapeRef.new(shape: AliasNameType, required: true, location_name: "AliasName"))
@@ -319,6 +406,9 @@ module Aws::KMS
DisconnectCustomKeyStoreResponse.struct_class = Types::DisconnectCustomKeyStoreResponse
+ DryRunOperationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ DryRunOperationException.struct_class = Types::DryRunOperationException
+
EnableKeyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
EnableKeyRequest.struct_class = Types::EnableKeyRequest
@@ -329,28 +419,65 @@ module Aws::KMS
EncryptRequest.add_member(:plaintext, Shapes::ShapeRef.new(shape: PlaintextType, required: true, location_name: "Plaintext"))
EncryptRequest.add_member(:encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContext"))
EncryptRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ EncryptRequest.add_member(:encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "EncryptionAlgorithm"))
+ EncryptRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
EncryptRequest.struct_class = Types::EncryptRequest
EncryptResponse.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextBlob"))
EncryptResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ EncryptResponse.add_member(:encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "EncryptionAlgorithm"))
EncryptResponse.struct_class = Types::EncryptResponse
+ EncryptionAlgorithmSpecList.member = Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec)
+
EncryptionContextType.key = Shapes::ShapeRef.new(shape: EncryptionContextKey)
EncryptionContextType.value = Shapes::ShapeRef.new(shape: EncryptionContextValue)
ExpiredImportTokenException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
ExpiredImportTokenException.struct_class = Types::ExpiredImportTokenException
+ GenerateDataKeyPairRequest.add_member(:encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContext"))
+ GenerateDataKeyPairRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ GenerateDataKeyPairRequest.add_member(:key_pair_spec, Shapes::ShapeRef.new(shape: DataKeyPairSpec, required: true, location_name: "KeyPairSpec"))
+ GenerateDataKeyPairRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GenerateDataKeyPairRequest.add_member(:recipient, Shapes::ShapeRef.new(shape: RecipientInfo, location_name: "Recipient"))
+ GenerateDataKeyPairRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ GenerateDataKeyPairRequest.struct_class = Types::GenerateDataKeyPairRequest
+
+ GenerateDataKeyPairResponse.add_member(:private_key_ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "PrivateKeyCiphertextBlob"))
+ GenerateDataKeyPairResponse.add_member(:private_key_plaintext, Shapes::ShapeRef.new(shape: PlaintextType, location_name: "PrivateKeyPlaintext"))
+ GenerateDataKeyPairResponse.add_member(:public_key, Shapes::ShapeRef.new(shape: PublicKeyType, location_name: "PublicKey"))
+ GenerateDataKeyPairResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ GenerateDataKeyPairResponse.add_member(:key_pair_spec, Shapes::ShapeRef.new(shape: DataKeyPairSpec, location_name: "KeyPairSpec"))
+ GenerateDataKeyPairResponse.add_member(:ciphertext_for_recipient, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextForRecipient"))
+ GenerateDataKeyPairResponse.struct_class = Types::GenerateDataKeyPairResponse
+
+ GenerateDataKeyPairWithoutPlaintextRequest.add_member(:encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContext"))
+ GenerateDataKeyPairWithoutPlaintextRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ GenerateDataKeyPairWithoutPlaintextRequest.add_member(:key_pair_spec, Shapes::ShapeRef.new(shape: DataKeyPairSpec, required: true, location_name: "KeyPairSpec"))
+ GenerateDataKeyPairWithoutPlaintextRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GenerateDataKeyPairWithoutPlaintextRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ GenerateDataKeyPairWithoutPlaintextRequest.struct_class = Types::GenerateDataKeyPairWithoutPlaintextRequest
+
+ GenerateDataKeyPairWithoutPlaintextResponse.add_member(:private_key_ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "PrivateKeyCiphertextBlob"))
+ GenerateDataKeyPairWithoutPlaintextResponse.add_member(:public_key, Shapes::ShapeRef.new(shape: PublicKeyType, location_name: "PublicKey"))
+ GenerateDataKeyPairWithoutPlaintextResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ GenerateDataKeyPairWithoutPlaintextResponse.add_member(:key_pair_spec, Shapes::ShapeRef.new(shape: DataKeyPairSpec, location_name: "KeyPairSpec"))
+ GenerateDataKeyPairWithoutPlaintextResponse.struct_class = Types::GenerateDataKeyPairWithoutPlaintextResponse
+
GenerateDataKeyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
GenerateDataKeyRequest.add_member(:encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContext"))
GenerateDataKeyRequest.add_member(:number_of_bytes, Shapes::ShapeRef.new(shape: NumberOfBytesType, location_name: "NumberOfBytes"))
GenerateDataKeyRequest.add_member(:key_spec, Shapes::ShapeRef.new(shape: DataKeySpec, location_name: "KeySpec"))
GenerateDataKeyRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GenerateDataKeyRequest.add_member(:recipient, Shapes::ShapeRef.new(shape: RecipientInfo, location_name: "Recipient"))
+ GenerateDataKeyRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
GenerateDataKeyRequest.struct_class = Types::GenerateDataKeyRequest
GenerateDataKeyResponse.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextBlob"))
GenerateDataKeyResponse.add_member(:plaintext, Shapes::ShapeRef.new(shape: PlaintextType, location_name: "Plaintext"))
GenerateDataKeyResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ GenerateDataKeyResponse.add_member(:ciphertext_for_recipient, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextForRecipient"))
GenerateDataKeyResponse.struct_class = Types::GenerateDataKeyResponse
GenerateDataKeyWithoutPlaintextRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
@@ -358,17 +485,32 @@ module Aws::KMS
GenerateDataKeyWithoutPlaintextRequest.add_member(:key_spec, Shapes::ShapeRef.new(shape: DataKeySpec, location_name: "KeySpec"))
GenerateDataKeyWithoutPlaintextRequest.add_member(:number_of_bytes, Shapes::ShapeRef.new(shape: NumberOfBytesType, location_name: "NumberOfBytes"))
GenerateDataKeyWithoutPlaintextRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GenerateDataKeyWithoutPlaintextRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
GenerateDataKeyWithoutPlaintextRequest.struct_class = Types::GenerateDataKeyWithoutPlaintextRequest
GenerateDataKeyWithoutPlaintextResponse.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextBlob"))
GenerateDataKeyWithoutPlaintextResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
GenerateDataKeyWithoutPlaintextResponse.struct_class = Types::GenerateDataKeyWithoutPlaintextResponse
+ GenerateMacRequest.add_member(:message, Shapes::ShapeRef.new(shape: PlaintextType, required: true, location_name: "Message"))
+ GenerateMacRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ GenerateMacRequest.add_member(:mac_algorithm, Shapes::ShapeRef.new(shape: MacAlgorithmSpec, required: true, location_name: "MacAlgorithm"))
+ GenerateMacRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GenerateMacRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ GenerateMacRequest.struct_class = Types::GenerateMacRequest
+
+ GenerateMacResponse.add_member(:mac, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "Mac"))
+ GenerateMacResponse.add_member(:mac_algorithm, Shapes::ShapeRef.new(shape: MacAlgorithmSpec, location_name: "MacAlgorithm"))
+ GenerateMacResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ GenerateMacResponse.struct_class = Types::GenerateMacResponse
+
GenerateRandomRequest.add_member(:number_of_bytes, Shapes::ShapeRef.new(shape: NumberOfBytesType, location_name: "NumberOfBytes"))
GenerateRandomRequest.add_member(:custom_key_store_id, Shapes::ShapeRef.new(shape: CustomKeyStoreIdType, location_name: "CustomKeyStoreId"))
+ GenerateRandomRequest.add_member(:recipient, Shapes::ShapeRef.new(shape: RecipientInfo, location_name: "Recipient"))
GenerateRandomRequest.struct_class = Types::GenerateRandomRequest
GenerateRandomResponse.add_member(:plaintext, Shapes::ShapeRef.new(shape: PlaintextType, location_name: "Plaintext"))
+ GenerateRandomResponse.add_member(:ciphertext_for_recipient, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextForRecipient"))
GenerateRandomResponse.struct_class = Types::GenerateRandomResponse
GetKeyPolicyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
@@ -395,6 +537,19 @@ module Aws::KMS
GetParametersForImportResponse.add_member(:parameters_valid_to, Shapes::ShapeRef.new(shape: DateType, location_name: "ParametersValidTo"))
GetParametersForImportResponse.struct_class = Types::GetParametersForImportResponse
+ GetPublicKeyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ GetPublicKeyRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ GetPublicKeyRequest.struct_class = Types::GetPublicKeyRequest
+
+ GetPublicKeyResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ GetPublicKeyResponse.add_member(:public_key, Shapes::ShapeRef.new(shape: PublicKeyType, location_name: "PublicKey"))
+ GetPublicKeyResponse.add_member(:customer_master_key_spec, Shapes::ShapeRef.new(shape: CustomerMasterKeySpec, deprecated: true, location_name: "CustomerMasterKeySpec", metadata: {"deprecatedMessage"=>"This field has been deprecated. Instead, use the KeySpec field."}))
+ GetPublicKeyResponse.add_member(:key_spec, Shapes::ShapeRef.new(shape: KeySpec, location_name: "KeySpec"))
+ GetPublicKeyResponse.add_member(:key_usage, Shapes::ShapeRef.new(shape: KeyUsageType, location_name: "KeyUsage"))
+ GetPublicKeyResponse.add_member(:encryption_algorithms, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpecList, location_name: "EncryptionAlgorithms"))
+ GetPublicKeyResponse.add_member(:signing_algorithms, Shapes::ShapeRef.new(shape: SigningAlgorithmSpecList, location_name: "SigningAlgorithms"))
+ GetPublicKeyResponse.struct_class = Types::GetPublicKeyResponse
+
GrantConstraints.add_member(:encryption_context_subset, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContextSubset"))
GrantConstraints.add_member(:encryption_context_equals, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "EncryptionContextEquals"))
GrantConstraints.struct_class = Types::GrantConstraints
@@ -425,6 +580,9 @@ module Aws::KMS
ImportKeyMaterialResponse.struct_class = Types::ImportKeyMaterialResponse
+ IncorrectKeyException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ IncorrectKeyException.struct_class = Types::IncorrectKeyException
+
IncorrectKeyMaterialException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
IncorrectKeyMaterialException.struct_class = Types::IncorrectKeyMaterialException
@@ -458,6 +616,12 @@ module Aws::KMS
KMSInternalException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
KMSInternalException.struct_class = Types::KMSInternalException
+ KMSInvalidMacException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ KMSInvalidMacException.struct_class = Types::KMSInvalidMacException
+
+ KMSInvalidSignatureException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ KMSInvalidSignatureException.struct_class = Types::KMSInvalidSignatureException
+
KMSInvalidStateException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
KMSInvalidStateException.struct_class = Types::KMSInvalidStateException
@@ -482,6 +646,15 @@ module Aws::KMS
KeyMetadata.add_member(:cloud_hsm_cluster_id, Shapes::ShapeRef.new(shape: CloudHsmClusterIdType, location_name: "CloudHsmClusterId"))
KeyMetadata.add_member(:expiration_model, Shapes::ShapeRef.new(shape: ExpirationModelType, location_name: "ExpirationModel"))
KeyMetadata.add_member(:key_manager, Shapes::ShapeRef.new(shape: KeyManagerType, location_name: "KeyManager"))
+ KeyMetadata.add_member(:customer_master_key_spec, Shapes::ShapeRef.new(shape: CustomerMasterKeySpec, deprecated: true, location_name: "CustomerMasterKeySpec", metadata: {"deprecatedMessage"=>"This field has been deprecated. Instead, use the KeySpec field."}))
+ KeyMetadata.add_member(:key_spec, Shapes::ShapeRef.new(shape: KeySpec, location_name: "KeySpec"))
+ KeyMetadata.add_member(:encryption_algorithms, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpecList, location_name: "EncryptionAlgorithms"))
+ KeyMetadata.add_member(:signing_algorithms, Shapes::ShapeRef.new(shape: SigningAlgorithmSpecList, location_name: "SigningAlgorithms"))
+ KeyMetadata.add_member(:multi_region, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "MultiRegion"))
+ KeyMetadata.add_member(:multi_region_configuration, Shapes::ShapeRef.new(shape: MultiRegionConfiguration, location_name: "MultiRegionConfiguration"))
+ KeyMetadata.add_member(:pending_deletion_window_in_days, Shapes::ShapeRef.new(shape: PendingWindowInDaysType, location_name: "PendingDeletionWindowInDays"))
+ KeyMetadata.add_member(:mac_algorithms, Shapes::ShapeRef.new(shape: MacAlgorithmSpecList, location_name: "MacAlgorithms"))
+ KeyMetadata.add_member(:xks_key_configuration, Shapes::ShapeRef.new(shape: XksKeyConfigurationType, location_name: "XksKeyConfiguration"))
KeyMetadata.struct_class = Types::KeyMetadata
KeyUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
@@ -503,6 +676,8 @@ module Aws::KMS
ListGrantsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: LimitType, location_name: "Limit"))
ListGrantsRequest.add_member(:marker, Shapes::ShapeRef.new(shape: MarkerType, location_name: "Marker"))
ListGrantsRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ ListGrantsRequest.add_member(:grant_id, Shapes::ShapeRef.new(shape: GrantIdType, location_name: "GrantId"))
+ ListGrantsRequest.add_member(:grantee_principal, Shapes::ShapeRef.new(shape: PrincipalIdType, location_name: "GranteePrincipal"))
ListGrantsRequest.struct_class = Types::ListGrantsRequest
ListGrantsResponse.add_member(:grants, Shapes::ShapeRef.new(shape: GrantList, location_name: "Grants"))
@@ -544,9 +719,22 @@ module Aws::KMS
ListRetirableGrantsRequest.add_member(:retiring_principal, Shapes::ShapeRef.new(shape: PrincipalIdType, required: true, location_name: "RetiringPrincipal"))
ListRetirableGrantsRequest.struct_class = Types::ListRetirableGrantsRequest
+ MacAlgorithmSpecList.member = Shapes::ShapeRef.new(shape: MacAlgorithmSpec)
+
MalformedPolicyDocumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
MalformedPolicyDocumentException.struct_class = Types::MalformedPolicyDocumentException
+ MultiRegionConfiguration.add_member(:multi_region_key_type, Shapes::ShapeRef.new(shape: MultiRegionKeyType, location_name: "MultiRegionKeyType"))
+ MultiRegionConfiguration.add_member(:primary_key, Shapes::ShapeRef.new(shape: MultiRegionKey, location_name: "PrimaryKey"))
+ MultiRegionConfiguration.add_member(:replica_keys, Shapes::ShapeRef.new(shape: MultiRegionKeyList, location_name: "ReplicaKeys"))
+ MultiRegionConfiguration.struct_class = Types::MultiRegionConfiguration
+
+ MultiRegionKey.add_member(:arn, Shapes::ShapeRef.new(shape: ArnType, location_name: "Arn"))
+ MultiRegionKey.add_member(:region, Shapes::ShapeRef.new(shape: RegionType, location_name: "Region"))
+ MultiRegionKey.struct_class = Types::MultiRegionKey
+
+ MultiRegionKeyList.member = Shapes::ShapeRef.new(shape: MultiRegionKey)
+
NotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
NotFoundException.struct_class = Types::NotFoundException
@@ -560,23 +748,48 @@ module Aws::KMS
ReEncryptRequest.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, required: true, location_name: "CiphertextBlob"))
ReEncryptRequest.add_member(:source_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "SourceEncryptionContext"))
+ ReEncryptRequest.add_member(:source_key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "SourceKeyId"))
ReEncryptRequest.add_member(:destination_key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "DestinationKeyId"))
ReEncryptRequest.add_member(:destination_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextType, location_name: "DestinationEncryptionContext"))
+ ReEncryptRequest.add_member(:source_encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "SourceEncryptionAlgorithm"))
+ ReEncryptRequest.add_member(:destination_encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "DestinationEncryptionAlgorithm"))
ReEncryptRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ ReEncryptRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
ReEncryptRequest.struct_class = Types::ReEncryptRequest
ReEncryptResponse.add_member(:ciphertext_blob, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "CiphertextBlob"))
ReEncryptResponse.add_member(:source_key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "SourceKeyId"))
ReEncryptResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ ReEncryptResponse.add_member(:source_encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "SourceEncryptionAlgorithm"))
+ ReEncryptResponse.add_member(:destination_encryption_algorithm, Shapes::ShapeRef.new(shape: EncryptionAlgorithmSpec, location_name: "DestinationEncryptionAlgorithm"))
ReEncryptResponse.struct_class = Types::ReEncryptResponse
+ RecipientInfo.add_member(:key_encryption_algorithm, Shapes::ShapeRef.new(shape: KeyEncryptionMechanism, location_name: "KeyEncryptionAlgorithm"))
+ RecipientInfo.add_member(:attestation_document, Shapes::ShapeRef.new(shape: AttestationDocumentType, location_name: "AttestationDocument"))
+ RecipientInfo.struct_class = Types::RecipientInfo
+
+ ReplicateKeyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ ReplicateKeyRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: RegionType, required: true, location_name: "ReplicaRegion"))
+ ReplicateKeyRequest.add_member(:policy, Shapes::ShapeRef.new(shape: PolicyType, location_name: "Policy"))
+ ReplicateKeyRequest.add_member(:bypass_policy_lockout_safety_check, Shapes::ShapeRef.new(shape: BooleanType, location_name: "BypassPolicyLockoutSafetyCheck"))
+ ReplicateKeyRequest.add_member(:description, Shapes::ShapeRef.new(shape: DescriptionType, location_name: "Description"))
+ ReplicateKeyRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+ ReplicateKeyRequest.struct_class = Types::ReplicateKeyRequest
+
+ ReplicateKeyResponse.add_member(:replica_key_metadata, Shapes::ShapeRef.new(shape: KeyMetadata, location_name: "ReplicaKeyMetadata"))
+ ReplicateKeyResponse.add_member(:replica_policy, Shapes::ShapeRef.new(shape: PolicyType, location_name: "ReplicaPolicy"))
+ ReplicateKeyResponse.add_member(:replica_tags, Shapes::ShapeRef.new(shape: TagList, location_name: "ReplicaTags"))
+ ReplicateKeyResponse.struct_class = Types::ReplicateKeyResponse
+
RetireGrantRequest.add_member(:grant_token, Shapes::ShapeRef.new(shape: GrantTokenType, location_name: "GrantToken"))
RetireGrantRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
RetireGrantRequest.add_member(:grant_id, Shapes::ShapeRef.new(shape: GrantIdType, location_name: "GrantId"))
+ RetireGrantRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
RetireGrantRequest.struct_class = Types::RetireGrantRequest
RevokeGrantRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
RevokeGrantRequest.add_member(:grant_id, Shapes::ShapeRef.new(shape: GrantIdType, required: true, location_name: "GrantId"))
+ RevokeGrantRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
RevokeGrantRequest.struct_class = Types::RevokeGrantRequest
ScheduleKeyDeletionRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
@@ -585,8 +798,25 @@ module Aws::KMS
ScheduleKeyDeletionResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
ScheduleKeyDeletionResponse.add_member(:deletion_date, Shapes::ShapeRef.new(shape: DateType, location_name: "DeletionDate"))
+ ScheduleKeyDeletionResponse.add_member(:key_state, Shapes::ShapeRef.new(shape: KeyState, location_name: "KeyState"))
+ ScheduleKeyDeletionResponse.add_member(:pending_window_in_days, Shapes::ShapeRef.new(shape: PendingWindowInDaysType, location_name: "PendingWindowInDays"))
ScheduleKeyDeletionResponse.struct_class = Types::ScheduleKeyDeletionResponse
+ SignRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ SignRequest.add_member(:message, Shapes::ShapeRef.new(shape: PlaintextType, required: true, location_name: "Message"))
+ SignRequest.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
+ SignRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ SignRequest.add_member(:signing_algorithm, Shapes::ShapeRef.new(shape: SigningAlgorithmSpec, required: true, location_name: "SigningAlgorithm"))
+ SignRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ SignRequest.struct_class = Types::SignRequest
+
+ SignResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ SignResponse.add_member(:signature, Shapes::ShapeRef.new(shape: CiphertextType, location_name: "Signature"))
+ SignResponse.add_member(:signing_algorithm, Shapes::ShapeRef.new(shape: SigningAlgorithmSpec, location_name: "SigningAlgorithm"))
+ SignResponse.struct_class = Types::SignResponse
+
+ SigningAlgorithmSpecList.member = Shapes::ShapeRef.new(shape: SigningAlgorithmSpec)
+
Tag.add_member(:tag_key, Shapes::ShapeRef.new(shape: TagKeyType, required: true, location_name: "TagKey"))
Tag.add_member(:tag_value, Shapes::ShapeRef.new(shape: TagValueType, required: true, location_name: "TagValue"))
Tag.struct_class = Types::Tag
@@ -617,6 +847,11 @@ module Aws::KMS
UpdateCustomKeyStoreRequest.add_member(:new_custom_key_store_name, Shapes::ShapeRef.new(shape: CustomKeyStoreNameType, location_name: "NewCustomKeyStoreName"))
UpdateCustomKeyStoreRequest.add_member(:key_store_password, Shapes::ShapeRef.new(shape: KeyStorePasswordType, location_name: "KeyStorePassword"))
UpdateCustomKeyStoreRequest.add_member(:cloud_hsm_cluster_id, Shapes::ShapeRef.new(shape: CloudHsmClusterIdType, location_name: "CloudHsmClusterId"))
+ UpdateCustomKeyStoreRequest.add_member(:xks_proxy_uri_endpoint, Shapes::ShapeRef.new(shape: XksProxyUriEndpointType, location_name: "XksProxyUriEndpoint"))
+ UpdateCustomKeyStoreRequest.add_member(:xks_proxy_uri_path, Shapes::ShapeRef.new(shape: XksProxyUriPathType, location_name: "XksProxyUriPath"))
+ UpdateCustomKeyStoreRequest.add_member(:xks_proxy_vpc_endpoint_service_name, Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceNameType, location_name: "XksProxyVpcEndpointServiceName"))
+ UpdateCustomKeyStoreRequest.add_member(:xks_proxy_authentication_credential, Shapes::ShapeRef.new(shape: XksProxyAuthenticationCredentialType, location_name: "XksProxyAuthenticationCredential"))
+ UpdateCustomKeyStoreRequest.add_member(:xks_proxy_connectivity, Shapes::ShapeRef.new(shape: XksProxyConnectivityType, location_name: "XksProxyConnectivity"))
UpdateCustomKeyStoreRequest.struct_class = Types::UpdateCustomKeyStoreRequest
UpdateCustomKeyStoreResponse.struct_class = Types::UpdateCustomKeyStoreResponse
@@ -625,6 +860,87 @@ module Aws::KMS
UpdateKeyDescriptionRequest.add_member(:description, Shapes::ShapeRef.new(shape: DescriptionType, required: true, location_name: "Description"))
UpdateKeyDescriptionRequest.struct_class = Types::UpdateKeyDescriptionRequest
+ UpdatePrimaryRegionRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ UpdatePrimaryRegionRequest.add_member(:primary_region, Shapes::ShapeRef.new(shape: RegionType, required: true, location_name: "PrimaryRegion"))
+ UpdatePrimaryRegionRequest.struct_class = Types::UpdatePrimaryRegionRequest
+
+ VerifyMacRequest.add_member(:message, Shapes::ShapeRef.new(shape: PlaintextType, required: true, location_name: "Message"))
+ VerifyMacRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ VerifyMacRequest.add_member(:mac_algorithm, Shapes::ShapeRef.new(shape: MacAlgorithmSpec, required: true, location_name: "MacAlgorithm"))
+ VerifyMacRequest.add_member(:mac, Shapes::ShapeRef.new(shape: CiphertextType, required: true, location_name: "Mac"))
+ VerifyMacRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ VerifyMacRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ VerifyMacRequest.struct_class = Types::VerifyMacRequest
+
+ VerifyMacResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ VerifyMacResponse.add_member(:mac_valid, Shapes::ShapeRef.new(shape: BooleanType, location_name: "MacValid"))
+ VerifyMacResponse.add_member(:mac_algorithm, Shapes::ShapeRef.new(shape: MacAlgorithmSpec, location_name: "MacAlgorithm"))
+ VerifyMacResponse.struct_class = Types::VerifyMacResponse
+
+ VerifyRequest.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, required: true, location_name: "KeyId"))
+ VerifyRequest.add_member(:message, Shapes::ShapeRef.new(shape: PlaintextType, required: true, location_name: "Message"))
+ VerifyRequest.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
+ VerifyRequest.add_member(:signature, Shapes::ShapeRef.new(shape: CiphertextType, required: true, location_name: "Signature"))
+ VerifyRequest.add_member(:signing_algorithm, Shapes::ShapeRef.new(shape: SigningAlgorithmSpec, required: true, location_name: "SigningAlgorithm"))
+ VerifyRequest.add_member(:grant_tokens, Shapes::ShapeRef.new(shape: GrantTokenList, location_name: "GrantTokens"))
+ VerifyRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: NullableBooleanType, location_name: "DryRun"))
+ VerifyRequest.struct_class = Types::VerifyRequest
+
+ VerifyResponse.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyIdType, location_name: "KeyId"))
+ VerifyResponse.add_member(:signature_valid, Shapes::ShapeRef.new(shape: BooleanType, location_name: "SignatureValid"))
+ VerifyResponse.add_member(:signing_algorithm, Shapes::ShapeRef.new(shape: SigningAlgorithmSpec, location_name: "SigningAlgorithm"))
+ VerifyResponse.struct_class = Types::VerifyResponse
+
+ XksKeyAlreadyInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksKeyAlreadyInUseException.struct_class = Types::XksKeyAlreadyInUseException
+
+ XksKeyConfigurationType.add_member(:id, Shapes::ShapeRef.new(shape: XksKeyIdType, location_name: "Id"))
+ XksKeyConfigurationType.struct_class = Types::XksKeyConfigurationType
+
+ XksKeyInvalidConfigurationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksKeyInvalidConfigurationException.struct_class = Types::XksKeyInvalidConfigurationException
+
+ XksKeyNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksKeyNotFoundException.struct_class = Types::XksKeyNotFoundException
+
+ XksProxyAuthenticationCredentialType.add_member(:access_key_id, Shapes::ShapeRef.new(shape: XksProxyAuthenticationAccessKeyIdType, required: true, location_name: "AccessKeyId"))
+ XksProxyAuthenticationCredentialType.add_member(:raw_secret_access_key, Shapes::ShapeRef.new(shape: XksProxyAuthenticationRawSecretAccessKeyType, required: true, location_name: "RawSecretAccessKey"))
+ XksProxyAuthenticationCredentialType.struct_class = Types::XksProxyAuthenticationCredentialType
+
+ XksProxyConfigurationType.add_member(:connectivity, Shapes::ShapeRef.new(shape: XksProxyConnectivityType, location_name: "Connectivity"))
+ XksProxyConfigurationType.add_member(:access_key_id, Shapes::ShapeRef.new(shape: XksProxyAuthenticationAccessKeyIdType, location_name: "AccessKeyId"))
+ XksProxyConfigurationType.add_member(:uri_endpoint, Shapes::ShapeRef.new(shape: XksProxyUriEndpointType, location_name: "UriEndpoint"))
+ XksProxyConfigurationType.add_member(:uri_path, Shapes::ShapeRef.new(shape: XksProxyUriPathType, location_name: "UriPath"))
+ XksProxyConfigurationType.add_member(:vpc_endpoint_service_name, Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceNameType, location_name: "VpcEndpointServiceName"))
+ XksProxyConfigurationType.struct_class = Types::XksProxyConfigurationType
+
+ XksProxyIncorrectAuthenticationCredentialException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyIncorrectAuthenticationCredentialException.struct_class = Types::XksProxyIncorrectAuthenticationCredentialException
+
+ XksProxyInvalidConfigurationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyInvalidConfigurationException.struct_class = Types::XksProxyInvalidConfigurationException
+
+ XksProxyInvalidResponseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyInvalidResponseException.struct_class = Types::XksProxyInvalidResponseException
+
+ XksProxyUriEndpointInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyUriEndpointInUseException.struct_class = Types::XksProxyUriEndpointInUseException
+
+ XksProxyUriInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyUriInUseException.struct_class = Types::XksProxyUriInUseException
+
+ XksProxyUriUnreachableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyUriUnreachableException.struct_class = Types::XksProxyUriUnreachableException
+
+ XksProxyVpcEndpointServiceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyVpcEndpointServiceInUseException.struct_class = Types::XksProxyVpcEndpointServiceInUseException
+
+ XksProxyVpcEndpointServiceInvalidConfigurationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyVpcEndpointServiceInvalidConfigurationException.struct_class = Types::XksProxyVpcEndpointServiceInvalidConfigurationException
+
+ XksProxyVpcEndpointServiceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "message"))
+ XksProxyVpcEndpointServiceNotFoundException.struct_class = Types::XksProxyVpcEndpointServiceNotFoundException
+
# @api private
API = Seahorse::Model::Api.new.tap do |api|
@@ -698,6 +1014,16 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterNotActiveException)
o.errors << Shapes::ShapeRef.new(shape: IncorrectTrustAnchorException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriEndpointInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriUnreachableException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyIncorrectAuthenticationCredentialException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyInvalidResponseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyInvalidConfigurationException)
end)
api.add_operation(:create_grant, Seahorse::Model::Operation.new.tap do |o|
@@ -714,6 +1040,7 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:create_key, Seahorse::Model::Operation.new.tap do |o|
@@ -732,6 +1059,9 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreNotFoundException)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreInvalidStateException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: XksKeyInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: XksKeyAlreadyInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksKeyNotFoundException)
end)
api.add_operation(:decrypt, Seahorse::Model::Operation.new.tap do |o|
@@ -744,10 +1074,13 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: DisabledException)
o.errors << Shapes::ShapeRef.new(shape: InvalidCiphertextException)
o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: IncorrectKeyException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:delete_alias, Seahorse::Model::Operation.new.tap do |o|
@@ -795,7 +1128,14 @@ module Aws::KMS
o.input = Shapes::ShapeRef.new(shape: DescribeCustomKeyStoresRequest)
o.output = Shapes::ShapeRef.new(shape: DescribeCustomKeyStoresResponse)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidMarkerException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o[:pager] = Aws::Pager.new(
+ limit_key: "limit",
+ tokens: {
+ "next_marker" => "marker"
+ }
+ )
end)
api.add_operation(:describe_key, Seahorse::Model::Operation.new.tap do |o|
@@ -892,6 +1232,7 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:generate_data_key, Seahorse::Model::Operation.new.tap do |o|
@@ -908,6 +1249,43 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
+ api.add_operation(:generate_data_key_pair, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "GenerateDataKeyPair"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: GenerateDataKeyPairRequest)
+ o.output = Shapes::ShapeRef.new(shape: GenerateDataKeyPairResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
+ api.add_operation(:generate_data_key_pair_without_plaintext, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "GenerateDataKeyPairWithoutPlaintext"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: GenerateDataKeyPairWithoutPlaintextRequest)
+ o.output = Shapes::ShapeRef.new(shape: GenerateDataKeyPairWithoutPlaintextResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:generate_data_key_without_plaintext, Seahorse::Model::Operation.new.tap do |o|
@@ -924,6 +1302,23 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
+ api.add_operation(:generate_mac, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "GenerateMac"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: GenerateMacRequest)
+ o.output = Shapes::ShapeRef.new(shape: GenerateMacResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:generate_random, Seahorse::Model::Operation.new.tap do |o|
@@ -934,6 +1329,7 @@ module Aws::KMS
o.output = Shapes::ShapeRef.new(shape: GenerateRandomResponse)
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreNotFoundException)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreInvalidStateException)
end)
@@ -979,6 +1375,24 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
end)
+ api.add_operation(:get_public_key, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "GetPublicKey"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: GetPublicKeyRequest)
+ o.output = Shapes::ShapeRef.new(shape: GetPublicKeyResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ end)
+
api.add_operation(:import_key_material, Seahorse::Model::Operation.new.tap do |o|
o.name = "ImportKeyMaterial"
o.http_method = "POST"
@@ -1009,7 +1423,6 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
o[:pager] = Aws::Pager.new(
- more_results: "truncated",
limit_key: "limit",
tokens: {
"next_marker" => "marker"
@@ -1026,11 +1439,11 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: InvalidMarkerException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantIdException)
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
o[:pager] = Aws::Pager.new(
- more_results: "truncated",
limit_key: "limit",
tokens: {
"next_marker" => "marker"
@@ -1050,7 +1463,6 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
o[:pager] = Aws::Pager.new(
- more_results: "truncated",
limit_key: "limit",
tokens: {
"next_marker" => "marker"
@@ -1068,7 +1480,6 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: InvalidMarkerException)
o[:pager] = Aws::Pager.new(
- more_results: "truncated",
limit_key: "limit",
tokens: {
"next_marker" => "marker"
@@ -1086,6 +1497,12 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
o.errors << Shapes::ShapeRef.new(shape: InvalidMarkerException)
+ o[:pager] = Aws::Pager.new(
+ limit_key: "limit",
+ tokens: {
+ "next_marker" => "marker"
+ }
+ )
end)
api.add_operation(:list_retirable_grants, Seahorse::Model::Operation.new.tap do |o|
@@ -1099,6 +1516,12 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o[:pager] = Aws::Pager.new(
+ limit_key: "limit",
+ tokens: {
+ "next_marker" => "marker"
+ }
+ )
end)
api.add_operation(:put_key_policy, Seahorse::Model::Operation.new.tap do |o|
@@ -1127,11 +1550,31 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: DisabledException)
o.errors << Shapes::ShapeRef.new(shape: InvalidCiphertextException)
o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: IncorrectKeyException)
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
+ api.add_operation(:replicate_key, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "ReplicateKey"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: ReplicateKeyRequest)
+ o.output = Shapes::ShapeRef.new(shape: ReplicateKeyResponse)
+ o.errors << Shapes::ShapeRef.new(shape: AlreadyExistsException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+ o.errors << Shapes::ShapeRef.new(shape: MalformedPolicyDocumentException)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: TagException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
end)
api.add_operation(:retire_grant, Seahorse::Model::Operation.new.tap do |o|
@@ -1147,6 +1590,7 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:revoke_grant, Seahorse::Model::Operation.new.tap do |o|
@@ -1161,6 +1605,7 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: InvalidGrantIdException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
end)
api.add_operation(:schedule_key_deletion, Seahorse::Model::Operation.new.tap do |o|
@@ -1176,6 +1621,23 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
end)
+ api.add_operation(:sign, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "Sign"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: SignRequest)
+ o.output = Shapes::ShapeRef.new(shape: SignResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
o.name = "TagResource"
o.http_method = "POST"
@@ -1212,6 +1674,7 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
end)
@@ -1222,12 +1685,22 @@ module Aws::KMS
o.input = Shapes::ShapeRef.new(shape: UpdateCustomKeyStoreRequest)
o.output = Shapes::ShapeRef.new(shape: UpdateCustomKeyStoreResponse)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreNameInUseException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterNotFoundException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterNotRelatedException)
o.errors << Shapes::ShapeRef.new(shape: CustomKeyStoreInvalidStateException)
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterNotActiveException)
o.errors << Shapes::ShapeRef.new(shape: CloudHsmClusterInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriEndpointInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyUriUnreachableException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyIncorrectAuthenticationCredentialException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceInUseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyVpcEndpointServiceInvalidConfigurationException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyInvalidResponseException)
+ o.errors << Shapes::ShapeRef.new(shape: XksProxyInvalidConfigurationException)
end)
api.add_operation(:update_key_description, Seahorse::Model::Operation.new.tap do |o|
@@ -1242,6 +1715,55 @@ module Aws::KMS
o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
end)
+
+ api.add_operation(:update_primary_region, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "UpdatePrimaryRegion"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: UpdatePrimaryRegionRequest)
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+ end)
+
+ api.add_operation(:verify, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "Verify"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: VerifyRequest)
+ o.output = Shapes::ShapeRef.new(shape: VerifyResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: DependencyTimeoutException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidSignatureException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
+
+ api.add_operation(:verify_mac, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "VerifyMac"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: VerifyMacRequest)
+ o.output = Shapes::ShapeRef.new(shape: VerifyMacResponse)
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: DisabledException)
+ o.errors << Shapes::ShapeRef.new(shape: KeyUnavailableException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidKeyUsageException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGrantTokenException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInternalException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidMacException)
+ o.errors << Shapes::ShapeRef.new(shape: KMSInvalidStateException)
+ o.errors << Shapes::ShapeRef.new(shape: DryRunOperationException)
+ end)
end
end
diff --git a/lib/aws-sdk-kms/customizations.rb b/lib/aws-sdk-kms/customizations.rb
index 1b6a97e..717e1f2 100644
--- a/lib/aws-sdk-kms/customizations.rb
+++ b/lib/aws-sdk-kms/customizations.rb
@@ -1,7 +1,8 @@
+# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing for info on making contributions:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
diff --git a/lib/aws-sdk-kms/endpoint_parameters.rb b/lib/aws-sdk-kms/endpoint_parameters.rb
new file mode 100644
index 0000000..670e9ae
--- /dev/null
+++ b/lib/aws-sdk-kms/endpoint_parameters.rb
@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::KMS
+ # Endpoint parameters used to influence endpoints per request.
+ #
+ # @!attribute region
+ # The AWS region used to dispatch the request.
+ #
+ # @return [String]
+ #
+ # @!attribute use_dual_stack
+ # When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
+ #
+ # @return [Boolean]
+ #
+ # @!attribute use_fips
+ # When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
+ #
+ # @return [Boolean]
+ #
+ # @!attribute endpoint
+ # Override the endpoint used to send this request
+ #
+ # @return [String]
+ #
+ EndpointParameters = Struct.new(
+ :region,
+ :use_dual_stack,
+ :use_fips,
+ :endpoint,
+ ) do
+ include Aws::Structure
+
+ # @api private
+ class << self
+ PARAM_MAP = {
+ 'Region' => :region,
+ 'UseDualStack' => :use_dual_stack,
+ 'UseFIPS' => :use_fips,
+ 'Endpoint' => :endpoint,
+ }.freeze
+ end
+
+ def initialize(options = {})
+ self[:region] = options[:region]
+ self[:use_dual_stack] = options[:use_dual_stack]
+ self[:use_dual_stack] = false if self[:use_dual_stack].nil?
+ if self[:use_dual_stack].nil?
+ raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack"
+ end
+ self[:use_fips] = options[:use_fips]
+ self[:use_fips] = false if self[:use_fips].nil?
+ if self[:use_fips].nil?
+ raise ArgumentError, "Missing required EndpointParameter: :use_fips"
+ end
+ self[:endpoint] = options[:endpoint]
+ end
+ end
+end
diff --git a/lib/aws-sdk-kms/endpoint_provider.rb b/lib/aws-sdk-kms/endpoint_provider.rb
new file mode 100644
index 0000000..9092621
--- /dev/null
+++ b/lib/aws-sdk-kms/endpoint_provider.rb
@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::KMS
+ class EndpointProvider
+ def resolve_endpoint(parameters)
+ region = parameters.region
+ use_dual_stack = parameters.use_dual_stack
+ use_fips = parameters.use_fips
+ endpoint = parameters.endpoint
+ if Aws::Endpoints::Matchers.set?(endpoint)
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+ raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
+ end
+ return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+ end
+ if Aws::Endpoints::Matchers.set?(region)
+ if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+ return Aws::Endpoints::Endpoint.new(url: "https://kms-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+ return Aws::Endpoints::Endpoint.new(url: "https://kms-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+ return Aws::Endpoints::Endpoint.new(url: "https://kms.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
+ end
+ return Aws::Endpoints::Endpoint.new(url: "https://kms.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+ end
+ end
+ raise ArgumentError, "Invalid Configuration: Missing Region"
+ raise ArgumentError, 'No endpoint could be resolved'
+
+ end
+ end
+end
diff --git a/lib/aws-sdk-kms/endpoints.rb b/lib/aws-sdk-kms/endpoints.rb
new file mode 100644
index 0000000..9377809
--- /dev/null
+++ b/lib/aws-sdk-kms/endpoints.rb
@@ -0,0 +1,716 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::KMS
+ # @api private
+ module Endpoints
+
+ class CancelKeyDeletion
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ConnectCustomKeyStore
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateAlias
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateCustomKeyStore
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateGrant
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class Decrypt
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteAlias
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteCustomKeyStore
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteImportedKeyMaterial
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeCustomKeyStores
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DisableKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DisableKeyRotation
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DisconnectCustomKeyStore
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class EnableKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class EnableKeyRotation
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class Encrypt
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateDataKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateDataKeyPair
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateDataKeyPairWithoutPlaintext
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateDataKeyWithoutPlaintext
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateMac
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GenerateRandom
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetKeyPolicy
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetKeyRotationStatus
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetParametersForImport
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetPublicKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ImportKeyMaterial
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListAliases
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListGrants
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListKeyPolicies
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListKeys
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListResourceTags
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListRetirableGrants
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class PutKeyPolicy
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ReEncrypt
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ReplicateKey
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RetireGrant
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RevokeGrant
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ScheduleKeyDeletion
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class Sign
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class TagResource
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UntagResource
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateAlias
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateCustomKeyStore
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateKeyDescription
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdatePrimaryRegion
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class Verify
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class VerifyMac
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::KMS::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ end
+end
diff --git a/lib/aws-sdk-kms/errors.rb b/lib/aws-sdk-kms/errors.rb
index f672c7f..eeddb87 100644
--- a/lib/aws-sdk-kms/errors.rb
+++ b/lib/aws-sdk-kms/errors.rb
@@ -1,11 +1,82 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::KMS
+
+ # When KMS returns an error response, the Ruby SDK constructs and raises an error.
+ # These errors all extend Aws::KMS::Errors::ServiceError < {Aws::Errors::ServiceError}
+ #
+ # You can rescue all KMS errors using ServiceError:
+ #
+ # begin
+ # # do stuff
+ # rescue Aws::KMS::Errors::ServiceError
+ # # rescues all KMS API errors
+ # end
+ #
+ #
+ # ## Request Context
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+ # information about the request that generated the error.
+ # See {Seahorse::Client::RequestContext} for more information.
+ #
+ # ## Error Classes
+ # * {AlreadyExistsException}
+ # * {CloudHsmClusterInUseException}
+ # * {CloudHsmClusterInvalidConfigurationException}
+ # * {CloudHsmClusterNotActiveException}
+ # * {CloudHsmClusterNotFoundException}
+ # * {CloudHsmClusterNotRelatedException}
+ # * {CustomKeyStoreHasCMKsException}
+ # * {CustomKeyStoreInvalidStateException}
+ # * {CustomKeyStoreNameInUseException}
+ # * {CustomKeyStoreNotFoundException}
+ # * {DependencyTimeoutException}
+ # * {DisabledException}
+ # * {DryRunOperationException}
+ # * {ExpiredImportTokenException}
+ # * {IncorrectKeyException}
+ # * {IncorrectKeyMaterialException}
+ # * {IncorrectTrustAnchorException}
+ # * {InvalidAliasNameException}
+ # * {InvalidArnException}
+ # * {InvalidCiphertextException}
+ # * {InvalidGrantIdException}
+ # * {InvalidGrantTokenException}
+ # * {InvalidImportTokenException}
+ # * {InvalidKeyUsageException}
+ # * {InvalidMarkerException}
+ # * {KMSInternalException}
+ # * {KMSInvalidMacException}
+ # * {KMSInvalidSignatureException}
+ # * {KMSInvalidStateException}
+ # * {KeyUnavailableException}
+ # * {LimitExceededException}
+ # * {MalformedPolicyDocumentException}
+ # * {NotFoundException}
+ # * {TagException}
+ # * {UnsupportedOperationException}
+ # * {XksKeyAlreadyInUseException}
+ # * {XksKeyInvalidConfigurationException}
+ # * {XksKeyNotFoundException}
+ # * {XksProxyIncorrectAuthenticationCredentialException}
+ # * {XksProxyInvalidConfigurationException}
+ # * {XksProxyInvalidResponseException}
+ # * {XksProxyUriEndpointInUseException}
+ # * {XksProxyUriInUseException}
+ # * {XksProxyUriUnreachableException}
+ # * {XksProxyVpcEndpointServiceInUseException}
+ # * {XksProxyVpcEndpointServiceInvalidConfigurationException}
+ # * {XksProxyVpcEndpointServiceNotFoundException}
+ #
+ # Additionally, error classes are dynamically generated for service errors based on the error code
+ # if they are not defined above.
module Errors
extend Aws::Errors::DynamicErrors
@@ -23,7 +94,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CloudHsmClusterInUseException < ServiceError
@@ -39,7 +109,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CloudHsmClusterInvalidConfigurationException < ServiceError
@@ -55,7 +124,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CloudHsmClusterNotActiveException < ServiceError
@@ -71,7 +139,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CloudHsmClusterNotFoundException < ServiceError
@@ -87,7 +154,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CloudHsmClusterNotRelatedException < ServiceError
@@ -103,7 +169,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CustomKeyStoreHasCMKsException < ServiceError
@@ -119,7 +184,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CustomKeyStoreInvalidStateException < ServiceError
@@ -135,7 +199,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CustomKeyStoreNameInUseException < ServiceError
@@ -151,7 +214,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class CustomKeyStoreNotFoundException < ServiceError
@@ -167,7 +229,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class DependencyTimeoutException < ServiceError
@@ -183,7 +244,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class DisabledException < ServiceError
@@ -199,7 +259,21 @@ module Aws::KMS
def message
@message || @data[:message]
end
+ end
+
+ class DryRunOperationException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::DryRunOperationException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
end
class ExpiredImportTokenException < ServiceError
@@ -215,7 +289,21 @@ module Aws::KMS
def message
@message || @data[:message]
end
+ end
+
+ class IncorrectKeyException < ServiceError
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::IncorrectKeyException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
end
class IncorrectKeyMaterialException < ServiceError
@@ -231,7 +319,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class IncorrectTrustAnchorException < ServiceError
@@ -247,7 +334,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidAliasNameException < ServiceError
@@ -263,7 +349,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidArnException < ServiceError
@@ -279,7 +364,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidCiphertextException < ServiceError
@@ -295,7 +379,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidGrantIdException < ServiceError
@@ -311,7 +394,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidGrantTokenException < ServiceError
@@ -327,7 +409,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidImportTokenException < ServiceError
@@ -343,7 +424,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidKeyUsageException < ServiceError
@@ -359,7 +439,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class InvalidMarkerException < ServiceError
@@ -375,7 +454,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class KMSInternalException < ServiceError
@@ -391,7 +469,36 @@ module Aws::KMS
def message
@message || @data[:message]
end
+ end
+
+ class KMSInvalidMacException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::KMSInvalidMacException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class KMSInvalidSignatureException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::KMSInvalidSignatureException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
end
class KMSInvalidStateException < ServiceError
@@ -407,7 +514,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class KeyUnavailableException < ServiceError
@@ -423,7 +529,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class LimitExceededException < ServiceError
@@ -439,7 +544,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class MalformedPolicyDocumentException < ServiceError
@@ -455,7 +559,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class NotFoundException < ServiceError
@@ -471,7 +574,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class TagException < ServiceError
@@ -487,7 +589,6 @@ module Aws::KMS
def message
@message || @data[:message]
end
-
end
class UnsupportedOperationException < ServiceError
@@ -503,7 +604,186 @@ module Aws::KMS
def message
@message || @data[:message]
end
+ end
+
+ class XksKeyAlreadyInUseException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksKeyAlreadyInUseException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+ class XksKeyInvalidConfigurationException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksKeyInvalidConfigurationException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksKeyNotFoundException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksKeyNotFoundException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyIncorrectAuthenticationCredentialException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyIncorrectAuthenticationCredentialException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyInvalidConfigurationException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyInvalidConfigurationException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyInvalidResponseException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyInvalidResponseException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyUriEndpointInUseException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyUriEndpointInUseException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyUriInUseException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyUriInUseException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyUriUnreachableException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyUriUnreachableException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyVpcEndpointServiceInUseException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceInUseException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyVpcEndpointServiceInvalidConfigurationException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
+ end
+
+ class XksProxyVpcEndpointServiceNotFoundException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceNotFoundException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+
+ # @return [String]
+ def message
+ @message || @data[:message]
+ end
end
end
diff --git a/lib/aws-sdk-kms/plugins/endpoints.rb b/lib/aws-sdk-kms/plugins/endpoints.rb
new file mode 100644
index 0000000..e85a407
--- /dev/null
+++ b/lib/aws-sdk-kms/plugins/endpoints.rb
@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::KMS
+ module Plugins
+ class Endpoints < Seahorse::Client::Plugin
+ option(
+ :endpoint_provider,
+ doc_type: 'Aws::KMS::EndpointProvider',
+ docstring: 'The endpoint provider used to resolve endpoints. Any '\
+ 'object that responds to `#resolve_endpoint(parameters)` '\
+ 'where `parameters` is a Struct similar to '\
+ '`Aws::KMS::EndpointParameters`'
+ ) do |cfg|
+ Aws::KMS::EndpointProvider.new
+ end
+
+ # @api private
+ class Handler < Seahorse::Client::Handler
+ def call(context)
+ # If endpoint was discovered, do not resolve or apply the endpoint.
+ unless context[:discovered_endpoint]
+ params = parameters_for_operation(context)
+ endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+ context.http_request.endpoint = endpoint.url
+ apply_endpoint_headers(context, endpoint.headers)
+ end
+
+ context[:endpoint_params] = params
+ context[:auth_scheme] =
+ Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+ @handler.call(context)
+ end
+
+ private
+
+ def apply_endpoint_headers(context, headers)
+ headers.each do |key, values|
+ value = values
+ .compact
+ .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+ .join(',')
+
+ context.http_request.headers[key] = value
+ end
+ end
+
+ def parameters_for_operation(context)
+ case context.operation_name
+ when :cancel_key_deletion
+ Aws::KMS::Endpoints::CancelKeyDeletion.build(context)
+ when :connect_custom_key_store
+ Aws::KMS::Endpoints::ConnectCustomKeyStore.build(context)
+ when :create_alias
+ Aws::KMS::Endpoints::CreateAlias.build(context)
+ when :create_custom_key_store
+ Aws::KMS::Endpoints::CreateCustomKeyStore.build(context)
+ when :create_grant
+ Aws::KMS::Endpoints::CreateGrant.build(context)
+ when :create_key
+ Aws::KMS::Endpoints::CreateKey.build(context)
+ when :decrypt
+ Aws::KMS::Endpoints::Decrypt.build(context)
+ when :delete_alias
+ Aws::KMS::Endpoints::DeleteAlias.build(context)
+ when :delete_custom_key_store
+ Aws::KMS::Endpoints::DeleteCustomKeyStore.build(context)
+ when :delete_imported_key_material
+ Aws::KMS::Endpoints::DeleteImportedKeyMaterial.build(context)
+ when :describe_custom_key_stores
+ Aws::KMS::Endpoints::DescribeCustomKeyStores.build(context)
+ when :describe_key
+ Aws::KMS::Endpoints::DescribeKey.build(context)
+ when :disable_key
+ Aws::KMS::Endpoints::DisableKey.build(context)
+ when :disable_key_rotation
+ Aws::KMS::Endpoints::DisableKeyRotation.build(context)
+ when :disconnect_custom_key_store
+ Aws::KMS::Endpoints::DisconnectCustomKeyStore.build(context)
+ when :enable_key
+ Aws::KMS::Endpoints::EnableKey.build(context)
+ when :enable_key_rotation
+ Aws::KMS::Endpoints::EnableKeyRotation.build(context)
+ when :encrypt
+ Aws::KMS::Endpoints::Encrypt.build(context)
+ when :generate_data_key
+ Aws::KMS::Endpoints::GenerateDataKey.build(context)
+ when :generate_data_key_pair
+ Aws::KMS::Endpoints::GenerateDataKeyPair.build(context)
+ when :generate_data_key_pair_without_plaintext
+ Aws::KMS::Endpoints::GenerateDataKeyPairWithoutPlaintext.build(context)
+ when :generate_data_key_without_plaintext
+ Aws::KMS::Endpoints::GenerateDataKeyWithoutPlaintext.build(context)
+ when :generate_mac
+ Aws::KMS::Endpoints::GenerateMac.build(context)
+ when :generate_random
+ Aws::KMS::Endpoints::GenerateRandom.build(context)
+ when :get_key_policy
+ Aws::KMS::Endpoints::GetKeyPolicy.build(context)
+ when :get_key_rotation_status
+ Aws::KMS::Endpoints::GetKeyRotationStatus.build(context)
+ when :get_parameters_for_import
+ Aws::KMS::Endpoints::GetParametersForImport.build(context)
+ when :get_public_key
+ Aws::KMS::Endpoints::GetPublicKey.build(context)
+ when :import_key_material
+ Aws::KMS::Endpoints::ImportKeyMaterial.build(context)
+ when :list_aliases
+ Aws::KMS::Endpoints::ListAliases.build(context)
+ when :list_grants
+ Aws::KMS::Endpoints::ListGrants.build(context)
+ when :list_key_policies
+ Aws::KMS::Endpoints::ListKeyPolicies.build(context)
+ when :list_keys
+ Aws::KMS::Endpoints::ListKeys.build(context)
+ when :list_resource_tags
+ Aws::KMS::Endpoints::ListResourceTags.build(context)
+ when :list_retirable_grants
+ Aws::KMS::Endpoints::ListRetirableGrants.build(context)
+ when :put_key_policy
+ Aws::KMS::Endpoints::PutKeyPolicy.build(context)
+ when :re_encrypt
+ Aws::KMS::Endpoints::ReEncrypt.build(context)
+ when :replicate_key
+ Aws::KMS::Endpoints::ReplicateKey.build(context)
+ when :retire_grant
+ Aws::KMS::Endpoints::RetireGrant.build(context)
+ when :revoke_grant
+ Aws::KMS::Endpoints::RevokeGrant.build(context)
+ when :schedule_key_deletion
+ Aws::KMS::Endpoints::ScheduleKeyDeletion.build(context)
+ when :sign
+ Aws::KMS::Endpoints::Sign.build(context)
+ when :tag_resource
+ Aws::KMS::Endpoints::TagResource.build(context)
+ when :untag_resource
+ Aws::KMS::Endpoints::UntagResource.build(context)
+ when :update_alias
+ Aws::KMS::Endpoints::UpdateAlias.build(context)
+ when :update_custom_key_store
+ Aws::KMS::Endpoints::UpdateCustomKeyStore.build(context)
+ when :update_key_description
+ Aws::KMS::Endpoints::UpdateKeyDescription.build(context)
+ when :update_primary_region
+ Aws::KMS::Endpoints::UpdatePrimaryRegion.build(context)
+ when :verify
+ Aws::KMS::Endpoints::Verify.build(context)
+ when :verify_mac
+ Aws::KMS::Endpoints::VerifyMac.build(context)
+ end
+ end
+ end
+
+ def add_handlers(handlers, _config)
+ handlers.add(Handler, step: :build, priority: 75)
+ end
+ end
+ end
+end
diff --git a/lib/aws-sdk-kms/resource.rb b/lib/aws-sdk-kms/resource.rb
index fa42909..e15bb39 100644
--- a/lib/aws-sdk-kms/resource.rb
+++ b/lib/aws-sdk-kms/resource.rb
@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::KMS
+
class Resource
# @param options ({})
diff --git a/lib/aws-sdk-kms/types.rb b/lib/aws-sdk-kms/types.rb
index e6b54e2..b1c9a96 100644
--- a/lib/aws-sdk-kms/types.rb
+++ b/lib/aws-sdk-kms/types.rb
@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -19,15 +21,29 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] target_key_id
- # String that contains the key identifier referred to by the alias.
+ # String that contains the key identifier of the KMS key associated
+ # with the alias.
# @return [String]
#
+ # @!attribute [rw] creation_date
+ # Date and time that the alias was most recently created in the
+ # account and Region. Formatted as Unix time.
+ # @return [Time]
+ #
+ # @!attribute [rw] last_updated_date
+ # Date and time that the alias was most recently associated with a KMS
+ # key in the account and Region. Formatted as Unix time.
+ # @return [Time]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/AliasListEntry AWS API Documentation
#
class AliasListEntry < Struct.new(
:alias_name,
:alias_arn,
- :target_key_id)
+ :target_key_id,
+ :creation_date,
+ :last_updated_date)
+ SENSITIVE = []
include Aws::Structure
end
@@ -41,21 +57,14 @@ module Aws::KMS
#
class AlreadyExistsException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass CancelKeyDeletionRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # The unique identifier for the customer master key (CMK) for which to
- # cancel deletion.
+ # Identifies the KMS key whose deletion is being canceled.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -64,7 +73,7 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
@@ -72,30 +81,36 @@ module Aws::KMS
#
class CancelKeyDeletionRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] key_id
- # The unique identifier of the master key for which deletion is
- # canceled.
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key whose
+ # deletion is canceled.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletionResponse AWS API Documentation
#
class CancelKeyDeletionResponse < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the specified AWS CloudHSM cluster is
- # already associated with a custom key store or it shares a backup
- # history with a cluster that is associated with a custom key store.
- # Each custom key store must be associated with a different AWS CloudHSM
- # cluster.
+ # The request was rejected because the specified CloudHSM cluster is
+ # already associated with an CloudHSM key store in the account, or it
+ # shares a backup history with an CloudHSM key store in the account.
+ # Each CloudHSM key store in the account must be associated with a
+ # different CloudHSM cluster.
#
- # Clusters that share a backup history have the same cluster
- # certificate. To view the cluster certificate of a cluster, use the
- # [DescribeClusters][1] operation.
+ # CloudHSM clusters that share a backup history have the same cluster
+ # certificate. To view the cluster certificate of an CloudHSM cluster,
+ # use the [DescribeClusters][1] operation.
#
#
#
@@ -108,42 +123,41 @@ module Aws::KMS
#
class CloudHsmClusterInUseException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the associated AWS CloudHSM cluster
- # did not meet the configuration requirements for a custom key store.
+ # The request was rejected because the associated CloudHSM cluster did
+ # not meet the configuration requirements for an CloudHSM key store.
#
- # * The cluster must be configured with private subnets in at least two
- # different Availability Zones in the Region.
+ # * The CloudHSM cluster must be configured with private subnets in at
+ # least two different Availability Zones in the Region.
#
# * The [security group for the cluster][1]
# (cloudhsm-cluster-*<cluster-id>*-sg) must include inbound
# rules and outbound rules that allow TCP traffic on ports 2223-2225.
# The **Source** in the inbound rules and the **Destination** in the
# outbound rules must match the security group ID. These rules are set
- # by default when you create the cluster. Do not delete or change
- # them. To get information about a particular security group, use the
- # [DescribeSecurityGroups][2] operation.
+ # by default when you create the CloudHSM cluster. Do not delete or
+ # change them. To get information about a particular security group,
+ # use the [DescribeSecurityGroups][2] operation.
#
- # * The cluster must contain at least as many HSMs as the operation
- # requires. To add HSMs, use the AWS CloudHSM [CreateHsm][3]
+ # * The CloudHSM cluster must contain at least as many HSMs as the
+ # operation requires. To add HSMs, use the CloudHSM [CreateHsm][3]
# operation.
#
# For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
- # operations, the AWS CloudHSM cluster must have at least two active
- # HSMs, each in a different Availability Zone. For the
- # ConnectCustomKeyStore operation, the AWS CloudHSM must contain at
- # least one active HSM.
+ # operations, the CloudHSM cluster must have at least two active HSMs,
+ # each in a different Availability Zone. For the ConnectCustomKeyStore
+ # operation, the CloudHSM must contain at least one active HSM.
#
- # For information about the requirements for an AWS CloudHSM cluster
- # that is associated with a custom key store, see [Assemble the
- # Prerequisites][4] in the *AWS Key Management Service Developer Guide*.
- # For information about creating a private subnet for an AWS CloudHSM
- # cluster, see [Create a Private Subnet][5] in the *AWS CloudHSM User
- # Guide*. For information about cluster security groups, see [Configure
- # a Default Security Group][1] in the <i> <i>AWS CloudHSM User Guide</i>
- # </i>.
+ # For information about the requirements for an CloudHSM cluster that is
+ # associated with an CloudHSM key store, see [Assemble the
+ # Prerequisites][4] in the *Key Management Service Developer Guide*. For
+ # information about creating a private subnet for an CloudHSM cluster,
+ # see [Create a Private Subnet][5] in the *CloudHSM User Guide*. For
+ # information about cluster security groups, see [Configure a Default
+ # Security Group][1] in the <i> <i>CloudHSM User Guide</i> </i>.
#
#
#
@@ -160,14 +174,14 @@ module Aws::KMS
#
class CloudHsmClusterInvalidConfigurationException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the AWS CloudHSM cluster that is
- # associated with the custom key store is not active. Initialize and
- # activate the cluster and try the command again. For detailed
- # instructions, see [Getting Started][1] in the *AWS CloudHSM User
- # Guide*.
+ # The request was rejected because the CloudHSM cluster associated with
+ # the CloudHSM key store is not active. Initialize and activate the
+ # cluster and try the command again. For detailed instructions, see
+ # [Getting Started][1] in the *CloudHSM User Guide*.
#
#
#
@@ -180,12 +194,13 @@ module Aws::KMS
#
class CloudHsmClusterNotActiveException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because AWS KMS cannot find the AWS CloudHSM
- # cluster with the specified cluster ID. Retry the request with a
- # different cluster ID.
+ # The request was rejected because KMS cannot find the CloudHSM cluster
+ # with the specified cluster ID. Retry the request with a different
+ # cluster ID.
#
# @!attribute [rw] message
# @return [String]
@@ -194,21 +209,23 @@ module Aws::KMS
#
class CloudHsmClusterNotFoundException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the specified AWS CloudHSM cluster
- # has a different cluster certificate than the original cluster. You
- # cannot use the operation to specify an unrelated cluster.
+ # The request was rejected because the specified CloudHSM cluster has a
+ # different cluster certificate than the original cluster. You cannot
+ # use the operation to specify an unrelated cluster for an CloudHSM key
+ # store.
#
- # Specify a cluster that shares a backup history with the original
- # cluster. This includes clusters that were created from a backup of the
- # current cluster, and clusters that were created from the same backup
- # that produced the current cluster.
+ # Specify an CloudHSM cluster that shares a backup history with the
+ # original cluster. This includes clusters that were created from a
+ # backup of the current cluster, and clusters that were created from the
+ # same backup that produced the current cluster.
#
- # Clusters that share a backup history have the same cluster
- # certificate. To view the cluster certificate of a cluster, use the
- # [DescribeClusters][1] operation.
+ # CloudHSM clusters that share a backup history have the same cluster
+ # certificate. To view the cluster certificate of an CloudHSM cluster,
+ # use the [DescribeClusters][1] operation.
#
#
#
@@ -221,16 +238,10 @@ module Aws::KMS
#
class CloudHsmClusterNotRelatedException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ConnectCustomKeyStoreRequest
- # data as a hash:
- #
- # {
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # }
- #
# @!attribute [rw] custom_key_store_id
# Enter the key store ID of the custom key store that you want to
# connect. To find the ID of a custom key store, use the
@@ -241,6 +252,7 @@ module Aws::KMS
#
class ConnectCustomKeyStoreRequest < Struct.new(
:custom_key_store_id)
+ SENSITIVE = []
include Aws::Structure
end
@@ -248,31 +260,52 @@ module Aws::KMS
#
class ConnectCustomKeyStoreResponse < Aws::EmptyStructure; end
- # @note When making an API call, you may pass CreateAliasRequest
- # data as a hash:
- #
- # {
- # alias_name: "AliasNameType", # required
- # target_key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] alias_name
# Specifies the alias name. This value must begin with `alias/`
- # followed by a name, such as `alias/ExampleAlias`. The alias name
- # cannot begin with `alias/aws/`. The `alias/aws/` prefix is reserved
- # for AWS managed CMKs.
+ # followed by a name, such as `alias/ExampleAlias`.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # The `AliasName` value must be string of 1-256 characters. It can
+ # contain only alphanumeric characters, forward slashes (/),
+ # underscores (\_), and dashes (-). The alias name cannot begin with
+ # `alias/aws/`. The `alias/aws/` prefix is reserved for [Amazon Web
+ # Services managed keys][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
# @return [String]
#
# @!attribute [rw] target_key_id
- # Identifies the CMK to which the alias refers. Specify the key ID or
- # the Amazon Resource Name (ARN) of the CMK. You cannot specify
- # another alias. For help finding the key ID and ARN, see [Finding the
- # Key ID and ARN][1] in the *AWS Key Management Service Developer
- # Guide*.
+ # Associates the alias with the specified [customer managed key][1].
+ # The KMS key must be in the same Amazon Web Services Region.
+ #
+ # A valid key ID is required. If you supply a null or empty string
+ # value, this operation returns an error.
+ #
+ # For help finding the key ID and ARN, see [Finding the Key ID and
+ # ARN][2] in the <i> <i>Key Management Service Developer Guide</i>
+ # </i>.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest AWS API Documentation
@@ -280,27 +313,26 @@ module Aws::KMS
class CreateAliasRequest < Struct.new(
:alias_name,
:target_key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass CreateCustomKeyStoreRequest
- # data as a hash:
- #
- # {
- # custom_key_store_name: "CustomKeyStoreNameType", # required
- # cloud_hsm_cluster_id: "CloudHsmClusterIdType", # required
- # trust_anchor_certificate: "TrustAnchorCertificateType", # required
- # key_store_password: "KeyStorePasswordType", # required
- # }
- #
# @!attribute [rw] custom_key_store_name
# Specifies a friendly name for the custom key store. The name must be
- # unique in your AWS account.
+ # unique in your Amazon Web Services account and Region. This
+ # parameter is required for all custom key stores.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
# @return [String]
#
# @!attribute [rw] cloud_hsm_cluster_id
- # Identifies the AWS CloudHSM cluster for the custom key store. Enter
- # the cluster ID of any active AWS CloudHSM cluster that is not
+ # Identifies the CloudHSM cluster for an CloudHSM key store. This
+ # parameter is required for custom key stores with
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
+ #
+ # Enter the cluster ID of any active CloudHSM cluster that is not
# already associated with a custom key store. To find the cluster ID,
# use the [DescribeClusters][1] operation.
#
@@ -310,9 +342,13 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] trust_anchor_certificate
- # Enter the content of the trust anchor certificate for the cluster.
- # This is the content of the `customerCA.crt` file that you created
- # when you [initialized the cluster][1].
+ # Specifies the certificate for an CloudHSM key store. This parameter
+ # is required for custom key stores with a `CustomKeyStoreType` of
+ # `AWS_CLOUDHSM`.
+ #
+ # Enter the content of the trust anchor certificate for the CloudHSM
+ # cluster. This is the content of the `customerCA.crt` file that you
+ # created when you [initialized the cluster][1].
#
#
#
@@ -320,25 +356,187 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] key_store_password
+ # Specifies the `kmsuser` password for an CloudHSM key store. This
+ # parameter is required for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
+ #
# Enter the password of the [ `kmsuser` crypto user (CU) account][1]
- # in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster
- # as this user to manage key material on your behalf.
+ # in the specified CloudHSM cluster. KMS logs into the cluster as this
+ # user to manage key material on your behalf.
#
- # This parameter tells AWS KMS the `kmsuser` account password; it does
- # not change the password in the AWS CloudHSM cluster.
+ # The password must be a string of 7 to 32 characters. Its value is
+ # case sensitive.
+ #
+ # This parameter tells KMS the `kmsuser` account password; it does not
+ # change the password in the CloudHSM cluster.
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser
# @return [String]
#
+ # @!attribute [rw] custom_key_store_type
+ # Specifies the type of custom key store. The default value is
+ # `AWS_CLOUDHSM`.
+ #
+ # For a custom key store backed by an CloudHSM cluster, omit the
+ # parameter or enter `AWS_CLOUDHSM`. For a custom key store backed by
+ # an external key manager outside of Amazon Web Services, enter
+ # `EXTERNAL_KEY_STORE`. You cannot change this property after the key
+ # store is created.
+ # @return [String]
+ #
+ # @!attribute [rw] xks_proxy_uri_endpoint
+ # Specifies the endpoint that KMS uses to send requests to the
+ # external key store proxy (XKS proxy). This parameter is required for
+ # custom key stores with a `CustomKeyStoreType` of
+ # `EXTERNAL_KEY_STORE`.
+ #
+ # The protocol must be HTTPS. KMS communicates on port 443. Do not
+ # specify the port in the `XksProxyUriEndpoint` value.
+ #
+ # For external key stores with `XksProxyConnectivity` value of
+ # `VPC_ENDPOINT_SERVICE`, specify `https://` followed by the private
+ # DNS name of the VPC endpoint service.
+ #
+ # For external key stores with `PUBLIC_ENDPOINT` connectivity, this
+ # endpoint must be reachable before you create the custom key store.
+ # KMS connects to the external key store proxy while creating the
+ # custom key store. For external key stores with
+ # `VPC_ENDPOINT_SERVICE` connectivity, KMS connects when you call the
+ # ConnectCustomKeyStore operation.
+ #
+ # The value of this parameter must begin with `https://`. The
+ # remainder can contain upper and lower case letters (A-Z and a-z),
+ # numbers (0-9), dots (`.`), and hyphens (`-`). Additional slashes
+ # (`/` and ``) are not permitted.
+ #
+ # <b>Uniqueness requirements: </b>
+ #
+ # * The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values
+ # must be unique in the Amazon Web Services account and Region.
+ #
+ # * An external key store with `PUBLIC_ENDPOINT` connectivity cannot
+ # use the same `XksProxyUriEndpoint` value as an external key store
+ # with `VPC_ENDPOINT_SERVICE` connectivity in the same Amazon Web
+ # Services Region.
+ #
+ # * Each external key store with `VPC_ENDPOINT_SERVICE` connectivity
+ # must have its own private DNS name. The `XksProxyUriEndpoint`
+ # value for external key stores with `VPC_ENDPOINT_SERVICE`
+ # connectivity (private DNS name) must be unique in the Amazon Web
+ # Services account and Region.
+ # @return [String]
+ #
+ # @!attribute [rw] xks_proxy_uri_path
+ # Specifies the base path to the proxy APIs for this external key
+ # store. To find this value, see the documentation for your external
+ # key store proxy. This parameter is required for all custom key
+ # stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # The value must start with `/` and must end with `/kms/xks/v1` where
+ # `v1` represents the version of the KMS external key store proxy API.
+ # This path can include an optional prefix between the required
+ # elements such as `/prefix/kms/xks/v1`.
+ #
+ # <b>Uniqueness requirements: </b>
+ #
+ # * The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values
+ # must be unique in the Amazon Web Services account and Region.
+ #
+ # ^
+ # @return [String]
+ #
+ # @!attribute [rw] xks_proxy_vpc_endpoint_service_name
+ # Specifies the name of the Amazon VPC endpoint service for interface
+ # endpoints that is used to communicate with your external key store
+ # proxy (XKS proxy). This parameter is required when the value of
+ # `CustomKeyStoreType` is `EXTERNAL_KEY_STORE` and the value of
+ # `XksProxyConnectivity` is `VPC_ENDPOINT_SERVICE`.
+ #
+ # The Amazon VPC endpoint service must [fulfill all requirements][1]
+ # for use with an external key store.
+ #
+ # **Uniqueness requirements:**
+ #
+ # * External key stores with `VPC_ENDPOINT_SERVICE` connectivity can
+ # share an Amazon VPC, but each external key store must have its own
+ # VPC endpoint service and private DNS name.
+ #
+ # ^
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements
+ # @return [String]
+ #
+ # @!attribute [rw] xks_proxy_authentication_credential
+ # Specifies an authentication credential for the external key store
+ # proxy (XKS proxy). This parameter is required for all custom key
+ # stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # The `XksProxyAuthenticationCredential` has two required elements:
+ # `RawSecretAccessKey`, a secret key, and `AccessKeyId`, a unique
+ # identifier for the `RawSecretAccessKey`. For character requirements,
+ # see
+ # [XksProxyAuthenticationCredentialType](kms/latest/APIReference/API_XksProxyAuthenticationCredentialType.html).
+ #
+ # KMS uses this authentication credential to sign requests to the
+ # external key store proxy on your behalf. This credential is
+ # unrelated to Identity and Access Management (IAM) and Amazon Web
+ # Services credentials.
+ #
+ # This parameter doesn't set or change the authentication credentials
+ # on the XKS proxy. It just tells KMS the credential that you
+ # established on your external key store proxy. If you rotate your
+ # proxy authentication credential, use the UpdateCustomKeyStore
+ # operation to provide the new credential to KMS.
+ # @return [Types::XksProxyAuthenticationCredentialType]
+ #
+ # @!attribute [rw] xks_proxy_connectivity
+ # Indicates how KMS communicates with the external key store proxy.
+ # This parameter is required for custom key stores with a
+ # `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
+ #
+ # If the external key store proxy uses a public endpoint, specify
+ # `PUBLIC_ENDPOINT`. If the external key store proxy uses a Amazon VPC
+ # endpoint service for communication with KMS, specify
+ # `VPC_ENDPOINT_SERVICE`. For help making this choice, see [Choosing a
+ # connectivity option][1] in the *Key Management Service Developer
+ # Guide*.
+ #
+ # An Amazon VPC endpoint service keeps your communication with KMS in
+ # a private address space entirely within Amazon Web Services, but it
+ # requires more configuration, including establishing a Amazon VPC
+ # with multiple subnets, a VPC endpoint service, a network load
+ # balancer, and a verified private DNS name. A public endpoint is
+ # simpler to set up, but it might be slower and might not fulfill your
+ # security requirements. You might consider testing with a public
+ # endpoint, and then establishing a VPC endpoint service for
+ # production tasks. Note that this choice does not determine the
+ # location of the external key store proxy. Even if you choose a VPC
+ # endpoint service, the proxy can be hosted within the VPC or outside
+ # of Amazon Web Services such as in your corporate data center.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStoreRequest AWS API Documentation
#
class CreateCustomKeyStoreRequest < Struct.new(
:custom_key_store_name,
:cloud_hsm_cluster_id,
:trust_anchor_certificate,
- :key_store_password)
+ :key_store_password,
+ :custom_key_store_type,
+ :xks_proxy_uri_endpoint,
+ :xks_proxy_uri_path,
+ :xks_proxy_vpc_endpoint_service_name,
+ :xks_proxy_authentication_credential,
+ :xks_proxy_connectivity)
+ SENSITIVE = [:key_store_password]
include Aws::Structure
end
@@ -350,35 +548,17 @@ module Aws::KMS
#
class CreateCustomKeyStoreResponse < Struct.new(
:custom_key_store_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass CreateGrantRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # grantee_principal: "PrincipalIdType", # required
- # retiring_principal: "PrincipalIdType",
- # operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey
- # constraints: {
- # encryption_context_subset: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # encryption_context_equals: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # },
- # grant_tokens: ["GrantTokenType"],
- # name: "GrantNameType",
- # }
- #
# @!attribute [rw] key_id
- # The unique identifier for the customer master key (CMK) that the
- # grant applies to.
+ # Identifies the KMS key for the grant. The grant gives principals
+ # permission to use this KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key
+ # in a different Amazon Web Services account, you must use the key
+ # ARN.
#
# For example:
#
@@ -387,75 +567,128 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
# @!attribute [rw] grantee_principal
- # The principal that is given permission to perform the operations
- # that the grant permits.
+ # The identity that gets the permissions specified in the grant.
#
- # To specify the principal, use the [Amazon Resource Name (ARN)][1] of
- # an AWS principal. Valid AWS principals include AWS accounts (root),
- # IAM users, IAM roles, federated users, and assumed role users. For
- # examples of the ARN syntax to use for specifying a principal, see
- # [AWS Identity and Access Management (IAM)][2] in the Example ARNs
- # section of the *AWS General Reference*.
+ # To specify the grantee principal, use the Amazon Resource Name (ARN)
+ # of an Amazon Web Services principal. Valid principals include Amazon
+ # Web Services accounts, IAM users, IAM roles, federated users, and
+ # assumed role users. For help with the ARN syntax for a principal,
+ # see [IAM ARNs][1] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
#
#
#
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
# @return [String]
#
# @!attribute [rw] retiring_principal
- # The principal that is given permission to retire the grant by using
- # RetireGrant operation.
+ # The principal that has permission to use the RetireGrant operation
+ # to retire the grant.
#
# To specify the principal, use the [Amazon Resource Name (ARN)][1] of
- # an AWS principal. Valid AWS principals include AWS accounts (root),
- # IAM users, federated users, and assumed role users. For examples of
- # the ARN syntax to use for specifying a principal, see [AWS Identity
- # and Access Management (IAM)][2] in the Example ARNs section of the
- # *AWS General Reference*.
+ # an Amazon Web Services principal. Valid principals include Amazon
+ # Web Services accounts, IAM users, IAM roles, federated users, and
+ # assumed role users. For help with the ARN syntax for a principal,
+ # see [IAM ARNs][2] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
+ #
+ # The grant determines the retiring principal. Other principals might
+ # have permission to retire the grant or revoke the grant. For
+ # details, see RevokeGrant and [Retiring and revoking grants][3] in
+ # the *Key Management Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete
# @return [String]
#
# @!attribute [rw] operations
# A list of operations that the grant permits.
+ #
+ # This list must include only operations that are permitted in a
+ # grant. Also, the operation must be supported on the KMS key. For
+ # example, you cannot create a grant for a symmetric encryption KMS
+ # key that allows the Sign operation, or a grant for an asymmetric KMS
+ # key that allows the GenerateDataKey operation. If you try, KMS
+ # returns a `ValidationError` exception. For details, see [Grant
+ # operations][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
# @return [Array<String>]
#
# @!attribute [rw] constraints
- # Allows a cryptographic operation only when the encryption context
- # matches or includes the encryption context specified in this
- # structure. For more information about encryption context, see
- # [Encryption Context][1] in the <i> <i>AWS Key Management Service
+ # Specifies a grant constraint.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # KMS supports the `EncryptionContextEquals` and
+ # `EncryptionContextSubset` grant constraints, which allow the
+ # permissions in the grant only when the encryption context in the
+ # request matches (`EncryptionContextEquals`) or includes
+ # (`EncryptionContextSubset`) the encryption context specified in the
+ # constraint.
+ #
+ # The encryption context grant constraints are supported only on
+ # [grant operations][1] that include an `EncryptionContext` parameter,
+ # such as cryptographic operations on symmetric encryption KMS keys.
+ # Grants with grant constraints can include the DescribeKey and
+ # RetireGrant operations, but the constraint doesn't apply to these
+ # operations. If a grant with a grant constraint includes the
+ # `CreateGrant` operation, the constraint requires that any grants
+ # created with the `CreateGrant` permission have an equally strict or
+ # stricter encryption context constraint.
+ #
+ # You cannot use an encryption context grant constraint for
+ # cryptographic operations with asymmetric KMS keys or HMAC KMS keys.
+ # Operations with these keys don't support an encryption context.
+ #
+ # Each constraint value can include up to 8 encryption context pairs.
+ # The encryption context value in each constraint cannot exceed 384
+ # characters. For information about grant constraints, see [Using
+ # grant constraints][2] in the *Key Management Service Developer
+ # Guide*. For more information about encryption context, see
+ # [Encryption context][3] in the <i> <i>Key Management Service
# Developer Guide</i> </i>.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
# @return [Types::GrantConstraints]
#
# @!attribute [rw] grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [Array<String>]
#
# @!attribute [rw] name
- # A friendly name for identifying the grant. Use this value to prevent
- # the unintended creation of duplicate grants when retrying this
- # request.
+ # A friendly name for the grant. Use this value to prevent the
+ # unintended creation of duplicate grants when retrying this request.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
#
# When this value is absent, all `CreateGrant` requests result in a
# new grant with a unique `GrantId` even if all the supplied
@@ -466,10 +699,22 @@ module Aws::KMS
# with identical parameters; if the grant already exists, the original
# `GrantId` is returned without creating a new grant. Note that the
# returned grant token is unique with every `CreateGrant` request,
- # even when a duplicate `GrantId` is returned. All grant tokens
- # obtained in this way can be used interchangeably.
+ # even when a duplicate `GrantId` is returned. All grant tokens for
+ # the same grant ID can be used interchangeably.
# @return [String]
#
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantRequest AWS API Documentation
#
class CreateGrantRequest < Struct.new(
@@ -479,26 +724,31 @@ module Aws::KMS
:operations,
:constraints,
:grant_tokens,
- :name)
+ :name,
+ :dry_run)
+ SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] grant_token
# The grant token.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [String]
#
# @!attribute [rw] grant_id
# The unique identifier for the grant.
#
- # You can use the `GrantId` in a subsequent RetireGrant or RevokeGrant
- # operation.
+ # You can use the `GrantId` in a ListGrants, RetireGrant, or
+ # RevokeGrant operation.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantResponse AWS API Documentation
@@ -506,118 +756,224 @@ module Aws::KMS
class CreateGrantResponse < Struct.new(
:grant_token,
:grant_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass CreateKeyRequest
- # data as a hash:
- #
- # {
- # policy: "PolicyType",
- # description: "DescriptionType",
- # key_usage: "ENCRYPT_DECRYPT", # accepts ENCRYPT_DECRYPT
- # origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL, AWS_CLOUDHSM
- # custom_key_store_id: "CustomKeyStoreIdType",
- # bypass_policy_lockout_safety_check: false,
- # tags: [
- # {
- # tag_key: "TagKeyType", # required
- # tag_value: "TagValueType", # required
- # },
- # ],
- # }
- #
# @!attribute [rw] policy
- # The key policy to attach to the CMK.
+ # The key policy to attach to the KMS key.
#
# If you provide a key policy, it must meet the following criteria:
#
- # * If you don't set `BypassPolicyLockoutSafetyCheck` to true, the
- # key policy must allow the principal that is making the `CreateKey`
- # request to make a subsequent PutKeyPolicy request on the CMK. This
- # reduces the risk that the CMK becomes unmanageable. For more
- # information, refer to the scenario in the [Default Key Policy][1]
- # section of the <i> <i>AWS Key Management Service Developer
- # Guide</i> </i>.
+ # * The key policy must allow the calling principal to make a
+ # subsequent `PutKeyPolicy` request on the KMS key. This reduces the
+ # risk that the KMS key becomes unmanageable. For more information,
+ # see [Default key policy][1] in the *Key Management Service
+ # Developer Guide*. (To omit this condition, set
+ # `BypassPolicyLockoutSafetyCheck` to true.)
#
# * Each statement in the key policy must contain one or more
# principals. The principals in the key policy must exist and be
- # visible to AWS KMS. When you create a new AWS principal (for
- # example, an IAM user or role), you might need to enforce a delay
- # before including the new principal in a key policy because the new
- # principal might not be immediately visible to AWS KMS. For more
- # information, see [Changes that I make are not always immediately
- # visible][2] in the *AWS Identity and Access Management User
- # Guide*.
+ # visible to KMS. When you create a new Amazon Web Services
+ # principal, you might need to enforce a delay before including the
+ # new principal in a key policy because the new principal might not
+ # be immediately visible to KMS. For more information, see [Changes
+ # that I make are not always immediately visible][2] in the *Amazon
+ # Web Services Identity and Access Management User Guide*.
+ #
+ # If you do not provide a key policy, KMS attaches a default key
+ # policy to the KMS key. For more information, see [Default key
+ # policy][3] in the *Key Management Service Developer Guide*.
#
- # If you do not provide a key policy, AWS KMS attaches a default key
- # policy to the CMK. For more information, see [Default Key Policy][3]
- # in the *AWS Key Management Service Developer Guide*.
+ # The key policy size quota is 32 kilobytes (32768 bytes).
#
- # The key policy size limit is 32 kilobytes (32768 bytes).
+ # For help writing and formatting a JSON policy document, see the [IAM
+ # JSON Policy Reference][4] in the <i> <i>Identity and Access
+ # Management User Guide</i> </i>.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default
+ # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
# @return [String]
#
# @!attribute [rw] description
- # A description of the CMK.
+ # A description of the KMS key. Use a description that helps you
+ # decide whether the KMS key is appropriate for a task. The default
+ # value is an empty string (no description).
#
- # Use a description that helps you decide whether the CMK is
- # appropriate for a task.
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # To set or change the description after the key is created, use
+ # UpdateKeyDescription.
# @return [String]
#
# @!attribute [rw] key_usage
- # The cryptographic operations for which you can use the CMK. The only
- # valid value is `ENCRYPT_DECRYPT`, which means you can use the CMK to
- # encrypt and decrypt data.
+ # Determines the [cryptographic operations][1] for which you can use
+ # the KMS key. The default value is `ENCRYPT_DECRYPT`. This parameter
+ # is optional when you are creating a symmetric encryption KMS key;
+ # otherwise, it is required. You can't change the `KeyUsage` value
+ # after the KMS key is created.
+ #
+ # Select only one valid value.
+ #
+ # * For symmetric encryption KMS keys, omit the parameter or specify
+ # `ENCRYPT_DECRYPT`.
+ #
+ # * For HMAC KMS keys (symmetric), specify `GENERATE_VERIFY_MAC`.
+ #
+ # * For asymmetric KMS keys with RSA key material, specify
+ # `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
+ #
+ # * For asymmetric KMS keys with ECC key material, specify
+ # `SIGN_VERIFY`.
+ #
+ # * For asymmetric KMS keys with SM2 key material (China Regions
+ # only), specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # @return [String]
+ #
+ # @!attribute [rw] customer_master_key_spec
+ # Instead, use the `KeySpec` parameter.
+ #
+ # The `KeySpec` and `CustomerMasterKeySpec` parameters work the same
+ # way. Only the names differ. We recommend that you use `KeySpec`
+ # parameter in your code. However, to avoid breaking changes, KMS
+ # supports both parameters.
+ # @return [String]
+ #
+ # @!attribute [rw] key_spec
+ # Specifies the type of KMS key to create. The default value,
+ # `SYMMETRIC_DEFAULT`, creates a KMS key with a 256-bit AES-GCM key
+ # that is used for encryption and decryption, except in China Regions,
+ # where it creates a 128-bit symmetric key that uses SM4 encryption.
+ # For help choosing a key spec for your KMS key, see [Choosing a KMS
+ # key type][1] in the <i> <i>Key Management Service Developer
+ # Guide</i> </i>.
+ #
+ # The `KeySpec` determines whether the KMS key contains a symmetric
+ # key or an asymmetric key pair. It also determines the algorithms
+ # that the KMS key supports. You can't change the `KeySpec` after the
+ # KMS key is created. To further restrict the algorithms that can be
+ # used with the KMS key, use a condition key in its key policy or IAM
+ # policy. For more information, see [kms:EncryptionAlgorithm][2],
+ # [kms:MacAlgorithm][3] or [kms:Signing Algorithm][4] in the <i>
+ # <i>Key Management Service Developer Guide</i> </i>.
+ #
+ # [Amazon Web Services services that are integrated with KMS][5] use
+ # symmetric encryption KMS keys to protect your data. These services
+ # do not support asymmetric KMS keys or HMAC KMS keys.
+ #
+ # KMS supports the following key specs for KMS keys:
+ #
+ # * Symmetric encryption key (default)
+ #
+ # * `SYMMETRIC_DEFAULT`
+ #
+ # ^
+ #
+ # * HMAC keys (symmetric)
+ #
+ # * `HMAC_224`
+ #
+ # * `HMAC_256`
+ #
+ # * `HMAC_384`
+ #
+ # * `HMAC_512`
+ #
+ # * Asymmetric RSA key pairs
+ #
+ # * `RSA_2048`
+ #
+ # * `RSA_3072`
+ #
+ # * `RSA_4096`
+ #
+ # * Asymmetric NIST-recommended elliptic curve key pairs
+ #
+ # * `ECC_NIST_P256` (secp256r1)
+ #
+ # * `ECC_NIST_P384` (secp384r1)
+ #
+ # * `ECC_NIST_P521` (secp521r1)
+ #
+ # * Other asymmetric elliptic curve key pairs
+ #
+ # * `ECC_SECG_P256K1` (secp256k1), commonly used for
+ # cryptocurrencies.
+ #
+ # ^
+ #
+ # * SM2 key pairs (China Regions only)
+ #
+ # * `SM2`
+ #
+ # ^
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm
+ # [5]: http://aws.amazon.com/kms/features/#AWS_Service_Integration
# @return [String]
#
# @!attribute [rw] origin
- # The source of the key material for the CMK. You cannot change the
- # origin after you create the CMK.
+ # The source of the key material for the KMS key. You cannot change
+ # the origin after you create the KMS key. The default is `AWS_KMS`,
+ # which means that KMS creates the key material.
#
- # The default is `AWS_KMS`, which means AWS KMS creates the key
- # material in its own key store.
+ # To [create a KMS key with no key material][1] (for imported key
+ # material), set this value to `EXTERNAL`. For more information about
+ # importing key material into KMS, see [Importing Key Material][2] in
+ # the *Key Management Service Developer Guide*. The `EXTERNAL` origin
+ # value is valid only for symmetric KMS keys.
#
- # When the parameter value is `EXTERNAL`, AWS KMS creates a CMK
- # without key material so that you can import key material from your
- # existing key management infrastructure. For more information about
- # importing key material into AWS KMS, see [Importing Key Material][1]
- # in the *AWS Key Management Service Developer Guide*.
+ # To [create a KMS key in an CloudHSM key store][3] and create its key
+ # material in the associated CloudHSM cluster, set this value to
+ # `AWS_CLOUDHSM`. You must also use the `CustomKeyStoreId` parameter
+ # to identify the CloudHSM key store. The `KeySpec` value must be
+ # `SYMMETRIC_DEFAULT`.
#
- # When the parameter value is `AWS_CLOUDHSM`, AWS KMS creates the CMK
- # in an AWS KMS [custom key store][2] and creates its key material in
- # the associated AWS CloudHSM cluster. You must also use the
- # `CustomKeyStoreId` parameter to identify the custom key store.
+ # To [create a KMS key in an external key store][4], set this value to
+ # `EXTERNAL_KEY_STORE`. You must also use the `CustomKeyStoreId`
+ # parameter to identify the external key store and the `XksKeyId`
+ # parameter to identify the associated external key. The `KeySpec`
+ # value must be `SYMMETRIC_DEFAULT`.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html
# @return [String]
#
# @!attribute [rw] custom_key_store_id
- # Creates the CMK in the specified [custom key store][1] and the key
- # material in its associated AWS CloudHSM cluster. To create a CMK in
- # a custom key store, you must also specify the `Origin` parameter
- # with a value of `AWS_CLOUDHSM`. The AWS CloudHSM cluster that is
- # associated with the custom key store must have at least two active
- # HSMs, each in a different Availability Zone in the Region.
- #
- # To find the ID of a custom key store, use the
+ # Creates the KMS key in the specified [custom key store][1]. The
+ # `ConnectionState` of the custom key store must be `CONNECTED`. To
+ # find the CustomKeyStoreID and ConnectionState use the
# DescribeCustomKeyStores operation.
#
- # The response includes the custom key store ID and the ID of the AWS
- # CloudHSM cluster.
+ # This parameter is valid only for symmetric encryption KMS keys in a
+ # single Region. You cannot create any other type of KMS key in a
+ # custom key store.
#
- # This operation is part of the [Custom Key Store feature][1] feature
- # in AWS KMS, which combines the convenience and extensive integration
- # of AWS KMS with the isolation and control of a single-tenant key
- # store.
+ # When you create a KMS key in an CloudHSM key store, KMS generates a
+ # non-exportable 256-bit symmetric key in its associated CloudHSM
+ # cluster and associates it with the KMS key. When you create a KMS
+ # key in an external key store, you must use the `XksKeyId` parameter
+ # to specify an external key that serves as key material for the KMS
+ # key.
#
#
#
@@ -625,65 +981,163 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] bypass_policy_lockout_safety_check
- # A flag to indicate whether to bypass the key policy lockout safety
- # check.
+ # Skips ("bypasses") the key policy lockout safety check. The
+ # default value is false.
#
- # Setting this value to true increases the risk that the CMK becomes
- # unmanageable. Do not set this value to true indiscriminately.
+ # Setting this value to true increases the risk that the KMS key
+ # becomes unmanageable. Do not set this value to true
+ # indiscriminately.
#
- # For more information, refer to the scenario in the [Default Key
- # Policy][1] section in the <i> <i>AWS Key Management Service
- # Developer Guide</i> </i>.
- #
- # Use this parameter only when you include a policy in the request and
- # you intend to prevent the principal that is making the request from
- # making a subsequent PutKeyPolicy request on the CMK.
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
#
- # The default value is false.
+ # Use this parameter only when you intend to prevent the principal
+ # that is making the request from making a subsequent PutKeyPolicy
+ # request on the KMS key.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
# @return [Boolean]
#
# @!attribute [rw] tags
- # One or more tags. Each tag consists of a tag key and a tag value.
- # Tag keys and tag values are both required, but tag values can be
- # empty (null) strings.
+ # Assigns one or more tags to the KMS key. Use this parameter to tag
+ # the KMS key when it is created. To tag an existing KMS key, use the
+ # TagResource operation.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the
+ # KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # </note>
+ #
+ # To use this parameter, you must have [kms:TagResource][2] permission
+ # in an IAM policy.
+ #
+ # Each tag consists of a tag key and a tag value. Both the tag key and
+ # the tag value are required, but the tag value can be an empty (null)
+ # string. You cannot have more than one tag on a KMS key with the same
+ # tag key. If you specify an existing tag key with a different tag
+ # value, KMS replaces the current tag value with the specified one.
+ #
+ # When you add tags to an Amazon Web Services resource, Amazon Web
+ # Services generates a cost allocation report with usage and costs
+ # aggregated by tags. Tags can also be used to control access to a KMS
+ # key. For details, see [Tagging Keys][3].
#
- # Use this parameter to tag the CMK when it is created. Alternately,
- # you can omit this parameter and instead tag the CMK after it is
- # created using TagResource.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
# @return [Array<Types::Tag>]
#
+ # @!attribute [rw] multi_region
+ # Creates a multi-Region primary key that you can replicate into other
+ # Amazon Web Services Regions. You cannot change this value after you
+ # create the KMS key.
+ #
+ # For a multi-Region key, set this parameter to `True`. For a
+ # single-Region KMS key, omit this parameter or set it to `False`. The
+ # default value is `False`.
+ #
+ # This operation supports *multi-Region keys*, an KMS feature that
+ # lets you create multiple interoperable KMS keys in different Amazon
+ # Web Services Regions. Because these KMS keys have the same key ID,
+ # key material, and other metadata, you can use them interchangeably
+ # to encrypt data in one Amazon Web Services Region and decrypt it in
+ # a different Amazon Web Services Region without re-encrypting the
+ # data or making a cross-Region call. For more information about
+ # multi-Region keys, see [Multi-Region keys in KMS][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # This value creates a *primary key*, not a replica. To create a
+ # *replica key*, use the ReplicateKey operation.
+ #
+ # You can create a symmetric or asymmetric multi-Region key, and you
+ # can create a multi-Region key with imported key material. However,
+ # you cannot create a multi-Region key in a custom key store.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
+ # @return [Boolean]
+ #
+ # @!attribute [rw] xks_key_id
+ # Identifies the [external key][1] that serves as key material for the
+ # KMS key in an [external key store][2]. Specify the ID that the
+ # [external key store proxy][3] uses to refer to the external key. For
+ # help, see the documentation for your external key store proxy.
+ #
+ # This parameter is required for a KMS key with an `Origin` value of
+ # `EXTERNAL_KEY_STORE`. It is not valid for KMS keys with any other
+ # `Origin` value.
+ #
+ # The external key must be an existing 256-bit AES symmetric
+ # encryption key hosted outside of Amazon Web Services in an external
+ # key manager associated with the external key store specified by the
+ # `CustomKeyStoreId` parameter. This key must be enabled and
+ # configured to perform encryption and decryption. Each KMS key in an
+ # external key store must use a different external key. For details,
+ # see [Requirements for a KMS key in an external key store][4] in the
+ # *Key Management Service Developer Guide*.
+ #
+ # Each KMS key in an external key store is associated two backing
+ # keys. One is key material that KMS generates. The other is the
+ # external key specified by this parameter. When you use the KMS key
+ # in an external key store to encrypt data, the encryption operation
+ # is performed first by KMS using the KMS key material, and then by
+ # the external key manager using the specified external key, a process
+ # known as *double encryption*. For details, see [Double
+ # encryption][5] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy
+ # [4]: https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyRequest AWS API Documentation
#
class CreateKeyRequest < Struct.new(
:policy,
:description,
:key_usage,
+ :customer_master_key_spec,
+ :key_spec,
:origin,
:custom_key_store_id,
:bypass_policy_lockout_safety_check,
- :tags)
+ :tags,
+ :multi_region,
+ :xks_key_id)
+ SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] key_metadata
- # Metadata associated with the CMK.
+ # Metadata associated with the KMS key.
# @return [Types::KeyMetadata]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyResponse AWS API Documentation
#
class CreateKeyResponse < Struct.new(
:key_metadata)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the custom key store contains AWS KMS
- # customer master keys (CMKs). After verifying that you do not need to
- # use the CMKs, use the ScheduleKeyDeletion operation to delete the
- # CMKs. After they are deleted, you can delete the custom key store.
+ # The request was rejected because the custom key store contains KMS
+ # keys. After verifying that you do not need to use the KMS keys, use
+ # the ScheduleKeyDeletion operation to delete the KMS keys. After they
+ # are deleted, you can delete the custom key store.
#
# @!attribute [rw] message
# @return [String]
@@ -692,6 +1146,7 @@ module Aws::KMS
#
class CustomKeyStoreHasCMKsException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
@@ -701,18 +1156,29 @@ module Aws::KMS
#
# This exception is thrown under the following conditions:
#
- # * You requested the CreateKey or GenerateRandom operation in a custom
- # key store that is not connected. These operations are valid only
- # when the custom key store `ConnectionState` is `CONNECTED`.
+ # * You requested the ConnectCustomKeyStore operation on a custom key
+ # store with a `ConnectionState` of `DISCONNECTING` or `FAILED`. This
+ # operation is valid for all other `ConnectionState` values. To
+ # reconnect a custom key store in a `FAILED` state, disconnect it
+ # (DisconnectCustomKeyStore), then connect it
+ # (`ConnectCustomKeyStore`).
+ #
+ # * You requested the CreateKey operation in a custom key store that is
+ # not connected. This operations is valid only when the custom key
+ # store `ConnectionState` is `CONNECTED`.
+ #
+ # * You requested the DisconnectCustomKeyStore operation on a custom key
+ # store with a `ConnectionState` of `DISCONNECTING` or `DISCONNECTED`.
+ # This operation is valid for all other `ConnectionState` values.
#
# * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore
# operation on a custom key store that is not disconnected. This
# operation is valid only when the custom key store `ConnectionState`
# is `DISCONNECTED`.
#
- # * You requested the ConnectCustomKeyStore operation on a custom key
- # store with a `ConnectionState` of `DISCONNECTING` or `FAILED`. This
- # operation is valid for all other `ConnectionState` values.
+ # * You requested the GenerateRandom operation in an CloudHSM key store
+ # that is not connected. This operation is valid only when the
+ # CloudHSM key store `ConnectionState` is `CONNECTED`.
#
# @!attribute [rw] message
# @return [String]
@@ -721,6 +1187,7 @@ module Aws::KMS
#
class CustomKeyStoreInvalidStateException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
@@ -735,11 +1202,12 @@ module Aws::KMS
#
class CustomKeyStoreNameInUseException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because AWS KMS cannot find a custom key
- # store with the specified key store name or ID.
+ # The request was rejected because KMS cannot find a custom key store
+ # with the specified key store name or ID.
#
# @!attribute [rw] message
# @return [String]
@@ -748,6 +1216,7 @@ module Aws::KMS
#
class CustomKeyStoreNotFoundException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
@@ -763,14 +1232,18 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] cloud_hsm_cluster_id
- # A unique identifier for the AWS CloudHSM cluster that is associated
- # with the custom key store.
+ # A unique identifier for the CloudHSM cluster that is associated with
+ # an CloudHSM key store. This field appears only when the
+ # `CustomKeyStoreType` is `AWS_CLOUDHSM`.
# @return [String]
#
# @!attribute [rw] trust_anchor_certificate
- # The trust anchor certificate of the associated AWS CloudHSM cluster.
- # When you [initialize the cluster][1], you create this certificate
- # and save it in the `customerCA.crt` file.
+ # The trust anchor certificate of the CloudHSM cluster associated with
+ # an CloudHSM key store. When you [initialize the cluster][1], you
+ # create this certificate and save it in the `customerCA.crt` file.
+ #
+ # This field appears only when the `CustomKeyStoreType` is
+ # `AWS_CLOUDHSM`.
#
#
#
@@ -778,22 +1251,31 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] connection_state
- # Indicates whether the custom key store is connected to its AWS
- # CloudHSM cluster.
- #
- # You can create and use CMKs in your custom key stores only when its
- # connection state is `CONNECTED`.
- #
- # The value is `DISCONNECTED` if the key store has never been
- # connected or you use the DisconnectCustomKeyStore operation to
- # disconnect it. If the value is `CONNECTED` but you are having
- # trouble using the custom key store, make sure that its associated
- # AWS CloudHSM cluster is active and contains at least one active HSM.
+ # Indicates whether the custom key store is connected to its backing
+ # key store. For an CloudHSM key store, the `ConnectionState`
+ # indicates whether it is connected to its CloudHSM cluster. For an
+ # external key store, the `ConnectionState` indicates whether it is
+ # connected to the external key store proxy that communicates with
+ # your external key manager.
+ #
+ # You can create and use KMS keys in your custom key stores only when
+ # its `ConnectionState` is `CONNECTED`.
+ #
+ # The `ConnectionState` value is `DISCONNECTED` only if the key store
+ # has never been connected or you use the DisconnectCustomKeyStore
+ # operation to disconnect it. If the value is `CONNECTED` but you are
+ # having trouble using the custom key store, make sure that the
+ # backing key store is reachable and active. For an CloudHSM key
+ # store, verify that its associated CloudHSM cluster is active and
+ # contains at least one active HSM. For an external key store, verify
+ # that the external key store proxy and external key manager are
+ # connected and enabled.
#
# A value of `FAILED` indicates that an attempt to connect was
- # unsuccessful. For help resolving a connection failure, see
- # [Troubleshooting a Custom Key Store][1] in the *AWS Key Management
- # Service Developer Guide*.
+ # unsuccessful. The `ConnectionErrorCode` field in the response
+ # indicates the cause of the failure. For help resolving a connection
+ # failure, see [Troubleshooting a custom key store][1] in the *Key
+ # Management Service Developer Guide*.
#
#
#
@@ -801,45 +1283,191 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] connection_error_code
- # Describes the connection error. Valid values are:
- #
- # * `CLUSTER_NOT_FOUND` - AWS KMS cannot find the AWS CloudHSM cluster
- # with the specified cluster ID.
+ # Describes the connection error. This field appears in the response
+ # only when the `ConnectionState` is `FAILED`.
+ #
+ # Many failures can be resolved by updating the properties of the
+ # custom key store. To update a custom key store, disconnect it
+ # (DisconnectCustomKeyStore), correct the errors
+ # (UpdateCustomKeyStore), and try to connect again
+ # (ConnectCustomKeyStore). For additional help resolving these errors,
+ # see [How to Fix a Connection Failure][1] in *Key Management Service
+ # Developer Guide*.
#
- # * `INSUFFICIENT_CLOUDHSM_HSMS` - The associated AWS CloudHSM cluster
- # does not contain any active HSMs. To connect a custom key store to
- # its AWS CloudHSM cluster, the cluster must contain at least one
- # active HSM.
+ # **All custom key stores:**
#
- # * `INTERNAL_ERROR` - AWS KMS could not complete the request due to
- # an internal error. Retry the request. For `ConnectCustomKeyStore`
+ # * `INTERNAL_ERROR` — KMS could not complete the request due to an
+ # internal error. Retry the request. For `ConnectCustomKeyStore`
# requests, disconnect the custom key store before trying to connect
# again.
#
- # * `INVALID_CREDENTIALS` - AWS KMS does not have the correct password
- # for the `kmsuser` crypto user in the AWS CloudHSM cluster.
- #
- # * `NETWORK_ERRORS` - Network errors are preventing AWS KMS from
- # connecting to the custom key store.
+ # * `NETWORK_ERRORS` — Network errors are preventing KMS from
+ # connecting the custom key store to its backing key store.
#
- # * `USER_LOCKED_OUT` - The `kmsuser` CU account is locked out of the
- # associated AWS CloudHSM cluster due to too many failed password
- # attempts. Before you can connect your custom key store to its AWS
- # CloudHSM cluster, you must change the `kmsuser` account password
- # and update the password value for the custom key store.
+ # **CloudHSM key stores:**
#
- # For help with connection failures, see [Troubleshooting Custom Key
- # Stores][1] in the *AWS Key Management Service Developer Guide*.
+ # * `CLUSTER_NOT_FOUND` — KMS cannot find the CloudHSM cluster with
+ # the specified cluster ID.
#
+ # * `INSUFFICIENT_CLOUDHSM_HSMS` — The associated CloudHSM cluster
+ # does not contain any active HSMs. To connect a custom key store to
+ # its CloudHSM cluster, the cluster must contain at least one active
+ # HSM.
+ #
+ # * `INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET` — At least one private
+ # subnet associated with the CloudHSM cluster doesn't have any
+ # available IP addresses. A CloudHSM key store connection requires
+ # one free IP address in each of the associated private subnets,
+ # although two are preferable. For details, see [How to Fix a
+ # Connection Failure][1] in the *Key Management Service Developer
+ # Guide*.
#
+ # * `INVALID_CREDENTIALS` — The `KeyStorePassword` for the custom key
+ # store doesn't match the current password of the `kmsuser` crypto
+ # user in the CloudHSM cluster. Before you can connect your custom
+ # key store to its CloudHSM cluster, you must change the `kmsuser`
+ # account password and update the `KeyStorePassword` value for the
+ # custom key store.
+ #
+ # * `SUBNET_NOT_FOUND` — A subnet in the CloudHSM cluster
+ # configuration was deleted. If KMS cannot find all of the subnets
+ # in the cluster configuration, attempts to connect the custom key
+ # store to the CloudHSM cluster fail. To fix this error, create a
+ # cluster from a recent backup and associate it with your custom key
+ # store. (This process creates a new cluster configuration with a
+ # VPC and private subnets.) For details, see [How to Fix a
+ # Connection Failure][1] in the *Key Management Service Developer
+ # Guide*.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html
+ # * `USER_LOCKED_OUT` — The `kmsuser` CU account is locked out of the
+ # associated CloudHSM cluster due to too many failed password
+ # attempts. Before you can connect your custom key store to its
+ # CloudHSM cluster, you must change the `kmsuser` account password
+ # and update the key store password value for the custom key store.
+ #
+ # * `USER_LOGGED_IN` — The `kmsuser` CU account is logged into the
+ # associated CloudHSM cluster. This prevents KMS from rotating the
+ # `kmsuser` account password and logging into the cluster. Before
+ # you can connect your custom key store to its CloudHSM cluster, you
+ # must log the `kmsuser` CU out of the cluster. If you changed the
+ # `kmsuser` password to log into the cluster, you must also and
+ # update the key store password value for the custom key store. For
+ # help, see [How to Log Out and Reconnect][2] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # * `USER_NOT_FOUND` — KMS cannot find a `kmsuser` CU account in the
+ # associated CloudHSM cluster. Before you can connect your custom
+ # key store to its CloudHSM cluster, you must create a `kmsuser` CU
+ # account in the cluster, and then update the key store password
+ # value for the custom key store.
+ #
+ # **External key stores:**
+ #
+ # * `INVALID_CREDENTIALS` — One or both of the
+ # `XksProxyAuthenticationCredential` values is not valid on the
+ # specified external key store proxy.
+ #
+ # * `XKS_PROXY_ACCESS_DENIED` — KMS requests are denied access to the
+ # external key store proxy. If the external key store proxy has
+ # authorization rules, verify that they permit KMS to communicate
+ # with the proxy on your behalf.
+ #
+ # * `XKS_PROXY_INVALID_CONFIGURATION` — A configuration error is
+ # preventing the external key store from connecting to its proxy.
+ # Verify the value of the `XksProxyUriPath`.
+ #
+ # * `XKS_PROXY_INVALID_RESPONSE` — KMS cannot interpret the response
+ # from the external key store proxy. If you see this connection
+ # error code repeatedly, notify your external key store proxy
+ # vendor.
+ #
+ # * `XKS_PROXY_INVALID_TLS_CONFIGURATION` — KMS cannot connect to the
+ # external key store proxy because the TLS configuration is invalid.
+ # Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify
+ # that the TLS certificate is not expired, and that it matches the
+ # hostname in the `XksProxyUriEndpoint` value, and that it is signed
+ # by a certificate authority included in the [Trusted Certificate
+ # Authorities][3] list.
+ #
+ # * `XKS_PROXY_NOT_REACHABLE` — KMS can't communicate with your
+ # external key store proxy. Verify that the `XksProxyUriEndpoint`
+ # and `XksProxyUriPath` are correct. Use the tools for your external
+ # key store proxy to verify that the proxy is active and available
+ # on its network. Also, verify that your external key manager
+ # instances are operating properly. Connection attempts fail with
+ # this connection error code if the proxy reports that all external
+ # key manager instances are unavailable.
+ #
+ # * `XKS_PROXY_TIMED_OUT` — KMS can connect to the external key store
+ # proxy, but the proxy does not respond to KMS in the time allotted.
+ # If you see this connection error code repeatedly, notify your
+ # external key store proxy vendor.
+ #
+ # * `XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION` — The Amazon VPC
+ # endpoint service configuration doesn't conform to the
+ # requirements for an KMS external key store.
+ #
+ # * The VPC endpoint service must be an endpoint service for
+ # interface endpoints in the caller's Amazon Web Services
+ # account.
+ #
+ # * It must have a network load balancer (NLB) connected to at least
+ # two subnets, each in a different Availability Zone.
+ #
+ # * The `Allow principals` list must include the KMS service
+ # principal for the Region, `cks.kms.<region>.amazonaws.com`, such
+ # as `cks.kms.us-east-1.amazonaws.com`.
+ #
+ # * It must *not* require [acceptance][4] of connection requests.
+ #
+ # * It must have a private DNS name. The private DNS name for an
+ # external key store with `VPC_ENDPOINT_SERVICE` connectivity must
+ # be unique in its Amazon Web Services Region.
+ #
+ # * The domain of the private DNS name must have a [verification
+ # status][5] of `verified`.
+ #
+ # * The [TLS certificate][6] specifies the private DNS hostname at
+ # which the endpoint is reachable.
+ #
+ # * `XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND` — KMS can't find the VPC
+ # endpoint service that it uses to communicate with the external key
+ # store proxy. Verify that the `XksProxyVpcEndpointServiceName` is
+ # correct and the KMS service principal has service consumer
+ # permissions on the Amazon VPC endpoint service.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2
+ # [3]: https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities
+ # [4]: https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html
+ # [5]: https://docs.aws.amazon.com/vpc/latest/privatelink/verify-domains.html
+ # [6]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html
# @return [String]
#
# @!attribute [rw] creation_date
# The date and time when the custom key store was created.
# @return [Time]
#
+ # @!attribute [rw] custom_key_store_type
+ # Indicates the type of the custom key store. `AWS_CLOUDHSM` indicates
+ # a custom key store backed by an CloudHSM cluster.
+ # `EXTERNAL_KEY_STORE` indicates a custom key store backed by an
+ # external key store proxy and external key manager outside of Amazon
+ # Web Services.
+ # @return [String]
+ #
+ # @!attribute [rw] xks_proxy_configuration
+ # Configuration settings for the external key store proxy (XKS proxy).
+ # The external key store proxy translates KMS requests into a format
+ # that your external key manager can understand. The proxy
+ # configuration includes connection information that KMS requires.
+ #
+ # This field appears only when the `CustomKeyStoreType` is
+ # `EXTERNAL_KEY_STORE`.
+ # @return [Types::XksProxyConfigurationType]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoresListEntry AWS API Documentation
#
class CustomKeyStoresListEntry < Struct.new(
@@ -849,101 +1477,220 @@ module Aws::KMS
:trust_anchor_certificate,
:connection_state,
:connection_error_code,
- :creation_date)
+ :creation_date,
+ :custom_key_store_type,
+ :xks_proxy_configuration)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DecryptRequest
- # data as a hash:
- #
- # {
- # ciphertext_blob: "data", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
- # }
- #
# @!attribute [rw] ciphertext_blob
# Ciphertext to be decrypted. The blob includes metadata.
# @return [String]
#
# @!attribute [rw] encryption_context
- # The encryption context. If this was specified in the Encrypt
- # function, it must be specified here or the decryption operation will
- # fail. For more information, see [Encryption Context][1].
+ # Specifies the encryption context to use when decrypting the data. An
+ # encryption context is valid only for [cryptographic operations][1]
+ # with a symmetric encryption KMS key. The standard asymmetric
+ # encryption algorithms and HMAC algorithms that KMS uses do not
+ # support an encryption context.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][2] in the *Key
+ # Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
# @return [Hash<String,String>]
#
# @!attribute [rw] grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [Array<String>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest AWS API Documentation
- #
- class DecryptRequest < Struct.new(
- :ciphertext_blob,
- :encryption_context,
- :grant_tokens)
- include Aws::Structure
- end
-
# @!attribute [rw] key_id
- # ARN of the key used to perform the decryption. This value is
- # returned if no errors are encountered during the operation.
- # @return [String]
+ # Specifies the KMS key that KMS uses to decrypt the ciphertext.
#
- # @!attribute [rw] plaintext
- # Decrypted plaintext data. When you use the HTTP API or the AWS CLI,
- # the value is Base64-encoded. Otherwise, it is not encoded.
- # @return [String]
+ # Enter a key ID of the KMS key that was used to encrypt the
+ # ciphertext. If you identify a different KMS key, the `Decrypt`
+ # operation throws an `IncorrectKeyException`.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse AWS API Documentation
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. If you used a symmetric encryption KMS
+ # key, KMS can get the KMS key from metadata that it adds to the
+ # symmetric ciphertext blob. However, it is always recommended as a
+ # best practice. This practice ensures that you use the KMS key that
+ # you intend.
#
- class DecryptResponse < Struct.new(
- :key_id,
- :plaintext)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass DeleteAliasRequest
- # data as a hash:
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
- # {
- # alias_name: "AliasNameType", # required
- # }
+ # For example:
#
- # @!attribute [rw] alias_name
- # The alias to be deleted. The alias name must begin with `alias/`
- # followed by the alias name, such as `alias/ExampleAlias`.
- # @return [String]
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasRequest AWS API Documentation
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- class DeleteAliasRequest < Struct.new(
- :alias_name)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass DeleteCustomKeyStoreRequest
- # data as a hash:
+ # * Alias name: `alias/ExampleAlias`
#
- # {
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # }
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # @!attribute [rw] custom_key_store_id
- # Enter the ID of the custom key store you want to delete. To find the
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ # @return [String]
+ #
+ # @!attribute [rw] encryption_algorithm
+ # Specifies the encryption algorithm that will be used to decrypt the
+ # ciphertext. Specify the same algorithm that was used to encrypt the
+ # data. If you specify a different algorithm, the `Decrypt` operation
+ # fails.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. The default value, `SYMMETRIC_DEFAULT`,
+ # represents the only supported algorithm that is valid for symmetric
+ # encryption KMS keys.
+ # @return [String]
+ #
+ # @!attribute [rw] recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's
+ # public key. The only valid encryption algorithm is
+ # `RSAES_OAEP_SHA_256`.
+ #
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
+ #
+ # When you use this parameter, instead of returning the plaintext
+ # data, KMS encrypts the plaintext data with the public key in the
+ # attestation document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can
+ # be decrypted only with the private key in the enclave. The
+ # `Plaintext` field in the response is null or empty.
+ #
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [Types::RecipientInfo]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest AWS API Documentation
+ #
+ class DecryptRequest < Struct.new(
+ :ciphertext_blob,
+ :encryption_context,
+ :grant_tokens,
+ :key_id,
+ :encryption_algorithm,
+ :recipient,
+ :dry_run)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that was used
+ # to decrypt the ciphertext.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
+ #
+ # @!attribute [rw] plaintext
+ # Decrypted plaintext data. When you use the HTTP API or the Amazon
+ # Web Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded.
+ #
+ # If the response includes the `CiphertextForRecipient` field, the
+ # `Plaintext` field is null or empty.
+ # @return [String]
+ #
+ # @!attribute [rw] encryption_algorithm
+ # The encryption algorithm that was used to decrypt the ciphertext.
+ # @return [String]
+ #
+ # @!attribute [rw] ciphertext_for_recipient
+ # The plaintext data encrypted with the public key in the attestation
+ # document.
+ #
+ # This field is included in the response only when the `Recipient`
+ # parameter in the request includes a valid attestation document from
+ # an Amazon Web Services Nitro enclave. For information about the
+ # interaction between KMS and Amazon Web Services Nitro Enclaves, see
+ # [How Amazon Web Services Nitro Enclaves uses KMS][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse AWS API Documentation
+ #
+ class DecryptResponse < Struct.new(
+ :key_id,
+ :plaintext,
+ :encryption_algorithm,
+ :ciphertext_for_recipient)
+ SENSITIVE = [:plaintext]
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] alias_name
+ # The alias to be deleted. The alias name must begin with `alias/`
+ # followed by the alias name, such as `alias/ExampleAlias`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasRequest AWS API Documentation
+ #
+ class DeleteAliasRequest < Struct.new(
+ :alias_name)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] custom_key_store_id
+ # Enter the ID of the custom key store you want to delete. To find the
# ID of a custom key store, use the DescribeCustomKeyStores operation.
# @return [String]
#
@@ -951,6 +1698,7 @@ module Aws::KMS
#
class DeleteCustomKeyStoreRequest < Struct.new(
:custom_key_store_id)
+ SENSITIVE = []
include Aws::Structure
end
@@ -958,18 +1706,11 @@ module Aws::KMS
#
class DeleteCustomKeyStoreResponse < Aws::EmptyStructure; end
- # @note When making an API call, you may pass DeleteImportedKeyMaterialRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # Identifies the CMK from which you are deleting imported key
- # material. The `Origin` of the CMK must be `EXTERNAL`.
+ # Identifies the KMS key from which you are deleting imported key
+ # material. The `Origin` of the KMS key must be `EXTERNAL`.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -978,7 +1719,7 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
@@ -986,11 +1727,12 @@ module Aws::KMS
#
class DeleteImportedKeyMaterialRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # The system timed out while trying to fulfill the request. The request
- # can be retried.
+ # The system timed out while trying to fulfill the request. You can
+ # retry the request.
#
# @!attribute [rw] message
# @return [String]
@@ -999,27 +1741,18 @@ module Aws::KMS
#
class DependencyTimeoutException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeCustomKeyStoresRequest
- # data as a hash:
- #
- # {
- # custom_key_store_id: "CustomKeyStoreIdType",
- # custom_key_store_name: "CustomKeyStoreNameType",
- # limit: 1,
- # marker: "MarkerType",
- # }
- #
# @!attribute [rw] custom_key_store_id
# Gets only information about the specified custom key store. Enter
# the key store ID.
#
# By default, this operation gets information about all custom key
- # stores in the account and region. To limit the output to a
- # particular custom key store, you can use either the
- # `CustomKeyStoreId` or `CustomKeyStoreName` parameter, but not both.
+ # stores in the account and Region. To limit the output to a
+ # particular custom key store, provide either the `CustomKeyStoreId`
+ # or `CustomKeyStoreName` parameter, but not both.
# @return [String]
#
# @!attribute [rw] custom_key_store_name
@@ -1027,14 +1760,14 @@ module Aws::KMS
# the friendly name of the custom key store.
#
# By default, this operation gets information about all custom key
- # stores in the account and region. To limit the output to a
- # particular custom key store, you can use either the
- # `CustomKeyStoreId` or `CustomKeyStoreName` parameter, but not both.
+ # stores in the account and Region. To limit the output to a
+ # particular custom key store, provide either the `CustomKeyStoreId`
+ # or `CustomKeyStoreName` parameter, but not both.
# @return [String]
#
# @!attribute [rw] limit
# Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
+ # When this value is present, KMS does not return more than the
# specified number of items, but it might return fewer.
# @return [Integer]
#
@@ -1051,6 +1784,7 @@ module Aws::KMS
:custom_key_store_name,
:limit,
:marker)
+ SENSITIVE = []
include Aws::Structure
end
@@ -1076,28 +1810,22 @@ module Aws::KMS
:custom_key_stores,
:next_marker,
:truncated)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeKeyRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # grant_tokens: ["GrantTokenType"],
- # }
- #
# @!attribute [rw] key_id
- # Describes the specified customer master key (CMK).
+ # Describes the specified KMS key.
#
- # If you specify a predefined AWS alias (an AWS alias with no key ID),
- # KMS associates the alias with an [AWS managed CMK][1] and returns
- # its `KeyId` and `Arn` in the response.
+ # If you specify a predefined Amazon Web Services alias (an Amazon Web
+ # Services alias with no key ID), KMS associates the alias with an
+ # [Amazon Web Services managed key][1] and returns its `KeyId` and
+ # `Arn` in the response.
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must
- # use the key ARN or alias ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -1110,23 +1838,26 @@ module Aws::KMS
#
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk
# @return [String]
#
# @!attribute [rw] grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyRequest AWS API Documentation
@@ -1134,6 +1865,7 @@ module Aws::KMS
class DescribeKeyRequest < Struct.new(
:key_id,
:grant_tokens)
+ SENSITIVE = []
include Aws::Structure
end
@@ -1145,20 +1877,14 @@ module Aws::KMS
#
class DescribeKeyResponse < Struct.new(
:key_metadata)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DisableKeyRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies the KMS key to disable.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1167,7 +1893,7 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
@@ -1175,20 +1901,17 @@ module Aws::KMS
#
class DisableKeyRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DisableKeyRotationRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies a symmetric encryption KMS key. You cannot enable or
+ # disable automatic rotation of [asymmetric KMS keys][1], [HMAC KMS
+ # keys][2], KMS keys with [imported key material][3], or KMS keys in a
+ # [custom key store][4].
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1197,18 +1920,26 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationRequest AWS API Documentation
#
class DisableKeyRotationRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the specified CMK is not enabled.
+ # The request was rejected because the specified KMS key is not enabled.
#
# @!attribute [rw] message
# @return [String]
@@ -1217,16 +1948,10 @@ module Aws::KMS
#
class DisabledException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DisconnectCustomKeyStoreRequest
- # data as a hash:
- #
- # {
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # }
- #
# @!attribute [rw] custom_key_store_id
# Enter the ID of the custom key store you want to disconnect. To find
# the ID of a custom key store, use the DescribeCustomKeyStores
@@ -1237,6 +1962,7 @@ module Aws::KMS
#
class DisconnectCustomKeyStoreRequest < Struct.new(
:custom_key_store_id)
+ SENSITIVE = []
include Aws::Structure
end
@@ -1244,17 +1970,23 @@ module Aws::KMS
#
class DisconnectCustomKeyStoreResponse < Aws::EmptyStructure; end
- # @note When making an API call, you may pass EnableKeyRequest
- # data as a hash:
+ # The request was rejected because the DryRun parameter was specified.
+ #
+ # @!attribute [rw] message
+ # @return [String]
#
- # {
- # key_id: "KeyIdType", # required
- # }
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DryRunOperationException AWS API Documentation
#
+ class DryRunOperationException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies the KMS key to enable.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1263,7 +1995,7 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
@@ -1271,20 +2003,18 @@ module Aws::KMS
#
class EnableKeyRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass EnableKeyRotationRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies a symmetric encryption KMS key. You cannot enable
+ # automatic rotation of [asymmetric KMS keys][1], [HMAC KMS keys][2],
+ # KMS keys with [imported key material][3], or KMS keys in a [custom
+ # key store][4]. To enable or disable automatic rotation of a set of
+ # related [multi-Region keys][5], set the property on the primary key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1293,36 +2023,35 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotationRequest AWS API Documentation
#
class EnableKeyRotationRequest < Struct.new(
:key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass EncryptRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # plaintext: "data", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies the KMS key to use in the encryption operation. The KMS
+ # key must have a `KeyUsage` of `ENCRYPT_DECRYPT`. To find the
+ # `KeyUsage` of a KMS key, use the DescribeKey operation.
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must
- # use the key ARN or alias ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -1335,7 +2064,7 @@ module Aws::KMS
#
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
@@ -1344,58 +2073,119 @@ module Aws::KMS
# @return [String]
#
# @!attribute [rw] encryption_context
- # Name-value pair that specifies the encryption context to be used for
- # authenticated encryption. If used here, the same value must be
- # supplied to the `Decrypt` API or decryption will fail. For more
- # information, see [Encryption Context][1].
+ # Specifies the encryption context that will be used to encrypt the
+ # data. An encryption context is valid only for [cryptographic
+ # operations][1] with a symmetric encryption KMS key. The standard
+ # asymmetric encryption algorithms and HMAC algorithms that KMS uses
+ # do not support an encryption context.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][2] in the *Key
+ # Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
# @return [Hash<String,String>]
#
# @!attribute [rw] grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [Array<String>]
#
+ # @!attribute [rw] encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to encrypt the
+ # plaintext message. The algorithm must be compatible with the KMS key
+ # that you specify.
+ #
+ # This parameter is required only for asymmetric KMS keys. The default
+ # value, `SYMMETRIC_DEFAULT`, is the algorithm used for symmetric
+ # encryption KMS keys. If you are using an asymmetric KMS key, we
+ # recommend RSAES\_OAEP\_SHA\_256.
+ #
+ # The SM2PKE algorithm is only available in China Regions.
+ # @return [String]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptRequest AWS API Documentation
#
class EncryptRequest < Struct.new(
:key_id,
:plaintext,
:encryption_context,
- :grant_tokens)
+ :grant_tokens,
+ :encryption_algorithm,
+ :dry_run)
+ SENSITIVE = [:plaintext]
include Aws::Structure
end
# @!attribute [rw] ciphertext_blob
- # The encrypted plaintext. When you use the HTTP API or the AWS CLI,
- # the value is Base64-encoded. Otherwise, it is not encoded.
+ # The encrypted plaintext. When you use the HTTP API or the Amazon Web
+ # Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded.
# @return [String]
#
# @!attribute [rw] key_id
- # The ID of the key used during encryption.
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that was used
+ # to encrypt the plaintext.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
+ #
+ # @!attribute [rw] encryption_algorithm
+ # The encryption algorithm that was used to encrypt the plaintext.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptResponse AWS API Documentation
#
class EncryptResponse < Struct.new(
:ciphertext_blob,
- :key_id)
+ :key_id,
+ :encryption_algorithm)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the provided import token is expired.
- # Use GetParametersForImport to get a new import token and public key,
- # use the new public key to encrypt the key material, and then try the
- # request again.
+ # The request was rejected because the specified import token is
+ # expired. Use GetParametersForImport to get a new import token and
+ # public key, use the new public key to encrypt the key material, and
+ # then try the request again.
#
# @!attribute [rw] message
# @return [String]
@@ -1404,29 +2194,45 @@ module Aws::KMS
#
class ExpiredImportTokenException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass GenerateDataKeyRequest
- # data as a hash:
+ # @!attribute [rw] encryption_context
+ # Specifies the encryption context that will be used when encrypting
+ # the private key in the data key pair.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
#
- # {
- # key_id: "KeyIdType", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # number_of_bytes: 1,
- # key_spec: "AES_256", # accepts AES_256, AES_128
- # grant_tokens: ["GrantTokenType"],
- # }
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
#
# @!attribute [rw] key_id
- # An identifier for the CMK that encrypts the data key.
+ # Specifies the symmetric encryption KMS key that encrypts the private
+ # key in the data key pair. You cannot specify an asymmetric KMS key
+ # or a KMS key in a custom key store. To get the type and origin of
+ # your KMS key, use the DescribeKey operation.
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must
- # use the key ARN or alias ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -1439,102 +2245,189 @@ module Aws::KMS
#
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @!attribute [rw] encryption_context
- # A set of key-value pairs that represents additional authenticated
- # data.
+ # @!attribute [rw] key_pair_spec
+ # Determines the type of data key pair that is generated.
#
- # For more information, see [Encryption Context][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # The KMS rule that restricts the use of asymmetric RSA and SM2 KMS
+ # keys to encrypt and decrypt or to sign and verify (but not both),
+ # and the rule that permits you to use ECC KMS keys only to sign and
+ # verify, are not effective on data key pairs, which are used outside
+ # of KMS. The SM2 key spec is only available in China Regions.
+ # @return [String]
#
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
- # @return [Hash<String,String>]
#
- # @!attribute [rw] number_of_bytes
- # The length of the data key in bytes. For example, use the value 64
- # to generate a 512-bit data key (64 bytes is 512 bits). For common
- # key lengths (128-bit and 256-bit symmetric keys), we recommend that
- # you use the `KeySpec` field instead of this one.
- # @return [Integer]
#
- # @!attribute [rw] key_spec
- # The length of the data key. Use `AES_128` to generate a 128-bit
- # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
- # @return [String]
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- # @!attribute [rw] grant_tokens
- # A list of grant tokens.
+ # @!attribute [rw] recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's
+ # public key. The only valid encryption algorithm is
+ # `RSAES_OAEP_SHA_256`.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
#
+ # When you use this parameter, instead of returning a plaintext copy
+ # of the private data key, KMS encrypts the plaintext private data key
+ # under the public key in the attestation document, and returns the
+ # resulting ciphertext in the `CiphertextForRecipient` field in the
+ # response. This ciphertext can be decrypted only with the private key
+ # in the enclave. The `CiphertextBlob` field in the response contains
+ # a copy of the private data key encrypted under the KMS key specified
+ # by the `KeyId` parameter. The `PrivateKeyPlaintext` field in the
+ # response is null or empty.
#
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
- # @return [Array<String>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyRequest AWS API Documentation
#
- class GenerateDataKeyRequest < Struct.new(
- :key_id,
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [Types::RecipientInfo]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairRequest AWS API Documentation
+ #
+ class GenerateDataKeyPairRequest < Struct.new(
:encryption_context,
- :number_of_bytes,
- :key_spec,
- :grant_tokens)
+ :key_id,
+ :key_pair_spec,
+ :grant_tokens,
+ :recipient,
+ :dry_run)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] ciphertext_blob
- # The encrypted copy of the data key. When you use the HTTP API or the
- # AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
+ # @!attribute [rw] private_key_ciphertext_blob
+ # The encrypted copy of the private key. When you use the HTTP API or
+ # the Amazon Web Services CLI, the value is Base64-encoded. Otherwise,
+ # it is not Base64-encoded.
# @return [String]
#
- # @!attribute [rw] plaintext
- # The plaintext data key. When you use the HTTP API or the AWS CLI,
- # the value is Base64-encoded. Otherwise, it is not encoded. Use this
- # data key to encrypt your data outside of KMS. Then, remove it from
- # memory as soon as possible.
+ # @!attribute [rw] private_key_plaintext
+ # The plaintext copy of the private key. When you use the HTTP API or
+ # the Amazon Web Services CLI, the value is Base64-encoded. Otherwise,
+ # it is not Base64-encoded.
+ #
+ # If the response includes the `CiphertextForRecipient` field, the
+ # `PrivateKeyPlaintext` field is null or empty.
+ # @return [String]
+ #
+ # @!attribute [rw] public_key
+ # The public key (in plaintext). When you use the HTTP API or the
+ # Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it
+ # is not Base64-encoded.
# @return [String]
#
# @!attribute [rw] key_id
- # The identifier of the CMK that encrypted the data key.
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that
+ # encrypted the private key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyResponse AWS API Documentation
+ # @!attribute [rw] key_pair_spec
+ # The type of data key pair that was generated.
+ # @return [String]
#
- class GenerateDataKeyResponse < Struct.new(
- :ciphertext_blob,
- :plaintext,
- :key_id)
+ # @!attribute [rw] ciphertext_for_recipient
+ # The plaintext private data key encrypted with the public key from
+ # the Nitro enclave. This ciphertext can be decrypted only by using a
+ # private key in the Nitro enclave.
+ #
+ # This field is included in the response only when the `Recipient`
+ # parameter in the request includes a valid attestation document from
+ # an Amazon Web Services Nitro enclave. For information about the
+ # interaction between KMS and Amazon Web Services Nitro Enclaves, see
+ # [How Amazon Web Services Nitro Enclaves uses KMS][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairResponse AWS API Documentation
+ #
+ class GenerateDataKeyPairResponse < Struct.new(
+ :private_key_ciphertext_blob,
+ :private_key_plaintext,
+ :public_key,
+ :key_id,
+ :key_pair_spec,
+ :ciphertext_for_recipient)
+ SENSITIVE = [:private_key_plaintext]
include Aws::Structure
end
- # @note When making an API call, you may pass GenerateDataKeyWithoutPlaintextRequest
- # data as a hash:
+ # @!attribute [rw] encryption_context
+ # Specifies the encryption context that will be used when encrypting
+ # the private key in the data key pair.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
#
- # {
- # key_id: "KeyIdType", # required
- # encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # key_spec: "AES_256", # accepts AES_256, AES_128
- # number_of_bytes: 1,
- # grant_tokens: ["GrantTokenType"],
- # }
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
#
# @!attribute [rw] key_id
- # The identifier of the customer master key (CMK) that encrypts the
- # data key.
+ # Specifies the symmetric encryption KMS key that encrypts the private
+ # key in the data key pair. You cannot specify an asymmetric KMS key
+ # or a KMS key in a custom key store. To get the type and origin of
+ # your KMS key, use the DescribeKey operation.
#
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must
- # use the key ARN or alias ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -1547,219 +2440,297 @@ module Aws::KMS
#
# * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @!attribute [rw] encryption_context
- # A set of key-value pairs that represents additional authenticated
- # data.
+ # @!attribute [rw] key_pair_spec
+ # Determines the type of data key pair that is generated.
#
- # For more information, see [Encryption Context][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # The KMS rule that restricts the use of asymmetric RSA and SM2 KMS
+ # keys to encrypt and decrypt or to sign and verify (but not both),
+ # and the rule that permits you to use ECC KMS keys only to sign and
+ # verify, are not effective on data key pairs, which are used outside
+ # of KMS. The SM2 key spec is only available in China Regions.
+ # @return [String]
#
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
- # @return [Hash<String,String>]
#
- # @!attribute [rw] key_spec
- # The length of the data key. Use `AES_128` to generate a 128-bit
- # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
- # @return [String]
#
- # @!attribute [rw] number_of_bytes
- # The length of the data key in bytes. For example, use the value 64
- # to generate a 512-bit data key (64 bytes is 512 bits). For common
- # key lengths (128-bit and 256-bit symmetric keys), we recommend that
- # you use the `KeySpec` field instead of this one.
- # @return [Integer]
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- # @!attribute [rw] grant_tokens
- # A list of grant tokens.
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
- # @return [Array<String>]
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextRequest AWS API Documentation
#
- class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
- :key_id,
+ class GenerateDataKeyPairWithoutPlaintextRequest < Struct.new(
:encryption_context,
- :key_spec,
- :number_of_bytes,
- :grant_tokens)
+ :key_id,
+ :key_pair_spec,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] ciphertext_blob
- # The encrypted data key. When you use the HTTP API or the AWS CLI,
- # the value is Base64-encoded. Otherwise, it is not encoded.
+ # @!attribute [rw] private_key_ciphertext_blob
+ # The encrypted copy of the private key. When you use the HTTP API or
+ # the Amazon Web Services CLI, the value is Base64-encoded. Otherwise,
+ # it is not Base64-encoded.
+ # @return [String]
+ #
+ # @!attribute [rw] public_key
+ # The public key (in plaintext). When you use the HTTP API or the
+ # Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it
+ # is not Base64-encoded.
# @return [String]
#
# @!attribute [rw] key_id
- # The identifier of the CMK that encrypted the data key.
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that
+ # encrypted the private key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextResponse AWS API Documentation
+ # @!attribute [rw] key_pair_spec
+ # The type of data key pair that was generated.
+ # @return [String]
#
- class GenerateDataKeyWithoutPlaintextResponse < Struct.new(
- :ciphertext_blob,
- :key_id)
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextResponse AWS API Documentation
+ #
+ class GenerateDataKeyPairWithoutPlaintextResponse < Struct.new(
+ :private_key_ciphertext_blob,
+ :public_key,
+ :key_id,
+ :key_pair_spec)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass GenerateRandomRequest
- # data as a hash:
+ # @!attribute [rw] key_id
+ # Specifies the symmetric encryption KMS key that encrypts the data
+ # key. You cannot specify an asymmetric KMS key or a KMS key in a
+ # custom key store. To get the type and origin of your KMS key, use
+ # the DescribeKey operation.
#
- # {
- # number_of_bytes: 1,
- # custom_key_store_id: "CustomKeyStoreIdType",
- # }
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
- # @!attribute [rw] number_of_bytes
- # The length of the byte string.
- # @return [Integer]
+ # For example:
#
- # @!attribute [rw] custom_key_store_id
- # Generates the random byte string in the AWS CloudHSM cluster that is
- # associated with the specified [custom key store][1]. To find the ID
- # of a custom key store, use the DescribeCustomKeyStores operation.
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Alias name: `alias/ExampleAlias`
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomRequest AWS API Documentation
+ # @!attribute [rw] encryption_context
+ # Specifies the encryption context that will be used when encrypting
+ # the data key.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
#
- class GenerateRandomRequest < Struct.new(
- :number_of_bytes,
- :custom_key_store_id)
- include Aws::Structure
- end
-
- # @!attribute [rw] plaintext
- # The random byte string. When you use the HTTP API or the AWS CLI,
- # the value is Base64-encoded. Otherwise, it is not encoded.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
+ #
+ # @!attribute [rw] number_of_bytes
+ # Specifies the length of the data key in bytes. For example, use the
+ # value 64 to generate a 512-bit data key (64 bytes is 512 bits). For
+ # 128-bit (16-byte) and 256-bit (32-byte) data keys, use the `KeySpec`
+ # parameter.
+ #
+ # You must specify either the `KeySpec` or the `NumberOfBytes`
+ # parameter (but not both) in every `GenerateDataKey` request.
+ # @return [Integer]
+ #
+ # @!attribute [rw] key_spec
+ # Specifies the length of the data key. Use `AES_128` to generate a
+ # 128-bit symmetric key, or `AES_256` to generate a 256-bit symmetric
+ # key.
+ #
+ # You must specify either the `KeySpec` or the `NumberOfBytes`
+ # parameter (but not both) in every `GenerateDataKey` request.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse AWS API Documentation
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
- class GenerateRandomResponse < Struct.new(
- :plaintext)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass GetKeyPolicyRequest
- # data as a hash:
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
- # {
- # key_id: "KeyIdType", # required
- # policy_name: "PolicyNameType", # required
- # }
#
- # @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- # For example:
+ # @!attribute [rw] recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's
+ # public key. The only valid encryption algorithm is
+ # `RSAES_OAEP_SHA_256`.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # When you use this parameter, instead of returning the plaintext data
+ # key, KMS encrypts the plaintext data key under the public key in the
+ # attestation document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can
+ # be decrypted only with the private key in the enclave. The
+ # `CiphertextBlob` field in the response contains a copy of the data
+ # key encrypted under the KMS key specified by the `KeyId` parameter.
+ # The `Plaintext` field in the response is null or empty.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
- # @return [String]
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] policy_name
- # Specifies the name of the key policy. The only valid name is
- # `default`. To get the names of key policies, use ListKeyPolicies.
- # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest AWS API Documentation
#
- class GetKeyPolicyRequest < Struct.new(
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [Types::RecipientInfo]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyRequest AWS API Documentation
+ #
+ class GenerateDataKeyRequest < Struct.new(
:key_id,
- :policy_name)
+ :encryption_context,
+ :number_of_bytes,
+ :key_spec,
+ :grant_tokens,
+ :recipient,
+ :dry_run)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] policy
- # A key policy document in JSON format.
+ # @!attribute [rw] ciphertext_blob
+ # The encrypted copy of the data key. When you use the HTTP API or the
+ # Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it
+ # is not Base64-encoded.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyResponse AWS API Documentation
- #
- class GetKeyPolicyResponse < Struct.new(
- :policy)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass GetKeyRotationStatusRequest
- # data as a hash:
+ # @!attribute [rw] plaintext
+ # The plaintext data key. When you use the HTTP API or the Amazon Web
+ # Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded. Use this data key to encrypt your data outside of
+ # KMS. Then, remove it from memory as soon as possible.
#
- # {
- # key_id: "KeyIdType", # required
- # }
+ # If the response includes the `CiphertextForRecipient` field, the
+ # `Plaintext` field is null or empty.
+ # @return [String]
#
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that
+ # encrypted the data key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
#
- # For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @!attribute [rw] ciphertext_for_recipient
+ # The plaintext data key encrypted with the public key from the Nitro
+ # enclave. This ciphertext can be decrypted only by using a private
+ # key in the Nitro enclave.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
- # @return [String]
+ # This field is included in the response only when the `Recipient`
+ # parameter in the request includes a valid attestation document from
+ # an Amazon Web Services Nitro enclave. For information about the
+ # interaction between KMS and Amazon Web Services Nitro Enclaves, see
+ # [How Amazon Web Services Nitro Enclaves uses KMS][1] in the *Key
+ # Management Service Developer Guide*.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusRequest AWS API Documentation
#
- class GetKeyRotationStatusRequest < Struct.new(
- :key_id)
- include Aws::Structure
- end
-
- # @!attribute [rw] key_rotation_enabled
- # A Boolean value that specifies whether key rotation is enabled.
- # @return [Boolean]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusResponse AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [String]
#
- class GetKeyRotationStatusResponse < Struct.new(
- :key_rotation_enabled)
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyResponse AWS API Documentation
+ #
+ class GenerateDataKeyResponse < Struct.new(
+ :ciphertext_blob,
+ :plaintext,
+ :key_id,
+ :ciphertext_for_recipient)
+ SENSITIVE = [:plaintext]
include Aws::Structure
end
- # @note When making an API call, you may pass GetParametersForImportRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
- # wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048
- # }
- #
# @!attribute [rw] key_id
- # The identifier of the CMK into which you will import key material.
- # The CMK's `Origin` must be `EXTERNAL`.
+ # Specifies the symmetric encryption KMS key that encrypts the data
+ # key. You cannot specify an asymmetric KMS key or a KMS key in a
+ # custom key store. To get the type and origin of your KMS key, use
+ # the DescribeKey operation.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -1768,216 +2739,301 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @!attribute [rw] wrapping_algorithm
- # The algorithm you will use to encrypt the key material before
- # importing it with ImportKeyMaterial. For more information, see
- # [Encrypt the Key Material][1] in the *AWS Key Management Service
- # Developer Guide*.
+ # @!attribute [rw] encryption_context
+ # Specifies the encryption context that will be used when encrypting
+ # the data key.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html
- # @return [String]
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
#
- # @!attribute [rw] wrapping_key_spec
- # The type of wrapping key (public key) to return in the response.
- # Only 2048-bit RSA public keys are supported.
+ # @!attribute [rw] key_spec
+ # The length of the data key. Use `AES_128` to generate a 128-bit
+ # symmetric key, or `AES_256` to generate a 256-bit symmetric key.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportRequest AWS API Documentation
+ # @!attribute [rw] number_of_bytes
+ # The length of the data key in bytes. For example, use the value 64
+ # to generate a 512-bit data key (64 bytes is 512 bits). For common
+ # key lengths (128-bit and 256-bit symmetric keys), we recommend that
+ # you use the `KeySpec` field instead of this one.
+ # @return [Integer]
#
- class GetParametersForImportRequest < Struct.new(
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextRequest AWS API Documentation
+ #
+ class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
:key_id,
- :wrapping_algorithm,
- :wrapping_key_spec)
+ :encryption_context,
+ :key_spec,
+ :number_of_bytes,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] key_id
- # The identifier of the CMK to use in a subsequent ImportKeyMaterial
- # request. This is the same CMK specified in the
- # `GetParametersForImport` request.
+ # @!attribute [rw] ciphertext_blob
+ # The encrypted data key. When you use the HTTP API or the Amazon Web
+ # Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded.
# @return [String]
#
- # @!attribute [rw] import_token
- # The import token to send in a subsequent ImportKeyMaterial request.
- # @return [String]
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that
+ # encrypted the data key.
#
- # @!attribute [rw] public_key
- # The public key to use to encrypt the key material before importing
- # it with ImportKeyMaterial.
- # @return [String]
#
- # @!attribute [rw] parameters_valid_to
- # The time at which the import token and public key are no longer
- # valid. After this time, you cannot use them to make an
- # ImportKeyMaterial request and you must send another
- # `GetParametersForImport` request to get new ones.
- # @return [Time]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportResponse AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
#
- class GetParametersForImportResponse < Struct.new(
- :key_id,
- :import_token,
- :public_key,
- :parameters_valid_to)
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextResponse AWS API Documentation
+ #
+ class GenerateDataKeyWithoutPlaintextResponse < Struct.new(
+ :ciphertext_blob,
+ :key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # Use this structure to allow cryptographic operations in the grant only
- # when the operation request includes the specified [encryption
- # context][1].
+ # @!attribute [rw] message
+ # The message to be hashed. Specify a message of up to 4,096 bytes.
#
- # AWS KMS applies the grant constraints only when the grant allows a
- # cryptographic operation that accepts an encryption context as input,
- # such as the following.
+ # `GenerateMac` and VerifyMac do not provide special handling for
+ # message digests. If you generate an HMAC for a hash digest of a
+ # message, you must verify the HMAC of the same hash digest.
+ # @return [String]
#
- # * Encrypt
+ # @!attribute [rw] key_id
+ # The HMAC KMS key to use in the operation. The MAC algorithm computes
+ # the HMAC for the message and the key as described in [RFC 2104][1].
#
- # * Decrypt
+ # To identify an HMAC KMS key, use the DescribeKey operation and see
+ # the `KeySpec` field in the response.
#
- # * GenerateDataKey
#
- # * GenerateDataKeyWithoutPlaintext
#
- # * ReEncrypt
+ # [1]: https://datatracker.ietf.org/doc/html/rfc2104
+ # @return [String]
#
- # AWS KMS does not apply the grant constraints to other operations, such
- # as DescribeKey or ScheduleKeyDeletion.
+ # @!attribute [rw] mac_algorithm
+ # The MAC algorithm used in the operation.
#
- # In a cryptographic operation, the encryption context in the decryption
- # operation must be an exact, case-sensitive match for the keys and
- # values in the encryption context of the encryption operation. Only the
- # order of the pairs can vary.
+ # The algorithm must be compatible with the HMAC KMS key that you
+ # specify. To find the MAC algorithms that your HMAC KMS key supports,
+ # use the DescribeKey operation and see the `MacAlgorithms` field in
+ # the `DescribeKey` response.
+ # @return [String]
#
- # However, in a grant constraint, the key in each key-value pair is not
- # case sensitive, but the value is case sensitive.
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
- # To avoid confusion, do not use multiple encryption context pairs that
- # differ only by case. To require a fully case-sensitive encryption
- # context, use the `kms:EncryptionContext:` and
- # `kms:EncryptionContextKeys` conditions in an IAM or key policy. For
- # details, see [kms:EncryptionContext:][2] in the <i> <i>AWS Key
- # Management Service Developer Guide</i> </i>.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
- # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- # @note When making an API call, you may pass GrantConstraints
- # data as a hash:
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # {
- # encryption_context_subset: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # encryption_context_equals: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # }
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] encryption_context_subset
- # A list of key-value pairs that must be included in the encryption
- # context of the cryptographic operation request. The grant allows the
- # cryptographic operation only when the encryption context in the
- # request includes the key-value pairs specified in this constraint,
- # although it can include additional key-value pairs.
- # @return [Hash<String,String>]
#
- # @!attribute [rw] encryption_context_equals
- # A list of key-value pairs that must match the encryption context in
- # the cryptographic operation request. The grant allows the operation
- # only when the encryption context in the request is the same as the
- # encryption context specified in this constraint.
- # @return [Hash<String,String>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantConstraints AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
#
- class GrantConstraints < Struct.new(
- :encryption_context_subset,
- :encryption_context_equals)
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMacRequest AWS API Documentation
+ #
+ class GenerateMacRequest < Struct.new(
+ :message,
+ :key_id,
+ :mac_algorithm,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = [:message]
include Aws::Structure
end
- # Contains information about an entry in a list of grants.
+ # @!attribute [rw] mac
+ # The hash-based message authentication code (HMAC) that was generated
+ # for the specified message, HMAC KMS key, and MAC algorithm.
#
- # @!attribute [rw] key_id
- # The unique identifier for the customer master key (CMK) to which the
- # grant applies.
+ # This is the standard, raw HMAC defined in [RFC 2104][1].
+ #
+ #
+ #
+ # [1]: https://datatracker.ietf.org/doc/html/rfc2104
# @return [String]
#
- # @!attribute [rw] grant_id
- # The unique identifier for the grant.
+ # @!attribute [rw] mac_algorithm
+ # The MAC algorithm that was used to generate the HMAC.
# @return [String]
#
- # @!attribute [rw] name
- # The friendly name that identifies the grant. If a name was provided
- # in the CreateGrant request, that name is returned. Otherwise this
- # value is null.
+ # @!attribute [rw] key_id
+ # The HMAC KMS key used in the operation.
# @return [String]
#
- # @!attribute [rw] creation_date
- # The date and time when the grant was created.
- # @return [Time]
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMacResponse AWS API Documentation
#
- # @!attribute [rw] grantee_principal
- # The principal that receives the grant's permissions.
- # @return [String]
+ class GenerateMacResponse < Struct.new(
+ :mac,
+ :mac_algorithm,
+ :key_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] number_of_bytes
+ # The length of the random byte string. This parameter is required.
+ # @return [Integer]
#
- # @!attribute [rw] retiring_principal
- # The principal that can retire the grant.
- # @return [String]
+ # @!attribute [rw] custom_key_store_id
+ # Generates the random byte string in the CloudHSM cluster that is
+ # associated with the specified CloudHSM key store. To find the ID of
+ # a custom key store, use the DescribeCustomKeyStores operation.
#
- # @!attribute [rw] issuing_account
- # The AWS account under which the grant was issued.
+ # External key store IDs are not valid for this parameter. If you
+ # specify the ID of an external key store, `GenerateRandom` throws an
+ # `UnsupportedOperationException`.
# @return [String]
#
- # @!attribute [rw] operations
- # The list of operations permitted by the grant.
- # @return [Array<String>]
+ # @!attribute [rw] recipient
+ # A signed [attestation document][1] from an Amazon Web Services Nitro
+ # enclave and the encryption algorithm to use with the enclave's
+ # public key. The only valid encryption algorithm is
+ # `RSAES_OAEP_SHA_256`.
#
- # @!attribute [rw] constraints
- # A list of key-value pairs that must be present in the encryption
- # context of certain subsequent operations that the grant allows.
- # @return [Types::GrantConstraints]
+ # This parameter only supports attestation documents for Amazon Web
+ # Services Nitro Enclaves. To include this parameter, use the [Amazon
+ # Web Services Nitro Enclaves SDK][2] or any Amazon Web Services SDK.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantListEntry AWS API Documentation
+ # When you use this parameter, instead of returning plaintext bytes,
+ # KMS encrypts the plaintext bytes under the public key in the
+ # attestation document, and returns the resulting ciphertext in the
+ # `CiphertextForRecipient` field in the response. This ciphertext can
+ # be decrypted only with the private key in the enclave. The
+ # `Plaintext` field in the response is null or empty.
#
- class GrantListEntry < Struct.new(
- :key_id,
- :grant_id,
- :name,
- :creation_date,
- :grantee_principal,
- :retiring_principal,
- :issuing_account,
- :operations,
- :constraints)
+ # For information about the interaction between KMS and Amazon Web
+ # Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
+ # uses KMS][3] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc
+ # [2]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [Types::RecipientInfo]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomRequest AWS API Documentation
+ #
+ class GenerateRandomRequest < Struct.new(
+ :number_of_bytes,
+ :custom_key_store_id,
+ :recipient)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ImportKeyMaterialRequest
- # data as a hash:
+ # @!attribute [rw] plaintext
+ # The random byte string. When you use the HTTP API or the Amazon Web
+ # Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded.
+ #
+ # If the response includes the `CiphertextForRecipient` field, the
+ # `Plaintext` field is null or empty.
+ # @return [String]
+ #
+ # @!attribute [rw] ciphertext_for_recipient
+ # The plaintext random bytes encrypted with the public key from the
+ # Nitro enclave. This ciphertext can be decrypted only by using a
+ # private key in the Nitro enclave.
+ #
+ # This field is included in the response only when the `Recipient`
+ # parameter in the request includes a valid attestation document from
+ # an Amazon Web Services Nitro enclave. For information about the
+ # interaction between KMS and Amazon Web Services Nitro Enclaves, see
+ # [How Amazon Web Services Nitro Enclaves uses KMS][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
#
- # {
- # key_id: "KeyIdType", # required
- # import_token: "data", # required
- # encrypted_key_material: "data", # required
- # valid_to: Time.now,
- # expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
- # }
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse AWS API Documentation
#
+ class GenerateRandomResponse < Struct.new(
+ :plaintext,
+ :ciphertext_for_recipient)
+ SENSITIVE = [:plaintext]
+ include Aws::Structure
+ end
+
# @!attribute [rw] key_id
- # The identifier of the CMK to import the key material into. The
- # CMK's `Origin` must be `EXTERNAL`.
+ # Gets the key policy for the specified KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -1986,572 +3042,2594 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
- # @!attribute [rw] import_token
- # The import token that you received in the response to a previous
- # GetParametersForImport request. It must be from the same response
- # that contained the public key that you used to encrypt the key
- # material.
- # @return [String]
- #
- # @!attribute [rw] encrypted_key_material
- # The encrypted key material to import. It must be encrypted with the
- # public key that you received in the response to a previous
- # GetParametersForImport request, using the wrapping algorithm that
- # you specified in that request.
- # @return [String]
- #
- # @!attribute [rw] valid_to
- # The time at which the imported key material expires. When the key
- # material expires, AWS KMS deletes the key material and the CMK
- # becomes unusable. You must omit this parameter when the
- # `ExpirationModel` parameter is set to
- # `KEY_MATERIAL_DOES_NOT_EXPIRE`. Otherwise it is required.
- # @return [Time]
- #
- # @!attribute [rw] expiration_model
- # Specifies whether the key material expires. The default is
- # `KEY_MATERIAL_EXPIRES`, in which case you must include the `ValidTo`
- # parameter. When this parameter is set to
- # `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo`
- # parameter.
+ # @!attribute [rw] policy_name
+ # Specifies the name of the key policy. The only valid name is
+ # `default`. To get the names of key policies, use ListKeyPolicies.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest AWS API Documentation
#
- class ImportKeyMaterialRequest < Struct.new(
+ class GetKeyPolicyRequest < Struct.new(
:key_id,
- :import_token,
- :encrypted_key_material,
- :valid_to,
- :expiration_model)
+ :policy_name)
+ SENSITIVE = []
include Aws::Structure
end
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialResponse AWS API Documentation
- #
- class ImportKeyMaterialResponse < Aws::EmptyStructure; end
-
- # The request was rejected because the provided key material is invalid
- # or is not the same key material that was previously imported into this
- # customer master key (CMK).
- #
- # @!attribute [rw] message
+ # @!attribute [rw] policy
+ # A key policy document in JSON format.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectKeyMaterialException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyResponse AWS API Documentation
#
- class IncorrectKeyMaterialException < Struct.new(
- :message)
+ class GetKeyPolicyResponse < Struct.new(
+ :policy)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the trust anchor certificate in the
- # request is not the trust anchor certificate for the specified AWS
- # CloudHSM cluster.
+ # @!attribute [rw] key_id
+ # Gets the rotation status for the specified KMS key.
#
- # When you [initialize the cluster][1], you create the trust anchor
- # certificate and save it in the `customerCA.crt` file.
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key
+ # in a different Amazon Web Services account, you must use the key
+ # ARN.
#
+ # For example:
#
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # @!attribute [rw] message
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectTrustAnchorException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusRequest AWS API Documentation
#
- class IncorrectTrustAnchorException < Struct.new(
- :message)
+ class GetKeyRotationStatusRequest < Struct.new(
+ :key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the specified alias name is not
- # valid.
- #
- # @!attribute [rw] message
- # @return [String]
+ # @!attribute [rw] key_rotation_enabled
+ # A Boolean value that specifies whether key rotation is enabled.
+ # @return [Boolean]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidAliasNameException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusResponse AWS API Documentation
#
- class InvalidAliasNameException < Struct.new(
- :message)
+ class GetKeyRotationStatusResponse < Struct.new(
+ :key_rotation_enabled)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because a specified ARN, or an ARN in a key
- # policy, is not valid.
+ # @!attribute [rw] key_id
+ # The identifier of the KMS key that will be associated with the
+ # imported key material. The `Origin` of the KMS key must be
+ # `EXTERNAL`.
#
- # @!attribute [rw] message
- # @return [String]
+ # All KMS key types are supported, including multi-Region keys.
+ # However, you cannot import key material into a KMS key in a custom
+ # key store.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidArnException AWS API Documentation
+ # Specify the key ID or key ARN of the KMS key.
#
- class InvalidArnException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the specified ciphertext, or
- # additional authenticated data incorporated into the ciphertext, such
- # as the encryption context, is corrupted, missing, or otherwise
- # invalid.
+ # For example:
#
- # @!attribute [rw] message
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidCiphertextException AWS API Documentation
+ # @!attribute [rw] wrapping_algorithm
+ # The algorithm you will use with the RSA public key (`PublicKey`) in
+ # the response to protect your key material during import. For more
+ # information, see [Select a wrapping
+ # algorithm](kms/latest/developerguide/importing-keys-get-public-key-and-token.html#select-wrapping-algorithm)
+ # in the *Key Management Service Developer Guide*.
#
- class InvalidCiphertextException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the specified `GrantId` is not valid.
+ # For RSA\_AES wrapping algorithms, you encrypt your key material with
+ # an AES key that you generate, then encrypt your AES key with the RSA
+ # public key from KMS. For RSAES wrapping algorithms, you encrypt your
+ # key material directly with the RSA public key from KMS.
#
- # @!attribute [rw] message
- # @return [String]
+ # The wrapping algorithms that you can use depend on the type of key
+ # material that you are importing. To import an RSA private key, you
+ # must use an RSA\_AES wrapping algorithm.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantIdException AWS API Documentation
+ # * **RSA\_AES\_KEY\_WRAP\_SHA\_256** — Supported for wrapping RSA and
+ # ECC key material.
#
- class InvalidGrantIdException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the specified grant token is not
- # valid.
+ # * **RSA\_AES\_KEY\_WRAP\_SHA\_1** — Supported for wrapping RSA and
+ # ECC key material.
#
- # @!attribute [rw] message
- # @return [String]
+ # * **RSAES\_OAEP\_SHA\_256** — Supported for all types of key
+ # material, except RSA key material (private key).
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantTokenException AWS API Documentation
+ # You cannot use the RSAES\_OAEP\_SHA\_256 wrapping algorithm with
+ # the RSA\_2048 wrapping key spec to wrap ECC\_NIST\_P521 key
+ # material.
#
- class InvalidGrantTokenException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the provided import token is invalid
- # or is associated with a different customer master key (CMK).
+ # * **RSAES\_OAEP\_SHA\_1** — Supported for all types of key material,
+ # except RSA key material (private key).
#
- # @!attribute [rw] message
+ # You cannot use the RSAES\_OAEP\_SHA\_1 wrapping algorithm with the
+ # RSA\_2048 wrapping key spec to wrap ECC\_NIST\_P521 key material.
+ #
+ # * **RSAES\_PKCS1\_V1\_5** (Deprecated) — Supported only for
+ # symmetric encryption key material (and only in legacy mode).
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidImportTokenException AWS API Documentation
+ # @!attribute [rw] wrapping_key_spec
+ # The type of RSA public key to return in the response. You will use
+ # this wrapping key with the specified wrapping algorithm to protect
+ # your key material during import.
#
- class InvalidImportTokenException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the specified `KeySpec` value is not
- # valid.
+ # Use the longest RSA wrapping key that is practical.
#
- # @!attribute [rw] message
+ # You cannot use an RSA\_2048 public key to directly wrap an
+ # ECC\_NIST\_P521 private key. Instead, use an RSA\_AES wrapping
+ # algorithm or choose a longer RSA public key.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidKeyUsageException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportRequest AWS API Documentation
#
- class InvalidKeyUsageException < Struct.new(
- :message)
+ class GetParametersForImportRequest < Struct.new(
+ :key_id,
+ :wrapping_algorithm,
+ :wrapping_key_spec)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because the marker that specifies where
- # pagination should next begin is not valid.
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key to use in a
+ # subsequent ImportKeyMaterial request. This is the same KMS key
+ # specified in the `GetParametersForImport` request.
#
- # @!attribute [rw] message
- # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidMarkerException AWS API Documentation
#
- class InvalidMarkerException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because an internal exception occurred. The
- # request can be retried.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
#
- # @!attribute [rw] message
+ # @!attribute [rw] import_token
+ # The import token to send in a subsequent ImportKeyMaterial request.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInternalException AWS API Documentation
+ # @!attribute [rw] public_key
+ # The public key to use to encrypt the key material before importing
+ # it with ImportKeyMaterial.
+ # @return [String]
#
- class KMSInternalException < Struct.new(
- :message)
+ # @!attribute [rw] parameters_valid_to
+ # The time at which the import token and public key are no longer
+ # valid. After this time, you cannot use them to make an
+ # ImportKeyMaterial request and you must send another
+ # `GetParametersForImport` request to get new ones.
+ # @return [Time]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportResponse AWS API Documentation
+ #
+ class GetParametersForImportResponse < Struct.new(
+ :key_id,
+ :import_token,
+ :public_key,
+ :parameters_valid_to)
+ SENSITIVE = [:public_key]
include Aws::Structure
end
- # The request was rejected because the state of the specified resource
- # is not valid for this request.
+ # @!attribute [rw] key_id
+ # Identifies the asymmetric KMS key that includes the public key.
#
- # For more information about how key state affects the use of a CMK, see
- # [How Key State Affects Use of a Customer Master Key][1] in the *AWS
- # Key Management Service Developer Guide*.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
+ # For example:
#
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # @!attribute [rw] message
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidStateException AWS API Documentation
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
- class KMSInvalidStateException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # Contains information about each entry in the key list.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] key_id
- # Unique identifier of the key.
- # @return [String]
#
- # @!attribute [rw] key_arn
- # ARN of the key.
- # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyListEntry AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- class KeyListEntry < Struct.new(
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyRequest AWS API Documentation
+ #
+ class GetPublicKeyRequest < Struct.new(
:key_id,
- :key_arn)
+ :grant_tokens)
+ SENSITIVE = []
include Aws::Structure
end
- # Contains metadata about a customer master key (CMK).
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the asymmetric KMS key
+ # from which the public key was downloaded.
#
- # This data type is used as a response element for the CreateKey and
- # DescribeKey operations.
#
- # @!attribute [rw] aws_account_id
- # The twelve-digit account ID of the AWS account that owns the CMK.
- # @return [String]
#
- # @!attribute [rw] key_id
- # The globally unique identifier for the CMK.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
- # @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the CMK. For examples, see [AWS
- # Key Management Service (AWS KMS)][1] in the Example ARNs section of
- # the *AWS General Reference*.
+ # @!attribute [rw] public_key
+ # The exported public key.
#
+ # The value is a DER-encoded X.509 public key, also known as
+ # `SubjectPublicKeyInfo` (SPKI), as defined in [RFC 5280][1]. When you
+ # use the HTTP API or the Amazon Web Services CLI, the value is
+ # Base64-encoded. Otherwise, it is not Base64-encoded.
#
#
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
- # @return [String]
#
- # @!attribute [rw] creation_date
- # The date and time when the CMK was created.
- # @return [Time]
#
- # @!attribute [rw] enabled
- # Specifies whether the CMK is enabled. When `KeyState` is `Enabled`
- # this value is true, otherwise it is false.
- # @return [Boolean]
+ #
+ # [1]: https://tools.ietf.org/html/rfc5280
+ # @return [String]
+ #
+ # @!attribute [rw] customer_master_key_spec
+ # Instead, use the `KeySpec` field in the `GetPublicKey` response.
+ #
+ # The `KeySpec` and `CustomerMasterKeySpec` fields have the same
+ # value. We recommend that you use the `KeySpec` field in your code.
+ # However, to avoid breaking changes, KMS supports both fields.
+ # @return [String]
+ #
+ # @!attribute [rw] key_spec
+ # The type of the of the public key that was downloaded.
+ # @return [String]
+ #
+ # @!attribute [rw] key_usage
+ # The permitted use of the public key. Valid values are
+ # `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
+ #
+ # This information is critical. If a public key with `SIGN_VERIFY` key
+ # usage encrypts data outside of KMS, the ciphertext cannot be
+ # decrypted.
+ # @return [String]
+ #
+ # @!attribute [rw] encryption_algorithms
+ # The encryption algorithms that KMS supports for this key.
+ #
+ # This information is critical. If a public key encrypts data outside
+ # of KMS by using an unsupported encryption algorithm, the ciphertext
+ # cannot be decrypted.
+ #
+ # This field appears in the response only when the `KeyUsage` of the
+ # public key is `ENCRYPT_DECRYPT`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] signing_algorithms
+ # The signing algorithms that KMS supports for this key.
+ #
+ # This field appears in the response only when the `KeyUsage` of the
+ # public key is `SIGN_VERIFY`.
+ # @return [Array<String>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyResponse AWS API Documentation
+ #
+ class GetPublicKeyResponse < Struct.new(
+ :key_id,
+ :public_key,
+ :customer_master_key_spec,
+ :key_spec,
+ :key_usage,
+ :encryption_algorithms,
+ :signing_algorithms)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Use this structure to allow [cryptographic operations][1] in the grant
+ # only when the operation request includes the specified [encryption
+ # context][2].
+ #
+ # KMS applies the grant constraints only to cryptographic operations
+ # that support an encryption context, that is, all cryptographic
+ # operations with a [symmetric KMS key][3]. Grant constraints are not
+ # applied to operations that do not support an encryption context, such
+ # as cryptographic operations with asymmetric KMS keys and management
+ # operations, such as DescribeKey or RetireGrant.
+ #
+ # In a cryptographic operation, the encryption context in the decryption
+ # operation must be an exact, case-sensitive match for the keys and
+ # values in the encryption context of the encryption operation. Only the
+ # order of the pairs can vary.
+ #
+ # However, in a grant constraint, the key in each key-value pair is not
+ # case sensitive, but the value is case sensitive.
+ #
+ # To avoid confusion, do not use multiple encryption context pairs that
+ # differ only by case. To require a fully case-sensitive encryption
+ # context, use the `kms:EncryptionContext:` and
+ # `kms:EncryptionContextKeys` conditions in an IAM or key policy. For
+ # details, see [kms:EncryptionContext:][4] in the <i> <i>Key Management
+ # Service Developer Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context
+ #
+ # @!attribute [rw] encryption_context_subset
+ # A list of key-value pairs that must be included in the encryption
+ # context of the [cryptographic operation][1] request. The grant
+ # allows the cryptographic operation only when the encryption context
+ # in the request includes the key-value pairs specified in this
+ # constraint, although it can include additional key-value pairs.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # @return [Hash<String,String>]
+ #
+ # @!attribute [rw] encryption_context_equals
+ # A list of key-value pairs that must match the encryption context in
+ # the [cryptographic operation][1] request. The grant allows the
+ # operation only when the encryption context in the request is the
+ # same as the encryption context specified in this constraint.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # @return [Hash<String,String>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantConstraints AWS API Documentation
+ #
+ class GrantConstraints < Struct.new(
+ :encryption_context_subset,
+ :encryption_context_equals)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Contains information about a grant.
+ #
+ # @!attribute [rw] key_id
+ # The unique identifier for the KMS key to which the grant applies.
+ # @return [String]
+ #
+ # @!attribute [rw] grant_id
+ # The unique identifier for the grant.
+ # @return [String]
+ #
+ # @!attribute [rw] name
+ # The friendly name that identifies the grant. If a name was provided
+ # in the CreateGrant request, that name is returned. Otherwise this
+ # value is null.
+ # @return [String]
+ #
+ # @!attribute [rw] creation_date
+ # The date and time when the grant was created.
+ # @return [Time]
+ #
+ # @!attribute [rw] grantee_principal
+ # The identity that gets the permissions in the grant.
+ #
+ # The `GranteePrincipal` field in the `ListGrants` response usually
+ # contains the user or role designated as the grantee principal in the
+ # grant. However, when the grantee principal in the grant is an Amazon
+ # Web Services service, the `GranteePrincipal` field contains the
+ # [service principal][1], which might represent several different
+ # grantee principals.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
+ # @return [String]
+ #
+ # @!attribute [rw] retiring_principal
+ # The principal that can retire the grant.
+ # @return [String]
+ #
+ # @!attribute [rw] issuing_account
+ # The Amazon Web Services account under which the grant was issued.
+ # @return [String]
+ #
+ # @!attribute [rw] operations
+ # The list of operations permitted by the grant.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] constraints
+ # A list of key-value pairs that must be present in the encryption
+ # context of certain subsequent operations that the grant allows.
+ # @return [Types::GrantConstraints]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantListEntry AWS API Documentation
+ #
+ class GrantListEntry < Struct.new(
+ :key_id,
+ :grant_id,
+ :name,
+ :creation_date,
+ :grantee_principal,
+ :retiring_principal,
+ :issuing_account,
+ :operations,
+ :constraints)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # The identifier of the KMS key that will be associated with the
+ # imported key material. This must be the same KMS key specified in
+ # the `KeyID` parameter of the corresponding GetParametersForImport
+ # request. The `Origin` of the KMS key must be `EXTERNAL` and its
+ # `KeyState` must be `PendingImport`.
+ #
+ # The KMS key can be a symmetric encryption KMS key, HMAC KMS key,
+ # asymmetric encryption KMS key, or asymmetric signing KMS key,
+ # including a [multi-Region
+ # key](kms/latest/developerguide/multi-region-keys-overview.html) of
+ # any supported type. You cannot perform this operation on a KMS key
+ # in a custom key store, or on a KMS key in a different Amazon Web
+ # Services account.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] import_token
+ # The import token that you received in the response to a previous
+ # GetParametersForImport request. It must be from the same response
+ # that contained the public key that you used to encrypt the key
+ # material.
+ # @return [String]
+ #
+ # @!attribute [rw] encrypted_key_material
+ # The encrypted key material to import. The key material must be
+ # encrypted under the public wrapping key that GetParametersForImport
+ # returned, using the wrapping algorithm that you specified in the
+ # same `GetParametersForImport` request.
+ # @return [String]
+ #
+ # @!attribute [rw] valid_to
+ # The date and time when the imported key material expires. This
+ # parameter is required when the value of the `ExpirationModel`
+ # parameter is `KEY_MATERIAL_EXPIRES`. Otherwise it is not valid.
+ #
+ # The value of this parameter must be a future date and time. The
+ # maximum value is 365 days from the request date.
+ #
+ # When the key material expires, KMS deletes the key material from the
+ # KMS key. Without its key material, the KMS key is unusable. To use
+ # the KMS key in cryptographic operations, you must reimport the same
+ # key material.
+ #
+ # You cannot change the `ExpirationModel` or `ValidTo` values for the
+ # current import after the request completes. To change either value,
+ # you must delete (DeleteImportedKeyMaterial) and reimport the key
+ # material.
+ # @return [Time]
+ #
+ # @!attribute [rw] expiration_model
+ # Specifies whether the key material expires. The default is
+ # `KEY_MATERIAL_EXPIRES`. For help with this choice, see [Setting an
+ # expiration time][1] in the *Key Management Service Developer Guide*.
+ #
+ # When the value of `ExpirationModel` is `KEY_MATERIAL_EXPIRES`, you
+ # must specify a value for the `ValidTo` parameter. When value is
+ # `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo`
+ # parameter.
+ #
+ # You cannot change the `ExpirationModel` or `ValidTo` values for the
+ # current import after the request completes. To change either value,
+ # you must reimport the key material.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialRequest AWS API Documentation
+ #
+ class ImportKeyMaterialRequest < Struct.new(
+ :key_id,
+ :import_token,
+ :encrypted_key_material,
+ :valid_to,
+ :expiration_model)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialResponse AWS API Documentation
+ #
+ class ImportKeyMaterialResponse < Aws::EmptyStructure; end
+
+ # The request was rejected because the specified KMS key cannot decrypt
+ # the data. The `KeyId` in a Decrypt request and the `SourceKeyId` in a
+ # ReEncrypt request must identify the same KMS key that was used to
+ # encrypt the ciphertext.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectKeyException AWS API Documentation
+ #
+ class IncorrectKeyException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the key material in the request is,
+ # expired, invalid, or is not the same key material that was previously
+ # imported into this KMS key.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectKeyMaterialException AWS API Documentation
+ #
+ class IncorrectKeyMaterialException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the trust anchor certificate in the
+ # request to create an CloudHSM key store is not the trust anchor
+ # certificate for the specified CloudHSM cluster.
+ #
+ # When you [initialize the CloudHSM cluster][1], you create the trust
+ # anchor certificate and save it in the `customerCA.crt` file.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectTrustAnchorException AWS API Documentation
+ #
+ class IncorrectTrustAnchorException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified alias name is not
+ # valid.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidAliasNameException AWS API Documentation
+ #
+ class InvalidAliasNameException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because a specified ARN, or an ARN in a key
+ # policy, is not valid.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidArnException AWS API Documentation
+ #
+ class InvalidArnException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # From the Decrypt or ReEncrypt operation, the request was rejected
+ # because the specified ciphertext, or additional authenticated data
+ # incorporated into the ciphertext, such as the encryption context, is
+ # corrupted, missing, or otherwise invalid.
+ #
+ # From the ImportKeyMaterial operation, the request was rejected because
+ # KMS could not decrypt the encrypted (wrapped) key material.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidCiphertextException AWS API Documentation
+ #
+ class InvalidCiphertextException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified `GrantId` is not valid.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantIdException AWS API Documentation
+ #
+ class InvalidGrantIdException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified grant token is not
+ # valid.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantTokenException AWS API Documentation
+ #
+ class InvalidGrantTokenException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the provided import token is invalid
+ # or is associated with a different KMS key.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidImportTokenException AWS API Documentation
+ #
+ class InvalidImportTokenException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected for one of the following reasons:
+ #
+ # * The `KeyUsage` value of the KMS key is incompatible with the API
+ # operation.
+ #
+ # * The encryption algorithm or signing algorithm specified for the
+ # operation is incompatible with the type of key material in the KMS
+ # key `(KeySpec`).
+ #
+ # For encrypting, decrypting, re-encrypting, and generating data keys,
+ # the `KeyUsage` must be `ENCRYPT_DECRYPT`. For signing and verifying
+ # messages, the `KeyUsage` must be `SIGN_VERIFY`. For generating and
+ # verifying message authentication codes (MACs), the `KeyUsage` must be
+ # `GENERATE_VERIFY_MAC`. To find the `KeyUsage` of a KMS key, use the
+ # DescribeKey operation.
+ #
+ # To find the encryption or signing algorithms supported for a
+ # particular KMS key, use the DescribeKey operation.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidKeyUsageException AWS API Documentation
+ #
+ class InvalidKeyUsageException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the marker that specifies where
+ # pagination should next begin is not valid.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidMarkerException AWS API Documentation
+ #
+ class InvalidMarkerException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because an internal exception occurred. The
+ # request can be retried.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInternalException AWS API Documentation
+ #
+ class KMSInternalException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the HMAC verification failed. HMAC
+ # verification fails when the HMAC computed by using the specified
+ # message, HMAC KMS key, and MAC algorithm does not match the HMAC
+ # specified in the request.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidMacException AWS API Documentation
+ #
+ class KMSInvalidMacException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the signature verification failed.
+ # Signature verification fails when it cannot confirm that signature was
+ # produced by signing the specified message with the specified KMS key
+ # and signing algorithm.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidSignatureException AWS API Documentation
+ #
+ class KMSInvalidSignatureException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the state of the specified resource
+ # is not valid for this request.
+ #
+ # This exceptions means one of the following:
+ #
+ # * The key state of the KMS key is not compatible with the operation.
+ #
+ # To find the key state, use the DescribeKey operation. For more
+ # information about which key states are compatible with each KMS
+ # operation, see [Key states of KMS keys][1] in the <i> <i>Key
+ # Management Service Developer Guide</i> </i>.
+ #
+ # * For cryptographic operations on KMS keys in custom key stores, this
+ # exception represents a general failure with many possible causes. To
+ # identify the cause, see the error message that accompanies the
+ # exception.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidStateException AWS API Documentation
+ #
+ class KMSInvalidStateException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Contains information about each entry in the key list.
+ #
+ # @!attribute [rw] key_id
+ # Unique identifier of the key.
+ # @return [String]
+ #
+ # @!attribute [rw] key_arn
+ # ARN of the key.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyListEntry AWS API Documentation
+ #
+ class KeyListEntry < Struct.new(
+ :key_id,
+ :key_arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Contains metadata about a KMS key.
+ #
+ # This data type is used as a response element for the CreateKey,
+ # DescribeKey, and ReplicateKey operations.
+ #
+ # @!attribute [rw] aws_account_id
+ # The twelve-digit account ID of the Amazon Web Services account that
+ # owns the KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] key_id
+ # The globally unique identifier for the KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) of the KMS key. For examples, see
+ # [Key Management Service (KMS)][1] in the Example ARNs section of the
+ # *Amazon Web Services General Reference*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
+ # @return [String]
+ #
+ # @!attribute [rw] creation_date
+ # The date and time when the KMS key was created.
+ # @return [Time]
+ #
+ # @!attribute [rw] enabled
+ # Specifies whether the KMS key is enabled. When `KeyState` is
+ # `Enabled` this value is true, otherwise it is false.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] description
+ # The description of the KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] key_usage
+ # The [cryptographic operations][1] for which you can use the KMS key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
+ # @return [String]
+ #
+ # @!attribute [rw] key_state
+ # The current status of the KMS key.
+ #
+ # For more information about how key state affects the use of a KMS
+ # key, see [Key states of KMS keys][1] in the *Key Management Service
+ # Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # @return [String]
+ #
+ # @!attribute [rw] deletion_date
+ # The date and time after which KMS deletes this KMS key. This value
+ # is present only when the KMS key is scheduled for deletion, that is,
+ # when its `KeyState` is `PendingDeletion`.
+ #
+ # When the primary key in a multi-Region key is scheduled for deletion
+ # but still has replica keys, its key state is
+ # `PendingReplicaDeletion` and the length of its waiting period is
+ # displayed in the `PendingDeletionWindowInDays` field.
+ # @return [Time]
+ #
+ # @!attribute [rw] valid_to
+ # The time at which the imported key material expires. When the key
+ # material expires, KMS deletes the key material and the KMS key
+ # becomes unusable. This value is present only for KMS keys whose
+ # `Origin` is `EXTERNAL` and whose `ExpirationModel` is
+ # `KEY_MATERIAL_EXPIRES`, otherwise this value is omitted.
+ # @return [Time]
+ #
+ # @!attribute [rw] origin
+ # The source of the key material for the KMS key. When this value is
+ # `AWS_KMS`, KMS created the key material. When this value is
+ # `EXTERNAL`, the key material was imported or the KMS key doesn't
+ # have any key material. When this value is `AWS_CLOUDHSM`, the key
+ # material was created in the CloudHSM cluster associated with a
+ # custom key store.
+ # @return [String]
+ #
+ # @!attribute [rw] custom_key_store_id
+ # A unique identifier for the [custom key store][1] that contains the
+ # KMS key. This field is present only when the KMS key is created in a
+ # custom key store.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # @return [String]
+ #
+ # @!attribute [rw] cloud_hsm_cluster_id
+ # The cluster ID of the CloudHSM cluster that contains the key
+ # material for the KMS key. When you create a KMS key in an CloudHSM
+ # [custom key store][1], KMS creates the key material for the KMS key
+ # in the associated CloudHSM cluster. This field is present only when
+ # the KMS key is created in an CloudHSM key store.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
+ # @return [String]
+ #
+ # @!attribute [rw] expiration_model
+ # Specifies whether the KMS key's key material expires. This value is
+ # present only when `Origin` is `EXTERNAL`, otherwise this value is
+ # omitted.
+ # @return [String]
+ #
+ # @!attribute [rw] key_manager
+ # The manager of the KMS key. KMS keys in your Amazon Web Services
+ # account are either customer managed or Amazon Web Services managed.
+ # For more information about the difference, see [KMS keys][1] in the
+ # *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys
+ # @return [String]
+ #
+ # @!attribute [rw] customer_master_key_spec
+ # Instead, use the `KeySpec` field.
+ #
+ # The `KeySpec` and `CustomerMasterKeySpec` fields have the same
+ # value. We recommend that you use the `KeySpec` field in your code.
+ # However, to avoid breaking changes, KMS supports both fields.
+ # @return [String]
+ #
+ # @!attribute [rw] key_spec
+ # Describes the type of key material in the KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] encryption_algorithms
+ # The encryption algorithms that the KMS key supports. You cannot use
+ # the KMS key with other encryption algorithms within KMS.
+ #
+ # This value is present only when the `KeyUsage` of the KMS key is
+ # `ENCRYPT_DECRYPT`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] signing_algorithms
+ # The signing algorithms that the KMS key supports. You cannot use the
+ # KMS key with other signing algorithms within KMS.
+ #
+ # This field appears only when the `KeyUsage` of the KMS key is
+ # `SIGN_VERIFY`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] multi_region
+ # Indicates whether the KMS key is a multi-Region (`True`) or regional
+ # (`False`) key. This value is `True` for multi-Region primary and
+ # replica keys and `False` for regional KMS keys.
+ #
+ # For more information about multi-Region keys, see [Multi-Region keys
+ # in KMS][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
+ # @return [Boolean]
+ #
+ # @!attribute [rw] multi_region_configuration
+ # Lists the primary and replica keys in same multi-Region key. This
+ # field is present only when the value of the `MultiRegion` field is
+ # `True`.
+ #
+ # For more information about any listed KMS key, use the DescribeKey
+ # operation.
+ #
+ # * `MultiRegionKeyType` indicates whether the KMS key is a `PRIMARY`
+ # or `REPLICA` key.
+ #
+ # * `PrimaryKey` displays the key ARN and Region of the primary key.
+ # This field displays the current KMS key if it is the primary key.
+ #
+ # * `ReplicaKeys` displays the key ARNs and Regions of all replica
+ # keys. This field includes the current KMS key if it is a replica
+ # key.
+ # @return [Types::MultiRegionConfiguration]
+ #
+ # @!attribute [rw] pending_deletion_window_in_days
+ # The waiting period before the primary key in a multi-Region key is
+ # deleted. This waiting period begins when the last of its replica
+ # keys is deleted. This value is present only when the `KeyState` of
+ # the KMS key is `PendingReplicaDeletion`. That indicates that the KMS
+ # key is the primary key in a multi-Region key, it is scheduled for
+ # deletion, and it still has existing replica keys.
+ #
+ # When a single-Region KMS key or a multi-Region replica key is
+ # scheduled for deletion, its deletion date is displayed in the
+ # `DeletionDate` field. However, when the primary key in a
+ # multi-Region key is scheduled for deletion, its waiting period
+ # doesn't begin until all of its replica keys are deleted. This value
+ # displays that waiting period. When the last replica key in the
+ # multi-Region key is deleted, the `KeyState` of the scheduled primary
+ # key changes from `PendingReplicaDeletion` to `PendingDeletion` and
+ # the deletion date appears in the `DeletionDate` field.
+ # @return [Integer]
+ #
+ # @!attribute [rw] mac_algorithms
+ # The message authentication code (MAC) algorithm that the HMAC KMS
+ # key supports.
+ #
+ # This value is present only when the `KeyUsage` of the KMS key is
+ # `GENERATE_VERIFY_MAC`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] xks_key_configuration
+ # Information about the external key that is associated with a KMS key
+ # in an external key store.
+ #
+ # For more information, see [External key][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
+ # @return [Types::XksKeyConfigurationType]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata AWS API Documentation
+ #
+ class KeyMetadata < Struct.new(
+ :aws_account_id,
+ :key_id,
+ :arn,
+ :creation_date,
+ :enabled,
+ :description,
+ :key_usage,
+ :key_state,
+ :deletion_date,
+ :valid_to,
+ :origin,
+ :custom_key_store_id,
+ :cloud_hsm_cluster_id,
+ :expiration_model,
+ :key_manager,
+ :customer_master_key_spec,
+ :key_spec,
+ :encryption_algorithms,
+ :signing_algorithms,
+ :multi_region,
+ :multi_region_configuration,
+ :pending_deletion_window_in_days,
+ :mac_algorithms,
+ :xks_key_configuration)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified KMS key was not
+ # available. You can retry the request.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyUnavailableException AWS API Documentation
+ #
+ class KeyUnavailableException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because a quota was exceeded. For more
+ # information, see [Quotas][1] in the *Key Management Service Developer
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/LimitExceededException AWS API Documentation
+ #
+ class LimitExceededException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Lists only aliases that are associated with the specified KMS key.
+ # Enter a KMS key in your Amazon Web Services account.
+ #
+ # This parameter is optional. If you omit it, `ListAliases` returns
+ # all aliases in the account and Region.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to
+ # 50.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesRequest AWS API Documentation
+ #
+ class ListAliasesRequest < Struct.new(
+ :key_id,
+ :limit,
+ :marker)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] aliases
+ # A list of aliases.
+ # @return [Array<Types::AliasListEntry>]
+ #
+ # @!attribute [rw] next_marker
+ # When `Truncated` is true, this element is present and contains the
+ # value to use for the `Marker` parameter in a subsequent request.
+ # @return [String]
+ #
+ # @!attribute [rw] truncated
+ # A flag that indicates whether there are more items in the list. When
+ # this value is true, the list in this response is truncated. To get
+ # more items, pass the value of the `NextMarker` element in
+ # thisresponse to the `Marker` parameter in a subsequent request.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesResponse AWS API Documentation
+ #
+ class ListAliasesResponse < Struct.new(
+ :aliases,
+ :next_marker,
+ :truncated)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to
+ # 50.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ # @return [String]
+ #
+ # @!attribute [rw] key_id
+ # Returns only grants for the specified KMS key. This parameter is
+ # required.
+ #
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key
+ # in a different Amazon Web Services account, you must use the key
+ # ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] grant_id
+ # Returns only the grant with the specified grant ID. The grant ID
+ # uniquely identifies the grant.
+ # @return [String]
+ #
+ # @!attribute [rw] grantee_principal
+ # Returns only grants where the specified principal is the grantee
+ # principal for the grant.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest AWS API Documentation
+ #
+ class ListGrantsRequest < Struct.new(
+ :limit,
+ :marker,
+ :key_id,
+ :grant_id,
+ :grantee_principal)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] grants
+ # A list of grants.
+ # @return [Array<Types::GrantListEntry>]
+ #
+ # @!attribute [rw] next_marker
+ # When `Truncated` is true, this element is present and contains the
+ # value to use for the `Marker` parameter in a subsequent request.
+ # @return [String]
+ #
+ # @!attribute [rw] truncated
+ # A flag that indicates whether there are more items in the list. When
+ # this value is true, the list in this response is truncated. To get
+ # more items, pass the value of the `NextMarker` element in
+ # thisresponse to the `Marker` parameter in a subsequent request.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsResponse AWS API Documentation
+ #
+ class ListGrantsResponse < Struct.new(
+ :grants,
+ :next_marker,
+ :truncated)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Gets the names of key policies for the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 1000, inclusive. If you do not include a value, it defaults to
+ # 100.
+ #
+ # Only one policy can be attached to a key.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesRequest AWS API Documentation
+ #
+ class ListKeyPoliciesRequest < Struct.new(
+ :key_id,
+ :limit,
+ :marker)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] policy_names
+ # A list of key policy names. The only valid value is `default`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] next_marker
+ # When `Truncated` is true, this element is present and contains the
+ # value to use for the `Marker` parameter in a subsequent request.
+ # @return [String]
+ #
+ # @!attribute [rw] truncated
+ # A flag that indicates whether there are more items in the list. When
+ # this value is true, the list in this response is truncated. To get
+ # more items, pass the value of the `NextMarker` element in
+ # thisresponse to the `Marker` parameter in a subsequent request.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesResponse AWS API Documentation
+ #
+ class ListKeyPoliciesResponse < Struct.new(
+ :policy_names,
+ :next_marker,
+ :truncated)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 1000, inclusive. If you do not include a value, it defaults to
+ # 100.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysRequest AWS API Documentation
+ #
+ class ListKeysRequest < Struct.new(
+ :limit,
+ :marker)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] keys
+ # A list of KMS keys.
+ # @return [Array<Types::KeyListEntry>]
+ #
+ # @!attribute [rw] next_marker
+ # When `Truncated` is true, this element is present and contains the
+ # value to use for the `Marker` parameter in a subsequent request.
+ # @return [String]
+ #
+ # @!attribute [rw] truncated
+ # A flag that indicates whether there are more items in the list. When
+ # this value is true, the list in this response is truncated. To get
+ # more items, pass the value of the `NextMarker` element in
+ # thisresponse to the `Marker` parameter in a subsequent request.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysResponse AWS API Documentation
+ #
+ class ListKeysResponse < Struct.new(
+ :keys,
+ :next_marker,
+ :truncated)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Gets tags on the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 50, inclusive. If you do not include a value, it defaults to 50.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ #
+ # Do not attempt to construct this value. Use only the value of
+ # `NextMarker` from the truncated response you just received.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsRequest AWS API Documentation
+ #
+ class ListResourceTagsRequest < Struct.new(
+ :key_id,
+ :limit,
+ :marker)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] tags
+ # A list of tags. Each tag consists of a tag key and a tag value.
+ #
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the
+ # KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # </note>
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # @return [Array<Types::Tag>]
+ #
+ # @!attribute [rw] next_marker
+ # When `Truncated` is true, this element is present and contains the
+ # value to use for the `Marker` parameter in a subsequent request.
+ #
+ # Do not assume or infer any information from this value.
+ # @return [String]
+ #
+ # @!attribute [rw] truncated
+ # A flag that indicates whether there are more items in the list. When
+ # this value is true, the list in this response is truncated. To get
+ # more items, pass the value of the `NextMarker` element in
+ # thisresponse to the `Marker` parameter in a subsequent request.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsResponse AWS API Documentation
+ #
+ class ListResourceTagsResponse < Struct.new(
+ :tags,
+ :next_marker,
+ :truncated)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] limit
+ # Use this parameter to specify the maximum number of items to return.
+ # When this value is present, KMS does not return more than the
+ # specified number of items, but it might return fewer.
+ #
+ # This value is optional. If you include a value, it must be between 1
+ # and 100, inclusive. If you do not include a value, it defaults to
+ # 50.
+ # @return [Integer]
+ #
+ # @!attribute [rw] marker
+ # Use this parameter in a subsequent request after you receive a
+ # response with truncated results. Set it to the value of `NextMarker`
+ # from the truncated response you just received.
+ # @return [String]
+ #
+ # @!attribute [rw] retiring_principal
+ # The retiring principal for which to list grants. Enter a principal
+ # in your Amazon Web Services account.
+ #
+ # To specify the retiring principal, use the [Amazon Resource Name
+ # (ARN)][1] of an Amazon Web Services principal. Valid principals
+ # include Amazon Web Services accounts, IAM users, IAM roles,
+ # federated users, and assumed role users. For help with the ARN
+ # syntax for a principal, see [IAM ARNs][2] in the <i> <i>Identity and
+ # Access Management User Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrantsRequest AWS API Documentation
+ #
+ class ListRetirableGrantsRequest < Struct.new(
+ :limit,
+ :marker,
+ :retiring_principal)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified policy is not
+ # syntactically or semantically correct.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MalformedPolicyDocumentException AWS API Documentation
+ #
+ class MalformedPolicyDocumentException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Describes the configuration of this multi-Region key. This field
+ # appears only when the KMS key is a primary or replica of a
+ # multi-Region key.
+ #
+ # For more information about any listed KMS key, use the DescribeKey
+ # operation.
+ #
+ # @!attribute [rw] multi_region_key_type
+ # Indicates whether the KMS key is a `PRIMARY` or `REPLICA` key.
+ # @return [String]
+ #
+ # @!attribute [rw] primary_key
+ # Displays the key ARN and Region of the primary key. This field
+ # includes the current KMS key if it is the primary key.
+ # @return [Types::MultiRegionKey]
+ #
+ # @!attribute [rw] replica_keys
+ # displays the key ARNs and Regions of all replica keys. This field
+ # includes the current KMS key if it is a replica key.
+ # @return [Array<Types::MultiRegionKey>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MultiRegionConfiguration AWS API Documentation
+ #
+ class MultiRegionConfiguration < Struct.new(
+ :multi_region_key_type,
+ :primary_key,
+ :replica_keys)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Describes the primary or replica key in a multi-Region key.
+ #
+ # @!attribute [rw] arn
+ # Displays the key ARN of a primary or replica key of a multi-Region
+ # key.
+ # @return [String]
+ #
+ # @!attribute [rw] region
+ # Displays the Amazon Web Services Region of a primary or replica key
+ # in a multi-Region key.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MultiRegionKey AWS API Documentation
+ #
+ class MultiRegionKey < Struct.new(
+ :arn,
+ :region)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified entity or resource
+ # could not be found.
+ #
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/NotFoundException AWS API Documentation
+ #
+ class NotFoundException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Sets the key policy on the specified KMS key.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] policy_name
+ # The name of the key policy. The only valid value is `default`.
+ # @return [String]
+ #
+ # @!attribute [rw] policy
+ # The key policy to attach to the KMS key.
+ #
+ # The key policy must meet the following criteria:
+ #
+ # * The key policy must allow the calling principal to make a
+ # subsequent `PutKeyPolicy` request on the KMS key. This reduces the
+ # risk that the KMS key becomes unmanageable. For more information,
+ # see [Default key policy][1] in the *Key Management Service
+ # Developer Guide*. (To omit this condition, set
+ # `BypassPolicyLockoutSafetyCheck` to true.)
+ #
+ # * Each statement in the key policy must contain one or more
+ # principals. The principals in the key policy must exist and be
+ # visible to KMS. When you create a new Amazon Web Services
+ # principal, you might need to enforce a delay before including the
+ # new principal in a key policy because the new principal might not
+ # be immediately visible to KMS. For more information, see [Changes
+ # that I make are not always immediately visible][2] in the *Amazon
+ # Web Services Identity and Access Management User Guide*.
+ #
+ # A key policy document can include only the following characters:
+ #
+ # * Printable ASCII characters from the space character (`\u0020`)
+ # through the end of the ASCII character range.
+ #
+ # * Printable characters in the Basic Latin and Latin-1 Supplement
+ # character set (through `\u00FF`).
+ #
+ # * The tab (`\u0009`), line feed (`\u000A`), and carriage return
+ # (`\u000D`) special characters
+ #
+ # For information about key policies, see [Key policies in KMS][3] in
+ # the *Key Management Service Developer Guide*.For help writing and
+ # formatting a JSON policy document, see the [IAM JSON Policy
+ # Reference][4] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+ # @return [String]
+ #
+ # @!attribute [rw] bypass_policy_lockout_safety_check
+ # Skips ("bypasses") the key policy lockout safety check. The
+ # default value is false.
+ #
+ # Setting this value to true increases the risk that the KMS key
+ # becomes unmanageable. Do not set this value to true
+ # indiscriminately.
+ #
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # Use this parameter only when you intend to prevent the principal
+ # that is making the request from making a subsequent PutKeyPolicy
+ # request on the KMS key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyRequest AWS API Documentation
+ #
+ class PutKeyPolicyRequest < Struct.new(
+ :key_id,
+ :policy_name,
+ :policy,
+ :bypass_policy_lockout_safety_check)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] ciphertext_blob
+ # Ciphertext of the data to reencrypt.
+ # @return [String]
+ #
+ # @!attribute [rw] source_encryption_context
+ # Specifies the encryption context to use to decrypt the ciphertext.
+ # Enter the same encryption context that was used to encrypt the
+ # ciphertext.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
+ #
+ # @!attribute [rw] source_key_id
+ # Specifies the KMS key that KMS will use to decrypt the ciphertext
+ # before it is re-encrypted.
+ #
+ # Enter a key ID of the KMS key that was used to encrypt the
+ # ciphertext. If you identify a different KMS key, the `ReEncrypt`
+ # operation throws an `IncorrectKeyException`.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key. If you used a symmetric encryption KMS
+ # key, KMS can get the KMS key from metadata that it adds to the
+ # symmetric ciphertext blob. However, it is always recommended as a
+ # best practice. This practice ensures that you use the KMS key that
+ # you intend.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ # @return [String]
+ #
+ # @!attribute [rw] destination_key_id
+ # A unique identifier for the KMS key that is used to reencrypt the
+ # data. Specify a symmetric encryption KMS key or an asymmetric KMS
+ # key with a `KeyUsage` value of `ENCRYPT_DECRYPT`. To find the
+ # `KeyUsage` value of a KMS key, use the DescribeKey operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ # @return [String]
+ #
+ # @!attribute [rw] destination_encryption_context
+ # Specifies that encryption context to use when the reencrypting the
+ # data.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # A destination encryption context is valid only when the destination
+ # KMS key is a symmetric encryption KMS key. The standard ciphertext
+ # format for asymmetric KMS keys does not include fields for metadata.
+ #
+ # An *encryption context* is a collection of non-secret key-value
+ # pairs that represent additional authenticated data. When you use an
+ # encryption context to encrypt data, you must specify the same (an
+ # exact case-sensitive match) encryption context to decrypt the data.
+ # An encryption context is supported only on operations with symmetric
+ # encryption KMS keys. On operations with symmetric encryption KMS
+ # keys, an encryption context is optional, but it is strongly
+ # recommended.
+ #
+ # For more information, see [Encryption context][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
+ # @return [Hash<String,String>]
+ #
+ # @!attribute [rw] source_encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to decrypt the
+ # ciphertext before it is reencrypted. The default value,
+ # `SYMMETRIC_DEFAULT`, represents the algorithm used for symmetric
+ # encryption KMS keys.
+ #
+ # Specify the same algorithm that was used to encrypt the ciphertext.
+ # If you specify a different algorithm, the decrypt attempt fails.
+ #
+ # This parameter is required only when the ciphertext was encrypted
+ # under an asymmetric KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] destination_encryption_algorithm
+ # Specifies the encryption algorithm that KMS will use to reecrypt the
+ # data after it has decrypted it. The default value,
+ # `SYMMETRIC_DEFAULT`, represents the encryption algorithm used for
+ # symmetric encryption KMS keys.
+ #
+ # This parameter is required only when the destination KMS key is an
+ # asymmetric KMS key.
+ # @return [String]
+ #
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
+ #
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest AWS API Documentation
+ #
+ class ReEncryptRequest < Struct.new(
+ :ciphertext_blob,
+ :source_encryption_context,
+ :source_key_id,
+ :destination_key_id,
+ :destination_encryption_context,
+ :source_encryption_algorithm,
+ :destination_encryption_algorithm,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] ciphertext_blob
+ # The reencrypted data. When you use the HTTP API or the Amazon Web
+ # Services CLI, the value is Base64-encoded. Otherwise, it is not
+ # Base64-encoded.
+ # @return [String]
+ #
+ # @!attribute [rw] source_key_id
+ # Unique identifier of the KMS key used to originally encrypt the
+ # data.
+ # @return [String]
+ #
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key that was used
+ # to reencrypt the data.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
+ #
+ # @!attribute [rw] source_encryption_algorithm
+ # The encryption algorithm that was used to decrypt the ciphertext
+ # before it was reencrypted.
+ # @return [String]
+ #
+ # @!attribute [rw] destination_encryption_algorithm
+ # The encryption algorithm that was used to reencrypt the data.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptResponse AWS API Documentation
+ #
+ class ReEncryptResponse < Struct.new(
+ :ciphertext_blob,
+ :source_key_id,
+ :key_id,
+ :source_encryption_algorithm,
+ :destination_encryption_algorithm)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Contains information about the party that receives the response from
+ # the API operation.
+ #
+ # This data type is designed to support Amazon Web Services Nitro
+ # Enclaves, which lets you create an isolated compute environment in
+ # Amazon EC2. For information about the interaction between KMS and
+ # Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro
+ # Enclaves uses KMS][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html
+ #
+ # @!attribute [rw] key_encryption_algorithm
+ # The encryption algorithm that KMS should use with the public key for
+ # an Amazon Web Services Nitro Enclave to encrypt plaintext values for
+ # the response. The only valid value is `RSAES_OAEP_SHA_256`.
+ # @return [String]
+ #
+ # @!attribute [rw] attestation_document
+ # The attestation document for an Amazon Web Services Nitro Enclave.
+ # This document includes the enclave's public key.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RecipientInfo AWS API Documentation
+ #
+ class RecipientInfo < Struct.new(
+ :key_encryption_algorithm,
+ :attestation_document)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Identifies the multi-Region primary key that is being replicated. To
+ # determine whether a KMS key is a multi-Region primary key, use the
+ # DescribeKey operation to check the value of the `MultiRegionKeyType`
+ # property.
+ #
+ # Specify the key ID or key ARN of a multi-Region primary key.
+ #
+ # For example:
+ #
+ # * Key ID: `mrk-1234abcd12ab34cd56ef1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] replica_region
+ # The Region ID of the Amazon Web Services Region for this replica
+ # key.
+ #
+ # Enter the Region ID, such as `us-east-1` or `ap-southeast-2`. For a
+ # list of Amazon Web Services Regions in which KMS is supported, see
+ # [KMS service endpoints][1] in the *Amazon Web Services General
+ # Reference*.
+ #
+ # <note markdown="1"> HMAC KMS keys are not supported in all Amazon Web Services Regions.
+ # If you try to replicate an HMAC KMS key in an Amazon Web Services
+ # Region in which HMAC keys are not supported, the `ReplicateKey`
+ # operation returns an `UnsupportedOperationException`. For a list of
+ # Regions in which HMAC KMS keys are supported, see [HMAC keys in
+ # KMS][2] in the *Key Management Service Developer Guide*.
+ #
+ # </note>
+ #
+ # The replica must be in a different Amazon Web Services Region than
+ # its primary key and other replicas of that primary key, but in the
+ # same Amazon Web Services partition. KMS must be available in the
+ # replica Region. If the Region is not enabled by default, the Amazon
+ # Web Services account must be enabled in the Region. For information
+ # about Amazon Web Services partitions, see [Amazon Resource Names
+ # (ARNs)][3] in the *Amazon Web Services General Reference*. For
+ # information about enabling and disabling Regions, see [Enabling a
+ # Region][4] and [Disabling a Region][5] in the *Amazon Web Services
+ # General Reference*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
+ # [5]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable
+ # @return [String]
+ #
+ # @!attribute [rw] policy
+ # The key policy to attach to the KMS key. This parameter is optional.
+ # If you do not provide a key policy, KMS attaches the [default key
+ # policy][1] to the KMS key.
+ #
+ # The key policy is not a shared property of multi-Region keys. You
+ # can specify the same key policy or a different key policy for each
+ # key in a set of related multi-Region keys. KMS does not synchronize
+ # this property.
+ #
+ # If you provide a key policy, it must meet the following criteria:
+ #
+ # * The key policy must allow the calling principal to make a
+ # subsequent `PutKeyPolicy` request on the KMS key. This reduces the
+ # risk that the KMS key becomes unmanageable. For more information,
+ # see [Default key policy][2] in the *Key Management Service
+ # Developer Guide*. (To omit this condition, set
+ # `BypassPolicyLockoutSafetyCheck` to true.)
+ #
+ # * Each statement in the key policy must contain one or more
+ # principals. The principals in the key policy must exist and be
+ # visible to KMS. When you create a new Amazon Web Services
+ # principal, you might need to enforce a delay before including the
+ # new principal in a key policy because the new principal might not
+ # be immediately visible to KMS. For more information, see [Changes
+ # that I make are not always immediately visible][3] in the *Amazon
+ # Web Services Identity and Access Management User Guide*.
+ #
+ # A key policy document can include only the following characters:
+ #
+ # * Printable ASCII characters from the space character (`\u0020`)
+ # through the end of the ASCII character range.
+ #
+ # * Printable characters in the Basic Latin and Latin-1 Supplement
+ # character set (through `\u00FF`).
+ #
+ # * The tab (`\u0009`), line feed (`\u000A`), and carriage return
+ # (`\u000D`) special characters
+ #
+ # For information about key policies, see [Key policies in KMS][4] in
+ # the *Key Management Service Developer Guide*. For help writing and
+ # formatting a JSON policy document, see the [IAM JSON Policy
+ # Reference][5] in the <i> <i>Identity and Access Management User
+ # Guide</i> </i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
+ # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+ # @return [String]
+ #
+ # @!attribute [rw] bypass_policy_lockout_safety_check
+ # Skips ("bypasses") the key policy lockout safety check. The
+ # default value is false.
+ #
+ # Setting this value to true increases the risk that the KMS key
+ # becomes unmanageable. Do not set this value to true
+ # indiscriminately.
+ #
+ # For more information, see [Default key policy][1] in the *Key
+ # Management Service Developer Guide*.
+ #
+ # Use this parameter only when you intend to prevent the principal
+ # that is making the request from making a subsequent PutKeyPolicy
+ # request on the KMS key.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key
+ # @return [Boolean]
#
# @!attribute [rw] description
- # The description of the CMK.
+ # A description of the KMS key. The default value is an empty string
+ # (no description).
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # The description is not a shared property of multi-Region keys. You
+ # can specify the same description or a different description for each
+ # key in a set of related multi-Region keys. KMS does not synchronize
+ # this property.
+ # @return [String]
+ #
+ # @!attribute [rw] tags
+ # Assigns one or more tags to the replica key. Use this parameter to
+ # tag the KMS key when it is created. To tag an existing KMS key, use
+ # the TagResource operation.
+ #
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # <note markdown="1"> Tagging or untagging a KMS key can allow or deny permission to the
+ # KMS key. For details, see [ABAC for KMS][1] in the *Key Management
+ # Service Developer Guide*.
+ #
+ # </note>
+ #
+ # To use this parameter, you must have [kms:TagResource][2] permission
+ # in an IAM policy.
+ #
+ # Tags are not a shared property of multi-Region keys. You can specify
+ # the same tags or different tags for each key in a set of related
+ # multi-Region keys. KMS does not synchronize this property.
+ #
+ # Each tag consists of a tag key and a tag value. Both the tag key and
+ # the tag value are required, but the tag value can be an empty (null)
+ # string. You cannot have more than one tag on a KMS key with the same
+ # tag key. If you specify an existing tag key with a different tag
+ # value, KMS replaces the current tag value with the specified one.
+ #
+ # When you add tags to an Amazon Web Services resource, Amazon Web
+ # Services generates a cost allocation report with usage and costs
+ # aggregated by tags. Tags can also be used to control access to a KMS
+ # key. For details, see [Tagging Keys][3].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html
+ # @return [Array<Types::Tag>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKeyRequest AWS API Documentation
+ #
+ class ReplicateKeyRequest < Struct.new(
+ :key_id,
+ :replica_region,
+ :policy,
+ :bypass_policy_lockout_safety_check,
+ :description,
+ :tags)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] replica_key_metadata
+ # Displays details about the new replica key, including its Amazon
+ # Resource Name ([key ARN][1]) and [Key states of KMS keys][2]. It
+ # also includes the ARN and Amazon Web Services Region of its primary
+ # key and other replica keys.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+ # @return [Types::KeyMetadata]
+ #
+ # @!attribute [rw] replica_policy
+ # The key policy of the new replica key. The value is a key policy
+ # document in JSON format.
+ # @return [String]
+ #
+ # @!attribute [rw] replica_tags
+ # The tags on the new replica key. The value is a list of tag key and
+ # tag value pairs.
+ # @return [Array<Types::Tag>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKeyResponse AWS API Documentation
+ #
+ class ReplicateKeyResponse < Struct.new(
+ :replica_key_metadata,
+ :replica_policy,
+ :replica_tags)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] grant_token
+ # Identifies the grant to be retired. You can use a grant token to
+ # identify a new grant even before it has achieved eventual
+ # consistency.
+ #
+ # Only the CreateGrant operation returns a grant token. For details,
+ # see [Grant token][1] and [Eventual consistency][2] in the *Key
+ # Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency
+ # @return [String]
+ #
+ # @!attribute [rw] key_id
+ # The key ARN KMS key associated with the grant. To find the key ARN,
+ # use the ListKeys operation.
+ #
+ # For example:
+ # `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @return [String]
+ #
+ # @!attribute [rw] grant_id
+ # Identifies the grant to retire. To get the grant ID, use
+ # CreateGrant, ListGrants, or ListRetirableGrants.
+ #
+ # * Grant ID Example -
+ # 0123456789012345678901234567890123456789012345678901234567890123
+ #
+ # ^
+ # @return [String]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantRequest AWS API Documentation
+ #
+ class RetireGrantRequest < Struct.new(
+ :grant_token,
+ :key_id,
+ :grant_id,
+ :dry_run)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # A unique identifier for the KMS key associated with the grant. To
+ # get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ #
+ # Specify the key ID or key ARN of the KMS key. To specify a KMS key
+ # in a different Amazon Web Services account, you must use the key
+ # ARN.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] grant_id
+ # Identifies the grant to revoke. To get the grant ID, use
+ # CreateGrant, ListGrants, or ListRetirableGrants.
+ # @return [String]
+ #
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
+ #
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantRequest AWS API Documentation
+ #
+ class RevokeGrantRequest < Struct.new(
+ :key_id,
+ :grant_id,
+ :dry_run)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # The unique identifier of the KMS key to delete.
+ #
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
+ # @return [String]
+ #
+ # @!attribute [rw] pending_window_in_days
+ # The waiting period, specified in number of days. After the waiting
+ # period ends, KMS deletes the KMS key.
+ #
+ # If the KMS key is a multi-Region primary key with replica keys, the
+ # waiting period begins when the last of its replica keys is deleted.
+ # Otherwise, the waiting period begins immediately.
+ #
+ # This value is optional. If you include a value, it must be between 7
+ # and 30, inclusive. If you do not include a value, it defaults to 30.
+ # You can use the [ `kms:ScheduleKeyDeletionPendingWindowInDays` ][1]
+ # condition key to further constrain the values that principals can
+ # specify in the `PendingWindowInDays` parameter.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days
+ # @return [Integer]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionRequest AWS API Documentation
+ #
+ class ScheduleKeyDeletionRequest < Struct.new(
+ :key_id,
+ :pending_window_in_days)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the KMS key whose
+ # deletion is scheduled.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
+ # @return [String]
+ #
+ # @!attribute [rw] deletion_date
+ # The date and time after which KMS deletes the KMS key.
+ #
+ # If the KMS key is a multi-Region primary key with replica keys, this
+ # field does not appear. The deletion date for the primary key isn't
+ # known until its last replica key is deleted.
+ # @return [Time]
+ #
+ # @!attribute [rw] key_state
+ # The current status of the KMS key.
+ #
+ # For more information about how key state affects the use of a KMS
+ # key, see [Key states of KMS keys][1] in the *Key Management Service
+ # Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
# @return [String]
#
- # @!attribute [rw] key_usage
- # The cryptographic operations for which you can use the CMK. The only
- # valid value is `ENCRYPT_DECRYPT`, which means you can use the CMK to
- # encrypt and decrypt data.
- # @return [String]
+ # @!attribute [rw] pending_window_in_days
+ # The waiting period before the KMS key is deleted.
+ #
+ # If the KMS key is a multi-Region primary key with replicas, the
+ # waiting period begins when the last of its replica keys is deleted.
+ # Otherwise, the waiting period begins immediately.
+ # @return [Integer]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionResponse AWS API Documentation
+ #
+ class ScheduleKeyDeletionResponse < Struct.new(
+ :key_id,
+ :deletion_date,
+ :key_state,
+ :pending_window_in_days)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Identifies an asymmetric KMS key. KMS uses the private key in the
+ # asymmetric KMS key to sign the message. The `KeyUsage` type of the
+ # KMS key must be `SIGN_VERIFY`. To find the `KeyUsage` of a KMS key,
+ # use the DescribeKey operation.
+ #
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
- # @!attribute [rw] key_state
- # The state of the CMK.
+ # For example:
#
- # For more information about how key state affects the use of a CMK,
- # see [How Key State Affects the Use of a Customer Master Key][1] in
- # the *AWS Key Management Service Developer Guide*.
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
+ # * Alias name: `alias/ExampleAlias`
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
- # @return [String]
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
#
- # @!attribute [rw] deletion_date
- # The date and time after which AWS KMS deletes the CMK. This value is
- # present only when `KeyState` is `PendingDeletion`.
- # @return [Time]
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ # @return [String]
#
- # @!attribute [rw] valid_to
- # The time at which the imported key material expires. When the key
- # material expires, AWS KMS deletes the key material and the CMK
- # becomes unusable. This value is present only for CMKs whose `Origin`
- # is `EXTERNAL` and whose `ExpirationModel` is `KEY_MATERIAL_EXPIRES`,
- # otherwise this value is omitted.
- # @return [Time]
+ # @!attribute [rw] message
+ # Specifies the message or message digest to sign. Messages can be
+ # 0-4096 bytes. To sign a larger message, provide a message digest.
#
- # @!attribute [rw] origin
- # The source of the CMK's key material. When this value is `AWS_KMS`,
- # AWS KMS created the key material. When this value is `EXTERNAL`, the
- # key material was imported from your existing key management
- # infrastructure or the CMK lacks key material. When this value is
- # `AWS_CLOUDHSM`, the key material was created in the AWS CloudHSM
- # cluster associated with a custom key store.
+ # If you provide a message digest, use the `DIGEST` value of
+ # `MessageType` to prevent the digest from being hashed again while
+ # signing.
# @return [String]
#
- # @!attribute [rw] custom_key_store_id
- # A unique identifier for the [custom key store][1] that contains the
- # CMK. This value is present only when the CMK is created in a custom
- # key store.
+ # @!attribute [rw] message_type
+ # Tells KMS whether the value of the `Message` parameter should be
+ # hashed as part of the signing algorithm. Use `RAW` for unhashed
+ # messages; use `DIGEST` for message digests, which are already
+ # hashed.
#
+ # When the value of `MessageType` is `RAW`, KMS uses the standard
+ # signing algorithm, which begins with a hash function. When the value
+ # is `DIGEST`, KMS skips the hashing step in the signing algorithm.
#
+ # Use the `DIGEST` value only when the value of the `Message`
+ # parameter is a message digest. If you use the `DIGEST` value with an
+ # unhashed message, the security of the signing operation can be
+ # compromised.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # @return [String]
+ # When the value of `MessageType`is `DIGEST`, the length of the
+ # `Message` value must match the length of hashed messages for the
+ # specified signing algorithm.
#
- # @!attribute [rw] cloud_hsm_cluster_id
- # The cluster ID of the AWS CloudHSM cluster that contains the key
- # material for the CMK. When you create a CMK in a [custom key
- # store][1], AWS KMS creates the key material for the CMK in the
- # associated AWS CloudHSM cluster. This value is present only when the
- # CMK is created in a custom key store.
+ # You can submit a message digest and omit the `MessageType` or
+ # specify `RAW` so the digest is hashed again while signing. However,
+ # this can cause verification failures when verifying with a system
+ # that assumes a single hash.
#
+ # The hashing algorithm in that `Sign` uses is based on the
+ # `SigningAlgorithm` value.
#
+ # * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
+ # algorithm.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html
- # @return [String]
+ # * Signing algorithms that end in SHA\_384 use the SHA\_384 hashing
+ # algorithm.
#
- # @!attribute [rw] expiration_model
- # Specifies whether the CMK's key material expires. This value is
- # present only when `Origin` is `EXTERNAL`, otherwise this value is
- # omitted.
- # @return [String]
+ # * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
+ # algorithm.
#
- # @!attribute [rw] key_manager
- # The manager of the CMK. CMKs in your AWS account are either customer
- # managed or AWS managed. For more information about the difference,
- # see [Customer Master Keys][1] in the *AWS Key Management Service
- # Developer Guide*.
+ # * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
+ # verification with SM2 key pairs][1].
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata AWS API Documentation
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
- class KeyMetadata < Struct.new(
- :aws_account_id,
- :key_id,
- :arn,
- :creation_date,
- :enabled,
- :description,
- :key_usage,
- :key_state,
- :deletion_date,
- :valid_to,
- :origin,
- :custom_key_store_id,
- :cloud_hsm_cluster_id,
- :expiration_model,
- :key_manager)
- include Aws::Structure
- end
-
- # The request was rejected because the specified CMK was not available.
- # The request can be retried.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] message
- # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyUnavailableException AWS API Documentation
#
- class KeyUnavailableException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because a limit was exceeded. For more
- # information, see [Limits][1] in the *AWS Key Management Service
- # Developer Guide*.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
+ # @!attribute [rw] signing_algorithm
+ # Specifies the signing algorithm to use when signing the message.
#
+ # Choose an algorithm that is compatible with the type and size of the
+ # specified asymmetric KMS key. When signing with RSA key pairs,
+ # RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1\_5
+ # algorithms for compatibility with existing applications.
+ # @return [String]
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # @!attribute [rw] message
- # @return [String]
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/LimitExceededException AWS API Documentation
#
- class LimitExceededException < Struct.new(
- :message)
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/SignRequest AWS API Documentation
+ #
+ class SignRequest < Struct.new(
+ :key_id,
+ :message,
+ :message_type,
+ :grant_tokens,
+ :signing_algorithm,
+ :dry_run)
+ SENSITIVE = [:message]
include Aws::Structure
end
- # @note When making an API call, you may pass ListAliasesRequest
- # data as a hash:
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the asymmetric KMS key
+ # that was used to sign the message.
#
- # {
- # key_id: "KeyIdType",
- # limit: 1,
- # marker: "MarkerType",
- # }
#
- # @!attribute [rw] key_id
- # Lists only aliases that refer to the specified CMK. The value of
- # this parameter can be the ID or Amazon Resource Name (ARN) of a CMK
- # in the caller's account and region. You cannot use an alias name or
- # alias ARN in this value.
#
- # This parameter is optional. If you omit it, `ListAliases` returns
- # all aliases in the account and region.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # @!attribute [rw] signature
+ # The cryptographic signature that was generated for the message.
#
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to
- # 50.
- # @return [Integer]
+ # * When used with the supported RSA signing algorithms, the encoding
+ # of this value is defined by [PKCS #1 in RFC 8017][1].
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
- # @return [String]
+ # * When used with the `ECDSA_SHA_256`, `ECDSA_SHA_384`, or
+ # `ECDSA_SHA_512` signing algorithms, this value is a DER-encoded
+ # object as defined by ANSI X9.62–2005 and [RFC 3279 Section
+ # 2.2.3][2]. This is the most commonly used signature format and is
+ # appropriate for most uses.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesRequest AWS API Documentation
+ # When you use the HTTP API or the Amazon Web Services CLI, the value
+ # is Base64-encoded. Otherwise, it is not Base64-encoded.
#
- class ListAliasesRequest < Struct.new(
- :key_id,
- :limit,
- :marker)
- include Aws::Structure
- end
-
- # @!attribute [rw] aliases
- # A list of aliases.
- # @return [Array<Types::AliasListEntry>]
#
- # @!attribute [rw] next_marker
- # When `Truncated` is true, this element is present and contains the
- # value to use for the `Marker` parameter in a subsequent request.
+ #
+ # [1]: https://tools.ietf.org/html/rfc8017
+ # [2]: https://tools.ietf.org/html/rfc3279#section-2.2.3
# @return [String]
#
- # @!attribute [rw] truncated
- # A flag that indicates whether there are more items in the list. When
- # this value is true, the list in this response is truncated. To get
- # more items, pass the value of the `NextMarker` element in
- # thisresponse to the `Marker` parameter in a subsequent request.
- # @return [Boolean]
+ # @!attribute [rw] signing_algorithm
+ # The signing algorithm that was used to sign the message.
+ # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesResponse AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/SignResponse AWS API Documentation
#
- class ListAliasesResponse < Struct.new(
- :aliases,
- :next_marker,
- :truncated)
+ class SignResponse < Struct.new(
+ :key_id,
+ :signature,
+ :signing_algorithm)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ListGrantsRequest
- # data as a hash:
- #
- # {
- # limit: 1,
- # marker: "MarkerType",
- # key_id: "KeyIdType", # required
- # }
- #
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
- #
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to
- # 50.
- # @return [Integer]
+ # A key-value pair. A tag consists of a tag key and a tag value. Tag
+ # keys and tag values are both required, but tag values can be empty
+ # (null) strings.
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
- # @return [String]
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and other
+ # output.
#
- # @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # For information about the rules that apply to tag keys and tag values,
+ # see [User-Defined Tag Restrictions][1] in the *Amazon Web Services
+ # Billing and Cost Management User Guide*.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
#
- # For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @!attribute [rw] tag_key
+ # The key of the tag.
+ # @return [String]
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # @!attribute [rw] tag_value
+ # The value of the tag.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Tag AWS API Documentation
#
- class ListGrantsRequest < Struct.new(
- :limit,
- :marker,
- :key_id)
+ class Tag < Struct.new(
+ :tag_key,
+ :tag_value)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] grants
- # A list of grants.
- # @return [Array<Types::GrantListEntry>]
+ # The request was rejected because one or more tags are not valid.
#
- # @!attribute [rw] next_marker
- # When `Truncated` is true, this element is present and contains the
- # value to use for the `Marker` parameter in a subsequent request.
+ # @!attribute [rw] message
# @return [String]
#
- # @!attribute [rw] truncated
- # A flag that indicates whether there are more items in the list. When
- # this value is true, the list in this response is truncated. To get
- # more items, pass the value of the `NextMarker` element in
- # thisresponse to the `Marker` parameter in a subsequent request.
- # @return [Boolean]
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsResponse AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagException AWS API Documentation
#
- class ListGrantsResponse < Struct.new(
- :grants,
- :next_marker,
- :truncated)
+ class TagException < Struct.new(
+ :message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ListKeyPoliciesRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # limit: 1,
- # marker: "MarkerType",
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Identifies a customer managed key in the account and Region.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2560,132 +5638,97 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
- #
- # This value is optional. If you include a value, it must be between 1
- # and 1000, inclusive. If you do not include a value, it defaults to
- # 100.
+ # @!attribute [rw] tags
+ # One or more tags. Each tag consists of a tag key and a tag value.
+ # The tag value can be an empty (null) string.
#
- # Only one policy can be attached to a key.
- # @return [Integer]
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
- # @return [String]
+ # You cannot have more than one tag on a KMS key with the same tag
+ # key. If you specify an existing tag key with a different tag value,
+ # KMS replaces the current tag value with the specified one.
+ # @return [Array<Types::Tag>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResourceRequest AWS API Documentation
#
- class ListKeyPoliciesRequest < Struct.new(
+ class TagResourceRequest < Struct.new(
:key_id,
- :limit,
- :marker)
- include Aws::Structure
- end
-
- # @!attribute [rw] policy_names
- # A list of key policy names. The only valid value is `default`.
- # @return [Array<String>]
- #
- # @!attribute [rw] next_marker
- # When `Truncated` is true, this element is present and contains the
- # value to use for the `Marker` parameter in a subsequent request.
- # @return [String]
- #
- # @!attribute [rw] truncated
- # A flag that indicates whether there are more items in the list. When
- # this value is true, the list in this response is truncated. To get
- # more items, pass the value of the `NextMarker` element in
- # thisresponse to the `Marker` parameter in a subsequent request.
- # @return [Boolean]
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesResponse AWS API Documentation
- #
- class ListKeyPoliciesResponse < Struct.new(
- :policy_names,
- :next_marker,
- :truncated)
+ :tags)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ListKeysRequest
- # data as a hash:
- #
- # {
- # limit: 1,
- # marker: "MarkerType",
- # }
- #
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
- #
- # This value is optional. If you include a value, it must be between 1
- # and 1000, inclusive. If you do not include a value, it defaults to
- # 100.
- # @return [Integer]
+ # The request was rejected because a specified parameter is not
+ # supported or a specified resource is not valid for this operation.
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ # @!attribute [rw] message
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UnsupportedOperationException AWS API Documentation
#
- class ListKeysRequest < Struct.new(
- :limit,
- :marker)
+ class UnsupportedOperationException < Struct.new(
+ :message)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] keys
- # A list of customer master keys (CMKs).
- # @return [Array<Types::KeyListEntry>]
+ # @!attribute [rw] key_id
+ # Identifies the KMS key from which you are removing tags.
#
- # @!attribute [rw] next_marker
- # When `Truncated` is true, this element is present and contains the
- # value to use for the `Marker` parameter in a subsequent request.
+ # Specify the key ID or key ARN of the KMS key.
+ #
+ # For example:
+ #
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
# @return [String]
#
- # @!attribute [rw] truncated
- # A flag that indicates whether there are more items in the list. When
- # this value is true, the list in this response is truncated. To get
- # more items, pass the value of the `NextMarker` element in
- # thisresponse to the `Marker` parameter in a subsequent request.
- # @return [Boolean]
+ # @!attribute [rw] tag_keys
+ # One or more tag keys. Specify only the tag keys, not the tag values.
+ # @return [Array<String>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysResponse AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResourceRequest AWS API Documentation
#
- class ListKeysResponse < Struct.new(
- :keys,
- :next_marker,
- :truncated)
+ class UntagResourceRequest < Struct.new(
+ :key_id,
+ :tag_keys)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ListResourceTagsRequest
- # data as a hash:
+ # @!attribute [rw] alias_name
+ # Identifies the alias that is changing its KMS key. This value must
+ # begin with `alias/` followed by the alias name, such as
+ # `alias/ExampleAlias`. You cannot use `UpdateAlias` to change the
+ # alias name.
#
- # {
- # key_id: "KeyIdType", # required
- # limit: 1,
- # marker: "MarkerType",
- # }
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ # @return [String]
#
- # @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # @!attribute [rw] target_key_id
+ # Identifies the [customer managed key][1] to associate with the
+ # alias. You don't have permission to associate an alias with an
+ # [Amazon Web Services managed key][2].
+ #
+ # The KMS key must be in the same Amazon Web Services account and
+ # Region as the alias. Also, the new target KMS key must be the same
+ # type as the current target KMS key (both symmetric or both
+ # asymmetric or both HMAC) and they must have the same key usage.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2694,154 +5737,190 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
- # @return [String]
#
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # To verify that the alias is mapped to the correct KMS key, use
+ # ListAliases.
#
- # This value is optional. If you include a value, it must be between 1
- # and 50, inclusive. If you do not include a value, it defaults to 50.
- # @return [Integer]
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
#
- # Do not attempt to construct this value. Use only the value of
- # `NextMarker` from the truncated response you just received.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest AWS API Documentation
#
- class ListResourceTagsRequest < Struct.new(
- :key_id,
- :limit,
- :marker)
+ class UpdateAliasRequest < Struct.new(
+ :alias_name,
+ :target_key_id)
+ SENSITIVE = []
include Aws::Structure
end
- # @!attribute [rw] tags
- # A list of tags. Each tag consists of a tag key and a tag value.
- # @return [Array<Types::Tag>]
+ # @!attribute [rw] custom_key_store_id
+ # Identifies the custom key store that you want to update. Enter the
+ # ID of the custom key store. To find the ID of a custom key store,
+ # use the DescribeCustomKeyStores operation.
+ # @return [String]
#
- # @!attribute [rw] next_marker
- # When `Truncated` is true, this element is present and contains the
- # value to use for the `Marker` parameter in a subsequent request.
+ # @!attribute [rw] new_custom_key_store_name
+ # Changes the friendly name of the custom key store to the value that
+ # you specify. The custom key store name must be unique in the Amazon
+ # Web Services account.
#
- # Do not assume or infer any information from this value.
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ #
+ # To change this value, an CloudHSM key store must be disconnected. An
+ # external key store can be connected or disconnected.
# @return [String]
#
- # @!attribute [rw] truncated
- # A flag that indicates whether there are more items in the list. When
- # this value is true, the list in this response is truncated. To get
- # more items, pass the value of the `NextMarker` element in
- # thisresponse to the `Marker` parameter in a subsequent request.
- # @return [Boolean]
+ # @!attribute [rw] key_store_password
+ # Enter the current password of the `kmsuser` crypto user (CU) in the
+ # CloudHSM cluster that is associated with the custom key store. This
+ # parameter is valid only for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsResponse AWS API Documentation
+ # This parameter tells KMS the current password of the `kmsuser`
+ # crypto user (CU). It does not set or change the password of any
+ # users in the CloudHSM cluster.
#
- class ListResourceTagsResponse < Struct.new(
- :tags,
- :next_marker,
- :truncated)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass ListRetirableGrantsRequest
- # data as a hash:
+ # To change this value, the CloudHSM key store must be disconnected.
+ # @return [String]
#
- # {
- # limit: 1,
- # marker: "MarkerType",
- # retiring_principal: "PrincipalIdType", # required
- # }
+ # @!attribute [rw] cloud_hsm_cluster_id
+ # Associates the custom key store with a related CloudHSM cluster.
+ # This parameter is valid only for custom key stores with a
+ # `CustomKeyStoreType` of `AWS_CLOUDHSM`.
#
- # @!attribute [rw] limit
- # Use this parameter to specify the maximum number of items to return.
- # When this value is present, AWS KMS does not return more than the
- # specified number of items, but it might return fewer.
+ # Enter the cluster ID of the cluster that you used to create the
+ # custom key store or a cluster that shares a backup history and has
+ # the same cluster certificate as the original cluster. You cannot use
+ # this parameter to associate a custom key store with an unrelated
+ # cluster. In addition, the replacement cluster must [fulfill the
+ # requirements][1] for a cluster associated with a custom key store.
+ # To view the cluster certificate of a cluster, use the
+ # [DescribeClusters][2] operation.
#
- # This value is optional. If you include a value, it must be between 1
- # and 100, inclusive. If you do not include a value, it defaults to
- # 50.
- # @return [Integer]
+ # To change this value, the CloudHSM key store must be disconnected.
#
- # @!attribute [rw] marker
- # Use this parameter in a subsequent request after you receive a
- # response with truncated results. Set it to the value of `NextMarker`
- # from the truncated response you just received.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
+ # [2]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html
# @return [String]
#
- # @!attribute [rw] retiring_principal
- # The retiring principal for which to list grants.
+ # @!attribute [rw] xks_proxy_uri_endpoint
+ # Changes the URI endpoint that KMS uses to connect to your external
+ # key store proxy (XKS proxy). This parameter is valid only for custom
+ # key stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
#
- # To specify the retiring principal, use the [Amazon Resource Name
- # (ARN)][1] of an AWS principal. Valid AWS principals include AWS
- # accounts (root), IAM users, federated users, and assumed role users.
- # For examples of the ARN syntax for specifying a principal, see [AWS
- # Identity and Access Management (IAM)][2] in the Example ARNs section
- # of the *Amazon Web Services General Reference*.
+ # For external key stores with an `XksProxyConnectivity` value of
+ # `PUBLIC_ENDPOINT`, the protocol must be HTTPS.
#
+ # For external key stores with an `XksProxyConnectivity` value of
+ # `VPC_ENDPOINT_SERVICE`, specify `https://` followed by the private
+ # DNS name associated with the VPC endpoint service. Each external key
+ # store must use a different private DNS name.
#
+ # The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
#
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
- # [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
+ # To change this value, the external key store must be disconnected.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrantsRequest AWS API Documentation
+ # @!attribute [rw] xks_proxy_uri_path
+ # Changes the base path to the proxy APIs for this external key store.
+ # To find this value, see the documentation for your external key
+ # manager and external key store proxy (XKS proxy). This parameter is
+ # valid only for custom key stores with a `CustomKeyStoreType` of
+ # `EXTERNAL_KEY_STORE`.
#
- class ListRetirableGrantsRequest < Struct.new(
- :limit,
- :marker,
- :retiring_principal)
- include Aws::Structure
- end
-
- # The request was rejected because the specified policy is not
- # syntactically or semantically correct.
+ # The value must start with `/` and must end with `/kms/xks/v1`, where
+ # `v1` represents the version of the KMS external key store proxy API.
+ # You can include an optional prefix between the required elements
+ # such as `/example/kms/xks/v1`.
#
- # @!attribute [rw] message
+ # The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
+ # be unique in the Amazon Web Services account and Region.
+ #
+ # You can change this value when the external key store is connected
+ # or disconnected.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MalformedPolicyDocumentException AWS API Documentation
+ # @!attribute [rw] xks_proxy_vpc_endpoint_service_name
+ # Changes the name that KMS uses to identify the Amazon VPC endpoint
+ # service for your external key store proxy (XKS proxy). This
+ # parameter is valid when the `CustomKeyStoreType` is
+ # `EXTERNAL_KEY_STORE` and the `XksProxyConnectivity` is
+ # `VPC_ENDPOINT_SERVICE`.
#
- class MalformedPolicyDocumentException < Struct.new(
- :message)
- include Aws::Structure
- end
-
- # The request was rejected because the specified entity or resource
- # could not be found.
+ # To change this value, the external key store must be disconnected.
+ # @return [String]
#
- # @!attribute [rw] message
+ # @!attribute [rw] xks_proxy_authentication_credential
+ # Changes the credentials that KMS uses to sign requests to the
+ # external key store proxy (XKS proxy). This parameter is valid only
+ # for custom key stores with a `CustomKeyStoreType` of
+ # `EXTERNAL_KEY_STORE`.
+ #
+ # You must specify both the `AccessKeyId` and `SecretAccessKey` value
+ # in the authentication credential, even if you are only updating one
+ # value.
+ #
+ # This parameter doesn't establish or change your authentication
+ # credentials on the proxy. It just tells KMS the credential that you
+ # established with your external key store proxy. For example, if you
+ # rotate the credential on your external key store proxy, you can use
+ # this parameter to update the credential in KMS.
+ #
+ # You can change this value when the external key store is connected
+ # or disconnected.
+ # @return [Types::XksProxyAuthenticationCredentialType]
+ #
+ # @!attribute [rw] xks_proxy_connectivity
+ # Changes the connectivity setting for the external key store. To
+ # indicate that the external key store proxy uses a Amazon VPC
+ # endpoint service to communicate with KMS, specify
+ # `VPC_ENDPOINT_SERVICE`. Otherwise, specify `PUBLIC_ENDPOINT`.
+ #
+ # If you change the `XksProxyConnectivity` to `VPC_ENDPOINT_SERVICE`,
+ # you must also change the `XksProxyUriEndpoint` and add an
+ # `XksProxyVpcEndpointServiceName` value.
+ #
+ # If you change the `XksProxyConnectivity` to `PUBLIC_ENDPOINT`, you
+ # must also change the `XksProxyUriEndpoint` and specify a null or
+ # empty string for the `XksProxyVpcEndpointServiceName` value.
+ #
+ # To change this value, the external key store must be disconnected.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/NotFoundException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreRequest AWS API Documentation
#
- class NotFoundException < Struct.new(
- :message)
+ class UpdateCustomKeyStoreRequest < Struct.new(
+ :custom_key_store_id,
+ :new_custom_key_store_name,
+ :key_store_password,
+ :cloud_hsm_cluster_id,
+ :xks_proxy_uri_endpoint,
+ :xks_proxy_uri_path,
+ :xks_proxy_vpc_endpoint_service_name,
+ :xks_proxy_authentication_credential,
+ :xks_proxy_connectivity)
+ SENSITIVE = [:key_store_password]
include Aws::Structure
end
- # @note When making an API call, you may pass PutKeyPolicyRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # policy_name: "PolicyNameType", # required
- # policy: "PolicyType", # required
- # bypass_policy_lockout_safety_check: false,
- # }
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreResponse AWS API Documentation
#
+ class UpdateCustomKeyStoreResponse < Aws::EmptyStructure; end
+
# @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # Updates the description of the specified KMS key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # Specify the key ID or key ARN of the KMS key.
#
# For example:
#
@@ -2850,225 +5929,168 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
# DescribeKey.
# @return [String]
#
- # @!attribute [rw] policy_name
- # The name of the key policy. The only valid value is `default`.
- # @return [String]
+ # @!attribute [rw] description
+ # New description for the KMS key.
#
- # @!attribute [rw] policy
- # The key policy to attach to the CMK.
+ # Do not include confidential or sensitive information in this field.
+ # This field may be displayed in plaintext in CloudTrail logs and
+ # other output.
+ # @return [String]
#
- # The key policy must meet the following criteria:
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescriptionRequest AWS API Documentation
#
- # * If you don't set `BypassPolicyLockoutSafetyCheck` to true, the
- # key policy must allow the principal that is making the
- # `PutKeyPolicy` request to make a subsequent `PutKeyPolicy` request
- # on the CMK. This reduces the risk that the CMK becomes
- # unmanageable. For more information, refer to the scenario in the
- # [Default Key Policy][1] section of the *AWS Key Management Service
- # Developer Guide*.
+ class UpdateKeyDescriptionRequest < Struct.new(
+ :key_id,
+ :description)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # Identifies the current primary key. When the operation completes,
+ # this KMS key will be a replica key.
#
- # * Each statement in the key policy must contain one or more
- # principals. The principals in the key policy must exist and be
- # visible to AWS KMS. When you create a new AWS principal (for
- # example, an IAM user or role), you might need to enforce a delay
- # before including the new principal in a key policy because the new
- # principal might not be immediately visible to AWS KMS. For more
- # information, see [Changes that I make are not always immediately
- # visible][2] in the *AWS Identity and Access Management User
- # Guide*.
+ # Specify the key ID or key ARN of a multi-Region primary key.
#
- # The key policy size limit is 32 kilobytes (32768 bytes).
+ # For example:
#
+ # * Key ID: `mrk-1234abcd12ab34cd56ef1234567890ab`
#
+ # * Key ARN:
+ # `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey.
# @return [String]
#
- # @!attribute [rw] bypass_policy_lockout_safety_check
- # A flag to indicate whether to bypass the key policy lockout safety
- # check.
- #
- # Setting this value to true increases the risk that the CMK becomes
- # unmanageable. Do not set this value to true indiscriminately.
- #
- # For more information, refer to the scenario in the [Default Key
- # Policy][1] section in the *AWS Key Management Service Developer
- # Guide*.
- #
- # Use this parameter only when you intend to prevent the principal
- # that is making the request from making a subsequent `PutKeyPolicy`
- # request on the CMK.
- #
- # The default value is false.
+ # @!attribute [rw] primary_region
+ # The Amazon Web Services Region of the new primary key. Enter the
+ # Region ID, such as `us-east-1` or `ap-southeast-2`. There must be an
+ # existing replica key in this Region.
#
+ # When the operation completes, the multi-Region key in this Region
+ # will be the primary key.
+ # @return [String]
#
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdatePrimaryRegionRequest AWS API Documentation
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
- # @return [Boolean]
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyRequest AWS API Documentation
- #
- class PutKeyPolicyRequest < Struct.new(
+ class UpdatePrimaryRegionRequest < Struct.new(
:key_id,
- :policy_name,
- :policy,
- :bypass_policy_lockout_safety_check)
+ :primary_region)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass ReEncryptRequest
- # data as a hash:
- #
- # {
- # ciphertext_blob: "data", # required
- # source_encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # destination_key_id: "KeyIdType", # required
- # destination_encryption_context: {
- # "EncryptionContextKey" => "EncryptionContextValue",
- # },
- # grant_tokens: ["GrantTokenType"],
- # }
+ # @!attribute [rw] message
+ # The message that will be used in the verification. Enter the same
+ # message that was used to generate the HMAC.
#
- # @!attribute [rw] ciphertext_blob
- # Ciphertext of the data to reencrypt.
+ # GenerateMac and `VerifyMac` do not provide special handling for
+ # message digests. If you generated an HMAC for a hash digest of a
+ # message, you must verify the HMAC for the same hash digest.
# @return [String]
#
- # @!attribute [rw] source_encryption_context
- # Encryption context used to encrypt and decrypt the data specified in
- # the `CiphertextBlob` parameter.
- # @return [Hash<String,String>]
- #
- # @!attribute [rw] destination_key_id
- # A unique identifier for the CMK that is used to reencrypt the data.
- #
- # To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
- # name, or alias ARN. When using an alias name, prefix it with
- # `"alias/"`. To specify a CMK in a different AWS account, you must
- # use the key ARN or alias ARN.
- #
- # For example:
- #
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
- #
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
- #
- # * Alias name: `alias/ExampleAlias`
+ # @!attribute [rw] key_id
+ # The KMS key that will be used in the verification.
#
- # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ # Enter a key ID of the KMS key that was used to generate the HMAC. If
+ # you identify a different KMS key, the `VerifyMac` operation fails.
+ # @return [String]
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey. To get the alias name and alias ARN, use ListAliases.
+ # @!attribute [rw] mac_algorithm
+ # The MAC algorithm that will be used in the verification. Enter the
+ # same MAC algorithm that was used to compute the HMAC. This algorithm
+ # must be supported by the HMAC KMS key identified by the `KeyId`
+ # parameter.
# @return [String]
#
- # @!attribute [rw] destination_encryption_context
- # Encryption context to use when the data is reencrypted.
- # @return [Hash<String,String>]
+ # @!attribute [rw] mac
+ # The HMAC to verify. Enter the HMAC that was generated by the
+ # GenerateMac operation when you specified the same message, HMAC KMS
+ # key, and MAC algorithm as the values specified in this request.
+ # @return [String]
#
# @!attribute [rw] grant_tokens
# A list of grant tokens.
#
- # For more information, see [Grant Tokens][1] in the *AWS Key
- # Management Service Developer Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
# @return [Array<String>]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest AWS API Documentation
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- class ReEncryptRequest < Struct.new(
- :ciphertext_blob,
- :source_encryption_context,
- :destination_key_id,
- :destination_encryption_context,
- :grant_tokens)
- include Aws::Structure
- end
-
- # @!attribute [rw] ciphertext_blob
- # The reencrypted data. When you use the HTTP API or the AWS CLI, the
- # value is Base64-encoded. Otherwise, it is not encoded.
- # @return [String]
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] source_key_id
- # Unique identifier of the CMK used to originally encrypt the data.
- # @return [String]
#
- # @!attribute [rw] key_id
- # Unique identifier of the CMK used to reencrypt the data.
- # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptResponse AWS API Documentation
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMacRequest AWS API Documentation
#
- class ReEncryptResponse < Struct.new(
- :ciphertext_blob,
- :source_key_id,
- :key_id)
+ class VerifyMacRequest < Struct.new(
+ :message,
+ :key_id,
+ :mac_algorithm,
+ :mac,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = [:message]
include Aws::Structure
end
- # @note When making an API call, you may pass RetireGrantRequest
- # data as a hash:
- #
- # {
- # grant_token: "GrantTokenType",
- # key_id: "KeyIdType",
- # grant_id: "GrantIdType",
- # }
- #
- # @!attribute [rw] grant_token
- # Token that identifies the grant to be retired.
- # @return [String]
- #
# @!attribute [rw] key_id
- # The Amazon Resource Name (ARN) of the CMK associated with the grant.
- #
- # For example:
- # `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # The HMAC KMS key used in the verification.
# @return [String]
#
- # @!attribute [rw] grant_id
- # Unique identifier of the grant to retire. The grant ID is returned
- # in the response to a `CreateGrant` operation.
+ # @!attribute [rw] mac_valid
+ # A Boolean value that indicates whether the HMAC was verified. A
+ # value of `True` indicates that the HMAC (`Mac`) was generated with
+ # the specified `Message`, HMAC KMS key (`KeyID`) and `MacAlgorithm.`.
#
- # * Grant ID Example -
- # 0123456789012345678901234567890123456789012345678901234567890123
+ # If the HMAC is not verified, the `VerifyMac` operation fails with a
+ # `KMSInvalidMacException` exception. This exception indicates that
+ # one or more of the inputs changed since the HMAC was computed.
+ # @return [Boolean]
#
- # ^
+ # @!attribute [rw] mac_algorithm
+ # The MAC algorithm used in the verification.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMacResponse AWS API Documentation
#
- class RetireGrantRequest < Struct.new(
- :grant_token,
+ class VerifyMacResponse < Struct.new(
:key_id,
- :grant_id)
+ :mac_valid,
+ :mac_algorithm)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass RevokeGrantRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # grant_id: "GrantIdType", # required
- # }
- #
# @!attribute [rw] key_id
- # A unique identifier for the customer master key associated with the
- # grant.
+ # Identifies the asymmetric KMS key that will be used to verify the
+ # signature. This must be the same KMS key that was used to generate
+ # the signature. If you specify a different KMS key, the signature
+ # verification fails.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To
- # specify a CMK in a different AWS account, you must use the key ARN.
+ # To specify a KMS key, use its key ID, key ARN, alias name, or alias
+ # ARN. When using an alias name, prefix it with `"alias/"`. To specify
+ # a KMS key in a different Amazon Web Services account, you must use
+ # the key ARN or alias ARN.
#
# For example:
#
@@ -3077,357 +6099,465 @@ module Aws::KMS
# * Key ARN:
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # * Alias name: `alias/ExampleAlias`
+ #
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
+ #
+ # To get the key ID and key ARN for a KMS key, use ListKeys or
+ # DescribeKey. To get the alias name and alias ARN, use ListAliases.
# @return [String]
#
- # @!attribute [rw] grant_id
- # Identifier of the grant to be revoked.
+ # @!attribute [rw] message
+ # Specifies the message that was signed. You can submit a raw message
+ # of up to 4096 bytes, or a hash digest of the message. If you submit
+ # a digest, use the `MessageType` parameter with a value of `DIGEST`.
+ #
+ # If the message specified here is different from the message that was
+ # signed, the signature verification fails. A message and its hash
+ # digest are considered to be the same message.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantRequest AWS API Documentation
+ # @!attribute [rw] message_type
+ # Tells KMS whether the value of the `Message` parameter should be
+ # hashed as part of the signing algorithm. Use `RAW` for unhashed
+ # messages; use `DIGEST` for message digests, which are already
+ # hashed.
#
- class RevokeGrantRequest < Struct.new(
- :key_id,
- :grant_id)
- include Aws::Structure
- end
-
- # @note When making an API call, you may pass ScheduleKeyDeletionRequest
- # data as a hash:
+ # When the value of `MessageType` is `RAW`, KMS uses the standard
+ # signing algorithm, which begins with a hash function. When the value
+ # is `DIGEST`, KMS skips the hashing step in the signing algorithm.
#
- # {
- # key_id: "KeyIdType", # required
- # pending_window_in_days: 1,
- # }
+ # Use the `DIGEST` value only when the value of the `Message`
+ # parameter is a message digest. If you use the `DIGEST` value with an
+ # unhashed message, the security of the verification operation can be
+ # compromised.
#
- # @!attribute [rw] key_id
- # The unique identifier of the customer master key (CMK) to delete.
+ # When the value of `MessageType`is `DIGEST`, the length of the
+ # `Message` value must match the length of hashed messages for the
+ # specified signing algorithm.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # You can submit a message digest and omit the `MessageType` or
+ # specify `RAW` so the digest is hashed again while signing. However,
+ # if the signed message is hashed once while signing, but twice while
+ # verifying, verification fails, even when the message hasn't
+ # changed.
#
- # For example:
+ # The hashing algorithm in that `Verify` uses is based on the
+ # `SigningAlgorithm` value.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * Signing algorithms that end in SHA\_256 use the SHA\_256 hashing
+ # algorithm.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # * Signing algorithms that end in SHA\_384 use the SHA\_384 hashing
+ # algorithm.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
- # @return [String]
+ # * Signing algorithms that end in SHA\_512 use the SHA\_512 hashing
+ # algorithm.
#
- # @!attribute [rw] pending_window_in_days
- # The waiting period, specified in number of days. After the waiting
- # period ends, AWS KMS deletes the customer master key (CMK).
+ # * SM2DSA uses the SM3 hashing algorithm. For details, see [Offline
+ # verification with SM2 key pairs][1].
#
- # This value is optional. If you include a value, it must be between 7
- # and 30, inclusive. If you do not include a value, it defaults to 30.
- # @return [Integer]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionRequest AWS API Documentation
#
- class ScheduleKeyDeletionRequest < Struct.new(
- :key_id,
- :pending_window_in_days)
- include Aws::Structure
- end
-
- # @!attribute [rw] key_id
- # The unique identifier of the customer master key (CMK) for which
- # deletion is scheduled.
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification
# @return [String]
#
- # @!attribute [rw] deletion_date
- # The date and time after which AWS KMS deletes the customer master
- # key (CMK).
- # @return [Time]
+ # @!attribute [rw] signature
+ # The signature that the `Sign` operation generated.
+ # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionResponse AWS API Documentation
+ # @!attribute [rw] signing_algorithm
+ # The signing algorithm that was used to sign the message. If you
+ # submit a different algorithm, the signature verification fails.
+ # @return [String]
#
- class ScheduleKeyDeletionResponse < Struct.new(
- :key_id,
- :deletion_date)
- include Aws::Structure
- end
-
- # A key-value pair. A tag consists of a tag key and a tag value. Tag
- # keys and tag values are both required, but tag values can be empty
- # (null) strings.
+ # @!attribute [rw] grant_tokens
+ # A list of grant tokens.
#
- # For information about the rules that apply to tag keys and tag values,
- # see [User-Defined Tag Restrictions][1] in the *AWS Billing and Cost
- # Management User Guide*.
+ # Use a grant token when your permission to call this operation comes
+ # from a new grant that has not yet achieved *eventual consistency*.
+ # For more information, see [Grant token][1] and [Using a grant
+ # token][2] in the *Key Management Service Developer Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
+ # @return [Array<String>]
#
- # @note When making an API call, you may pass Tag
- # data as a hash:
+ # @!attribute [rw] dry_run
+ # Checks if your request will succeed. `DryRun` is an optional
+ # parameter.
#
- # {
- # tag_key: "TagKeyType", # required
- # tag_value: "TagValueType", # required
- # }
+ # To learn more about how to use this parameter, see [Testing your KMS
+ # API calls][1] in the *Key Management Service Developer Guide*.
#
- # @!attribute [rw] tag_key
- # The key of the tag.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyRequest AWS API Documentation
+ #
+ class VerifyRequest < Struct.new(
+ :key_id,
+ :message,
+ :message_type,
+ :signature,
+ :signing_algorithm,
+ :grant_tokens,
+ :dry_run)
+ SENSITIVE = [:message]
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] key_id
+ # The Amazon Resource Name ([key ARN][1]) of the asymmetric KMS key
+ # that was used to verify the signature.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
# @return [String]
#
- # @!attribute [rw] tag_value
- # The value of the tag.
+ # @!attribute [rw] signature_valid
+ # A Boolean value that indicates whether the signature was verified. A
+ # value of `True` indicates that the `Signature` was produced by
+ # signing the `Message` with the specified `KeyID` and
+ # `SigningAlgorithm.` If the signature is not verified, the `Verify`
+ # operation fails with a `KMSInvalidSignatureException` exception.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] signing_algorithm
+ # The signing algorithm that was used to verify the signature.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Tag AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyResponse AWS API Documentation
#
- class Tag < Struct.new(
- :tag_key,
- :tag_value)
+ class VerifyResponse < Struct.new(
+ :key_id,
+ :signature_valid,
+ :signing_algorithm)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because one or more tags are not valid.
+ # The request was rejected because the (`XksKeyId`) is already
+ # associated with a KMS key in this external key store. Each KMS key in
+ # an external key store must be associated with a different external
+ # key.
#
# @!attribute [rw] message
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyAlreadyInUseException AWS API Documentation
#
- class TagException < Struct.new(
+ class XksKeyAlreadyInUseException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass TagResourceRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # tags: [ # required
- # {
- # tag_key: "TagKeyType", # required
- # tag_value: "TagValueType", # required
- # },
- # ],
- # }
+ # Information about the [external key ][1]that is associated with a KMS
+ # key in an external key store.
#
- # @!attribute [rw] key_id
- # A unique identifier for the CMK you are tagging.
+ # This element appears in a CreateKey or DescribeKey response only for a
+ # KMS key in an external key store.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # The *external key* is a symmetric encryption key that is hosted by an
+ # external key manager outside of Amazon Web Services. When you use the
+ # KMS key in an external key store in a cryptographic operation, the
+ # cryptographic operation is performed in the external key manager using
+ # the specified external key. For more information, see [External
+ # key][1] in the *Key Management Service Developer Guide*.
#
- # For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # @!attribute [rw] id
+ # The ID of the external key in its external key manager. This is the
+ # ID that the external key store proxy uses to identify the external
+ # key.
# @return [String]
#
- # @!attribute [rw] tags
- # One or more tags. Each tag consists of a tag key and a tag value.
- # @return [Array<Types::Tag>]
- #
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResourceRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyConfigurationType AWS API Documentation
#
- class TagResourceRequest < Struct.new(
- :key_id,
- :tags)
+ class XksKeyConfigurationType < Struct.new(
+ :id)
+ SENSITIVE = []
include Aws::Structure
end
- # The request was rejected because a specified parameter is not
- # supported or a specified resource is not valid for this operation.
+ # The request was rejected because the external key specified by the
+ # `XksKeyId` parameter did not meet the configuration requirements for
+ # an external key store.
+ #
+ # The external key must be an AES-256 symmetric key that is enabled and
+ # performs encryption and decryption.
#
# @!attribute [rw] message
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UnsupportedOperationException AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyInvalidConfigurationException AWS API Documentation
#
- class UnsupportedOperationException < Struct.new(
+ class XksKeyInvalidConfigurationException < Struct.new(
:message)
+ SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass UntagResourceRequest
- # data as a hash:
- #
- # {
- # key_id: "KeyIdType", # required
- # tag_keys: ["TagKeyType"], # required
- # }
+ # The request was rejected because the external key store proxy could
+ # not find the external key. This exception is thrown when the value of
+ # the `XksKeyId` parameter doesn't identify a key in the external key
+ # manager associated with the external key proxy.
#
- # @!attribute [rw] key_id
- # A unique identifier for the CMK from which you are removing tags.
+ # Verify that the `XksKeyId` represents an existing key in the external
+ # key manager. Use the key identifier that the external key store proxy
+ # uses to identify the key. For details, see the documentation provided
+ # with your external key store proxy or key manager.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # @!attribute [rw] message
+ # @return [String]
#
- # For example:
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyNotFoundException AWS API Documentation
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ class XksKeyNotFoundException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # KMS uses the authentication credential to sign requests that it sends
+ # to the external key store proxy (XKS proxy) on your behalf. You
+ # establish these credentials on your external key store proxy and
+ # report them to KMS.
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # The `XksProxyAuthenticationCredential` includes two required elements.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # @!attribute [rw] access_key_id
+ # A unique identifier for the raw secret access key.
# @return [String]
#
- # @!attribute [rw] tag_keys
- # One or more tag keys. Specify only the tag keys, not the tag values.
- # @return [Array<String>]
+ # @!attribute [rw] raw_secret_access_key
+ # A secret string of 43-64 characters. Valid characters are a-z, A-Z,
+ # 0-9, /, +, and =.
+ # @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResourceRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyAuthenticationCredentialType AWS API Documentation
#
- class UntagResourceRequest < Struct.new(
- :key_id,
- :tag_keys)
+ class XksProxyAuthenticationCredentialType < Struct.new(
+ :access_key_id,
+ :raw_secret_access_key)
+ SENSITIVE = [:access_key_id, :raw_secret_access_key]
include Aws::Structure
end
- # @note When making an API call, you may pass UpdateAliasRequest
- # data as a hash:
+ # Detailed information about the external key store proxy (XKS proxy).
+ # Your external key store proxy translates KMS requests into a format
+ # that your external key manager can understand. These fields appear in
+ # a DescribeCustomKeyStores response only when the `CustomKeyStoreType`
+ # is `EXTERNAL_KEY_STORE`.
#
- # {
- # alias_name: "AliasNameType", # required
- # target_key_id: "KeyIdType", # required
- # }
- #
- # @!attribute [rw] alias_name
- # Specifies the name of the alias to change. This value must begin
- # with `alias/` followed by the alias name, such as
- # `alias/ExampleAlias`.
+ # @!attribute [rw] connectivity
+ # Indicates whether the external key store proxy uses a public
+ # endpoint or an Amazon VPC endpoint service to communicate with KMS.
# @return [String]
#
- # @!attribute [rw] target_key_id
- # Unique identifier of the customer master key (CMK) to be mapped to
- # the alias. When the update operation completes, the alias will point
- # to this CMK.
+ # @!attribute [rw] access_key_id
+ # The part of the external key store [proxy authentication
+ # credential][1] that uniquely identifies the secret access key.
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
#
- # For example:
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential
+ # @return [String]
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @!attribute [rw] uri_endpoint
+ # The URI endpoint for the external key store proxy.
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ # If the external key store proxy has a public endpoint, it is
+ # displayed here.
#
- # To verify that the alias is mapped to the correct CMK, use
- # ListAliases.
+ # If the external key store proxy uses an Amazon VPC endpoint service
+ # name, this field displays the private DNS name associated with the
+ # VPC endpoint service.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest AWS API Documentation
+ # @!attribute [rw] uri_path
+ # The path to the external key store proxy APIs.
+ # @return [String]
#
- class UpdateAliasRequest < Struct.new(
- :alias_name,
- :target_key_id)
+ # @!attribute [rw] vpc_endpoint_service_name
+ # The Amazon VPC endpoint service used to communicate with the
+ # external key store proxy. This field appears only when the external
+ # key store proxy uses an Amazon VPC endpoint service to communicate
+ # with KMS.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyConfigurationType AWS API Documentation
+ #
+ class XksProxyConfigurationType < Struct.new(
+ :connectivity,
+ :access_key_id,
+ :uri_endpoint,
+ :uri_path,
+ :vpc_endpoint_service_name)
+ SENSITIVE = [:access_key_id]
include Aws::Structure
end
- # @note When making an API call, you may pass UpdateCustomKeyStoreRequest
- # data as a hash:
+ # The request was rejected because the proxy credentials failed to
+ # authenticate to the specified external key store proxy. The specified
+ # external key store proxy rejected a status request from KMS due to
+ # invalid credentials. This can indicate an error in the credentials or
+ # in the identification of the external key store proxy.
#
- # {
- # custom_key_store_id: "CustomKeyStoreIdType", # required
- # new_custom_key_store_name: "CustomKeyStoreNameType",
- # key_store_password: "KeyStorePasswordType",
- # cloud_hsm_cluster_id: "CloudHsmClusterIdType",
- # }
- #
- # @!attribute [rw] custom_key_store_id
- # Identifies the custom key store that you want to update. Enter the
- # ID of the custom key store. To find the ID of a custom key store,
- # use the DescribeCustomKeyStores operation.
+ # @!attribute [rw] message
# @return [String]
#
- # @!attribute [rw] new_custom_key_store_name
- # Changes the friendly name of the custom key store to the value that
- # you specify. The custom key store name must be unique in the AWS
- # account.
- # @return [String]
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyIncorrectAuthenticationCredentialException AWS API Documentation
#
- # @!attribute [rw] key_store_password
- # Enter the current password of the `kmsuser` crypto user (CU) in the
- # AWS CloudHSM cluster that is associated with the custom key store.
+ class XksProxyIncorrectAuthenticationCredentialException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the Amazon VPC endpoint service
+ # configuration does not fulfill the requirements for an external key
+ # store proxy. For details, see the exception message.
#
- # This parameter tells AWS KMS the current password of the `kmsuser`
- # crypto user (CU). It does not set or change the password of any
- # users in the AWS CloudHSM cluster.
+ # @!attribute [rw] message
# @return [String]
#
- # @!attribute [rw] cloud_hsm_cluster_id
- # Associates the custom key store with a related AWS CloudHSM cluster.
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyInvalidConfigurationException AWS API Documentation
#
- # Enter the cluster ID of the cluster that you used to create the
- # custom key store or a cluster that shares a backup history and has
- # the same cluster certificate as the original cluster. You cannot use
- # this parameter to associate a custom key store with an unrelated
- # cluster. In addition, the replacement cluster must [fulfill the
- # requirements][1] for a cluster associated with a custom key store.
- # To view the cluster certificate of a cluster, use the
- # [DescribeClusters][2] operation.
+ class XksProxyInvalidConfigurationException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # KMS cannot interpret the response it received from the external key
+ # store proxy. The problem might be a poorly constructed response, but
+ # it could also be a transient network issue. If you see this error
+ # repeatedly, report it to the proxy vendor.
+ #
+ # @!attribute [rw] message
+ # @return [String]
#
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyInvalidResponseException AWS API Documentation
#
+ class XksProxyInvalidResponseException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the concatenation of the
+ # `XksProxyUriEndpoint` is already associated with an external key store
+ # in the Amazon Web Services account and Region. Each external key store
+ # in an account and Region must use a unique external key store proxy
+ # address.
#
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore
- # [2]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html
+ # @!attribute [rw] message
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriEndpointInUseException AWS API Documentation
#
- class UpdateCustomKeyStoreRequest < Struct.new(
- :custom_key_store_id,
- :new_custom_key_store_name,
- :key_store_password,
- :cloud_hsm_cluster_id)
+ class XksProxyUriEndpointInUseException < Struct.new(
+ :message)
+ SENSITIVE = []
include Aws::Structure
end
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreResponse AWS API Documentation
+ # The request was rejected because the concatenation of the
+ # `XksProxyUriEndpoint` and `XksProxyUriPath` is already associated with
+ # an external key store in the Amazon Web Services account and Region.
+ # Each external key store in an account and Region must use a unique
+ # external key store proxy API address.
#
- class UpdateCustomKeyStoreResponse < Aws::EmptyStructure; end
+ # @!attribute [rw] message
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriInUseException AWS API Documentation
+ #
+ class XksProxyUriInUseException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
- # @note When making an API call, you may pass UpdateKeyDescriptionRequest
- # data as a hash:
+ # KMS was unable to reach the specified `XksProxyUriPath`. The path must
+ # be reachable before you create the external key store or update its
+ # settings.
#
- # {
- # key_id: "KeyIdType", # required
- # description: "DescriptionType", # required
- # }
+ # This exception is also thrown when the external key store proxy
+ # response to a `GetHealthStatus` request indicates that all external
+ # key manager instances are unavailable.
#
- # @!attribute [rw] key_id
- # A unique identifier for the customer master key (CMK).
+ # @!attribute [rw] message
+ # @return [String]
#
- # Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriUnreachableException AWS API Documentation
#
- # For example:
+ class XksProxyUriUnreachableException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the specified Amazon VPC endpoint
+ # service is already associated with an external key store in the Amazon
+ # Web Services account and Region. Each external key store in an Amazon
+ # Web Services account and Region must use a different Amazon VPC
+ # endpoint service.
#
- # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @!attribute [rw] message
+ # @return [String]
#
- # * Key ARN:
- # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceInUseException AWS API Documentation
#
- # To get the key ID and key ARN for a CMK, use ListKeys or
- # DescribeKey.
+ class XksProxyVpcEndpointServiceInUseException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because the Amazon VPC endpoint service
+ # configuration does not fulfill the requirements for an external key
+ # store proxy. For details, see the exception message and [review the
+ # requirements](kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements)
+ # for Amazon VPC endpoint service connectivity for an external key
+ # store.
+ #
+ # @!attribute [rw] message
# @return [String]
#
- # @!attribute [rw] description
- # New description for the CMK.
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceInvalidConfigurationException AWS API Documentation
+ #
+ class XksProxyVpcEndpointServiceInvalidConfigurationException < Struct.new(
+ :message)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The request was rejected because KMS could not find the specified VPC
+ # endpoint service. Use DescribeCustomKeyStores to verify the VPC
+ # endpoint service name for the external key store. Also, confirm that
+ # the `Allow principals` list for the VPC endpoint service includes the
+ # KMS service principal for the Region, such as
+ # `cks.kms.us-east-1.amazonaws.com`.
+ #
+ # @!attribute [rw] message
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescriptionRequest AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceNotFoundException AWS API Documentation
#
- class UpdateKeyDescriptionRequest < Struct.new(
- :key_id,
- :description)
+ class XksProxyVpcEndpointServiceNotFoundException < Struct.new(
+ :message)
+ SENSITIVE = []
include Aws::Structure
end