aws-sdk-ec2

This is the Amazon EC2 API Reference. It provides descriptions, API request parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.

Learn more

• To learn about using the Query API, see Using the API for Amazon EC2.
• To learn about the permissions required to call an Amazon EC2 API action, see Actions, resources, and condition keys for Amazon EC2.
• To get the list of API actions by service and resource, see Actions by service.
• To get the alphabetical list of API actions, see .
• To get descriptions of the API error codes, see Error codes for the Amazon EC2 API.

Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using the Query API directly:

• Amazon Web Services CLI Command Reference - ec2 commands
• CloudFormation - Amazon EC2 resource type reference
• Amazon Web Services Tools for PowerShell Cmdlet Reference - Amazon EC2 cmdlets
• Amazon Web Services SDKs

Getting Started

Examples are available for many services and operations, check out the usage examples.

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-ec2 to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-ec2 = "1.228.0"
tokio = { version = "1", features = ["full"] }

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

use aws_sdk_ec2 as ec2;

#[::tokio::main]
async fn main() -> Result<(), ec2::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_ec2::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

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

License

This project is licensed under the Apache-2.0 License.