On This Page

Overview

The Amazon S3 connector in DryvIQ allows you to analyze, migrate, copy, and synchronize files between your Amazon S3 account and cloud storage repositories and on-premise network file shares. The first step is to create the connection by providing the connection information required for DryvIQ to connect to the platform. The connector can be created using any account with permissions to access the content.

Create Connection | DryvIQ Application User Interface

Select Connections > Add connection.
Select Amazon S3 as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Test the connection to ensure DryvIQ can connect using the information entered.
You will see a "Connection test succeeded" message on the Add connection modal when DryvIQ establishes connection. (If you don't see this message, verify the information you entered.)
Select Done to finish creating the connection.

Add connection modal - Amazon S3

Field	Description	Required
Display as	Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists. If you do not add a display name, the connection will automatically be named, “Amazon S3.” DryvIQ recommends you enter a name that more readily identifies the connection, especially if you will be creating multiple connections.	Optional
Access Key	Enter the access key ID required to access the account.	Required
Secret Key	Enter the secret key required to access the account.	Required
Region	Select the AWS region assigned to the account (if applicable).	Optional
Service URL	If you have a custom Amazon S3 implementation, enter the service URL that needs to be used. You must enter the full URL including `https://` at the the beginning. The URL will override the Region value.	Optional
Use Server-Side Encryption	Select if the account uses server side encryption.	Optional
Storage Class	Select the storage class: Standard, Standard-Infrequent Access, Reduced Frequency, or Glacier.	Optional

Features and Limitations

Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. The information below is platform specific. Use the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.

Supported Features	Unsupported Features	Other Features/Limitations
Version preservation	Timestamp preservation	File size maximum: 5 TB
Metadata map	Author/Owner preservation	Path length maximum: No maximum
Permission preservation (See Permission Preservation below.)	File lock propagation	Restricted types: none
	Mirror lock ownership	Segment path length: No maximum
	Account map	Invalid characters: DryvIQ restricts the use of / to prevent nesting in buckets. Amazon doesn’t restrict characters but provides Object Key and Metadata guidelines you should follow.
	Group map
	User impersonation
	Tags map

Permission Preservation

Amazon S3’s permission structure affects how DryvIQ can apply permissions. Please be aware of the following limitations for permission preservation.

Amazon S3 has a policy limit per bucket of 20,000. DryvIQ will likely hit this limit if too many permissions are migrated.
Amazon S3 supports permissions on folders only.
Amazon S2 supports inheriting permissions from parent folders. It does not currently support permissions disinheritance (breaking permissions inheritance from parent folders).
Amazon S3 only supports permissions on IAM users in AWS. IAM Groups are not supported because groups are not supported as policy principals in AWS. This is an AWS platform limitation.

Create Connection | DryvIQ API

Creating a basic Amazon S3 Connection

Create a basic Amazon S3 connection using the following information.

POST {{url}}/v1/connections/

{
  "name": "amazon S3",
  "platform": {
    "id": "amazon-s3"
  },
  "auth": {
  	"client_id":"{{client_id}}",
	"client_secret":"{{client_secret}}"
  	
  }
}

Create a Job | DryvIQ API Job Configuration Example

POST {{url}}v1/jobs

{
    "name":"Simple Job",
    "kind": "transfer",
    "transfer": {
      "transfer_type": "copy",
        "source": {
            "connection": { "id": "Source Connection ID" },
            "target": {
                "path": "/sourceDocumentLibrary"
            }
        },
        "destination": {
            "connection": { "id": "Destination Connections ID" },
            "target": {
                "path": "/destinationFolder"
            }
        },
        "simulation_mode": false
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Report {Name}"
    }
}