Skip to content

EC2  >  Structures  >  Volume

Volume

Structure Class

Volume dataclass

Bases: _SerdeShape

Describes a volume.

Attributes

attachments class-attribute instance-attribute 
attachments: list[VolumeAttachment] | None = ...
Note

This parameter is not returned by CreateVolume.

Information about the volume attachments.

availability_zone class-attribute instance-attribute 
availability_zone: str | None = ...

The Availability Zone for the volume.

availability_zone_id class-attribute instance-attribute 
availability_zone_id: str | None = ...

The ID of the Availability Zone for the volume.

create_time class-attribute instance-attribute 
create_time: datetime | None = ...

The time stamp when volume creation was initiated.

encrypted class-attribute instance-attribute 
encrypted: bool | None = ...

Indicates whether the volume is encrypted.

fast_restored class-attribute instance-attribute 
fast_restored: bool | None = ...
Note

This parameter is not returned by CreateVolume.

Indicates whether the volume was created using fast snapshot restore.

iops class-attribute instance-attribute 
iops: int | None = ...

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = ...

The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.

multi_attach_enabled class-attribute instance-attribute 
multi_attach_enabled: bool | None = ...

Indicates whether Amazon EBS Multi-Attach is enabled.

operator class-attribute instance-attribute 
operator: OperatorResponse | None = ...

The service provider that manages the volume.

outpost_arn class-attribute instance-attribute 
outpost_arn: str | None = ...

The Amazon Resource Name (ARN) of the Outpost.

owner_id class-attribute instance-attribute 
owner_id: str | None = ...

The ID of the Amazon Web Services account that owns the volume.

size class-attribute instance-attribute 
size: int | None = ...

The size of the volume, in GiBs.

snapshot_id class-attribute instance-attribute 
snapshot_id: str | None = ...

The snapshot from which the volume was created, if applicable.

source_volume_id class-attribute instance-attribute 
source_volume_id: str | None = ...

The ID of the source volume from which the volume copy was created. Only for volume copies.

sse_type class-attribute instance-attribute 
sse_type: str | None = ...
Note

This parameter is not returned by CreateVolume.

Reserved for future use.

state class-attribute instance-attribute 
state: str | None = ...

The volume state.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

Any tags assigned to the volume.

throughput class-attribute instance-attribute 
throughput: int | None = ...

The throughput that the volume supports, in MiB/s.

volume_arn class-attribute instance-attribute 
volume_arn: str | None = ...

The Amazon Resource Name (ARN) of the volume.

volume_id class-attribute instance-attribute 
volume_id: str | None = ...

The ID of the volume.

volume_initialization_rate class-attribute instance-attribute 
volume_initialization_rate: int | None = ...

The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.

volume_type class-attribute instance-attribute 
volume_type: str | None = ...

The volume type.