DataFire integration for AWS Storage Gateway
npm install @datafire/amazonaws_storagegatewayClient library for AWS Storage Gateway
bash
npm install --save @datafire/amazonaws_storagegateway
`
js
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
$3
js
amazonaws_storagegateway.ActivateGateway({
"ActivationKey": "",
"GatewayName": "",
"GatewayTimezone": "",
"GatewayRegion": ""
}, context)
`#### Input
* input
* ActivationKey required ActivationKey
* GatewayName required GatewayName
* GatewayRegion required RegionId
* GatewayTimezone required GatewayTimezone
* GatewayType GatewayType
* MediumChangerType MediumChangerType
* TapeDriveType TapeDriveType#### Output
* output ActivateGatewayOutput
$3
js
amazonaws_storagegateway.AddCache({
"GatewayARN": "",
"DiskIds": []
}, context)
`#### Input
* input
* DiskIds required DiskIds
* GatewayARN required GatewayARN#### Output
* output AddCacheOutput
$3
js
amazonaws_storagegateway.AddTagsToResource({
"ResourceARN": "",
"Tags": []
}, context)
`#### Input
* input
* ResourceARN required ResourceARN
* Tags required Tags#### Output
* output AddTagsToResourceOutput
$3
js
amazonaws_storagegateway.AddUploadBuffer({
"GatewayARN": "",
"DiskIds": []
}, context)
`#### Input
* input
* DiskIds required DiskIds
* GatewayARN required GatewayARN#### Output
* output AddUploadBufferOutput
$3
js
amazonaws_storagegateway.AddWorkingStorage({
"GatewayARN": "",
"DiskIds": []
}, context)
`#### Input
* input
* DiskIds required DiskIds
* GatewayARN required GatewayARN#### Output
* output AddWorkingStorageOutput
$3
js
amazonaws_storagegateway.CancelArchival({
"GatewayARN": "",
"TapeARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeARN required TapeARN#### Output
* output CancelArchivalOutput
$3
js
amazonaws_storagegateway.CancelRetrieval({
"GatewayARN": "",
"TapeARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeARN required TapeARN#### Output
* output CancelRetrievalOutput
$3
js
amazonaws_storagegateway.CreateCachediSCSIVolume({
"GatewayARN": "",
"VolumeSizeInBytes": 0,
"TargetName": "",
"NetworkInterfaceId": "",
"ClientToken": ""
}, context)
`#### Input
* input
* ClientToken required ClientToken
* GatewayARN required GatewayARN
* NetworkInterfaceId required NetworkInterfaceId
* SnapshotId SnapshotId
* SourceVolumeARN VolumeARN
* TargetName required TargetName
* VolumeSizeInBytes required long#### Output
* output CreateCachediSCSIVolumeOutput
$3
js
amazonaws_storagegateway.CreateNFSFileShare({
"ClientToken": "",
"GatewayARN": "",
"Role": "",
"LocationARN": ""
}, context)
`#### Input
* input
* 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
$3
js
amazonaws_storagegateway.CreateSnapshot({
"VolumeARN": "",
"SnapshotDescription": ""
}, context)
`#### Input
* input
* SnapshotDescription required SnapshotDescription
* VolumeARN required VolumeARN#### Output
* output CreateSnapshotOutput
$3
js
amazonaws_storagegateway.CreateSnapshotFromVolumeRecoveryPoint({
"VolumeARN": "",
"SnapshotDescription": ""
}, context)
`#### Input
* input
* SnapshotDescription required SnapshotDescription
* VolumeARN required VolumeARN#### Output
* output CreateSnapshotFromVolumeRecoveryPointOutput
$3
js
amazonaws_storagegateway.CreateStorediSCSIVolume({
"GatewayARN": "",
"DiskId": "",
"PreserveExistingData": true,
"TargetName": "",
"NetworkInterfaceId": ""
}, context)
`#### Input
* input
* DiskId required DiskId
* GatewayARN required GatewayARN
* NetworkInterfaceId required NetworkInterfaceId
* PreserveExistingData required boolean
* SnapshotId SnapshotId
* TargetName required TargetName#### Output
* output CreateStorediSCSIVolumeOutput
$3
js
amazonaws_storagegateway.CreateTapeWithBarcode({
"GatewayARN": "",
"TapeSizeInBytes": 0,
"TapeBarcode": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeBarcode required TapeBarcode
* TapeSizeInBytes required TapeSize#### Output
* output CreateTapeWithBarcodeOutput
$3
js
amazonaws_storagegateway.CreateTapes({
"GatewayARN": "",
"TapeSizeInBytes": 0,
"ClientToken": "",
"NumTapesToCreate": 0,
"TapeBarcodePrefix": ""
}, context)
`#### Input
* input
* ClientToken required ClientToken
* GatewayARN required GatewayARN
* NumTapesToCreate required NumTapesToCreate
* TapeBarcodePrefix required TapeBarcodePrefix
* TapeSizeInBytes required TapeSize#### Output
* output CreateTapesOutput
$3
js
amazonaws_storagegateway.DeleteBandwidthRateLimit({
"GatewayARN": "",
"BandwidthType": ""
}, context)
`#### Input
* input
* BandwidthType required BandwidthType
* GatewayARN required GatewayARN#### Output
* output DeleteBandwidthRateLimitOutput
$3
js
amazonaws_storagegateway.DeleteChapCredentials({
"TargetARN": "",
"InitiatorName": ""
}, context)
`#### Input
* input
* InitiatorName required IqnName
* TargetARN required TargetARN#### Output
* output DeleteChapCredentialsOutput
$3
js
amazonaws_storagegateway.DeleteFileShare({
"FileShareARN": ""
}, context)
`#### Input
* input
* FileShareARN required FileShareARN
* ForceDelete boolean#### Output
* output DeleteFileShareOutput
$3
js
amazonaws_storagegateway.DeleteGateway({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DeleteGatewayOutput
$3
js
amazonaws_storagegateway.DeleteSnapshotSchedule({
"VolumeARN": ""
}, context)
`#### Input
* input
* VolumeARN required VolumeARN#### Output
* output DeleteSnapshotScheduleOutput
$3
js
amazonaws_storagegateway.DeleteTape({
"GatewayARN": "",
"TapeARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeARN required TapeARN#### Output
* output DeleteTapeOutput
$3
js
amazonaws_storagegateway.DeleteTapeArchive({
"TapeARN": ""
}, context)
`#### Input
* input
* TapeARN required TapeARN#### Output
* output DeleteTapeArchiveOutput
$3
js
amazonaws_storagegateway.DeleteVolume({
"VolumeARN": ""
}, context)
`#### Input
* input
* VolumeARN required VolumeARN#### Output
* output DeleteVolumeOutput
$3
js
amazonaws_storagegateway.DescribeBandwidthRateLimit({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeBandwidthRateLimitOutput
$3
js
amazonaws_storagegateway.DescribeCache({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeCacheOutput
$3
js
amazonaws_storagegateway.DescribeCachediSCSIVolumes({
"VolumeARNs": []
}, context)
`#### Input
* input
* VolumeARNs required VolumeARNs#### Output
* output DescribeCachediSCSIVolumesOutput
$3
js
amazonaws_storagegateway.DescribeChapCredentials({
"TargetARN": ""
}, context)
`#### Input
* input
* TargetARN required TargetARN#### Output
* output DescribeChapCredentialsOutput
$3
js
amazonaws_storagegateway.DescribeGatewayInformation({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeGatewayInformationOutput
$3
js
amazonaws_storagegateway.DescribeMaintenanceStartTime({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeMaintenanceStartTimeOutput
$3
js
amazonaws_storagegateway.DescribeNFSFileShares({
"FileShareARNList": []
}, context)
`#### Input
* input
* FileShareARNList required FileShareARNList#### Output
* output DescribeNFSFileSharesOutput
$3
js
amazonaws_storagegateway.DescribeSnapshotSchedule({
"VolumeARN": ""
}, context)
`#### Input
* input
* VolumeARN required VolumeARN#### Output
* output DescribeSnapshotScheduleOutput
$3
js
amazonaws_storagegateway.DescribeStorediSCSIVolumes({
"VolumeARNs": []
}, context)
`#### Input
* input
* VolumeARNs required VolumeARNs#### Output
* output DescribeStorediSCSIVolumesOutput
$3
js
amazonaws_storagegateway.DescribeTapeArchives({}, context)
`#### Input
* input
* Limit
* Marker
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs#### Output
* output DescribeTapeArchivesOutput
$3
js
amazonaws_storagegateway.DescribeTapeRecoveryPoints({
"GatewayARN": ""
}, context)
`#### Input
* input
* Limit
* Marker
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker#### Output
* output DescribeTapeRecoveryPointsOutput
$3
js
amazonaws_storagegateway.DescribeTapes({
"GatewayARN": ""
}, context)
`#### Input
* input
* Limit
* Marker
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs#### Output
* output DescribeTapesOutput
$3
js
amazonaws_storagegateway.DescribeUploadBuffer({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeUploadBufferOutput
$3
js
amazonaws_storagegateway.DescribeVTLDevices({
"GatewayARN": ""
}, context)
`#### Input
* input
* Limit
* Marker
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker
* VTLDeviceARNs VTLDeviceARNs#### Output
* output DescribeVTLDevicesOutput
$3
js
amazonaws_storagegateway.DescribeWorkingStorage({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DescribeWorkingStorageOutput
$3
js
amazonaws_storagegateway.DisableGateway({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output DisableGatewayOutput
$3
js
amazonaws_storagegateway.ListFileShares({}, context)
`#### Input
* input
* GatewayARN GatewayARN
* Limit PositiveIntObject
* Marker Marker#### Output
* output ListFileSharesOutput
$3
js
amazonaws_storagegateway.ListGateways({}, context)
`#### Input
* input
* Limit
* Marker
* Limit PositiveIntObject
* Marker Marker#### Output
* output ListGatewaysOutput
$3
js
amazonaws_storagegateway.ListLocalDisks({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output ListLocalDisksOutput
$3
js
amazonaws_storagegateway.ListTagsForResource({
"ResourceARN": ""
}, context)
`#### Input
* input
* Limit PositiveIntObject
* Marker Marker
* ResourceARN required ResourceARN#### Output
* output ListTagsForResourceOutput
$3
js
amazonaws_storagegateway.ListTapes({}, context)
`#### Input
* input
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs#### Output
* output ListTapesOutput
$3
js
amazonaws_storagegateway.ListVolumeInitiators({
"VolumeARN": ""
}, context)
`#### Input
* input
* VolumeARN required VolumeARN#### Output
* output ListVolumeInitiatorsOutput
$3
js
amazonaws_storagegateway.ListVolumeRecoveryPoints({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output ListVolumeRecoveryPointsOutput
$3
js
amazonaws_storagegateway.ListVolumes({}, context)
`#### Input
* input
* Limit
* Marker
* GatewayARN GatewayARN
* Limit PositiveIntObject
* Marker Marker#### Output
* output ListVolumesOutput
$3
js
amazonaws_storagegateway.NotifyWhenUploaded({
"FileShareARN": ""
}, context)
`#### Input
* input
* FileShareARN required FileShareARN#### Output
* output NotifyWhenUploadedOutput
$3
js
amazonaws_storagegateway.RefreshCache({
"FileShareARN": ""
}, context)
`#### Input
* input
* FileShareARN required FileShareARN#### Output
* output RefreshCacheOutput
$3
js
amazonaws_storagegateway.RemoveTagsFromResource({
"ResourceARN": "",
"TagKeys": []
}, context)
`#### Input
* input
* ResourceARN required ResourceARN
* TagKeys required TagKeys#### Output
* output RemoveTagsFromResourceOutput
$3
js
amazonaws_storagegateway.ResetCache({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output ResetCacheOutput
$3
js
amazonaws_storagegateway.RetrieveTapeArchive({
"TapeARN": "",
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeARN required TapeARN#### Output
* output RetrieveTapeArchiveOutput
$3
js
amazonaws_storagegateway.RetrieveTapeRecoveryPoint({
"TapeARN": "",
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* TapeARN required TapeARN#### Output
* output RetrieveTapeRecoveryPointOutput
$3
js
amazonaws_storagegateway.SetLocalConsolePassword({
"GatewayARN": "",
"LocalConsolePassword": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* LocalConsolePassword required LocalConsolePassword#### Output
* output SetLocalConsolePasswordOutput
$3
js
amazonaws_storagegateway.ShutdownGateway({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output ShutdownGatewayOutput
$3
js
amazonaws_storagegateway.StartGateway({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output StartGatewayOutput
$3
js
amazonaws_storagegateway.UpdateBandwidthRateLimit({
"GatewayARN": ""
}, context)
`#### Input
* input
* AverageDownloadRateLimitInBitsPerSec BandwidthDownloadRateLimit
* AverageUploadRateLimitInBitsPerSec BandwidthUploadRateLimit
* GatewayARN required GatewayARN#### Output
* output UpdateBandwidthRateLimitOutput
$3
js
amazonaws_storagegateway.UpdateChapCredentials({
"TargetARN": "",
"SecretToAuthenticateInitiator": "",
"InitiatorName": ""
}, context)
`#### Input
* input
* InitiatorName required IqnName
* SecretToAuthenticateInitiator required ChapSecret
* SecretToAuthenticateTarget ChapSecret
* TargetARN required TargetARN#### Output
* output UpdateChapCredentialsOutput
$3
js
amazonaws_storagegateway.UpdateGatewayInformation({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN
* GatewayName GatewayName
* GatewayTimezone GatewayTimezone#### Output
* output UpdateGatewayInformationOutput
$3
js
amazonaws_storagegateway.UpdateGatewaySoftwareNow({
"GatewayARN": ""
}, context)
`#### Input
* input
* GatewayARN required GatewayARN#### Output
* output UpdateGatewaySoftwareNowOutput
$3
js
amazonaws_storagegateway.UpdateMaintenanceStartTime({
"GatewayARN": "",
"HourOfDay": 0,
"MinuteOfHour": 0,
"DayOfWeek": 0
}, context)
`#### Input
* input
* DayOfWeek required DayOfWeek
* GatewayARN required GatewayARN
* HourOfDay required HourOfDay
* MinuteOfHour required MinuteOfHour#### Output
* output UpdateMaintenanceStartTimeOutput
$3
js
amazonaws_storagegateway.UpdateNFSFileShare({
"FileShareARN": ""
}, context)
`#### Input
* input
* ClientList FileShareClientList
* DefaultStorageClass StorageClass
* FileShareARN required FileShareARN
* GuessMIMETypeEnabled Boolean
* KMSEncrypted Boolean
* KMSKey KMSKey
* NFSFileShareDefaults NFSFileShareDefaults
* ReadOnly Boolean
* Squash Squash#### Output
* output UpdateNFSFileShareOutput
$3
js
amazonaws_storagegateway.UpdateSnapshotSchedule({
"VolumeARN": "",
"StartAt": 0,
"RecurrenceInHours": 0
}, context)
`#### Input
* input
* Description Description
* RecurrenceInHours required RecurrenceInHours
* StartAt required HourOfDay
* VolumeARN required VolumeARN#### Output
* output UpdateSnapshotScheduleOutput
$3
js
amazonaws_storagegateway.UpdateVTLDeviceType({
"VTLDeviceARN": "",
"DeviceType": ""
}, context)
`#### Input
* input
* DeviceType required DeviceType
* VTLDeviceARN required VTLDeviceARN#### Output
* output UpdateVTLDeviceTypeOutput
Definitions
$3
* ActivateGatewayInput : A JSON object containing one or more of the following fields:
-
-
-
-
-
-
-
* ActivationKey required ActivationKey
* GatewayName required GatewayName
* GatewayRegion required RegionId
* GatewayTimezone required GatewayTimezone
* GatewayType GatewayType
* MediumChangerType MediumChangerType
* TapeDriveType TapeDriveType$3
* 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$3
* ActivationKey string$3
* AddCacheInput
* DiskIds required DiskIds
* GatewayARN required GatewayARN$3
* AddCacheOutput
* GatewayARN GatewayARN$3
* AddTagsToResourceInput : AddTagsToResourceInput
* ResourceARN required ResourceARN
* Tags required Tags$3
* AddTagsToResourceOutput object: AddTagsToResourceOutput
* ResourceARN ResourceARN$3
* AddUploadBufferInput object
* DiskIds required DiskIds
* GatewayARN required GatewayARN$3
* AddUploadBufferOutput
* GatewayARN GatewayARN$3
* AddWorkingStorageInput : A JSON object containing one or more of the following fields:
* DiskIds required DiskIds
* GatewayARN required GatewayARN$3
* AddWorkingStorageOutput object: A JSON object containing the of the gateway for which working storage was configured.
* GatewayARN GatewayARN$3
* BandwidthDownloadRateLimit integer$3
* BandwidthType $3
* BandwidthUploadRateLimit $3
* 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".$3
* 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$3
* CachediSCSIVolumes array
* items CachediSCSIVolume$3
* CancelArchivalInput : CancelArchivalInput
* GatewayARN required GatewayARN
* TapeARN required TapeARN$3
* CancelArchivalOutput object: CancelArchivalOutput
* TapeARN TapeARN$3
* CancelRetrievalInput object: CancelRetrievalInput
* GatewayARN required GatewayARN
* TapeARN required TapeARN$3
* CancelRetrievalOutput object: CancelRetrievalOutput
* TapeARN TapeARN$3
* ChapCredentials array
* items ChapInfo$3
* ChapInfo : Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
* InitiatorName IqnName
* SecretToAuthenticateInitiator ChapSecret
* SecretToAuthenticateTarget ChapSecret
* TargetARN TargetARN$3
* ChapSecret string$3
* ClientToken $3
* CreateCachediSCSIVolumeInput
* ClientToken required ClientToken
* GatewayARN required GatewayARN
* NetworkInterfaceId required NetworkInterfaceId
* SnapshotId SnapshotId
* SourceVolumeARN VolumeARN
* TargetName required TargetName
* VolumeSizeInBytes required long$3
* CreateCachediSCSIVolumeOutput
* TargetARN TargetARN
* VolumeARN VolumeARN$3
* CreateNFSFileShareInput : 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$3
* CreateNFSFileShareOutput object: CreateNFSFileShareOutput
* FileShareARN FileShareARN$3
* CreateSnapshotFromVolumeRecoveryPointInput object
* SnapshotDescription required SnapshotDescription
* VolumeARN required VolumeARN$3
* CreateSnapshotFromVolumeRecoveryPointOutput
* SnapshotId SnapshotId
* VolumeARN VolumeARN
* VolumeRecoveryPointTime string$3
* CreateSnapshotInput : A JSON object containing one or more of the following fields:
* SnapshotDescription required SnapshotDescription
* VolumeARN required VolumeARN$3
* CreateSnapshotOutput object: A JSON object containing the following fields:
* SnapshotId SnapshotId
* VolumeARN VolumeARN$3
* CreateStorediSCSIVolumeInput object: A JSON object containing one or more of the following fields:
-
-
-
-
-
* DiskId required DiskId
* GatewayARN required GatewayARN
* NetworkInterfaceId required NetworkInterfaceId
* PreserveExistingData required boolean
* SnapshotId SnapshotId
* TargetName required TargetName$3
* CreateStorediSCSIVolumeOutput object: A JSON object containing the following fields:
* TargetARN TargetARN
* VolumeARN VolumeARN
* VolumeSizeInBytes long$3
* CreateTapeWithBarcodeInput object: CreateTapeWithBarcodeInput
* GatewayARN required GatewayARN
* TapeBarcode required TapeBarcode
* TapeSizeInBytes required TapeSize$3
* CreateTapeWithBarcodeOutput object: CreateTapeOutput
* TapeARN TapeARN$3
* CreateTapesInput object: CreateTapesInput
* ClientToken required ClientToken
* GatewayARN required GatewayARN
* NumTapesToCreate required NumTapesToCreate
* TapeBarcodePrefix required TapeBarcodePrefix
* TapeSizeInBytes required TapeSize$3
* CreateTapesOutput object: CreateTapeOutput
* TapeARNs TapeARNs$3
* CreatedDate string$3
* DayOfWeek $3
* DeleteBandwidthRateLimitInput : A JSON object containing the following fields:
* BandwidthType required BandwidthType
* GatewayARN required GatewayARN$3
* DeleteBandwidthRateLimitOutput object: A JSON object containing the of the gateway whose bandwidth rate information was deleted.
* GatewayARN GatewayARN$3
* DeleteChapCredentialsInput object: A JSON object containing one or more of the following fields:
* InitiatorName required IqnName
* TargetARN required TargetARN$3
* DeleteChapCredentialsOutput object: A JSON object containing the following fields:
* InitiatorName IqnName
* TargetARN TargetARN$3
* DeleteFileShareInput object: DeleteFileShareInput
* FileShareARN required FileShareARN
* ForceDelete boolean$3
* DeleteFileShareOutput object: DeleteFileShareOutput
* FileShareARN FileShareARN$3
* DeleteGatewayInput object: A JSON object containing the ID of the gateway to delete.
* GatewayARN required GatewayARN$3
* DeleteGatewayOutput object: A JSON object containing the ID of the deleted gateway.
* GatewayARN GatewayARN$3
* DeleteSnapshotScheduleInput object
* VolumeARN required VolumeARN$3
* DeleteSnapshotScheduleOutput
* VolumeARN VolumeARN$3
* DeleteTapeArchiveInput : DeleteTapeArchiveInput
* TapeARN required TapeARN$3
* DeleteTapeArchiveOutput object: DeleteTapeArchiveOutput
* TapeARN TapeARN$3
* DeleteTapeInput object: DeleteTapeInput
* GatewayARN required GatewayARN
* TapeARN required TapeARN$3
* DeleteTapeOutput object: DeleteTapeOutput
* TapeARN TapeARN$3
* DeleteVolumeInput object: A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
* VolumeARN required VolumeARN$3
* DeleteVolumeOutput object: A JSON object containing the of the storage volume that was deleted
* VolumeARN VolumeARN$3
* DescribeBandwidthRateLimitInput object: A JSON object containing the of the gateway.
* GatewayARN required GatewayARN$3
* DescribeBandwidthRateLimitOutput object: A JSON object containing the following fields:
* AverageDownloadRateLimitInBitsPerSec BandwidthDownloadRateLimit
* AverageUploadRateLimitInBitsPerSec BandwidthUploadRateLimit
* GatewayARN GatewayARN$3
* DescribeCacheInput object
* GatewayARN required GatewayARN$3
* DescribeCacheOutput
* CacheAllocatedInBytes long
* CacheDirtyPercentage double
* CacheHitPercentage double
* CacheMissPercentage double
* CacheUsedPercentage double
* DiskIds DiskIds
* GatewayARN GatewayARN$3
* DescribeCachediSCSIVolumesInput
* VolumeARNs required VolumeARNs$3
* DescribeCachediSCSIVolumesOutput : A JSON object containing the following fields:
* CachediSCSIVolumes CachediSCSIVolumes$3
* DescribeChapCredentialsInput object: A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
* TargetARN required TargetARN$3
* DescribeChapCredentialsOutput object: A JSON object containing a .
* ChapCredentials ChapCredentials$3
* DescribeGatewayInformationInput object: A JSON object containing the ID of the gateway.
* GatewayARN required GatewayARN$3
* 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$3
* DescribeMaintenanceStartTimeInput object: A JSON object containing the of the gateway.
* GatewayARN required GatewayARN$3
* DescribeMaintenanceStartTimeOutput object: A JSON object containing the following fields:
-
-
-
-
* DayOfWeek DayOfWeek
* GatewayARN GatewayARN
* HourOfDay HourOfDay
* MinuteOfHour MinuteOfHour
* Timezone GatewayTimezone$3
* DescribeNFSFileSharesInput object: DescribeNFSFileSharesInput
* FileShareARNList required FileShareARNList$3
* DescribeNFSFileSharesOutput object: DescribeNFSFileSharesOutput
* NFSFileShareInfoList NFSFileShareInfoList$3
* DescribeSnapshotScheduleInput object: A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
* VolumeARN required VolumeARN$3
* DescribeSnapshotScheduleOutput object
* Description Description
* RecurrenceInHours RecurrenceInHours
* StartAt HourOfDay
* Timezone GatewayTimezone
* VolumeARN VolumeARN$3
* DescribeStorediSCSIVolumesInput : A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
* VolumeARNs required VolumeARNs$3
* DescribeStorediSCSIVolumesOutput object
* StorediSCSIVolumes StorediSCSIVolumes$3
* DescribeTapeArchivesInput : DescribeTapeArchivesInput
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs$3
* DescribeTapeArchivesOutput object: DescribeTapeArchivesOutput
* Marker Marker
* TapeArchives TapeArchives$3
* DescribeTapeRecoveryPointsInput object: DescribeTapeRecoveryPointsInput
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker$3
* DescribeTapeRecoveryPointsOutput object: DescribeTapeRecoveryPointsOutput
* GatewayARN GatewayARN
* Marker Marker
* TapeRecoveryPointInfos TapeRecoveryPointInfos$3
* DescribeTapesInput object: DescribeTapesInput
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs$3
* DescribeTapesOutput object: DescribeTapesOutput
* Marker Marker
* Tapes Tapes$3
* DescribeUploadBufferInput object
* GatewayARN required GatewayARN$3
* DescribeUploadBufferOutput
* DiskIds DiskIds
* GatewayARN GatewayARN
* UploadBufferAllocatedInBytes long
* UploadBufferUsedInBytes long$3
* DescribeVTLDevicesInput : DescribeVTLDevicesInput
* GatewayARN required GatewayARN
* Limit PositiveIntObject
* Marker Marker
* VTLDeviceARNs VTLDeviceARNs$3
* DescribeVTLDevicesOutput object: DescribeVTLDevicesOutput
* GatewayARN GatewayARN
* Marker Marker
* VTLDevices VTLDevices$3
* DescribeWorkingStorageInput object: A JSON object containing the of the gateway.
* GatewayARN required GatewayARN$3
* DescribeWorkingStorageOutput object: A JSON object containing the following fields:
* DiskIds DiskIds
* GatewayARN GatewayARN
* WorkingStorageAllocatedInBytes long
* WorkingStorageUsedInBytes long$3
* Description string$3
* DeviceType $3
* DeviceiSCSIAttributes : Lists iSCSI information about a VTL device.
* ChapEnabled boolean
* NetworkInterfaceId NetworkInterfaceId
* NetworkInterfacePort integer
* TargetARN TargetARN$3
* DisableGatewayInput object: DisableGatewayInput
* GatewayARN required GatewayARN$3
* DisableGatewayOutput object: DisableGatewayOutput
* GatewayARN GatewayARN$3
* Disk object
* DiskAllocationResource string
* DiskAllocationType DiskAllocationType
* DiskId DiskId
* DiskNode string
* DiskPath string
* DiskSizeInBytes long
* DiskStatus string$3
* DiskAllocationType $3
* DiskId $3
* DiskIds
* items DiskId$3
* Disks
* items Disk$3
* DoubleObject $3
* ErrorCode (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)$3
* FileShareARN string: The Amazon Resource Name (ARN) of the file share. $3
* FileShareARNList array
* items FileShareARN$3
* FileShareClientList : 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$3
* FileShareId string: The ID of the file share. $3
* FileShareInfo object: Describes a file share.
* FileShareARN FileShareARN
* FileShareId FileShareId
* FileShareStatus FileShareStatus
* GatewayARN GatewayARN$3
* FileShareInfoList array
* items FileShareInfo$3
* FileShareStatus : The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING. $3
* 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.$3
* GatewayId string$3
* GatewayInfo : Describes a gateway object.
* GatewayARN GatewayARN
* GatewayId GatewayId
* GatewayName string
* GatewayOperationalState GatewayOperationalState
* GatewayType GatewayType$3
* GatewayName string: The name you configured for your gateway.$3
* GatewayNetworkInterfaces array
* items NetworkInterface$3
* GatewayOperationalState $3
* GatewayState $3
* GatewayTimezone $3
* GatewayType $3
* Gateways
* items GatewayInfo$3
* HourOfDay $3
* IPV4AddressCIDR $3
* Initiator $3
* Initiators
* items Initiator$3
* InternalServerError : An internal server error has occurred during the request. For more information, see the error and message fields.
* error StorageGatewayError
* message string$3
* 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$3
* IqnName string$3
* KMSKey : The ARN of the KMS key used for Amazon S3 server side encryption. $3
* LastSoftwareUpdate string$3
* ListFileSharesInput : ListFileShareInput
* GatewayARN GatewayARN
* Limit PositiveIntObject
* Marker Marker$3
* ListFileSharesOutput object: ListFileShareOutput
* FileShareInfoList FileShareInfoList
* Marker Marker
* NextMarker Marker$3
* ListGatewaysInput object: A JSON object containing zero or more of the following fields:
* Limit PositiveIntObject
* Marker Marker$3
* ListGatewaysOutput object
* Gateways Gateways
* Marker Marker$3
* ListLocalDisksInput : A JSON object containing the of the gateway.
* GatewayARN required GatewayARN$3
* ListLocalDisksOutput object
* Disks Disks
* GatewayARN GatewayARN$3
* ListTagsForResourceInput : ListTagsForResourceInput
* Limit PositiveIntObject
* Marker Marker
* ResourceARN required ResourceARN$3
* ListTagsForResourceOutput object: ListTagsForResourceOutput
* Marker Marker
* ResourceARN ResourceARN
* Tags Tags$3
* ListTapesInput object: A JSON object that contains one or more of the following fields:
* Limit PositiveIntObject
* Marker Marker
* TapeARNs TapeARNs$3
* ListTapesOutput object: A JSON object containing the following fields:
* Marker Marker
* TapeInfos TapeInfos$3
* ListVolumeInitiatorsInput object: ListVolumeInitiatorsInput
* VolumeARN required VolumeARN$3
* ListVolumeInitiatorsOutput object: ListVolumeInitiatorsOutput
* Initiators Initiators$3
* ListVolumeRecoveryPointsInput object
* GatewayARN required GatewayARN$3
* ListVolumeRecoveryPointsOutput
* GatewayARN GatewayARN
* VolumeRecoveryPointInfos VolumeRecoveryPointInfos$3
* ListVolumesInput : A JSON object that contains one or more of the following fields:
* GatewayARN GatewayARN
* Limit PositiveIntObject
* Marker Marker$3
* ListVolumesOutput object
* GatewayARN GatewayARN
* Marker Marker
* VolumeInfos VolumeInfos$3
* LocalConsolePassword $3
* LocationARN : The ARN of the backend storage used for storing file data. $3
* Marker string$3
* MediumChangerType $3
* MinuteOfHour $3
* NFSFileShareDefaults : 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$3
* 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$3
* NFSFileShareInfoList array
* items NFSFileShareInfo$3
* NetworkInterface : Describes a gateway's network interface.
* Ipv4Address string
* Ipv6Address string
* MacAddress string$3
* NetworkInterfaceId string$3
* NextUpdateAvailabilityDate $3
* NotificationId : The randomly generated ID of the notification that was sent. This ID is in UUID format.$3
* NotifyWhenUploadedInput object
* FileShareARN required FileShareARN$3
* NotifyWhenUploadedOutput
* FileShareARN FileShareARN
* NotificationId NotificationId$3
* NumTapesToCreate $3
* Path : The file share path used by the NFS client to identify the mount point. $3
* PermissionId integer$3
* PermissionMode $3
* PositiveIntObject $3
* RecurrenceInHours $3
* RefreshCacheInput
* FileShareARN required FileShareARN$3
* RefreshCacheOutput
* FileShareARN FileShareARN$3
* RegionId $3
* RemoveTagsFromResourceInput : RemoveTagsFromResourceInput
* ResourceARN required ResourceARN
* TagKeys required TagKeys$3
* RemoveTagsFromResourceOutput object: RemoveTagsFromResourceOutput
* ResourceARN ResourceARN$3
* ResetCacheInput object
* GatewayARN required GatewayARN$3
* ResetCacheOutput
* GatewayARN GatewayARN$3
* ResourceARN $3
* RetrieveTapeArchiveInput : RetrieveTapeArchiveInput
* GatewayARN required GatewayARN
* TapeARN required TapeARN$3
* RetrieveTapeArchiveOutput object: RetrieveTapeArchiveOutput
* TapeARN TapeARN$3
* RetrieveTapeRecoveryPointInput object: RetrieveTapeRecoveryPointInput
* GatewayARN required GatewayARN
* TapeARN required TapeARN$3
* RetrieveTapeRecoveryPointOutput object: RetrieveTapeRecoveryPointOutput
* TapeARN TapeARN$3
* Role string: The ARN of the IAM role that file gateway assumes when it accesses the underlying storage. $3
* 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$3
* SetLocalConsolePasswordInput object: SetLocalConsolePasswordInput
* GatewayARN required GatewayARN
* LocalConsolePassword required LocalConsolePassword$3
* SetLocalConsolePasswordOutput object
* GatewayARN GatewayARN$3
* ShutdownGatewayInput : A JSON object containing the of the gateway to shut down.
* GatewayARN required GatewayARN$3
* ShutdownGatewayOutput object: A JSON object containing the of the gateway that was shut down.
* GatewayARN GatewayARN$3
* SnapshotDescription string$3
* SnapshotId $3
* Squash : 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.
$3
* StartGatewayInput object: A JSON object containing the of the gateway to start.
* GatewayARN required GatewayARN$3
* StartGatewayOutput object: A JSON object containing the of the gateway that was restarted.
* GatewayARN GatewayARN$3
* StorageClass string: $3
* 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$3
* 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$3
* StorediSCSIVolumes array
* items StorediSCSIVolume$3
* Tag
* Key required TagKey
* Value required TagValue$3
* TagKey $3
* TagKeys
* items TagKey$3
* TagValue $3
* Tags
* items Tag$3
* Tape : Describes a virtual tape object.
* Progress DoubleObject
* TapeARN TapeARN
* TapeBarcode TapeBarcode
* TapeCreatedDate Time
* TapeSizeInBytes TapeSize
* TapeStatus TapeStatus
* TapeUsedInBytes TapeUsage
* VTLDevice VTLDeviceARN$3
* TapeARN string$3
* TapeARNs : 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$3
* 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$3
* TapeArchiveStatus string$3
* TapeArchives
* items TapeArchive$3
* TapeBarcode $3
* TapeBarcodePrefix $3
* TapeDriveType $3
* TapeInfo : Describes a virtual tape.
* GatewayARN GatewayARN
* TapeARN TapeARN
* TapeBarcode TapeBarcode
* TapeSizeInBytes TapeSize
* TapeStatus TapeStatus$3
* 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$3
* TapeRecoveryPointInfo object: Describes a recovery point.
* TapeARN TapeARN
* TapeRecoveryPointTime Time
* TapeSizeInBytes TapeSize
* TapeStatus TapeRecoveryPointStatus$3
* TapeRecoveryPointInfos array
* items TapeRecoveryPointInfo$3
* TapeRecoveryPointStatus $3
* TapeSize $3
* TapeStatus $3
* TapeUsage $3
* Tapes
* items Tape$3
* TargetARN $3
* TargetName $3
* Time $3
* UpdateBandwidthRateLimitInput A JSON object conta