{"_id":"57855fd2a795200e00f149e0","category":{"_id":"55faf9aa17b9d00d00969f49","pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":92,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":29,"slug":"api","title":"API Reference"},"parentDoc":null,"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"},"user":"5613e4f8fdd08f2b00437620","__v":5,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-12T21:23:30.708Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"patch","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":93,"body":"This call updates the details of a specific volume.\n\nLearn more about using the Volumes API for [Amazon S3](aws-cloud-storage-tutorial) and for [Google Cloud Storage](google-cloud-storage-tutorial).\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  --data ':::at:::patch-volume.json' -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"Content-Type: application/json\\\" -X PATCH \\\"https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/output\\\"\",\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\": \"Key\",\n    \"h-1\": \"Description of value\",\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###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"0-0\": \"`volume_id`\",\n    \"0-1\": \"The volume that you want to update.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Request body\n\nIn the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`description`\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"0-1\": \"String\",\n    \"h-2\": \"Description of value\",\n    \"0-2\": \"An optional description of this volume.\",\n    \"1-0\": \"`service`\\n_required_\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"This object should contain the information about the cloud service that this volume represents.\\n\\nSee the <code><a href=\\\"#section-the-service-object\\\">service</code> object section</a> below for an explanation of its structure.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n###The `service` object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`type`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The type of cloud service supported. Currently the only valid values are `\\\"s3\\\"` for Amazon Web Services and `\\\"gcs\\\"` for Google Cloud Storage.\",\n    \"1-0\": \"`access_mode`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Signifies whether this volume should be used for read-write (`\\\"RW\\\"`) or read-only (`\\\"RO\\\"`) operations.\\n\\nThe access mode is consulted independently of the credentials granted to Seven Bridges when the volume was created, so it is possible to use a read-write credentials to register both read-write and read-only volumes using it.\\n\\n_default:_ `\\\"RW\\\"`\",\n    \"2-0\": \"`prefix`\",\n    \"2-1\": \"String\",\n    \"3-0\": \"`bucket`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3` and `gcs`_</span>\\n_required_\",\n    \"3-1\": \"String\",\n    \"4-0\": \"`root_url`\\n\\n_default: https://s3.amazonaws.com for`s3` type and https://www.googleapis.com/ for `gcs`_\",\n    \"5-0\": \"`credentials`\",\n    \"5-1\": \"Object\",\n    \"6-0\": \"<a name=\\\"access-key-id\\\"></a>`access_key_id`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\\n_required_\",\n    \"4-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-0\": \"<a name=\\\"secret-access-key\\\"></a>`secret_access_key`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\\n_required_\",\n    \"7-1\": \"String\",\n    \"8-0\": \"<a name=\\\"client-email\\\"></a>`client_email`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `gcs`_</span>\\n_required_\",\n    \"8-1\": \"String\",\n    \"9-0\": \"<a name=\\\"private-key\\\"></a>`private_key`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `gcs`_</span>\\n_required_\",\n    \"9-1\": \"String\",\n    \"10-0\": \"`properties`\",\n    \"10-1\": \"Object\",\n    \"11-0\": \"`sse_algorithm`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\",\n    \"12-0\": \"`sse_aws_kms_key_id`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\",\n    \"11-1\": \"String\",\n    \"12-1\": \"String\",\n    \"3-2\": \"The name of the AWS S3 or GCS bucket you wish to register as a volume.\",\n    \"2-2\": \"A service-specific prefix to prepend to all objects created in this volume. If the service supports folders, and this prefix includes them, the API will attempt to create any missing folders when it outputs a file.\\n\\n_default:_ `\\\"\\\"`\",\n    \"4-2\": \"Cloud provider API endpoint to use when accessing this bucket.\\n\\nFor a list of AWS-supported endpoints, see <a href=\\\"http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\\\" target=\\\"blank\\\">AWS Regions and Endpoints</a>.\",\n    \"5-2\": \"Contains credentials for underlying cloud provider.\\nFor Amazon Web Services, these credentials are:\\n* <code><a href=\\\"#access-key-id\\\">access_key_id</code></a>\\n* <code><a href=\\\"#secret-access-key\\\">secret_access_key</code></a>\\n\\nFor Google Cloud Storage, these credentials are:\\n* <code><a href=\\\"#client-email\\\">client_email</code></a>\\n* <code><a href=\\\"#private-key\\\">private_key</code></a>\",\n    \"6-2\": \"AWS access key ID of the IAM user shared with the CGC to access this bucket.\",\n    \"7-2\": \"AWS secret access key of the IAM user shared with the CGC to access this bucket.\",\n    \"8-2\": \"Google Cloud Storage user email.\",\n    \"9-2\": \"Google Cloud Storage private key.\",\n    \"10-2\": \"Contains properties of specific service.\",\n    \"11-2\": \"Use default AES256 server-side encryption or AWS KMS encryption when writing to this bucket.\\n\\nCan be:\\n  * AES256 (default)\\n  * `aws:kms`\\n\\n_default: AES256_\",\n    \"12-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  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"description\\\": null,\\n  \\\"service\\\": {\\n    \\\"properties\\\": {\\n      \\\"sse_algorithm\\\": \\\"AES256\\\"\\n    }\\n  },\\n}\\n\",\n      \"language\": \"text\",\n      \"name\": \"Example request body\"\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.](doc:api-status-codes) \n\n###Response body\nThe response object contains information about the specified volume. The information is structured using the following key-value pairs:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`active`\",\n    \"1-0\": \"`id`\",\n    \"0-1\": \"Boolean\",\n    \"1-1\": \"String\",\n    \"2-1\": \"String\",\n    \"2-0\": \"`name`\",\n    \"3-0\": \"`description`\",\n    \"3-1\": \"String\",\n    \"4-0\": \"`service`\",\n    \"4-1\": \"Object\",\n    \"5-0\": \"`created_on`\",\n    \"5-1\": \"String\",\n    \"6-0\": \"`modified_on`\",\n    \"6-1\": \"String\",\n    \"0-2\": \"If a volume is deactivated, this field will be set to false\",\n    \"1-2\": \"ID of this volume, containing owner/name\",\n    \"2-2\": \"Name of the volume.\",\n    \"3-2\": \"The description of this volume.\",\n    \"4-2\": \"This object more closely describes the mapping of the volume to the cloud service where the data is stored.\\n\\nSee the <code><a href=\\\"#section-the-service-object\\\">service</code> object section</a> above for an explanation of its structure.\",\n    \"5-2\": \"The date and time this volume was created.\",\n    \"6-2\": \"The date and time this volume was last modified.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://api.sbgenomics.com/v2/storage/volumes/rfranklin/output\\\",\\n  \\\"id\\\": \\\"rfranklin/output\\\",\\n  \\\"name\\\": \\\"output\\\",\\n  \\\"access_mode\\\": \\\"RW\\\",\\n  \\\"service\\\": {\\n    \\\"type\\\": \\\"S3\\\",\\n    \\\"bucket\\\": \\\"output_bucket\\\",\\n    \\\"prefix\\\": \\\"outfiles\\\",\\n    \\\"endpoint\\\": \\\"s3.amazonaws.com\\\",\\n    \\\"credentials\\\": {\\n      \\\"access_key_id\\\": \\\"AKIAJRC7TPMRMDKOFXGA\\\"\\n    },\\n    \\\"properties\\\": {\\n      \\\"sse_algorithm\\\": \\\"AES256\\\"\\n    }\\n  },\\n  \\\"created_on\\\": \\\"2016-06-30T08:14:02Z\\\",\\n  \\\"modified_on\\\": \\\"2016-06-30T08:14:02Z\\\",\\n  \\\"active\\\": true\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Note that you cannot view volumes that you have created via the visual interface. However, you can see all your volumes by making the call to [list volumes](list-volumes-v2).\"\n}\n[/block]","excerpt":"","slug":"update-a-volume-v2","type":"endpoint","title":"Update a volume"}

GET STARTED

TUTORIALS

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING YOUR PRIVATE DATA

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

BRING YOUR TOOLS

DESCRIBE YOUR TOOL

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API Reference

BULK API ACTIONS

WATCH AND LEARN

DATA CRUNCHER

SBFS (Beta)

SBFS Command Reference

GLOSSARY

patchUpdate a volume

This call updates the details of a specific volume. Learn more about using the Volumes API for [Amazon S3](aws-cloud-storage-tutorial) and for [Google Cloud Storage](google-cloud-storage-tutorial). [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\nContent-Type: application/json", "language": "http", "name": null }, { "code": "curl --data '@patch-volume.json' -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"Content-Type: application/json\" -X PATCH \"https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/output\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "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] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "0-0": "`volume_id`", "0-1": "The volume that you want to update." }, "cols": 2, "rows": 1 } [/block] ###Request body In the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table. [block:parameters] { "data": { "0-0": "`description`", "h-0": "Key", "h-1": "Data type of value", "0-1": "String", "h-2": "Description of value", "0-2": "An optional description of this volume.", "1-0": "`service`\n_required_", "1-1": "Object", "1-2": "This object should contain the information about the cloud service that this volume represents.\n\nSee the <code><a href=\"#section-the-service-object\">service</code> object section</a> below for an explanation of its structure." }, "cols": 3, "rows": 2 } [/block] ###The `service` object [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`type`", "0-1": "string", "0-2": "The type of cloud service supported. Currently the only valid values are `\"s3\"` for Amazon Web Services and `\"gcs\"` for Google Cloud Storage.", "1-0": "`access_mode`", "1-1": "string", "1-2": "Signifies whether this volume should be used for read-write (`\"RW\"`) or read-only (`\"RO\"`) operations.\n\nThe access mode is consulted independently of the credentials granted to Seven Bridges when the volume was created, so it is possible to use a read-write credentials to register both read-write and read-only volumes using it.\n\n_default:_ `\"RW\"`", "2-0": "`prefix`", "2-1": "String", "3-0": "`bucket`\n\n<span style=\"color:#871818\">_applies to type: `s3` and `gcs`_</span>\n_required_", "3-1": "String", "4-0": "`root_url`\n\n_default: https://s3.amazonaws.com for`s3` type and https://www.googleapis.com/ for `gcs`_", "5-0": "`credentials`", "5-1": "Object", "6-0": "<a name=\"access-key-id\"></a>`access_key_id`\n\n<span style=\"color:#871818\">_applies to type: `s3`_</span>\n_required_", "4-1": "String", "6-1": "String", "7-0": "<a name=\"secret-access-key\"></a>`secret_access_key`\n\n<span style=\"color:#871818\">_applies to type: `s3`_</span>\n_required_", "7-1": "String", "8-0": "<a name=\"client-email\"></a>`client_email`\n\n<span style=\"color:#871818\">_applies to type: `gcs`_</span>\n_required_", "8-1": "String", "9-0": "<a name=\"private-key\"></a>`private_key`\n\n<span style=\"color:#871818\">_applies to type: `gcs`_</span>\n_required_", "9-1": "String", "10-0": "`properties`", "10-1": "Object", "11-0": "`sse_algorithm`\n\n<span style=\"color:#871818\">_applies to type: `s3`_</span>", "12-0": "`sse_aws_kms_key_id`\n\n<span style=\"color:#871818\">_applies to type: `s3`_</span>", "11-1": "String", "12-1": "String", "3-2": "The name of the AWS S3 or GCS bucket you wish to register as a volume.", "2-2": "A service-specific prefix to prepend to all objects created in this volume. If the service supports folders, and this prefix includes them, the API will attempt to create any missing folders when it outputs a file.\n\n_default:_ `\"\"`", "4-2": "Cloud provider API endpoint to use when accessing this bucket.\n\nFor a list of AWS-supported endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\" target=\"blank\">AWS Regions and Endpoints</a>.", "5-2": "Contains credentials for underlying cloud provider.\nFor Amazon Web Services, these credentials are:\n* <code><a href=\"#access-key-id\">access_key_id</code></a>\n* <code><a href=\"#secret-access-key\">secret_access_key</code></a>\n\nFor Google Cloud Storage, these credentials are:\n* <code><a href=\"#client-email\">client_email</code></a>\n* <code><a href=\"#private-key\">private_key</code></a>", "6-2": "AWS access key ID of the IAM user shared with the CGC to access this bucket.", "7-2": "AWS secret access key of the IAM user shared with the CGC to access this bucket.", "8-2": "Google Cloud Storage user email.", "9-2": "Google Cloud Storage private key.", "10-2": "Contains properties of specific service.", "11-2": "Use default AES256 server-side encryption or AWS KMS encryption when writing to this bucket.\n\nCan be:\n * AES256 (default)\n * `aws:kms`\n\n_default: AES256_", "12-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." }, "cols": 3, "rows": 13 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"description\": null,\n \"service\": {\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n },\n}\n", "language": "text", "name": "Example request body" } ] } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Response body The response object contains information about the specified volume. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`active`", "1-0": "`id`", "0-1": "Boolean", "1-1": "String", "2-1": "String", "2-0": "`name`", "3-0": "`description`", "3-1": "String", "4-0": "`service`", "4-1": "Object", "5-0": "`created_on`", "5-1": "String", "6-0": "`modified_on`", "6-1": "String", "0-2": "If a volume is deactivated, this field will be set to false", "1-2": "ID of this volume, containing owner/name", "2-2": "Name of the volume.", "3-2": "The description of this volume.", "4-2": "This object more closely describes the mapping of the volume to the cloud service where the data is stored.\n\nSee the <code><a href=\"#section-the-service-object\">service</code> object section</a> above for an explanation of its structure.", "5-2": "The date and time this volume was created.", "6-2": "The date and time this volume was last modified." }, "cols": 3, "rows": 7 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://api.sbgenomics.com/v2/storage/volumes/rfranklin/output\",\n \"id\": \"rfranklin/output\",\n \"name\": \"output\",\n \"access_mode\": \"RW\",\n \"service\": {\n \"type\": \"S3\",\n \"bucket\": \"output_bucket\",\n \"prefix\": \"outfiles\",\n \"endpoint\": \"s3.amazonaws.com\",\n \"credentials\": {\n \"access_key_id\": \"AKIAJRC7TPMRMDKOFXGA\"\n },\n \"properties\": {\n \"sse_algorithm\": \"AES256\"\n }\n },\n \"created_on\": \"2016-06-30T08:14:02Z\",\n \"modified_on\": \"2016-06-30T08:14:02Z\",\n \"active\": true\n}", "language": "json" } ], "sidebar": true } [/block] [block:callout] { "type": "success", "body": "Note that you cannot view volumes that you have created via the visual interface. However, you can see all your volumes by making the call to [list volumes](list-volumes-v2)." } [/block]