Volume
Describes a volume.
Contents
- attachmentSet
-
Note
This parameter is not returned by CreateVolume.
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 is encrypted.
Type: Boolean
Required: No
- fastRestored
-
Note
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
Type: Boolean
Required: No
- iops
-
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.Type: Integer
Required: No
- kmsKeyId
-
The Amazon Resource Name (ARN) of the AWS KMS key that was used to protect the volume encryption key for the volume.
Type: String
Required: No
- multiAttachEnabled
-
Indicates whether Amazon EBS Multi-Attach is enabled.
Type: Boolean
Required: No
- operator
-
The service provider that manages the volume.
Type: OperatorResponse object
Required: No
- outpostArn
-
The Amazon Resource Name (ARN) of the Outpost.
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
- sseType
-
Note
This parameter is not returned by CreateVolume.
Reserved for future use.
Type: String
Valid Values:
sse-ebs | sse-kms | noneRequired: No
- status
-
The volume state.
Type: String
Valid Values:
creating | available | in-use | deleting | deleted | errorRequired: No
- tagSet
-
Any tags assigned to the volume.
Type: Array of Tag objects
Required: No
- throughput
-
The throughput that the volume supports, in MiB/s.
Type: Integer
Required: No
- volumeId
-
The ID of the volume.
Type: String
Required: No
- volumeType
-
The volume type.
Type: String
Valid Values:
standard | io1 | io2 | gp2 | sc1 | st1 | gp3Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
