awslabs / awslabs/aws-sdk-rust

S3 CreateBucketOutput location() returns a URL rather than the bucket name

Open
#732 2 comments 0 reactions 0 assignees View on GitHub
documentation p2
Dominant language
Rust
Stars
3.3k
Forks
290
Avg merge
1d 12h
Merged PRs (30d)
3

Description

### Describe the issue

The documentation states `location()` returns: "A forward slash followed by the name of the bucket.". This should be updated to match the current behavior when creating an S3 bucket:
```
let constraint = BucketLocationConstraint::from("eu-west-1");
let cfg = CreateBucketConfiguration::builder()
.location_constraint(constraint)
.build();

let resp = client.create_bucket()
.bucket("my-test-bucket")
.create_bucket_configuration(cfg)
.send()
.await?;

println!("{}", resp.location().unwrap());
```
The output is:
```
http://my-test-bucket.s3.amazonaws.com/
```

### Links

https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/output/struct.CreateBucketOutput.html#method.location

Contributor guide

Open the contributing guide

Research direction

Start with the linked docs.rs page for aws_sdk_s3::output::CreateBucketOutput::location and compare its stated return value with the reproduced S3 output. Update the documentation to describe the observed URL behavior, then verify the rendered API documentation reflects the correction.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, rust
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.