CreateAlias(AliasName => Str, TargetKeyId => Str)

Returns: nothing

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. 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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

To associate an alias with a different key, call UpdateAlias.

Note that you cannot create or update an alias that represents a key in another account.

CreateGrant(GranteePrincipal => Str, KeyId => Str, [Constraints => Paws::KMS::GrantConstraints, GrantTokens => ArrayRef[Str], Operations => ArrayRef[Str], RetiringPrincipal => Str])

Returns: a Paws::KMS::CreateGrantResponse instance

Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the developer guide. If a grant is absent, access to the key is evaluated based on IAM policies attached to the user.

1. ListGrants

2. RetireGrant

3. RevokeGrant

CreateKey([Description => Str, KeyUsage => Str, Policy => Str])

Returns: a Paws::KMS::CreateKeyResponse instance

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

Decrypt(CiphertextBlob => Str, [EncryptionContext => Paws::KMS::EncryptionContextType, GrantTokens => ArrayRef[Str]])

Returns: a Paws::KMS::DecryptResponse instance

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

• 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.

DeleteAlias(AliasName => Str)

Returns: nothing

Deletes the specified alias. To associate an alias with a different key, call UpdateAlias.

DescribeKey(KeyId => Str)

Returns: a Paws::KMS::DescribeKeyResponse instance

Provides detailed information about the specified customer master key.

DisableKey(KeyId => Str)

Returns: nothing

Marks a key as disabled, thereby preventing its use.

DisableKeyRotation(KeyId => Str)

Returns: nothing

Disables rotation of the specified key.

EnableKey(KeyId => Str)

Returns: nothing

Marks a key as enabled, thereby permitting its use. You can have up to 25 enabled keys at one time.

EnableKeyRotation(KeyId => Str)

Returns: nothing

Enables rotation of the specified customer master key.

Encrypt(KeyId => Str, Plaintext => Str, [EncryptionContext => Paws::KMS::EncryptionContextType, GrantTokens => ArrayRef[Str]])

Returns: a Paws::KMS::EncryptResponse instance

Encrypts plaintext into ciphertext by using a customer master key. The "Encrypt" function has two primary use cases:

• You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
• If you are moving encrypted data from one region to another, you can use this API 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.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling "Encrypt".

If you want to encrypt data locally in your application, you can use the "GenerateDataKey" function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

GenerateDataKey(KeyId => Str, [EncryptionContext => Paws::KMS::EncryptionContextType, GrantTokens => ArrayRef[Str], KeySpec => Str, NumberOfBytes => Int])

Returns: a Paws::KMS::GenerateDataKeyResponse instance

Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the "Plaintext" field of the response object and an encrypted copy of the key in the "CiphertextBlob" field. The key is encrypted by using the master key specified by the "KeyId" field. To decrypt the encrypted key, pass it to the "Decrypt" API.

We recommend that you use the following pattern to locally encrypt data: call the "GenerateDataKey" API, use the key returned in the "Plaintext" response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the "CiphertextBlob" field) alongside of the locally encrypted data.

You should not call the "Encrypt" function to re-encrypt your data keys within a region. "GenerateDataKey" always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.

If you decide to use the optional "EncryptionContext" parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the "Decrypt" API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.

To decrypt data, pass the encrypted data key to the "Decrypt" API. "Decrypt" uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.

GenerateDataKeyWithoutPlaintext(KeyId => Str, [EncryptionContext => Paws::KMS::EncryptionContextType, GrantTokens => ArrayRef[Str], KeySpec => Str, NumberOfBytes => Int])

Returns: a Paws::KMS::GenerateDataKeyWithoutPlaintextResponse instance

Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.

GenerateRandom([NumberOfBytes => Int])

Returns: a Paws::KMS::GenerateRandomResponse instance

Generates an unpredictable byte string.

GetKeyPolicy(KeyId => Str, PolicyName => Str)

Returns: a Paws::KMS::GetKeyPolicyResponse instance

Retrieves a policy attached to the specified key.

GetKeyRotationStatus(KeyId => Str)

Returns: a Paws::KMS::GetKeyRotationStatusResponse instance

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

ListAliases([Limit => Int, Marker => Str])

Returns: a Paws::KMS::ListAliasesResponse instance

Lists all of the key aliases in the account.

ListGrants(KeyId => Str, [Limit => Int, Marker => Str])

Returns: a Paws::KMS::ListGrantsResponse instance

List the grants for a specified key.

ListKeyPolicies(KeyId => Str, [Limit => Int, Marker => Str])

Returns: a Paws::KMS::ListKeyPoliciesResponse instance

Retrieves a list of policies attached to a key.

ListKeys([Limit => Int, Marker => Str])

Returns: a Paws::KMS::ListKeysResponse instance

Lists the customer master keys.

PutKeyPolicy(KeyId => Str, Policy => Str, PolicyName => Str)

Returns: nothing

Attaches a policy to the specified key.

ReEncrypt(CiphertextBlob => Str, DestinationKeyId => Str, [DestinationEncryptionContext => Paws::KMS::EncryptionContextType, GrantTokens => ArrayRef[Str], SourceEncryptionContext => Paws::KMS::EncryptionContextType])

Returns: a Paws::KMS::ReEncryptResponse instance

Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.

Unlike other actions, "ReEncrypt" is authorized twice - once as "ReEncryptFrom" on the source key and once as "ReEncryptTo" on the destination key. We therefore recommend that you include the "action":"kms:ReEncrypt*" statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.

RetireGrant([GrantId => Str, GrantToken => Str, KeyId => Str])

Returns: nothing

Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
• The "RetiringPrincipal", if present
• The "GranteePrincipal", if "RetireGrant" is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the "CreateGrant" function.

RevokeGrant(GrantId => Str, KeyId => Str)

Returns: nothing

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

UpdateAlias(AliasName => Str, TargetKeyId => Str)

Returns: nothing

Updates an alias to associate it with a different key.

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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

An alias is not a property of a key. Therefore, an alias can be associated with and disassociated from an existing key without changing the properties of the key.

Note that you cannot create or update an alias that represents a key in another account.

UpdateKeyDescription(Description => Str, KeyId => Str)

Returns: nothing

Updates the description of a key.