Skip to content

StorediSCSIVolume

Source code in docs_src/capo_storage_gateway/types/storedi_scsi_volume.py
class StorediSCSIVolume(TypedDict, closed=True):
    volume_arn: NotRequired["capo_storage_gateway.types.volume_arn.VolumeARN"]
    """<p>The Amazon Resource Name (ARN) of the storage volume.</p>"""
    volume_id: NotRequired["capo_storage_gateway.types.volume_id.VolumeId"]
    """<p>The unique identifier of the volume, e.g., vol-AE4B946D.</p>"""
    volume_type: NotRequired["capo_storage_gateway.types.volume_type.VolumeType"]
    """<p>One of the VolumeType enumeration values describing the type of the volume.</p>"""
    volume_status: NotRequired["capo_storage_gateway.types.volume_status.VolumeStatus"]
    """<p>One of the VolumeStatus values that indicates the state of the storage volume.</p>"""
    volume_attachment_status: NotRequired[
        "capo_storage_gateway.types.volume_attachment_status.VolumeAttachmentStatus"
    ]
    """<p>A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume">Moving your volumes to a different gateway</a>.</p>"""
    volume_size_in_bytes: "capo_storage_gateway.types.long.long"
    """<p>The size of the volume in bytes.</p>"""
    volume_progress: NotRequired[
        "capo_storage_gateway.types.double_object.DoubleObject"
    ]
    """<p>Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.</p>"""
    volume_disk_id: NotRequired["capo_storage_gateway.types.disk_id.DiskId"]
    """<p>The ID of the local disk that was specified in the <a>CreateStorediSCSIVolume</a> operation.</p>"""
    source_snapshot_id: NotRequired["capo_storage_gateway.types.snapshot_id.SnapshotId"]
    """<p>If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.</p>"""
    preserved_existing_data: "capo_storage_gateway.types.boolean2.Boolean2"
    """<p>Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>"""
    volumei_scsi_attributes: NotRequired[
        "capo_storage_gateway.types.volumei_scsi_attributes.VolumeiSCSIAttributes"
    ]
    """<p>An <a>VolumeiSCSIAttributes</a> object that represents a collection of iSCSI attributes for one stored volume.</p>"""
    created_date: NotRequired["capo_storage_gateway.types.created_date.CreatedDate"]
    """<p>The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.</p>"""
    volume_used_in_bytes: NotRequired[
        "capo_storage_gateway.types.volume_used_in_bytes.VolumeUsedInBytes"
    ]
    """<p>The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. <code>VolumeUsedInBytes</code> is different from the compressed size of the volume, which is the value that is used to calculate your bill.</p> <note> <p>This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.</p> </note>"""
    kms_key: NotRequired["capo_storage_gateway.types.kms_key.KMSKey"]
    target_name: NotRequired["capo_storage_gateway.types.target_name.TargetName"]
    """<p>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p> <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>"""

created_date instance-attribute

created_date: NotRequired[CreatedDate]

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

kms_key instance-attribute

kms_key: NotRequired[KMSKey]

preserved_existing_data instance-attribute

preserved_existing_data: Boolean2

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

source_snapshot_id instance-attribute

source_snapshot_id: NotRequired[SnapshotId]

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

target_name instance-attribute

target_name: NotRequired[TargetName]

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

volume_arn instance-attribute

volume_arn: NotRequired[VolumeARN]

The Amazon Resource Name (ARN) of the storage volume.

volume_attachment_status instance-attribute

volume_attachment_status: NotRequired[VolumeAttachmentStatus]

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

volume_disk_id instance-attribute

volume_disk_id: NotRequired[DiskId]

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

volume_id instance-attribute

volume_id: NotRequired[VolumeId]

The unique identifier of the volume, e.g., vol-AE4B946D.

volume_progress instance-attribute

volume_progress: NotRequired[DoubleObject]

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

volume_size_in_bytes instance-attribute

volume_size_in_bytes: long

The size of the volume in bytes.

volume_status instance-attribute

volume_status: NotRequired[VolumeStatus]

One of the VolumeStatus values that indicates the state of the storage volume.

volume_type instance-attribute

volume_type: NotRequired[VolumeType]

One of the VolumeType enumeration values describing the type of the volume.

volume_used_in_bytes instance-attribute

volume_used_in_bytes: NotRequired[VolumeUsedInBytes]

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

volumei_scsi_attributes instance-attribute

volumei_scsi_attributes: NotRequired[VolumeiSCSIAttributes]

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.