GetVolume
Gets a persistent volume.
Request Syntax
GET /2023-10-12/farms/farmId/fleets/fleetId/volumes/volumeId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"attachedWorkerId": "string",
"availabilityZoneId": "string",
"createdAt": "string",
"expiresAt": "string",
"farmId": "string",
"fleetId": "string",
"iops": number,
"lastAssignedAt": "string",
"lastReleasedAt": "string",
"sizeGiB": number,
"state": "string",
"throughputMiB": number,
"volumeId": "string",
"volumeType": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- attachedWorkerId
-
The worker ID of the worker the volume is attached to.
Type: String
Pattern:
worker-[0-9a-f]{32} - availabilityZoneId
-
The Availability Zone ID of the volume.
Type: String
- createdAt
-
The date and time the resource was created.
Type: Timestamp
- expiresAt
-
The date and time the volume expires and will be deleted.
Type: Timestamp
- farmId
-
The farm ID of the farm that contains the fleet.
Type: String
Pattern:
farm-[0-9a-f]{32} - fleetId
-
The fleet ID of the fleet that contains the volume.
Type: String
Pattern:
fleet-[0-9a-f]{32} - iops
-
The IOPS of the volume.
Type: Integer
Valid Range: Minimum value of 100. Maximum value of 80000.
- lastAssignedAt
-
The date and time the volume was last assigned to a worker.
Type: Timestamp
- lastReleasedAt
-
The date and time the volume was last released from a worker.
Type: Timestamp
- sizeGiB
-
The volume size in GiB.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65536.
- state
-
The state of the volume.
Type: String
Valid Values:
PENDING_CREATION | PENDING_ATTACHMENT | IN_USE | AVAILABLE | PENDING_DELETION - throughputMiB
-
The throughput of the volume in MiB.
Type: Integer
Valid Range: Minimum value of 125. Maximum value of 2000.
- volumeId
-
The volume ID.
Type: String
Pattern:
volume-[0-9a-f]{32} - volumeType
-
The EBS volume type.
Type: String
Valid Values:
gp3
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have permission to perform the action.
- context
-
Information about the resources in use when the exception was thrown.
HTTP Status Code: 403
- InternalServerErrorException
-
Deadline Cloud can't process your request right now. Try again later.
- retryAfterSeconds
-
The number of seconds a client should wait before retrying the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource can't be found.
- context
-
Information about the resources in use when the exception was thrown.
- resourceId
-
The identifier of the resource that couldn't be found.
- resourceType
-
The type of the resource that couldn't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a request rate quota.
- context
-
Information about the resources in use when the exception was thrown.
- quotaCode
-
Identifies the quota that is being throttled.
- retryAfterSeconds
-
The number of seconds a client should wait before retrying the request.
- serviceCode
-
Identifies the service that is being throttled.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
- context
-
Information about the resources in use when the exception was thrown.
- fieldList
-
A list of fields that failed validation.
- reason
-
The reason that the request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
