DeadlineCloud / Client / list_volumes

list_volumes¶

DeadlineCloud.Client.list_volumes(**kwargs)¶

Lists the persistent volumes in a fleet.

Request Syntax

response = client.list_volumes(
    farmId='string',
    fleetId='string',
    nextToken='string',
    maxResults=123
)

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 volumes.
nextToken (string) – The token for the next set of results, or null to start from the beginning.
maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

{
    'volumes': [
        {
            'volumeId': 'string',
            'farmId': 'string',
            'fleetId': 'string',
            'state': 'PENDING_CREATION'|'PENDING_ATTACHMENT'|'IN_USE'|'AVAILABLE'|'PENDING_DELETION',
            'sizeGiB': 123,
            'availabilityZoneId': 'string',
            'attachedWorkerId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Shared pagination field for List operation outputs (nextToken).
- volumes (list) –
  
  The volumes on the list.
  - (dict) –
    
    The summary of a persistent volume.
    - 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.
- nextToken (string) –
  
  If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions

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