Amazon S3

Synced Objects

Amazon S3 supports the following Synced Objects:

Files

Files

Send a request to Enable Sync to start a file sync. Syncs for Amazon S3 can be created with one of the following configurations:

Bucket Sync: All files in the specified bucket will be synced.
Folder Sync: Only files in the specified folder will be synced (recursively including all subfolders).
Sync of specific files: Only a group of specific files will be synced.

Bucket Sync
Folder Sync
Sync of specific files

Example

{
    "integration": "amazons3",
    "pipeline": "files",
    "configuration": {
      "bucket": "my-s3-bucket"
    }
}

Configuration options:

bucket

string

required

The S3 bucket name to sync files from.

mimeTypes

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

Example

{
    "integration": "amazons3",
    "pipeline": "files",
    "configuration": {
      "bucket": "my-s3-bucket",
      "subfolder": "documents/"
    }
}

Configuration options:

bucket

string

required

The S3 bucket name to sync files from.

subfolder

string

required

A subfolder path within the bucket to limit the Sync scope to.

mimeTypes

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

Example

{
    "integration": "amazons3",
    "pipeline": "files",
    "configuration": {
      "bucket": "my-s3-bucket",
      "fileIds": ["documents/document1.pdf", "documents/document2.pdf"]
    }
}

Configuration options:

bucket

string

required

The S3 bucket name to sync files from.

fileIds

string[]

required

A list of S3 file keys, including the path, to limit the Sync scope to.

mimeTypes

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

Managed Sync

Sync API

Permissions API

Integrations Reference

Synced Objects

Files

​Synced Objects

​Files

Synced Objects

Files