API ReferenceExport StorageS3s

Create export storage

Create a new target storage connection to a S3 bucket with IAM role access.

For information about the required fields and prerequisites, see Amazon S3 in the Label Studio documentation.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
can_delete_objectsbooleanOptional
Deletion from storage enabled.
titlestringOptional
Storage title
descriptionstringOptional
Storage description
projectintegerOptional
Project ID
bucketstringOptional
S3 bucket name
prefixstringOptional
S3 bucket prefix
external_idstringOptional
AWS External ID
role_arnstringOptional
AWS Role ARN
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint

Response

projectinteger
A unique integer value identifying this project.
idinteger or null
titlestring or null<=256 characters
Cloud storage title
descriptionstring or null
Cloud storage description
created_atdatetime or null
Creation time
bucketstring or null
S3 bucket name
prefixstring or null
S3 bucket prefix
external_idstring or null
AWS External ID
role_arnstring or null
AWS Role ARN
region_namestring or null
AWS Region
s3_endpointstring or null
S3 Endpoint