Sync export storage

POST

http://localhost:8000/api/storages/export/s3/:id/sync

POST

/api/storages/export/s3/:id/sync

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 )

200Successful

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

Sync tasks from an S3 export storage connection.

Path parameters

idintegerRequired

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestring

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

bucketstring or null

S3 bucket name

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null>=0<=2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

prefixstring or null

S3 bucket prefix

regex_filterstring or null

Cloud storage regex for filtering objects

region_namestring or null

AWS Region

s3_endpointstring or null

S3 Endpoint

statusenum or null

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

synchronizableboolean or nullDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean or null

Interpret objects as BLOBs and generate URLs