Update import storage

PATCH

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.

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_urlsbooleanOptional
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.
presignbooleanOptional
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

This endpoint returns an object.
regex_filterstringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urlsbooleanOptional
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.
presignbooleanOptional
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
Built with