Amazon S3 Writeback Connector
Intro
Amazon S3 is an online file storage web service offered by Amazon Web Services that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. Use this connector to export your data from a Domo DataSet to an Amazon S3 Bucket. To learn more about the Amazon S3 API, visit their page (http://docs.aws.amazon.com/AmazonS3/...I/Welcome.html).
You export data to S3 in the Data Center. This topic discusses the fields and menus that are specific to the Domo to S3 Writeback connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Prerequisites
To configure this connector, you will need the following:
-
A Domo Client ID and Client Secret. To obtain these credentials, do the following:
-
Log into your Domo developer account at https://developer.domo.com/login.
-
Select the desired data and user application scope.
-
Click Create.
-
-
Your AWS access key. You can find this in the Security Credentials section of the AWS Console. Alternatively, if you are using IAM, you can find it under Users.
-
Your AWS secret key, which was provided when you created your access key. You can generate a new secret key in the AWS Console.
-
The name of the AWS S3 Bucket you want to push data to.
Configuring the Connection
This section enumerates the options in the Credentials and Details panes in the Domo to S3 Writeback Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.
Credentials Pane
This pane contains fields for entering credentials to connect to your Domo developer account as well as your S3 bucket. The following table describes what is needed for each field:
|
Field |
Description |
|---|---|
|
Domo Client ID |
Enter your Domo client ID. |
|
Domo Client Secret |
Enter your Domo client secret. |
|
Access Key |
Enter your AWS access key. |
|
Secret Key |
Enter your AWS secret key. |
|
Bucket |
Enter the name of the bucket you want to push Domo data to. |
|
Region |
Select the Amazon S3 region where your bucket is located. |
Once you have entered valid credentials, you can use the same account any time you go to set up a new Domo-S3 connection. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Details Pane
This pane contains a number of fields for specifying your data and indicating where it's going.
|
Menu |
Description |
|---|---|
| How Would You Like To Select Your Folder Path? | Specify whether you would like to search the folder path or enter it manually. |
| Select Folder Path | Select the folder path that you would like to use. |
| Path | Enter the path where you would like the file to be saved in your Amazon S3 bucket. |
| Overwrite | Select this check box if you want to overwrite the existing file in your Amazon S3 bucket with selected filename. |
| How Would You Like To Select Your Input DataSet? | Specify whether you would like to search for your DataSet ID or enter it manually. |
| DataSet ID | Select the DataSet ID that you would like to use. |
|
Input DataSet ID |
Enter the DataSet ID (GUID) for the DataSet you want to copy to S3. You can find the ID by opening the details view for the DataSet in the Data Center and looking at the portion of the URL following datasources/. For example, in the URL https://mycompany.domo.com/datasources/845305d8-da3d-4107-a9d6-13ef3f86d4a4/details/overview, the DataSet ID is 845305d8-da3d-4107-a9d6-13ef3f86d4a4. |
| Select Filename |
Select whether you want to reference your DataSet using the Input DataSet ID, Input DataSet Name, or an output file name. If you choose Use Input Dataset Name or Enter File Name and your dataset name contains the macro <current_date> or <current_date-1> without spaces, then <current_date> will be replaced by today's date and <current_date-1> will be replaced by yesterday's date or -31 for 31 days ago in format yyyy-MM-dd. |
| Filename | Enter the output file name for your data. |
| Only Writeback New Data | Check this box to only pull your last execution data from the input dataset and export it to S3 Object. |
| File Extension | Select the extension that should be used as the file extension for your output file. |
| Delimiter | Select the character that should be used as a delimiter for your output file. |
| Compression | Select the compression type that should be used for your output file. |
| Encryption Method | Select the encryption type that should be used for your output file. |
| Encryption Key | Enter the encryption key. |
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.