Documentation Index
Fetch the complete documentation index at: https://docs.useparagon.com/llms.txt
Use this file to discover all available pages before exploring further.
Synced Objects
Amazon S3 supports the following Synced Objects:
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
{
"integration": "amazons3",
"pipeline": "files",
"configuration": {
"bucket": "my-s3-bucket"
}
}
Configuration options:The S3 bucket name to sync files from.
An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
{
"integration": "amazons3",
"pipeline": "files",
"configuration": {
"bucket": "my-s3-bucket",
"subfolder": "documents/"
}
}
Configuration options:The S3 bucket name to sync files from.
A subfolder path within the bucket to limit the Sync scope to.
An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
{
"integration": "amazons3",
"pipeline": "files",
"configuration": {
"bucket": "my-s3-bucket",
"fileIds": ["documents/document1.pdf", "documents/document2.pdf"]
}
}
Configuration options:The S3 bucket name to sync files from.
A list of S3 file keys, including the path, to limit the Sync scope to.
An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.