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
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
# API Gateway code examples for the SDK for Python
## Overview
Shows how to use the AWS SDK for Python (Boto3) to work with Amazon API Gateway.
<!--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
_API Gateway enables you to create and deploy your own REST and WebSocket APIs at any scale._
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-->
## 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-->
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
Code excerpts that show you how to call individual service functions.
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
- [CreateDeployment](aws_service/aws_service.py#L189)
- [CreateResource](aws_service/aws_service.py#L77)
- [CreateRestApi](aws_service/aws_service.py#L43)
- [DeleteRestApi](aws_service/aws_service.py#L260)
- [GetResources](aws_service/aws_service.py#L25)
- [GetRestApis](aws_service/aws_service.py#L231)
- [PutIntegration](aws_service/aws_service.py#L100)
- [PutIntegrationResponse](aws_service/aws_service.py#L25)
- [PutMethod](aws_service/aws_service.py#L25)
- [PutMethodResponse](aws_service/aws_service.py#L25)
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
### Scenarios
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
Tools: writeme check for unmanaged folders logic remains wrong. (#6759)
2024-08-27 14:32:38 -04:00
- [Create a REST API to track COVID-19 data](../../cross_service/apigateway_covid-19_tracker)
- [Create a lending library REST API](../../cross_service/aurora_rest_lending_library)
- [Create a websocket chat application](../../cross_service/apigateway_websocket_chat)
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 and deploy a REST API](aws_service/aws_service.py)
Tools: writeme check for unmanaged folders logic remains wrong. (#6759)
2024-08-27 14:32:38 -04:00
- [Use API Gateway to invoke a Lambda function](../../example_code/lambda)
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-->
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
### Instructions
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-->
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
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 REST API to track COVID-19 data
This example shows you how to create a REST API that simulates a system to track daily cases of COVID-19 in the United States, using fictional data.
<!--custom.scenario_prereqs.cross_ApiGatewayDataTracker.start-->
<!--custom.scenario_prereqs.cross_ApiGatewayDataTracker.end-->
<!--custom.scenarios.cross_ApiGatewayDataTracker.start-->
<!--custom.scenarios.cross_ApiGatewayDataTracker.end-->
#### 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-->
#### Create a websocket chat application
This example shows you how to create a chat application that is served by a websocket API built on Amazon API Gateway.
<!--custom.scenario_prereqs.cross_ApiGatewayWebsocketChat.start-->
<!--custom.scenario_prereqs.cross_ApiGatewayWebsocketChat.end-->
<!--custom.scenarios.cross_ApiGatewayWebsocketChat.start-->
<!--custom.scenarios.cross_ApiGatewayWebsocketChat.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
#### Create and deploy a REST API
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 a REST API served by API Gateway.
- Add resources to the REST API to represent a user profile.
- Add integration methods so that the REST API uses a DynamoDB table to store user profile data.
- Send HTTP requests to the REST API to add and retrieve user profiles.
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
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.api-gateway_Usage_CreateDeployRest.start-->
<!--custom.scenario_prereqs.api-gateway_Usage_CreateDeployRest.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
Start the example by running the following at a command prompt:
```
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
python aws_service/aws_service.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
```
Python v3: Update READMEs in Python folder with WriteMe. (#5500) Updates to Python READMEs
2023-10-13 14:57:41 -05: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.scenarios.api-gateway_Usage_CreateDeployRest.start-->
For additional instructions on how to set up and run this example, see the
[README](aws_service/README.md) in the `aws_service` folder.
<!--custom.scenarios.api-gateway_Usage_CreateDeployRest.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
#### Use API Gateway to invoke a Lambda function
This example shows you how to create an AWS Lambda function invoked by Amazon API Gateway.
<!--custom.scenario_prereqs.cross_LambdaAPIGateway.start-->
<!--custom.scenario_prereqs.cross_LambdaAPIGateway.end-->
<!--custom.scenarios.cross_LambdaAPIGateway.start-->
<!--custom.scenarios.cross_LambdaAPIGateway.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.
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.
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
- [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)
- [API Gateway API Reference](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)
- [SDK for Python API Gateway reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.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-->
---
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
Reference in New Issue Copy Permalink