Expand description
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, macOS, 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. You can also 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 API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
If you’re using the service, you’re probably looking for KmsClient and Kms.
Structs§
- Alias
List Entry Contains information about an alias.
- Cancel
KeyDeletion Request - Cancel
KeyDeletion Response - Connect
Custom KeyStore Request - Connect
Custom KeyStore Response - Create
Alias Request - Create
Custom KeyStore Request - Create
Custom KeyStore Response - Create
Grant Request - Create
Grant Response - Create
KeyRequest - Create
KeyResponse - Custom
KeyStores List Entry Contains information about each custom key store in the custom key store list.
- Decrypt
Request - Decrypt
Response - Delete
Alias Request - Delete
Custom KeyStore Request - Delete
Custom KeyStore Response - Delete
Imported KeyMaterial Request - Describe
Custom KeyStores Request - Describe
Custom KeyStores Response - Describe
KeyRequest - Describe
KeyResponse - Disable
KeyRequest - Disable
KeyRotation Request - Disconnect
Custom KeyStore Request - Disconnect
Custom KeyStore Response - Enable
KeyRequest - Enable
KeyRotation Request - Encrypt
Request - Encrypt
Response - Generate
Data KeyPair Request - Generate
Data KeyPair Response - Generate
Data KeyPair Without Plaintext Request - Generate
Data KeyPair Without Plaintext Response - Generate
Data KeyRequest - Generate
Data KeyResponse - Generate
Data KeyWithout Plaintext Request - Generate
Data KeyWithout Plaintext Response - Generate
Random Request - Generate
Random Response - GetKey
Policy Request - GetKey
Policy Response - GetKey
Rotation Status Request - GetKey
Rotation Status Response - GetParameters
ForImport Request - GetParameters
ForImport Response - GetPublic
KeyRequest - GetPublic
KeyResponse - Grant
Constraints Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.
AWS KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric CMK. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or RetireGrant.
In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.
However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.
To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the
kms:EncryptionContext:andkms:EncryptionContextKeysconditions in an IAM or key policy. For details, see kms:EncryptionContext: in the AWS Key Management Service Developer Guide .- Grant
List Entry Contains information about a grant.
- Import
KeyMaterial Request - Import
KeyMaterial Response - KeyList
Entry Contains information about each entry in the key list.
- KeyMetadata
Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
- KmsClient
- A client for the KMS API.
- List
Aliases Request - List
Aliases Response - List
Grants Request - List
Grants Response - List
KeyPolicies Request - List
KeyPolicies Response - List
Keys Request - List
Keys Response - List
Resource Tags Request - List
Resource Tags Response - List
Retirable Grants Request - Multi
Region Configuration Describes the configuration of this multi-Region CMK. This field appears only when the CMK is a primary or replica of a multi-Region CMK.
For more information about any listed CMK, use the DescribeKey operation.
- Multi
Region Key Describes the primary or replica key in a multi-Region key.
- PutKey
Policy Request - ReEncrypt
Request - ReEncrypt
Response - Replicate
KeyRequest - Replicate
KeyResponse - Retire
Grant Request - Revoke
Grant Request - Schedule
KeyDeletion Request - Schedule
KeyDeletion Response - Sign
Request - Sign
Response - Tag
A key-value pair. A 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.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
- TagResource
Request - Untag
Resource Request - Update
Alias Request - Update
Custom KeyStore Request - Update
Custom KeyStore Response - Update
KeyDescription Request - Update
Primary Region Request - Verify
Request - Verify
Response
Enums§
- Cancel
KeyDeletion Error - Errors returned by CancelKeyDeletion
- Connect
Custom KeyStore Error - Errors returned by ConnectCustomKeyStore
- Create
Alias Error - Errors returned by CreateAlias
- Create
Custom KeyStore Error - Errors returned by CreateCustomKeyStore
- Create
Grant Error - Errors returned by CreateGrant
- Create
KeyError - Errors returned by CreateKey
- Decrypt
Error - Errors returned by Decrypt
- Delete
Alias Error - Errors returned by DeleteAlias
- Delete
Custom KeyStore Error - Errors returned by DeleteCustomKeyStore
- Delete
Imported KeyMaterial Error - Errors returned by DeleteImportedKeyMaterial
- Describe
Custom KeyStores Error - Errors returned by DescribeCustomKeyStores
- Describe
KeyError - Errors returned by DescribeKey
- Disable
KeyError - Errors returned by DisableKey
- Disable
KeyRotation Error - Errors returned by DisableKeyRotation
- Disconnect
Custom KeyStore Error - Errors returned by DisconnectCustomKeyStore
- Enable
KeyError - Errors returned by EnableKey
- Enable
KeyRotation Error - Errors returned by EnableKeyRotation
- Encrypt
Error - Errors returned by Encrypt
- Generate
Data KeyError - Errors returned by GenerateDataKey
- Generate
Data KeyPair Error - Errors returned by GenerateDataKeyPair
- Generate
Data KeyPair Without Plaintext Error - Errors returned by GenerateDataKeyPairWithoutPlaintext
- Generate
Data KeyWithout Plaintext Error - Errors returned by GenerateDataKeyWithoutPlaintext
- Generate
Random Error - Errors returned by GenerateRandom
- GetKey
Policy Error - Errors returned by GetKeyPolicy
- GetKey
Rotation Status Error - Errors returned by GetKeyRotationStatus
- GetParameters
ForImport Error - Errors returned by GetParametersForImport
- GetPublic
KeyError - Errors returned by GetPublicKey
- Import
KeyMaterial Error - Errors returned by ImportKeyMaterial
- List
Aliases Error - Errors returned by ListAliases
- List
Grants Error - Errors returned by ListGrants
- List
KeyPolicies Error - Errors returned by ListKeyPolicies
- List
Keys Error - Errors returned by ListKeys
- List
Resource Tags Error - Errors returned by ListResourceTags
- List
Retirable Grants Error - Errors returned by ListRetirableGrants
- PutKey
Policy Error - Errors returned by PutKeyPolicy
- ReEncrypt
Error - Errors returned by ReEncrypt
- Replicate
KeyError - Errors returned by ReplicateKey
- Retire
Grant Error - Errors returned by RetireGrant
- Revoke
Grant Error - Errors returned by RevokeGrant
- Schedule
KeyDeletion Error - Errors returned by ScheduleKeyDeletion
- Sign
Error - Errors returned by Sign
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Alias Error - Errors returned by UpdateAlias
- Update
Custom KeyStore Error - Errors returned by UpdateCustomKeyStore
- Update
KeyDescription Error - Errors returned by UpdateKeyDescription
- Update
Primary Region Error - Errors returned by UpdatePrimaryRegion
- Verify
Error - Errors returned by Verify
Traits§
- Kms
- Trait representing the capabilities of the KMS API. KMS clients implement this trait.