VolumeInfo - Storage Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

VolumeInfo

Describes a storage volume object.

Contents

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Type: String

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

Required: No

GatewayId

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Type: String

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

Required: No

VolumeARN

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Type: String

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

Required: No

VolumeAttachmentStatus

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

VolumeId

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Type: String

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

Required: No

VolumeSizeInBytes

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Type: Long

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

See Also

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