storagegateway-2013-06-30.examples.json 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381
  1. {
  2. "version": "1.0",
  3. "examples": {
  4. "ActivateGateway": [
  5. {
  6. "input": {
  7. "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
  8. "GatewayName": "My_Gateway",
  9. "GatewayRegion": "us-east-1",
  10. "GatewayTimezone": "GMT-12:00",
  11. "GatewayType": "STORED",
  12. "MediumChangerType": "AWS-Gateway-VTL",
  13. "TapeDriveType": "IBM-ULT3580-TD5"
  14. },
  15. "output": {
  16. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
  17. },
  18. "comments": {
  19. "input": {
  20. },
  21. "output": {
  22. }
  23. },
  24. "description": "Activates the gateway you previously deployed on your host.",
  25. "id": "to-activate-the-gateway-1471281611207",
  26. "title": "To activate the gateway"
  27. }
  28. ],
  29. "AddCache": [
  30. {
  31. "input": {
  32. "DiskIds": [
  33. "pci-0000:03:00.0-scsi-0:0:0:0",
  34. "pci-0000:03:00.0-scsi-0:0:1:0"
  35. ],
  36. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  37. },
  38. "output": {
  39. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  40. },
  41. "comments": {
  42. "input": {
  43. },
  44. "output": {
  45. }
  46. },
  47. "description": "The following example shows a request that activates a gateway-stored volume.",
  48. "id": "to-add-a-cache-1471043606854",
  49. "title": "To add a cache"
  50. }
  51. ],
  52. "AddTagsToResource": [
  53. {
  54. "input": {
  55. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
  56. "Tags": [
  57. {
  58. "Key": "Dev Gatgeway Region",
  59. "Value": "East Coast"
  60. }
  61. ]
  62. },
  63. "output": {
  64. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
  65. },
  66. "comments": {
  67. "input": {
  68. },
  69. "output": {
  70. }
  71. },
  72. "description": "Adds one or more tags to the specified resource.",
  73. "id": "to-add-tags-to-resource-1471283689460",
  74. "title": "To add tags to resource"
  75. }
  76. ],
  77. "AddUploadBuffer": [
  78. {
  79. "input": {
  80. "DiskIds": [
  81. "pci-0000:03:00.0-scsi-0:0:0:0",
  82. "pci-0000:03:00.0-scsi-0:0:1:0"
  83. ],
  84. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  85. },
  86. "output": {
  87. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  88. },
  89. "comments": {
  90. "input": {
  91. },
  92. "output": {
  93. }
  94. },
  95. "description": "Configures one or more gateway local disks as upload buffer for a specified gateway.",
  96. "id": "to-add-upload-buffer-on-local-disk-1471293902847",
  97. "title": "To add upload buffer on local disk"
  98. }
  99. ],
  100. "AddWorkingStorage": [
  101. {
  102. "input": {
  103. "DiskIds": [
  104. "pci-0000:03:00.0-scsi-0:0:0:0",
  105. "pci-0000:03:00.0-scsi-0:0:1:0"
  106. ],
  107. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  108. },
  109. "output": {
  110. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  111. },
  112. "comments": {
  113. "input": {
  114. },
  115. "output": {
  116. }
  117. },
  118. "description": "Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)",
  119. "id": "to-add-storage-on-local-disk-1471294305401",
  120. "title": "To add storage on local disk"
  121. }
  122. ],
  123. "CancelArchival": [
  124. {
  125. "input": {
  126. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  127. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  128. },
  129. "output": {
  130. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  131. },
  132. "comments": {
  133. "input": {
  134. },
  135. "output": {
  136. }
  137. },
  138. "description": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.",
  139. "id": "to-cancel-virtual-tape-archiving-1471294865203",
  140. "title": "To cancel virtual tape archiving"
  141. }
  142. ],
  143. "CancelRetrieval": [
  144. {
  145. "input": {
  146. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  147. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  148. },
  149. "output": {
  150. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  151. },
  152. "comments": {
  153. "input": {
  154. },
  155. "output": {
  156. }
  157. },
  158. "description": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.",
  159. "id": "to-cancel-virtual-tape-retrieval-1471295704491",
  160. "title": "To cancel virtual tape retrieval"
  161. }
  162. ],
  163. "CreateCachediSCSIVolume": [
  164. {
  165. "input": {
  166. "ClientToken": "cachedvol112233",
  167. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  168. "NetworkInterfaceId": "10.1.1.1",
  169. "SnapshotId": "snap-f47b7b94",
  170. "TargetName": "my-volume",
  171. "VolumeSizeInBytes": 536870912000
  172. },
  173. "output": {
  174. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
  175. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  176. },
  177. "comments": {
  178. "input": {
  179. },
  180. "output": {
  181. }
  182. },
  183. "description": "Creates a cached volume on a specified cached gateway.",
  184. "id": "to-create-a-cached-iscsi-volume-1471296661787",
  185. "title": "To create a cached iSCSI volume"
  186. }
  187. ],
  188. "CreateSnapshot": [
  189. {
  190. "input": {
  191. "SnapshotDescription": "My root volume snapshot as of 10/03/2017",
  192. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  193. },
  194. "output": {
  195. "SnapshotId": "snap-78e22663",
  196. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  197. },
  198. "comments": {
  199. "input": {
  200. },
  201. "output": {
  202. }
  203. },
  204. "description": "Initiates an ad-hoc snapshot of a gateway volume.",
  205. "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561",
  206. "title": "To create a snapshot of a gateway volume"
  207. }
  208. ],
  209. "CreateSnapshotFromVolumeRecoveryPoint": [
  210. {
  211. "input": {
  212. "SnapshotDescription": "My root volume snapshot as of 2017-06-30T10:10:10.000Z",
  213. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  214. },
  215. "output": {
  216. "SnapshotId": "snap-78e22663",
  217. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  218. "VolumeRecoveryPointTime": "2017-06-30T10:10:10.000Z"
  219. },
  220. "comments": {
  221. "input": {
  222. },
  223. "output": {
  224. }
  225. },
  226. "description": "Initiates a snapshot of a gateway from a volume recovery point.",
  227. "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561",
  228. "title": "To create a snapshot of a gateway volume"
  229. }
  230. ],
  231. "CreateStorediSCSIVolume": [
  232. {
  233. "input": {
  234. "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
  235. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  236. "NetworkInterfaceId": "10.1.1.1",
  237. "PreserveExistingData": true,
  238. "SnapshotId": "snap-f47b7b94",
  239. "TargetName": "my-volume"
  240. },
  241. "output": {
  242. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
  243. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  244. "VolumeSizeInBytes": 1099511627776
  245. },
  246. "comments": {
  247. "input": {
  248. },
  249. "output": {
  250. }
  251. },
  252. "description": "Creates a stored volume on a specified stored gateway.",
  253. "id": "to-create-a-stored-iscsi-volume-1471367662813",
  254. "title": "To create a stored iSCSI volume"
  255. }
  256. ],
  257. "CreateTapeWithBarcode": [
  258. {
  259. "input": {
  260. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  261. "TapeBarcode": "TEST12345",
  262. "TapeSizeInBytes": 107374182400
  263. },
  264. "output": {
  265. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
  266. },
  267. "comments": {
  268. "input": {
  269. },
  270. "output": {
  271. }
  272. },
  273. "description": "Creates a virtual tape by using your own barcode.",
  274. "id": "to-create-a-virtual-tape-using-a-barcode-1471371842452",
  275. "title": "To create a virtual tape using a barcode"
  276. }
  277. ],
  278. "CreateTapes": [
  279. {
  280. "input": {
  281. "ClientToken": "77777",
  282. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  283. "NumTapesToCreate": 3,
  284. "TapeBarcodePrefix": "TEST",
  285. "TapeSizeInBytes": 107374182400
  286. },
  287. "output": {
  288. "TapeARNs": [
  289. "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D",
  290. "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F",
  291. "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E"
  292. ]
  293. },
  294. "comments": {
  295. "input": {
  296. },
  297. "output": {
  298. }
  299. },
  300. "description": "Creates one or more virtual tapes.",
  301. "id": "to-create-a-virtual-tape-1471372061659",
  302. "title": "To create a virtual tape"
  303. }
  304. ],
  305. "DeleteBandwidthRateLimit": [
  306. {
  307. "input": {
  308. "BandwidthType": "All",
  309. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  310. },
  311. "output": {
  312. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  313. },
  314. "comments": {
  315. "input": {
  316. },
  317. "output": {
  318. }
  319. },
  320. "description": "Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.",
  321. "id": "to-delete-bandwidth-rate-limits-of-gateway-1471373225520",
  322. "title": "To delete bandwidth rate limits of gateway"
  323. }
  324. ],
  325. "DeleteChapCredentials": [
  326. {
  327. "input": {
  328. "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  329. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  330. },
  331. "output": {
  332. "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  333. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  334. },
  335. "comments": {
  336. "input": {
  337. },
  338. "output": {
  339. }
  340. },
  341. "description": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.",
  342. "id": "to-delete-chap-credentials-1471375025612",
  343. "title": "To delete CHAP credentials"
  344. }
  345. ],
  346. "DeleteGateway": [
  347. {
  348. "input": {
  349. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  350. },
  351. "output": {
  352. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  353. },
  354. "comments": {
  355. "input": {
  356. },
  357. "output": {
  358. }
  359. },
  360. "description": "This operation deletes the gateway, but not the gateway's VM from the host computer.",
  361. "id": "to-delete-a-gatgeway-1471381697333",
  362. "title": "To delete a gatgeway"
  363. }
  364. ],
  365. "DeleteSnapshotSchedule": [
  366. {
  367. "input": {
  368. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  369. },
  370. "output": {
  371. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  372. },
  373. "comments": {
  374. "input": {
  375. },
  376. "output": {
  377. }
  378. },
  379. "description": "This action enables you to delete a snapshot schedule for a volume.",
  380. "id": "to-delete-a-snapshot-of-a-volume-1471382234377",
  381. "title": "To delete a snapshot of a volume"
  382. }
  383. ],
  384. "DeleteTape": [
  385. {
  386. "input": {
  387. "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B",
  388. "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
  389. },
  390. "output": {
  391. "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
  392. },
  393. "comments": {
  394. "input": {
  395. },
  396. "output": {
  397. }
  398. },
  399. "description": "This example deletes the specified virtual tape.",
  400. "id": "to-delete-a-virtual-tape-1471382444157",
  401. "title": "To delete a virtual tape"
  402. }
  403. ],
  404. "DeleteTapeArchive": [
  405. {
  406. "input": {
  407. "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
  408. },
  409. "output": {
  410. "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
  411. },
  412. "comments": {
  413. "input": {
  414. },
  415. "output": {
  416. }
  417. },
  418. "description": "Deletes the specified virtual tape from the virtual tape shelf (VTS).",
  419. "id": "to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329",
  420. "title": "To delete a virtual tape from the shelf (VTS)"
  421. }
  422. ],
  423. "DeleteVolume": [
  424. {
  425. "input": {
  426. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  427. },
  428. "output": {
  429. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  430. },
  431. "comments": {
  432. "input": {
  433. },
  434. "output": {
  435. }
  436. },
  437. "description": "Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.",
  438. "id": "to-delete-a-gateway-volume-1471384418416",
  439. "title": "To delete a gateway volume"
  440. }
  441. ],
  442. "DescribeBandwidthRateLimit": [
  443. {
  444. "input": {
  445. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  446. },
  447. "output": {
  448. "AverageDownloadRateLimitInBitsPerSec": 204800,
  449. "AverageUploadRateLimitInBitsPerSec": 102400,
  450. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  451. },
  452. "comments": {
  453. "input": {
  454. },
  455. "output": {
  456. }
  457. },
  458. "description": "Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.",
  459. "id": "to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404",
  460. "title": "To describe the bandwidth rate limits of a gateway"
  461. }
  462. ],
  463. "DescribeCache": [
  464. {
  465. "input": {
  466. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  467. },
  468. "output": {
  469. "CacheAllocatedInBytes": 2199023255552,
  470. "CacheDirtyPercentage": 0.07,
  471. "CacheHitPercentage": 99.68,
  472. "CacheMissPercentage": 0.32,
  473. "CacheUsedPercentage": 0.07,
  474. "DiskIds": [
  475. "pci-0000:03:00.0-scsi-0:0:0:0",
  476. "pci-0000:04:00.0-scsi-0:1:0:0"
  477. ],
  478. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  479. },
  480. "comments": {
  481. "input": {
  482. },
  483. "output": {
  484. }
  485. },
  486. "description": "Returns information about the cache of a gateway.",
  487. "id": "to-describe-cache-information-1471385756036",
  488. "title": "To describe cache information"
  489. }
  490. ],
  491. "DescribeCachediSCSIVolumes": [
  492. {
  493. "input": {
  494. "VolumeARNs": [
  495. "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  496. ]
  497. },
  498. "output": {
  499. "CachediSCSIVolumes": [
  500. {
  501. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  502. "VolumeId": "vol-1122AABB",
  503. "VolumeSizeInBytes": 1099511627776,
  504. "VolumeStatus": "AVAILABLE",
  505. "VolumeType": "CACHED iSCSI",
  506. "VolumeiSCSIAttributes": {
  507. "ChapEnabled": true,
  508. "LunNumber": 1,
  509. "NetworkInterfaceId": "10.243.43.207",
  510. "NetworkInterfacePort": 3260,
  511. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  512. }
  513. }
  514. ]
  515. },
  516. "comments": {
  517. "input": {
  518. },
  519. "output": {
  520. }
  521. },
  522. "description": "Returns a description of the gateway cached iSCSI volumes specified in the request.",
  523. "id": "to-describe-gateway-cached-iscsi-volumes-1471458094649",
  524. "title": "To describe gateway cached iSCSI volumes"
  525. }
  526. ],
  527. "DescribeChapCredentials": [
  528. {
  529. "input": {
  530. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  531. },
  532. "output": {
  533. "ChapCredentials": [
  534. {
  535. "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  536. "SecretToAuthenticateInitiator": "111111111111",
  537. "SecretToAuthenticateTarget": "222222222222",
  538. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  539. }
  540. ]
  541. },
  542. "comments": {
  543. "input": {
  544. },
  545. "output": {
  546. }
  547. },
  548. "description": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.",
  549. "id": "to-describe-chap-credetnitals-for-an-iscsi-1471467462967",
  550. "title": "To describe CHAP credetnitals for an iSCSI"
  551. }
  552. ],
  553. "DescribeGatewayInformation": [
  554. {
  555. "input": {
  556. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  557. },
  558. "output": {
  559. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  560. "GatewayId": "sgw-AABB1122",
  561. "GatewayName": "My_Gateway",
  562. "GatewayNetworkInterfaces": [
  563. {
  564. "Ipv4Address": "10.35.69.216"
  565. }
  566. ],
  567. "GatewayState": "STATE_RUNNING",
  568. "GatewayTimezone": "GMT-8:00",
  569. "GatewayType": "STORED",
  570. "LastSoftwareUpdate": "2016-01-02T16:00:00",
  571. "NextUpdateAvailabilityDate": "2017-01-02T16:00:00"
  572. },
  573. "comments": {
  574. "input": {
  575. },
  576. "output": {
  577. }
  578. },
  579. "description": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).",
  580. "id": "to-describe-metadata-about-the-gateway-1471467849079",
  581. "title": "To describe metadata about the gateway"
  582. }
  583. ],
  584. "DescribeMaintenanceStartTime": [
  585. {
  586. "input": {
  587. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  588. },
  589. "output": {
  590. "DayOfWeek": 2,
  591. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  592. "HourOfDay": 15,
  593. "MinuteOfHour": 35,
  594. "Timezone": "GMT+7:00"
  595. },
  596. "comments": {
  597. "input": {
  598. },
  599. "output": {
  600. }
  601. },
  602. "description": "Returns your gateway's weekly maintenance start time including the day and time of the week.",
  603. "id": "to-describe-gateways-maintenance-start-time-1471470727387",
  604. "title": "To describe gateway's maintenance start time"
  605. }
  606. ],
  607. "DescribeSnapshotSchedule": [
  608. {
  609. "input": {
  610. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  611. },
  612. "output": {
  613. "Description": "sgw-AABB1122:vol-AABB1122:Schedule",
  614. "RecurrenceInHours": 24,
  615. "StartAt": 6,
  616. "Timezone": "GMT+7:00",
  617. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  618. },
  619. "comments": {
  620. "input": {
  621. },
  622. "output": {
  623. }
  624. },
  625. "description": "Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.",
  626. "id": "to-describe-snapshot-schedule-for-gateway-volume-1471471139538",
  627. "title": "To describe snapshot schedule for gateway volume"
  628. }
  629. ],
  630. "DescribeStorediSCSIVolumes": [
  631. {
  632. "input": {
  633. "VolumeARNs": [
  634. "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  635. ]
  636. },
  637. "output": {
  638. "StorediSCSIVolumes": [
  639. {
  640. "PreservedExistingData": false,
  641. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  642. "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
  643. "VolumeId": "vol-1122AABB",
  644. "VolumeProgress": 23.7,
  645. "VolumeSizeInBytes": 1099511627776,
  646. "VolumeStatus": "BOOTSTRAPPING",
  647. "VolumeiSCSIAttributes": {
  648. "ChapEnabled": true,
  649. "NetworkInterfaceId": "10.243.43.207",
  650. "NetworkInterfacePort": 3260,
  651. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  652. }
  653. }
  654. ]
  655. },
  656. "comments": {
  657. "input": {
  658. },
  659. "output": {
  660. }
  661. },
  662. "description": "Returns the description of the gateway volumes specified in the request belonging to the same gateway.",
  663. "id": "to-describe-the-volumes-of-a-gateway-1471472640660",
  664. "title": "To describe the volumes of a gateway"
  665. }
  666. ],
  667. "DescribeTapeArchives": [
  668. {
  669. "input": {
  670. "Limit": 123,
  671. "Marker": "1",
  672. "TapeARNs": [
  673. "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD",
  674. "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  675. ]
  676. },
  677. "output": {
  678. "Marker": "1",
  679. "TapeArchives": [
  680. {
  681. "CompletionTime": "2016-12-16T13:50Z",
  682. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD",
  683. "TapeBarcode": "AM08A1AD",
  684. "TapeSizeInBytes": 107374182400,
  685. "TapeStatus": "ARCHIVED"
  686. },
  687. {
  688. "CompletionTime": "2016-12-16T13:59Z",
  689. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
  690. "TapeBarcode": "AMZN01A2A4",
  691. "TapeSizeInBytes": 429496729600,
  692. "TapeStatus": "ARCHIVED"
  693. }
  694. ]
  695. },
  696. "comments": {
  697. "input": {
  698. },
  699. "output": {
  700. }
  701. },
  702. "description": "Returns a description of specified virtual tapes in the virtual tape shelf (VTS).",
  703. "id": "to-describe-virtual-tapes-in-the-vts-1471473188198",
  704. "title": "To describe virtual tapes in the VTS"
  705. }
  706. ],
  707. "DescribeTapeRecoveryPoints": [
  708. {
  709. "input": {
  710. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  711. "Limit": 1,
  712. "Marker": "1"
  713. },
  714. "output": {
  715. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  716. "Marker": "1",
  717. "TapeRecoveryPointInfos": [
  718. {
  719. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
  720. "TapeRecoveryPointTime": "2016-12-16T13:50Z",
  721. "TapeSizeInBytes": 1471550497,
  722. "TapeStatus": "AVAILABLE"
  723. }
  724. ]
  725. },
  726. "comments": {
  727. "input": {
  728. },
  729. "output": {
  730. }
  731. },
  732. "description": "Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.",
  733. "id": "to-describe-virtual-tape-recovery-points-1471542042026",
  734. "title": "To describe virtual tape recovery points"
  735. }
  736. ],
  737. "DescribeTapes": [
  738. {
  739. "input": {
  740. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  741. "Limit": 2,
  742. "Marker": "1",
  743. "TapeARNs": [
  744. "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
  745. "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0"
  746. ]
  747. },
  748. "output": {
  749. "Marker": "1",
  750. "Tapes": [
  751. {
  752. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
  753. "TapeBarcode": "TEST04A2A1",
  754. "TapeSizeInBytes": 107374182400,
  755. "TapeStatus": "AVAILABLE"
  756. },
  757. {
  758. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
  759. "TapeBarcode": "TEST05A2A0",
  760. "TapeSizeInBytes": 107374182400,
  761. "TapeStatus": "AVAILABLE"
  762. }
  763. ]
  764. },
  765. "comments": {
  766. "input": {
  767. },
  768. "output": {
  769. }
  770. },
  771. "description": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.",
  772. "id": "to-describe-virtual-tapes-associated-with-gateway-1471629287727",
  773. "title": "To describe virtual tape(s) associated with gateway"
  774. }
  775. ],
  776. "DescribeUploadBuffer": [
  777. {
  778. "input": {
  779. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  780. },
  781. "output": {
  782. "DiskIds": [
  783. "pci-0000:03:00.0-scsi-0:0:0:0",
  784. "pci-0000:04:00.0-scsi-0:1:0:0"
  785. ],
  786. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  787. "UploadBufferAllocatedInBytes": 0,
  788. "UploadBufferUsedInBytes": 161061273600
  789. },
  790. "comments": {
  791. "input": {
  792. },
  793. "output": {
  794. }
  795. },
  796. "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.",
  797. "id": "to-describe-upload-buffer-of-gateway-1471631099003",
  798. "title": "To describe upload buffer of gateway"
  799. },
  800. {
  801. "input": {
  802. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  803. },
  804. "output": {
  805. "DiskIds": [
  806. "pci-0000:03:00.0-scsi-0:0:0:0",
  807. "pci-0000:04:00.0-scsi-0:1:0:0"
  808. ],
  809. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  810. "UploadBufferAllocatedInBytes": 161061273600,
  811. "UploadBufferUsedInBytes": 0
  812. },
  813. "comments": {
  814. "input": {
  815. },
  816. "output": {
  817. }
  818. },
  819. "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.",
  820. "id": "to-describe-upload-buffer-of-a-gateway--1471904566370",
  821. "title": "To describe upload buffer of a gateway"
  822. }
  823. ],
  824. "DescribeVTLDevices": [
  825. {
  826. "input": {
  827. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  828. "Limit": 123,
  829. "Marker": "1",
  830. "VTLDeviceARNs": [
  831. ]
  832. },
  833. "output": {
  834. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  835. "Marker": "1",
  836. "VTLDevices": [
  837. {
  838. "DeviceiSCSIAttributes": {
  839. "ChapEnabled": false,
  840. "NetworkInterfaceId": "10.243.43.207",
  841. "NetworkInterfacePort": 3260,
  842. "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger"
  843. },
  844. "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
  845. "VTLDeviceProductIdentifier": "L700",
  846. "VTLDeviceType": "Medium Changer",
  847. "VTLDeviceVendor": "STK"
  848. },
  849. {
  850. "DeviceiSCSIAttributes": {
  851. "ChapEnabled": false,
  852. "NetworkInterfaceId": "10.243.43.209",
  853. "NetworkInterfacePort": 3260,
  854. "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01"
  855. },
  856. "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001",
  857. "VTLDeviceProductIdentifier": "ULT3580-TD5",
  858. "VTLDeviceType": "Tape Drive",
  859. "VTLDeviceVendor": "IBM"
  860. },
  861. {
  862. "DeviceiSCSIAttributes": {
  863. "ChapEnabled": false,
  864. "NetworkInterfaceId": "10.243.43.209",
  865. "NetworkInterfacePort": 3260,
  866. "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02"
  867. },
  868. "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002",
  869. "VTLDeviceProductIdentifier": "ULT3580-TD5",
  870. "VTLDeviceType": "Tape Drive",
  871. "VTLDeviceVendor": "IBM"
  872. }
  873. ]
  874. },
  875. "comments": {
  876. "input": {
  877. },
  878. "output": {
  879. }
  880. },
  881. "description": "Returns a description of virtual tape library (VTL) devices for the specified gateway.",
  882. "id": "to-describe-virtual-tape-library-vtl-devices-of-a-single-gateway-1471906071410",
  883. "title": "To describe virtual tape library (VTL) devices of a single gateway"
  884. }
  885. ],
  886. "DescribeWorkingStorage": [
  887. {
  888. "input": {
  889. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  890. },
  891. "output": {
  892. "DiskIds": [
  893. "pci-0000:03:00.0-scsi-0:0:0:0",
  894. "pci-0000:03:00.0-scsi-0:0:1:0"
  895. ],
  896. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  897. "WorkingStorageAllocatedInBytes": 2199023255552,
  898. "WorkingStorageUsedInBytes": 789207040
  899. },
  900. "comments": {
  901. "input": {
  902. },
  903. "output": {
  904. }
  905. },
  906. "description": "This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.",
  907. "id": "to-describe-the-working-storage-of-a-gateway-depreciated-1472070842332",
  908. "title": "To describe the working storage of a gateway [Depreciated]"
  909. }
  910. ],
  911. "DisableGateway": [
  912. {
  913. "input": {
  914. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  915. },
  916. "output": {
  917. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  918. },
  919. "comments": {
  920. "input": {
  921. },
  922. "output": {
  923. }
  924. },
  925. "description": "Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.",
  926. "id": "to-disable-a-gateway-when-it-is-no-longer-functioning-1472076046936",
  927. "title": "To disable a gateway when it is no longer functioning"
  928. }
  929. ],
  930. "ListGateways": [
  931. {
  932. "input": {
  933. "Limit": 2,
  934. "Marker": "1"
  935. },
  936. "output": {
  937. "Gateways": [
  938. {
  939. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  940. },
  941. {
  942. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C"
  943. }
  944. ],
  945. "Marker": "1"
  946. },
  947. "comments": {
  948. "input": {
  949. },
  950. "output": {
  951. }
  952. },
  953. "description": "Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.",
  954. "id": "to-lists-region-specific-gateways-per-aws-account-1472077860657",
  955. "title": "To lists region specific gateways per AWS account"
  956. }
  957. ],
  958. "ListLocalDisks": [
  959. {
  960. "input": {
  961. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  962. },
  963. "output": {
  964. "Disks": [
  965. {
  966. "DiskAllocationType": "CACHE_STORAGE",
  967. "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
  968. "DiskNode": "SCSI(0:0)",
  969. "DiskPath": "/dev/sda",
  970. "DiskSizeInBytes": 1099511627776,
  971. "DiskStatus": "missing"
  972. },
  973. {
  974. "DiskAllocationResource": "",
  975. "DiskAllocationType": "UPLOAD_BUFFER",
  976. "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0",
  977. "DiskNode": "SCSI(0:1)",
  978. "DiskPath": "/dev/sdb",
  979. "DiskSizeInBytes": 1099511627776,
  980. "DiskStatus": "present"
  981. }
  982. ],
  983. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  984. },
  985. "comments": {
  986. "input": {
  987. },
  988. "output": {
  989. }
  990. },
  991. "description": "The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all.",
  992. "id": "to-list-the-gateways-local-disks-1472079564618",
  993. "title": "To list the gateway's local disks"
  994. }
  995. ],
  996. "ListTagsForResource": [
  997. {
  998. "input": {
  999. "Limit": 1,
  1000. "Marker": "1",
  1001. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
  1002. },
  1003. "output": {
  1004. "Marker": "1",
  1005. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
  1006. "Tags": [
  1007. {
  1008. "Key": "Dev Gatgeway Region",
  1009. "Value": "East Coast"
  1010. }
  1011. ]
  1012. },
  1013. "comments": {
  1014. "input": {
  1015. },
  1016. "output": {
  1017. }
  1018. },
  1019. "description": "Lists the tags that have been added to the specified resource.",
  1020. "id": "to-list-tags-that-have-been-added-to-a-resource-1472080268972",
  1021. "title": "To list tags that have been added to a resource"
  1022. }
  1023. ],
  1024. "ListVolumeRecoveryPoints": [
  1025. {
  1026. "input": {
  1027. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1028. },
  1029. "output": {
  1030. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1031. "VolumeRecoveryPointInfos": [
  1032. {
  1033. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  1034. "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z",
  1035. "VolumeSizeInBytes": 536870912000
  1036. }
  1037. ]
  1038. },
  1039. "comments": {
  1040. "input": {
  1041. },
  1042. "output": {
  1043. }
  1044. },
  1045. "description": "Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.",
  1046. "id": "to-list-recovery-points-for-a-gateway-1472143015088",
  1047. "title": "To list recovery points for a gateway"
  1048. }
  1049. ],
  1050. "ListVolumes": [
  1051. {
  1052. "input": {
  1053. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1054. "Limit": 2,
  1055. "Marker": "1"
  1056. },
  1057. "output": {
  1058. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1059. "Marker": "1",
  1060. "VolumeInfos": [
  1061. {
  1062. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1063. "GatewayId": "sgw-12A3456B",
  1064. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
  1065. "VolumeId": "vol-1122AABB",
  1066. "VolumeSizeInBytes": 107374182400,
  1067. "VolumeType": "STORED"
  1068. },
  1069. {
  1070. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
  1071. "GatewayId": "sgw-gw-13B4567C",
  1072. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
  1073. "VolumeId": "vol-1122AABB",
  1074. "VolumeSizeInBytes": 107374182400,
  1075. "VolumeType": "STORED"
  1076. }
  1077. ]
  1078. },
  1079. "comments": {
  1080. "input": {
  1081. },
  1082. "output": {
  1083. }
  1084. },
  1085. "description": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.",
  1086. "id": "to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653",
  1087. "title": "To list the iSCSI stored volumes of a gateway"
  1088. }
  1089. ],
  1090. "RemoveTagsFromResource": [
  1091. {
  1092. "input": {
  1093. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
  1094. "TagKeys": [
  1095. "Dev Gatgeway Region",
  1096. "East Coast"
  1097. ]
  1098. },
  1099. "output": {
  1100. "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
  1101. },
  1102. "comments": {
  1103. "input": {
  1104. },
  1105. "output": {
  1106. }
  1107. },
  1108. "description": "Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.",
  1109. "id": "to-remove-tags-from-a-resource-1472147210553",
  1110. "title": "To remove tags from a resource"
  1111. }
  1112. ],
  1113. "ResetCache": [
  1114. {
  1115. "input": {
  1116. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
  1117. },
  1118. "output": {
  1119. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
  1120. },
  1121. "comments": {
  1122. "input": {
  1123. },
  1124. "output": {
  1125. }
  1126. },
  1127. "description": "Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.",
  1128. "id": "to-reset-cache-disks-in-error-status-1472148909807",
  1129. "title": "To reset cache disks in error status"
  1130. }
  1131. ],
  1132. "RetrieveTapeArchive": [
  1133. {
  1134. "input": {
  1135. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  1136. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
  1137. },
  1138. "output": {
  1139. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
  1140. },
  1141. "comments": {
  1142. "input": {
  1143. },
  1144. "output": {
  1145. }
  1146. },
  1147. "description": "Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.",
  1148. "id": "to-retrieve-an-archived-tape-from-the-vts-1472149812358",
  1149. "title": "To retrieve an archived tape from the VTS"
  1150. }
  1151. ],
  1152. "RetrieveTapeRecoveryPoint": [
  1153. {
  1154. "input": {
  1155. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  1156. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
  1157. },
  1158. "output": {
  1159. "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
  1160. },
  1161. "comments": {
  1162. "input": {
  1163. },
  1164. "output": {
  1165. }
  1166. },
  1167. "description": "Retrieves the recovery point for the specified virtual tape.",
  1168. "id": "to-retrieve-the-recovery-point-of-a-virtual-tape-1472150014805",
  1169. "title": "To retrieve the recovery point of a virtual tape"
  1170. }
  1171. ],
  1172. "SetLocalConsolePassword": [
  1173. {
  1174. "input": {
  1175. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  1176. "LocalConsolePassword": "PassWordMustBeAtLeast6Chars."
  1177. },
  1178. "output": {
  1179. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
  1180. },
  1181. "comments": {
  1182. "input": {
  1183. },
  1184. "output": {
  1185. }
  1186. },
  1187. "description": "Sets the password for your VM local console.",
  1188. "id": "to-set-a-password-for-your-vm-1472150202632",
  1189. "title": "To set a password for your VM"
  1190. }
  1191. ],
  1192. "ShutdownGateway": [
  1193. {
  1194. "input": {
  1195. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
  1196. },
  1197. "output": {
  1198. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
  1199. },
  1200. "comments": {
  1201. "input": {
  1202. },
  1203. "output": {
  1204. }
  1205. },
  1206. "description": "This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.",
  1207. "id": "to-shut-down-a-gateway-service-1472150508835",
  1208. "title": "To shut down a gateway service"
  1209. }
  1210. ],
  1211. "StartGateway": [
  1212. {
  1213. "input": {
  1214. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
  1215. },
  1216. "output": {
  1217. "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
  1218. },
  1219. "comments": {
  1220. "input": {
  1221. },
  1222. "output": {
  1223. }
  1224. },
  1225. "description": "Starts a gateway service that was previously shut down.",
  1226. "id": "to-start-a-gateway-service-1472150722315",
  1227. "title": "To start a gateway service"
  1228. }
  1229. ],
  1230. "UpdateBandwidthRateLimit": [
  1231. {
  1232. "input": {
  1233. "AverageDownloadRateLimitInBitsPerSec": 102400,
  1234. "AverageUploadRateLimitInBitsPerSec": 51200,
  1235. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1236. },
  1237. "output": {
  1238. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1239. },
  1240. "comments": {
  1241. "input": {
  1242. },
  1243. "output": {
  1244. }
  1245. },
  1246. "description": "Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.",
  1247. "id": "to-update-the-bandwidth-rate-limits-of-a-gateway-1472151016202",
  1248. "title": "To update the bandwidth rate limits of a gateway"
  1249. }
  1250. ],
  1251. "UpdateChapCredentials": [
  1252. {
  1253. "input": {
  1254. "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  1255. "SecretToAuthenticateInitiator": "111111111111",
  1256. "SecretToAuthenticateTarget": "222222222222",
  1257. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  1258. },
  1259. "output": {
  1260. "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  1261. "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
  1262. },
  1263. "comments": {
  1264. "input": {
  1265. },
  1266. "output": {
  1267. }
  1268. },
  1269. "description": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.",
  1270. "id": "to-update-chap-credentials-for-an-iscsi-target-1472151325795",
  1271. "title": "To update CHAP credentials for an iSCSI target"
  1272. }
  1273. ],
  1274. "UpdateGatewayInformation": [
  1275. {
  1276. "input": {
  1277. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1278. "GatewayName": "MyGateway2",
  1279. "GatewayTimezone": "GMT-12:00"
  1280. },
  1281. "output": {
  1282. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1283. "GatewayName": ""
  1284. },
  1285. "comments": {
  1286. "input": {
  1287. },
  1288. "output": {
  1289. }
  1290. },
  1291. "description": "Updates a gateway's metadata, which includes the gateway's name and time zone.",
  1292. "id": "to-update-a-gateways-metadata-1472151688693",
  1293. "title": "To update a gateway's metadata"
  1294. }
  1295. ],
  1296. "UpdateGatewaySoftwareNow": [
  1297. {
  1298. "input": {
  1299. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1300. },
  1301. "output": {
  1302. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1303. },
  1304. "comments": {
  1305. "input": {
  1306. },
  1307. "output": {
  1308. }
  1309. },
  1310. "description": "Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.",
  1311. "id": "to-update-a-gateways-vm-software-1472152020929",
  1312. "title": "To update a gateway's VM software"
  1313. }
  1314. ],
  1315. "UpdateMaintenanceStartTime": [
  1316. {
  1317. "input": {
  1318. "DayOfWeek": 2,
  1319. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  1320. "HourOfDay": 0,
  1321. "MinuteOfHour": 30
  1322. },
  1323. "output": {
  1324. "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
  1325. },
  1326. "comments": {
  1327. "input": {
  1328. },
  1329. "output": {
  1330. }
  1331. },
  1332. "description": "Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.",
  1333. "id": "to-update-a-gateways-maintenance-start-time-1472152552031",
  1334. "title": "To update a gateway's maintenance start time"
  1335. }
  1336. ],
  1337. "UpdateSnapshotSchedule": [
  1338. {
  1339. "input": {
  1340. "Description": "Hourly snapshot",
  1341. "RecurrenceInHours": 1,
  1342. "StartAt": 0,
  1343. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  1344. },
  1345. "output": {
  1346. "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  1347. },
  1348. "comments": {
  1349. "input": {
  1350. },
  1351. "output": {
  1352. }
  1353. },
  1354. "description": "Updates a snapshot schedule configured for a gateway volume.",
  1355. "id": "to-update-a-volume-snapshot-schedule-1472152757068",
  1356. "title": "To update a volume snapshot schedule"
  1357. }
  1358. ],
  1359. "UpdateVTLDeviceType": [
  1360. {
  1361. "input": {
  1362. "DeviceType": "Medium Changer",
  1363. "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001"
  1364. },
  1365. "output": {
  1366. "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001"
  1367. },
  1368. "comments": {
  1369. "input": {
  1370. },
  1371. "output": {
  1372. }
  1373. },
  1374. "description": "Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.",
  1375. "id": "to-update-a-vtl-device-type-1472153012967",
  1376. "title": "To update a VTL device type"
  1377. }
  1378. ]
  1379. }
  1380. }