AWS KMS code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with AWS Key Management Service (AWS KMS).

AWS KMS is an encryption and key management service scaled for the cloud.

⚠ Important

• Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

Prerequisites

For prerequisites, see the README in the python folder.

Install the packages required by these examples by running the following in a virtual environment:

python -m pip install -r requirements.txt

Basics

Code examples that show you how to perform the essential operations within a service.

• Learn the basics

Single actions

Code excerpts that show you how to call individual service functions.

• CreateAlias
• CreateGrant
• CreateKey
• Decrypt
• DeleteAlias
• DescribeKey
• DisableKey
• EnableKey
• EnableKeyRotation
• Encrypt
• GenerateDataKey
• GetKeyPolicy
• ListAliases
• ListGrants
• ListKeyPolicies
• ListKeys
• PutKeyPolicy
• ReEncrypt
• RetireGrant
• RevokeGrant
• ScheduleKeyDeletion
• Sign
• TagResource
• UpdateAlias
• Verify

Run the examples

Instructions

Learn the basics

This example shows you how to do the following:

• Create a KMS key.
• List KMS keys for your account and get details about them.
• Enable and disable KMS keys.
• Generate a symmetric data key that can be used for client-side encryption.
• Generate an asymmetric key used to digitally sign data.
• Tag keys.
• Delete KMS keys.

Start the example by running the following at a command prompt:

python kms_scenario.py

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the python folder.

Additional resources

• AWS KMS Developer Guide
• AWS KMS API Reference
• SDK for Python AWS KMS reference

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0