Here's how to set it up
Step 1: Setup & Prerequisites
We'll be using AWS Linux CLI interface for this tutorial. If you don't have a Linux environment, please contact us for support.
If you already have python you can install with the following, see here for more details.
pip install --upgrade --user awscli
If you don't have python, you can install using the bundled installer
curl "https://s3.amazonaws.com/aws-cli/awscli-bundle.zip" -o "awscli-bundle.zip"
sudo ./awscli-bundle/install -i /usr/local/aws -b /usr/local/bin/aws
#without sudo (assumes ~/bin is in your PATH)
./awscli-bundle/install -b ~/bin/aws
Step 2: Configure CLI
If you don't already have your credentials, please contact uConnect support, email@example.com Unless otherwise instructed by the uConnect team, you should use “us-east-1” as your region.
Next run the following and enter in your AWS Access Key and Secret Key
AWS Access Key ID [****************JRTA]:
AWS Secret Access Key [****************RZ7O]:
Default region name [us-east-1]:
Default output format [None]:
Step 3: Upload Your First File
Now you're ready to upload your file to uConnect!
aws s3 cp [/path/your_local_file] s3://YOURUNIQUEBUCKET/student_feed.csv
The AWS S3 API will respond with the document ID if the file was successfully transferred, otherwise it will respond with an error. You can also check the command exit code to determine it was successful.
If you wish to do a test run, simply send a file and our support team will verify that it is received and correct.
Step 4: Scheduling your Regular Upload
After you've validated everything looks good, we recommend using cron to schedule the upload.
Pick a weekly, monthly, or semesterly date to do your upload, in general the format is:
+---------------- minute (0 - 59)
| +------------- hour (0 - 23)
| | +---------- day of month (1 - 31)
| | | +------- month (1 - 12)
| | | | +---- day of week (0 - 6) (Sunday=0 or 7)
| | | | |
* * * * * command to be executed
5 8 * * Sat aws s3 cp [/path/your_local_file] s3://YOURUNIQUEBUCKET/student_feed.csv
Now, you're all set! If you have any questions, please reach out to us at firstname.lastname@example.org.