Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 5.46 KB

README.md

File metadata and controls

94 lines (63 loc) · 5.46 KB
Raw

The AWS SDK for Rust Docs MSRV Usage Guide

This repo contains the new AWS SDK for Rust (the SDK) and its public roadmap.

Please Note: The SDK is currently released as a developer preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.

The SDK is code generated from Smithy models that represent each AWS service. The code used to generate the SDK can be found in smithy-rs.

Getting Started with the SDK

Examples are availble for many services and operations, check out the examples folder.

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

The SDK provides one crate per AWS service. You must add Tokio 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 your Cargo.toml file:

    [dependencies]
aws-config = "0.2.0"
aws-sdk-dynamodb = "0.2.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, and AWS_REGION
    • Web Identity Token credentials from the environment or container (including EKS)
    • The default credentials files located in ~/.aws/config and ~/.aws/credentials (location can vary per platform)
    • ECS Container Credentials (IAM roles for tasks)
    • EC2 Instance Metadata Service (IAM Roles attached to instance) Note: SSO is not supported yet.

  4. Make a request using DynamoDB

use aws_sdk_dynamodb::{Client, Error};

#[tokio::main]
async fn main() -> 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(())
}

Prerequisites

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.

Using the SDK

While we're working on the SDK, detailed usage instructions will be added to the Developer Guide. Please suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

Feedback and Contributing

Feedback

The SDK uses GitHub Issues to track feature requests and issues with the SDK. In addition, we use GitHub 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 a GitHub 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 in the Developer Preview launch.

Contributing

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

Supported Rust Versions (MSRV)

The SDK currently requires a minimum of Rust 1.54, and is not guaranteed to build on compiler versions earlier than that. While we are still in alpha, we will be keeping the minimum compiler version two releases behind the latest stable release where possible (so if the latest stable were 1.55, we would be on 1.53). However, we are not making any guarantees around this at present. Increases in minimum required Rust version will be called out in the Release Notes for new releases of the SDK.

Additional Resources

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.