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 1 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
# Secrets Manager code examples for the SDK for Python
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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 Secrets Manager.
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
<!--custom.overview.start-->
<!--custom.overview.end-->
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -08:00
Python - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -05:00
_Secrets Manager helps you to securely encrypt, store, and retrieve credentials for your databases and other services._
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -08:00
## ⚠ Important
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -08:00
Python - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -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).
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
<!--custom.important.start-->
<!--custom.important.end-->
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
## 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-->
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
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -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
Code excerpts that show you how to call individual service functions.
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -08:00
Tools: Writeme canonical titles (#6382) * Fix some WRITEME issues and generate titles for Actions: * Open files with utf-8 encoding. * Case-insensitive README filename comparison. * Render titles for actions in READMEs. * Fixed WRITEME to check for combined language and version. * Remove case-insensitive README lookup, rename wrong case Readme.md to README.md.
2024-04-30 12:22:08 -07:00
- [BatchGetSecretValue](batch_get_secret_value.py#L17)
- [GetSecretValue](get_secret_value.py#L16)
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -08:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release.
2024-08-21 13:27:36 -07:00
### Scenarios
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -08:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release.
2024-08-21 13:27:36 -07:00
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
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 - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -05:00
- [Create a lending library REST API](../../cross_service/aurora_rest_lending_library)
<!--custom.examples.start-->
<!--custom.examples.end-->
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -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
## Run the examples
### Instructions
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
<!--custom.instructions.start-->
Python - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -05:00
To use these examples, first deploy the secrets to AWS using [this CDK stack](../../../resources/cdk/secrets-manager).
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
Python - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -05:00
Next, after pulling AWS credentials, run one of the following commands:
* `python3 scenario_get_secret.py`
* `python3 scenario_get_batch_secrets.py`
<!--custom.instructions.end-->
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -08:00
Python Secrets Manager SOS data, snippet tags, and README update. (#2379) Co-authored-by: Irene Smith <73654695+irenepsmith@users.noreply.github.com>
2021-11-15 09:40:17 -08:00
SOS: Recategorize examples REQUIRES TANDEM INTERNAL MERGE (#6754) * Recategorize Scenarios as Basics where appropriate. * Remove titles from Basics examples. * Refactor SOS templates for recategorization. * Add basics to WRITEME code and templates. * Run WRITEME for recategorization. * Update validate-doc-metadata to tagged release.
2024-08-21 13:27:36 -07:00
#### Create a lending library REST API
This example shows you how to create a lending library where patrons can borrow and return books by using a REST API backed by an Amazon Aurora database.
<!--custom.scenario_prereqs.cross_AuroraRestLendingLibrary.start-->
<!--custom.scenario_prereqs.cross_AuroraRestLendingLibrary.end-->
<!--custom.scenarios.cross_AuroraRestLendingLibrary.start-->
<!--custom.scenarios.cross_AuroraRestLendingLibrary.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
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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.
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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.
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
<!--custom.tests.start-->
<!--custom.tests.end-->
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
## Additional resources
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -08:00
Python - Secrets Manager - Add get_secret_value and batch single actions (#5809) * Updates * adding tests * adding tests * adding tests * adding tests * adding tests * adding tests * YAMLinting * a few improvements upon futher consideration * black * Update .doc_gen/metadata/secrets-manager_metadata.yaml Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/batch_get_secret_value.py Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Update python/example_code/secretsmanager/requirements.txt Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com> * Refactoring * More refactors * Tests updated * Tests updated * Template * Template * metadata updates * integ * README update * linting --------- Co-authored-by: Laren-AWS <57545972+Laren-AWS@users.noreply.github.com>
2024-01-08 09:55:55 -05:00
- [Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
- [Secrets Manager API Reference](https://docs.aws.amazon.com/secretsmanager/latest/apireference/Welcome.html)
- [SDK for Python Secrets Manager reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html)
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
<!--custom.resources.start-->
<!--custom.resources.end-->
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -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
AWS Secrets Manager example Create and manage secrets, use an existing secret to access an Amazon Aurora database cluster.
2021-01-26 17:16:18 -08:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
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
SPDX-License-Identifier: Apache-2.0
Reference in New Issue Copy Permalink