✨ Sync import storage | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Sync tasks from an S3 import storage connection that was set up with IAM role access.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Sync tasks from an S3 import storage connection that was set up with IAM role access.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path Parameters

idintegerRequired

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

role_arnstring

AWS RoleArn

typestringDefaults to s3s

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

descriptionstring or null

Cloud storage description

external_idstring or null

AWS ExternalId

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null0-2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

legacy_authboolean or null

metaany or null

prefixstring or null

S3 bucket prefix

presignboolean or nullDefaults to true

presign_ttlinteger or null0-32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or null

Perform recursive scan over the bucket content

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

* `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

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

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