The Open API specification for Synapse is now available for download!

Download Open API Spec

ExternalS3UploadDestination

org.sagebionetworks.repo.model.file.ExternalS3UploadDestination

This upload destination contains information to start an upload to an external external S3 bucket connected with Synapse. The destination is mapped from an ExternalS3StorageLocationSetting.

Field Type Description
concreteType STRING Indicates which implementation this object represents.
storageLocationId INTEGER the unique id for the storage location, that points to the StorageLocationSetting
uploadType UploadType The enumeration of possible upload types.
banner STRING If set, the client should show this banner every time an upload is initiated
destinationProjectId STRING The ID of the project where this file will be uploaded.
projectStorageLocationUsage ProjectStorageLocationUsage Represent the current size and limits for a single project storage location.
baseKey STRING the optional base key, which acts as a prefix or a base folder
stsEnabled BOOLEAN Enables STS on this Storage Location
endpointUrl STRING the s3 endpoint url (default: https://s3.amazonaws.com)
bucket STRING the bucket to use