StorageLocation¶
Contained within this file are experimental interfaces for working with the Synapse Python Client. Unless otherwise noted these interfaces are subject to change at any time. Use at your own risk.
API Reference¶
synapseclient.models.StorageLocation
dataclass
¶
Bases: EnumCoercionMixin, StorageLocationSynchronousProtocol
A storage location setting describes where files are uploaded to and downloaded from via Synapse. Storage location settings may be created for external locations, such as user-owned Amazon S3 buckets, Google Cloud Storage buckets, SFTP servers, or proxy storage.
| ATTRIBUTE | DESCRIPTION |
|---|---|
storage_location_id |
(Read Only) The unique ID for this storage location, assigned by the server on creation. |
storage_type |
The type of storage location. Required when creating a new
storage location via
TYPE:
|
banner |
The banner text to display to a user every time a file is uploaded. This field is optional. |
description |
A description of the storage location. This description is shown when a user has to choose which upload destination to use. |
| ATTRIBUTE | DESCRIPTION |
|---|---|
bucket |
The name of the S3 or Google Cloud Storage bucket. Applicable to
|
base_key |
The optional base key (prefix/folder) within the bucket.
Applicable to |
sts_enabled |
Whether STS (AWS Security Token Service) is enabled on this
storage location. Applicable to |
endpoint_url |
The endpoint URL of the S3 service. Applicable to
|
| ATTRIBUTE | DESCRIPTION |
|---|---|
url |
The base URL for uploading to the external destination. Applicable to
|
supports_subfolders |
Whether the destination supports creating subfolders
under the base url. Applicable to |
| ATTRIBUTE | DESCRIPTION |
|---|---|
proxy_url |
The HTTPS URL of the proxy used for upload and download.
Applicable to |
secret_key |
The encryption key used to sign all pre-signed URLs used to
communicate with the proxy. Applicable to |
benefactor_id |
An Entity ID (such as a Project ID). When set, any user with
the 'create' permission on the given benefactorId will be allowed to
create ProxyFileHandle using its storage location ID. Applicable to
|
| ATTRIBUTE | DESCRIPTION |
|---|---|
upload_type |
(Read Only) The upload type for this storage location.
Automatically derived from
TYPE:
|
etag |
(Read Only) Synapse employs an Optimistic Concurrency Control (OCC) scheme. The E-Tag changes every time the setting is updated. |
created_on |
(Read Only) The date this storage location setting was created. |
created_by |
(Read Only) The ID of the user that created this storage location setting. |
Creating an external S3 storage location
Create a storage location backed by your own S3 bucket:
from synapseclient.models import StorageLocation, StorageLocationType
import synapseclient
synapseclient.login()
storage = StorageLocation(
storage_type=StorageLocationType.EXTERNAL_S3,
bucket="my-external-synapse-bucket",
base_key="path/within/bucket",
).store()
print(f"Storage location ID: {storage.storage_location_id}")
Creating a Google Cloud storage location
Create a storage location backed by your own GCS bucket:
from synapseclient.models import StorageLocation, StorageLocationType
import synapseclient
synapseclient.login()
storage = StorageLocation(
storage_type=StorageLocationType.EXTERNAL_GOOGLE_CLOUD,
bucket="my-gcs-bucket",
base_key="path/within/bucket",
).store()
Source code in synapseclient/models/storage_location.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | |
Functions¶
store_async
async
¶
store_async(*, synapse_client: Optional[Synapse] = None) -> StorageLocation
Create this storage location in Synapse. Storage locations are immutable; this always creates a new one. If a storage location with identical properties already exists for this user, the existing one is returned (idempotent).
| PARAMETER | DESCRIPTION |
|---|---|
synapse_client
|
If not passed in and caching was not disabled by
|
| RETURNS | DESCRIPTION |
|---|---|
StorageLocation
|
The StorageLocation object with server-assigned fields populated. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If |
Using this function
Create an external S3 storage location:
import asyncio
from synapseclient import Synapse
from synapseclient.models import StorageLocation, StorageLocationType
syn = Synapse()
syn.login()
async def main():
storage = await StorageLocation(
storage_type=StorageLocationType.EXTERNAL_S3,
bucket="my-bucket",
base_key="my/prefix",
).store_async()
print(f"Created storage location: {storage.storage_location_id}")
asyncio.run(main())
Source code in synapseclient/models/storage_location.py
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 | |
get_async
async
¶
get_async(*, synapse_client: Optional[Synapse] = None) -> StorageLocation
Retrieve this storage location from Synapse by its ID. Only the creator of a StorageLocationSetting can retrieve it by its id.
| PARAMETER | DESCRIPTION |
|---|---|
synapse_client
|
If not passed in and caching was not disabled by
|
| RETURNS | DESCRIPTION |
|---|---|
StorageLocation
|
The StorageLocation object populated with data from Synapse. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If |
Using this function
Retrieve a storage location by ID:
import asyncio
from synapseclient import Synapse
from synapseclient.models import StorageLocation
syn = Synapse()
syn.login()
async def main():
storage = await StorageLocation(storage_location_id=12345).get_async()
print(f"Type: {storage.storage_type}, Bucket: {storage.bucket}")
asyncio.run(main())
Source code in synapseclient/models/storage_location.py
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | |
synapseclient.models.StorageLocationType
dataclass
¶
Describes a Synapse storage location type.
Each instance is a distinct object identified by its name, so SFTP and
HTTPS remain separate even though they share the same backend
concreteType (ExternalStorageLocationSetting).
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
Human-readable identifier (e.g.
TYPE:
|
concrete_type |
The
TYPE:
|
Source code in synapseclient/models/storage_location.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | |
synapseclient.models.UploadType
¶
Enumeration of upload types for storage locations.
| ATTRIBUTE | DESCRIPTION |
|---|---|
S3 |
Amazon S3 compatible upload.
|
GOOGLE_CLOUD_STORAGE |
Google Cloud Storage upload.
|
SFTP |
SFTP upload.
|
HTTPS |
HTTPS upload (typically used with proxy storage).
|
NONE |
No upload type specified.
|
Source code in synapseclient/models/storage_location.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | |