Skip to content

Commit

Permalink
Update README.md (#656)
Browse files Browse the repository at this point in the history
* Update README.md

Add example for working with public buckets that require "--no-sign-request"

* Apply suggestions from code review

---------

Co-authored-by: mattBrzezinski <[email protected]>
  • Loading branch information
alex-s-gardner and mattBrzezinski authored Aug 21, 2023
1 parent d10c5a4 commit 100c30e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ using AWS: @service
S3.list_objects("your-bucket") # note: no '/' in front of bucket name
```

Working with public buckets that require "--no-sign-request", e.g. [copernicus data](https://registry.opendata.aws/copernicus-dem/), you'll need to set AWS credentials to `nothing`:

```julia
using AWS: @service
@service S3

aws_config = AWSConfig(; creds=nothing, region="eu-central-1")
a = S3.list_objects("copernicus-dem-30m/"; aws_config)
```


The high-level function calls are wrapped around the low-level function calls, meaning you can still pass along any low-level `kwargs` such as `aws_config` when making these requests.

**Note:** When calling the `@service` macro you **CANNOT** match the predefined constant for the low level API. The low level API constants are named in all lowercase, and spaces are replaced with underscores.
Expand Down

0 comments on commit 100c30e

Please sign in to comment.