{ "metadata": { "apiVersion": "2013-06-30", "endpointPrefix": "storagegateway", "jsonVersion": "1.1", "serviceFullName": "AWS Storage Gateway", "signatureVersion": "v4", "targetPrefix": "StorageGateway_20130630", "protocol": "json" }, "operations": { "ActivateGateway": { "input": { "type": "structure", "required": [ "ActivationKey", "GatewayName", "GatewayTimezone", "GatewayRegion" ], "members": { "ActivationKey": {}, "GatewayName": {}, "GatewayTimezone": {}, "GatewayRegion": {}, "GatewayType": {}, "TapeDriveType": {}, "MediumChangerType": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "AddCache": { "input": { "type": "structure", "required": [ "GatewayARN", "DiskIds" ], "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" } } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "AddUploadBuffer": { "input": { "type": "structure", "required": [ "GatewayARN", "DiskIds" ], "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" } } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "AddWorkingStorage": { "input": { "type": "structure", "required": [ "GatewayARN", "DiskIds" ], "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" } } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "CancelArchival": { "input": { "type": "structure", "required": [ "GatewayARN", "TapeARN" ], "members": { "GatewayARN": {}, "TapeARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "CancelRetrieval": { "input": { "type": "structure", "required": [ "GatewayARN", "TapeARN" ], "members": { "GatewayARN": {}, "TapeARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "CreateCachediSCSIVolume": { "input": { "type": "structure", "required": [ "GatewayARN", "VolumeSizeInBytes", "TargetName", "NetworkInterfaceId", "ClientToken" ], "members": { "GatewayARN": {}, "VolumeSizeInBytes": { "type": "long" }, "SnapshotId": {}, "TargetName": {}, "NetworkInterfaceId": {}, "ClientToken": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {}, "TargetARN": {} } } }, "CreateSnapshot": { "input": { "type": "structure", "required": [ "VolumeARN", "SnapshotDescription" ], "members": { "VolumeARN": {}, "SnapshotDescription": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {}, "SnapshotId": {} } } }, "CreateSnapshotFromVolumeRecoveryPoint": { "input": { "type": "structure", "required": [ "VolumeARN", "SnapshotDescription" ], "members": { "VolumeARN": {}, "SnapshotDescription": {} } }, "output": { "type": "structure", "members": { "SnapshotId": {}, "VolumeARN": {}, "VolumeRecoveryPointTime": {} } } }, "CreateStorediSCSIVolume": { "input": { "type": "structure", "required": [ "GatewayARN", "DiskId", "PreserveExistingData", "TargetName", "NetworkInterfaceId" ], "members": { "GatewayARN": {}, "DiskId": {}, "SnapshotId": {}, "PreserveExistingData": { "type": "boolean" }, "TargetName": {}, "NetworkInterfaceId": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {}, "VolumeSizeInBytes": { "type": "long" }, "TargetARN": {} } } }, "CreateTapes": { "input": { "type": "structure", "required": [ "GatewayARN", "TapeSizeInBytes", "ClientToken", "NumTapesToCreate", "TapeBarcodePrefix" ], "members": { "GatewayARN": {}, "TapeSizeInBytes": { "type": "long" }, "ClientToken": {}, "NumTapesToCreate": { "type": "integer" }, "TapeBarcodePrefix": {} } }, "output": { "type": "structure", "members": { "TapeARNs": { "shape": "S1b" } } } }, "DeleteBandwidthRateLimit": { "input": { "type": "structure", "required": [ "GatewayARN", "BandwidthType" ], "members": { "GatewayARN": {}, "BandwidthType": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "DeleteChapCredentials": { "input": { "type": "structure", "required": [ "TargetARN", "InitiatorName" ], "members": { "TargetARN": {}, "InitiatorName": {} } }, "output": { "type": "structure", "members": { "TargetARN": {}, "InitiatorName": {} } } }, "DeleteGateway": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "DeleteSnapshotSchedule": { "input": { "type": "structure", "required": [ "VolumeARN" ], "members": { "VolumeARN": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {} } } }, "DeleteTape": { "input": { "type": "structure", "required": [ "GatewayARN", "TapeARN" ], "members": { "GatewayARN": {}, "TapeARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "DeleteTapeArchive": { "input": { "type": "structure", "required": [ "TapeARN" ], "members": { "TapeARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "DeleteVolume": { "input": { "type": "structure", "required": [ "VolumeARN" ], "members": { "VolumeARN": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {} } } }, "DescribeBandwidthRateLimit": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "AverageUploadRateLimitInBitsPerSec": { "type": "long" }, "AverageDownloadRateLimitInBitsPerSec": { "type": "long" } } } }, "DescribeCache": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" }, "CacheAllocatedInBytes": { "type": "long" }, "CacheUsedPercentage": { "type": "double" }, "CacheDirtyPercentage": { "type": "double" }, "CacheHitPercentage": { "type": "double" }, "CacheMissPercentage": { "type": "double" } } } }, "DescribeCachediSCSIVolumes": { "input": { "type": "structure", "required": [ "VolumeARNs" ], "members": { "VolumeARNs": { "shape": "S20" } } }, "output": { "type": "structure", "members": { "CachediSCSIVolumes": { "type": "list", "member": { "type": "structure", "members": { "VolumeARN": {}, "VolumeId": {}, "VolumeType": {}, "VolumeStatus": {}, "VolumeSizeInBytes": { "type": "long" }, "VolumeProgress": { "type": "double" }, "SourceSnapshotId": {}, "VolumeiSCSIAttributes": { "shape": "S28" } } } } } } }, "DescribeChapCredentials": { "input": { "type": "structure", "required": [ "TargetARN" ], "members": { "TargetARN": {} } }, "output": { "type": "structure", "members": { "ChapCredentials": { "type": "list", "member": { "type": "structure", "members": { "TargetARN": {}, "SecretToAuthenticateInitiator": {}, "InitiatorName": {}, "SecretToAuthenticateTarget": {} } } } } } }, "DescribeGatewayInformation": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "GatewayId": {}, "GatewayTimezone": {}, "GatewayState": {}, "GatewayNetworkInterfaces": { "type": "list", "member": { "type": "structure", "members": { "Ipv4Address": {}, "MacAddress": {}, "Ipv6Address": {} } } }, "GatewayType": {}, "NextUpdateAvailabilityDate": {} } } }, "DescribeMaintenanceStartTime": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "HourOfDay": { "type": "integer" }, "MinuteOfHour": { "type": "integer" }, "DayOfWeek": { "type": "integer" }, "Timezone": {} } } }, "DescribeSnapshotSchedule": { "input": { "type": "structure", "required": [ "VolumeARN" ], "members": { "VolumeARN": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {}, "StartAt": { "type": "integer" }, "RecurrenceInHours": { "type": "integer" }, "Description": {}, "Timezone": {} } } }, "DescribeStorediSCSIVolumes": { "input": { "type": "structure", "required": [ "VolumeARNs" ], "members": { "VolumeARNs": { "shape": "S20" } } }, "output": { "type": "structure", "members": { "StorediSCSIVolumes": { "type": "list", "member": { "type": "structure", "members": { "VolumeARN": {}, "VolumeId": {}, "VolumeType": {}, "VolumeStatus": {}, "VolumeSizeInBytes": { "type": "long" }, "VolumeProgress": { "type": "double" }, "VolumeDiskId": {}, "SourceSnapshotId": {}, "PreservedExistingData": { "type": "boolean" }, "VolumeiSCSIAttributes": { "shape": "S28" } } } } } } }, "DescribeTapeArchives": { "input": { "type": "structure", "members": { "TapeARNs": { "shape": "S1b" }, "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "TapeArchives": { "type": "list", "member": { "type": "structure", "members": { "TapeARN": {}, "TapeBarcode": {}, "TapeSizeInBytes": { "type": "long" }, "CompletionTime": { "type": "timestamp" }, "RetrievedTo": {}, "TapeStatus": {} } } }, "Marker": {} } } }, "DescribeTapeRecoveryPoints": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "TapeRecoveryPointInfos": { "type": "list", "member": { "type": "structure", "members": { "TapeARN": {}, "TapeRecoveryPointTime": { "type": "timestamp" }, "TapeSizeInBytes": { "type": "long" }, "TapeStatus": {} } } }, "Marker": {} } } }, "DescribeTapes": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "TapeARNs": { "shape": "S1b" }, "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "Tapes": { "type": "list", "member": { "type": "structure", "members": { "TapeARN": {}, "TapeBarcode": {}, "TapeSizeInBytes": { "type": "long" }, "TapeStatus": {}, "VTLDevice": {}, "Progress": { "type": "double" } } } }, "Marker": {} } } }, "DescribeUploadBuffer": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" }, "UploadBufferUsedInBytes": { "type": "long" }, "UploadBufferAllocatedInBytes": { "type": "long" } } } }, "DescribeVTLDevices": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "VTLDeviceARNs": { "type": "list", "member": {} }, "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "VTLDevices": { "type": "list", "member": { "type": "structure", "members": { "VTLDeviceARN": {}, "VTLDeviceType": {}, "VTLDeviceVendor": {}, "VTLDeviceProductIdentifier": {}, "DeviceiSCSIAttributes": { "type": "structure", "members": { "TargetARN": {}, "NetworkInterfaceId": {}, "NetworkInterfacePort": { "type": "integer" }, "ChapEnabled": { "type": "boolean" } } } } } }, "Marker": {} } } }, "DescribeWorkingStorage": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "DiskIds": { "shape": "Sc" }, "WorkingStorageUsedInBytes": { "type": "long" }, "WorkingStorageAllocatedInBytes": { "type": "long" } } } }, "DisableGateway": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "ListGateways": { "input": { "type": "structure", "members": { "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "Gateways": { "type": "list", "member": { "type": "structure", "members": { "GatewayARN": {}, "GatewayType": {}, "GatewayOperationalState": {} } } }, "Marker": {} } } }, "ListLocalDisks": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "Disks": { "type": "list", "member": { "type": "structure", "members": { "DiskId": {}, "DiskPath": {}, "DiskNode": {}, "DiskSizeInBytes": { "type": "long" }, "DiskAllocationType": {}, "DiskAllocationResource": {} } } } } } }, "ListVolumeRecoveryPoints": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "VolumeRecoveryPointInfos": { "type": "list", "member": { "type": "structure", "members": { "VolumeARN": {}, "VolumeSizeInBytes": { "type": "long" }, "VolumeUsageInBytes": { "type": "long" }, "VolumeRecoveryPointTime": {} } } } } } }, "ListVolumes": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "Marker": {}, "Limit": { "type": "integer" } } }, "output": { "type": "structure", "members": { "GatewayARN": {}, "Marker": {}, "VolumeInfos": { "type": "list", "member": { "type": "structure", "members": { "VolumeARN": {}, "VolumeType": {} } } } } } }, "RetrieveTapeArchive": { "input": { "type": "structure", "required": [ "TapeARN", "GatewayARN" ], "members": { "TapeARN": {}, "GatewayARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "RetrieveTapeRecoveryPoint": { "input": { "type": "structure", "required": [ "TapeARN", "GatewayARN" ], "members": { "TapeARN": {}, "GatewayARN": {} } }, "output": { "type": "structure", "members": { "TapeARN": {} } } }, "ShutdownGateway": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "StartGateway": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "UpdateBandwidthRateLimit": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "AverageUploadRateLimitInBitsPerSec": { "type": "long" }, "AverageDownloadRateLimitInBitsPerSec": { "type": "long" } } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "UpdateChapCredentials": { "input": { "type": "structure", "required": [ "TargetARN", "SecretToAuthenticateInitiator", "InitiatorName" ], "members": { "TargetARN": {}, "SecretToAuthenticateInitiator": {}, "InitiatorName": {}, "SecretToAuthenticateTarget": {} } }, "output": { "type": "structure", "members": { "TargetARN": {}, "InitiatorName": {} } } }, "UpdateGatewayInformation": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {}, "GatewayName": {}, "GatewayTimezone": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "UpdateGatewaySoftwareNow": { "input": { "type": "structure", "required": [ "GatewayARN" ], "members": { "GatewayARN": {} } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "UpdateMaintenanceStartTime": { "input": { "type": "structure", "required": [ "GatewayARN", "HourOfDay", "MinuteOfHour", "DayOfWeek" ], "members": { "GatewayARN": {}, "HourOfDay": { "type": "integer" }, "MinuteOfHour": { "type": "integer" }, "DayOfWeek": { "type": "integer" } } }, "output": { "type": "structure", "members": { "GatewayARN": {} } } }, "UpdateSnapshotSchedule": { "input": { "type": "structure", "required": [ "VolumeARN", "StartAt", "RecurrenceInHours" ], "members": { "VolumeARN": {}, "StartAt": { "type": "integer" }, "RecurrenceInHours": { "type": "integer" }, "Description": {} } }, "output": { "type": "structure", "members": { "VolumeARN": {} } } } }, "shapes": { "Sc": { "type": "list", "member": {} }, "S1b": { "type": "list", "member": {} }, "S20": { "type": "list", "member": {} }, "S28": { "type": "structure", "members": { "TargetARN": {}, "NetworkInterfaceId": {}, "NetworkInterfacePort": { "type": "integer" }, "LunNumber": { "type": "integer" }, "ChapEnabled": { "type": "boolean" } } } } }