- This line was added.
- This line was removed.
- Formatting was changed.
This page details the steps to use the AWS S3 Get plugin:
- Associate the Plugin with an Agent Group
- Assign the Plugin to a Source
- Set Global Variables for the Plugin
- Complete Operation Setup
|NOTE: This page uses Design Studio as an example; you may use this plugin in Cloud Studio using similar steps.|
The AWS S3 Get plugin passes your provided AWS S3 access key ID and secret access key (described below in Set Global Variables for the Plugin) to Amazon. Security is handled by Amazon as described in Amazon's documentation on AWS Security Credentials.
The AWS S3 Get plugin can be used whenever you need to retrieve, rename, or delete files from AWS. For reference, a basic Jitterpak AWS S3 Basic Example (JPK) is included with an example setup.
In addition, these options offer additional functionality beyond the AWS S3 Get plugin:
- AWS S3 Create: AWS S3 Create is a Jitterbit-provided plugin used to upload a file to Amazon AWS S3 as a target within an operation in Design Studio.
- AWS REST API: The AWS REST API can be accessed through an HTTP source or HTTP target in Design Studio. During configuration, it may be necessary to use the HMAC-SHA256 Generator plugin depending on your method of authentication. If you need assistance, please contact support.
If using a Cloud Agent Group, you can skip this step, as the AWS S3 Get plugin is already associated with Jitterbit's Cloud Agent Groups by default.
If using a Private Agent Group, you must associate this Jitterbit-provided plugin with your Private Agent Group. This will make the plugin available on all Private Agents within the Private Agent Group. To associate the plugin:
- Log in to the Harmony Portal and go to the Management Console. Then use the menu in the top left to navigate to Customizations > Plug-ins.
- In the table, locate the row "Jitterbit AWS S3 Get." On the far right, use the Action dropdown to select Associate Agent Group.
- In the popup, select your Private Agent Group and click Save.
|TIP: Detailed documentation on associating plugins is available in Customizations > Plug-ins.|
- Create an operation. The example Jitterpak uses a Archive type, although any operation using a source, including those with transformations, may be used.
- Create a dummy source that the plugin will be assigned to. This source is used as a placeholder and will not actually be read from. We recommend using a global variable source. If other file-type sources are used, such as temporary storage, local file, or FTP, during configuration of the source it is recommended to provide a Get Files value of
- Assign the plugin to the source. To do this, right-click on the source and select Plugin. In the popup, under Available plugins, select "Jitterbit AWS S3 Get" and click Assign. Then click OK.
|TIP: Detailed documentation on assigning plugins is available in Applying Pipeline Plug-ins.|
In order for a plugin assigned to a source to be functional, any global variables required by the plugin must be set. These variables are set in a script, which should be placed before the source in the operation so that the variables can be initialized.
To add a script before the source:
- Right-click on the source in the operation and select Insert Before This > Script.
Create a new Jitterbit Script that sets variables used by the plugin to authenticate with your S3 bucket and read the file that you specify. A script template for required variables is provided below, followed by documentation on all possible variables that may be included within the script.
Code Block title AWS S3 Get Script
<trans> $AWS.S3.BUCKET_NAME="<YOUR_BUCKET_NAME>"; $AWS.S3.ACCESS_KEY_ID="<YOUR_ACCESS_KEY>"; $AWS.S3.SECRET_ACCESS_KEY="<YOUR_SECRET_KEY>"; $AWS.S3.OBJECT_KEY="<myfile.txt>"; </trans>
|The URL of the Amazon AWS S3 endpoint. Defaults to |
|String||Required||The name of the S3 source bucket. To read from within a folder inside the bucket, add the folder name after a forward slash (e.g. |
|String||Required||The S3 access key (e.g. |
|String||Required||The S3 secret access key (e.g. |
|String||Optional||The S3 region. Defaults to |
|String||Required||The S3 object key to be read. This is the name of the specific file that you want to be returned, such as |
If set to
The name used for renaming the object on the S3 bucket after reading it. Using this variable will change the S3 object key. Do not use with the
|WARNING: Although included in the plugin manifest, the variable AWS.S3.OBJECT_KEY_PREFIX is not functional. At this time, it is not possible to read multiple files at once; only one file may be read at a time.|
|CAUTION: Some of the variables above should not be used in combination with others. If they are used together, this will cause errors with your operation.|
The plugin portion of the operation setup is complete after you have (1) the script defining the variables to be used with the plugin and (2) the plugin assigned to a source in the operation.
|CAUTION: If using a temporary storage, local file, or FTP Site target, in order for the S3 filename and extension to be written to the target, it is recommended to enter |
For reference, the Jitterpak AWS S3 Basic Example (JPK) provides a complete operation using the AWS S3 Get plugin.