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 }, 834 "output": { 835 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 836 "Marker": "1", 837 "VTLDevices": [ 838 { 839 "DeviceiSCSIAttributes": { 840 "ChapEnabled": false, 841 "NetworkInterfaceId": "10.243.43.207", 842 "NetworkInterfacePort": 3260, 843 "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger" 844 }, 845 "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", 846 "VTLDeviceProductIdentifier": "L700", 847 "VTLDeviceType": "Medium Changer", 848 "VTLDeviceVendor": "STK" 849 }, 850 { 851 "DeviceiSCSIAttributes": { 852 "ChapEnabled": false, 853 "NetworkInterfaceId": "10.243.43.209", 854 "NetworkInterfacePort": 3260, 855 "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01" 856 }, 857 "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", 858 "VTLDeviceProductIdentifier": "ULT3580-TD5", 859 "VTLDeviceType": "Tape Drive", 860 "VTLDeviceVendor": "IBM" 861 }, 862 { 863 "DeviceiSCSIAttributes": { 864 "ChapEnabled": false, 865 "NetworkInterfaceId": "10.243.43.209", 866 "NetworkInterfacePort": 3260, 867 "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02" 868 }, 869 "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", 870 "VTLDeviceProductIdentifier": "ULT3580-TD5", 871 "VTLDeviceType": "Tape Drive", 872 "VTLDeviceVendor": "IBM" 873 } 874 ] 875 }, 876 "comments": { 877 "input": { 878 }, 879 "output": { 880 } 881 }, 882 "description": "Returns a description of virtual tape library (VTL) devices for the specified gateway.", 883 "id": "to-describe-virtual-tape-library-vtl-devices-of-a-single-gateway-1471906071410", 884 "title": "To describe virtual tape library (VTL) devices of a single gateway" 885 } 886 ], 887 "DescribeWorkingStorage": [ 888 { 889 "input": { 890 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 891 }, 892 "output": { 893 "DiskIds": [ 894 "pci-0000:03:00.0-scsi-0:0:0:0", 895 "pci-0000:03:00.0-scsi-0:0:1:0" 896 ], 897 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 898 "WorkingStorageAllocatedInBytes": 2199023255552, 899 "WorkingStorageUsedInBytes": 789207040 900 }, 901 "comments": { 902 "input": { 903 }, 904 "output": { 905 } 906 }, 907 "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.", 908 "id": "to-describe-the-working-storage-of-a-gateway-depreciated-1472070842332", 909 "title": "To describe the working storage of a gateway [Depreciated]" 910 } 911 ], 912 "DisableGateway": [ 913 { 914 "input": { 915 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 916 }, 917 "output": { 918 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 919 }, 920 "comments": { 921 "input": { 922 }, 923 "output": { 924 } 925 }, 926 "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.", 927 "id": "to-disable-a-gateway-when-it-is-no-longer-functioning-1472076046936", 928 "title": "To disable a gateway when it is no longer functioning" 929 } 930 ], 931 "ListGateways": [ 932 { 933 "input": { 934 "Limit": 2, 935 "Marker": "1" 936 }, 937 "output": { 938 "Gateways": [ 939 { 940 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 941 }, 942 { 943 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C" 944 } 945 ], 946 "Marker": "1" 947 }, 948 "comments": { 949 "input": { 950 }, 951 "output": { 952 } 953 }, 954 "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.", 955 "id": "to-lists-region-specific-gateways-per-aws-account-1472077860657", 956 "title": "To lists region specific gateways per AWS account" 957 } 958 ], 959 "ListLocalDisks": [ 960 { 961 "input": { 962 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 963 }, 964 "output": { 965 "Disks": [ 966 { 967 "DiskAllocationType": "CACHE_STORAGE", 968 "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", 969 "DiskNode": "SCSI(0:0)", 970 "DiskPath": "/dev/sda", 971 "DiskSizeInBytes": 1099511627776, 972 "DiskStatus": "missing" 973 }, 974 { 975 "DiskAllocationResource": "", 976 "DiskAllocationType": "UPLOAD_BUFFER", 977 "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0", 978 "DiskNode": "SCSI(0:1)", 979 "DiskPath": "/dev/sdb", 980 "DiskSizeInBytes": 1099511627776, 981 "DiskStatus": "present" 982 } 983 ], 984 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 985 }, 986 "comments": { 987 "input": { 988 }, 989 "output": { 990 } 991 }, 992 "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.", 993 "id": "to-list-the-gateways-local-disks-1472079564618", 994 "title": "To list the gateway's local disks" 995 } 996 ], 997 "ListTagsForResource": [ 998 { 999 "input": { 1000 "Limit": 1, 1001 "Marker": "1", 1002 "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" 1003 }, 1004 "output": { 1005 "Marker": "1", 1006 "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", 1007 "Tags": [ 1008 { 1009 "Key": "Dev Gatgeway Region", 1010 "Value": "East Coast" 1011 } 1012 ] 1013 }, 1014 "comments": { 1015 "input": { 1016 }, 1017 "output": { 1018 } 1019 }, 1020 "description": "Lists the tags that have been added to the specified resource.", 1021 "id": "to-list-tags-that-have-been-added-to-a-resource-1472080268972", 1022 "title": "To list tags that have been added to a resource" 1023 } 1024 ], 1025 "ListVolumeRecoveryPoints": [ 1026 { 1027 "input": { 1028 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1029 }, 1030 "output": { 1031 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1032 "VolumeRecoveryPointInfos": [ 1033 { 1034 "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 1035 "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z", 1036 "VolumeSizeInBytes": 536870912000 1037 } 1038 ] 1039 }, 1040 "comments": { 1041 "input": { 1042 }, 1043 "output": { 1044 } 1045 }, 1046 "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.", 1047 "id": "to-list-recovery-points-for-a-gateway-1472143015088", 1048 "title": "To list recovery points for a gateway" 1049 } 1050 ], 1051 "ListVolumes": [ 1052 { 1053 "input": { 1054 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1055 "Limit": 2, 1056 "Marker": "1" 1057 }, 1058 "output": { 1059 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1060 "Marker": "1", 1061 "VolumeInfos": [ 1062 { 1063 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1064 "GatewayId": "sgw-12A3456B", 1065 "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 1066 "VolumeId": "vol-1122AABB", 1067 "VolumeSizeInBytes": 107374182400, 1068 "VolumeType": "STORED" 1069 }, 1070 { 1071 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C", 1072 "GatewayId": "sgw-gw-13B4567C", 1073 "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD", 1074 "VolumeId": "vol-1122AABB", 1075 "VolumeSizeInBytes": 107374182400, 1076 "VolumeType": "STORED" 1077 } 1078 ] 1079 }, 1080 "comments": { 1081 "input": { 1082 }, 1083 "output": { 1084 } 1085 }, 1086 "description": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.", 1087 "id": "to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653", 1088 "title": "To list the iSCSI stored volumes of a gateway" 1089 } 1090 ], 1091 "RemoveTagsFromResource": [ 1092 { 1093 "input": { 1094 "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", 1095 "TagKeys": [ 1096 "Dev Gatgeway Region", 1097 "East Coast" 1098 ] 1099 }, 1100 "output": { 1101 "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" 1102 }, 1103 "comments": { 1104 "input": { 1105 }, 1106 "output": { 1107 } 1108 }, 1109 "description": "Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.", 1110 "id": "to-remove-tags-from-a-resource-1472147210553", 1111 "title": "To remove tags from a resource" 1112 } 1113 ], 1114 "ResetCache": [ 1115 { 1116 "input": { 1117 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" 1118 }, 1119 "output": { 1120 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" 1121 }, 1122 "comments": { 1123 "input": { 1124 }, 1125 "output": { 1126 } 1127 }, 1128 "description": "Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.", 1129 "id": "to-reset-cache-disks-in-error-status-1472148909807", 1130 "title": "To reset cache disks in error status" 1131 } 1132 ], 1133 "RetrieveTapeArchive": [ 1134 { 1135 "input": { 1136 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 1137 "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" 1138 }, 1139 "output": { 1140 "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" 1141 }, 1142 "comments": { 1143 "input": { 1144 }, 1145 "output": { 1146 } 1147 }, 1148 "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.", 1149 "id": "to-retrieve-an-archived-tape-from-the-vts-1472149812358", 1150 "title": "To retrieve an archived tape from the VTS" 1151 } 1152 ], 1153 "RetrieveTapeRecoveryPoint": [ 1154 { 1155 "input": { 1156 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 1157 "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" 1158 }, 1159 "output": { 1160 "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" 1161 }, 1162 "comments": { 1163 "input": { 1164 }, 1165 "output": { 1166 } 1167 }, 1168 "description": "Retrieves the recovery point for the specified virtual tape.", 1169 "id": "to-retrieve-the-recovery-point-of-a-virtual-tape-1472150014805", 1170 "title": "To retrieve the recovery point of a virtual tape" 1171 } 1172 ], 1173 "SetLocalConsolePassword": [ 1174 { 1175 "input": { 1176 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 1177 "LocalConsolePassword": "PassWordMustBeAtLeast6Chars." 1178 }, 1179 "output": { 1180 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" 1181 }, 1182 "comments": { 1183 "input": { 1184 }, 1185 "output": { 1186 } 1187 }, 1188 "description": "Sets the password for your VM local console.", 1189 "id": "to-set-a-password-for-your-vm-1472150202632", 1190 "title": "To set a password for your VM" 1191 } 1192 ], 1193 "ShutdownGateway": [ 1194 { 1195 "input": { 1196 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" 1197 }, 1198 "output": { 1199 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" 1200 }, 1201 "comments": { 1202 "input": { 1203 }, 1204 "output": { 1205 } 1206 }, 1207 "description": "This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.", 1208 "id": "to-shut-down-a-gateway-service-1472150508835", 1209 "title": "To shut down a gateway service" 1210 } 1211 ], 1212 "StartGateway": [ 1213 { 1214 "input": { 1215 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" 1216 }, 1217 "output": { 1218 "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" 1219 }, 1220 "comments": { 1221 "input": { 1222 }, 1223 "output": { 1224 } 1225 }, 1226 "description": "Starts a gateway service that was previously shut down.", 1227 "id": "to-start-a-gateway-service-1472150722315", 1228 "title": "To start a gateway service" 1229 } 1230 ], 1231 "UpdateBandwidthRateLimit": [ 1232 { 1233 "input": { 1234 "AverageDownloadRateLimitInBitsPerSec": 102400, 1235 "AverageUploadRateLimitInBitsPerSec": 51200, 1236 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1237 }, 1238 "output": { 1239 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1240 }, 1241 "comments": { 1242 "input": { 1243 }, 1244 "output": { 1245 } 1246 }, 1247 "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.", 1248 "id": "to-update-the-bandwidth-rate-limits-of-a-gateway-1472151016202", 1249 "title": "To update the bandwidth rate limits of a gateway" 1250 } 1251 ], 1252 "UpdateChapCredentials": [ 1253 { 1254 "input": { 1255 "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", 1256 "SecretToAuthenticateInitiator": "111111111111", 1257 "SecretToAuthenticateTarget": "222222222222", 1258 "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" 1259 }, 1260 "output": { 1261 "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", 1262 "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" 1263 }, 1264 "comments": { 1265 "input": { 1266 }, 1267 "output": { 1268 } 1269 }, 1270 "description": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.", 1271 "id": "to-update-chap-credentials-for-an-iscsi-target-1472151325795", 1272 "title": "To update CHAP credentials for an iSCSI target" 1273 } 1274 ], 1275 "UpdateGatewayInformation": [ 1276 { 1277 "input": { 1278 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1279 "GatewayName": "MyGateway2", 1280 "GatewayTimezone": "GMT-12:00" 1281 }, 1282 "output": { 1283 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1284 "GatewayName": "" 1285 }, 1286 "comments": { 1287 "input": { 1288 }, 1289 "output": { 1290 } 1291 }, 1292 "description": "Updates a gateway's metadata, which includes the gateway's name and time zone.", 1293 "id": "to-update-a-gateways-metadata-1472151688693", 1294 "title": "To update a gateway's metadata" 1295 } 1296 ], 1297 "UpdateGatewaySoftwareNow": [ 1298 { 1299 "input": { 1300 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1301 }, 1302 "output": { 1303 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1304 }, 1305 "comments": { 1306 "input": { 1307 }, 1308 "output": { 1309 } 1310 }, 1311 "description": "Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.", 1312 "id": "to-update-a-gateways-vm-software-1472152020929", 1313 "title": "To update a gateway's VM software" 1314 } 1315 ], 1316 "UpdateMaintenanceStartTime": [ 1317 { 1318 "input": { 1319 "DayOfWeek": 2, 1320 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 1321 "HourOfDay": 0, 1322 "MinuteOfHour": 30 1323 }, 1324 "output": { 1325 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" 1326 }, 1327 "comments": { 1328 "input": { 1329 }, 1330 "output": { 1331 } 1332 }, 1333 "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.", 1334 "id": "to-update-a-gateways-maintenance-start-time-1472152552031", 1335 "title": "To update a gateway's maintenance start time" 1336 } 1337 ], 1338 "UpdateSnapshotSchedule": [ 1339 { 1340 "input": { 1341 "Description": "Hourly snapshot", 1342 "RecurrenceInHours": 1, 1343 "StartAt": 0, 1344 "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" 1345 }, 1346 "output": { 1347 "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" 1348 }, 1349 "comments": { 1350 "input": { 1351 }, 1352 "output": { 1353 } 1354 }, 1355 "description": "Updates a snapshot schedule configured for a gateway volume.", 1356 "id": "to-update-a-volume-snapshot-schedule-1472152757068", 1357 "title": "To update a volume snapshot schedule" 1358 } 1359 ], 1360 "UpdateVTLDeviceType": [ 1361 { 1362 "input": { 1363 "DeviceType": "Medium Changer", 1364 "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" 1365 }, 1366 "output": { 1367 "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" 1368 }, 1369 "comments": { 1370 "input": { 1371 }, 1372 "output": { 1373 } 1374 }, 1375 "description": "Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.", 1376 "id": "to-update-a-vtl-device-type-1472153012967", 1377 "title": "To update a VTL device type" 1378 } 1379 ] 1380 } 1381} 1382