API ReferenceImport StorageS3

Sync import storage

Sync tasks from an S3 import storage connection. You will need to provide the import storage ID. You can find this using List import storages.

Sync operations with external buckets only go one way. They either create tasks from objects in the bucket (source/import storage) or push annotations to the output bucket (export/target storage). Changing something on the bucket side doesn’t guarantee consistency in results.

Before proceeding, you should review How sync operations work - Source storage to ensure that your data remains secure and private.

Path parameters

idintegerRequired
Storage ID

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Response

projectinteger
A unique integer value identifying this project.
idinteger or null
typestring or nullDefaults to s3
synchronizableboolean or nullDefaults to true
presignboolean or nullDefaults to true
last_syncdatetime or null
Last sync finished time
last_sync_countinteger or null
Count of tasks synced last time
last_sync_jobstring or null<=256 characters
Last sync job ID
statusenum or null
Allowed values:
tracebackstring or null
Traceback report for the last failed sync
metamap from strings to any or null
Meta and debug information about storage processes
titlestring or null<=256 characters
Cloud storage title
descriptionstring or null
Cloud storage description
created_atdatetime or null
Creation time
bucketstring or null
S3 bucket name
prefixstring or null
S3 bucket prefix
regex_filterstring or null
Cloud storage regex for filtering objects
use_blob_urlsboolean or null
Interpret objects as BLOBs and generate URLs
aws_access_key_idstring or null

AWS_ACCESS_KEY_ID

aws_secret_access_keystring or null

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring or null

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring or null
AWS SSE KMS Key ID
region_namestring or null
AWS Region
s3_endpointstring or null
S3 Endpoint
presign_ttlinteger or null

Presigned URLs TTL (in minutes)

recursive_scanboolean or null
Perform recursive scan over the bucket content