volumes

Creates, updates, deletes, gets or lists a volumes resource.

Overview

Name	volumes
Type	Resource
Id	aws.deadline.volumes

Fields

The following fields are returned by SELECT queries:

get_volume

Name	Datatype	Description
attached_worker_id	string	The worker ID of the worker the volume is attached to. (pattern: <code>worker-[0-9a-f]{32}</code>)
availability_zone_id	string	The Availability Zone ID of the volume.
created_at	string (date-time)	The date and time the resource was created.
expires_at	string (date-time)	The date and time the volume expires and will be deleted.
farm_id	string	The farm ID of the farm that contains the fleet. (pattern: <code>farm-[0-9a-f]{32}</code>)
fleet_id	string	The fleet ID of the fleet that contains the volume. (pattern: <code>fleet-[0-9a-f]{32}</code>)
iops	integer	The IOPS of the volume.
last_assigned_at	string (date-time)	The date and time the volume was last assigned to a worker.
last_released_at	string (date-time)	The date and time the volume was last released from a worker.
size_gi_b	integer	The volume size in GiB.
state	string	The state of the volume. (PENDING_CREATION, PENDING_ATTACHMENT, IN_USE, AVAILABLE, PENDING_DELETION)
throughput_mi_b	integer	The throughput of the volume in MiB.
volume_id	string	The volume ID. (pattern: <code>volume-[0-9a-f]{32}</code>)
volume_type	string	The EBS volume type. (gp3)

list_volumes

Name	Datatype	Description
attached_worker_id	string	The worker ID of the worker the volume is attached to. (pattern: <code>worker-[0-9a-f]{32}</code>)
availability_zone_id	string	The Availability Zone ID of the volume.
farm_id	string	The farm ID of the farm that contains the fleet. (pattern: <code>farm-[0-9a-f]{32}</code>)
fleet_id	string	The fleet ID of the fleet that contains the volume. (pattern: <code>fleet-[0-9a-f]{32}</code>)
size_gi_b	integer	The volume size in GiB.
state	string	The state of the volume. (PENDING_CREATION, PENDING_ATTACHMENT, IN_USE, AVAILABLE, PENDING_DELETION)
volume_id	string	The volume ID. (pattern: <code>volume-[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_volume	select	farm_id, fleet_id, volume_id, region		Gets a persistent volume.
list_volumes	select	farm_id, fleet_id, region	nextToken, maxResults	Lists the persistent volumes in a fleet.
delete_volume	delete	farm_id, fleet_id, volume_id, region		Deletes a persistent volume.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID of the farm that contains the fleet.
fleet_id	string	The fleet ID of the fleet that contains the volume.
region	string	AWS region (default: us-east-1)
volume_id	string	The volume ID of the volume to delete.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_volume

Gets a persistent volume.

SELECT
attached_worker_id,
availability_zone_id,
created_at,
expires_at,
farm_id,
fleet_id,
iops,
last_assigned_at,
last_released_at,
size_gi_b,
state,
throughput_mi_b,
volume_id,
volume_type
FROM aws.deadline.volumes
WHERE farm_id = '{{ farm_id }}' -- required
AND fleet_id = '{{ fleet_id }}' -- required
AND volume_id = '{{ volume_id }}' -- required
AND region = '{{ region }}' -- required
;

list_volumes

Lists the persistent volumes in a fleet.

SELECT
attached_worker_id,
availability_zone_id,
farm_id,
fleet_id,
size_gi_b,
state,
volume_id
FROM aws.deadline.volumes
WHERE farm_id = '{{ farm_id }}' -- required
AND fleet_id = '{{ fleet_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

DELETE examples

delete_volume

Deletes a persistent volume.

DELETE FROM aws.deadline.volumes
WHERE farm_id = '{{ farm_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND volume_id = '{{ volume_id }}' --required
AND region = '{{ region }}' --required
;