The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.31
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::KMS

NAME

Paws::KMS - Perl Interface to AWS AWS Key Management Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('KMS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Key Management Service

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.

All AWS KMS operations require Signature Version 4.

Logging API Requests

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

  • AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.

  • Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.

  • Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.

Commonly Used APIs

Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.

  • Encrypt

  • Decrypt

  • GenerateDataKey

  • GenerateDataKeyWithoutPlaintext

METHODS

CancelKeyDeletion(KeyId => Str)

Each argument is described in detail in: Paws::KMS::CancelKeyDeletion

Returns: a Paws::KMS::CancelKeyDeletionResponse instance

  Cancels the deletion of a customer master key (CMK). When this
operation is successful, the CMK is set to the C<Disabled> state. To
enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

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

Each argument is described in detail in: Paws::KMS::CreateAlias

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

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

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

Each argument is described in detail in: Paws::KMS::CreateGrant

Returns: a Paws::KMS::CreateGrantResponse instance

  Adds a grant to a key to specify who can use the key and under what
conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

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

Each argument is described in detail in: Paws::KMS::CreateKey

Returns: a Paws::KMS::CreateKeyResponse instance

  Creates a customer master key (CMK).

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 in the AWS Key Management Service Developer Guide

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

Each argument is described in detail in: Paws::KMS::Decrypt

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)

Each argument is described in detail in: Paws::KMS::DeleteAlias

Returns: nothing

  Deletes the specified alias. To map an alias to a different key, call
UpdateAlias.

DeleteImportedKeyMaterial(KeyId => Str)

Each argument is described in detail in: Paws::KMS::DeleteImportedKeyMaterial

Returns: nothing

  Deletes key material that you previously imported and makes the
specified customer master key (CMK) unusable. For more information
about importing key material into AWS KMS, see Importing Key Material
in the I<AWS Key Management Service Developer Guide>.

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.

DescribeKey(KeyId => Str, [GrantTokens => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::KMS::DescribeKey

Returns: a Paws::KMS::DescribeKeyResponse instance

  Provides detailed information about the specified customer master key.

DisableKey(KeyId => Str)

Each argument is described in detail in: Paws::KMS::DisableKey

Returns: nothing

  Sets the state of a customer master key (CMK) to disabled, thereby
preventing its use for cryptographic operations. For more information
about how key state affects the use of a CMK, see How Key State Affects
the Use of a Customer Master Key in the I<AWS Key Management Service
Developer Guide>.

DisableKeyRotation(KeyId => Str)

Each argument is described in detail in: Paws::KMS::DisableKeyRotation

Returns: nothing

  Disables rotation of the specified key.

EnableKey(KeyId => Str)

Each argument is described in detail in: Paws::KMS::EnableKey

Returns: nothing

  Marks a key as enabled, thereby permitting its use.

EnableKeyRotation(KeyId => Str)

Each argument is described in detail in: Paws::KMS::EnableKeyRotation

Returns: nothing

  Enables rotation of the specified customer master key.

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

Each argument is described in detail in: Paws::KMS::Encrypt

Returns: a Paws::KMS::EncryptResponse instance

  Encrypts plaintext into ciphertext by using a customer master key. The
C<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|Undef], KeySpec => Str, NumberOfBytes => Int])

Each argument is described in detail in: Paws::KMS::GenerateDataKey

Returns: a Paws::KMS::GenerateDataKeyResponse instance

  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.

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 retrieve 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 an arbitrary unpredictable byte string, 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.

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

Each argument is described in detail in: Paws::KMS::GenerateDataKeyWithoutPlaintext

Returns: a Paws::KMS::GenerateDataKeyWithoutPlaintextResponse instance

  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.

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.

GenerateRandom([NumberOfBytes => Int])

Each argument is described in detail in: Paws::KMS::GenerateRandom

Returns: a Paws::KMS::GenerateRandomResponse instance

  Generates an unpredictable byte string.

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

Each argument is described in detail in: Paws::KMS::GetKeyPolicy

Returns: a Paws::KMS::GetKeyPolicyResponse instance

  Retrieves a policy attached to the specified key.

GetKeyRotationStatus(KeyId => Str)

Each argument is described in detail in: Paws::KMS::GetKeyRotationStatus

Returns: a Paws::KMS::GetKeyRotationStatusResponse instance

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

GetParametersForImport(KeyId => Str, WrappingAlgorithm => Str, WrappingKeySpec => Str)

Each argument is described in detail in: Paws::KMS::GetParametersForImport

Returns: a Paws::KMS::GetParametersForImportResponse instance

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

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, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

ImportKeyMaterial(EncryptedKeyMaterial => Str, ImportToken => Str, KeyId => Str, [ExpirationModel => Str, ValidTo => Str])

Each argument is described in detail in: Paws::KMS::ImportKeyMaterial

Returns: a Paws::KMS::ImportKeyMaterialResponse instance

  Imports key material into an AWS KMS customer master key (CMK) from
your existing key management infrastructure. For more information about
importing key material into AWS KMS, see Importing Key Material in the
I<AWS Key Management Service Developer Guide>.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes 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.

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

Each argument is described in detail in: Paws::KMS::ListAliases

Returns: a Paws::KMS::ListAliasesResponse instance

  Lists all of the key aliases in the account.

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

Each argument is described in detail in: Paws::KMS::ListGrants

Returns: a Paws::KMS::ListGrantsResponse instance

  List the grants for a specified key.

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

Each argument is described in detail in: Paws::KMS::ListKeyPolicies

Returns: a Paws::KMS::ListKeyPoliciesResponse instance

  Retrieves a list of policies attached to a key.

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

Each argument is described in detail in: Paws::KMS::ListKeys

Returns: a Paws::KMS::ListKeysResponse instance

  Lists the customer master keys.

ListRetirableGrants(RetiringPrincipal => Str, [Limit => Int, Marker => Str])

Each argument is described in detail in: Paws::KMS::ListRetirableGrants

Returns: a Paws::KMS::ListGrantsResponse instance

  Returns a list of all grants for which the grant's C<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.

PutKeyPolicy(KeyId => Str, Policy => Str, PolicyName => Str, [BypassPolicyLockoutSafetyCheck => Bool])

Each argument is described in detail in: Paws::KMS::PutKeyPolicy

Returns: nothing

  Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

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

Each argument is described in detail in: Paws::KMS::ReEncrypt

Returns: a Paws::KMS::ReEncryptResponse instance

  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.

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.

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

Each argument is described in detail in: Paws::KMS::RetireGrant

Returns: nothing

  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.

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

Each argument is described in detail in: Paws::KMS::RevokeGrant

Returns: nothing

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

ScheduleKeyDeletion(KeyId => Str, [PendingWindowInDays => Int])

Each argument is described in detail in: Paws::KMS::ScheduleKeyDeletion

Returns: a Paws::KMS::ScheduleKeyDeletionResponse instance

  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
C<PendingDeletion>. Before the waiting period ends, you can use
CancelKeyDeletion to cancel the deletion of the CMK. After the waiting
period ends, AWS KMS deletes the CMK and all AWS KMS data associated
with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is 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 in the AWS Key Management Service Developer Guide.

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

Each argument is described in detail in: Paws::KMS::UpdateAlias

Returns: nothing

  Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the 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).

The alias and the key it is mapped to must be in the same AWS account and the same region.

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

Each argument is described in detail in: Paws::KMS::UpdateKeyDescription

Returns: nothing

  Updates the description of a customer master key (CMK).

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAliases(sub { },[Limit => Int, Marker => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - Aliases, passing the object as the first parameter, and the string 'Aliases' as the second parameter

If not, it will return a a Paws::KMS::ListAliasesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllGrants(sub { },KeyId => Str, [Limit => Int, Marker => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - Grants, passing the object as the first parameter, and the string 'Grants' as the second parameter

If not, it will return a a Paws::KMS::ListGrantsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllKeyPolicies(sub { },KeyId => Str, [Limit => Int, Marker => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - PolicyNames, passing the object as the first parameter, and the string 'PolicyNames' as the second parameter

If not, it will return a a Paws::KMS::ListKeyPoliciesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllKeys(sub { },[Limit => Int, Marker => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - Keys, passing the object as the first parameter, and the string 'Keys' as the second parameter

If not, it will return a a Paws::KMS::ListKeysResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues