Sync export storage | API Reference

Sync tasks to an S3 export/target storage connection. You will need to provide the export storage ID. You can find this using List export 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

Response

projectinteger

A unique integer value identifying this project.

idinteger or null

typestring or nullDefaults to s3

synchronizableboolean 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

can_delete_objectsboolean or null

Deletion from storage enabled

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

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.export_storage.s3.sync(
7	id=1,
8	)

1	{
2	"project": 1,
3	"id": 1,
4	"type": "type",
5	"synchronizable": true,
6	"last_sync": "2024-01-15T09:30:00Z",
7	"last_sync_count": 1,
8	"last_sync_job": "last_sync_job",
9	"status": "initialized",
10	"traceback": "traceback",
11	"meta": {
12	"key": "value"
13	},
14	"title": "title",
15	"description": "description",
16	"created_at": "2024-01-15T09:30:00Z",
17	"can_delete_objects": true,
18	"bucket": "bucket",
19	"prefix": "prefix",
20	"regex_filter": "regex_filter",
21	"use_blob_urls": true,
22	"aws_access_key_id": "aws_access_key_id",
23	"aws_secret_access_key": "aws_secret_access_key",
24	"aws_session_token": "aws_session_token",
25	"aws_sse_kms_key_id": "aws_sse_kms_key_id",
26	"region_name": "region_name",
27	"s3_endpoint": "s3_endpoint"
28	}

Path parameters

Headers

Response