(arrow-rs) branch main updated: Improve docs for `AmazonS3Builder::from_env` (#6977)

[tustvold]

This is an automated email from the ASF dual-hosted git repository.

tustvold pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/main by this push:
     new 12a12355ef Improve docs for `AmazonS3Builder::from_env` (#6977)
12a12355ef is described below

commit 12a12355efa3809a3c3d6c7b12093850d372fb71
Author: Kyle Barron <k...@developmentseed.org>
AuthorDate: Wed Jan 15 00:27:02 2025 -0800

    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 <and...@nerdnetworks.org>
---
 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 d29fa782e8..29b2eefa80 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` -> 
<https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
     /// * `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;