Skip to end of metadata
Go to start of metadata

Introduction

The Jitterbit AWS S3 Get plugin is used to read, rename, or delete a file from Amazon AWS S3. A file that is read can then be used as a source of data within an operation in Design Studio.

This page details the steps to use the AWS S3 Get plugin:

  1. Associate the Plugin with an Agent Group
  2. Assign the Plugin to a Source
  3. Set Global Variables for the Plugin
  4. Complete Operation Setup
NOTE: This page uses Design Studio as an example; you may use this plugin in Cloud Studio using similar steps.

Encryption

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.

Example

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.

Additional Functionality

In addition, these options offer additional functionality beyond the AWS S3 Get plugin:

Associate the Plugin with an Agent Group

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:

  1. 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.
  2. In the table, locate the row "Jitterbit AWS S3 Get." On the far right, use the Action dropdown to select Associate Agent Group.
  3. In the popup, select your Private Agent Group and click Save.
TIP: Detailed documentation on associating plugins is available in Customizations > Plug-ins.

Assign the Plugin to a Source

In your Design Studio project, you must assign the plugin to a source within an operation. Within your project:

  1. Create an operation. The example Jitterpak uses a Archive type, although any operation using a source, including those with transformations, may be used.
  2. 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 storagelocal file, or FTP, during configuration of the source it is recommended to provide a Get Files value of [file].[ext].
  3. 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.

Set Global Variables for the Plugin

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:

  1. Right-click on the source in the operation and select Insert Before This > Script.
  2. 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.

    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>
NameTypeRequiredDescription
AWS.S3.ENDPOINTString

Optional

The URL of the Amazon AWS S3 endpoint. Defaults to "s3.amazonaws.com" if not set. Valid endpoint names by region are provided in Amazon's documentation AWS Regions and Endpoints.
AWS.S3.BUCKET_NAMEStringRequiredThe 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. "my_bucket/folder").
AWS.S3.ACCESS_KEY_IDStringRequiredThe S3 access key (e.g. "ABCDEFGHI1JK2LM3NOPQ").
AWS.S3.SECRET_ACCESS_KEYStringRequiredThe S3 secret access key (e.g. "1aBCd2e/F34gH56IJ7Kl/Mno8pqRsTUvw9x0yzzz").
AWS.S3.REGIONStringOptionalThe S3 region. Defaults to "DEFAULT_REGION" if not set (not recommended). Current region names are provided in Amazon's documentation AWS Regions and Endpoints.
AWS.S3.OBJECT_KEYStringRequiredThe S3 object key to be read. This is the name of the specific file that you want to be returned, such as "myfile.txt". The object key is case-sensitive. Specifying multiple files or using wildcards is not supported.
AWS.S3.DELETEBooleanOptional

If set to "true", deletes the object from the S3 bucket after reading it. The default is "false". Do not use with the AWS.S3.NEWNAME variable.

WARNING: This variable deletes the specified object on the S3 bucket itself.
AWS.S3.NEWNAMEStringOptional

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 AWS.S3.DELETE variable.

WARNING: This variable renames a specified object on the S3 bucket itself.
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.

Complete Operation Setup

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.

To complete your operation setup, define a target for archiving your S3 data, or add both a target and a transformation if you want to transform your data prior to reaching the target.

CAUTION: If using a temporary storagelocal file, or FTP Site target, in order for the S3 filename and extension to be written to the target, it is recommended to enter [AWS.S3.OBJECT_KEY] in the Filename(s) field to use the same filename in the target as that being read by the plugin. Using a value of [file].[ext] will return the S3 ID of the file rather than the S3 filename.

For reference, the Jitterpak AWS S3 Basic Example (JPK) provides a complete operation using the AWS S3 Get plugin.

On This Page

Plugin

Last updated:  Mar 11, 2020