From 1c55b703d0510f4f355ac10953ef18ff7ddfc9cc Mon Sep 17 00:00:00 2001 From: Doug Schwartz Date: Wed, 16 Jun 2021 13:17:00 -0700 Subject: [PATCH] Added doc comment to STS credentials-provider code example --- aws/sdk/examples/sts/src/bin/credentials-provider.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/aws/sdk/examples/sts/src/bin/credentials-provider.rs b/aws/sdk/examples/sts/src/bin/credentials-provider.rs index fdaead636d1..26a6a0a9cac 100644 --- a/aws/sdk/examples/sts/src/bin/credentials-provider.rs +++ b/aws/sdk/examples/sts/src/bin/credentials-provider.rs @@ -8,6 +8,8 @@ use std::sync::{Arc, Mutex}; use std::time::{Duration, SystemTime}; use sts::Credentials; +/// Implements a basic version of ProvideCredentials with AWS STS +/// and lists the tables in the region based on those credentials. #[tokio::main] async fn main() -> Result<(), dynamodb::Error> { tracing_subscriber::fmt::init(); @@ -26,7 +28,7 @@ async fn main() -> Result<(), dynamodb::Error> { Ok(()) } -/// This is a rough example of how you could implement ProvideCredentials with Sts +/// This is a rough example of how you could implement ProvideCredentials with Amazon STS. /// /// Do not use this in production! A high quality implementation is in the roadmap. #[derive(Clone)]