@datafire/amazonaws_storagegateway
v5.0.0
Published
DataFire integration for AWS Storage Gateway
Downloads
4
Readme
@datafire/amazonaws_storagegateway
Client library for AWS Storage Gateway
Installation and Usage
npm install --save @datafire/amazonaws_storagegateway
let amazonaws_storagegateway = require('@datafire/amazonaws_storagegateway').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_storagegateway.ActivateGateway({
"ActivationKey": "",
"GatewayName": "",
"GatewayTimezone": "",
"GatewayRegion": ""
}).then(data => {
console.log(data);
});
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: AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway. Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request. Error Responses: Provides reference information about AWS Storage Gateway errors. Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses. AWS Storage Gateway Regions and Endpoints: Provides a list of each region and endpoints available for use with AWS Storage Gateway. AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected. IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs. For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
Actions
ActivateGateway
amazonaws_storagegateway.ActivateGateway({
"ActivationKey": "",
"GatewayName": "",
"GatewayTimezone": "",
"GatewayRegion": ""
}, context)
Input
- input
object
- ActivationKey required ActivationKey
- GatewayName required GatewayName
- GatewayRegion required RegionId
- GatewayTimezone required GatewayTimezone
- GatewayType GatewayType
- MediumChangerType MediumChangerType
- TapeDriveType TapeDriveType
Output
- output ActivateGatewayOutput
AddCache
amazonaws_storagegateway.AddCache({
"GatewayARN": "",
"DiskIds": []
}, context)
Input
- input
object
- DiskIds required DiskIds
- GatewayARN required GatewayARN
Output
- output AddCacheOutput
AddTagsToResource
amazonaws_storagegateway.AddTagsToResource({
"ResourceARN": "",
"Tags": []
}, context)
Input
- input
object
- ResourceARN required ResourceARN
- Tags required Tags
Output
- output AddTagsToResourceOutput
AddUploadBuffer
amazonaws_storagegateway.AddUploadBuffer({
"GatewayARN": "",
"DiskIds": []
}, context)
Input
- input
object
- DiskIds required DiskIds
- GatewayARN required GatewayARN
Output
- output AddUploadBufferOutput
AddWorkingStorage
amazonaws_storagegateway.AddWorkingStorage({
"GatewayARN": "",
"DiskIds": []
}, context)
Input
- input
object
- DiskIds required DiskIds
- GatewayARN required GatewayARN
Output
- output AddWorkingStorageOutput
CancelArchival
amazonaws_storagegateway.CancelArchival({
"GatewayARN": "",
"TapeARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeARN required TapeARN
Output
- output CancelArchivalOutput
CancelRetrieval
amazonaws_storagegateway.CancelRetrieval({
"GatewayARN": "",
"TapeARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeARN required TapeARN
Output
- output CancelRetrievalOutput
CreateCachediSCSIVolume
amazonaws_storagegateway.CreateCachediSCSIVolume({
"GatewayARN": "",
"VolumeSizeInBytes": 0,
"TargetName": "",
"NetworkInterfaceId": "",
"ClientToken": ""
}, context)
Input
- input
object
- ClientToken required ClientToken
- GatewayARN required GatewayARN
- NetworkInterfaceId required NetworkInterfaceId
- SnapshotId SnapshotId
- SourceVolumeARN VolumeARN
- TargetName required TargetName
- VolumeSizeInBytes required long
Output
CreateNFSFileShare
amazonaws_storagegateway.CreateNFSFileShare({
"ClientToken": "",
"GatewayARN": "",
"Role": "",
"LocationARN": ""
}, context)
Input
- input
object
- ClientList FileShareClientList
- ClientToken required ClientToken
- DefaultStorageClass StorageClass
- GatewayARN required GatewayARN
- GuessMIMETypeEnabled Boolean
- KMSEncrypted Boolean
- KMSKey KMSKey
- LocationARN required LocationARN
- NFSFileShareDefaults NFSFileShareDefaults
- ReadOnly Boolean
- Role required Role
- Squash Squash
Output
- output CreateNFSFileShareOutput
CreateSnapshot
amazonaws_storagegateway.CreateSnapshot({
"VolumeARN": "",
"SnapshotDescription": ""
}, context)
Input
- input
object
- SnapshotDescription required SnapshotDescription
- VolumeARN required VolumeARN
Output
- output CreateSnapshotOutput
CreateSnapshotFromVolumeRecoveryPoint
amazonaws_storagegateway.CreateSnapshotFromVolumeRecoveryPoint({
"VolumeARN": "",
"SnapshotDescription": ""
}, context)
Input
- input
object
- SnapshotDescription required SnapshotDescription
- VolumeARN required VolumeARN
Output
CreateStorediSCSIVolume
amazonaws_storagegateway.CreateStorediSCSIVolume({
"GatewayARN": "",
"DiskId": "",
"PreserveExistingData": true,
"TargetName": "",
"NetworkInterfaceId": ""
}, context)
Input
- input
object
- DiskId required DiskId
- GatewayARN required GatewayARN
- NetworkInterfaceId required NetworkInterfaceId
- PreserveExistingData required boolean
- SnapshotId SnapshotId
- TargetName required TargetName
Output
CreateTapeWithBarcode
amazonaws_storagegateway.CreateTapeWithBarcode({
"GatewayARN": "",
"TapeSizeInBytes": 0,
"TapeBarcode": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeBarcode required TapeBarcode
- TapeSizeInBytes required TapeSize
Output
- output CreateTapeWithBarcodeOutput
CreateTapes
amazonaws_storagegateway.CreateTapes({
"GatewayARN": "",
"TapeSizeInBytes": 0,
"ClientToken": "",
"NumTapesToCreate": 0,
"TapeBarcodePrefix": ""
}, context)
Input
- input
object
- ClientToken required ClientToken
- GatewayARN required GatewayARN
- NumTapesToCreate required NumTapesToCreate
- TapeBarcodePrefix required TapeBarcodePrefix
- TapeSizeInBytes required TapeSize
Output
- output CreateTapesOutput
DeleteBandwidthRateLimit
amazonaws_storagegateway.DeleteBandwidthRateLimit({
"GatewayARN": "",
"BandwidthType": ""
}, context)
Input
- input
object
- BandwidthType required BandwidthType
- GatewayARN required GatewayARN
Output
DeleteChapCredentials
amazonaws_storagegateway.DeleteChapCredentials({
"TargetARN": "",
"InitiatorName": ""
}, context)
Input
Output
- output DeleteChapCredentialsOutput
DeleteFileShare
amazonaws_storagegateway.DeleteFileShare({
"FileShareARN": ""
}, context)
Input
- input
object
- FileShareARN required FileShareARN
- ForceDelete boolean
Output
- output DeleteFileShareOutput
DeleteGateway
amazonaws_storagegateway.DeleteGateway({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output DeleteGatewayOutput
DeleteSnapshotSchedule
amazonaws_storagegateway.DeleteSnapshotSchedule({
"VolumeARN": ""
}, context)
Input
- input
object
- VolumeARN required VolumeARN
Output
- output DeleteSnapshotScheduleOutput
DeleteTape
amazonaws_storagegateway.DeleteTape({
"GatewayARN": "",
"TapeARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeARN required TapeARN
Output
- output DeleteTapeOutput
DeleteTapeArchive
amazonaws_storagegateway.DeleteTapeArchive({
"TapeARN": ""
}, context)
Input
- input
object
- TapeARN required TapeARN
Output
- output DeleteTapeArchiveOutput
DeleteVolume
amazonaws_storagegateway.DeleteVolume({
"VolumeARN": ""
}, context)
Input
- input
object
- VolumeARN required VolumeARN
Output
- output DeleteVolumeOutput
DescribeBandwidthRateLimit
amazonaws_storagegateway.DescribeBandwidthRateLimit({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
DescribeCache
amazonaws_storagegateway.DescribeCache({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output DescribeCacheOutput
DescribeCachediSCSIVolumes
amazonaws_storagegateway.DescribeCachediSCSIVolumes({
"VolumeARNs": []
}, context)
Input
- input
object
- VolumeARNs required VolumeARNs
Output
DescribeChapCredentials
amazonaws_storagegateway.DescribeChapCredentials({
"TargetARN": ""
}, context)
Input
- input
object
- TargetARN required TargetARN
Output
DescribeGatewayInformation
amazonaws_storagegateway.DescribeGatewayInformation({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
DescribeMaintenanceStartTime
amazonaws_storagegateway.DescribeMaintenanceStartTime({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
DescribeNFSFileShares
amazonaws_storagegateway.DescribeNFSFileShares({
"FileShareARNList": []
}, context)
Input
- input
object
- FileShareARNList required FileShareARNList
Output
- output DescribeNFSFileSharesOutput
DescribeSnapshotSchedule
amazonaws_storagegateway.DescribeSnapshotSchedule({
"VolumeARN": ""
}, context)
Input
- input
object
- VolumeARN required VolumeARN
Output
DescribeStorediSCSIVolumes
amazonaws_storagegateway.DescribeStorediSCSIVolumes({
"VolumeARNs": []
}, context)
Input
- input
object
- VolumeARNs required VolumeARNs
Output
DescribeTapeArchives
amazonaws_storagegateway.DescribeTapeArchives({}, context)
Input
- input
object
- Limit
string
- Marker
string
- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
- Limit
Output
- output DescribeTapeArchivesOutput
DescribeTapeRecoveryPoints
amazonaws_storagegateway.DescribeTapeRecoveryPoints({
"GatewayARN": ""
}, context)
Input
- input
object
- Limit
string
- Marker
string
- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
- Limit
Output
DescribeTapes
amazonaws_storagegateway.DescribeTapes({
"GatewayARN": ""
}, context)
Input
- input
object
- Limit
string
- Marker
string
- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
- Limit
Output
- output DescribeTapesOutput
DescribeUploadBuffer
amazonaws_storagegateway.DescribeUploadBuffer({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output DescribeUploadBufferOutput
DescribeVTLDevices
amazonaws_storagegateway.DescribeVTLDevices({
"GatewayARN": ""
}, context)
Input
- input
object
- Limit
string
- Marker
string
- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
- VTLDeviceARNs VTLDeviceARNs
- Limit
Output
- output DescribeVTLDevicesOutput
DescribeWorkingStorage
amazonaws_storagegateway.DescribeWorkingStorage({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output DescribeWorkingStorageOutput
DisableGateway
amazonaws_storagegateway.DisableGateway({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output DisableGatewayOutput
ListFileShares
amazonaws_storagegateway.ListFileShares({}, context)
Input
- input
object
- GatewayARN GatewayARN
- Limit PositiveIntObject
- Marker Marker
Output
- output ListFileSharesOutput
ListGateways
amazonaws_storagegateway.ListGateways({}, context)
Input
- input
object
- Limit
string
- Marker
string
- Limit PositiveIntObject
- Marker Marker
- Limit
Output
- output ListGatewaysOutput
ListLocalDisks
amazonaws_storagegateway.ListLocalDisks({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output ListLocalDisksOutput
ListTagsForResource
amazonaws_storagegateway.ListTagsForResource({
"ResourceARN": ""
}, context)
Input
- input
object
- Limit PositiveIntObject
- Marker Marker
- ResourceARN required ResourceARN
Output
- output ListTagsForResourceOutput
ListTapes
amazonaws_storagegateway.ListTapes({}, context)
Input
- input
object
- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
Output
- output ListTapesOutput
ListVolumeInitiators
amazonaws_storagegateway.ListVolumeInitiators({
"VolumeARN": ""
}, context)
Input
- input
object
- VolumeARN required VolumeARN
Output
- output ListVolumeInitiatorsOutput
ListVolumeRecoveryPoints
amazonaws_storagegateway.ListVolumeRecoveryPoints({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
ListVolumes
amazonaws_storagegateway.ListVolumes({}, context)
Input
- input
object
- Limit
string
- Marker
string
- GatewayARN GatewayARN
- Limit PositiveIntObject
- Marker Marker
- Limit
Output
- output ListVolumesOutput
NotifyWhenUploaded
amazonaws_storagegateway.NotifyWhenUploaded({
"FileShareARN": ""
}, context)
Input
- input
object
- FileShareARN required FileShareARN
Output
- output NotifyWhenUploadedOutput
RefreshCache
amazonaws_storagegateway.RefreshCache({
"FileShareARN": ""
}, context)
Input
- input
object
- FileShareARN required FileShareARN
Output
- output RefreshCacheOutput
RemoveTagsFromResource
amazonaws_storagegateway.RemoveTagsFromResource({
"ResourceARN": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceARN required ResourceARN
- TagKeys required TagKeys
Output
- output RemoveTagsFromResourceOutput
ResetCache
amazonaws_storagegateway.ResetCache({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output ResetCacheOutput
RetrieveTapeArchive
amazonaws_storagegateway.RetrieveTapeArchive({
"TapeARN": "",
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeARN required TapeARN
Output
- output RetrieveTapeArchiveOutput
RetrieveTapeRecoveryPoint
amazonaws_storagegateway.RetrieveTapeRecoveryPoint({
"TapeARN": "",
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- TapeARN required TapeARN
Output
SetLocalConsolePassword
amazonaws_storagegateway.SetLocalConsolePassword({
"GatewayARN": "",
"LocalConsolePassword": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- LocalConsolePassword required LocalConsolePassword
Output
ShutdownGateway
amazonaws_storagegateway.ShutdownGateway({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output ShutdownGatewayOutput
StartGateway
amazonaws_storagegateway.StartGateway({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
- output StartGatewayOutput
UpdateBandwidthRateLimit
amazonaws_storagegateway.UpdateBandwidthRateLimit({
"GatewayARN": ""
}, context)
Input
- input
object
- AverageDownloadRateLimitInBitsPerSec BandwidthDownloadRateLimit
- AverageUploadRateLimitInBitsPerSec BandwidthUploadRateLimit
- GatewayARN required GatewayARN
Output
UpdateChapCredentials
amazonaws_storagegateway.UpdateChapCredentials({
"TargetARN": "",
"SecretToAuthenticateInitiator": "",
"InitiatorName": ""
}, context)
Input
- input
object
- InitiatorName required IqnName
- SecretToAuthenticateInitiator required ChapSecret
- SecretToAuthenticateTarget ChapSecret
- TargetARN required TargetARN
Output
- output UpdateChapCredentialsOutput
UpdateGatewayInformation
amazonaws_storagegateway.UpdateGatewayInformation({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
- GatewayName GatewayName
- GatewayTimezone GatewayTimezone
Output
UpdateGatewaySoftwareNow
amazonaws_storagegateway.UpdateGatewaySoftwareNow({
"GatewayARN": ""
}, context)
Input
- input
object
- GatewayARN required GatewayARN
Output
UpdateMaintenanceStartTime
amazonaws_storagegateway.UpdateMaintenanceStartTime({
"GatewayARN": "",
"HourOfDay": 0,
"MinuteOfHour": 0,
"DayOfWeek": 0
}, context)
Input
- input
object
- DayOfWeek required DayOfWeek
- GatewayARN required GatewayARN
- HourOfDay required HourOfDay
- MinuteOfHour required MinuteOfHour
Output
UpdateNFSFileShare
amazonaws_storagegateway.UpdateNFSFileShare({
"FileShareARN": ""
}, context)
Input
- input
object
- ClientList FileShareClientList
- DefaultStorageClass StorageClass
- FileShareARN required FileShareARN
- GuessMIMETypeEnabled Boolean
- KMSEncrypted Boolean
- KMSKey KMSKey
- NFSFileShareDefaults NFSFileShareDefaults
- ReadOnly Boolean
- Squash Squash
Output
- output UpdateNFSFileShareOutput
UpdateSnapshotSchedule
amazonaws_storagegateway.UpdateSnapshotSchedule({
"VolumeARN": "",
"StartAt": 0,
"RecurrenceInHours": 0
}, context)
Input
- input
object
- Description Description
- RecurrenceInHours required RecurrenceInHours
- StartAt required HourOfDay
- VolumeARN required VolumeARN
Output
- output UpdateSnapshotScheduleOutput
UpdateVTLDeviceType
amazonaws_storagegateway.UpdateVTLDeviceType({
"VTLDeviceARN": "",
"DeviceType": ""
}, context)
Input
- input
object
- DeviceType required DeviceType
- VTLDeviceARN required VTLDeviceARN
Output
- output UpdateVTLDeviceTypeOutput
Definitions
ActivateGatewayInput
- ActivateGatewayInput
object
: A JSON object containing one or more of the following fields: ActivateGatewayInput$ActivationKey ActivateGatewayInput$GatewayName ActivateGatewayInput$GatewayRegion ActivateGatewayInput$GatewayTimezone ActivateGatewayInput$GatewayType ActivateGatewayInput$TapeDriveType ActivateGatewayInput$MediumChangerType- ActivationKey required ActivationKey
- GatewayName required GatewayName
- GatewayRegion required RegionId
- GatewayTimezone required GatewayTimezone
- GatewayType GatewayType
- MediumChangerType MediumChangerType
- TapeDriveType TapeDriveType
ActivateGatewayOutput
- ActivateGatewayOutput
object
: AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization. For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.- GatewayARN GatewayARN
ActivationKey
- ActivationKey
string
AddCacheInput
- AddCacheInput
object
- DiskIds required DiskIds
- GatewayARN required GatewayARN
AddCacheOutput
- AddCacheOutput
object
- GatewayARN GatewayARN
AddTagsToResourceInput
- AddTagsToResourceInput
object
: AddTagsToResourceInput- ResourceARN required ResourceARN
- Tags required Tags
AddTagsToResourceOutput
- AddTagsToResourceOutput
object
: AddTagsToResourceOutput- ResourceARN ResourceARN
AddUploadBufferInput
- AddUploadBufferInput
object
- DiskIds required DiskIds
- GatewayARN required GatewayARN
AddUploadBufferOutput
- AddUploadBufferOutput
object
- GatewayARN GatewayARN
AddWorkingStorageInput
- AddWorkingStorageInput
object
: A JSON object containing one or more of the following fields: AddWorkingStorageInput$DiskIds- DiskIds required DiskIds
- GatewayARN required GatewayARN
AddWorkingStorageOutput
- AddWorkingStorageOutput
object
: A JSON object containing the of the gateway for which working storage was configured.- GatewayARN GatewayARN
BandwidthDownloadRateLimit
- BandwidthDownloadRateLimit
integer
BandwidthType
- BandwidthType
string
BandwidthUploadRateLimit
- BandwidthUploadRateLimit
integer
Boolean
- Boolean
boolean
: A value that indicates whether the write status of a file share is read-only: "true" if write status is read-only, and otherwise "false".
CachediSCSIVolume
- CachediSCSIVolume
object
: Describes an iSCSI cached volume.- CreatedDate CreatedDate
- SourceSnapshotId SnapshotId
- VolumeARN VolumeARN
- VolumeId VolumeId
- VolumeProgress DoubleObject
- VolumeSizeInBytes long
- VolumeStatus VolumeStatus
- VolumeType VolumeType
- VolumeUsedInBytes VolumeUsedInBytes
- VolumeiSCSIAttributes VolumeiSCSIAttributes
CachediSCSIVolumes
- CachediSCSIVolumes
array
- items CachediSCSIVolume
CancelArchivalInput
- CancelArchivalInput
object
: CancelArchivalInput- GatewayARN required GatewayARN
- TapeARN required TapeARN
CancelArchivalOutput
- CancelArchivalOutput
object
: CancelArchivalOutput- TapeARN TapeARN
CancelRetrievalInput
- CancelRetrievalInput
object
: CancelRetrievalInput- GatewayARN required GatewayARN
- TapeARN required TapeARN
CancelRetrievalOutput
- CancelRetrievalOutput
object
: CancelRetrievalOutput- TapeARN TapeARN
ChapCredentials
- ChapCredentials
array
- items ChapInfo
ChapInfo
- ChapInfo
object
: Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.- InitiatorName IqnName
- SecretToAuthenticateInitiator ChapSecret
- SecretToAuthenticateTarget ChapSecret
- TargetARN TargetARN
ChapSecret
- ChapSecret
string
ClientToken
- ClientToken
string
CreateCachediSCSIVolumeInput
- CreateCachediSCSIVolumeInput
object
- ClientToken required ClientToken
- GatewayARN required GatewayARN
- NetworkInterfaceId required NetworkInterfaceId
- SnapshotId SnapshotId
- SourceVolumeARN VolumeARN
- TargetName required TargetName
- VolumeSizeInBytes required long
CreateCachediSCSIVolumeOutput
CreateNFSFileShareInput
- CreateNFSFileShareInput
object
: CreateNFSFileShareInput- ClientList FileShareClientList
- ClientToken required ClientToken
- DefaultStorageClass StorageClass
- GatewayARN required GatewayARN
- GuessMIMETypeEnabled Boolean
- KMSEncrypted Boolean
- KMSKey KMSKey
- LocationARN required LocationARN
- NFSFileShareDefaults NFSFileShareDefaults
- ReadOnly Boolean
- Role required Role
- Squash Squash
CreateNFSFileShareOutput
- CreateNFSFileShareOutput
object
: CreateNFSFileShareOutput- FileShareARN FileShareARN
CreateSnapshotFromVolumeRecoveryPointInput
- CreateSnapshotFromVolumeRecoveryPointInput
object
- SnapshotDescription required SnapshotDescription
- VolumeARN required VolumeARN
CreateSnapshotFromVolumeRecoveryPointOutput
- CreateSnapshotFromVolumeRecoveryPointOutput
object
- SnapshotId SnapshotId
- VolumeARN VolumeARN
- VolumeRecoveryPointTime string
CreateSnapshotInput
- CreateSnapshotInput
object
: A JSON object containing one or more of the following fields: CreateSnapshotInput$SnapshotDescription CreateSnapshotInput$VolumeARN- SnapshotDescription required SnapshotDescription
- VolumeARN required VolumeARN
CreateSnapshotOutput
- CreateSnapshotOutput
object
: A JSON object containing the following fields:- SnapshotId SnapshotId
- VolumeARN VolumeARN
CreateStorediSCSIVolumeInput
- CreateStorediSCSIVolumeInput
object
: A JSON object containing one or more of the following fields: CreateStorediSCSIVolumeInput$DiskId CreateStorediSCSIVolumeInput$NetworkInterfaceId CreateStorediSCSIVolumeInput$PreserveExistingData CreateStorediSCSIVolumeInput$SnapshotId CreateStorediSCSIVolumeInput$TargetName- DiskId required DiskId
- GatewayARN required GatewayARN
- NetworkInterfaceId required NetworkInterfaceId
- PreserveExistingData required boolean
- SnapshotId SnapshotId
- TargetName required TargetName
CreateStorediSCSIVolumeOutput
- CreateStorediSCSIVolumeOutput
object
: A JSON object containing the following fields:
CreateTapeWithBarcodeInput
- CreateTapeWithBarcodeInput
object
: CreateTapeWithBarcodeInput- GatewayARN required GatewayARN
- TapeBarcode required TapeBarcode
- TapeSizeInBytes required TapeSize
CreateTapeWithBarcodeOutput
- CreateTapeWithBarcodeOutput
object
: CreateTapeOutput- TapeARN TapeARN
CreateTapesInput
- CreateTapesInput
object
: CreateTapesInput- ClientToken required ClientToken
- GatewayARN required GatewayARN
- NumTapesToCreate required NumTapesToCreate
- TapeBarcodePrefix required TapeBarcodePrefix
- TapeSizeInBytes required TapeSize
CreateTapesOutput
- CreateTapesOutput
object
: CreateTapeOutput- TapeARNs TapeARNs
CreatedDate
- CreatedDate
string
DayOfWeek
- DayOfWeek
integer
DeleteBandwidthRateLimitInput
- DeleteBandwidthRateLimitInput
object
: A JSON object containing the following fields: DeleteBandwidthRateLimitInput$BandwidthType- BandwidthType required BandwidthType
- GatewayARN required GatewayARN
DeleteBandwidthRateLimitOutput
- DeleteBandwidthRateLimitOutput
object
: A JSON object containing the of the gateway whose bandwidth rate information was deleted.- GatewayARN GatewayARN
DeleteChapCredentialsInput
- DeleteChapCredentialsInput
object
: A JSON object containing one or more of the following fields: DeleteChapCredentialsInput$InitiatorName DeleteChapCredentialsInput$TargetARN
DeleteChapCredentialsOutput
- DeleteChapCredentialsOutput
object
: A JSON object containing the following fields:
DeleteFileShareInput
- DeleteFileShareInput
object
: DeleteFileShareInput- FileShareARN required FileShareARN
- ForceDelete boolean
DeleteFileShareOutput
- DeleteFileShareOutput
object
: DeleteFileShareOutput- FileShareARN FileShareARN
DeleteGatewayInput
- DeleteGatewayInput
object
: A JSON object containing the ID of the gateway to delete.- GatewayARN required GatewayARN
DeleteGatewayOutput
- DeleteGatewayOutput
object
: A JSON object containing the ID of the deleted gateway.- GatewayARN GatewayARN
DeleteSnapshotScheduleInput
- DeleteSnapshotScheduleInput
object
- VolumeARN required VolumeARN
DeleteSnapshotScheduleOutput
- DeleteSnapshotScheduleOutput
object
- VolumeARN VolumeARN
DeleteTapeArchiveInput
- DeleteTapeArchiveInput
object
: DeleteTapeArchiveInput- TapeARN required TapeARN
DeleteTapeArchiveOutput
- DeleteTapeArchiveOutput
object
: DeleteTapeArchiveOutput- TapeARN TapeARN
DeleteTapeInput
- DeleteTapeInput
object
: DeleteTapeInput- GatewayARN required GatewayARN
- TapeARN required TapeARN
DeleteTapeOutput
- DeleteTapeOutput
object
: DeleteTapeOutput- TapeARN TapeARN
DeleteVolumeInput
- DeleteVolumeInput
object
: A JSON object containing the DeleteVolumeInput$VolumeARN to delete.- VolumeARN required VolumeARN
DeleteVolumeOutput
- DeleteVolumeOutput
object
: A JSON object containing the of the storage volume that was deleted- VolumeARN VolumeARN
DescribeBandwidthRateLimitInput
- DescribeBandwidthRateLimitInput
object
: A JSON object containing the of the gateway.- GatewayARN required GatewayARN
DescribeBandwidthRateLimitOutput
- DescribeBandwidthRateLimitOutput
object
: A JSON object containing the following fields:- AverageDownloadRateLimitInBitsPerSec BandwidthDownloadRateLimit
- AverageUploadRateLimitInBitsPerSec BandwidthUploadRateLimit
- GatewayARN GatewayARN
DescribeCacheInput
- DescribeCacheInput
object
- GatewayARN required GatewayARN
DescribeCacheOutput
- DescribeCacheOutput
object
DescribeCachediSCSIVolumesInput
- DescribeCachediSCSIVolumesInput
object
- VolumeARNs required VolumeARNs
DescribeCachediSCSIVolumesOutput
- DescribeCachediSCSIVolumesOutput
object
: A JSON object containing the following fields:- CachediSCSIVolumes CachediSCSIVolumes
DescribeChapCredentialsInput
- DescribeChapCredentialsInput
object
: A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.- TargetARN required TargetARN
DescribeChapCredentialsOutput
- DescribeChapCredentialsOutput
object
: A JSON object containing a .- ChapCredentials ChapCredentials
DescribeGatewayInformationInput
- DescribeGatewayInformationInput
object
: A JSON object containing the ID of the gateway.- GatewayARN required GatewayARN
DescribeGatewayInformationOutput
- DescribeGatewayInformationOutput
object
: A JSON object containing the following fields:- GatewayARN GatewayARN
- GatewayId GatewayId
- GatewayName string
- GatewayNetworkInterfaces GatewayNetworkInterfaces
- GatewayState GatewayState
- GatewayTimezone GatewayTimezone
- GatewayType GatewayType
- LastSoftwareUpdate LastSoftwareUpdate
- NextUpdateAvailabilityDate NextUpdateAvailabilityDate
DescribeMaintenanceStartTimeInput
- DescribeMaintenanceStartTimeInput
object
: A JSON object containing the of the gateway.- GatewayARN required GatewayARN
DescribeMaintenanceStartTimeOutput
- DescribeMaintenanceStartTimeOutput
object
: A JSON object containing the following fields: DescribeMaintenanceStartTimeOutput$DayOfWeek DescribeMaintenanceStartTimeOutput$HourOfDay DescribeMaintenanceStartTimeOutput$MinuteOfHour DescribeMaintenanceStartTimeOutput$Timezone- DayOfWeek DayOfWeek
- GatewayARN GatewayARN
- HourOfDay HourOfDay
- MinuteOfHour MinuteOfHour
- Timezone GatewayTimezone
DescribeNFSFileSharesInput
- DescribeNFSFileSharesInput
object
: DescribeNFSFileSharesInput- FileShareARNList required FileShareARNList
DescribeNFSFileSharesOutput
- DescribeNFSFileSharesOutput
object
: DescribeNFSFileSharesOutput- NFSFileShareInfoList NFSFileShareInfoList
DescribeSnapshotScheduleInput
- DescribeSnapshotScheduleInput
object
: A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.- VolumeARN required VolumeARN
DescribeSnapshotScheduleOutput
- DescribeSnapshotScheduleOutput
object
- Description Description
- RecurrenceInHours RecurrenceInHours
- StartAt HourOfDay
- Timezone GatewayTimezone
- VolumeARN VolumeARN
DescribeStorediSCSIVolumesInput
- DescribeStorediSCSIVolumesInput
object
: A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.- VolumeARNs required VolumeARNs
DescribeStorediSCSIVolumesOutput
- DescribeStorediSCSIVolumesOutput
object
- StorediSCSIVolumes StorediSCSIVolumes
DescribeTapeArchivesInput
- DescribeTapeArchivesInput
object
: DescribeTapeArchivesInput- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
DescribeTapeArchivesOutput
- DescribeTapeArchivesOutput
object
: DescribeTapeArchivesOutput- Marker Marker
- TapeArchives TapeArchives
DescribeTapeRecoveryPointsInput
- DescribeTapeRecoveryPointsInput
object
: DescribeTapeRecoveryPointsInput- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
DescribeTapeRecoveryPointsOutput
- DescribeTapeRecoveryPointsOutput
object
: DescribeTapeRecoveryPointsOutput- GatewayARN GatewayARN
- Marker Marker
- TapeRecoveryPointInfos TapeRecoveryPointInfos
DescribeTapesInput
- DescribeTapesInput
object
: DescribeTapesInput- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
DescribeTapesOutput
DescribeUploadBufferInput
- DescribeUploadBufferInput
object
- GatewayARN required GatewayARN
DescribeUploadBufferOutput
- DescribeUploadBufferOutput
object
- DiskIds DiskIds
- GatewayARN GatewayARN
- UploadBufferAllocatedInBytes long
- UploadBufferUsedInBytes long
DescribeVTLDevicesInput
- DescribeVTLDevicesInput
object
: DescribeVTLDevicesInput- GatewayARN required GatewayARN
- Limit PositiveIntObject
- Marker Marker
- VTLDeviceARNs VTLDeviceARNs
DescribeVTLDevicesOutput
- DescribeVTLDevicesOutput
object
: DescribeVTLDevicesOutput- GatewayARN GatewayARN
- Marker Marker
- VTLDevices VTLDevices
DescribeWorkingStorageInput
- DescribeWorkingStorageInput
object
: A JSON object containing the of the gateway.- GatewayARN required GatewayARN
DescribeWorkingStorageOutput
- DescribeWorkingStorageOutput
object
: A JSON object containing the following fields:- DiskIds DiskIds
- GatewayARN GatewayARN
- WorkingStorageAllocatedInBytes long
- WorkingStorageUsedInBytes long
Description
- Description
string
DeviceType
- DeviceType
string
DeviceiSCSIAttributes
- DeviceiSCSIAttributes
object
: Lists iSCSI information about a VTL device.- ChapEnabled boolean
- NetworkInterfaceId NetworkInterfaceId
- NetworkInterfacePort integer
- TargetARN TargetARN
DisableGatewayInput
- DisableGatewayInput
object
: DisableGatewayInput- GatewayARN required GatewayARN
DisableGatewayOutput
- DisableGatewayOutput
object
: DisableGatewayOutput- GatewayARN GatewayARN
Disk
- Disk
object
DiskAllocationType
- DiskAllocationType
string
DiskId
- DiskId
string
DiskIds
- DiskIds
array
- items DiskId
Disks
- Disks
array
- items Disk
DoubleObject
- DoubleObject
number
ErrorCode
- ErrorCode
string
(values: ActivationKeyExpired, ActivationKeyInvalid, ActivationKeyNotFound, GatewayInternalError, GatewayNotConnected, GatewayNotFound, GatewayProxyNetworkConnectionBusy, AuthenticationFailure, BandwidthThrottleScheduleNotFound, Blocked, CannotExportSnapshot, ChapCredentialNotFound, DiskAlreadyAllocated, DiskDoesNotExist, DiskSizeGreaterThanVolumeMaxSize, DiskSizeLessThanVolumeSize, DiskSizeNotGigAligned, DuplicateCertificateInfo, DuplicateSchedule, EndpointNotFound, IAMNotSupported, InitiatorInvalid, InitiatorNotFound, InternalError, InvalidGateway, InvalidEndpoint, InvalidParameters, InvalidSchedule, LocalStorageLimitExceeded, LunAlreadyAllocated , LunInvalid, MaximumContentLengthExceeded, MaximumTapeCartridgeCountExceeded, MaximumVolumeCountExceeded, NetworkConfigurationChanged, NoDisksAvailable, NotImplemented, NotSupported, OperationAborted, OutdatedGateway, ParametersNotImplemented, RegionInvalid, RequestTimeout, ServiceUnavailable, SnapshotDeleted, SnapshotIdInvalid, SnapshotInProgress, SnapshotNotFound, SnapshotScheduleNotFound, StagingAreaFull, StorageFailure, TapeCartridgeNotFound, TargetAlreadyExists, TargetInvalid, TargetNotFound, UnauthorizedOperation, VolumeAlreadyExists, VolumeIdInvalid, VolumeInUse, VolumeNotFound, VolumeNotReady)
FileShareARN
- FileShareARN
string
: The Amazon Resource Name (ARN) of the file share.
FileShareARNList
- FileShareARNList
array
- items FileShareARN
FileShareClientList
- FileShareClientList
array
: The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.- items IPV4AddressCIDR
FileShareId
- FileShareId
string
: The ID of the file share.
FileShareInfo
- FileShareInfo
object
: Describes a file share.- FileShareARN FileShareARN
- FileShareId FileShareId
- FileShareStatus FileShareStatus
- GatewayARN GatewayARN
FileShareInfoList
- FileShareInfoList
array
- items FileShareInfo
FileShareStatus
- FileShareStatus
string
: The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.
GatewayARN
- GatewayARN
string
: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayId
- GatewayId
string
GatewayInfo
- GatewayInfo
object
: Describes a gateway object.- GatewayARN GatewayARN
- GatewayId GatewayId
- GatewayName string
- GatewayOperationalState GatewayOperationalState
- GatewayType GatewayType
GatewayName
- GatewayName
string
: The name you configured for your gateway.
GatewayNetworkInterfaces
- GatewayNetworkInterfaces
array
- items NetworkInterface
GatewayOperationalState
- GatewayOperationalState
string
GatewayState
- GatewayState
string
GatewayTimezone
- GatewayTimezone
string
GatewayType
- GatewayType
string
Gateways
- Gateways
array
- items GatewayInfo
HourOfDay
- HourOfDay
integer
IPV4AddressCIDR
- IPV4AddressCIDR
string
Initiator
- Initiator
string
Initiators
- Initiators
array
- items Initiator
InternalServerError
- InternalServerError
object
: An internal server error has occurred during the request. For more information, see the error and message fields.- error StorageGatewayError
- message string
InvalidGatewayRequestException
- InvalidGatewayRequestException
object
: An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.- error StorageGatewayError
- message string
IqnName
- IqnName
string
KMSKey
- KMSKey
string
: The ARN of the KMS key used for Amazon S3 server side encryption.
LastSoftwareUpdate
- LastSoftwareUpdate
string
ListFileSharesInput
- ListFileSharesInput
object
: ListFileShareInput- GatewayARN GatewayARN
- Limit PositiveIntObject
- Marker Marker
ListFileSharesOutput
- ListFileSharesOutput
object
: ListFileShareOutput- FileShareInfoList FileShareInfoList
- Marker Marker
- NextMarker Marker
ListGatewaysInput
- ListGatewaysInput
object
: A JSON object containing zero or more of the following fields: ListGatewaysInput$Limit ListGatewaysInput$Marker- Limit PositiveIntObject
- Marker Marker
ListGatewaysOutput
ListLocalDisksInput
- ListLocalDisksInput
object
: A JSON object containing the of the gateway.- GatewayARN required GatewayARN
ListLocalDisksOutput
- ListLocalDisksOutput
object
- Disks Disks
- GatewayARN GatewayARN
ListTagsForResourceInput
- ListTagsForResourceInput
object
: ListTagsForResourceInput- Limit PositiveIntObject
- Marker Marker
- ResourceARN required ResourceARN
ListTagsForResourceOutput
- ListTagsForResourceOutput
object
: ListTagsForResourceOutput- Marker Marker
- ResourceARN ResourceARN
- Tags Tags
ListTapesInput
- ListTapesInput
object
: A JSON object that contains one or more of the following fields: ListTapesInput$Limit ListTapesInput$Marker ListTapesInput$TapeARNs- Limit PositiveIntObject
- Marker Marker
- TapeARNs TapeARNs
ListTapesOutput
- ListTapesOutput
object
: A JSON object containing the following fields: ListTapesOutput$Marker ListTapesOutput$VolumeInfos
ListVolumeInitiatorsInput
- ListVolumeInitiatorsInput
object
: ListVolumeInitiatorsInput- VolumeARN required VolumeARN
ListVolumeInitiatorsOutput
- ListVolumeInitiatorsOutput
object
: ListVolumeInitiatorsOutput- Initiators Initiators
ListVolumeRecoveryPointsInput
- ListVolumeRecoveryPointsInput
object
- GatewayARN required GatewayARN
ListVolumeRecoveryPointsOutput
- ListVolumeRecoveryPointsOutput
object
- GatewayARN GatewayARN
- VolumeRecoveryPointInfos VolumeRecoveryPointInfos
ListVolumesInput
- ListVolumesInput
object
: A JSON object that contains one or more of the following fields: ListVolumesInput$Limit ListVolumesInput$Marker- GatewayARN GatewayARN
- Limit PositiveIntObject
- Marker Marker
ListVolumesOutput
- ListVolumesOutput
object
- GatewayARN GatewayARN
- Marker Marker
- VolumeInfos VolumeInfos
LocalConsolePassword
- LocalConsolePassword
string
LocationARN
- LocationARN
string
: The ARN of the backend storage used for storing file data.
Marker
- Marker
string
MediumChangerType
- MediumChangerType
string
MinuteOfHour
- MinuteOfHour
integer
NFSFileShareDefaults
- NFSFileShareDefaults
object
: 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 type.- DirectoryMode PermissionMode
- FileMode PermissionMode
- GroupId PermissionId
- OwnerId PermissionId
NFSFileShareInfo
- NFSFileShareInfo
object
: 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.- ClientList FileShareClientList
- DefaultStorageClass StorageClass
- FileShareARN FileShareARN
- FileShareId FileShareId
- FileShareStatus FileShareStatus
- GatewayARN GatewayARN
- GuessMIMETypeEnabled Boolean
- KMSEncrypted boolean
- KMSKey KMSKey
- LocationARN LocationARN
- NFSFileShareDefaults NFSFileShareDefaults
- Path Path
- ReadOnly Boolean
- Role Role
- Squash Squash
NFSFileShareInfoList
- NFSFileShareInfoList
array
- items NFSFileShareInfo
NetworkInterface
- NetworkInterface
object
: Describes a gateway's network interface.
NetworkInterfaceId
- NetworkInterfaceId
string
NextUpdateAvailabilityDate
- NextUpdateAvailabilityDate
string
NotificationId
- NotificationId
string
: The randomly generated ID of the notification that was sent. This ID is in UUID format.
NotifyWhenUploadedInput
- NotifyWhenUploadedInput
object
- FileShareARN required FileShareARN
NotifyWhenUploadedOutput
- NotifyWhenUploadedOutput
object
- FileShareARN FileShareARN
- NotificationId NotificationId
NumTapesToCreate
- NumTapesToCreate
integer
Path
- Path
string
: The file share path used by the NFS client to identify the mount point.
PermissionId
- PermissionId
integer
PermissionMode
- PermissionMode
string
PositiveIntObject
- PositiveIntObject
integer
RecurrenceInHours
- RecurrenceInHours
integer
RefreshCacheInput
- RefreshCacheInput
object
- FileShareARN required FileShareARN
RefreshCacheOutput
- RefreshCacheOutput
object
- FileShareARN FileShareARN
RegionId
- RegionId
string
RemoveTagsFromResourceInput
- RemoveTagsFromResourceInput
object
: RemoveTagsFromResourceInput- ResourceARN required ResourceARN
- TagKeys required TagKeys
RemoveTagsFromResourceOutput
- RemoveTagsFromResourceOutput
object
: RemoveTagsFromResourceOutput- ResourceARN ResourceARN
ResetCacheInput
- ResetCacheInput
object
- GatewayARN required GatewayARN
ResetCacheOutput
- ResetCacheOutput
object
- GatewayARN GatewayARN
ResourceARN
- ResourceARN
string
RetrieveTapeArchiveInput
- RetrieveTapeArchiveInput
object
: RetrieveTapeArchiveInput- GatewayARN required GatewayARN
- TapeARN required TapeARN
RetrieveTapeArchiveOutput
- RetrieveTapeArchiveOutput
object
: RetrieveTapeArchiveOutput- TapeARN TapeARN
RetrieveTapeRecoveryPointInput
- RetrieveTapeRecoveryPointInput
object
: RetrieveTapeRecoveryPointInput- GatewayARN required GatewayARN
- TapeARN required TapeARN
RetrieveTapeRecoveryPointOutput
- RetrieveTapeRecoveryPointOutput
object
: RetrieveTapeRecoveryPointOutput- TapeARN TapeARN
Role
- Role
string
: The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
ServiceUnavailableError
- ServiceUnavailableError
object
: An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.- error StorageGatewayError
- message string
SetLocalConsolePasswordInput
- SetLocalConsolePasswordInput
object
: SetLocalConsolePasswordInput- GatewayARN required GatewayARN
- LocalConsolePassword required LocalConsolePassword
SetLocalConsolePasswordOutput
- SetLocalConsolePasswordOutput
object
- GatewayARN GatewayARN
ShutdownGatewayInput
- ShutdownGatewayInput
object
: A JSON object containing the of the gateway to shut down.- GatewayARN required GatewayARN
ShutdownGatewayOutput
- ShutdownGatewayOutput
object
: A JSON object containing the of the gateway that was shut down.- GatewayARN GatewayARN
SnapshotDescription
- SnapshotDescription
string
SnapshotId
- SnapshotId
string
Squash
- Squash
string
: The user mapped to anonymous user. Valid options are the following: "RootSquash" - Only root is mapped to anonymous user. "NoSquash" - No one is mapped to anonymous user "AllSquash" - Everyone is mapped to anonymous user.
StartGatewayInput
- StartGatewayInput
object
: A JSON object containing the of the gateway to start.- GatewayARN required GatewayARN
StartGatewayOutput
- StartGatewayOutput
object
: A JSON object containing the of the gateway that was restarted.- GatewayARN GatewayARN
StorageClass
- StorageClass
string
:
StorageGatewayError
- StorageGatewayError
object
: Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.- errorCode ErrorCode
- errorDetails errorDetails
StorediSCSIVolume
- StorediSCSIVolume
object
: Describes an iSCSI stored volume.- CreatedDate CreatedDate
- PreservedExistingData boolean
- SourceSnapshotId SnapshotId
- VolumeARN VolumeARN
- VolumeDiskId DiskId
- VolumeId VolumeId
- VolumeProgress DoubleObject
- VolumeSizeInBytes long
- VolumeStatus VolumeStatus
- VolumeType VolumeType
- VolumeUsedInBytes VolumeUsedInBytes
- VolumeiSCSIAttributes VolumeiSCSIAttributes
StorediSCSIVolumes
- StorediSCSIVolumes
array
- items StorediSCSIVolume
Tag
TagKey
- TagKey
string
TagKeys
- TagKeys
array
- items TagKey
TagValue
- TagValue
string
Tags
- Tags
array
- items Tag
Tape
- Tape
object
: Describes a virtual tape object.- Progress DoubleObject
- TapeARN TapeARN
- TapeBarcode TapeBarcode
- TapeCreatedDate Time
- TapeSizeInBytes TapeSize
- TapeStatus TapeStatus
- TapeUsedInBytes TapeUsage
- VTLDevice VTLDeviceARN
TapeARN
- TapeARN
string
TapeARNs
- TapeARNs
array
: The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.- items TapeARN
TapeArchive
- TapeArchive
object
: Represents a virtual tape that is archived in the virtual tape shelf (VTS).- CompletionTime Time
- RetrievedTo GatewayARN
- TapeARN TapeARN
- TapeBarcode TapeBarcode
- TapeCreatedDate Time
- TapeSizeInBytes TapeSize
- TapeStatus TapeArchiveStatus
- TapeUsedInBytes TapeUsage
TapeArchiveStatus
- TapeArchiveStatus
string
TapeArchives
- TapeArchives
array
- items TapeArchive
TapeBarcode
- TapeBarcode
string
TapeBarcodePrefix
- TapeBarcodePrefix
string
TapeDriveType
- TapeDriveType
string
TapeInfo
- TapeInfo
object
: Describes a virtual tape.- GatewayARN GatewayARN
- TapeARN TapeARN
- TapeBarcode TapeBarcode
- TapeSizeInBytes TapeSize
- TapeStatus TapeStatus
TapeInfos
- TapeInfos
array
: An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.- items TapeInfo
TapeRecoveryPointInfo
- TapeRecoveryPointInfo
object
: Describes a recovery point.- TapeARN TapeARN
- TapeRecoveryPointTime Time
- TapeSizeInBytes TapeSize
- TapeStatus TapeRecoveryPointStatus
TapeRecoveryPointInfos
- TapeRecoveryPointInfos
array
- items TapeRecoveryPointInfo
TapeRecoveryPointStatus
- TapeRecoveryPointStatus
string
TapeSize
- TapeSize
integer
TapeStatus
- TapeStatus
string
TapeUsage
- TapeUsage
integer
Tapes
- Tapes
array
- items Tape
TargetARN
- TargetARN
string
TargetName
- TargetName
string
Time
- Time
string
UpdateBandwidthRateLimitInput
- UpdateBandwidthRateLimitInput
object
: A JSON object conta