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
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
# ACM code examples for the SDK for Python
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
## Overview
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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 Certificate Manager (ACM).
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
<!--custom.overview.start-->
<!--custom.overview.end-->
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
_ACM helps you to provision, manage, and renew publicly trusted TLS certificates on AWS based websites._
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08: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/).
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08: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-->
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Added snippet tags for Python examples of some services and cleaned up READMEs.
2021-07-28 17:38:03 -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-->
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
### Basics
Code examples that show you how to perform the essential operations within a service.
- [Learn the basics](certificate_basics.py)
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
### Single actions
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
Code excerpts that show you how to call individual service functions.
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
- [AddTagsToCertificate](certificate_basics.py#L168)
- [DeleteCertificate](certificate_basics.py#L152)
- [DescribeCertificate](certificate_basics.py#L37)
- [GetCertificate](certificate_basics.py#L61)
- [ImportCertificate](certificate_basics.py#L128)
- [ListCertificates](certificate_basics.py#L80)
- [ListTagsForCertificate](certificate_basics.py#L189)
- [RemoveTagsFromCertificate](certificate_basics.py#L211)
- [RequestCertificate](certificate_basics.py#L242)
- [ResendValidationEmail](certificate_basics.py#L293)
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
<!--custom.examples.start-->
<!--custom.examples.end-->
Added snippet tags for Python examples of some services and cleaned up READMEs.
2021-07-28 17:38:03 -07:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
## Run the examples
Added snippet tags for Python examples of some services and cleaned up READMEs.
2021-07-28 17:38:03 -07:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
### Instructions
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
<!--custom.instructions.start-->
<!--custom.instructions.end-->
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Updates to WRITEME to get ready for internal beta release. (#4297) * Fix mixed slashes in paths. * Fix a link and update README per feedback. * Improve -h output.
2023-01-25 07:40:26 -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
#### Learn the basics
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
This example shows you how to do the following:
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
- Request a certificate from ACM.
- Import a self-signed certificate.
- List and describe certificates.
- Remove certificates.
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
<!--custom.basic_prereqs.acm_Usage_ImportListRemove.start-->
<!--custom.basic_prereqs.acm_Usage_ImportListRemove.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
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
Start the example by running the following at a command prompt:
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
```
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
python certificate_basics.py
```
Python v3: Update READMEs in Python folder with WriteMe. (#5500) Updates to Python READMEs
2023-10-13 14:57:41 -05: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
<!--custom.basics.acm_Usage_ImportListRemove.start-->
<!--custom.basics.acm_Usage_ImportListRemove.end-->
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
### Tests
⚠ Running tests might result in charges to your AWS account.
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `python` folder.
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -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
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
<!--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
- [ACM User Guide](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html)
- [ACM API Reference](https://docs.aws.amazon.com/acm/latest/APIReference/Welcome.html)
- [SDK for Python ACM reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/acm.html)
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
<!--custom.resources.start-->
<!--custom.resources.end-->
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
---
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
AWS Certificate Manager (ACM) basic examples.
2020-11-16 17:28:48 -08:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Draft version of WRITEME, a tool to automatically generate READMEs (#4265) * Draft version of WRITEME, a tool to automatically generate READMEs from metadata and templates. Add requirements.txt to updated READMEs that refer to them. * Fix YAML linting error. Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>
2023-01-20 12:38:24 -08:00
SPDX-License-Identifier: Apache-2.0
Reference in New Issue Copy Permalink