Class: Aws::KMS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KMS::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-kms/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#cancel_key_deletion(params = {}) ⇒ Types::CancelKeyDeletionResponse
Cancels the deletion of a customer master key (CMK).
-
#create_alias(params = {}) ⇒ Struct
Creates a display name for a customer-managed customer master key (CMK).
-
#create_grant(params = {}) ⇒ Types::CreateGrantResponse
Adds a grant to a customer master key (CMK).
-
#create_key(params = {}) ⇒ Types::CreateKeyResponse
Creates a customer master key (CMK) in the caller’s AWS account.
-
#decrypt(params = {}) ⇒ Types::DecryptResponse
Decrypts ciphertext.
-
#delete_alias(params = {}) ⇒ Struct
Deletes the specified alias.
-
#delete_imported_key_material(params = {}) ⇒ Struct
Deletes key material that you previously imported.
-
#describe_key(params = {}) ⇒ Types::DescribeKeyResponse
Provides detailed information about the specified customer master key (CMK).
-
#disable_key(params = {}) ⇒ Struct
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.
-
#disable_key_rotation(params = {}) ⇒ Struct
Disables [automatic rotation of the key material] for the specified customer master key (CMK).
-
#enable_key(params = {}) ⇒ Struct
Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations.
-
#enable_key_rotation(params = {}) ⇒ Struct
Enables [automatic rotation of the key material] for the specified customer master key (CMK).
-
#encrypt(params = {}) ⇒ Types::EncryptResponse
Encrypts plaintext into ciphertext by using a customer master key (CMK).
-
#generate_data_key(params = {}) ⇒ Types::GenerateDataKeyResponse
Returns a data encryption key that you can use in your application to encrypt data locally.
-
#generate_data_key_without_plaintext(params = {}) ⇒ Types::GenerateDataKeyWithoutPlaintextResponse
Returns a data encryption key encrypted under a customer master key (CMK).
-
#generate_random(params = {}) ⇒ Types::GenerateRandomResponse
Returns a random byte string that is cryptographically secure.
-
#get_key_policy(params = {}) ⇒ Types::GetKeyPolicyResponse
Gets a key policy attached to the specified customer master key (CMK).
-
#get_key_rotation_status(params = {}) ⇒ Types::GetKeyRotationStatusResponse
Gets a Boolean value that indicates whether [automatic rotation of the key material] is enabled for the specified customer master key (CMK).
-
#get_parameters_for_import(params = {}) ⇒ Types::GetParametersForImportResponse
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure.
-
#import_key_material(params = {}) ⇒ Struct
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
-
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Gets a list of aliases in the caller’s AWS account and region.
-
#list_grants(params = {}) ⇒ Types::ListGrantsResponse
Gets a list of all grants for the specified customer master key (CMK).
-
#list_key_policies(params = {}) ⇒ Types::ListKeyPoliciesResponse
Gets the names of the key policies that are attached to a customer master key (CMK).
-
#list_keys(params = {}) ⇒ Types::ListKeysResponse
Gets a list of all customer master keys (CMKs) in the caller’s AWS account and region.
-
#list_resource_tags(params = {}) ⇒ Types::ListResourceTagsResponse
Returns a list of all tags for the specified customer master key (CMK).
-
#list_retirable_grants(params = {}) ⇒ Types::ListGrantsResponse
Returns a list of all grants for which the grant’s ‘RetiringPrincipal` matches the one specified.
-
#put_key_policy(params = {}) ⇒ Struct
Attaches a key policy to the specified customer master key (CMK).
-
#re_encrypt(params = {}) ⇒ Types::ReEncryptResponse
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side.
-
#retire_grant(params = {}) ⇒ Struct
Retires a grant.
-
#revoke_grant(params = {}) ⇒ Struct
Revokes the specified grant for the specified customer master key (CMK).
-
#schedule_key_deletion(params = {}) ⇒ Types::ScheduleKeyDeletionResponse
Schedules the deletion of a customer master key (CMK).
-
#tag_resource(params = {}) ⇒ Struct
Adds or edits tags for a customer master key (CMK).
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified customer master key (CMK).
-
#update_alias(params = {}) ⇒ Struct
Associates an existing alias with a different customer master key (CMK).
-
#update_key_description(params = {}) ⇒ Struct
Updates the description of a customer master key (CMK).
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(*args) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client.
163 164 165 |
# File 'lib/aws-sdk-kms/client.rb', line 163 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3427 3428 3429 |
# File 'lib/aws-sdk-kms/client.rb', line 3427 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3430 3431 3432 |
# File 'lib/aws-sdk-kms/client.rb', line 3430 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 |
# File 'lib/aws-sdk-kms/client.rb', line 3405 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.7.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_key_deletion(params = {}) ⇒ Types::CancelKeyDeletionResponse
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] in the *AWS Key Management Service Developer Guide*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
234 235 236 237 |
# File 'lib/aws-sdk-kms/client.rb', line 234 def cancel_key_deletion(params = {}, = {}) req = build_request(:cancel_key_deletion, params) req.send_request() end |
#create_alias(params = {}) ⇒ Struct
Creates a display name for a customer-managed customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
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.
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 for AWS managed CMKs.
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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
316 317 318 319 |
# File 'lib/aws-sdk-kms/client.rb', line 316 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_grant(params = {}) ⇒ Types::CreateGrantResponse
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] in the *AWS Key Management Service Developer Guide*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
481 482 483 484 |
# File 'lib/aws-sdk-kms/client.rb', line 481 def create_grant(params = {}, = {}) req = build_request(:create_grant, params) req.send_request() end |
#create_key(params = {}) ⇒ Types::CreateKeyResponse
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]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html
667 668 669 670 |
# File 'lib/aws-sdk-kms/client.rb', line 667 def create_key(params = {}, = {}) req = build_request(:create_key, params) req.send_request() end |
#decrypt(params = {}) ⇒ Types::DecryptResponse
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
-
GenerateDataKey
-
GenerateDataKeyWithoutPlaintext
-
Encrypt
Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for ‘Decrypt` permissions, limit the user to particular CMKs or particular trusted accounts.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
759 760 761 762 |
# File 'lib/aws-sdk-kms/client.rb', line 759 def decrypt(params = {}, = {}) req = build_request(:decrypt, params) req.send_request() end |
#delete_alias(params = {}) ⇒ Struct
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.
803 804 805 806 |
# File 'lib/aws-sdk-kms/client.rb', line 803 def delete_alias(params = {}, = {}) req = build_request(:delete_alias, params) req.send_request() end |
#delete_imported_key_material(params = {}) ⇒ Struct
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] 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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
866 867 868 869 |
# File 'lib/aws-sdk-kms/client.rb', line 866 def delete_imported_key_material(params = {}, = {}) req = build_request(:delete_imported_key_material, params) req.send_request() end |
#describe_key(params = {}) ⇒ Types::DescribeKeyResponse
Provides detailed information about the specified customer master key (CMK).
You can use ‘DescribeKey` on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS KMS associates the alias with an [AWS managed CMK] and returns its `KeyId` and `Arn` in the response.
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.
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
982 983 984 985 |
# File 'lib/aws-sdk-kms/client.rb', line 982 def describe_key(params = {}, = {}) req = build_request(:describe_key, params) req.send_request() end |
#disable_key(params = {}) ⇒ Struct
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*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1038 1039 1040 1041 |
# File 'lib/aws-sdk-kms/client.rb', line 1038 def disable_key(params = {}, = {}) req = build_request(:disable_key, params) req.send_request() end |
#disable_key_rotation(params = {}) ⇒ Struct
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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1091 1092 1093 1094 |
# File 'lib/aws-sdk-kms/client.rb', line 1091 def disable_key_rotation(params = {}, = {}) req = build_request(:disable_key_rotation, params) req.send_request() end |
#enable_key(params = {}) ⇒ Struct
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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1143 1144 1145 1146 |
# File 'lib/aws-sdk-kms/client.rb', line 1143 def enable_key(params = {}, = {}) req = build_request(:enable_key, params) req.send_request() end |
#enable_key_rotation(params = {}) ⇒ Struct
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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1196 1197 1198 1199 |
# File 'lib/aws-sdk-kms/client.rb', line 1196 def enable_key_rotation(params = {}, = {}) req = build_request(:enable_key_rotation, params) req.send_request() end |
#encrypt(params = {}) ⇒ Types::EncryptResponse
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.
-
You can use the ‘Encrypt` operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the `Encrypt` method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary.
You don’t need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key.
Also, you don’t need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the ‘GenerateDataKey` operation returns.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1320 1321 1322 1323 |
# File 'lib/aws-sdk-kms/client.rb', line 1320 def encrypt(params = {}, = {}) req = build_request(:encrypt, params) req.send_request() end |
#generate_data_key(params = {}) ⇒ Types::GenerateDataKeyResponse
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:
-
Use this operation (‘GenerateDataKey`) to get a data encryption key.
-
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.
-
Store the encrypted data key (returned in the ‘CiphertextBlob` field of the response) alongside the locally encrypted data.
To decrypt data locally:
-
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
-
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] in the *AWS Key Management Service Developer Guide*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1484 1485 1486 1487 |
# File 'lib/aws-sdk-kms/client.rb', line 1484 def generate_data_key(params = {}, = {}) req = build_request(:generate_data_key, params) req.send_request() end |
#generate_data_key_without_plaintext(params = {}) ⇒ Types::GenerateDataKeyWithoutPlaintextResponse
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. It 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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1616 1617 1618 1619 |
# File 'lib/aws-sdk-kms/client.rb', line 1616 def generate_data_key_without_plaintext(params = {}, = {}) req = build_request(:generate_data_key_without_plaintext, params) req.send_request() end |
#generate_random(params = {}) ⇒ Types::GenerateRandomResponse
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] whitepaper.
[1]: d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf
1665 1666 1667 1668 |
# File 'lib/aws-sdk-kms/client.rb', line 1665 def generate_random(params = {}, = {}) req = build_request(:generate_random, params) req.send_request() end |
#get_key_policy(params = {}) ⇒ Types::GetKeyPolicyResponse
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.
1725 1726 1727 1728 |
# File 'lib/aws-sdk-kms/client.rb', line 1725 def get_key_policy(params = {}, = {}) req = build_request(:get_key_policy, params) req.send_request() end |
#get_key_rotation_status(params = {}) ⇒ Types::GetKeyRotationStatusResponse
Gets a Boolean value that indicates whether [automatic rotation of the key material] is enabled for the specified customer master key (CMK).
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
-
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
-
Pending deletion: While a CMK is pending deletion, its key rotation status is ‘false` and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the ‘KeyId` parameter.
[1]: docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1802 1803 1804 1805 |
# File 'lib/aws-sdk-kms/client.rb', line 1802 def get_key_rotation_status(params = {}, = {}) req = build_request(:get_key_rotation_status, params) req.send_request() end |
#get_parameters_for_import(params = {}) ⇒ Types::GetParametersForImportResponse
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] 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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1909 1910 1911 1912 |
# File 'lib/aws-sdk-kms/client.rb', line 1909 def get_parameters_for_import(params = {}, = {}) req = build_request(:get_parameters_for_import, params) req.send_request() end |
#import_key_material(params = {}) ⇒ Struct
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] 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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
2031 2032 2033 2034 |
# File 'lib/aws-sdk-kms/client.rb', line 2031 def import_key_material(params = {}, = {}) req = build_request(:import_key_material, params) req.send_request() end |
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Gets a list of aliases in the caller’s AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the ‘KeyId` parameter.
The ‘ListAliases` response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format `aws/<service-name>`, such as `aws/dynamodb`.
The response might also include aliases that have no ‘TargetKeyId` field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your [AWS KMS aliases limit].
[1]: docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit
2164 2165 2166 2167 |
# File 'lib/aws-sdk-kms/client.rb', line 2164 def list_aliases(params = {}, = {}) req = build_request(:list_aliases, params) req.send_request() end |
#list_grants(params = {}) ⇒ Types::ListGrantsResponse
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.
2306 2307 2308 2309 |
# File 'lib/aws-sdk-kms/client.rb', line 2306 def list_grants(params = {}, = {}) req = build_request(:list_grants, params) req.send_request() end |
#list_key_policies(params = {}) ⇒ Types::ListKeyPoliciesResponse
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.
2389 2390 2391 2392 |
# File 'lib/aws-sdk-kms/client.rb', line 2389 def list_key_policies(params = {}, = {}) req = build_request(:list_key_policies, params) req.send_request() end |
#list_keys(params = {}) ⇒ Types::ListKeysResponse
Gets a list of all customer master keys (CMKs) in the caller’s AWS account and region.
2479 2480 2481 2482 |
# File 'lib/aws-sdk-kms/client.rb', line 2479 def list_keys(params = {}, = {}) req = build_request(:list_keys, params) req.send_request() end |
#list_resource_tags(params = {}) ⇒ Types::ListResourceTagsResponse
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.
2573 2574 2575 2576 |
# File 'lib/aws-sdk-kms/client.rb', line 2573 def (params = {}, = {}) req = build_request(:list_resource_tags, params) req.send_request() end |
#list_retirable_grants(params = {}) ⇒ Types::ListGrantsResponse
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.
2677 2678 2679 2680 |
# File 'lib/aws-sdk-kms/client.rb', line 2677 def list_retirable_grants(params = {}, = {}) req = build_request(:list_retirable_grants, params) req.send_request() end |
#put_key_policy(params = {}) ⇒ Struct
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] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
2785 2786 2787 2788 |
# File 'lib/aws-sdk-kms/client.rb', line 2785 def put_key_policy(params = {}, = {}) req = build_request(:put_key_policy, params) req.send_request() end |
#re_encrypt(params = {}) ⇒ Types::ReEncryptResponse
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] 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.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
2904 2905 2906 2907 |
# File 'lib/aws-sdk-kms/client.rb', line 2904 def re_encrypt(params = {}, = {}) req = build_request(:re_encrypt, params) req.send_request() end |
#retire_grant(params = {}) ⇒ Struct
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.
2969 2970 2971 2972 |
# File 'lib/aws-sdk-kms/client.rb', line 2969 def retire_grant(params = {}, = {}) req = build_request(:retire_grant, params) req.send_request() end |
#revoke_grant(params = {}) ⇒ Struct
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.
3023 3024 3025 3026 |
# File 'lib/aws-sdk-kms/client.rb', line 3023 def revoke_grant(params = {}, = {}) req = build_request(:revoke_grant, params) req.send_request() end |
#schedule_key_deletion(params = {}) ⇒ Types::ScheduleKeyDeletionResponse
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*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
3115 3116 3117 3118 |
# File 'lib/aws-sdk-kms/client.rb', line 3115 def schedule_key_deletion(params = {}, = {}) req = build_request(:schedule_key_deletion, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or edits tags for a 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 can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.
For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions] in the *AWS Billing and Cost Management User Guide*.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html [2]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
3193 3194 3195 3196 |
# File 'lib/aws-sdk-kms/client.rb', line 3193 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified 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, specify the tag key. To change the tag value of an existing tag key, use TagResource.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
3256 3257 3258 3259 |
# File 'lib/aws-sdk-kms/client.rb', line 3256 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_alias(params = {}) ⇒ Struct
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).
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
3338 3339 3340 3341 |
# File 'lib/aws-sdk-kms/client.rb', line 3338 def update_alias(params = {}, = {}) req = build_request(:update_alias, params) req.send_request() end |
#update_key_description(params = {}) ⇒ Struct
Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see [How Key State Affects Use of a Customer Master Key] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
3396 3397 3398 3399 |
# File 'lib/aws-sdk-kms/client.rb', line 3396 def update_key_description(params = {}, = {}) req = build_request(:update_key_description, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3420 3421 3422 |
# File 'lib/aws-sdk-kms/client.rb', line 3420 def waiter_names [] end |