aws-sdk-networkflowmonitor

Crates.ioaws-sdk-networkflowmonitor
lib.rsaws-sdk-networkflowmonitor
version1.1.0
sourcesrc
created_at2024-12-02 04:54:17.079503
updated_at2024-12-04 06:56:07.8313
descriptionAWS SDK for Network Flow Monitor
homepage
repositoryhttps://github.com/awslabs/aws-sdk-rust
max_upload_size
id1468260
size1,999,687
AWS SDK Rust Bot (aws-sdk-rust-ci)

documentation

README

aws-sdk-networkflowmonitor

Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.

In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.

To learn more about Network Flow Monitor, see the Network Flow Monitor User Guide in the Amazon CloudWatch User Guide.

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

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

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

use aws_sdk_networkflowmonitor as networkflowmonitor;

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

License

This project is licensed under the Apache-2.0 License.

Commit count: 1103

cargo fmt