KMS#
Client#
- class KMS.Client#
A low-level client representing AWS Key Management Service (KMS)
Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide.
Note
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services 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 KMS and other Amazon Web Services 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 Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. 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 using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account root access key ID and secret access key for everyday work. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service (STS) to generate temporary security credentials and use those to sign requests.
All KMS requests must be signed with Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services 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 CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.
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.
Encrypt
Decrypt
GenerateDataKey
GenerateDataKeyWithoutPlaintext
client = session.create_client('kms')
These are the available methods:
- can_paginate
- cancel_key_deletion
- close
- connect_custom_key_store
- create_alias
- create_custom_key_store
- create_grant
- create_key
- decrypt
- delete_alias
- delete_custom_key_store
- delete_imported_key_material
- derive_shared_secret
- describe_custom_key_stores
- describe_key
- disable_key
- disable_key_rotation
- disconnect_custom_key_store
- enable_key
- enable_key_rotation
- encrypt
- generate_data_key
- generate_data_key_pair
- generate_data_key_pair_without_plaintext
- generate_data_key_without_plaintext
- generate_mac
- generate_random
- get_key_policy
- get_key_rotation_status
- get_paginator
- get_parameters_for_import
- get_public_key
- get_waiter
- import_key_material
- list_aliases
- list_grants
- list_key_policies
- list_key_rotations
- list_keys
- list_resource_tags
- list_retirable_grants
- put_key_policy
- re_encrypt
- replicate_key
- retire_grant
- revoke_grant
- rotate_key_on_demand
- schedule_key_deletion
- sign
- tag_resource
- untag_resource
- update_alias
- update_custom_key_store
- update_key_description
- update_primary_region
- verify
- verify_mac
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AlreadyExistsException
- CloudHsmClusterInUseException
- CloudHsmClusterInvalidConfigurationException
- CloudHsmClusterNotActiveException
- CloudHsmClusterNotFoundException
- CloudHsmClusterNotRelatedException
- ConflictException
- CustomKeyStoreHasCMKsException
- CustomKeyStoreInvalidStateException
- CustomKeyStoreNameInUseException
- CustomKeyStoreNotFoundException
- DependencyTimeoutException
- DisabledException
- DryRunOperationException
- ExpiredImportTokenException
- IncorrectKeyException
- IncorrectKeyMaterialException
- IncorrectTrustAnchorException
- InvalidAliasNameException
- InvalidArnException
- InvalidCiphertextException
- InvalidGrantIdException
- InvalidGrantTokenException
- InvalidImportTokenException
- InvalidKeyUsageException
- InvalidMarkerException
- KMSInternalException
- KMSInvalidMacException
- KMSInvalidSignatureException
- KMSInvalidStateException
- KeyUnavailableException
- LimitExceededException
- MalformedPolicyDocumentException
- NotFoundException
- TagException
- UnsupportedOperationException
- XksKeyAlreadyInUseException
- XksKeyInvalidConfigurationException
- XksKeyNotFoundException
- XksProxyIncorrectAuthenticationCredentialException
- XksProxyInvalidConfigurationException
- XksProxyInvalidResponseException
- XksProxyUriEndpointInUseException
- XksProxyUriInUseException
- XksProxyUriUnreachableException
- XksProxyVpcEndpointServiceInUseException
- XksProxyVpcEndpointServiceInvalidConfigurationException
- XksProxyVpcEndpointServiceNotFoundException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: