Get details of an export job

This call will return the details of an export job.

When you export a file from a project on the Platform into a volume, you write to your cloud storage bucket. This call obtains the details of that job.

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

πŸ“˜

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/exports/{export_id}

πŸ“˜

When exporting a file from the Platform to an attached volume, export is possible only to a volume that is in the same location (cloud provider and region) as the project from which the file is being exported.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Response body

The response object contains information about the status of the export job. The information is structured using the following key-value pairs:

KeyData type of valueDescription of value
idStringID of this export job
stateStringThe state of this export job. Possible values are:
PENDING: the export is queued;
RUNNING: the export is running;
COMPLETED: the export has completed successfully;
FAILED: the export has failed.
sourceObjectExport source, as passed when this job was started by the call to start an export job .
fileStringID of the file that was exported.
destinationObjectExport destination, as passed when this job was started by the call to start an export job.
volumeStringID of the volume where to export.
locationStringLocation on the volume where the file should be exported.
started_onStringTime when the export job was started.
finished_onStringTime when the export job was finished.
propertiesObjectContains properties related to the export, including:
"sse_algorithm" - algorithm used for S3 encryption
"aws_storage_class" - storage class (STANDARD or GLACIER)
* "aws_canned_acl" - ACL which is set on the S3 bucket
overwriteBooleanWhether the file should be overwritten in the destination.
Language