Configure the Amazon Web Services (AWS) Command Line Interface (CLI)

Note

To follow these instructions, we need to create an AWS account for you. See Getting Access to Resources for more information.

The Amazon Web Services (AWS) Command Line Interface (CLI) allows you to interact with AWS via the command line. Configuring the AWS CLI is required for using the download data script and uploading your results to S3 for review.

These instructions assume you have already installed AWS CLI during conda set up.

Configuring the AWS CLI

Info

If you're using Lightsail for Research, the configuration and login steps have occurred automatically. You only need to follow these steps if you're using another system like your laptop.

To follow these instructions, you'll need the access portal URL from when you set up your user in IAM Identity Center.

Note: SSO below stands for "Single Sign-On" and is what AWS used to call IAM Identity Center.

Use the following command in your Terminal application to start configuring:
```
aws configure sso
```

Fill in the prompts using the following values, replacing {The access portal URL from you invite email} including the curly brackets with the access portal URL.

SSO session name (Recommended): openscpca-sso
SSO start URL [None]: {The access URL from you invite email}
SSO region [None]: us-east-1
SSO registration scopes [sso:account:access]: sso:account:access

Step 2 will automatically open a browser window for you to confirm access by hitting the Confirm and continue button. (If a browser window doesn't open, follow the instructions in your Terminal.) If you're not logged in, you will be prompted to log in.
Click the Allow access button on the next screen.

Return to your Terminal application. You should see the following:

The only AWS account available to you is: {account number}
Using the account ID {account number}
The only role available to you is: ResearcherRestriction
Using the role name "ResearcherRestriction"

Fill in the prompts with the following:

CLI default client Region [None]: us-east-2
CLI default output format [None]: json
CLI profile name [ResearcherRestriction-{account number}]: openscpca

Logging in to a new session

To use the AWS CLI for this project, you will need to be logged into the openscpca profile on your computer.

To login, use the following command in your Terminal application:
```
aws sso login --profile openscpca
```
Step 1 will automatically open a browser window for you to confirm access by hitting the Confirm and continue button. (If a browser window doesn't open, follow the instructions in your Terminal.)
Click the Allow access button on the next screen.

Storing your AWS profile name

These instructions are mostly applicable to advanced users, but we're happy to help you set this up if you need assistance!

Optionally, you may wish to save your profile name as an environment variable in your shell profile file (e.g., ~/.bashrc for Bash users or ~/.zshrc for Z shell users).

AWS CLI commands and some of the provided OpenScPCA scripts will automatically look for the environment variable AWS_PROFILE. If you define this variable in your profile file, you will not need to specify --profile openscpca (or whichever name you used for your profile) when logging into the AWS CLI or running other commands.

To take advantage of this, you can add this line to your profile file (assuming your profile is named openscpca):

export AWS_PROFILE=openscpca

That said, please be aware that, if you use other AWS accounts, adding this environment variable might conflict with any settings for your other accounts.