Skip to content

VolumeInfo

Source code in docs_src/capo_storage_gateway/types/volume_info.py
class VolumeInfo(TypedDict, closed=True):
    volume_arn: NotRequired["capo_storage_gateway.types.volume_arn.VolumeARN"]
    """<p>The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:</p> <p> <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB</code> </p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"""
    volume_id: NotRequired["capo_storage_gateway.types.volume_id.VolumeId"]
    """<p>The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"""
    gateway_arn: NotRequired["capo_storage_gateway.types.gateway_arn.GatewayARN"]
    gateway_id: NotRequired["capo_storage_gateway.types.gateway_id.GatewayId"]
    """<p>The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</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_size_in_bytes: "capo_storage_gateway.types.long.long"
    """<p>The size of the volume in bytes.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"""
    volume_attachment_status: NotRequired[
        "capo_storage_gateway.types.volume_attachment_status.VolumeAttachmentStatus"
    ]
    """<p>One of the VolumeStatus values that indicates the state of the storage volume.</p>"""

gateway_arn instance-attribute

gateway_arn: NotRequired[GatewayARN]

gateway_id instance-attribute

gateway_id: NotRequired[GatewayId]

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volume_arn instance-attribute

volume_arn: NotRequired[VolumeARN]

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volume_attachment_status instance-attribute

volume_attachment_status: NotRequired[VolumeAttachmentStatus]

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

volume_id instance-attribute

volume_id: NotRequired[VolumeId]

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volume_size_in_bytes instance-attribute

volume_size_in_bytes: long

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volume_type instance-attribute

volume_type: NotRequired[VolumeType]

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