MORPH
SIGN IN SIGN UP
awsdocs / aws-doc-sdk-examples UNCLAIMED

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 0 Java
Normal View History Raw
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
# AWS KMS code examples for the SDK for Python
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
## Overview
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
Shows how to use the AWS SDK for Python (Boto3) to work with AWS Key Management Service (AWS KMS).
<!--custom.overview.start-->
<!--custom.overview.end-->
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
_AWS KMS is an encryption and key management service scaled for the cloud._
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
## ⚠ Important
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
<!--custom.important.start-->
<!--custom.important.end-->
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
## Code examples
Rearrange WRITEME to put prerequisites at the top of Code examples section (#4674) * Rearrange WRITEME to put prerequisites at the top of Code examples section. Run WRITEME over all Python services.
2023-04-13 11:38:14 -07:00
### Prerequisites
For prerequisites, see the [README](../../README.md#Prerequisites) 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
```
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
### Basics
Code examples that show you how to perform the essential operations within a service.
- [Learn the basics](kms_scenario.py)
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
### Single actions
Code excerpts that show you how to call individual service functions.
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
- [CreateAlias](alias_management.py#L89)
- [CreateGrant](grant_management.py#L38)
- [CreateKey](key_management.py#L39)
- [Decrypt](key_encryption.py#L66)
- [DeleteAlias](alias_management.py#L172)
- [DescribeKey](key_management.py#L110)
- [DisableKey](key_management.py#L175)
- [EnableKey](key_management.py#L156)
- [EnableKeyRotation](key_management.py#L216)
- [Encrypt](key_encryption.py#L37)
- [GenerateDataKey](key_management.py#L132)
- [GetKeyPolicy](key_policies.py#L62)
- [ListAliases](alias_management.py#L113)
- [ListGrants](grant_management.py#L67)
- [ListKeyPolicies](key_policies.py#L39)
- [ListKeys](key_management.py#L82)
- [PutKeyPolicy](key_policies.py#L91)
- [ReEncrypt](key_encryption.py#L88)
- [RetireGrant](grant_management.py#L95)
- [RevokeGrant](grant_management.py#L115)
- [ScheduleKeyDeletion](key_management.py#L189)
- [Sign](key_encryption.py#L123)
- [TagResource](key_management.py#L235)
- [UpdateAlias](alias_management.py#L143)
- [Verify](key_encryption.py#L147)
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
<!--custom.examples.start-->
<!--custom.examples.end-->
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
## Run the examples
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
### Instructions
<!--custom.instructions.start-->
<!--custom.instructions.end-->
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
#### Learn the basics
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
This example shows you how to do the following:
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
- 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.
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
- Generate an asymmetric key used to digitally sign data.
- Tag keys.
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
- Delete KMS keys.
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
<!--custom.basic_prereqs.kms_Scenario_Basics.start-->
<!--custom.basic_prereqs.kms_Scenario_Basics.end-->
Rearrange WRITEME to put prerequisites at the top of Code examples section (#4674) * Rearrange WRITEME to put prerequisites at the top of Code examples section. Run WRITEME over all Python services.
2023-04-13 11:38:14 -07:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
Start the example by running the following at a command prompt:
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
```
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
python kms_scenario.py
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
```
Python v3: Update READMEs in Python folder with WriteMe. (#5500) Updates to Python READMEs
2023-10-13 14:57:41 -05:00
Python: KMS, basics (#6963) * Started KMS scenario, 10 steps completed, working key policies.
2024-10-09 15:34:31 -04:00
<!--custom.basics.kms_Scenario_Basics.start-->
<!--custom.basics.kms_Scenario_Basics.end-->
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
### Tests
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
⚠ Running tests might result in charges to your AWS account.
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `python` folder.
<!--custom.tests.start-->
<!--custom.tests.end-->
## Additional resources
Tools: WRITEME for python (#5845) Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Update python/example_code/s3/README.md Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Added missing custom messages
2024-01-05 10:05:03 -05:00
- [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html)
- [AWS KMS API Reference](https://docs.aws.amazon.com/kms/latest/APIReference/Welcome.html)
- [SDK for Python AWS KMS reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kms.html)
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
<!--custom.resources.start-->
<!--custom.resources.end-->
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
---
Run WRITEME over all Python services to generated READMEs. (#4603) * Run WRITEME over all Python services to generated READMEs. * Editorial feedback. * Add string to 40-char allow list.
2023-03-31 05:36:53 -07:00
Python KMS examples, unit tests, SOS and README.
2021-12-10 16:21:49 -08:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
feat: integrate folder exclusion into writeme and fix validation issues - Add folder exclusion functionality to runner.py as a core feature - Support excluding multiple configurable folders (.kiro, .git, node_modules, __pycache__) - Add proper exit code handling to writeme.py wrapper - Fix malformed snippet-end tag in BatchActions.java - Update generated README files for KMS and Lambda services - Ensure proper validation error reporting
2025-07-25 14:05:34 -07:00
SPDX-License-Identifier: Apache-2.0
Reference in New Issue Copy Permalink