Using the Amazon S3 Source Component
The Amazon S3 Source Component is an SSIS data flow pipeline component that can be used to read/retrieve data from Amazon S3.
The component includes the following two pages to configure how you want to read data.
- General
- Columns
General Page
The General page of the Amazon S3 Source Component allows you to specify the general settings of the component.
- Source Item Settings
-
- Connection Manager
-
The Amazon S3 Source Component requires a connection in order to connect to Amazon S3. The Connection Manager drop-down will show a list of all connection managers that are available to your current SSIS package.
- Source Item Path
-
The Source Item Path specifies the location of the file or folder that you are trying to read from. Click the ellipsis button ('...') to open up an Amazon S3 browser dialog to select an item.
- Item Selection Mode
-
The Item Selection Mode settings specify what sub-items (if any) you wish to retrieve. The available modes are:
- Selected Item: Retrieves only the item specified at Source Item Path.
- Recursive: Retrieves the selected item (specified by the Source Item Path option) and all sub-items recursively.
- Recursive (Files Only): Retrieves items the same as the Recursive mode but only returns files.
- Selected Level (Files Only): Retrieves the selected item and all immediate files under the folder as specified by the Source Item Path option.
- Max Keys
-
The Max Keys lets you specify how many records to retrieve per service call to Amazon S3. The default is set to 1000.
- Refresh Component Button
-
Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.
- Expression fx Button
-
Clicking the fx button to launch SSIS Expression Editor to enable dynamic updates of the property at run time.
- Generate Documentation Button
-
Clicking the Generate Documentation button to generate a Word document that describes the component's metadata including relevant mapping, and so on.
Columns
The Columns page of the Amazon S3 Source component shows you all available attributes from the object that you specified on the General page.
On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.
The Columns Page grid consists of:
- Amazon S3 Field: Column that will be retrieved from the current item (file or folder).
- Data Type: The data type of this field.
Note: As a general best practice, you should only select the fields that are needed for the downstream pipeline components.