In order to download data from Blackfynn Discover, you will need to install the Amazon AWS Command Line Interface. The CLI allows you to programmatically get access to the data on Amazon S3 using your personal AWS account.
Setting up the AWS CLI consists of two steps:
- Installing the AWS CLI tool
- Configuring the AWS CLI tool to use your credentials.
Installing the AWS CLI Tools
We recommend to install AWS CLI version 2. You can download the installers here:
Run the installer package to install the CLI on your machine. Typically, it is best to install the CLI for all users of your computer.
For more detailed information and other operating systems, AWS provides detailed instructions on various ways to install the client here: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html
Configuring AWS CLI Tools
There are many specialized ways to configure the AWS CLI. However, for purpose of accessing public data from Blackfynn Discover, the configuration is very simple using the
aws configure command.
Running this command will require you to enter 4 values:
- Your AWS Access Key ID: This is the access key associated with the IAM user that you created when you configured you AWS account.
- Your AWS Secret Access Key: This is the Secret Access Key that was generated when setting up your IAM user.
- Default region name: We recommend using us-east-1 as this is where Blackfynn Discover is located.
- Default output format: We recommend using JSON.
$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLEAWS
Secret Access Key [None]: wJalxRfiCYEXAMPLEKEYDefault
region name [None]: us-east-1
Default output format [None]: json
After confirming the credentials, you will now be able to interact with Amazon AWS as the IAM user associated with your account. We recommend to increase the number of concurrent connections to 200. This will significantly increase the download speed.
$ aws configure set default.s3.max_concurrent_requests 200
You can find more detailed information about configuring your CLI at the AWS Documentation site: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html