Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rust: Move running the code instructions to a more prominent location. #5477

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Rust: Move running the code instructions to a more prominent location. #5477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions rust_dev_preview/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,19 @@ The WebAssembly example shows how to use the AWS SDK for Rust within a WASM runt

## Running the code examples

Each example has one or more examples that can be executed with `cargo run --bin [program name]`.
See the individual readme files in each service directory for information about specific code examples for that service.

Unit tests for each example can be run with `cargo test`, and these will not cause any changes or charges to your AWS account.
Integration tests may cause changes or charges to your AWS account, and are described individually for each example.
However, they can be run with `cargo test -- --ignored`.

### Prerequisites

You must have an AWS account, and have configured your default credentials and AWS Region as described in [Getting started with the AWS SDK for Rust](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/getting-started.html).

You must have the [Cargo](https://doc.rust-lang.org/cargo/) build tool, which is typically installed via [rustup](https://rustup.rs/).

### Environment variables

These examples use `tracing_subscriber` with `env_filter` to print information about various information as the example runs. Because the AWS SDK for Rust and many crates used in these examples use `tracing` for structured logging, it is important to have an understanding of the `RUST_LOG` variable.
Expand Down Expand Up @@ -70,19 +83,6 @@ The following environment variables are specific to the AWS SDK for Rust.

- `AWS_SDK_UA_APP_ID` specifies an additional app name that will be present in the User-Agent header for every SDK request.

### Prerequisites

You must have an AWS account, and have configured your default credentials and AWS Region as described in [Getting started with the AWS SDK for Rust](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/getting-started.html).

You must have the [Cargo](https://doc.rust-lang.org/cargo/) build tool, which is typically installed via [rustup](https://rustup.rs/).

Each example has one or more examples that can be executed with `cargo run --bin [program name]`.
See the individual readme files in each service directory for information about specific code examples for that service.

Unit tests for each example can be run with `cargo test`, and these will not cause any changes or charges to your AWS account.
Integration tests may cause changes or charges to your AWS account, and are described individually for each example.
However, they can be run with `cargo test -- --ignored`.

## Resources

- [AWS SDK for Rust repo](https://github.com/awslabs/aws-sdk-rust)
Expand Down
Loading