amazonka-storagegateway-1.3.3.1: Amazon Storage Gateway SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway

Contents

Description

AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the /AWS Storage Gateway Service API Reference/:

See: AWS API Reference

Synopsis

Service Configuration

storageGateway :: Service Source

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

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by StorageGateway.

InvalidGatewayRequestException

_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

_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.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

CancelArchival

CreateStorediSCSIVolume

DescribeChapCredentials

CreateTapes

UpdateVTLDeviceType

CreateCachediSCSIVolume

ListVolumeInitiators

AddUploadBuffer

ListTagsForResource

UpdateGatewayInformation

DescribeMaintenanceStartTime

DescribeWorkingStorage

DescribeCachediSCSIVolumes

AddCache

StartGateway

ShutdownGateway

UpdateGatewaySoftwareNow

RemoveTagsFromResource

DeleteChapCredentials

UpdateChapCredentials

DescribeUploadBuffer

DescribeTapes (Paginated)

DescribeStorediSCSIVolumes

CreateSnapshotFromVolumeRecoveryPoint

RetrieveTapeRecoveryPoint

AddTagsToResource

DeleteGateway

UpdateMaintenanceStartTime

DescribeGatewayInformation

RetrieveTapeArchive

DescribeTapeArchives (Paginated)

DisableGateway

DescribeSnapshotSchedule

DescribeBandwidthRateLimit

DeleteSnapshotSchedule

UpdateSnapshotSchedule

CreateSnapshot

CancelRetrieval

DescribeVTLDevices (Paginated)

DeleteTapeArchive

ListVolumeRecoveryPoints

ResetCache

ListGateways (Paginated)

DeleteTape

ListLocalDisks

ListVolumes (Paginated)

UpdateBandwidthRateLimit

AddWorkingStorage

DescribeTapeRecoveryPoints (Paginated)

DeleteBandwidthRateLimit

ActivateGateway

DescribeCache

DeleteVolume

Types

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:

ChapInfo

data ChapInfo Source

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

See: chapInfo smart constructor.

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

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

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:

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

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.

giGatewayName :: Lens' GatewayInfo (Maybe Text) Source

Undocumented member.

giGatewayType :: Lens' GatewayInfo (Maybe Text) Source

Undocumented member.

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

Tag

tag Source

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag 

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

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

tagKey :: Lens' Tag Text Source

Undocumented member.

tagValue :: Lens' Tag Text Source

Undocumented member.

Tape

data Tape Source

Describes a virtual tape object.

See: tape smart constructor.

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.

tTapeARN :: Lens' Tape (Maybe Text) Source

The Amazon Resource Name (ARN) 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).

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.

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

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:

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.

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.

vtldVTLDeviceARN :: Lens' VTLDevice (Maybe Text) Source

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

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 :: Lens' VolumeInfo (Maybe Text) Source

Undocumented member.

viVolumeType :: Lens' VolumeInfo (Maybe Text) Source

Undocumented member.

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:

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:

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.

vscsiaNetworkInterfacePort :: Lens' VolumeiSCSIAttributes (Maybe Int) Source

The port used to communicate with iSCSI targets.