Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

Volume

Describes a volume.

Contents

attachmentSet

Information about the volume attachments.

Type: array of VolumeAttachment objects

Required: No

availabilityZone

The Availability Zone for the volume.

Type: String

Required: No

createTime

The time stamp when volume creation was initiated.

Type: Timestamp

Required: No

encrypted

Indicates whether the volume will be encrypted.

Type: Boolean

Required: No

iops

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Type: Integer

Required: No

kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

Type: String

Required: No

size

The size of the volume, in GiBs.

Type: Integer

Required: No

snapshotId

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

Type: String

Required: No

status

The volume state.

Type: String

Valid Values: creating | available | in-use | deleting | deleted | error

Required: No

tagSet

Any tags assigned to the volume.

Type: array of Tag objects

Required: No

volumeId

The ID of the volume.

Type: String

Required: No

volumeType

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Type: String

Valid Values: standard | io1 | gp2 | sc1 | st1

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: