From 12a12355efa3809a3c3d6c7b12093850d372fb71 Mon Sep 17 00:00:00 2001 From: Kyle Barron Date: Wed, 15 Jan 2025 00:27:02 -0800 Subject: [PATCH] Improve docs for `AmazonS3Builder::from_env` (#6977) * Improve docs for `AmazonS3Builder::from_env` * wording * Update object_store/src/aws/builder.rs --------- Co-authored-by: Andrew Lamb --- object_store/src/aws/builder.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/object_store/src/aws/builder.rs b/object_store/src/aws/builder.rs index d29fa782e8ff..29b2eefa8021 100644 --- a/object_store/src/aws/builder.rs +++ b/object_store/src/aws/builder.rs @@ -427,7 +427,11 @@ impl AmazonS3Builder { /// Fill the [`AmazonS3Builder`] with regular AWS environment variables /// - /// Variables extracted from environment: + /// All environment variables starting with `AWS_` will be evaluated. Names must + /// match acceptable input to [`AmazonS3ConfigKey::from_str`]. Only upper-case environment + /// variables are accepted. + /// + /// Some examples of variables extracted from environment: /// * `AWS_ACCESS_KEY_ID` -> access_key_id /// * `AWS_SECRET_ACCESS_KEY` -> secret_access_key /// * `AWS_DEFAULT_REGION` -> region @@ -435,6 +439,7 @@ impl AmazonS3Builder { /// * `AWS_SESSION_TOKEN` -> token /// * `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` -> /// * `AWS_ALLOW_HTTP` -> set to "true" to permit HTTP connections without TLS + /// * `AWS_REQUEST_PAYER` -> set to "true" to permit operations on requester-pays buckets. /// # Example /// ``` /// use object_store::aws::AmazonS3Builder;