Skip to content

Volume

Source code in docs_src/capo_ec2/types/volume.py
class Volume(TypedDict, closed=True):
    availability_zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Availability Zone for the volume.</p>"""
    outpost_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Outpost.</p>"""
    source_volume_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the source volume from which the volume copy was created. Only for volume copies.</p>"""
    iops: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the volume.</p>"""
    volume_type: NotRequired["capo_ec2.types.volume_type.VolumeType"]
    """<p>The volume type.</p>"""
    fast_restored: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<note> <p>This parameter is not returned by CreateVolume.</p> </note> <p>Indicates whether the volume was created using fast snapshot restore.</p>"""
    multi_attach_enabled: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether Amazon EBS Multi-Attach is enabled.</p>"""
    throughput: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The throughput that the volume supports, in MiB/s.</p>"""
    sse_type: NotRequired["capo_ec2.types.sse_type.SSEType"]
    """<note> <p>This parameter is not returned by CreateVolume.</p> </note> <p>Reserved for future use.</p>"""
    operator: NotRequired["capo_ec2.types.operator_response.OperatorResponse"]
    """<p>The service provider that manages the volume.</p>"""
    volume_initialization_rate: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>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 <code>null</code>.</p>"""
    volume_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the volume.</p>"""
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the volume.</p>"""
    volume_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the volume.</p>"""
    size: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The size of the volume, in GiBs.</p>"""
    snapshot_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The snapshot from which the volume was created, if applicable.</p>"""
    availability_zone: NotRequired["capo_ec2.types.string.String"]
    """<p>The Availability Zone for the volume.</p>"""
    state: NotRequired["capo_ec2.types.volume_state.VolumeState"]
    """<p>The volume state.</p>"""
    create_time: NotRequired["capo_ec2.types.date_time.DateTime"]
    """<p>The time stamp when volume creation was initiated.</p>"""
    attachments: NotRequired[
        "capo_ec2.types.volume_attachment_list.VolumeAttachmentList"
    ]
    """<note> <p>This parameter is not returned by CreateVolume.</p> </note> <p>Information about the volume attachments.</p>"""
    encrypted: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the volume is encrypted.</p>"""
    kms_key_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.</p>"""

attachments instance-attribute

attachments: NotRequired[VolumeAttachmentList]

This parameter is not returned by CreateVolume.

Information about the volume attachments.

availability_zone instance-attribute

availability_zone: NotRequired[String]

The Availability Zone for the volume.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[String]

The ID of the Availability Zone for the volume.

create_time instance-attribute

create_time: NotRequired[DateTime]

The time stamp when volume creation was initiated.

encrypted instance-attribute

encrypted: NotRequired[Boolean]

Indicates whether the volume is encrypted.

fast_restored instance-attribute

fast_restored: NotRequired[Boolean]

This parameter is not returned by CreateVolume.

Indicates whether the volume was created using fast snapshot restore.

iops instance-attribute

iops: NotRequired[Integer]

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 instance-attribute

kms_key_id: NotRequired[String]

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

multi_attach_enabled instance-attribute

multi_attach_enabled: NotRequired[Boolean]

Indicates whether Amazon EBS Multi-Attach is enabled.

operator instance-attribute

operator: NotRequired[OperatorResponse]

The service provider that manages the volume.

outpost_arn instance-attribute

outpost_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Outpost.

owner_id instance-attribute

owner_id: NotRequired[String]

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

size instance-attribute

size: NotRequired[Integer]

The size of the volume, in GiBs.

snapshot_id instance-attribute

snapshot_id: NotRequired[String]

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

source_volume_id instance-attribute

source_volume_id: NotRequired[String]

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

sse_type instance-attribute

sse_type: NotRequired[SSEType]

This parameter is not returned by CreateVolume.

Reserved for future use.

state instance-attribute

state: NotRequired[VolumeState]

The volume state.

tags instance-attribute

tags: NotRequired[TagList]

Any tags assigned to the volume.

throughput instance-attribute

throughput: NotRequired[Integer]

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

volume_arn instance-attribute

volume_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the volume.

volume_id instance-attribute

volume_id: NotRequired[String]

The ID of the volume.

volume_initialization_rate instance-attribute

volume_initialization_rate: NotRequired[Integer]

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 instance-attribute

volume_type: NotRequired[VolumeType]

The volume type.