# 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 # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:kms) module Aws::KMS class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :kms set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::JsonRpc) # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `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::AssumeRoleCredentials` - Used when you need to assume a role. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * 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. # # @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: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @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. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @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] :retry_limit (3) # 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. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) # Disables request parameter conversion, validation, and formatting. # Also disable response data type conversions. This option is useful # when you want to ensure the highest level of performance by # avoiding overhead of walking request parameters and response data # structures. # # When `:simple_json` is enabled, the request parameters hash must # be formatted exactly as the DynamoDB API expects. # # @option options [Boolean] :stub_responses (false) # Causes the client to return stubbed responses. By default # fake responses are generated and returned. You can specify # the response data to return or errors to raise by calling # {ClientStubs#stub_responses}. See {ClientStubs} for more information. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # def initialize(*args) super end # @!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. # # 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*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html # # @option params [required, String] :key_id # The unique identifier for the customer master key (CMK) for which to # cancel deletion. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, 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) # # # The following example cancels deletion of the specified CMK. # # 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. # }) # # 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. # } # # @example Request syntax with placeholder values # # resp = client.cancel_key_deletion({ # key_id: "KeyIdType", # required # }) # # @example Response structure # # resp.key_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion AWS API Documentation # # @overload cancel_key_deletion(params = {}) # @param [Hash] params ({}) def cancel_key_deletion(params = {}, options = {}) req = build_request(:cancel_key_deletion, params) req.send_request(options) end # Creates a display name for a customer master key (CMK). You can use an # alias to identify a CMK in selected operations, such as Encrypt and # GenerateDataKey. # # 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. # # 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. # # An alias must start with the word `alias` followed by a forward slash # (`alias/`). The alias name can contain only alphanumeric characters, # forward slashes (/), underscores (\_), and dashes (-). Alias names # cannot begin with `aws`; that alias name prefix is reserved by Amazon # Web Services (AWS). # # 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. # # To map an existing alias to a different CMK, call UpdateAlias. # # @option params [required, String] :alias_name # String that contains the display name. The name must start with the # word "alias" followed by a forward slash (alias/). Aliases that # begin with "alias/AWS" are reserved. # # @option params [required, String] :target_key_id # Identifies the CMK for which you are creating the alias. This value # cannot be an alias. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # @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). # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.create_alias({ # alias_name: "AliasNameType", # required # target_key_id: "KeyIdType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias AWS API Documentation # # @overload create_alias(params = {}) # @param [Hash] params ({}) def create_alias(params = {}, options = {}) req = build_request(:create_alias, params) req.send_request(options) end # Adds a grant to a customer master key (CMK). The grant specifies who # can use the CMK and under what conditions. When setting permissions, # grants are an alternative to key policies. # # 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 *AWS Key Management Service # Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/grants.html # # @option params [required, String] :key_id # The unique identifier for the customer master key (CMK) that the grant # applies to. # # 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` # # * 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] :grantee_principal # The principal that is given permission to perform the operations that # the grant permits. # # 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*. # # # # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam # # @option params [String] :retiring_principal # The principal that is given permission to retire the grant by using # RetireGrant operation. # # 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*. # # # # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam # # @option params [required, Array] :operations # A list of operations that the grant permits. # # @option params [Types::GrantConstraints] :constraints # A structure that you can use to allow certain operations in the grant # only when the desired encryption context is present. For more # information about encryption context, see [Encryption Context][1] in # the *AWS Key Management Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @option params [String] :name # A friendly name for identifying the grant. Use this value to prevent # unintended creation of duplicate grants when retrying this request. # # When this value is absent, all `CreateGrant` requests result in a new # grant with a unique `GrantId` even if all the supplied parameters are # identical. This can result in unintended duplicates when you retry the # `CreateGrant` request. # # When this value is present, you can retry a `CreateGrant` request 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. # # @return [Types::CreateGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGrantResponse#grant_token #grant_token} => String # * {Types::CreateGrantResponse#grant_id #grant_id} => String # # # @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). # # 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. # operations: [ # "Encrypt", # "Decrypt", # ], # A list of operations that the grant allows. # }) # # resp.to_h outputs the following: # { # grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The unique identifier of the grant. # grant_token: "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA", # The grant token. # } # # @example Request syntax with placeholder values # # resp = client.create_grant({ # 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", # }) # # @example Response structure # # resp.grant_token #=> String # resp.grant_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant AWS API Documentation # # @overload create_grant(params = {}) # @param [Hash] params ({}) def create_grant(params = {}, options = {}) req = build_request(:create_grant, params) req.send_request(options) end # Creates a customer master key (CMK) in the caller's AWS account. # # You can use a CMK to encrypt small amounts of data (4 KiB or less) # directly, but CMKs are more commonly used to encrypt data encryption # keys (DEKs), which are used to encrypt raw data. For more information # about DEKs and the difference between CMKs and DEKs, see the # following: # # * The GenerateDataKey operation # # * [AWS Key Management Service Concepts][1] in the *AWS Key Management # Service Developer Guide* # # You cannot use this operation to create a CMK in a different AWS # account. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.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: # # * 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 *AWS Key Management Service Developer Guide*. # # * 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*. # # 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). # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam # [2]: http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency # [3]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default # # @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 intended use of the CMK. # # You can use CMKs only for symmetric encryption and decryption. # # @option params [String] :origin # The source of the CMK's key material. # # The default is `AWS_KMS`, which means AWS KMS creates the key # material. When this parameter is set to `EXTERNAL`, the request # 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*. # # The CMK's `Origin` is immutable and is set when the CMK is created. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html # # @option params [Boolean] :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 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. # # The default value is false. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam # # @option params [Array] :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. # # 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. # # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata # # # @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. # }) # # 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 # 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" # resp.key_metadata.deletion_date #=> Time # resp.key_metadata.valid_to #=> Time # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL" # 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: # # * GenerateDataKey # # * GenerateDataKeyWithoutPlaintext # # * Encrypt # # Note that if a caller has been granted access permissions to all keys # (through, for example, IAM user policies that grant `Decrypt` # permission on all resources), then ciphertext encrypted by using keys # in other accounts where the key grants access to the caller can be # decrypted. To remedy this, we recommend that you do not grant # `Decrypt` access in an IAM user policy. Instead grant `Decrypt` access # only in key policies. If you must grant `Decrypt` access in an IAM # user policy, you should scope the resource to specific keys or to # specific trusted accounts. # # @option params [required, String, IO] :ciphertext_blob # Ciphertext to be decrypted. The blob includes metadata. # # @option params [Hash] :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]. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @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 # # # @example Example: To decrypt data # # # The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS. # # resp = client.decrypt({ # ciphertext_blob: "", # The encrypted data (ciphertext). # }) # # 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: "", # The decrypted (plaintext) data. # } # # @example Request syntax with placeholder values # # resp = client.decrypt({ # ciphertext_blob: "data", # required # encryption_context: { # "EncryptionContextKey" => "EncryptionContextValue", # }, # grant_tokens: ["GrantTokenType"], # }) # # @example Response structure # # resp.key_id #=> String # resp.plaintext #=> String # # @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. # # 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. # # 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. # # @option params [required, String] :alias_name # The alias to be deleted. The name must start with the word "alias" # followed by a forward slash (alias/). Aliases that begin with # "alias/aws" are reserved. # # @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.delete_alias({ # alias_name: "AliasNameType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias AWS API Documentation # # @overload delete_alias(params = {}) # @param [Hash] params ({}) def delete_alias(params = {}, options = {}) req = build_request(:delete_alias, 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. # # 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`. # # After you delete key material, you can use ImportKeyMaterial to # reimport the same key material into the CMK. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html # # @option params [required, String] :key_id # The identifier of the CMK whose key material to delete. The CMK's # `Origin` must be `EXTERNAL`. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To delete imported key material # # # 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 # # resp = client.delete_imported_key_material({ # key_id: "KeyIdType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial AWS API Documentation # # @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 # Provides detailed information about the specified customer master key # (CMK). # # 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. # # @option params [required, String] :key_id # A unique identifier for the customer master key (CMK). # # 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` # # 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 [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata # # # @example Example: To obtain information about a customer master key (CMK) # # # The following example returns information (metadata) about the specified CMK. # # 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.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 specified CMK. # } # # @example Request syntax with placeholder values # # resp = client.describe_key({ # key_id: "KeyIdType", # required # grant_tokens: ["GrantTokenType"], # }) # # @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" # resp.key_metadata.deletion_date #=> Time # resp.key_metadata.valid_to #=> Time # resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL" # 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/DescribeKey AWS API Documentation # # @overload describe_key(params = {}) # @param [Hash] params ({}) def describe_key(params = {}, options = {}) req = build_request(:describe_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. # # 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*. # # # # [1]: http://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. # # 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 CMK, use ListKeys or DescribeKey. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @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. # }) # # @example Request syntax with placeholder values # # resp = client.disable_key({ # key_id: "KeyIdType", # required # }) # # @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 for the specified # customer master key (CMK). You cannot perform this operation on a CMK # in a different AWS account. # # @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. # # 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 CMK, use ListKeys or DescribeKey. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To disable automatic rotation of key material # # # The following example disables automatic annual rotation of the key material for the specified CMK. # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.disable_key_rotation({ # key_id: "KeyIdType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation AWS API Documentation # # @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 # Sets the state of a customer master key (CMK) to enabled, thereby # permitting its use for cryptographic operations. You cannot perform # this operation on a CMK in a different AWS account. # # @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. # # 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 CMK, use ListKeys or DescribeKey. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To enable a customer master key (CMK) # # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.enable_key({ # key_id: "KeyIdType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey AWS API Documentation # # @overload enable_key(params = {}) # @param [Hash] params ({}) def enable_key(params = {}, options = {}) req = build_request(:enable_key, params) req.send_request(options) end # Enables automatic rotation of the key material for the specified # customer master key (CMK). You cannot perform this operation on a CMK # in a different AWS account. # # @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. # # 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 CMK, use ListKeys or DescribeKey. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To enable automatic rotation of key material # # # The following example enables automatic annual rotation of the key material for the specified CMK. # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.enable_key_rotation({ # key_id: "KeyIdType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation AWS API Documentation # # @overload enable_key_rotation(params = {}) # @param [Hash] params ({}) def enable_key_rotation(params = {}, options = {}) req = build_request(:enable_key_rotation, 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: # # * You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data # such as an RSA key, a database password, or other sensitive # information. # # * To move encrypted data from one AWS region to another, you can use # this operation to encrypt in the new region the plaintext data key # that was used to encrypt the data in the original region. This # provides you with an encrypted copy of the data key that can be # decrypted in the new region and used there to decrypt the encrypted # data. # # 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. # # Unless you are moving encrypted data from one region to another, you # don't use this operation to encrypt a generated data key within a # region. To get data keys that are already encrypted, call the # GenerateDataKey or GenerateDataKeyWithoutPlaintext operation. Data # keys don't need to be encrypted again by calling `Encrypt`. # # To encrypt data locally in your application, use the GenerateDataKey # operation to return a plaintext data encryption key and a copy of the # key encrypted under the CMK of your choosing. # # @option params [required, String] :key_id # A unique identifier for the customer master key (CMK). # # 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` # # 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 [required, String, IO] :plaintext # Data to be encrypted. # # @option params [Hash] :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]. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @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 # # # @example Example: To encrypt data # # # The following example encrypts data with the specified customer master key (CMK). # # 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: "", # The data to encrypt. # }) # # resp.to_h outputs the following: # { # ciphertext_blob: "", # 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. # } # # @example Request syntax with placeholder values # # resp = client.encrypt({ # key_id: "KeyIdType", # required # plaintext: "data", # required # encryption_context: { # "EncryptionContextKey" => "EncryptionContextValue", # }, # grant_tokens: ["GrantTokenType"], # }) # # @example Response structure # # resp.ciphertext_blob #=> String # resp.key_id #=> String # # @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 data encryption key that you can use in your application to # encrypt data locally. # # You must specify the customer master key (CMK) under which to generate # the data key. You must also specify the length of the data key using # either the `KeySpec` or `NumberOfBytes` field. You must specify one # field or the other, 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. # # This operation returns a plaintext copy of the data key in the # `Plaintext` field of the response, and an encrypted copy of the data # key in the `CiphertextBlob` field. The data key is encrypted under the # CMK specified in the `KeyId` field of the request. # # We recommend that you use the following pattern to encrypt data # locally in your application: # # 1. Use this operation (`GenerateDataKey`) to get a data encryption # key. # # 2. Use the plaintext data encryption key (returned in the `Plaintext` # field of the response) to encrypt data locally, then erase the # plaintext data key from memory. # # 3. Store the encrypted data key (returned in the `CiphertextBlob` # field of the response) alongside the locally encrypted data. # # To decrypt data locally: # # 1. Use the Decrypt operation to decrypt the encrypted data key into a # plaintext copy of the data key. # # 2. Use the plaintext data key to decrypt data locally, then erase the # plaintext data key from memory. # # To return only an encrypted copy of the data key, use # GenerateDataKeyWithoutPlaintext. To return a random byte string that # is cryptographically secure, use GenerateRandom. # # If you use the optional `EncryptionContext` field, you must store at # least enough information to be able to reconstruct the full encryption # context when you later send the ciphertext to the Decrypt operation. # It is a good practice to choose an encryption context that you can # reconstruct on the fly to better secure the ciphertext. For more # information, see [Encryption Context][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [required, String] :key_id # The identifier of the CMK under which to generate and encrypt the data # encryption 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` # # 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] :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*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [Integer] :number_of_bytes # The length of the data encryption 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 encryption key. Use `AES_128` to generate a # 128-bit symmetric key, or `AES_256` to generate a 256-bit symmetric # key. # # @option params [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @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 # # # @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 customer master key (CMK). # # 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.to_h outputs the following: # { # ciphertext_blob: "", # 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: "", # 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 # Returns a data encryption key encrypted under a customer master key # (CMK). This operation is identical to GenerateDataKey but returns only # the encrypted copy of the data key. # # 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. # # This operation is useful in a system that has multiple components with # different degrees of trust. For example, consider a system that stores # encrypted data in containers. Each container stores the encrypted data # and an encrypted copy of the data key. One component of the system, # called the *control plane*, creates new containers. When it creates a # new container, it uses this operation # (`GenerateDataKeyWithoutPlaintext`) to get an encrypted data key and # then stores it in the container. Later, a different component of the # system, called the *data plane*, puts encrypted data into the # containers. To do this, it passes the encrypted data key to the # Decrypt operation, then uses the returned plaintext data key to # encrypt data, and finally stores the encrypted data in the container. # In this system, the control plane never sees the plaintext data key. # # @option params [required, String] :key_id # The identifier of the customer master key (CMK) under which to # generate and encrypt the data encryption 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` # # 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] :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*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html # # @option params [String] :key_spec # The length of the data encryption 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 encryption 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] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @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 customer master key (CMK). # # 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.to_h outputs the following: # { # ciphertext_blob: "", # 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. # } # # @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"], # }) # # @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 # Returns a random byte string that is cryptographically secure. # # For more information about entropy and random number generation, see # the [AWS Key Management Service Cryptographic Details][1] whitepaper. # # # # [1]: https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf # # @option params [Integer] :number_of_bytes # The length of the byte string. # # @return [Types::GenerateRandomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GenerateRandomResponse#plaintext #plaintext} => String # # # @example Example: To generate random data # # # The following example uses AWS KMS to generate 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: "", # The random data. # } # # @example Request syntax with placeholder values # # resp = client.generate_random({ # number_of_bytes: 1, # }) # # @example Response structure # # resp.plaintext #=> 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 customer master key (CMK). # You cannot perform this operation on a CMK in a different AWS account. # # @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. # # 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 CMK, 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 customer master key (CMK). # # 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. # }) # # 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 is enabled for the specified customer master key (CMK). # # 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 [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. To # specify a CMK in a different AWS 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 CMK, 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 customer master key (CMK) # # # The following example retrieves the status of automatic annual rotation of the key material for the specified CMK. # # 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.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 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*. # # 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. # # 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. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.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`. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 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*. # # # # [1]: http://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 # # # @example Example: To retrieve the public key and import token for a customer master key (CMK) # # # The following example retrieves the public key and import token for the specified CMK. # # 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.to_h outputs the following: # { # import_token: "", # 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: "", # 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 # 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 # # @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 # 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: # # * The key ID or key ARN of a CMK with no key material. Its `Origin` # must be `EXTERNAL`. # # 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 encrypted key material. To get the public key to encrypt the key # material, call GetParametersForImport. # # * 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. # # * 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. # # When this operation is successful, the CMK's key state 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. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.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`. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 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. # # @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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To import key material into a customer master key (CMK) # # # The following example imports key material into the specified CMK. # # resp = client.import_key_material({ # encrypted_key_material: "", # The encrypted key material to import. # expiration_model: "KEY_MATERIAL_DOES_NOT_EXPIRE", # A value that specifies whether the key material expires. # import_token: "", # 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. # }) # # @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 all aliases in the caller's AWS account and region. # You cannot list aliases in other accounts. For more information about # aliases, see CreateAlias. # # The response might include several aliases that do not have a # `TargetKeyId` field because they are not associated with a CMK. These # are predefined aliases that are reserved for CMKs managed by AWS # services. If an alias is not associated with a CMK, the alias does not # count against the [alias limit][1] for your account. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit # # @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. # # @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 # # # @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 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. # } # # @example Request syntax with placeholder values # # resp = client.list_aliases({ # 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.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 customer master key (CMK). # # 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 [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. # # @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. To # specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. # # @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 # # # @example Example: To list grants for a customer master key (CMK) # # # The following example lists grants for the specified CMK. # # 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. # }) # # 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 # }) # # @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 # # @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 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. # # @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. # # 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 CMK, 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. # # 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. # # Currently only 1 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 # # # @example Example: To list key policies for a customer master key (CMK) # # # The following example lists key policies for the specified CMK. # # 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. # }) # # 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 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. # # 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 # # # @example Example: To list customer master keys (CMKs) # # # The following example lists CMKs. # # 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 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. # } # # @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 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. # # @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. # # 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 CMK, 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. # # 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 # # # @example Example: To list tags for a customer master key (CMK) # # # The following example lists tags for a CMK. # # 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. # }) # # 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 a list of all grants for which the grant's # `RetiringPrincipal` matches the one specified. # # A typical use is to list all grants that you are able to retire. To # retire a grant, use RetireGrant. # # @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. # # @option params [required, String] :retiring_principal # The retiring principal for which to list grants. # # 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*. # # # # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam # # @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 # # # @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 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 # # 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", "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 # # @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. # # For more information about key policies, see [Key Policies][1] in the # *AWS Key Management Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.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. # # 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 CMK, 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 CMK. # # The key policy must meet the following criteria: # # * 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*. # # * 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*. # # The key policy size limit is 32 kilobytes (32768 bytes). # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam # [2]: http://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. # # 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. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To attach a key policy to a customer master key (CMK) # # # The following example attaches a key policy to the specified CMK. # # 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. # }) # # @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 # 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. # # You can reencrypt data using CMKs in different AWS accounts. # # 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. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html # # @option params [required, String, IO] :ciphertext_blob # Ciphertext of the data to reencrypt. # # @option params [Hash] :source_encryption_context # Encryption context used to encrypt and decrypt the data specified in # the `CiphertextBlob` parameter. # # @option params [required, String] :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` # # * 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] :destination_encryption_context # Encryption context to use when the data is reencrypted. # # @option params [Array] :grant_tokens # A list of grant tokens. # # For more information, see [Grant Tokens][1] in the *AWS Key Management # Service Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token # # @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 # # # @example Example: To reencrypt data # # # The following example reencrypts data with the specified CMK. # # resp = client.re_encrypt({ # ciphertext_blob: "", # 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. # }) # # resp.to_h outputs the following: # { # ciphertext_blob: "", # 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. # } # # @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"], # }) # # @example Response structure # # resp.ciphertext_blob #=> String # resp.source_key_id #=> String # resp.key_id #=> String # # @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 # 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: # # * The AWS account (root user) under which the grant was created # # * The `RetiringPrincipal`, if present in the grant # # * The `GranteePrincipal`, if `RetireGrant` is an operation specified # in the grant # # 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. # # For example: # `arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab` # # @option params [String] :grant_id # Unique identifier of the grant to retire. The grant ID is returned in # the response to a `CreateGrant` operation. # # * Grant ID Example - # 0123456789012345678901234567890123456789012345678901234567890123 # # ^ # # @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 customer master key (CMK) associated with the grant. # }) # # @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 # # @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. # # 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 [required, String] :key_id # A unique identifier for the customer master key associated with the # grant. # # 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` # # * 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] :grant_id # Identifier of the grant to be revoked. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To revoke a grant # # # 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 customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK. # }) # # @example Request syntax with placeholder values # # resp = client.revoke_grant({ # key_id: "KeyIdType", # required # grant_id: "GrantIdType", # required # }) # # @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 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 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. # # You cannot perform this operation on a CMK in a different AWS account. # # Deleting a CMK is a destructive and potentially dangerous operation. # When a CMK is deleted, all data that was encrypted under the CMK is # rendered unrecoverable. To restrict the use of a CMK without deleting # it, use DisableKey. # # For more information about scheduling a CMK for deletion, see # [Deleting Customer Master Keys][1] in the *AWS Key Management Service # Developer Guide*. # # # # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html # # @option params [required, String] :key_id # The unique identifier of the customer master key (CMK) to delete. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # @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 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 [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 # # # @example Example: To schedule a customer master key (CMK) for deletion # # # The following example schedules the specified CMK for deletion. # # 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.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 # # resp = client.schedule_key_deletion({ # key_id: "KeyIdType", # required # pending_window_in_days: 1, # }) # # @example Response structure # # resp.key_id #=> String # resp.deletion_date #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion AWS API Documentation # # @overload schedule_key_deletion(params = {}) # @param [Hash] params ({}) def schedule_key_deletion(params = {}, options = {}) req = build_request(:schedule_key_deletion, params) req.send_request(options) end # Adds or overwrites one or more tags for the specified customer master # key (CMK). You cannot perform this operation on a CMK in a different # AWS account. # # 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. # # You cannot use the same tag key more than once per CMK. For example, # consider a CMK with one tag whose tag key is `Purpose` and tag value # is `Test`. If you send a `TagResource` request for this CMK with a tag # key of `Purpose` and a tag value of `Prod`, it does not create a # second tag. Instead, the original tag is overwritten with the new tag # value. # # 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*. # # # # [1]: http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html # # @option params [required, String] :key_id # A unique identifier for the CMK you are tagging. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # @option params [required, Array] :tags # One or more tags. Each tag consists of a tag key and a tag value. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To tag a customer master key (CMK) # # # The following example tags a CMK. # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # key_id: "KeyIdType", # required # tags: [ # required # { # tag_key: "TagKeyType", # required # tag_value: "TagValueType", # required # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes the specified tag or tags from the specified customer master # key (CMK). You cannot perform this operation on a CMK in a different # AWS account. # # To remove a tag, you specify the tag key for each tag to remove. You # do not specify the tag value. To overwrite the tag value for an # existing tag, use TagResource. # # @option params [required, String] :key_id # A unique identifier for the CMK from which you are removing tags. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # @option params [required, Array] :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 remove tags from a customer master key (CMK) # # # The following example removes tags from a CMK. # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # key_id: "KeyIdType", # required # tag_keys: ["TagKeyType"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, 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. # # 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. # # An alias name can contain only alphanumeric characters, forward # slashes (/), underscores (\_), and dashes (-). An alias must start # with the word `alias` followed by a forward slash (`alias/`). The # alias name can contain only alphanumeric characters, forward slashes # (/), underscores (\_), and dashes (-). Alias names cannot begin with # `aws`; that alias name prefix is reserved by Amazon Web Services # (AWS). # # @option params [required, String] :alias_name # String that contains the name of the alias to be modified. The name # must start with the word "alias" followed by a forward slash # (alias/). Aliases that begin with "alias/aws" are reserved. # # @option params [required, String] :target_key_id # Unique identifier of the customer master key to be mapped to the # alias. # # Specify the key ID or the Amazon Resource Name (ARN) of the CMK. # # 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 CMK, use ListKeys or DescribeKey. # # To verify that the alias is mapped to the correct CMK, use # ListAliases. # # @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 customer master key (CMK). # # 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. # }) # # @example Request syntax with placeholder values # # 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/UpdateAlias AWS API Documentation # # @overload update_alias(params = {}) # @param [Hash] params ({}) def update_alias(params = {}, options = {}) req = build_request(:update_alias, params) req.send_request(options) end # Updates the description of a customer master key (CMK). To see the # decription of a CMK, use DescribeKey. # # You cannot perform this operation on a CMK in a different AWS account. # # @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. # # 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 CMK, use ListKeys or DescribeKey. # # @option params [required, String] :description # New description for the CMK. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # # @example Example: To update the description of a customer master key (CMK) # # # The following example updates the description of the specified CMK. # # 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. # }) # # @example Request syntax with placeholder values # # resp = client.update_key_description({ # key_id: "KeyIdType", # required # description: "DescriptionType", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription AWS API Documentation # # @overload update_key_description(params = {}) # @param [Hash] params ({}) def update_key_description(params = {}, options = {}) req = build_request(:update_key_description, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-kms' context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end