KmsClient Class

Member Function Documentation

KmsClient::KmsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a KmsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

KmsClient::KmsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads KmsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelKeyDeletionResponse *KmsClient::cancelKeyDeletion(const CancelKeyDeletionRequest &request)

Sends request to the KmsClient service, and returns a pointer to an CancelKeyDeletionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. 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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer

[slot] CreateAliasResponse *KmsClient::createAlias(const CreateAliasRequest &request)

Sends request to the KmsClient service, and returns a pointer to an CreateAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as <a>Encrypt</a> and <a>GenerateDataKey</a>.

</p

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.

</p

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 <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a>

operation>

An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services

(AWS)>

The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS

account>

To map an existing alias to a different CMK, call

[slot] CreateGrantResponse *KmsClient::createGrant(const CreateGrantRequest &request)

Sends request to the KmsClient service, and returns a pointer to an CreateGrantResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i>AWS Key Management Service Developer

[slot] CreateKeyResponse *KmsClient::createKey(const CreateKeyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an CreateKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

The <a>GenerateDataKey</a>

operatio> </li> <li>

<a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html">AWS Key Management Service Concepts</a> in the <i>AWS Key Management Service Developer Guide</i>

</p </li> </ul>

You cannot use this operation to create a CMK in a different AWS

[slot] DecryptResponse *KmsClient::decrypt(const DecryptRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DecryptResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

operations> <ul> <li>

<a>GenerateDataKey</a>

</p </li> <li>

<a>GenerateDataKeyWithoutPlaintext</a>

</p </li> <li>

<a>Encrypt</a>

</p </li> </ul>

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> 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 <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted

[slot] DeleteAliasResponse *KmsClient::deleteAlias(const DeleteAliasRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DeleteAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

</p

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 <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation.

</p

Each CMK can have multiple aliases. To change the alias of a CMK, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different customer master key (CMK), call

[slot] DeleteImportedKeyMaterialResponse *KmsClient::deleteImportedKeyMaterial(const DeleteImportedKeyMaterialRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DeleteImportedKeyMaterialResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. You cannot perform this operation on a CMK in a different AWS

account>

When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to

<code>PendingImport</code>>

After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the

[slot] DescribeKeyResponse *KmsClient::describeKey(const DescribeKeyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DescribeKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides detailed information about the specified customer master key

(CMK)>

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId

[slot] DisableKeyResponse *KmsClient::disableKey(const DisableKeyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DisableKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer

[slot] DisableKeyRotationResponse *KmsClient::disableKeyRotation(const DisableKeyRotationRequest &request)

Sends request to the KmsClient service, and returns a pointer to an DisableKeyRotationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] EnableKeyResponse *KmsClient::enableKey(const EnableKeyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an EnableKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] EnableKeyRotationResponse *KmsClient::enableKeyRotation(const EnableKeyRotationRequest &request)

Sends request to the KmsClient service, and returns a pointer to an EnableKeyRotationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] EncryptResponse *KmsClient::encrypt(const EncryptRequest &request)

Sends request to the KmsClient service, and returns a pointer to an EncryptResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Encrypts plaintext into ciphertext by using a customer master key (CMK). The <code>Encrypt</code> operation has two primary use

cases> <ul> <li>

You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive

information> </li> <li>

To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted

data> </li> </ul>

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId

parameter>

Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a generated data key within a region. To get data keys that are already encrypted, call the <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> operation. Data keys don't need to be encrypted again by calling

<code>Encrypt</code>>

To encrypt data locally in your application, use the <a>GenerateDataKey</a> operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your

[slot] GenerateDataKeyResponse *KmsClient::generateDataKey(const GenerateDataKeyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GenerateDataKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a data encryption key that you can use in your application to encrypt data locally.

</p

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 <code>KeySpec</code> or <code>NumberOfBytes</code> 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 <code>KeySpec</code>. 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 <code>Plaintext</code> field of the response, and an encrypted copy of the data key in the <code>CiphertextBlob</code> field. The data key is encrypted under the CMK specified in the <code>KeyId</code> field of the request.

</p

We recommend that you use the following pattern to encrypt data locally in your

application> <ol> <li>

Use this operation (<code>GenerateDataKey</code>) to get a data encryption

key> </li> <li>

Use the plaintext data encryption key (returned in the <code>Plaintext</code> field of the response) to encrypt data locally, then erase the plaintext data key from

memory> </li> <li>

Store the encrypted data key (returned in the <code>CiphertextBlob</code> field of the response) alongside the locally encrypted

data> </li> </ol>

To decrypt data

locally> <ol> <li>

Use the <a>Decrypt</a> operation to decrypt the encrypted data key into a plaintext copy of the data

key> </li> <li>

Use the plaintext data key to decrypt data locally, then erase the plaintext data key from

memory> </li> </ol>

To return only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To return a random byte string that is cryptographically secure, use

<a>GenerateRandom</a>>

If you use the optional <code>EncryptionContext</code> 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 <a>Decrypt</a> 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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html">Encryption Context</a> in the <i>AWS Key Management Service Developer

[slot] GenerateDataKeyWithoutPlaintextResponse *KmsClient::generateDataKeyWithoutPlaintext(const GenerateDataKeyWithoutPlaintextRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GenerateDataKeyWithoutPlaintextResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to <a>GenerateDataKey</a> but returns only the encrypted copy of the data key.

</p

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 <i>control plane</i>, creates new containers. When it creates a new container, it uses this operation (<code>GenerateDataKeyWithoutPlaintext</code>) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the <i>data plane</i>, puts encrypted data into the containers. To do this, it passes the encrypted data key to the <a>Decrypt</a> 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

[slot] GenerateRandomResponse *KmsClient::generateRandom(const GenerateRandomRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GenerateRandomResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a random byte string that is cryptographically

secure>

For more information about entropy and random number generation, see the <a href="https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf">AWS Key Management Service Cryptographic Details</a>

[slot] GetKeyPolicyResponse *KmsClient::getKeyPolicy(const GetKeyPolicyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GetKeyPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS

[slot] GetKeyRotationStatusResponse *KmsClient::getKeyRotationStatus(const GetKeyRotationStatusRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GetKeyRotationStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key

(CMK)>

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId

[slot] GetParametersForImportResponse *KmsClient::getParametersForImport(const GetParametersForImportRequest &request)

Sends request to the KmsClient service, and returns a pointer to an GetParametersForImportResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer

Guide</i>>

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's <code>Origin</code> must be <code>EXTERNAL</code>. 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 <a>ImportKeyMaterial</a> 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 <a>ImportKeyMaterial</a> request. To get new ones, send another <code>GetParametersForImport</code>

[slot] ImportKeyMaterialResponse *KmsClient::importKeyMaterial(const ImportKeyMaterialRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ImportKeyMaterialResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer

Guide</i>>

Before using this operation, call <a>GetParametersForImport</a>. 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 <code>GetParametersForImport</code>

response>

When calling this operation, you must specify the following

values> <ul> <li>

The key ID or key ARN of a CMK with no key material. Its <code>Origin</code> must be

<code>EXTERNAL</code>>

To create a CMK with no key material, call <a>CreateKey</a> and set the value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the <code>Origin</code> of a CMK, call

<a>DescribeKey</a>.> </li> <li>

The encrypted key material. To get the public key to encrypt the key material, call

<a>GetParametersForImport</a>> </li> <li>

The import token that <a>GetParametersForImport</a> returned. This token and the public key used to encrypt the key material must have come from the same

response> </li> <li>

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> </li> </ul>

When this operation is successful, the CMK's key state changes from <code>PendingImport</code> to <code>Enabled</code>, 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

[slot] ListAliasesResponse *KmsClient::listAliases(const ListAliasesRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListAliasesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see

<a>CreateAlias</a>>

The response might include several aliases that do not have a <code>TargetKeyId</code> field because they are not associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an alias is not associated with a CMK, the alias does not count against the <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">alias limit</a> for your

[slot] ListGrantsResponse *KmsClient::listGrants(const ListGrantsRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListGrantsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListKeyPoliciesResponse *KmsClient::listKeyPolicies(const ListKeyPoliciesRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListKeyPoliciesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>GetKeyPolicy</a> operation. However, the only valid policy name is <code>default</code>. You cannot perform this operation on a CMK in a different AWS

[slot] ListKeysResponse *KmsClient::listKeys(const ListKeysRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListKeysResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a list of all customer master keys (CMKs) in the caller's AWS account and

[slot] ListResourceTagsResponse *KmsClient::listResourceTags(const ListResourceTagsRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListResourceTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListRetirableGrantsResponse *KmsClient::listRetirableGrants(const ListRetirableGrantsRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ListRetirableGrantsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one

specified>

A typical use is to list all grants that you are able to retire. To retire a grant, use

[slot] PutKeyPolicyResponse *KmsClient::putKeyPolicy(const PutKeyPolicyRequest &request)

Sends request to the KmsClient service, and returns a pointer to an PutKeyPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>AWS Key Management Service Developer

[slot] ReEncryptResponse *KmsClient::reEncrypt(const ReEncryptRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ReEncryptResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

You can reencrypt data using CMKs in different AWS

accounts>

Unlike other operations, <code>ReEncrypt</code> is authorized twice, once as <code>ReEncryptFrom</code> on the source CMK and once as <code>ReEncryptTo</code> on the destination CMK. We recommend that you include the <code>"kms:ReEncrypt*"</code> permission in your <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policies</a> 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 <a>PutKeyPolicy</a>

[slot] RetireGrantResponse *KmsClient::retireGrant(const RetireGrantRequest &request)

Sends request to the KmsClient service, and returns a pointer to an RetireGrantResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

The AWS account (root user) under which the grant was

create> </li> <li>

The <code>RetiringPrincipal</code>, if present in the

gran> </li> <li>

The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is an operation specified in the

gran> </li> </ul>

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 <a>CreateGrant</a> operation returns

[slot] RevokeGrantResponse *KmsClient::revokeGrant(const RevokeGrantRequest &request)

Sends request to the KmsClient service, and returns a pointer to an RevokeGrantResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ScheduleKeyDeletionResponse *KmsClient::scheduleKeyDeletion(const ScheduleKeyDeletionRequest &request)

Sends request to the KmsClient service, and returns a pointer to an ScheduleKeyDeletionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> 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> <b>

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

<a>DisableKey</a>> </b>

For more information about scheduling a CMK for deletion, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer

[slot] TagResourceResponse *KmsClient::tagResource(const TagResourceRequest &request)

Sends request to the KmsClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS

account>

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null)

strings>

You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is <code>Purpose</code> and tag value is <code>Test</code>. If you send a <code>TagResource</code> request for this CMK with a tag key of <code>Purpose</code> and a tag value of <code>Prod</code>, it does not create a second tag. Instead, the original tag is overwritten with the new tag

value>

For information about the rules that apply to tag keys and tag values, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User

[slot] UntagResourceResponse *KmsClient::untagResource(const UntagResourceRequest &request)

Sends request to the KmsClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS

account>

To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use

[slot] UpdateAliasResponse *KmsClient::updateAlias(const UpdateAliasRequest &request)

Sends request to the KmsClient service, and returns a pointer to an UpdateAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>CreateAlias</a> to create a new alias and <a>DeleteAlias</a> 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 <a>DescribeKey</a> operation. To get the aliases of all CMKs in the account, use the <a>ListAliases</a> operation.

</p

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services

[slot] UpdateKeyDescriptionResponse *KmsClient::updateKeyDescription(const UpdateKeyDescriptionRequest &request)

Sends request to the KmsClient service, and returns a pointer to an UpdateKeyDescriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the description of a customer master key (CMK). To see the decription of a CMK, use <a>DescribeKey</a>.

</p

You cannot perform this operation on a CMK in a different AWS