DeadlineCloud / Client / get_volume

get_volume¶

DeadlineCloud.Client.get_volume(**kwargs)¶

Gets a persistent volume.

Request Syntax

response = client.get_volume(
    farmId='string',
    fleetId='string',
    volumeId='string'
)

Parameters:

farmId (string) –
[REQUIRED]

The farm ID of the farm that contains the fleet.
fleetId (string) –
[REQUIRED]

The fleet ID of the fleet that contains the volume.
volumeId (string) –
[REQUIRED]

The volume ID of the volume to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'volumeId': 'string',
    'farmId': 'string',
    'fleetId': 'string',
    'state': 'PENDING_CREATION'|'PENDING_ATTACHMENT'|'IN_USE'|'AVAILABLE'|'PENDING_DELETION',
    'sizeGiB': 123,
    'availabilityZoneId': 'string',
    'attachedWorkerId': 'string',
    'volumeType': 'gp3',
    'iops': 123,
    'throughputMiB': 123,
    'createdAt': datetime(2015, 1, 1),
    'lastAssignedAt': datetime(2015, 1, 1),
    'lastReleasedAt': datetime(2015, 1, 1),
    'expiresAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
- volumeId (string) –
  
  The volume ID.
- farmId (string) –
  
  The farm ID of the farm that contains the fleet.
- fleetId (string) –
  
  The fleet ID of the fleet that contains the volume.
- state (string) –
  
  The state of the volume.
- sizeGiB (integer) –
  
  The volume size in GiB.
- availabilityZoneId (string) –
  
  The Availability Zone ID of the volume.
- attachedWorkerId (string) –
  
  The worker ID of the worker the volume is attached to.
- volumeType (string) –
  
  The EBS volume type.
- iops (integer) –
  
  The IOPS of the volume.
- throughputMiB (integer) –
  
  The throughput of the volume in MiB.
- createdAt (datetime) –
  
  The date and time the resource was created.
- lastAssignedAt (datetime) –
  
  The date and time the volume was last assigned to a worker.
- lastReleasedAt (datetime) –
  
  The date and time the volume was last released from a worker.
- expiresAt (datetime) –
  
  The date and time the volume expires and will be deleted.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException