Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

object_store: Add support for requester pays buckets #6768

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

object_store: Add support for requester pays buckets #6768

wants to merge 5 commits into from
+143 −2

Conversation

kylebarron
Copy link
Contributor

Which issue does this PR close?

Closes #6716.

Rationale for this change

Support for AWS S3 requester pays buckets. Open data is commonly provided through these buckets because it allows data providers to pay only for the cost of the data and not for the data egress.

What changes are included in this PR?

  • Add new public AmazonS3Builder::with_request_payer config option
  • Include the required header when authorizing and signing requests via the AwsAuthorizer

Are there any user-facing changes?

Addition of AmazonS3Builder::with_request_payer

@github-actions github-actions bot added the object-store Object Store Interface label Nov 21, 2024
@kylebarron
Copy link
Contributor Author

I also ran some manual testing locally to ensure it works end-to-end, but not sure if there's any place for them here

#[tokio::test]
async fn test_get_request_payer() {
    let client = AmazonS3Builder::new()
        .with_access_key_id("REDACTED")
        .with_secret_access_key("REDACTED")
        .with_bucket_name("naip-visualization")
        .with_region("us-west-2")
        .with_request_payer(true)
        .build()
        .unwrap();
    let resp = client.get(&"readme.txt".into()).await.unwrap();
    let buf = resp.bytes().await.unwrap();
    let s = String::from_utf8(buf.into()).unwrap();
    dbg!(s);
}

ran successfully and gave:

successes:

---- aws::client::tests::test_get_request_payer stdout ----
[src/aws/client.rs:908:9] s = "Visualization NAIP on AWS\n\nThe National Agriculture Imagery Program (NAIP) acquires aerial imagery during the agricultural growing seasons in the continental United States. This leaf-on imagery typically ranges from 60 centimeters to 100 centimeters in resolution. In the naip-visualization Amazon S3 bucket, you’ll find GeoTIFF 3-band RGB imagery at source resolution, which has been compressed, tiled, and cloud-optimized. This data is useful as source for background imagery, or to use to download a subsampled version of the original.\n\nNAIP is administered by t
...

and

#[tokio::test]
async fn test_signed_get_request_payer() {
    let client = AmazonS3Builder::new()
        .with_access_key_id("REDACTED")
        .with_secret_access_key("REDACTED")
        .with_bucket_name("naip-visualization")
        .with_region("us-west-2")
        .with_request_payer(true)
        .build()
        .unwrap();
    let url = client
        .signed_url(Method::GET, &"readme.txt".into(), Duration::from_secs(60))
        .await
        .unwrap();
    dbg!(url.to_string());
}

gave

https://s3.us-west-2.amazonaws.com/naip-visualization/readme.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=REDACTED%2F20241121%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241121T131723Z&X-Amz-Expires=60&X-Amz-SignedHeaders=host&x-amz-request-payer=requester&X-Amz-Signature=8b9b548bd41b24a0cdf8eacfbccb3364472efdf5ebf5d9cf943e7c6c23e1d3be

which also worked:
image

@kylebarron
Copy link
Contributor Author

I don't think the CI failure is related to my changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
object-store Object Store Interface
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support for AWS Requester Pays buckets
1 participant
@kylebarron