Skip to content

Commit

Permalink
docs: more documentation on how aws s3 profiles work
Browse files Browse the repository at this point in the history
  • Loading branch information
timvw committed Mar 27, 2024
1 parent d713ba3 commit 54ea518
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ qv gs://datafusion-delta-testing/data/delta/COVID-19_NYT

### Configuration

Often, things just work out of the box ([Credential loading](https://github.com/Xuanwo/reqsign/blob/06791cbc5fbcea333ef59f7795b0b0f9efe0dcd1/src/aws/credential.rs#L102)).
Usually [Credential](https://github.com/awslabs/aws-sdk-rust/blob/main/sdk/aws-config/src/default_provider/credentials.rs#L25) loading works out of the box when using the [AWS SDK for Rust](https://github.com/awslabs/aws-sdk-rust/tree/main).

The following environment variables are needed for credentials:

* AWS_REGION
* AWS_ACCESS_KEY_ID
* AWS_SECRET_ACCESS_KEY

We have also support AWS SSO credentials, in that case you need:
In case you have AWS SSO credentials you need to set the following:
* AWS_PROFILE

In case you have a custom endpoint in place (eg: [minio](https://min.io/)) you also need to set:
Expand All @@ -48,6 +48,12 @@ qv s3://tpc-h-parquet/1/customer
qv s3://tpc-h-parquet/1/customer --profile my-user
```

This is the same as:

```bash
AWS_PROFILE=my-user qv s3://tpc-h-parquet/1/customer
```

## View data from S3 console URL

```bash
Expand Down

0 comments on commit 54ea518

Please sign in to comment.