Repository files navigation

This repo contains the AWS SDK for Rust and itspublic roadmap.

The SDK is code generated fromSmithy models that represent each AWS service.The code used to generate the SDK can be found insmithy-rs.

Examples are available for many services and operations, check out theexamples folder.

For a step-by-step guide including several advanced use cases, check out theDeveloper Guide.

The SDK provides one crate per AWS service. You must addTokio as a dependency within your Rust project to execute asynchronous code.

1. Create a new Rust project:cargo new sdk-example

2. Add dependencies to DynamoDB and Tokio to yourCargo.toml file:

   [dependencies]aws-config = {version="1.6.0",features = ["behavior-version-latest"] }aws-sdk-dynamodb ="1.69.0"tokio = {version ="1",features = ["full"] }

3. Provide your AWS credentials with the default credential provider chain, which currently looks in:

   • Environment variables:AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY, andAWS_REGION
   • The default credentials files located in~/.aws/config and~/.aws/credentials (location can vary per platform)
   • Web Identity Token credentials from the environment or container (including EKS)
   • ECS Container Credentials (IAM roles for tasks)
   • EC2 Instance Metadata Service (IAM Roles attached to instance)

4. Make a request using DynamoDB

use aws_sdk_dynamodb::{Client,Error};#[tokio::main]asyncfnmain() ->Result<(),Error>{let shared_config = aws_config::load_from_env().await;let client =Client::new(&shared_config);let req = client.list_tables().limit(10);let resp = req.send().await?;println!("Current DynamoDB tables: {:?}", resp.table_names);Ok(())}

In order to use the SDK, you must already have Rust and Cargo installed. If you don't,these instructions describe how to install Rust and Cargo.

Detailed usage instructions are available in theDeveloper Guide.Suggestions for additional sections or improvements for the guide are welcome. Please open an issue describing what you are trying to do.

• Developer Guide
• GitHub discussions - For ideas, RFCs & general questions
• GitHub issues – For bug reports & feature requests
• Generated Docs (latest version)
• Usage examples

The SDK usesGitHub Issues to track feature requests and issues with the SDK. In addition, we useGitHub Projects to provide users with a high level view of our roadmap and the features we're actively working on.

You can provide feedback or report a bug by submitting aGitHub issue.This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc.Issues you open will be evaluated for our roadmap.

If you are interested in contributing to the SDK, please take a look atCONTRIBUTING

The SDK currently requires a minimum of Rust 1.81.0, and is not guaranteed to build on compiler versionsearlier than that. We keep the minimum compiler version two releases behind the latest stable release wherepossible (so if the latest stable were 1.55, we would support 1.53). Increases in minimum required Rustversion will be called out in the Release Notes for new releases of the SDK.

• Design docs - Design documentation for the SDK lives in thedesign folder of smithy-rs.
• Runtime / Handwritten code: The Rust Runtime code that underpins the SDK can be accessedhere andhere. This code is copied into this repo as part of code generation.
• Code Examples
• API reference documentation (rustdoc)

SeeCONTRIBUTING for more information.

This project is licensed under the Apache-2.0 License.