awsdocs / aws-doc-sdk-examples

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.
Apache License 2.0
9.57k stars 5.63k forks source link

[Enhancement]: Code examples for drivers/plugins/tools built on the AWS SDK #3968

Open bartolm opened 1 year ago

bartolm commented 1 year ago

Background story

Some AWS service teams provide an open-source layer (such as a driver, plugin, tool, etc) built on top of the AWS SDK that enhances interaction with the service's low-level API. In the case of Amazon QLDB, customers use the service's data API to run transactions in their database resource. The QLDB service team doesn't recommend using the data API directly through an AWS SDK because it involves some complex processing logic to successfully make API calls. Instead, they provide an open-source driver (in multiple languages) to streamline interaction with the QLDB data API.

In addition, some service teams (like QLDB) also provide open-source code examples in the form of sample applications in a separate GitHub repository such as aws-samples. It would be great if our AWS SDK code examples library could source code examples directly from other GitHub repo's as well.

What does this example accomplish?

These code examples for QLDB would demonstrate how to run various data transactions on a ledger database by using a QLDB driver, since the QLDB service team doesn't recommend using the data API directly through an AWS SDK. The data transactions would include basic CRUD operations such as:

Which AWS service(s)?

Amazon QLDB

Which AWS SDKs or tools?

Are there existing code examples to leverage?

Java sample app in the aws-samples GitHub repo: https://github.com/aws-samples/amazon-qldb-dmv-sample-java (also available for Node.js and Python)

Inline Java code examples in the QLDB Developer Guide (also available for .NET, Go, Node.js, and Python):

Do you have any reference code?

No response

brmur commented 1 year ago

@aaronmarkham tagging for awareness

github-actions[bot] commented 1 year ago

Marked stale by the Shirriff. Notifying @awsdocs/aws-sdk-docs-code-maintainers

Laren-AWS commented 1 year ago

The "curated example" feature addresses this. I have a PR (https://github.com/awsdocs/aws-doc-sdk-examples/pull/4186) to get this started. Once that's merged, we can add some metadata to publish QLDB examples and refine as we go.