API ReferenceImport StorageS3

Update import storage

Update a specific S3 import storage connection. You will need to provide the import storage ID. You can find this using List import storages.

For more information about working with external storage, see Sync data from external storage.

Path parameters

idintegerRequired
A unique integer value identifying this s3 import storage.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
regex_filterstringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urlsbooleanOptionalDefaults to false
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
presignbooleanOptionalDefaults to true
Presign URLs for download
presign_ttlintegerOptionalDefaults to 1
Presign TTL in minutes
recursive_scanbooleanOptional
Scan recursively
titlestringOptional
Storage title
descriptionstringOptional
Storage description
projectintegerOptional
Project ID
bucketstringOptional
S3 bucket name
prefixstringOptional
S3 bucket prefix
aws_access_key_idstringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystringOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstringOptional
AWS SSE KMS Key ID
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint

Response

regex_filterstring or null
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urlsboolean or nullDefaults to false
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
presignboolean or nullDefaults to true
Presign URLs for download
presign_ttlinteger or nullDefaults to 1
Presign TTL in minutes
recursive_scanboolean or null
Scan recursively
titlestring or null
Storage title
descriptionstring or null
Storage description
projectinteger or null
Project ID
bucketstring or null
S3 bucket name
prefixstring or null
S3 bucket prefix
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