Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- storageGateway :: Service
- _InvalidGatewayRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- data CachediSCSIVolume
- cachediSCSIVolume :: CachediSCSIVolume
- cscsivVolumeiSCSIAttributes :: Lens' CachediSCSIVolume (Maybe VolumeiSCSIAttributes)
- cscsivVolumeStatus :: Lens' CachediSCSIVolume (Maybe Text)
- cscsivSourceSnapshotId :: Lens' CachediSCSIVolume (Maybe Text)
- cscsivVolumeARN :: Lens' CachediSCSIVolume (Maybe Text)
- cscsivVolumeProgress :: Lens' CachediSCSIVolume (Maybe Double)
- cscsivVolumeSizeInBytes :: Lens' CachediSCSIVolume (Maybe Integer)
- cscsivCreatedDate :: Lens' CachediSCSIVolume (Maybe UTCTime)
- cscsivVolumeId :: Lens' CachediSCSIVolume (Maybe Text)
- cscsivVolumeType :: Lens' CachediSCSIVolume (Maybe Text)
- data ChapInfo
- chapInfo :: ChapInfo
- ciTargetARN :: Lens' ChapInfo (Maybe Text)
- ciSecretToAuthenticateInitiator :: Lens' ChapInfo (Maybe Text)
- ciInitiatorName :: Lens' ChapInfo (Maybe Text)
- ciSecretToAuthenticateTarget :: Lens' ChapInfo (Maybe Text)
- data DeviceiSCSIAttributes
- deviceiSCSIAttributes :: DeviceiSCSIAttributes
- dscsiaTargetARN :: Lens' DeviceiSCSIAttributes (Maybe Text)
- dscsiaChapEnabled :: Lens' DeviceiSCSIAttributes (Maybe Bool)
- dscsiaNetworkInterfaceId :: Lens' DeviceiSCSIAttributes (Maybe Text)
- dscsiaNetworkInterfacePort :: Lens' DeviceiSCSIAttributes (Maybe Int)
- data Disk
- disk :: Disk
- dDiskAllocationResource :: Lens' Disk (Maybe Text)
- dDiskAllocationType :: Lens' Disk (Maybe Text)
- dDiskNode :: Lens' Disk (Maybe Text)
- dDiskPath :: Lens' Disk (Maybe Text)
- dDiskSizeInBytes :: Lens' Disk (Maybe Integer)
- dDiskStatus :: Lens' Disk (Maybe Text)
- dDiskId :: Lens' Disk (Maybe Text)
- data FileShareInfo
- fileShareInfo :: FileShareInfo
- fsiFileShareStatus :: Lens' FileShareInfo (Maybe Text)
- fsiGatewayARN :: Lens' FileShareInfo (Maybe Text)
- fsiFileShareId :: Lens' FileShareInfo (Maybe Text)
- fsiFileShareARN :: Lens' FileShareInfo (Maybe Text)
- data GatewayInfo
- gatewayInfo :: GatewayInfo
- giGatewayARN :: Lens' GatewayInfo (Maybe Text)
- giGatewayOperationalState :: Lens' GatewayInfo (Maybe Text)
- giGatewayName :: Lens' GatewayInfo (Maybe Text)
- giGatewayId :: Lens' GatewayInfo (Maybe Text)
- giGatewayType :: Lens' GatewayInfo (Maybe Text)
- data NFSFileShareDefaults
- nFSFileShareDefaults :: NFSFileShareDefaults
- nfsfsdFileMode :: Lens' NFSFileShareDefaults (Maybe Text)
- nfsfsdOwnerId :: Lens' NFSFileShareDefaults (Maybe Natural)
- nfsfsdDirectoryMode :: Lens' NFSFileShareDefaults (Maybe Text)
- nfsfsdGroupId :: Lens' NFSFileShareDefaults (Maybe Natural)
- data NFSFileShareInfo
- nFSFileShareInfo :: NFSFileShareInfo
- nfsfsiFileShareStatus :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiKMSKey :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiGatewayARN :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiPath :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiKMSEncrypted :: Lens' NFSFileShareInfo (Maybe Bool)
- nfsfsiFileShareId :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiFileShareARN :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiDefaultStorageClass :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiRole :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiSquash :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiNFSFileShareDefaults :: Lens' NFSFileShareInfo (Maybe NFSFileShareDefaults)
- nfsfsiLocationARN :: Lens' NFSFileShareInfo (Maybe Text)
- nfsfsiClientList :: Lens' NFSFileShareInfo (Maybe (NonEmpty Text))
- nfsfsiReadOnly :: Lens' NFSFileShareInfo (Maybe Bool)
- data NetworkInterface
- networkInterface :: NetworkInterface
- niIPv6Address :: Lens' NetworkInterface (Maybe Text)
- niMACAddress :: Lens' NetworkInterface (Maybe Text)
- niIPv4Address :: Lens' NetworkInterface (Maybe Text)
- data StorediSCSIVolume
- storediSCSIVolume :: StorediSCSIVolume
- sscsivVolumeiSCSIAttributes :: Lens' StorediSCSIVolume (Maybe VolumeiSCSIAttributes)
- sscsivVolumeStatus :: Lens' StorediSCSIVolume (Maybe Text)
- sscsivSourceSnapshotId :: Lens' StorediSCSIVolume (Maybe Text)
- sscsivPreservedExistingData :: Lens' StorediSCSIVolume (Maybe Bool)
- sscsivVolumeARN :: Lens' StorediSCSIVolume (Maybe Text)
- sscsivVolumeProgress :: Lens' StorediSCSIVolume (Maybe Double)
- sscsivVolumeSizeInBytes :: Lens' StorediSCSIVolume (Maybe Integer)
- sscsivCreatedDate :: Lens' StorediSCSIVolume (Maybe UTCTime)
- sscsivVolumeId :: Lens' StorediSCSIVolume (Maybe Text)
- sscsivVolumeDiskId :: Lens' StorediSCSIVolume (Maybe Text)
- sscsivVolumeType :: Lens' StorediSCSIVolume (Maybe Text)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data Tape
- tape :: Tape
- tTapeBarcode :: Lens' Tape (Maybe Text)
- tTapeStatus :: Lens' Tape (Maybe Text)
- tTapeARN :: Lens' Tape (Maybe Text)
- tProgress :: Lens' Tape (Maybe Double)
- tTapeSizeInBytes :: Lens' Tape (Maybe Integer)
- tVTLDevice :: Lens' Tape (Maybe Text)
- tTapeUsedInBytes :: Lens' Tape (Maybe Integer)
- tTapeCreatedDate :: Lens' Tape (Maybe UTCTime)
- data TapeArchive
- tapeArchive :: TapeArchive
- taTapeBarcode :: Lens' TapeArchive (Maybe Text)
- taTapeStatus :: Lens' TapeArchive (Maybe Text)
- taTapeARN :: Lens' TapeArchive (Maybe Text)
- taTapeSizeInBytes :: Lens' TapeArchive (Maybe Integer)
- taCompletionTime :: Lens' TapeArchive (Maybe UTCTime)
- taTapeUsedInBytes :: Lens' TapeArchive (Maybe Integer)
- taTapeCreatedDate :: Lens' TapeArchive (Maybe UTCTime)
- taRetrievedTo :: Lens' TapeArchive (Maybe Text)
- data TapeInfo
- tapeInfo :: TapeInfo
- tiTapeBarcode :: Lens' TapeInfo (Maybe Text)
- tiTapeStatus :: Lens' TapeInfo (Maybe Text)
- tiTapeARN :: Lens' TapeInfo (Maybe Text)
- tiGatewayARN :: Lens' TapeInfo (Maybe Text)
- tiTapeSizeInBytes :: Lens' TapeInfo (Maybe Integer)
- data TapeRecoveryPointInfo
- tapeRecoveryPointInfo :: TapeRecoveryPointInfo
- trpiTapeStatus :: Lens' TapeRecoveryPointInfo (Maybe Text)
- trpiTapeRecoveryPointTime :: Lens' TapeRecoveryPointInfo (Maybe UTCTime)
- trpiTapeARN :: Lens' TapeRecoveryPointInfo (Maybe Text)
- trpiTapeSizeInBytes :: Lens' TapeRecoveryPointInfo (Maybe Integer)
- data VTLDevice
- vTLDevice :: VTLDevice
- vtldDeviceiSCSIAttributes :: Lens' VTLDevice (Maybe DeviceiSCSIAttributes)
- vtldVTLDeviceVendor :: Lens' VTLDevice (Maybe Text)
- vtldVTLDeviceARN :: Lens' VTLDevice (Maybe Text)
- vtldVTLDeviceType :: Lens' VTLDevice (Maybe Text)
- vtldVTLDeviceProductIdentifier :: Lens' VTLDevice (Maybe Text)
- data VolumeInfo
- volumeInfo :: VolumeInfo
- viGatewayARN :: Lens' VolumeInfo (Maybe Text)
- viVolumeARN :: Lens' VolumeInfo (Maybe Text)
- viVolumeSizeInBytes :: Lens' VolumeInfo (Maybe Integer)
- viVolumeId :: Lens' VolumeInfo (Maybe Text)
- viGatewayId :: Lens' VolumeInfo (Maybe Text)
- viVolumeType :: Lens' VolumeInfo (Maybe Text)
- data VolumeRecoveryPointInfo
- volumeRecoveryPointInfo :: VolumeRecoveryPointInfo
- vrpiVolumeRecoveryPointTime :: Lens' VolumeRecoveryPointInfo (Maybe Text)
- vrpiVolumeARN :: Lens' VolumeRecoveryPointInfo (Maybe Text)
- vrpiVolumeSizeInBytes :: Lens' VolumeRecoveryPointInfo (Maybe Integer)
- vrpiVolumeUsageInBytes :: Lens' VolumeRecoveryPointInfo (Maybe Integer)
- data VolumeiSCSIAttributes
- volumeiSCSIAttributes :: VolumeiSCSIAttributes
- vscsiaLunNumber :: Lens' VolumeiSCSIAttributes (Maybe Natural)
- vscsiaTargetARN :: Lens' VolumeiSCSIAttributes (Maybe Text)
- vscsiaChapEnabled :: Lens' VolumeiSCSIAttributes (Maybe Bool)
- vscsiaNetworkInterfaceId :: Lens' VolumeiSCSIAttributes (Maybe Text)
- vscsiaNetworkInterfacePort :: Lens' VolumeiSCSIAttributes (Maybe Int)
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. For more information, see the error and message fields.
_ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error has occurred during the request. For more information, see the error and message fields.
CachediSCSIVolume
data CachediSCSIVolume Source #
Describes an iSCSI cached volume.
See: cachediSCSIVolume
smart constructor.
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:
cscsivVolumeiSCSIAttributes
- AnVolumeiSCSIAttributes
object that represents a collection of iSCSI attributes for one stored volume.cscsivVolumeStatus
- One of the VolumeStatus values that indicates the state of the storage volume.cscsivSourceSnapshotId
- If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.cscsivVolumeARN
- The Amazon Resource Name (ARN) of the storage volume.cscsivVolumeProgress
- 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 cached volume is not restoring or bootstrapping.cscsivVolumeSizeInBytes
- The size, in bytes, of the volume capacity.cscsivCreatedDate
- The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.cscsivVolumeId
- The unique identifier of the volume, e.g. vol-AE4B946D.cscsivVolumeType
- One of the VolumeType enumeration values that describes the type of the volume.
cscsivVolumeiSCSIAttributes :: Lens' CachediSCSIVolume (Maybe VolumeiSCSIAttributes) Source #
An VolumeiSCSIAttributes
object that represents a collection of iSCSI attributes for one stored volume.
cscsivVolumeStatus :: Lens' CachediSCSIVolume (Maybe Text) Source #
One of the VolumeStatus values that indicates the state of the storage volume.
cscsivSourceSnapshotId :: Lens' CachediSCSIVolume (Maybe Text) Source #
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
cscsivVolumeARN :: Lens' CachediSCSIVolume (Maybe Text) Source #
The Amazon Resource Name (ARN) of the storage volume.
cscsivVolumeProgress :: Lens' CachediSCSIVolume (Maybe Double) Source #
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 cached volume is not restoring or bootstrapping.
cscsivVolumeSizeInBytes :: Lens' CachediSCSIVolume (Maybe Integer) Source #
The size, in bytes, of the volume capacity.
cscsivCreatedDate :: Lens' CachediSCSIVolume (Maybe UTCTime) Source #
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
cscsivVolumeId :: Lens' CachediSCSIVolume (Maybe Text) Source #
The unique identifier of the volume, e.g. vol-AE4B946D.
cscsivVolumeType :: Lens' CachediSCSIVolume (Maybe Text) Source #
One of the VolumeType enumeration values that describes the type of the volume.
ChapInfo
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
See: chapInfo
smart constructor.
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
- The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).ciSecretToAuthenticateInitiator
- The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.ciInitiatorName
- The iSCSI initiator that connects to the target.ciSecretToAuthenticateTarget
- The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
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.
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
- Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.dscsiaChapEnabled
- Indicates whether mutual CHAP is enabled for the iSCSI target.dscsiaNetworkInterfaceId
- The network interface identifier of the VTL device.dscsiaNetworkInterfacePort
- The port used to communicate with iSCSI VTL device targets.
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
See: disk
smart constructor.
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
- Undocumented member.dDiskAllocationType
- Undocumented member.dDiskNode
- Undocumented member.dDiskPath
- Undocumented member.dDiskSizeInBytes
- Undocumented member.dDiskStatus
- Undocumented member.dDiskId
- Undocumented member.
FileShareInfo
fileShareInfo :: FileShareInfo Source #
Creates a value of FileShareInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fsiFileShareStatus
- Undocumented member.fsiGatewayARN
- Undocumented member.fsiFileShareId
- Undocumented member.fsiFileShareARN
- Undocumented member.
fsiFileShareStatus :: Lens' FileShareInfo (Maybe Text) Source #
Undocumented member.
fsiGatewayARN :: Lens' FileShareInfo (Maybe Text) Source #
Undocumented member.
fsiFileShareId :: Lens' FileShareInfo (Maybe Text) Source #
Undocumented member.
fsiFileShareARN :: Lens' FileShareInfo (Maybe Text) Source #
Undocumented member.
GatewayInfo
data GatewayInfo Source #
Describes a gateway object.
See: gatewayInfo
smart constructor.
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
- The Amazon Resource Name (ARN) of the gateway. Use theListGateways
operation to return a list of gateways for your account and region.giGatewayOperationalState
- The state of the gateway. Valid Values: DISABLED or ACTIVEgiGatewayName
- The name of the gateway.giGatewayId
- 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.giGatewayType
- The type of the gateway.
giGatewayARN :: Lens' GatewayInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and region.
giGatewayOperationalState :: Lens' GatewayInfo (Maybe Text) Source #
The state of the gateway. Valid Values: DISABLED or ACTIVE
giGatewayName :: Lens' GatewayInfo (Maybe Text) Source #
The name of the gateway.
giGatewayId :: Lens' GatewayInfo (Maybe Text) Source #
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.
giGatewayType :: Lens' GatewayInfo (Maybe Text) Source #
The type of the gateway.
NFSFileShareDefaults
data NFSFileShareDefaults Source #
Describes file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway architecture.
See: nFSFileShareDefaults
smart constructor.
nFSFileShareDefaults :: NFSFileShareDefaults Source #
Creates a value of NFSFileShareDefaults
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nfsfsdFileMode
- The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.nfsfsdOwnerId
- The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.nfsfsdDirectoryMode
- The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.nfsfsdGroupId
- The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
nfsfsdFileMode :: Lens' NFSFileShareDefaults (Maybe Text) Source #
The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.
nfsfsdOwnerId :: Lens' NFSFileShareDefaults (Maybe Natural) Source #
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
nfsfsdDirectoryMode :: Lens' NFSFileShareDefaults (Maybe Text) Source #
The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.
nfsfsdGroupId :: Lens' NFSFileShareDefaults (Maybe Natural) Source #
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
NFSFileShareInfo
data NFSFileShareInfo Source #
The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.
See: nFSFileShareInfo
smart constructor.
nFSFileShareInfo :: NFSFileShareInfo Source #
Creates a value of NFSFileShareInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nfsfsiFileShareStatus
- Undocumented member.nfsfsiKMSKey
- Undocumented member.nfsfsiGatewayARN
- Undocumented member.nfsfsiPath
- Undocumented member.nfsfsiKMSEncrypted
- True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.nfsfsiFileShareId
- Undocumented member.nfsfsiFileShareARN
- Undocumented member.nfsfsiDefaultStorageClass
- The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.nfsfsiRole
- Undocumented member.nfsfsiSquash
- Undocumented member.nfsfsiNFSFileShareDefaults
- Undocumented member.nfsfsiLocationARN
- Undocumented member.nfsfsiClientList
- Undocumented member.nfsfsiReadOnly
- Undocumented member.
nfsfsiFileShareStatus :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiKMSKey :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiGatewayARN :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiPath :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiKMSEncrypted :: Lens' NFSFileShareInfo (Maybe Bool) Source #
True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
nfsfsiFileShareId :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiFileShareARN :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiDefaultStorageClass :: Lens' NFSFileShareInfo (Maybe Text) Source #
The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
nfsfsiRole :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiSquash :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiNFSFileShareDefaults :: Lens' NFSFileShareInfo (Maybe NFSFileShareDefaults) Source #
Undocumented member.
nfsfsiLocationARN :: Lens' NFSFileShareInfo (Maybe Text) Source #
Undocumented member.
nfsfsiClientList :: Lens' NFSFileShareInfo (Maybe (NonEmpty Text)) Source #
Undocumented member.
nfsfsiReadOnly :: Lens' NFSFileShareInfo (Maybe Bool) Source #
Undocumented member.
NetworkInterface
data NetworkInterface Source #
Describes a gateway's network interface.
See: networkInterface
smart constructor.
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
- The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported .niMACAddress
- The Media Access Control (MAC) address of the interface.niIPv4Address
- The Internet Protocol version 4 (IPv4) address of the interface.
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.
niIPv4Address :: Lens' NetworkInterface (Maybe Text) Source #
The Internet Protocol version 4 (IPv4) address of the interface.
StorediSCSIVolume
data StorediSCSIVolume Source #
Describes an iSCSI stored volume.
See: storediSCSIVolume
smart constructor.
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:
sscsivVolumeiSCSIAttributes
- AnVolumeiSCSIAttributes
object that represents a collection of iSCSI attributes for one stored volume.sscsivVolumeStatus
- One of the VolumeStatus values that indicates the state of the storage volume.sscsivSourceSnapshotId
- 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.sscsivPreservedExistingData
- Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true, falsesscsivVolumeARN
- The Amazon Resource Name (ARN) of the storage volume.sscsivVolumeProgress
- 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.sscsivVolumeSizeInBytes
- The size of the volume in bytes.sscsivCreatedDate
- The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.sscsivVolumeId
- The unique identifier of the volume, e.g. vol-AE4B946D.sscsivVolumeDiskId
- The ID of the local disk that was specified in theCreateStorediSCSIVolume
operation.sscsivVolumeType
- One of the VolumeType enumeration values describing the type of the volume.
sscsivVolumeiSCSIAttributes :: Lens' StorediSCSIVolume (Maybe VolumeiSCSIAttributes) Source #
An VolumeiSCSIAttributes
object that represents a collection of iSCSI attributes for one stored volume.
sscsivVolumeStatus :: Lens' StorediSCSIVolume (Maybe Text) Source #
One of the VolumeStatus values that indicates the state of the storage volume.
sscsivSourceSnapshotId :: Lens' StorediSCSIVolume (Maybe Text) Source #
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.
sscsivPreservedExistingData :: Lens' StorediSCSIVolume (Maybe Bool) Source #
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true, false
sscsivVolumeARN :: Lens' StorediSCSIVolume (Maybe Text) Source #
The Amazon Resource Name (ARN) of the storage volume.
sscsivVolumeProgress :: Lens' StorediSCSIVolume (Maybe Double) Source #
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.
sscsivVolumeSizeInBytes :: Lens' StorediSCSIVolume (Maybe Integer) Source #
The size of the volume in bytes.
sscsivCreatedDate :: Lens' StorediSCSIVolume (Maybe UTCTime) Source #
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
sscsivVolumeId :: Lens' StorediSCSIVolume (Maybe Text) Source #
The unique identifier of the volume, e.g. vol-AE4B946D.
sscsivVolumeDiskId :: Lens' StorediSCSIVolume (Maybe Text) Source #
The ID of the local disk that was specified in the CreateStorediSCSIVolume
operation.
sscsivVolumeType :: Lens' StorediSCSIVolume (Maybe Text) Source #
One of the VolumeType enumeration values describing the type of the volume.
Tag
See: tag
smart constructor.
Tape
Describes a virtual tape object.
See: tape
smart constructor.
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
- The barcode that identifies a specific virtual tape.tTapeStatus
- The current state of the virtual tape.tTapeARN
- The Amazon Resource Name (ARN) of the virtual tape.tProgress
- For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete).tTapeSizeInBytes
- The size, in bytes, of the virtual tape capacity.tVTLDevice
- The virtual tape library (VTL) device that the virtual tape is associated with.tTapeUsedInBytes
- The size, in bytes, of data written to the virtual tape.tTapeCreatedDate
- The date the virtual tape was created.
tTapeBarcode :: Lens' Tape (Maybe Text) Source #
The barcode that identifies a specific 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 capacity.
tVTLDevice :: Lens' Tape (Maybe Text) Source #
The virtual tape library (VTL) device that the virtual tape is associated with.
tTapeUsedInBytes :: Lens' Tape (Maybe Integer) Source #
The size, in bytes, of data written to the virtual tape.
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
- The barcode that identifies the archived virtual tape.taTapeStatus
- The current state of the archived virtual tape.taTapeARN
- The Amazon Resource Name (ARN) of an archived virtual tape.taTapeSizeInBytes
- The size, in bytes, of the archived virtual tape.taCompletionTime
- 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.taTapeUsedInBytes
- The size, in bytes, of data written to the virtual tape.taTapeCreatedDate
- Undocumented member.taRetrievedTo
- The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS).
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.
taTapeUsedInBytes :: Lens' TapeArchive (Maybe Integer) Source #
The size, in bytes, of data written to the virtual tape.
taTapeCreatedDate :: Lens' TapeArchive (Maybe UTCTime) Source #
Undocumented member.
taRetrievedTo :: Lens' TapeArchive (Maybe Text) Source #
The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeInfo
Describes a virtual tape.
See: tapeInfo
smart constructor.
Creates a value of TapeInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiTapeBarcode
- The barcode that identifies a specific virtual tape.tiTapeStatus
- The status of the tape.tiTapeARN
- The Amazon Resource Name (ARN) of a virtual tape.tiGatewayARN
- The Amazon Resource Name (ARN) of the gateway. Use theListGateways
operation to return a list of gateways for your account and region.tiTapeSizeInBytes
- The size, in bytes, of a virtual tape.
tiTapeBarcode :: Lens' TapeInfo (Maybe Text) Source #
The barcode that identifies a specific virtual tape.
tiGatewayARN :: Lens' TapeInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and region.
TapeRecoveryPointInfo
data TapeRecoveryPointInfo Source #
Describes a recovery point.
See: tapeRecoveryPointInfo
smart constructor.
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
- Undocumented member.trpiTapeRecoveryPointTime
- 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
- The Amazon Resource Name (ARN) of the virtual tape.trpiTapeSizeInBytes
- The size, in bytes, of the virtual tapes to recover.
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
Represents a device object associated with a tape gateway.
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
- A list of iSCSI information about a VTL device.vtldVTLDeviceVendor
- Undocumented member.vtldVTLDeviceARN
- Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).vtldVTLDeviceType
- Undocumented member.vtldVTLDeviceProductIdentifier
- Undocumented member.
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
data VolumeInfo Source #
Describes a storage volume object.
See: volumeInfo
smart constructor.
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:
viGatewayARN
- Undocumented member.viVolumeARN
- The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:arn:aws:storagegateway:us-east-2:111122223333:gatewaysgw-12A3456Bvolume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).viVolumeSizeInBytes
- The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).viVolumeId
- 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 (-).viGatewayId
- 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 (-).viVolumeType
- Undocumented member.
viGatewayARN :: Lens' VolumeInfo (Maybe Text) Source #
Undocumented member.
viVolumeARN :: Lens' VolumeInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN: arn:aws:storagegateway:us-east-2:111122223333:gatewaysgw-12A3456Bvolume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
viVolumeSizeInBytes :: Lens' VolumeInfo (Maybe Integer) Source #
The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
viVolumeId :: Lens' VolumeInfo (Maybe Text) Source #
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 (-).
viGatewayId :: Lens' VolumeInfo (Maybe Text) Source #
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 (-).
viVolumeType :: Lens' VolumeInfo (Maybe Text) Source #
Undocumented member.
VolumeRecoveryPointInfo
data VolumeRecoveryPointInfo Source #
See: volumeRecoveryPointInfo
smart constructor.
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
- Undocumented member.vrpiVolumeARN
- Undocumented member.vrpiVolumeSizeInBytes
- Undocumented member.vrpiVolumeUsageInBytes
- Undocumented member.
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.
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
- The logical disk number.vscsiaTargetARN
- The Amazon Resource Name (ARN) of the volume target.vscsiaChapEnabled
- Indicates whether mutual CHAP is enabled for the iSCSI target.vscsiaNetworkInterfaceId
- The network interface identifier.vscsiaNetworkInterfacePort
- The port used to communicate with iSCSI targets.
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.