AWS EBS

Describe volumes

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Describe EBS volumes.

Inputs

Expand All

Champ

Type

Description

region [required]

enum

default: us-east-1

filters

[object]

One or more filters.

Name

string

The name of the filter. Filter names are case-sensitive.

Values

[string]

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

volumeIds

[string]

Volume IDs.

maxResults

number

The maximum number of volume results returned by DescribeVolumes in paginated output.

Outputs

Expand All

Champ

Type

Description

volumes

[object]

Information about the volumes.

Attachments

[object]

This parameter is not returned by CreateVolume. Information about the volume attachments.

AttachTime

date-time

The time stamp when the attachment initiated.

Device

string

The device name. If the volume is attached to a Fargate task, this parameter returns null.

InstanceId

string

The ID of the instance. If the volume is attached to a Fargate task, this parameter returns null.

State

string

The attachment state of the volume.

VolumeId

string

The ID of the volume.

DeleteOnTermination

boolean

Indicates whether the EBS volume is deleted on instance termination.

AssociatedResource

string

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

InstanceOwningService

string

The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached. This parameter is returned only for volumes that are attached to Fargate tasks.

AvailabilityZone

string

The Availability Zone for the volume.

CreateTime

date-time

The time stamp when volume creation was initiated.

Encrypted

boolean

Indicates whether the volume is encrypted.

KmsKeyId

string

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

OutpostArn

string

The Amazon Resource Name (ARN) of the Outpost.

Size

number

The size of the volume, in GiBs.

SnapshotId

string

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

State

string

The volume state.

VolumeId

string

The ID of the volume.

Iops

number

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.

Tags

[object]

Any tags assigned to the volume.

Key

string

The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

Value

string

The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

VolumeType

string

The volume type.

FastRestored

boolean

This parameter is not returned by CreateVolume. Indicates whether the volume was created using fast snapshot restore.

MultiAttachEnabled

boolean

Indicates whether Amazon EBS Multi-Attach is enabled.

Throughput

number

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

SseType

string

This parameter is not returned by CreateVolume. Reserved for future use.

amzRequestId [required]

string