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
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
# Amazon Keyspaces code examples for the SDK for Python
## Overview
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 Keyspaces (for Apache Cassandra).
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
<!--custom.overview.start-->
<!--custom.overview.end-->
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
_Amazon Keyspaces is a scalable, highly available, and managed Apache Cassandra-compatible database service._
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
## ⚠ 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/).
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
* Running the 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
* 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).
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
* 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).
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-->
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29: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-->
Incorporated edits and feedback.
2022-10-28 16:25:02 -07:00
### Get started
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
- [Hello Amazon Keyspaces](hello.py#L4) (`ListKeyspaces`)
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
### Basics
Code examples that show you how to perform the essential operations within a service.
- [Learn the basics](scenario_get_started_keyspaces.py)
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07: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
- [CreateKeyspace](keyspace.py#L32)
- [CreateTable](keyspace.py#L109)
- [DeleteKeyspace](keyspace.py#L277)
- [DeleteTable](keyspace.py#L256)
- [GetKeyspace](keyspace.py#L57)
- [GetTable](keyspace.py#L147)
- [ListKeyspaces](keyspace.py#L86)
- [ListTables](keyspace.py#L177)
- [RestoreTable](keyspace.py#L224)
- [UpdateTable](keyspace.py#L199)
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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-->
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07: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
<!--custom.instructions.start-->
<!--custom.instructions.end-->
#### Hello Amazon Keyspaces
This example shows you how to get started using Amazon Keyspaces.
```
Python - Formatting: Runs black formatter on all files (#6596) * black formatting
2024-07-03 17:16:21 -04:00
python hello.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
```
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
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
This example shows you how to do the following:
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
- Create a keyspace and table. The table schema holds movie data and has point-in-time recovery enabled.
- Connect to the keyspace using a secure TLS connection with SigV4 authentication.
- Query the table. Add, retrieve, and update movie data.
- Update the table. Add a column to track watched movies.
- Restore the table to its previous state and clean up resources.
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
<!--custom.basic_prereqs.keyspaces_Scenario_GetStartedKeyspaces.start-->
<!--custom.basic_prereqs.keyspaces_Scenario_GetStartedKeyspaces.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
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
Start the example by running the following at a command prompt:
```
python scenario_get_started_keyspaces.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.keyspaces_Scenario_GetStartedKeyspaces.start-->
<!--custom.basics.keyspaces_Scenario_GetStartedKeyspaces.end-->
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -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
### Tests
⚠ Running tests might result in charges to your AWS account.
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
To find instructions for running these tests, see the [README](../../README.md#Tests)
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
in the `python` folder.
<!--custom.tests.start-->
<!--custom.tests.end-->
Python Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07:00
## Additional resources
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
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 Keyspaces Developer Guide](https://docs.aws.amazon.com/keyspaces/latest/devguide/what-is-keyspaces.html)
- [Amazon Keyspaces API Reference](https://docs.aws.amazon.com/keyspaces/latest/APIReference/Welcome.html)
- [SDK for Python Amazon Keyspaces reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/keyspaces.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 Keyspaces get started scenario and actions. Fix link in README.
2022-10-24 17:29:03 -07: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