AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 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:
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.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonKeyManagementService IDisposable
The IAmazonKeyManagementService type exposes the following members
Name | Description | |
---|---|---|
BeginCancelKeyDeletion(CancelKeyDeletionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CancelKeyDeletion operation. | |
BeginCreateAlias(CreateAliasRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateAlias operation. | |
BeginCreateGrant(CreateGrantRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateGrant operation. | |
BeginCreateKey(CreateKeyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateKey operation. | |
BeginDecrypt(DecryptRequest, AsyncCallback, object) | Initiates the asynchronous execution of the Decrypt operation. | |
BeginDeleteAlias(DeleteAliasRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteAlias operation. | |
BeginDescribeKey(DescribeKeyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeKey operation. | |
BeginDisableKey(DisableKeyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DisableKey operation. | |
BeginDisableKeyRotation(DisableKeyRotationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DisableKeyRotation operation. | |
BeginEnableKey(EnableKeyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the EnableKey operation. | |
BeginEnableKeyRotation(EnableKeyRotationRequest, AsyncCallback, object) | Initiates the asynchronous execution of the EnableKeyRotation operation. | |
BeginEncrypt(EncryptRequest, AsyncCallback, object) | Initiates the asynchronous execution of the Encrypt operation. | |
BeginGenerateDataKey(GenerateDataKeyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GenerateDataKey operation. | |
BeginGenerateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation. | |
BeginGenerateRandom(GenerateRandomRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GenerateRandom operation. | |
BeginGetKeyPolicy(GetKeyPolicyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetKeyPolicy operation. | |
BeginGetKeyRotationStatus(GetKeyRotationStatusRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetKeyRotationStatus operation. | |
BeginListAliases(ListAliasesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListAliases operation. | |
BeginListGrants(ListGrantsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListGrants operation. | |
BeginListKeyPolicies(ListKeyPoliciesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListKeyPolicies operation. | |
BeginListKeys(ListKeysRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListKeys operation. | |
BeginListRetirableGrants(ListRetirableGrantsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListRetirableGrants operation. | |
BeginPutKeyPolicy(PutKeyPolicyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the PutKeyPolicy operation. | |
BeginReEncrypt(ReEncryptRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ReEncrypt operation. | |
BeginRetireGrant(RetireGrantRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RetireGrant operation. | |
BeginRevokeGrant(RevokeGrantRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RevokeGrant operation. | |
BeginScheduleKeyDeletion(ScheduleKeyDeletionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ScheduleKeyDeletion operation. | |
BeginUpdateAlias(UpdateAliasRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateAlias operation. | |
BeginUpdateKeyDescription(UpdateKeyDescriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateKeyDescription operation. | |
CancelKeyDeletion(string) |
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.
For more information about scheduling and canceling deletion of a CMK, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. |
|
CancelKeyDeletion(CancelKeyDeletionRequest) |
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.
For more information about scheduling and canceling deletion of a CMK, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. |
|
CreateAlias(string, string) |
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. |
|
CreateAlias(CreateAliasRequest) |
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(CreateGrantRequest) |
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(CreateKeyRequest) | 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(DecryptRequest) |
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by
using any of the following functions:
Note that if a caller has been granted access permissions to all keys (through, for
example, IAM user policies that grant |
|
DeleteAlias(string) | Deletes the specified alias. To map an alias to a different key, call UpdateAlias. | |
DeleteAlias(DeleteAliasRequest) | Deletes the specified alias. To map an alias to a different key, call UpdateAlias. | |
DescribeKey(string) | Provides detailed information about the specified customer master key. | |
DescribeKey(DescribeKeyRequest) | Provides detailed information about the specified customer master key. | |
DisableKey(string) | Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide. | |
DisableKey(DisableKeyRequest) | Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide. | |
DisableKeyRotation(string) | Disables rotation of the specified key. | |
DisableKeyRotation(DisableKeyRotationRequest) | Disables rotation of the specified key. | |
EnableKey(string) | Marks a key as enabled, thereby permitting its use. | |
EnableKey(EnableKeyRequest) | Marks a key as enabled, thereby permitting its use. | |
EnableKeyRotation(string) | Enables rotation of the specified customer master key. | |
EnableKeyRotation(EnableKeyRotationRequest) | Enables rotation of the specified customer master key. | |
Encrypt(EncryptRequest) |
Encrypts plaintext into ciphertext by using a customer master key. The Encrypt
function has two primary use cases:
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
If you want to encrypt data locally in your application, you can use the |
|
EndCancelKeyDeletion(IAsyncResult) | Finishes the asynchronous execution of the CancelKeyDeletion operation. | |
EndCreateAlias(IAsyncResult) | Finishes the asynchronous execution of the CreateAlias operation. | |
EndCreateGrant(IAsyncResult) | Finishes the asynchronous execution of the CreateGrant operation. | |
EndCreateKey(IAsyncResult) | Finishes the asynchronous execution of the CreateKey operation. | |
EndDecrypt(IAsyncResult) | Finishes the asynchronous execution of the Decrypt operation. | |
EndDeleteAlias(IAsyncResult) | Finishes the asynchronous execution of the DeleteAlias operation. | |
EndDescribeKey(IAsyncResult) | Finishes the asynchronous execution of the DescribeKey operation. | |
EndDisableKey(IAsyncResult) | Finishes the asynchronous execution of the DisableKey operation. | |
EndDisableKeyRotation(IAsyncResult) | Finishes the asynchronous execution of the DisableKeyRotation operation. | |
EndEnableKey(IAsyncResult) | Finishes the asynchronous execution of the EnableKey operation. | |
EndEnableKeyRotation(IAsyncResult) | Finishes the asynchronous execution of the EnableKeyRotation operation. | |
EndEncrypt(IAsyncResult) | Finishes the asynchronous execution of the Encrypt operation. | |
EndGenerateDataKey(IAsyncResult) | Finishes the asynchronous execution of the GenerateDataKey operation. | |
EndGenerateDataKeyWithoutPlaintext(IAsyncResult) | Finishes the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation. | |
EndGenerateRandom(IAsyncResult) | Finishes the asynchronous execution of the GenerateRandom operation. | |
EndGetKeyPolicy(IAsyncResult) | Finishes the asynchronous execution of the GetKeyPolicy operation. | |
EndGetKeyRotationStatus(IAsyncResult) | Finishes the asynchronous execution of the GetKeyRotationStatus operation. | |
EndListAliases(IAsyncResult) | Finishes the asynchronous execution of the ListAliases operation. | |
EndListGrants(IAsyncResult) | Finishes the asynchronous execution of the ListGrants operation. | |
EndListKeyPolicies(IAsyncResult) | Finishes the asynchronous execution of the ListKeyPolicies operation. | |
EndListKeys(IAsyncResult) | Finishes the asynchronous execution of the ListKeys operation. | |
EndListRetirableGrants(IAsyncResult) | Finishes the asynchronous execution of the ListRetirableGrants operation. | |
EndPutKeyPolicy(IAsyncResult) | Finishes the asynchronous execution of the PutKeyPolicy operation. | |
EndReEncrypt(IAsyncResult) | Finishes the asynchronous execution of the ReEncrypt operation. | |
EndRetireGrant(IAsyncResult) | Finishes the asynchronous execution of the RetireGrant operation. | |
EndRevokeGrant(IAsyncResult) | Finishes the asynchronous execution of the RevokeGrant operation. | |
EndScheduleKeyDeletion(IAsyncResult) | Finishes the asynchronous execution of the ScheduleKeyDeletion operation. | |
EndUpdateAlias(IAsyncResult) | Finishes the asynchronous execution of the UpdateAlias operation. | |
EndUpdateKeyDescription(IAsyncResult) | Finishes the asynchronous execution of the UpdateKeyDescription operation. | |
GenerateDataKey(GenerateDataKeyRequest) |
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
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
To decrypt data, pass the encrypted data key to the |
|
GenerateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest) | 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(int) | Generates an unpredictable byte string. | |
GenerateRandom(GenerateRandomRequest) | Generates an unpredictable byte string. | |
GetKeyPolicy(string, string) | Retrieves a policy attached to the specified key. | |
GetKeyPolicy(GetKeyPolicyRequest) | Retrieves a policy attached to the specified key. | |
GetKeyRotationStatus(string) | Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. | |
GetKeyRotationStatus(GetKeyRotationStatusRequest) | Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. | |
ListAliases(ListAliasesRequest) | Lists all of the key aliases in the account. | |
ListGrants(ListGrantsRequest) | List the grants for a specified key. | |
ListKeyPolicies(ListKeyPoliciesRequest) | Retrieves a list of policies attached to a key. | |
ListKeys(ListKeysRequest) | Lists the customer master keys. | |
ListRetirableGrants(string) |
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. |
|
ListRetirableGrants() |
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. |
|
ListRetirableGrants(ListRetirableGrantsRequest) |
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. |
|
PutKeyPolicy(string, string, string) | Attaches a policy to the specified key. | |
PutKeyPolicy(PutKeyPolicyRequest) | Attaches a policy to the specified key. | |
ReEncrypt(ReEncryptRequest) |
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, |
|
RetireGrant(string) |
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:
CreateGrant
function.
|
|
RetireGrant(RetireGrantRequest) |
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:
CreateGrant
function.
|
|
RevokeGrant(string, string) | Revokes a grant. You can revoke a grant to actively deny operations that depend on it. | |
RevokeGrant(RevokeGrantRequest) | Revokes a grant. You can revoke a grant to actively deny operations that depend on it. | |
ScheduleKeyDeletion(string) |
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 point 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, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. |
|
ScheduleKeyDeletion(string, int) |
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 point 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, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. |
|
ScheduleKeyDeletion(ScheduleKeyDeletionRequest) |
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 point 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, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. |
|
UpdateAlias(string, string) |
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. |
|
UpdateAlias(UpdateAliasRequest) |
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(string, string) | Updates the description of a key. | |
UpdateKeyDescription(UpdateKeyDescriptionRequest) | Updates the description of a key. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8