{"_id":"5ad5db1a8955590003ee462e","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5ad5d392af566800032a8107","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T10:59:30.322Z","from_sync":false,"order":32,"slug":"bulk-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-17T11:31:38.963Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Bulk export files from your project on CGC into your volume on either Amazon Web Services or Google Cloud Storage. One call can contain up to 100 items.\n\nFiles selected for export must not be public files or aliases. Aliases are objects stored in your cloud storage bucket which have been made available on CGC. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when [creating](doc:create-a-volume-v2) or [modifying](doc:modify-a-volume-v2) a volume.\n\nEssentially, the call writes to your cloud storage bucket on Amazon Web Services or Google Cloud Storage via the volume. If this call is successful, the original project files will become aliases to the newly exported objects on the volume. Source files will be deleted from CGC and, if no more copies of the files exist, they will no longer count towards your total storage price on CGC. In summary, once you export files from CGC to a volume, they are no longer part of the storage on CGC and cannot be exported again.\n\nLearn more about using the Volumes API for for [Amazon S3](doc:aws-cloud-storage-tutorial) and for [Google Cloud Storage](doc:google-cloud-storage-tutorial).\n\n##Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/create\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST v2/bulk/storage/exports/create\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/create \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \\\\\\n  -d '{\\n    \\\"items\\\": [\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8051c948ec3c0ce2b7c\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": true,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        },\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8191c948ec3c0ce2b7f\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": false,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        }\\n         \\n    ]\\n}\\n'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \" X-SBG-Auth-Token\\n*required* \",\n    \"0-1\": \"Your CGC [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \" Content-Type\\n*required* \",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Query parameters - Advance Access\n\nThe following parameter is Advance Access. This means that, while it is fully operational, it is subject to change. Learn more about this feature below.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`copy_only`\",\n    \"0-1\": \"Boolean\",\n    \"0-2\": \"If set to `true`, the file will be copied to a volume but the source file will remain on CGC.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Request body\n\nFor every item in the request body, you should enter the list of key-value pairs described in the table below. One API call can contain up to 100 items.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`source`\\n*required*\",\n    \"0-1\": \"Boolean\",\n    \"0-2\": \"If set to `true`, the file will be copied to a volume but the source file will remain on CGC.\",\n    \"1-0\": \"`file`\\n*required*\",\n    \"2-0\": \"`destination`\\n*required*\",\n    \"3-0\": \"`volume`\",\n    \"4-0\": \"`location`\\n*required*\",\n    \"5-0\": \"`properties`\",\n    \"6-0\": \"`sse_algorithm`\",\n    \"7-0\": \"`sse_aws_kms_key_id`\\n*applies to type:s3*\",\n    \"8-0\": \"`aws_canned_acl`\",\n    \"9-0\": \"`overwrite`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The ID of the file for export.\",\n    \"2-1\": \"Object\",\n    \"3-1\": \"String\",\n    \"4-1\": \"String\",\n    \"5-1\": \"Object\",\n    \"6-1\": \"String\",\n    \"7-1\": \"String\",\n    \"8-1\": \"String\",\n    \"9-1\": \"Boolean\",\n    \"2-2\": \"This object describes the destination to which the file will be exported.\",\n    \"3-2\": \"The ID of the volume to which the files will be exported.\",\n    \"4-2\": \"Volume-specific location to which the files will be exported. \\nThis location should be recognizable to the underlying cloud service as a valid key or path to the new files.\\n\\nPlease note that if this volume has been configured with a `prefix` parameter, the value of `prefix` will be prepended to `location` before attempting to create files on the volume.\",\n    \"5-2\": \"Service-specific properties of the export. These values override the defaults from the volume.\",\n    \"6-2\": \"S3 server-side encryption to use when exporting to this bucket.\\n\\nSupported values:\\n\\n  * `AES256` (SSE-S3 encryption)\\n  * 'aws:kms`\\n  * `null` (no server-side encryption).\\ndefault:AES256\",\n    \"7-2\": \"If AWS KMS encryption is used, this should be set to the required KMS key. If not set and `aws:kms` is set as `sse_algorithm`, default KMS key is used.\",\n    \"8-2\": \"If AWS KMS encryption is used, this should be set to the required KMS key. If not set and aws:kms is set as sse_algorithm, default KMS key is used.\",\n    \"9-2\": \"If this is set to true and a named file exists in the project where the alias is about to be created, the existing file will be deleted.\\n\\ndefault:false\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n###Example request (normal)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/bulk/storage/exports/create HTTP/1.1  \\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"items\\\": [\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8051c948ec3c0ce2b7c\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": true,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        },\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8191c948ec3c0ce2b7f\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": false,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        }\\n         \\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Sample request body for S3 service\"\n    }\n  ]\n}\n[/block]\n###Example request (advance access - copy file only)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/bulk/storage/exports?copy_only=true HTTP/1.1  \\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"items\\\": [\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8051c948ec3c0ce2b7c\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": true,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        },\\n        {\\n              \\\"source\\\": {\\n                \\\"file\\\": \\\"5abce8191c948ec3c0ce2b7f\\\"\\n              },\\n              \\\"destination\\\": {\\n                \\\"volume\\\": \\\"rfranklin/output\\\",\\n                \\\"location\\\": \\\"output.vcf\\\"\\n              },\\n              \\\"overwrite\\\": false,\\n              \\\"properties\\\": {\\n              \\\"sse_algorithm\\\": \\\"AES256\\\"\\n            }\\n        }\\n         \\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Sample request body for S3 service\"\n    }\n  ]\n}\n[/block]\n##Response\n\n[See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes).\n\n###Response body\n\nThe response object contains information about all of the exported items. The information is structured using the following key-value pairs:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"ID of this import job.\",\n    \"1-0\": \"`state`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The state of this import job. Possible values are:\\n\\n  * `PENDING`: the import is queued;\\n  * `RUNNING`: the import is running;\\n  * `COMPLETED`: the import has completed successfully;\\n  * `FAILED`: the import has failed.\",\n    \"2-0\": \"`source`\",\n    \"2-1\": \"object\",\n    \"2-2\": \"Import source, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2).\",\n    \"3-0\": \"`destination`\",\n    \"3-1\": \"object\",\n    \"3-2\": \"Import destination, as passed when this job was [start an import job](doc:start-an-import-job-v2).\",\n    \"4-0\": \"`result`\",\n    \"4-1\": \"object\",\n    \"4-2\": \"File object that was imported.\",\n    \"5-0\": \"`error`\",\n    \"5-1\": \"object\",\n    \"5-2\": \"In case of error in the import job, standard API error is returned here.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"items\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/exports/MiNOzItzc9HpRfZxoGp3YTZE8STJMZmI\\\",\\n                \\\"id\\\": \\\"MiNOzItzc9HpRfZxoGp3YTZE8STJMZmI\\\",\\n                \\\"state\\\": \\\"PENDING\\\",\\n                \\\"source\\\": {\\n                    \\\"file\\\": \\\"5abce8051c948ec3c0ce2b7c\\\"\\n                },\\n                \\\"destination\\\": {\\n                    \\\"volume\\\": \\\"rfranklin/output\\\",\\n                    \\\"location\\\": \\\"output.vcf\\\"\\n                },\\n                \\\"properties\\\": {\\n                    \\\"sse_algorithm\\\": \\\"AES256\\\",\\n                    \\\"sse_aws_kms_key_id\\\": null,\\n                    \\\"aws_canned_acl\\\": null\\n                },\\n                \\\"overwrite\\\": true\\n            }\\n        },\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/exports/1sKqNbEI8nrb3TGui6OD3ATRz1XxDRIi\\\",\\n                \\\"id\\\": \\\"1sKqNbEI8nrb3TGui6OD3ATRz1XxDRIi\\\",\\n                \\\"state\\\": \\\"PENDING\\\",\\n                \\\"source\\\": {\\n                    \\\"file\\\": \\\"5abce8191c948ec3c0ce2b7f\\\"\\n                },\\n                \\\"destination\\\": {\\n                    \\\"volume\\\": \\\"rfranklin/output.vcf\\\",\\n                    \\\"location\\\": \\\"output.vcf\\\"\\n                },\\n                \\\"properties\\\": {\\n                    \\\"sse_algorithm\\\": \\\"AES256\\\",\\n                    \\\"sse_aws_kms_key_id\\\": null,\\n                    \\\"aws_canned_acl\\\": null\\n                },\\n                \\\"overwrite\\\": false\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"start-a-bulk-export-job","type":"endpoint","title":"Start a bulk export job"}

postStart a bulk export job


Bulk export files from your project on CGC into your volume on either Amazon Web Services or Google Cloud Storage. One call can contain up to 100 items. Files selected for export must not be public files or aliases. Aliases are objects stored in your cloud storage bucket which have been made available on CGC. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when [creating](doc:create-a-volume-v2) or [modifying](doc:modify-a-volume-v2) a volume. Essentially, the call writes to your cloud storage bucket on Amazon Web Services or Google Cloud Storage via the volume. If this call is successful, the original project files will become aliases to the newly exported objects on the volume. Source files will be deleted from CGC and, if no more copies of the files exist, they will no longer count towards your total storage price on CGC. In summary, once you export files from CGC to a volume, they are no longer part of the storage on CGC and cannot be exported again. Learn more about using the Volumes API for for [Amazon S3](doc:aws-cloud-storage-tutorial) and for [Google Cloud Storage](doc:google-cloud-storage-tutorial). ##Request [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/create", "language": "text", "name": "Path" } ] } [/block] ###Example request [block:code] { "codes": [ { "code": "POST v2/bulk/storage/exports/create\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/create \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \\\n -d '{\n \"items\": [\n {\n \"source\": {\n \"file\": \"5abce8051c948ec3c0ce2b7c\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": true,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n },\n {\n \"source\": {\n \"file\": \"5abce8191c948ec3c0ce2b7f\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": false,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n }\n \n ]\n}\n'", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": " X-SBG-Auth-Token\n*required* ", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ##Query parameters - Advance Access The following parameter is Advance Access. This means that, while it is fully operational, it is subject to change. Learn more about this feature below. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`copy_only`", "0-1": "Boolean", "0-2": "If set to `true`, the file will be copied to a volume but the source file will remain on CGC." }, "cols": 3, "rows": 1 } [/block] ##Request body For every item in the request body, you should enter the list of key-value pairs described in the table below. One API call can contain up to 100 items. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`source`\n*required*", "0-1": "Boolean", "0-2": "If set to `true`, the file will be copied to a volume but the source file will remain on CGC.", "1-0": "`file`\n*required*", "2-0": "`destination`\n*required*", "3-0": "`volume`", "4-0": "`location`\n*required*", "5-0": "`properties`", "6-0": "`sse_algorithm`", "7-0": "`sse_aws_kms_key_id`\n*applies to type:s3*", "8-0": "`aws_canned_acl`", "9-0": "`overwrite`", "1-1": "String", "1-2": "The ID of the file for export.", "2-1": "Object", "3-1": "String", "4-1": "String", "5-1": "Object", "6-1": "String", "7-1": "String", "8-1": "String", "9-1": "Boolean", "2-2": "This object describes the destination to which the file will be exported.", "3-2": "The ID of the volume to which the files will be exported.", "4-2": "Volume-specific location to which the files will be exported. \nThis location should be recognizable to the underlying cloud service as a valid key or path to the new files.\n\nPlease note that if this volume has been configured with a `prefix` parameter, the value of `prefix` will be prepended to `location` before attempting to create files on the volume.", "5-2": "Service-specific properties of the export. These values override the defaults from the volume.", "6-2": "S3 server-side encryption to use when exporting to this bucket.\n\nSupported values:\n\n * `AES256` (SSE-S3 encryption)\n * 'aws:kms`\n * `null` (no server-side encryption).\ndefault:AES256", "7-2": "If AWS KMS encryption is used, this should be set to the required KMS key. If not set and `aws:kms` is set as `sse_algorithm`, default KMS key is used.", "8-2": "If AWS KMS encryption is used, this should be set to the required KMS key. If not set and aws:kms is set as sse_algorithm, default KMS key is used.", "9-2": "If this is set to true and a named file exists in the project where the alias is about to be created, the existing file will be deleted.\n\ndefault:false" }, "cols": 3, "rows": 10 } [/block] ###Example request (normal) [block:code] { "codes": [ { "code": "POST /v2/bulk/storage/exports/create HTTP/1.1 \nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": "HTTP" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"source\": {\n \"file\": \"5abce8051c948ec3c0ce2b7c\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": true,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n },\n {\n \"source\": {\n \"file\": \"5abce8191c948ec3c0ce2b7f\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": false,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n }\n \n ]\n}", "language": "json", "name": "Sample request body for S3 service" } ] } [/block] ###Example request (advance access - copy file only) [block:code] { "codes": [ { "code": "POST /v2/bulk/storage/exports?copy_only=true HTTP/1.1 \nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": "HTTP" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"source\": {\n \"file\": \"5abce8051c948ec3c0ce2b7c\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": true,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n },\n {\n \"source\": {\n \"file\": \"5abce8191c948ec3c0ce2b7f\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"overwrite\": false,\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n }\n \n ]\n}", "language": "json", "name": "Sample request body for S3 service" } ] } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes). ###Response body The response object contains information about all of the exported items. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`id`", "0-1": "string", "0-2": "ID of this import job.", "1-0": "`state`", "1-1": "string", "1-2": "The state of this import job. Possible values are:\n\n * `PENDING`: the import is queued;\n * `RUNNING`: the import is running;\n * `COMPLETED`: the import has completed successfully;\n * `FAILED`: the import has failed.", "2-0": "`source`", "2-1": "object", "2-2": "Import source, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2).", "3-0": "`destination`", "3-1": "object", "3-2": "Import destination, as passed when this job was [start an import job](doc:start-an-import-job-v2).", "4-0": "`result`", "4-1": "object", "4-2": "File object that was imported.", "5-0": "`error`", "5-1": "object", "5-2": "In case of error in the import job, standard API error is returned here." }, "cols": 3, "rows": 6 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/exports/MiNOzItzc9HpRfZxoGp3YTZE8STJMZmI\",\n \"id\": \"MiNOzItzc9HpRfZxoGp3YTZE8STJMZmI\",\n \"state\": \"PENDING\",\n \"source\": {\n \"file\": \"5abce8051c948ec3c0ce2b7c\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"properties\": {\n \"sse_algorithm\": \"AES256\",\n \"sse_aws_kms_key_id\": null,\n \"aws_canned_acl\": null\n },\n \"overwrite\": true\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/exports/1sKqNbEI8nrb3TGui6OD3ATRz1XxDRIi\",\n \"id\": \"1sKqNbEI8nrb3TGui6OD3ATRz1XxDRIi\",\n \"state\": \"PENDING\",\n \"source\": {\n \"file\": \"5abce8191c948ec3c0ce2b7f\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output.vcf\",\n \"location\": \"output.vcf\"\n },\n \"properties\": {\n \"sse_algorithm\": \"AES256\",\n \"sse_aws_kms_key_id\": null,\n \"aws_canned_acl\": null\n },\n \"overwrite\": false\n }\n }\n ]\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]