Use Amazon S3 records

Use records from files stored in an Amazon S3 bucket as input to ArcGIS Data Pipelines.

Usage notes

Keep the following in mind when working with Amazon S3:

• To use a dataset from Amazon S3, you must first create a data store item. Data store items securely store credentials and connection information so the data can be read by Data Pipelines. To create a data store, follow the steps in the Connect to Amazon S3 section below.
• To change the data store item you configured, use the Data store item parameter to remove the currently selected item, and choose one of the following options:
  • Add data store—Create a new data store item.
  • Select item—Browse your content to select an existing data store item.
• Use the Dataset path parameter to specify the name of the dataset, or the name of the folder that contains the dataset. For example, you can specify dataset paths in the following ways:
  • Reference a single file by specifying the path to that file such as Hurricanes.shp or CustomerInfo.csv.
  • Reference a folder containing multiple datasets by specifying a path such as MyFolder/. All files in the folder must have the same schema and file type.
  • Reference specific file types from a folder that contains multiple files and formats by specifying a path such as MyFolder/*.parquet. In this example, only the parquet files will be read. All of parquet files in the folder must have the same schema.
  • Reference multiple files and nested folders using glob patterns by specifying a path such as MyFolder/**/*.geojson. In this example, any subfolders within MyFolder and any GeoJSON files within those subfolders will be loaded.

  The dataset path must also be relative to the bucket and folder that were specified when creating the data store item. For example, if the full dataset path is s3://my-bucket/my-folder/my-subfolder/file.csv, and the data store item specifies my-bucket for the bucket, and my-folder for the folder, the dataset path should be my-subfolder/file.csv.

• Use the File format parameter to specify the file format of the dataset specified in the Dataset path parameter. The following format options are available:
  • CSV or delimited (for example, .csv, .tsv, and .txt)
  • Parquet (.parquet)
  • GeoParquet (.geoparquet)
  • JSON (for example, .json or a .txt file containing data formatted as JSON )
  • GeoJSON (for example, .json and .geojson, or a .txt file containing data formatted as GeoJSON)
  • Shapefile (.shp)
  • File Geodatabase (.gdb)
  • ORC (.orc)
• If the CSV or delimited format option is specified, the following dataset definition parameters are available:
  • Delimiter—The delimiter used to split field (or column) and record (or row) values. The default is comma delimited (,). Other common delimiter formats include, but are not limited to, tab (\t), semicolon (;), vertical bar (|), and forward and backward slashes (/ and \).
  • Has header row—Specifies whether the dataset contains a header row. The default is true. If set to false, the first row of the dataset will be considered a record.
  • Has multiline data—Specifies whether the dataset has records that contain new line characters. The default is false. If set to true, data that contains multiline data will be read and formatted correctly.
  • Character encoding—Specifies the encoding type used to read the specified dataset. The default is UTF-8. You can choose from the available encoding options, or specify an encoding type. Spaces are not supported in encoding values. For example, specifying a value of ISO 8859-8 is invalid and must be specified as ISO-8859-8.
• Fields is available to configure field names and types when the data format value is CSV or delimited. The Configure schema button opens a dialog box containing the dataset fields with the following options:
  • Include or drop fields—You can remove fields by checking the check box next to the field. By default, all fields are included.
  • Field name—The name of the field as it will be used in Data Pipelines. This value can be edited. By default, this value will be the same as the field in the source dataset unless the source name contains invalid characters or is a reserved word. Invalid characters will be replaced with an underscore (_), and reserved words will be prefixed with an underscore (_).
  • Field type—The field type as it will be used in Data Pipelines. This value can be edited.
  The following table describes the available field types:

  Field type	Description
  String	String fields support a string of text characters.
  Small integer	Small integer fields support whole numbers between -32768 and 32767.
  Integer	Integer fields support whole numbers between -2147483648 and 2147483647.
  Big integer	Big integer fields support whole numbers between -9223372036854776000 and 9223372036854776000.
  Float	Float fields support fractional numbers between approximately -3.4E38 and 3.4E38.
  Double	Double fields support fractional numbers between approximately -2.2E308 and 1.8E308.
  Date	Date fields support values in the format yyyy-MM-dd HH:mm:ss, for example, a valid value is 2022-12-31 13:30:30. If the date values are stored in a different format, use the Create date time tool to calculate a date field.
  Boolean	Boolean fields support values of True and False. If a field contains integer representations of Boolean values (0 and 1), use the Update fields tool to cast the integers to Boolean values instead.

• If the JSON format option is specified, the Root property parameter is available. You can use this parameter to specify a property in the JSON to read data from. You can reference nested properties using a decimal separator between each property, for example, property.subProperty. By default, the full JSON file will be read.
• If the GeoJSON format option is specified, the Geometry type parameter is available. This parameter is optional. By default, the geometry type in the GeoJSON file is used. If the GeoJSON file contains more than one geometry type, you must specify the value for this parameter. Mixed geometry types are not supported and only the specified type will be used. The options are Point, Multipoint, Polyline, and Polygon. A geometry field containing the locations of the GeoJSON data will be automatically calculated and added to the input dataset. The geometry field can be used as input to spatial operations or to enable geometry on the output result.
• If the File Geodatabase format option is specified, the Feature class or table name parameter is available. Use this parameter to specify the name of the feature class or table you want to use as input. Only point, multipoint, polyline, and polygon feature classes and tables are supported. Datasets such as raster, mosaic, trajectory, and others are not supported. Advanced feature types such as geometric network features are not supported.
• To improve the performance of reading input datasets, consider the following options:
  • Use the Use caching parameter to store a copy of the dataset. The cached copy is only maintained while at least one browser tab open to the editor is connected. This may make it faster to access the data during processing. If the source data has been updated since it was cached, uncheck this parameter and preview or run the tool again.
  • After configuring an input dataset, configure any of the following tools that limit the amount of data being processed:
    • Filter by attribute—Maintain a subset of records that contain certain attribute values.
    • Select fields—Maintain only the fields of interest.
    • Filter by extent—Maintain a subset of records within a certain spatial extent.

Connect to Amazon S3

To use data stored in Amazon S3, complete the following steps to create a data store item in the Data Pipelines editor:

1. On the Data Pipelines editor toolbar, click Inputs and choose Amazon S3.

   The Select a data store connection dialog box appears.

2. Choose Add a new data store.
3. Click Next.

   The Add a connection to a data store dialog box appears.

4. Provide the access key ID and corresponding secret access key you obtained from your Amazon Web Services (AWS) account.
5. Provide the region where the bucket exists and type the name of the bucket.
6. Optionally, provide the path to a folder within the container to register it.
7. Click Next.

   The item details pane appears.

8. Provide a title for the new data store item.

   This title will appear in your content. You can also store the item in a specific folder and provide item tags or a summary.

9. Click Create connection to create the data store item.

   An Amazon S3 element that you can configure for a specific dataset is added to the canvas.

Limitations

The following are known limitations:

• Your credentials must have at least s3:ListBucket, s3:GetBucketAcl, and s3:GetObject permissions. These permissions allow access to read the specified bucket and the datasets within it.
• If you specify a folder containing multiple files that represent a single dataset, all files identified in the Amazon S3 folder must have the same schema and geometry type.
• Zipped files (.zip) are not supported.
• Esri JSON files (.esrijson) are not supported.
• If the dataset includes field names with spaces or invalid characters, the names are automatically updated to use underscores. For example, a field named Population 2022 is renamed Population_2022, and a field named %Employed is renamed _Employed.
• To use a data store item to connect to external data sources, you must be the owner of the data store item. Data store items that are shared with you are not supported as input.

Licensing requirements

The following licensing and configurations are required:

• Creator or Professional user type
• Publisher, Facilitator, or Administrator role, or an equivalent custom role

To learn more about Data Pipelines requirements, see Requirements.