Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

StorediSCSIVolume

Describes an iSCSI stored volume.

Contents

CreatedDate

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.

Type: Timestamp

Required: No

PreservedExistingData

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

Type: Boolean

Required: No

SourceSnapshotId

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Type: String

Pattern: \Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z

Required: No

VolumeARN

The Amazon Resource Name (ARN) of the storage volume.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: No

VolumeDiskId

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: No

VolumeId

The unique identifier of the volume, e.g. vol-AE4B946D.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 30.

Required: No

VolumeiSCSIAttributes

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Type: VolumeiSCSIAttributes object

Required: No

VolumeProgress

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Type: Double

Required: No

VolumeSizeInBytes

The size of the volume in bytes.

Type: Long

Required: No

VolumeStatus

One of the VolumeStatus values that indicates the state of the storage volume.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

Required: No

VolumeType

One of the VolumeType enumeration values describing the type of the volume.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

VolumeUsedInBytes

The size of the data stored on the volume in bytes.

Note

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Type: Long

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: