Skip to Content

Amazon S3 Connector

Summary

The Harmony Amazon S3 Connector establishes access to Amazon S3.

The Amazon S3 connector provides an interface for creating an Amazon S3 connection, the foundation used for generating instances of Amazon S3 activities. These activities, once configured, interact with Amazon S3 through the connection.

The Amazon S3 connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure an Amazon S3 connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Amazon S3 connection and its activities are referred to as an Amazon S3 endpoint:

Amazon S3 activity types

  • Put Object: Places object data into an Amazon S3 bucket and is intended to be used as a target in an operation.

  • Get Object: Retrieves an object from an Amazon S3 bucket and is intended to be used as a source in an operation.

  • List Objects: Returns some or all (up to 100,000) of the objects in an Amazon S3 bucket and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Amazon S3 connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Amazon S3 connector uses the AWS SDK for Java version 1.12.524. Refer to the API documentation for information on the schema nodes and fields.

To use the Amazon S3 connector, the Amazon S3 instance must have the s3:PutObject, s3:GetObject, and s3:ListBucket permissions set. For more information, see the Amazon S3 permissions documentation.

Troubleshooting

If you experience issues with the Amazon S3 connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.amazon" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.