Primary Use Cases | This connector is an excellent choice for retrieving flat files when APIs are not an option. |
Primary Metrics | N/A |
Primary Company Roles |
|
Average Implementation Time | Less than an hour if you have the correct file types in S3. |
Ease of Use (on a 1-to-10 scale with 1 being easiest) | 4 |
2. In the
**Permissions** pane, select **Attach existing policies directly**, then check the box for either **AmazonS3FullAccess** or **AmazonS3ReadOnlyAccess**.
Customer-managed policies *do not work*.
3. In the
**Review** pane, click **Create User**.
2. After you create your user, copy the access and secret keys to use in the
**Credentials** pane in Domo.
## Connecting to Your Amazon S3 Account
This section enumerates the options in the **Credentials** and **Details** panes in the Amazon S3 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 Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").
### Credentials Pane
This pane contains fields for entering credentials to connect to your Amazon S3 account. The following table describes what is needed for each field:
Field | Description |
|---|---|
| Access Key | Enter your AWS access key. For information about finding your access key, see "Prerequisites," above. |
| Secret Key | Enter your AWS secret key. For information about finding your secret key, see "Prerequisites," above. |
| Bucket | Enter the Amazon S3 Bucket you want to pull files from. |
| S3 Bucket Region | Select the S3 Bucket Region where your file is located. |
Menu | Description | ||||||
|---|---|---|---|---|---|---|---|
What file type would you like to import? | Select the file type you want to import into Domo: CSV, JSON, XML, Excel, TSV, or TXT. | ||||||
How Would You Like to Choose Your Filename? | Select how you want Domo to identify your file. Options are as follows:
| ||||||
Prefix (Optional) | Enter a prefix to filter results by. A prefix limits results to only those keys that begin with the given prefix. Note that with this standard version of the connector, only the latest modified file will be imported. The advanced version of the connector retrieves all files with the same prefix, provided they have the same schema. For more information, see Amazon S3 Advanced Connector . | ||||||
| S3 Path Helper | Enter a prefix value to populate S3 Path Helper . | ||||||
Enter Complete Filepath | Enter the complete path for the desired file. | ||||||
File Name | Enter the name of the file you want to import, with or without the file path. For example: folder\_name/file\_name | ||||||
File Name Match Type | Specify whether the file you want to retrieve starts with or contains the text you entered under File Name . | ||||||
File Compression Type | Select the compression type for the file you want to retrieve. If the file is not compressed, select None . | ||||||
Are Headers Present in CSV File? | Select Yes if the CSV file you are importing contains headers; otherwise select No . | ||||||
List of Files | Select the file you want to retrieve. | ||||||
Select the Delimiting Character | Select the delimiter used in the CSV file you want to retrieve. If your delimiter is not listed, select Other . | ||||||
Quote Character | Select a quote character to parse the CSV file you want to retrieve. A double quote (") is the CSV standard. | ||||||
Escape Character | Select an escape character to parse the CSV file you want to retrieve. A backslash () is the CSV standard. | ||||||
| Add Filename Column | Specify if the *BATCH\_FILE\_NAME* column should be added to the final output or not. | ||||||
| File Encoding | Select the appropriate file encoding. By default, the encoding is set to UTF-8 . | ||||||
| Use Previous Schema(Append Mode) | Select the checkbox to use the previous schema in the subsequent runs of the dataset (applicable only in Append mode). If it is not selected, the previous schema will not be used. | ||||||
Enable Parsing for Large JSON Files? | Specify whether parsing is enabled for large JSON files. | ||||||
Does Your JSON Text Require a Line Reader? | Specify whether the text in your JSON file includes multiple lines that should be read. | ||||||
Should the Backslash be Escaped? | Specify whether the text in your JSON file contains backslash characters that should be escaped. | ||||||
Enter Your Data Tag | Enter the tag for the data in your JSON or XML file. | ||||||
Enter Fields to Exclude | Provide a comma-separated list of fields to exclude in your JSON/XML import. | ||||||
Enter Your Header Tag | Enter the tag for the header in your JSON or XML file. | ||||||
Do You Require Attributes in Data? | Specify whether you require attributes values as part of your XML data. | ||||||
Enter XPath Expression | Enter your XPath expression. | ||||||
Is Password Protected? | Select Yes if the file you are retrieving is password-protected; otherwise select No . | ||||||
Header Start Row | Enter the number of the header row in the Excel file you are retrieving. | ||||||
Data Start Row | Enter the number of the first data row in the Excel file you are retrieving. | ||||||
Footer | Enter the number of the footer row in the Excel file you are retrieving. | ||||||
Blank Rows | Select the action that should be taken if blank rows are encountered. If you select Skip blank rows , any blank rows are skipped; if you select Stop at the first blank column , the data import stops when a column with a blank row is encountered. | ||||||
Empty Column Headers | Specify what should happen if empty column headers are encountered. If you choose Add blank columns , column names are automatically generated for the new columns. If you select Stop at the first blank column , the data import stops when an empty header is encountered. | ||||||
Convert Data Type of Columns Containing Leading 0's to String | Select this checkbox, if you want to convert the data type of the columns which contain leading 0's to String. If this checkbox is not selected, then the leading 0's will be truncated from the columns and the data type will be updated to a new data type. |