Connecting to AWS S3
- 31 May 2022
- 3 Minutes to read
- Print
- DarkLight
Connecting to AWS S3
- Updated on 31 May 2022
- 3 Minutes to read
- Print
- DarkLight
Article Summary
Note
This documentation is prior to May 2022.
AWS S3 is a storage system that is used to store all of your data and analyze it. One can think of it as an infinite hard disk that Explorium uses for storage.
There are three options to connect to AWS S3:
- Create a new project
- Edit an existing project connection
- Export data from the Export >Run recipe button
Use variable names in the file name input for customization. Available variables: project, model, date, year, month, day, hour, minute, second.
For Example: if my project name is 'My Project', and the file path value is 'Desktop_{date}/{project}_{date}', then the prediction file will be stored at 'Desktop_2019-02-19_15-20' directory, and the file name will be 'myProject_2019-02-19_15-20'
Connecting to AWS S3 when Creating a New Project
- Click Enrich. The Enrich page is displayed.
- Click
in the upper-right hand corner. The Create a new project window is displayed.
- Type in a new project name. The project name needs to be unique.
- Select a use case from the drop-down.
- Click Create project. The Upload a dataset window appears.
- Select AWS S3.
- All fields are mandatory, enter the connection name.
- Type in the Access key.
Note: Scroll below to see how you can obtain the Access Key, Secret Key and Bucket Name. - Type in the Secret Key.
- Type in the Bucket Name, which is the name of the root folder within S3 where the file resides.
- Click Test Connection to make sure the connection is successful.
A message is displayed informing you if the connection was successfully created or not. If the test connection failed, then you are unable to create a connection.
Note: Before creating a new connection, a Test Connection must be run. If the test failed, or a parameter was changed, the Create button will be disabled, and you need to create a new connection. - After the test connection has succeeded, click Create in order to create the connection.
- Select the database connection.
- Type in the file name. which is the filename within the bucket selected during the creation of the connection. For example, the full path would be explorium-output/file-name.csv If the folder resides within a subfolder, this must be included before the file-name - for example: subfolder-name/file-name.csv. In this scenario the full path would be explorium-output/subfolder-name/file-name.csv.
- Click Save.
Connecting to AWS S3 when Editing a Dataset
- Click Enrich. The Enrich page is displayed.
- Create or search for a project.
- Click
.
The Change data and edit data dataset window appears.
- Click Continue. The Upload a dataset window appears.
- Select AWS S3.
- All fields are mandatory. Select the connection name.
- Type in the Access key.
Note: Scroll below to see how you can obtain the Access Key, Secret Key and Bucket Name. - Type in the Secret Key.
- Type in the Bucket Name, which is the name of the root folder within S3 where the file resides.
- Click Create to test the connection before creating the connector.
- Click Test Connection. A message is displayed informing you if the connection was successfully created or not. If the test connection failed, then you are unable to create a connection.
Note: Before creating a new connection, a Test Connection must be run. If the test failed, or a parameter was changed, the Create button will be disabled, and you need to create a new connection. - After the test connection has succeeded, click Create in order to create the connection.
- Select the database connection.
- Type in the file name which is the filename within the bucket selected during the creation of the connection. For example, the full path would be explorium-output/file-name.csv If the folder resides within a subfolder, this must be included before the file-name- for example: subfolder-name/file-name.csv. In this scenario the full path would be explorium-output/subfolder-name/file-name.csv.
- Click Save.
Exporting Data
- Click Enrich. The Enrich page is displayed.
- Create, search or edit a project.
- Click the Export >Run Recipe.
- The Schedule Recipe Run window is displayed.
- Select the input connection (optional).
- Select the output connection.
How can you obtain the Access Key, Secret Key and Bucket name from the client’s S3?
- Within the AWS console, click on your personal account settings > My Security Credentials.
- copy an existing access key + secret access key or create a new set of keys: