Update a volume (AWS IAM role)
Navigation
- Amazon Web Services Simple Storage Service (AWS S3) Volumes
- Attach an Amazon Web Services (AWS) volume volume using an IAM user
- Attach an Amazon Web Services (AWS) volume using an IAM role:
- Via the visual interface
- Via the API:
- Create a volume (AWS IAM role)
- Get details of a volume (AWS IAM role)
- Update a volume (AWS IAM role)
This call updates the details of a specific volume.
Request
https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/{volume_id}
PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3210a98c1db9304ea9d9273156740f74
Content-Type: application/json
curl - -data '@patch-volume.json' -s -H "X-SBG-Auth-Token: 3210a98c1db9304ea9d9273156740f74" -H "Content-Type: application/json" -X PATCH "https://api.sb.biodatacatalyst.nhlbi.nih.gov/storage/volumes/rfranklin/output"
Header Fields
| Key | Description of value |
|---|---|
X-SBG-Auth-Tokenrequired | Your Platform authentication token. |
Content-typerequired | application/json |
Path parameters
| Key | Description of value |
|---|---|
volume_id | The volume that you want to update. |
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.
| Key | Data type of value | Description of value |
|---|---|---|
access_mode | String | Signifies whether this volume should be used for read-write ("RW") or read-only ("RO") operations.The 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. default: "RW" |
description | String | An optional description of this volume. |
servicerequired | Object | This object should contain the information about the cloud service that this volume represents. See the service object section for an explanation of its structure. |
The service object
service object| Key | Data type of value | Description of value |
|---|---|---|
credentials | Object | This object contains authentication parameters of your AWS IAM Role:external_id (optional, used if an External ID is defined as required in for the role in the AWS console)role_arn |
external_id | String | Optional information that you can use in an IAM role trust policy to designate who can assume the role. Must be provided if it is configured in your role trust policy on AWS. More info. |
role_arn | String | The ARN (Amazon Resource Name) of your role that is used to connect your S3 bucket. |
properties | Object | Contains properties of specific service. |
sse_algorithm | String | Use default AES256 server-side encryption when writing to this bucket. (Support for SSE-KMS and SSE-C will be added in a later release.) Can be: - AES256 (default)- aws:kms- null |
sse_aws_kms_key_id | String | Provide your AWS KMS ID here if you specify aws:kms as your sse_algorithm. Learn more about AWS KMS. |
{
"description": null,
"service": {
"properties": {
"sse_algorithm": "AES256"
}
},
}
Response
See a list of Platform-specific response codes that may be contained in the body of the response.
Response body
The response object contains information about the specified volume. The information is structured using the following key-value pairs:
| Key | Data type of value | Description of value |
|---|---|---|
active | Boolean | If a volume is deactivated, this field will be set to false |
id | String | ID of this volume, containing owner/name |
name | String | Name of the volume. |
description | String | The description of this volume. |
service | Object | This object more closely describes the mapping of the volume to the cloud service where the data is stored. See the service object section for an explanation of its structure. |
created_on | String | The date and time this volume was created. |
modified_on | String | The date and time this volume was last modified. |
{
"href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/rfranklin/output",
"id": "rfranklin/output",
"name": "output",
"access_mode": "RW",
"service": {
"type": "S3",
"bucket": "output_bucket",
"endpoint": "s3.amazonaws.com",
"credentials": {
"external_id": "external-volume-id-1234",
"role_arn": "arn:aws:iam::123456789012:role/test-volume-00"
},
"properties": {
"sse_algorithm": "AES256"
}
},
"created_on": "2020-06-30T08:14:02Z",
"modified_on": "2020-06-30T08:14:02Z",
"active": true
}
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.