Skip to content

How-To Guides

AWS Profile Configuration

  • Install AWS CLI - Command line tool.
  • Create an AWS AMI user then extract Access ID & key.
  • Configure AWS CLI profile by:
aws configure <--profile [PROFILE_NAME]>
# ensure you set a defalut region.

Check installed Python version

  • Ensure you Python version is >= 3.12.3 by:
python --version

# Consider update Python version if less than 3

Install eraXplor

  • Install eraxplor too by:
pip install eraXplor

How-To use

eraXplor-aws supports two separate AWS FOCUS commands:

# Configure FOCUS export stack
eraXplor-aws --command configure --profile default --region us-east-1 --stack-name CID-DataExports-Source --granularity MONTHLY

# Download parquet files later (after export data is available)
eraXplor-aws --command download --profile default --region us-east-1 --stack-name CID-DataExports-Source

For Windows/PowerShell users restart your terminal, and you may need to use the following command:

python3 -m eraXplor-aws

# Or
python -m eraXplor-aws

# to avoid using this command, apend the eraXplor to your paths.
# Normaly its under: C:\Users\<YourUser>\AppData\Local\Programs\Python\Python<version>\Scripts\
Note

Ensure you run the command in a place you have sufficient permission to replace file. The eraXport tool sorting cost reult into a CSV file, by default The CSV will replace for next run.

Argument Reference

  • --command or -c: (Optional) Default value configure. Available options: configure, download
  • --profile or -p: (Optional) Default value default.
  • --region or -r: (Optional) Default value us-east-1.
  • --stack-name or -s: (Optional) Default value CID-DataExports-Source.
  • --granularity or -g: (Optional) Default value MONTHLY. Available options: HOURLY, DAILY, MONTHLY