GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::KMS (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(KMS)->new;
  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 (KMS) is an encryption and key management web service. This guide describes the KMS actions that you can call programmatically. For general information about 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 KMS and AWS. 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 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.

<B>Signing RequestsB>

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 access key ID and secret key for everyday work with 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 KMS operations require Signature Version 4.

<B>Recording API RequestsB>

KMS supports AWS CloudTrail, a service that records 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 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

<B>Additional ResourcesB>

For more information about credentials and request signing, see the following:
o AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.
o AWS Security Token Service. This guide describes how to create and use temporary security credentials.
o Signing AWS API Requests. This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
<B>Commonly Used APIsB>

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.
o Encrypt
o Decrypt
o GenerateDataKey
o GenerateDataKeyWithoutPlaintext

METHODS

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

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

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

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

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

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:
o GenerateDataKey
o GenerateDataKeyWithoutPlaintext
o 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 associate an alias with a different key, call UpdateAlias.

    DescribeKey(KeyId => Str)

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

Marks a key as disabled, thereby preventing its use.

    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. You can have up to 25 enabled keys at one time.

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

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 Encrypt function has two primary use cases:
o You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
o 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])

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

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

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

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

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.

    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.

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

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

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

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

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

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:
o The account that created the grant
o The RetiringPrincipal, if present
o 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)

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.

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

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

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)

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

Returns: nothing

Updates the description of a key.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::KMS (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.