Storage: S3 Roles

✨ 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.
post/api/storages/export/s3s/validate

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/storages/export/s3s/validate
  • Auth
    API key in header Authorization

Request body

aws_access_key_idstring nullable

AWS_ACCESS_KEY_ID

aws_secret_access_keystring nullable

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring nullable

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring nullable

AWS SSE KMS Key ID

bucketstring nullable

S3 bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

descriptionstring nullable

Cloud storage description

external_idstring nullable

AWS ExternalId

last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

legacy_authboolean nullable
metaunknown
prefixstring nullable

S3 bucket prefix

projectinteger required

A unique integer value identifying this project.

regex_filterstring nullable

Cloud storage regex for filtering objects

region_namestring nullable

AWS Region

role_arnstring required

AWS RoleArn

s3_endpointstring nullable

S3 Endpoint

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Response

Validation successful

Changes

No operation changes recorded.