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
# Amazon SQS code examples for the SDK for Python
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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 Amazon Simple Queue Service (Amazon SQS).
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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-->
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
_Amazon SQS is a fully managed message queuing service that makes it easy to decouple and scale microservices, distributed systems, and serverless applications._
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-->
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -08:00
Python SQS examples: added snippets tags, SOS data, and updated README.
2021-10-22 16:15:10 -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 SQS examples: added snippets tags, SOS data, and updated README.
2021-10-22 16:15:10 -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
Code excerpts that show you how to call individual service functions.
Python SQS examples: added snippets tags, SOS data, and updated README.
2021-10-22 16:15:10 -07: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
- [CreateQueue](queue_wrapper.py#L23)
- [DeleteMessage](message_wrapper.py#L132)
- [DeleteMessageBatch](message_wrapper.py#L153)
- [DeleteQueue](queue_wrapper.py#L95)
- [GetQueueUrl](queue_wrapper.py#L50)
- [ListQueues](queue_wrapper.py#L71)
- [ReceiveMessage](message_wrapper.py#L100)
- [SendMessage](message_wrapper.py#L24)
- [SendMessageBatch](message_wrapper.py#L52)
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
### Scenarios
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
Renamed metadata.yaml to .metadata.yaml. Updated READMEs to common format.
2020-09-14 18:25:50 -07:00
Tools: writeme check for unmanaged folders logic remains wrong. (#6759)
2024-08-27 14:32:38 -04:00
- [Create a messenger application](../../cross_service/stepfunctions_messenger)
- [Create an Amazon Textract explorer application](../../cross_service/textract_explorer)
Rewrite scanner to use -tools (#6601)
2024-07-11 16:17:29 -04:00
- [Create and publish to a FIFO topic](../sns/sns_fifo_topic.py)
Remove add_services metadata (#7258) This is only used inconsistently in cross_metadata, and will be simplified if we remove it.
2025-02-24 16:56:43 -05:00
- [Detect people and objects in a video](../../example_code/rekognition)
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
- [Send and receive batches of messages](message_wrapper.py)
Renamed metadata.yaml to .metadata.yaml. Updated READMEs to common format.
2020-09-14 18:25:50 -07: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-->
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
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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
Added common test_tools to centralize common fixtures and stubbers. Refactored SQS tests to use the test_tools. Added usage_demo functions to SQS modules.
2020-04-22 17:36:41 -07:00
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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-->
<!--custom.instructions.end-->
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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
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
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 messenger application
This example shows you how to create an AWS Step Functions messenger application that retrieves message records from a database table.
<!--custom.scenario_prereqs.cross_StepFunctionsMessenger.start-->
<!--custom.scenario_prereqs.cross_StepFunctionsMessenger.end-->
<!--custom.scenarios.cross_StepFunctionsMessenger.start-->
<!--custom.scenarios.cross_StepFunctionsMessenger.end-->
#### Create an Amazon Textract explorer application
This example shows you how to explore Amazon Textract output through an interactive application.
<!--custom.scenario_prereqs.cross_TextractExplorer.start-->
<!--custom.scenario_prereqs.cross_TextractExplorer.end-->
<!--custom.scenarios.cross_TextractExplorer.start-->
<!--custom.scenarios.cross_TextractExplorer.end-->
Rewrite scanner to use -tools (#6601)
2024-07-11 16:17:29 -04:00
#### Create and publish to a FIFO topic
This example shows you how to create and publish to a FIFO Amazon SNS topic.
<!--custom.scenario_prereqs.sns_PublishFifoTopic.start-->
<!--custom.scenario_prereqs.sns_PublishFifoTopic.end-->
Start the example by running the following at a command prompt:
```
python ../sns/sns_fifo_topic.py
```
<!--custom.scenarios.sns_PublishFifoTopic.start-->
<!--custom.scenarios.sns_PublishFifoTopic.end-->
Remove add_services metadata (#7258) This is only used inconsistently in cross_metadata, and will be simplified if we remove it.
2025-02-24 16:56:43 -05:00
#### Detect people and objects in a video
This example shows you how to detect people and objects in a video with Amazon Rekognition.
<!--custom.scenario_prereqs.cross_RekognitionVideoDetection.start-->
<!--custom.scenario_prereqs.cross_RekognitionVideoDetection.end-->
<!--custom.scenarios.cross_RekognitionVideoDetection.start-->
<!--custom.scenarios.cross_RekognitionVideoDetection.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
#### Send and receive batches of messages
This example shows you how to do the following:
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 an Amazon SQS queue.
- Send batches of messages to the queue.
- Receive batches of messages from the queue.
- Delete batches of messages from the queue.
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
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
<!--custom.scenario_prereqs.sqs_Scenario_SendReceiveBatch.start-->
<!--custom.scenario_prereqs.sqs_Scenario_SendReceiveBatch.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
Start the example by running the following at a command prompt:
```
python message_wrapper.py
Python SQS examples: added snippets tags, SOS data, and updated README.
2021-10-22 16:15:10 -07:00
```
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -08:00
Python v3: Update READMEs in Python folder with WriteMe. (#5500) Updates to Python READMEs
2023-10-13 14:57:41 -05: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.scenarios.sqs_Scenario_SendReceiveBatch.start-->
<!--custom.scenarios.sqs_Scenario_SendReceiveBatch.end-->
### Tests
⚠ Running tests might result in charges to your AWS account.
Added SQS API coverage for SQS queue and message operations. Added unit tests using pytest and Botocore Stubber. Passed pylint. Added readme and metadata.
2020-01-13 09:49:45 -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
- [Amazon SQS Developer Guide](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html)
- [Amazon SQS API Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html)
- [SDK for Python Amazon SQS reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.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-->
Added common test_tools to centralize common fixtures and stubbers. Refactored SQS tests to use the test_tools. Added usage_demo functions to SQS modules.
2020-04-22 17:36:41 -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
Added common test_tools to centralize common fixtures and stubbers. Refactored SQS tests to use the test_tools. Added usage_demo functions to SQS modules.
2020-04-22 17:36:41 -07:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Remove add_services metadata (#7258) This is only used inconsistently in cross_metadata, and will be simplified if we remove it.
2025-02-24 16:56:43 -05:00
SPDX-License-Identifier: Apache-2.0
Reference in New Issue Copy Permalink