Copyright	(c) 2013-2015 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.StorageGateway.Types

Contents

Service Configuration
Errors
CachediSCSIVolume
ChapInfo
DeviceiSCSIAttributes
Disk
GatewayInfo
NetworkInterface
StorediSCSIVolume
Tape
TapeArchive
TapeRecoveryPointInfo
VTLDevice
VolumeInfo
VolumeRecoveryPointInfo
VolumeiSCSIAttributes

Description

Synopsis

Service Configuration

storageGateway :: Service Source

API version '2013-06-30' of the Amazon Storage Gateway SDK configuration.

Errors

_InvalidGatewayRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source

An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source

An internal server error has occurred during the request. See the error and message fields for more information.

CachediSCSIVolume

data CachediSCSIVolume Source

See: cachediSCSIVolume smart constructor.

Instances

Eq CachediSCSIVolume
Data CachediSCSIVolume
Read CachediSCSIVolume
Show CachediSCSIVolume
Generic CachediSCSIVolume
FromJSON CachediSCSIVolume
Typeable * CachediSCSIVolume
type Rep CachediSCSIVolume

cachediSCSIVolume :: CachediSCSIVolume Source

Creates a value of CachediSCSIVolume with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cscsivVolumeStatus :: Lens' CachediSCSIVolume (Maybe Text) Source

Undocumented member.

cscsivVolumeiSCSIAttributes :: Lens' CachediSCSIVolume (Maybe VolumeiSCSIAttributes) Source

Undocumented member.

cscsivSourceSnapshotId :: Lens' CachediSCSIVolume (Maybe Text) Source

Undocumented member.

cscsivVolumeARN :: Lens' CachediSCSIVolume (Maybe Text) Source

Undocumented member.

cscsivVolumeProgress :: Lens' CachediSCSIVolume (Maybe Double) Source

Undocumented member.

cscsivVolumeSizeInBytes :: Lens' CachediSCSIVolume (Maybe Integer) Source

Undocumented member.

cscsivVolumeId :: Lens' CachediSCSIVolume (Maybe Text) Source

Undocumented member.

cscsivVolumeType :: Lens' CachediSCSIVolume (Maybe Text) Source

Undocumented member.

ChapInfo

data ChapInfo Source

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

See: chapInfo smart constructor.

Instances

Eq ChapInfo
Data ChapInfo
Read ChapInfo
Show ChapInfo
Generic ChapInfo
FromJSON ChapInfo
Typeable * ChapInfo
type Rep ChapInfo

chapInfo :: ChapInfo Source

Creates a value of ChapInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ciTargetARN :: Lens' ChapInfo (Maybe Text) Source

The Amazon Resource Name (ARN) of the volume.

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

ciSecretToAuthenticateInitiator :: Lens' ChapInfo (Maybe Text) Source

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

ciInitiatorName :: Lens' ChapInfo (Maybe Text) Source

The iSCSI initiator that connects to the target.

ciSecretToAuthenticateTarget :: Lens' ChapInfo (Maybe Text) Source

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

DeviceiSCSIAttributes

data DeviceiSCSIAttributes Source

Lists iSCSI information about a VTL device.

See: deviceiSCSIAttributes smart constructor.

Instances

Eq DeviceiSCSIAttributes
Data DeviceiSCSIAttributes
Read DeviceiSCSIAttributes
Show DeviceiSCSIAttributes
Generic DeviceiSCSIAttributes
FromJSON DeviceiSCSIAttributes
Typeable * DeviceiSCSIAttributes
type Rep DeviceiSCSIAttributes

deviceiSCSIAttributes :: DeviceiSCSIAttributes Source

Creates a value of DeviceiSCSIAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dscsiaTargetARN :: Lens' DeviceiSCSIAttributes (Maybe Text) Source

Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

dscsiaChapEnabled :: Lens' DeviceiSCSIAttributes (Maybe Bool) Source

Indicates whether mutual CHAP is enabled for the iSCSI target.

dscsiaNetworkInterfaceId :: Lens' DeviceiSCSIAttributes (Maybe Text) Source

The network interface identifier of the VTL device.

dscsiaNetworkInterfacePort :: Lens' DeviceiSCSIAttributes (Maybe Int) Source

The port used to communicate with iSCSI VTL device targets.

Disk

data Disk Source

See: disk smart constructor.

Instances

Eq Disk
Data Disk
Read Disk
Show Disk
Generic Disk
FromJSON Disk
Typeable * Disk
type Rep Disk

disk :: Disk Source

Creates a value of Disk with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dDiskAllocationResource :: Lens' Disk (Maybe Text) Source

Undocumented member.

dDiskAllocationType :: Lens' Disk (Maybe Text) Source

Undocumented member.

dDiskNode :: Lens' Disk (Maybe Text) Source

Undocumented member.

dDiskPath :: Lens' Disk (Maybe Text) Source

Undocumented member.

dDiskSizeInBytes :: Lens' Disk (Maybe Integer) Source

Undocumented member.

dDiskStatus :: Lens' Disk (Maybe Text) Source

Undocumented member.

dDiskId :: Lens' Disk (Maybe Text) Source

Undocumented member.

GatewayInfo

data GatewayInfo Source

See: gatewayInfo smart constructor.

Instances

Eq GatewayInfo
Data GatewayInfo
Read GatewayInfo
Show GatewayInfo
Generic GatewayInfo
FromJSON GatewayInfo
Typeable * GatewayInfo
type Rep GatewayInfo

gatewayInfo :: GatewayInfo Source

Creates a value of GatewayInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

giGatewayARN :: Lens' GatewayInfo (Maybe Text) Source

Undocumented member.

giGatewayOperationalState :: Lens' GatewayInfo (Maybe Text) Source

Undocumented member.

giGatewayType :: Lens' GatewayInfo (Maybe Text) Source

Undocumented member.

NetworkInterface

data NetworkInterface Source

Describes a gateway's network interface.

See: networkInterface smart constructor.

Instances

Eq NetworkInterface
Data NetworkInterface
Read NetworkInterface
Show NetworkInterface
Generic NetworkInterface
FromJSON NetworkInterface
Typeable * NetworkInterface
type Rep NetworkInterface

networkInterface :: NetworkInterface Source

Creates a value of NetworkInterface with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

niIPv6Address :: Lens' NetworkInterface (Maybe Text) Source

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

niMACAddress :: Lens' NetworkInterface (Maybe Text) Source

The Media Access Control (MAC) address of the interface.

This is currently unsupported and will not be returned in output.

niIPv4Address :: Lens' NetworkInterface (Maybe Text) Source

The Internet Protocol version 4 (IPv4) address of the interface.

StorediSCSIVolume

data StorediSCSIVolume Source

See: storediSCSIVolume smart constructor.

Instances

Eq StorediSCSIVolume
Data StorediSCSIVolume
Read StorediSCSIVolume
Show StorediSCSIVolume
Generic StorediSCSIVolume
FromJSON StorediSCSIVolume
Typeable * StorediSCSIVolume
type Rep StorediSCSIVolume

storediSCSIVolume :: StorediSCSIVolume Source

Creates a value of StorediSCSIVolume with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sscsivVolumeStatus :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

sscsivVolumeiSCSIAttributes :: Lens' StorediSCSIVolume (Maybe VolumeiSCSIAttributes) Source

Undocumented member.

sscsivSourceSnapshotId :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

sscsivPreservedExistingData :: Lens' StorediSCSIVolume (Maybe Bool) Source

Undocumented member.

sscsivVolumeARN :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

sscsivVolumeProgress :: Lens' StorediSCSIVolume (Maybe Double) Source

Undocumented member.

sscsivVolumeSizeInBytes :: Lens' StorediSCSIVolume (Maybe Integer) Source

Undocumented member.

sscsivVolumeId :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

sscsivVolumeType :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

sscsivVolumeDiskId :: Lens' StorediSCSIVolume (Maybe Text) Source

Undocumented member.

Tape

data Tape Source

Describes a virtual tape object.

See: tape smart constructor.

Instances

Eq Tape
Data Tape
Read Tape
Show Tape
Generic Tape
FromJSON Tape
Typeable * Tape
type Rep Tape

tape :: Tape Source

Creates a value of Tape with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tTapeBarcode :: Lens' Tape (Maybe Text) Source

The barcode that identifies a specific virtual tape.

tTapeStatus :: Lens' Tape (Maybe Text) Source

The current state of the virtual tape.

tProgress :: Lens' Tape (Maybe Double) Source

For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

Range: 0 (not started) to 100 (complete).

tTapeARN :: Lens' Tape (Maybe Text) Source

The Amazon Resource Name (ARN) of the virtual tape.

tTapeSizeInBytes :: Lens' Tape (Maybe Integer) Source

The size, in bytes, of the virtual tape.

tVTLDevice :: Lens' Tape (Maybe Text) Source

The virtual tape library (VTL) device that the virtual tape is associated with.

TapeArchive

data TapeArchive Source

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

See: tapeArchive smart constructor.

Instances

Eq TapeArchive
Data TapeArchive
Read TapeArchive
Show TapeArchive
Generic TapeArchive
FromJSON TapeArchive
Typeable * TapeArchive
type Rep TapeArchive

tapeArchive :: TapeArchive Source

Creates a value of TapeArchive with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

taTapeBarcode :: Lens' TapeArchive (Maybe Text) Source

The barcode that identifies the archived virtual tape.

taTapeStatus :: Lens' TapeArchive (Maybe Text) Source

The current state of the archived virtual tape.

taTapeARN :: Lens' TapeArchive (Maybe Text) Source

The Amazon Resource Name (ARN) of an archived virtual tape.

taTapeSizeInBytes :: Lens' TapeArchive (Maybe Integer) Source

The size, in bytes, of the archived virtual tape.

taCompletionTime :: Lens' TapeArchive (Maybe UTCTime) Source

The time that the archiving of the virtual tape was completed.

The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

taRetrievedTo :: Lens' TapeArchive (Maybe Text) Source

The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.

The virtual tape is retrieved from the virtual tape shelf (VTS).

TapeRecoveryPointInfo

data TapeRecoveryPointInfo Source

Describes a recovery point.

See: tapeRecoveryPointInfo smart constructor.

Instances

Eq TapeRecoveryPointInfo
Data TapeRecoveryPointInfo
Read TapeRecoveryPointInfo
Show TapeRecoveryPointInfo
Generic TapeRecoveryPointInfo
FromJSON TapeRecoveryPointInfo
Typeable * TapeRecoveryPointInfo
type Rep TapeRecoveryPointInfo

tapeRecoveryPointInfo :: TapeRecoveryPointInfo Source

Creates a value of TapeRecoveryPointInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trpiTapeStatus :: Lens' TapeRecoveryPointInfo (Maybe Text) Source

Undocumented member.

trpiTapeRecoveryPointTime :: Lens' TapeRecoveryPointInfo (Maybe UTCTime) Source

The time when the point-in-time view of the virtual tape was replicated for later recovery.

The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

trpiTapeARN :: Lens' TapeRecoveryPointInfo (Maybe Text) Source

The Amazon Resource Name (ARN) of the virtual tape.

trpiTapeSizeInBytes :: Lens' TapeRecoveryPointInfo (Maybe Integer) Source

The size, in bytes, of the virtual tapes to recover.

VTLDevice

data VTLDevice Source

Represents a device object associated with a gateway-VTL.

See: vTLDevice smart constructor.

Instances

Eq VTLDevice
Data VTLDevice
Read VTLDevice
Show VTLDevice
Generic VTLDevice
FromJSON VTLDevice
Typeable * VTLDevice
type Rep VTLDevice

vTLDevice :: VTLDevice Source

Creates a value of VTLDevice with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vtldDeviceiSCSIAttributes :: Lens' VTLDevice (Maybe DeviceiSCSIAttributes) Source

A list of iSCSI information about a VTL device.

vtldVTLDeviceVendor :: Lens' VTLDevice (Maybe Text) Source

Undocumented member.

vtldVTLDeviceARN :: Lens' VTLDevice (Maybe Text) Source

Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

vtldVTLDeviceType :: Lens' VTLDevice (Maybe Text) Source

Undocumented member.

vtldVTLDeviceProductIdentifier :: Lens' VTLDevice (Maybe Text) Source

Undocumented member.

VolumeInfo

data VolumeInfo Source

See: volumeInfo smart constructor.

Instances

Eq VolumeInfo
Data VolumeInfo
Read VolumeInfo
Show VolumeInfo
Generic VolumeInfo
FromJSON VolumeInfo
Typeable * VolumeInfo
type Rep VolumeInfo

volumeInfo :: VolumeInfo Source

Creates a value of VolumeInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

viVolumeARN
viVolumeType

viVolumeARN :: Lens' VolumeInfo (Maybe Text) Source

Undocumented member.

viVolumeType :: Lens' VolumeInfo (Maybe Text) Source

Undocumented member.

VolumeRecoveryPointInfo

data VolumeRecoveryPointInfo Source

See: volumeRecoveryPointInfo smart constructor.

Instances

Eq VolumeRecoveryPointInfo
Data VolumeRecoveryPointInfo
Read VolumeRecoveryPointInfo
Show VolumeRecoveryPointInfo
Generic VolumeRecoveryPointInfo
FromJSON VolumeRecoveryPointInfo
Typeable * VolumeRecoveryPointInfo
type Rep VolumeRecoveryPointInfo

volumeRecoveryPointInfo :: VolumeRecoveryPointInfo Source

Creates a value of VolumeRecoveryPointInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vrpiVolumeRecoveryPointTime :: Lens' VolumeRecoveryPointInfo (Maybe Text) Source

Undocumented member.

vrpiVolumeARN :: Lens' VolumeRecoveryPointInfo (Maybe Text) Source

Undocumented member.

vrpiVolumeSizeInBytes :: Lens' VolumeRecoveryPointInfo (Maybe Integer) Source

Undocumented member.

vrpiVolumeUsageInBytes :: Lens' VolumeRecoveryPointInfo (Maybe Integer) Source

Undocumented member.

VolumeiSCSIAttributes

data VolumeiSCSIAttributes Source

Lists iSCSI information about a volume.

See: volumeiSCSIAttributes smart constructor.

Instances

Eq VolumeiSCSIAttributes
Data VolumeiSCSIAttributes
Read VolumeiSCSIAttributes
Show VolumeiSCSIAttributes
Generic VolumeiSCSIAttributes
FromJSON VolumeiSCSIAttributes
Typeable * VolumeiSCSIAttributes
type Rep VolumeiSCSIAttributes

volumeiSCSIAttributes :: VolumeiSCSIAttributes Source

Creates a value of VolumeiSCSIAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vscsiaLunNumber :: Lens' VolumeiSCSIAttributes (Maybe Natural) Source

The logical disk number.

vscsiaTargetARN :: Lens' VolumeiSCSIAttributes (Maybe Text) Source

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

vscsiaChapEnabled :: Lens' VolumeiSCSIAttributes (Maybe Bool) Source

Indicates whether mutual CHAP is enabled for the iSCSI target.

vscsiaNetworkInterfaceId :: Lens' VolumeiSCSIAttributes (Maybe Text) Source

The network interface identifier.

vscsiaNetworkInterfacePort :: Lens' VolumeiSCSIAttributes (Maybe Int) Source

The port used to communicate with iSCSI targets.