API ReferenceExport StorageS3s

✨ Validate export storage

<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> Validate a specific S3 export storage connection that was set up with IAM role access.

Authentication

Authorizationstring
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Request

This endpoint expects an object.
projectintegerRequired
A unique integer value identifying this project.
role_arnstringRequired>=1 character
AWS RoleArn
aws_access_key_idstring or nullOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystring or nullOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring or nullOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring or nullOptional
AWS SSE KMS Key ID
bucketstring or nullOptional
S3 bucket name
can_delete_objectsboolean or nullOptional
Deletion from storage enabled
descriptionstring or nullOptional
Cloud storage description
external_idstring or nullOptional
AWS ExternalId
last_syncstring or nullOptionalformat: "date-time"
Last sync finished time
last_sync_countinteger or nullOptional0-2147483647
Count of tasks synced last time
last_sync_jobstring or nullOptional<=256 characters
Last sync job ID
legacy_authboolean or nullOptional
metaany or nullOptional
Meta and debug information about storage processes
prefixstring or nullOptional
S3 bucket prefix
regex_filterstring or nullOptional
Cloud storage regex for filtering objects
region_namestring or nullOptional
AWS Region
s3_endpointstring or nullOptional
S3 Endpoint
statusenumOptional
* `initialized` - Initialized * `queued` - Queued * `in_progress` - In progress * `failed` - Failed * `completed` - Completed * `completed_with_errors` - Completed with errors
synchronizablebooleanOptionalDefaults to true
titlestring or nullOptional<=256 characters
Cloud storage title
tracebackstring or nullOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs

Response

Validation successful