Skip to content

GetVolumeResponse

Source code in docs_src/capo_deadline/types/get_volume_response.py
class GetVolumeResponse(TypedDict, closed=True):
    volume_id: "capo_deadline.types.volume_id.VolumeId"
    """<p>The volume ID.</p>"""
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the farm that contains the fleet.</p>"""
    fleet_id: "capo_deadline.types.fleet_id.FleetId"
    """<p>The fleet ID of the fleet that contains the volume.</p>"""
    state: "capo_deadline.types.volume_state.VolumeState"
    """<p>The state of the volume.</p>"""
    size_gi_b: "capo_deadline.types.persistent_volume_size_gi_b.PersistentVolumeSizeGiB"
    """<p>The volume size in GiB.</p>"""
    availability_zone_id: "capo_deadline.types.string.String"
    """<p>The Availability Zone ID of the volume.</p>"""
    attached_worker_id: NotRequired["capo_deadline.types.worker_id.WorkerId"]
    """<p>The worker ID of the worker the volume is attached to.</p>"""
    volume_type: "capo_deadline.types.ebs_volume_type.EbsVolumeType"
    """<p>The EBS volume type.</p>"""
    iops: NotRequired["capo_deadline.types.persistent_volume_iops.PersistentVolumeIops"]
    """<p>The IOPS of the volume.</p>"""
    throughput_mi_b: NotRequired[
        "capo_deadline.types.persistent_volume_throughput_mi_b.PersistentVolumeThroughputMiB"
    ]
    """<p>The throughput of the volume in MiB.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    last_assigned_at: NotRequired["capo_deadline.types.timestamp.Timestamp"]
    """<p>The date and time the volume was last assigned to a worker.</p>"""
    last_released_at: NotRequired["capo_deadline.types.timestamp.Timestamp"]
    """<p>The date and time the volume was last released from a worker.</p>"""
    expires_at: NotRequired["capo_deadline.types.timestamp.Timestamp"]
    """<p>The date and time the volume expires and will be deleted.</p>"""

attached_worker_id instance-attribute

attached_worker_id: NotRequired[WorkerId]

The worker ID of the worker the volume is attached to.

availability_zone_id instance-attribute

availability_zone_id: String

The Availability Zone ID of the volume.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

The date and time the volume expires and will be deleted.

farm_id instance-attribute

farm_id: FarmId

The farm ID of the farm that contains the fleet.

fleet_id instance-attribute

fleet_id: FleetId

The fleet ID of the fleet that contains the volume.

iops instance-attribute

iops: NotRequired[PersistentVolumeIops]

The IOPS of the volume.

last_assigned_at instance-attribute

last_assigned_at: NotRequired[Timestamp]

The date and time the volume was last assigned to a worker.

last_released_at instance-attribute

last_released_at: NotRequired[Timestamp]

The date and time the volume was last released from a worker.

size_gi_b instance-attribute

The volume size in GiB.

state instance-attribute

state: VolumeState

The state of the volume.

throughput_mi_b instance-attribute

throughput_mi_b: NotRequired[PersistentVolumeThroughputMiB]

The throughput of the volume in MiB.

volume_id instance-attribute

volume_id: VolumeId

The volume ID.

volume_type instance-attribute

volume_type: EbsVolumeType

The EBS volume type.