Crate aws_sdk_dynamodb

source ·
Expand description

Please Note: The SDK is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don’t have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables’ throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-dynamodb to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = "0.55.3"
aws-sdk-dynamodb = "0.28.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_dynamodb as dynamodb;

#[::tokio::main]
async fn main() -> Result<(), dynamodb::Error> {
    let config = ::aws_config::load_from_env().await;
    let client = dynamodb::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

Crate Organization

The entry point for most customers will be Client, which exposes one method for each API offered by Amazon DynamoDB. The return value of each of these methods is a “fluent builder”, where the different inputs for that API are added by builder-style function call chaining, followed by calling send() to get a Future that will result in either a successful output or a SdkError.

Some of these API inputs may be structs or enums to provide more complex structured information. These structs and enums live in types. There are some simpler types for representing data such as date times or binary blobs that live in primitives.

All types required to configure a client via the Config struct live in config.

The operation module has a submodule for every API, and in each submodule is the input, output, and error type for that API, as well as builders to construct each of those.

There is a top-level Error type that encompasses all the errors that the client can return. Any other error type can be converted to this Error type via the From trait.

The other modules within this crate are not required for normal usage.

Examples

Examples can be found here.

Modules

  • client
    Client for calling Amazon DynamoDB.
  • config
    Configuration for Amazon DynamoDB.
  • endpoint
    Endpoint resolution functionality.
  • error
    Common errors and error handling utilities.
  • meta
    Information about this crate.
  • middleware
    Base Middleware Stack
  • operation
    All operations that this crate can perform.
  • primitives
    Primitives such as Blob or DateTime used by other types.
  • types
    Data structures used by operation inputs/outputs.

Structs

Enums

  • Error
    All possible error types for this service.