Amazonka.StorageGateway.Types.VolumeInfo

Documentation

data VolumeInfo

Describes a storage volume object.

See: newVolumeInfo smart constructor.

Constructors

VolumeInfo'

Fields

• gatewayARN :: Maybe Text
• gatewayId :: Maybe Text

  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 (-).

• volumeARN :: Maybe Text

  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 (-).

• volumeAttachmentStatus :: Maybe Text

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

• volumeId :: Maybe Text

  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 (-).

• volumeSizeInBytes :: Maybe Integer

  The size of the volume in bytes.

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

• volumeType :: Maybe Text

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

Instances

FromJSON VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

parseJSON :: Value -> Parser VolumeInfo

parseJSONList :: Value -> Parser [VolumeInfo]

Generic VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Associated Types

type Rep VolumeInfo :: Type -> Type

Methods

from :: VolumeInfo -> Rep VolumeInfo x

to :: Rep VolumeInfo x -> VolumeInfo

Read VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

readsPrec :: Int -> ReadS VolumeInfo

readList :: ReadS [VolumeInfo]

readPrec :: ReadPrec VolumeInfo

readListPrec :: ReadPrec [VolumeInfo]

Show VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

showsPrec :: Int -> VolumeInfo -> ShowS

show :: VolumeInfo -> String

showList :: [VolumeInfo] -> ShowS

NFData VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

rnf :: VolumeInfo -> ()

Eq VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

(==) :: VolumeInfo -> VolumeInfo -> Bool

(/=) :: VolumeInfo -> VolumeInfo -> Bool

Hashable VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

Methods

hashWithSalt :: Int -> VolumeInfo -> Int

hash :: VolumeInfo -> Int

type Rep VolumeInfo

Defined in Amazonka.StorageGateway.Types.VolumeInfo

type Rep VolumeInfo = D1 ('MetaData "VolumeInfo" "Amazonka.StorageGateway.Types.VolumeInfo" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "VolumeInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "volumeAttachmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "volumeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "volumeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVolumeInfo :: VolumeInfo

Create a value of VolumeInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:gatewayARN:VolumeInfo', volumeInfo_gatewayARN - Undocumented member.

$sel:gatewayId:VolumeInfo', volumeInfo_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 (-).

$sel:volumeARN:VolumeInfo', volumeInfo_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 (-).

$sel:volumeAttachmentStatus:VolumeInfo', volumeInfo_volumeAttachmentStatus - One of the VolumeStatus values that indicates the state of the storage volume.

$sel:volumeId:VolumeInfo', volumeInfo_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 (-).

$sel:volumeSizeInBytes:VolumeInfo', volumeInfo_volumeSizeInBytes - The size of the volume in bytes.

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

$sel:volumeType:VolumeInfo', volumeInfo_volumeType - One of the VolumeType enumeration values describing the type of the volume.

volumeInfo_gatewayARN :: Lens' VolumeInfo (Maybe Text)

Undocumented member.

volumeInfo_gatewayId :: Lens' VolumeInfo (Maybe Text)

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 (-).

volumeInfo_volumeARN :: Lens' VolumeInfo (Maybe Text)

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 (-).

volumeInfo_volumeAttachmentStatus :: Lens' VolumeInfo (Maybe Text)

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

volumeInfo_volumeId :: Lens' VolumeInfo (Maybe Text)

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 (-).

volumeInfo_volumeSizeInBytes :: Lens' VolumeInfo (Maybe Integer)

The size of the volume in bytes.

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

volumeInfo_volumeType :: Lens' VolumeInfo (Maybe Text)

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