aws-sdk-storagegateway 1.0.0.rc8 → 1.0.0.rc9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-storagegateway.rb +1 -1
- data/lib/aws-sdk-storagegateway/client.rb +1102 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4920de3e4a3cf76304b267c9f2402f60936775bf
|
4
|
+
data.tar.gz: 75375a3ba4131ef000376ad050a3f981df6fc1d7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2ae5e7d41ede4272a63c381d27a91385e559653684e2997c1f7c8228534a8a75033ed738d62fc5e453dc5adf8c45dbbcc9dc00316f629b32cd6432ec3e239540
|
7
|
+
data.tar.gz: 3a2413d23b7a24603bd4d65f371b49133ad54364fe700a88a37ac2d89d66be34df0e3e39825176972674f7ed2a6f9491e82a2d4a90ceed355060fe41a966444b
|
@@ -232,6 +232,26 @@ module Aws::StorageGateway
|
|
232
232
|
#
|
233
233
|
# * {Types::ActivateGatewayOutput#gateway_arn #gateway_arn} => String
|
234
234
|
#
|
235
|
+
#
|
236
|
+
# @example Example: To activate the gateway
|
237
|
+
#
|
238
|
+
# # Activates the gateway you previously deployed on your host.
|
239
|
+
#
|
240
|
+
# resp = client.activate_gateway({
|
241
|
+
# activation_key: "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
|
242
|
+
# gateway_name: "My_Gateway",
|
243
|
+
# gateway_region: "us-east-1",
|
244
|
+
# gateway_timezone: "GMT-12:00",
|
245
|
+
# gateway_type: "STORED",
|
246
|
+
# medium_changer_type: "AWS-Gateway-VTL",
|
247
|
+
# tape_drive_type: "IBM-ULT3580-TD5",
|
248
|
+
# })
|
249
|
+
#
|
250
|
+
# resp.to_h outputs the following:
|
251
|
+
# {
|
252
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
253
|
+
# }
|
254
|
+
#
|
235
255
|
# @example Request syntax with placeholder values
|
236
256
|
#
|
237
257
|
# resp = client.activate_gateway({
|
@@ -279,6 +299,24 @@ module Aws::StorageGateway
|
|
279
299
|
#
|
280
300
|
# * {Types::AddCacheOutput#gateway_arn #gateway_arn} => String
|
281
301
|
#
|
302
|
+
#
|
303
|
+
# @example Example: To add a cache
|
304
|
+
#
|
305
|
+
# # The following example shows a request that activates a gateway-stored volume.
|
306
|
+
#
|
307
|
+
# resp = client.add_cache({
|
308
|
+
# disk_ids: [
|
309
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
310
|
+
# "pci-0000:03:00.0-scsi-0:0:1:0",
|
311
|
+
# ],
|
312
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
313
|
+
# })
|
314
|
+
#
|
315
|
+
# resp.to_h outputs the following:
|
316
|
+
# {
|
317
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
318
|
+
# }
|
319
|
+
#
|
282
320
|
# @example Request syntax with placeholder values
|
283
321
|
#
|
284
322
|
# resp = client.add_cache({
|
@@ -342,6 +380,26 @@ module Aws::StorageGateway
|
|
342
380
|
#
|
343
381
|
# * {Types::AddTagsToResourceOutput#resource_arn #resource_arn} => String
|
344
382
|
#
|
383
|
+
#
|
384
|
+
# @example Example: To add tags to resource
|
385
|
+
#
|
386
|
+
# # Adds one or more tags to the specified resource.
|
387
|
+
#
|
388
|
+
# resp = client.add_tags_to_resource({
|
389
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
390
|
+
# tags: [
|
391
|
+
# {
|
392
|
+
# key: "Dev Gatgeway Region",
|
393
|
+
# value: "East Coast",
|
394
|
+
# },
|
395
|
+
# ],
|
396
|
+
# })
|
397
|
+
#
|
398
|
+
# resp.to_h outputs the following:
|
399
|
+
# {
|
400
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
401
|
+
# }
|
402
|
+
#
|
345
403
|
# @example Request syntax with placeholder values
|
346
404
|
#
|
347
405
|
# resp = client.add_tags_to_resource({
|
@@ -385,6 +443,24 @@ module Aws::StorageGateway
|
|
385
443
|
#
|
386
444
|
# * {Types::AddUploadBufferOutput#gateway_arn #gateway_arn} => String
|
387
445
|
#
|
446
|
+
#
|
447
|
+
# @example Example: To add upload buffer on local disk
|
448
|
+
#
|
449
|
+
# # Configures one or more gateway local disks as upload buffer for a specified gateway.
|
450
|
+
#
|
451
|
+
# resp = client.add_upload_buffer({
|
452
|
+
# disk_ids: [
|
453
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
454
|
+
# "pci-0000:03:00.0-scsi-0:0:1:0",
|
455
|
+
# ],
|
456
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
457
|
+
# })
|
458
|
+
#
|
459
|
+
# resp.to_h outputs the following:
|
460
|
+
# {
|
461
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
462
|
+
# }
|
463
|
+
#
|
388
464
|
# @example Request syntax with placeholder values
|
389
465
|
#
|
390
466
|
# resp = client.add_upload_buffer({
|
@@ -433,6 +509,24 @@ module Aws::StorageGateway
|
|
433
509
|
#
|
434
510
|
# * {Types::AddWorkingStorageOutput#gateway_arn #gateway_arn} => String
|
435
511
|
#
|
512
|
+
#
|
513
|
+
# @example Example: To add storage on local disk
|
514
|
+
#
|
515
|
+
# # Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)
|
516
|
+
#
|
517
|
+
# resp = client.add_working_storage({
|
518
|
+
# disk_ids: [
|
519
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
520
|
+
# "pci-0000:03:00.0-scsi-0:0:1:0",
|
521
|
+
# ],
|
522
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
523
|
+
# })
|
524
|
+
#
|
525
|
+
# resp.to_h outputs the following:
|
526
|
+
# {
|
527
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
528
|
+
# }
|
529
|
+
#
|
436
530
|
# @example Request syntax with placeholder values
|
437
531
|
#
|
438
532
|
# resp = client.add_working_storage({
|
@@ -469,6 +563,21 @@ module Aws::StorageGateway
|
|
469
563
|
#
|
470
564
|
# * {Types::CancelArchivalOutput#tape_arn #tape_arn} => String
|
471
565
|
#
|
566
|
+
#
|
567
|
+
# @example Example: To cancel virtual tape archiving
|
568
|
+
#
|
569
|
+
# # Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
|
570
|
+
#
|
571
|
+
# resp = client.cancel_archival({
|
572
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
573
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
|
574
|
+
# })
|
575
|
+
#
|
576
|
+
# resp.to_h outputs the following:
|
577
|
+
# {
|
578
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
|
579
|
+
# }
|
580
|
+
#
|
472
581
|
# @example Request syntax with placeholder values
|
473
582
|
#
|
474
583
|
# resp = client.cancel_archival({
|
@@ -505,6 +614,21 @@ module Aws::StorageGateway
|
|
505
614
|
#
|
506
615
|
# * {Types::CancelRetrievalOutput#tape_arn #tape_arn} => String
|
507
616
|
#
|
617
|
+
#
|
618
|
+
# @example Example: To cancel virtual tape retrieval
|
619
|
+
#
|
620
|
+
# # Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
|
621
|
+
#
|
622
|
+
# resp = client.cancel_retrieval({
|
623
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
624
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# resp.to_h outputs the following:
|
628
|
+
# {
|
629
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
|
630
|
+
# }
|
631
|
+
#
|
508
632
|
# @example Request syntax with placeholder values
|
509
633
|
#
|
510
634
|
# resp = client.cancel_retrieval({
|
@@ -572,6 +696,26 @@ module Aws::StorageGateway
|
|
572
696
|
# * {Types::CreateCachediSCSIVolumeOutput#volume_arn #volume_arn} => String
|
573
697
|
# * {Types::CreateCachediSCSIVolumeOutput#target_arn #target_arn} => String
|
574
698
|
#
|
699
|
+
#
|
700
|
+
# @example Example: To create a cached iSCSI volume
|
701
|
+
#
|
702
|
+
# # Creates a cached volume on a specified cached gateway.
|
703
|
+
#
|
704
|
+
# resp = client.create_cached_iscsi_volume({
|
705
|
+
# client_token: "cachedvol112233",
|
706
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
707
|
+
# network_interface_id: "10.1.1.1",
|
708
|
+
# snapshot_id: "snap-f47b7b94",
|
709
|
+
# target_name: "my-volume",
|
710
|
+
# volume_size_in_bytes: 536870912000,
|
711
|
+
# })
|
712
|
+
#
|
713
|
+
# resp.to_h outputs the following:
|
714
|
+
# {
|
715
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
716
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
717
|
+
# }
|
718
|
+
#
|
575
719
|
# @example Request syntax with placeholder values
|
576
720
|
#
|
577
721
|
# resp = client.create_cached_iscsi_volume({
|
@@ -751,6 +895,22 @@ module Aws::StorageGateway
|
|
751
895
|
# * {Types::CreateSnapshotOutput#volume_arn #volume_arn} => String
|
752
896
|
# * {Types::CreateSnapshotOutput#snapshot_id #snapshot_id} => String
|
753
897
|
#
|
898
|
+
#
|
899
|
+
# @example Example: To create a snapshot of a gateway volume
|
900
|
+
#
|
901
|
+
# # Initiates an ad-hoc snapshot of a gateway volume.
|
902
|
+
#
|
903
|
+
# resp = client.create_snapshot({
|
904
|
+
# snapshot_description: "My root volume snapshot as of 10/03/2017",
|
905
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
906
|
+
# })
|
907
|
+
#
|
908
|
+
# resp.to_h outputs the following:
|
909
|
+
# {
|
910
|
+
# snapshot_id: "snap-78e22663",
|
911
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
912
|
+
# }
|
913
|
+
#
|
754
914
|
# @example Request syntax with placeholder values
|
755
915
|
#
|
756
916
|
# resp = client.create_snapshot({
|
@@ -804,6 +964,23 @@ module Aws::StorageGateway
|
|
804
964
|
# * {Types::CreateSnapshotFromVolumeRecoveryPointOutput#volume_arn #volume_arn} => String
|
805
965
|
# * {Types::CreateSnapshotFromVolumeRecoveryPointOutput#volume_recovery_point_time #volume_recovery_point_time} => String
|
806
966
|
#
|
967
|
+
#
|
968
|
+
# @example Example: To create a snapshot of a gateway volume
|
969
|
+
#
|
970
|
+
# # Initiates a snapshot of a gateway from a volume recovery point.
|
971
|
+
#
|
972
|
+
# resp = client.create_snapshot_from_volume_recovery_point({
|
973
|
+
# snapshot_description: "My root volume snapshot as of 2017-06-30T10:10:10.000Z",
|
974
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
975
|
+
# })
|
976
|
+
#
|
977
|
+
# resp.to_h outputs the following:
|
978
|
+
# {
|
979
|
+
# snapshot_id: "snap-78e22663",
|
980
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
981
|
+
# volume_recovery_point_time: "2017-06-30T10:10:10.000Z",
|
982
|
+
# }
|
983
|
+
#
|
807
984
|
# @example Request syntax with placeholder values
|
808
985
|
#
|
809
986
|
# resp = client.create_snapshot_from_volume_recovery_point({
|
@@ -893,6 +1070,27 @@ module Aws::StorageGateway
|
|
893
1070
|
# * {Types::CreateStorediSCSIVolumeOutput#volume_size_in_bytes #volume_size_in_bytes} => Integer
|
894
1071
|
# * {Types::CreateStorediSCSIVolumeOutput#target_arn #target_arn} => String
|
895
1072
|
#
|
1073
|
+
#
|
1074
|
+
# @example Example: To create a stored iSCSI volume
|
1075
|
+
#
|
1076
|
+
# # Creates a stored volume on a specified stored gateway.
|
1077
|
+
#
|
1078
|
+
# resp = client.create_stored_iscsi_volume({
|
1079
|
+
# disk_id: "pci-0000:03:00.0-scsi-0:0:0:0",
|
1080
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1081
|
+
# network_interface_id: "10.1.1.1",
|
1082
|
+
# preserve_existing_data: true,
|
1083
|
+
# snapshot_id: "snap-f47b7b94",
|
1084
|
+
# target_name: "my-volume",
|
1085
|
+
# })
|
1086
|
+
#
|
1087
|
+
# resp.to_h outputs the following:
|
1088
|
+
# {
|
1089
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1090
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1091
|
+
# volume_size_in_bytes: 1099511627776,
|
1092
|
+
# }
|
1093
|
+
#
|
896
1094
|
# @example Request syntax with placeholder values
|
897
1095
|
#
|
898
1096
|
# resp = client.create_stored_iscsi_volume({
|
@@ -948,6 +1146,22 @@ module Aws::StorageGateway
|
|
948
1146
|
#
|
949
1147
|
# * {Types::CreateTapeWithBarcodeOutput#tape_arn #tape_arn} => String
|
950
1148
|
#
|
1149
|
+
#
|
1150
|
+
# @example Example: To create a virtual tape using a barcode
|
1151
|
+
#
|
1152
|
+
# # Creates a virtual tape by using your own barcode.
|
1153
|
+
#
|
1154
|
+
# resp = client.create_tape_with_barcode({
|
1155
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
1156
|
+
# tape_barcode: "TEST12345",
|
1157
|
+
# tape_size_in_bytes: 107374182400,
|
1158
|
+
# })
|
1159
|
+
#
|
1160
|
+
# resp.to_h outputs the following:
|
1161
|
+
# {
|
1162
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345",
|
1163
|
+
# }
|
1164
|
+
#
|
951
1165
|
# @example Request syntax with placeholder values
|
952
1166
|
#
|
953
1167
|
# resp = client.create_tape_with_barcode({
|
@@ -1017,6 +1231,28 @@ module Aws::StorageGateway
|
|
1017
1231
|
#
|
1018
1232
|
# * {Types::CreateTapesOutput#tape_arns #tape_arns} => Array<String>
|
1019
1233
|
#
|
1234
|
+
#
|
1235
|
+
# @example Example: To create a virtual tape
|
1236
|
+
#
|
1237
|
+
# # Creates one or more virtual tapes.
|
1238
|
+
#
|
1239
|
+
# resp = client.create_tapes({
|
1240
|
+
# client_token: "77777",
|
1241
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
1242
|
+
# num_tapes_to_create: 3,
|
1243
|
+
# tape_barcode_prefix: "TEST",
|
1244
|
+
# tape_size_in_bytes: 107374182400,
|
1245
|
+
# })
|
1246
|
+
#
|
1247
|
+
# resp.to_h outputs the following:
|
1248
|
+
# {
|
1249
|
+
# tape_arns: [
|
1250
|
+
# "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D",
|
1251
|
+
# "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F",
|
1252
|
+
# "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E",
|
1253
|
+
# ],
|
1254
|
+
# }
|
1255
|
+
#
|
1020
1256
|
# @example Request syntax with placeholder values
|
1021
1257
|
#
|
1022
1258
|
# resp = client.create_tapes({
|
@@ -1061,6 +1297,21 @@ module Aws::StorageGateway
|
|
1061
1297
|
#
|
1062
1298
|
# * {Types::DeleteBandwidthRateLimitOutput#gateway_arn #gateway_arn} => String
|
1063
1299
|
#
|
1300
|
+
#
|
1301
|
+
# @example Example: To delete bandwidth rate limits of gateway
|
1302
|
+
#
|
1303
|
+
# # Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
|
1304
|
+
#
|
1305
|
+
# resp = client.delete_bandwidth_rate_limit({
|
1306
|
+
# bandwidth_type: "All",
|
1307
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1308
|
+
# })
|
1309
|
+
#
|
1310
|
+
# resp.to_h outputs the following:
|
1311
|
+
# {
|
1312
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1313
|
+
# }
|
1314
|
+
#
|
1064
1315
|
# @example Request syntax with placeholder values
|
1065
1316
|
#
|
1066
1317
|
# resp = client.delete_bandwidth_rate_limit({
|
@@ -1097,6 +1348,22 @@ module Aws::StorageGateway
|
|
1097
1348
|
# * {Types::DeleteChapCredentialsOutput#target_arn #target_arn} => String
|
1098
1349
|
# * {Types::DeleteChapCredentialsOutput#initiator_name #initiator_name} => String
|
1099
1350
|
#
|
1351
|
+
#
|
1352
|
+
# @example Example: To delete CHAP credentials
|
1353
|
+
#
|
1354
|
+
# # Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
|
1355
|
+
#
|
1356
|
+
# resp = client.delete_chap_credentials({
|
1357
|
+
# initiator_name: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
1358
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1359
|
+
# })
|
1360
|
+
#
|
1361
|
+
# resp.to_h outputs the following:
|
1362
|
+
# {
|
1363
|
+
# initiator_name: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
1364
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1365
|
+
# }
|
1366
|
+
#
|
1100
1367
|
# @example Request syntax with placeholder values
|
1101
1368
|
#
|
1102
1369
|
# resp = client.delete_chap_credentials({
|
@@ -1179,6 +1446,20 @@ module Aws::StorageGateway
|
|
1179
1446
|
#
|
1180
1447
|
# * {Types::DeleteGatewayOutput#gateway_arn #gateway_arn} => String
|
1181
1448
|
#
|
1449
|
+
#
|
1450
|
+
# @example Example: To delete a gatgeway
|
1451
|
+
#
|
1452
|
+
# # This operation deletes the gateway, but not the gateway's VM from the host computer.
|
1453
|
+
#
|
1454
|
+
# resp = client.delete_gateway({
|
1455
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1456
|
+
# })
|
1457
|
+
#
|
1458
|
+
# resp.to_h outputs the following:
|
1459
|
+
# {
|
1460
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1461
|
+
# }
|
1462
|
+
#
|
1182
1463
|
# @example Request syntax with placeholder values
|
1183
1464
|
#
|
1184
1465
|
# resp = client.delete_gateway({
|
@@ -1221,6 +1502,20 @@ module Aws::StorageGateway
|
|
1221
1502
|
#
|
1222
1503
|
# * {Types::DeleteSnapshotScheduleOutput#volume_arn #volume_arn} => String
|
1223
1504
|
#
|
1505
|
+
#
|
1506
|
+
# @example Example: To delete a snapshot of a volume
|
1507
|
+
#
|
1508
|
+
# # This action enables you to delete a snapshot schedule for a volume.
|
1509
|
+
#
|
1510
|
+
# resp = client.delete_snapshot_schedule({
|
1511
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1512
|
+
# })
|
1513
|
+
#
|
1514
|
+
# resp.to_h outputs the following:
|
1515
|
+
# {
|
1516
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1517
|
+
# }
|
1518
|
+
#
|
1224
1519
|
# @example Request syntax with placeholder values
|
1225
1520
|
#
|
1226
1521
|
# resp = client.delete_snapshot_schedule({
|
@@ -1255,6 +1550,21 @@ module Aws::StorageGateway
|
|
1255
1550
|
#
|
1256
1551
|
# * {Types::DeleteTapeOutput#tape_arn #tape_arn} => String
|
1257
1552
|
#
|
1553
|
+
#
|
1554
|
+
# @example Example: To delete a virtual tape
|
1555
|
+
#
|
1556
|
+
# # This example deletes the specified virtual tape.
|
1557
|
+
#
|
1558
|
+
# resp = client.delete_tape({
|
1559
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B",
|
1560
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0",
|
1561
|
+
# })
|
1562
|
+
#
|
1563
|
+
# resp.to_h outputs the following:
|
1564
|
+
# {
|
1565
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0",
|
1566
|
+
# }
|
1567
|
+
#
|
1258
1568
|
# @example Request syntax with placeholder values
|
1259
1569
|
#
|
1260
1570
|
# resp = client.delete_tape({
|
@@ -1286,6 +1596,20 @@ module Aws::StorageGateway
|
|
1286
1596
|
#
|
1287
1597
|
# * {Types::DeleteTapeArchiveOutput#tape_arn #tape_arn} => String
|
1288
1598
|
#
|
1599
|
+
#
|
1600
|
+
# @example Example: To delete a virtual tape from the shelf (VTS)
|
1601
|
+
#
|
1602
|
+
# # Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
1603
|
+
#
|
1604
|
+
# resp = client.delete_tape_archive({
|
1605
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0",
|
1606
|
+
# })
|
1607
|
+
#
|
1608
|
+
# resp.to_h outputs the following:
|
1609
|
+
# {
|
1610
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0",
|
1611
|
+
# }
|
1612
|
+
#
|
1289
1613
|
# @example Request syntax with placeholder values
|
1290
1614
|
#
|
1291
1615
|
# resp = client.delete_tape_archive({
|
@@ -1335,6 +1659,20 @@ module Aws::StorageGateway
|
|
1335
1659
|
#
|
1336
1660
|
# * {Types::DeleteVolumeOutput#volume_arn #volume_arn} => String
|
1337
1661
|
#
|
1662
|
+
#
|
1663
|
+
# @example Example: To delete a gateway volume
|
1664
|
+
#
|
1665
|
+
# # Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
|
1666
|
+
#
|
1667
|
+
# resp = client.delete_volume({
|
1668
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1669
|
+
# })
|
1670
|
+
#
|
1671
|
+
# resp.to_h outputs the following:
|
1672
|
+
# {
|
1673
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1674
|
+
# }
|
1675
|
+
#
|
1338
1676
|
# @example Request syntax with placeholder values
|
1339
1677
|
#
|
1340
1678
|
# resp = client.delete_volume({
|
@@ -1374,6 +1712,22 @@ module Aws::StorageGateway
|
|
1374
1712
|
# * {Types::DescribeBandwidthRateLimitOutput#average_upload_rate_limit_in_bits_per_sec #average_upload_rate_limit_in_bits_per_sec} => Integer
|
1375
1713
|
# * {Types::DescribeBandwidthRateLimitOutput#average_download_rate_limit_in_bits_per_sec #average_download_rate_limit_in_bits_per_sec} => Integer
|
1376
1714
|
#
|
1715
|
+
#
|
1716
|
+
# @example Example: To describe the bandwidth rate limits of a gateway
|
1717
|
+
#
|
1718
|
+
# # Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
|
1719
|
+
#
|
1720
|
+
# resp = client.describe_bandwidth_rate_limit({
|
1721
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1722
|
+
# })
|
1723
|
+
#
|
1724
|
+
# resp.to_h outputs the following:
|
1725
|
+
# {
|
1726
|
+
# average_download_rate_limit_in_bits_per_sec: 204800,
|
1727
|
+
# average_upload_rate_limit_in_bits_per_sec: 102400,
|
1728
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1729
|
+
# }
|
1730
|
+
#
|
1377
1731
|
# @example Request syntax with placeholder values
|
1378
1732
|
#
|
1379
1733
|
# resp = client.describe_bandwidth_rate_limit({
|
@@ -1416,6 +1770,29 @@ module Aws::StorageGateway
|
|
1416
1770
|
# * {Types::DescribeCacheOutput#cache_hit_percentage #cache_hit_percentage} => Float
|
1417
1771
|
# * {Types::DescribeCacheOutput#cache_miss_percentage #cache_miss_percentage} => Float
|
1418
1772
|
#
|
1773
|
+
#
|
1774
|
+
# @example Example: To describe cache information
|
1775
|
+
#
|
1776
|
+
# # Returns information about the cache of a gateway.
|
1777
|
+
#
|
1778
|
+
# resp = client.describe_cache({
|
1779
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1780
|
+
# })
|
1781
|
+
#
|
1782
|
+
# resp.to_h outputs the following:
|
1783
|
+
# {
|
1784
|
+
# cache_allocated_in_bytes: 2199023255552,
|
1785
|
+
# cache_dirty_percentage: 0.07,
|
1786
|
+
# cache_hit_percentage: 99.68,
|
1787
|
+
# cache_miss_percentage: 0.32,
|
1788
|
+
# cache_used_percentage: 0.07,
|
1789
|
+
# disk_ids: [
|
1790
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
1791
|
+
# "pci-0000:04:00.0-scsi-0:1:0:0",
|
1792
|
+
# ],
|
1793
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1794
|
+
# }
|
1795
|
+
#
|
1419
1796
|
# @example Request syntax with placeholder values
|
1420
1797
|
#
|
1421
1798
|
# resp = client.describe_cache({
|
@@ -1456,6 +1833,37 @@ module Aws::StorageGateway
|
|
1456
1833
|
#
|
1457
1834
|
# * {Types::DescribeCachediSCSIVolumesOutput#cached_iscsi_volumes #cached_iscsi_volumes} => Array<Types::CachediSCSIVolume>
|
1458
1835
|
#
|
1836
|
+
#
|
1837
|
+
# @example Example: To describe gateway cached iSCSI volumes
|
1838
|
+
#
|
1839
|
+
# # Returns a description of the gateway cached iSCSI volumes specified in the request.
|
1840
|
+
#
|
1841
|
+
# resp = client.describe_cached_iscsi_volumes({
|
1842
|
+
# volume_arns: [
|
1843
|
+
# "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1844
|
+
# ],
|
1845
|
+
# })
|
1846
|
+
#
|
1847
|
+
# resp.to_h outputs the following:
|
1848
|
+
# {
|
1849
|
+
# cached_iscsi_volumes: [
|
1850
|
+
# {
|
1851
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
1852
|
+
# volume_id: "vol-1122AABB",
|
1853
|
+
# volume_size_in_bytes: 1099511627776,
|
1854
|
+
# volume_status: "AVAILABLE",
|
1855
|
+
# volume_type: "CACHED iSCSI",
|
1856
|
+
# volume_iscsi_attributes: {
|
1857
|
+
# chap_enabled: true,
|
1858
|
+
# lun_number: 1,
|
1859
|
+
# network_interface_id: "10.243.43.207",
|
1860
|
+
# network_interface_port: 3260,
|
1861
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1862
|
+
# },
|
1863
|
+
# },
|
1864
|
+
# ],
|
1865
|
+
# }
|
1866
|
+
#
|
1459
1867
|
# @example Request syntax with placeholder values
|
1460
1868
|
#
|
1461
1869
|
# resp = client.describe_cached_iscsi_volumes({
|
@@ -1501,6 +1909,27 @@ module Aws::StorageGateway
|
|
1501
1909
|
#
|
1502
1910
|
# * {Types::DescribeChapCredentialsOutput#chap_credentials #chap_credentials} => Array<Types::ChapInfo>
|
1503
1911
|
#
|
1912
|
+
#
|
1913
|
+
# @example Example: To describe CHAP credetnitals for an iSCSI
|
1914
|
+
#
|
1915
|
+
# # Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
|
1916
|
+
#
|
1917
|
+
# resp = client.describe_chap_credentials({
|
1918
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1919
|
+
# })
|
1920
|
+
#
|
1921
|
+
# resp.to_h outputs the following:
|
1922
|
+
# {
|
1923
|
+
# chap_credentials: [
|
1924
|
+
# {
|
1925
|
+
# initiator_name: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
1926
|
+
# secret_to_authenticate_initiator: "111111111111",
|
1927
|
+
# secret_to_authenticate_target: "222222222222",
|
1928
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
1929
|
+
# },
|
1930
|
+
# ],
|
1931
|
+
# }
|
1932
|
+
#
|
1504
1933
|
# @example Request syntax with placeholder values
|
1505
1934
|
#
|
1506
1935
|
# resp = client.describe_chap_credentials({
|
@@ -1545,6 +1974,32 @@ module Aws::StorageGateway
|
|
1545
1974
|
# * {Types::DescribeGatewayInformationOutput#next_update_availability_date #next_update_availability_date} => String
|
1546
1975
|
# * {Types::DescribeGatewayInformationOutput#last_software_update #last_software_update} => String
|
1547
1976
|
#
|
1977
|
+
#
|
1978
|
+
# @example Example: To describe metadata about the gateway
|
1979
|
+
#
|
1980
|
+
# # Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
|
1981
|
+
#
|
1982
|
+
# resp = client.describe_gateway_information({
|
1983
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1984
|
+
# })
|
1985
|
+
#
|
1986
|
+
# resp.to_h outputs the following:
|
1987
|
+
# {
|
1988
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
1989
|
+
# gateway_id: "sgw-AABB1122",
|
1990
|
+
# gateway_name: "My_Gateway",
|
1991
|
+
# gateway_network_interfaces: [
|
1992
|
+
# {
|
1993
|
+
# ipv_4_address: "10.35.69.216",
|
1994
|
+
# },
|
1995
|
+
# ],
|
1996
|
+
# gateway_state: "STATE_RUNNING",
|
1997
|
+
# gateway_timezone: "GMT-8:00",
|
1998
|
+
# gateway_type: "STORED",
|
1999
|
+
# last_software_update: "2016-01-02T16:00:00",
|
2000
|
+
# next_update_availability_date: "2017-01-02T16:00:00",
|
2001
|
+
# }
|
2002
|
+
#
|
1548
2003
|
# @example Request syntax with placeholder values
|
1549
2004
|
#
|
1550
2005
|
# resp = client.describe_gateway_information({
|
@@ -1591,6 +2046,24 @@ module Aws::StorageGateway
|
|
1591
2046
|
# * {Types::DescribeMaintenanceStartTimeOutput#day_of_week #day_of_week} => Integer
|
1592
2047
|
# * {Types::DescribeMaintenanceStartTimeOutput#timezone #timezone} => String
|
1593
2048
|
#
|
2049
|
+
#
|
2050
|
+
# @example Example: To describe gateway's maintenance start time
|
2051
|
+
#
|
2052
|
+
# # Returns your gateway's weekly maintenance start time including the day and time of the week.
|
2053
|
+
#
|
2054
|
+
# resp = client.describe_maintenance_start_time({
|
2055
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2056
|
+
# })
|
2057
|
+
#
|
2058
|
+
# resp.to_h outputs the following:
|
2059
|
+
# {
|
2060
|
+
# day_of_week: 2,
|
2061
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2062
|
+
# hour_of_day: 15,
|
2063
|
+
# minute_of_hour: 35,
|
2064
|
+
# timezone: "GMT+7:00",
|
2065
|
+
# }
|
2066
|
+
#
|
1594
2067
|
# @example Request syntax with placeholder values
|
1595
2068
|
#
|
1596
2069
|
# resp = client.describe_maintenance_start_time({
|
@@ -1679,6 +2152,24 @@ module Aws::StorageGateway
|
|
1679
2152
|
# * {Types::DescribeSnapshotScheduleOutput#description #description} => String
|
1680
2153
|
# * {Types::DescribeSnapshotScheduleOutput#timezone #timezone} => String
|
1681
2154
|
#
|
2155
|
+
#
|
2156
|
+
# @example Example: To describe snapshot schedule for gateway volume
|
2157
|
+
#
|
2158
|
+
# # Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.
|
2159
|
+
#
|
2160
|
+
# resp = client.describe_snapshot_schedule({
|
2161
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
2162
|
+
# })
|
2163
|
+
#
|
2164
|
+
# resp.to_h outputs the following:
|
2165
|
+
# {
|
2166
|
+
# description: "sgw-AABB1122:vol-AABB1122:Schedule",
|
2167
|
+
# recurrence_in_hours: 24,
|
2168
|
+
# start_at: 6,
|
2169
|
+
# timezone: "GMT+7:00",
|
2170
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
2171
|
+
# }
|
2172
|
+
#
|
1682
2173
|
# @example Request syntax with placeholder values
|
1683
2174
|
#
|
1684
2175
|
# resp = client.describe_snapshot_schedule({
|
@@ -1718,6 +2209,38 @@ module Aws::StorageGateway
|
|
1718
2209
|
#
|
1719
2210
|
# * {Types::DescribeStorediSCSIVolumesOutput#stored_iscsi_volumes #stored_iscsi_volumes} => Array<Types::StorediSCSIVolume>
|
1720
2211
|
#
|
2212
|
+
#
|
2213
|
+
# @example Example: To describe the volumes of a gateway
|
2214
|
+
#
|
2215
|
+
# # Returns the description of the gateway volumes specified in the request belonging to the same gateway.
|
2216
|
+
#
|
2217
|
+
# resp = client.describe_stored_iscsi_volumes({
|
2218
|
+
# volume_arns: [
|
2219
|
+
# "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
2220
|
+
# ],
|
2221
|
+
# })
|
2222
|
+
#
|
2223
|
+
# resp.to_h outputs the following:
|
2224
|
+
# {
|
2225
|
+
# stored_iscsi_volumes: [
|
2226
|
+
# {
|
2227
|
+
# preserved_existing_data: false,
|
2228
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
2229
|
+
# volume_disk_id: "pci-0000:03:00.0-scsi-0:0:0:0",
|
2230
|
+
# volume_id: "vol-1122AABB",
|
2231
|
+
# volume_progress: 23.7,
|
2232
|
+
# volume_size_in_bytes: 1099511627776,
|
2233
|
+
# volume_status: "BOOTSTRAPPING",
|
2234
|
+
# volume_iscsi_attributes: {
|
2235
|
+
# chap_enabled: true,
|
2236
|
+
# network_interface_id: "10.243.43.207",
|
2237
|
+
# network_interface_port: 3260,
|
2238
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
2239
|
+
# },
|
2240
|
+
# },
|
2241
|
+
# ],
|
2242
|
+
# }
|
2243
|
+
#
|
1721
2244
|
# @example Request syntax with placeholder values
|
1722
2245
|
#
|
1723
2246
|
# resp = client.describe_stored_iscsi_volumes({
|
@@ -1777,6 +2300,41 @@ module Aws::StorageGateway
|
|
1777
2300
|
# * {Types::DescribeTapeArchivesOutput#tape_archives #tape_archives} => Array<Types::TapeArchive>
|
1778
2301
|
# * {Types::DescribeTapeArchivesOutput#marker #marker} => String
|
1779
2302
|
#
|
2303
|
+
#
|
2304
|
+
# @example Example: To describe virtual tapes in the VTS
|
2305
|
+
#
|
2306
|
+
# # Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
2307
|
+
#
|
2308
|
+
# resp = client.describe_tape_archives({
|
2309
|
+
# limit: 123,
|
2310
|
+
# marker: "1",
|
2311
|
+
# tape_arns: [
|
2312
|
+
# "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD",
|
2313
|
+
# "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
|
2314
|
+
# ],
|
2315
|
+
# })
|
2316
|
+
#
|
2317
|
+
# resp.to_h outputs the following:
|
2318
|
+
# {
|
2319
|
+
# marker: "1",
|
2320
|
+
# tape_archives: [
|
2321
|
+
# {
|
2322
|
+
# completion_time: Time.parse("2016-12-16T13:50Z"),
|
2323
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD",
|
2324
|
+
# tape_barcode: "AM08A1AD",
|
2325
|
+
# tape_size_in_bytes: 107374182400,
|
2326
|
+
# tape_status: "ARCHIVED",
|
2327
|
+
# },
|
2328
|
+
# {
|
2329
|
+
# completion_time: Time.parse("2016-12-16T13:59Z"),
|
2330
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
|
2331
|
+
# tape_barcode: "AMZN01A2A4",
|
2332
|
+
# tape_size_in_bytes: 429496729600,
|
2333
|
+
# tape_status: "ARCHIVED",
|
2334
|
+
# },
|
2335
|
+
# ],
|
2336
|
+
# }
|
2337
|
+
#
|
1780
2338
|
# @example Request syntax with placeholder values
|
1781
2339
|
#
|
1782
2340
|
# resp = client.describe_tape_archives({
|
@@ -1834,6 +2392,31 @@ module Aws::StorageGateway
|
|
1834
2392
|
# * {Types::DescribeTapeRecoveryPointsOutput#tape_recovery_point_infos #tape_recovery_point_infos} => Array<Types::TapeRecoveryPointInfo>
|
1835
2393
|
# * {Types::DescribeTapeRecoveryPointsOutput#marker #marker} => String
|
1836
2394
|
#
|
2395
|
+
#
|
2396
|
+
# @example Example: To describe virtual tape recovery points
|
2397
|
+
#
|
2398
|
+
# # Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
|
2399
|
+
#
|
2400
|
+
# resp = client.describe_tape_recovery_points({
|
2401
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2402
|
+
# limit: 1,
|
2403
|
+
# marker: "1",
|
2404
|
+
# })
|
2405
|
+
#
|
2406
|
+
# resp.to_h outputs the following:
|
2407
|
+
# {
|
2408
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2409
|
+
# marker: "1",
|
2410
|
+
# tape_recovery_point_infos: [
|
2411
|
+
# {
|
2412
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
|
2413
|
+
# tape_recovery_point_time: Time.parse("2016-12-16T13:50Z"),
|
2414
|
+
# tape_size_in_bytes: 1471550497,
|
2415
|
+
# tape_status: "AVAILABLE",
|
2416
|
+
# },
|
2417
|
+
# ],
|
2418
|
+
# }
|
2419
|
+
#
|
1837
2420
|
# @example Request syntax with placeholder values
|
1838
2421
|
#
|
1839
2422
|
# resp = client.describe_tape_recovery_points({
|
@@ -1896,6 +2479,40 @@ module Aws::StorageGateway
|
|
1896
2479
|
# * {Types::DescribeTapesOutput#tapes #tapes} => Array<Types::Tape>
|
1897
2480
|
# * {Types::DescribeTapesOutput#marker #marker} => String
|
1898
2481
|
#
|
2482
|
+
#
|
2483
|
+
# @example Example: To describe virtual tape(s) associated with gateway
|
2484
|
+
#
|
2485
|
+
# # 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.
|
2486
|
+
#
|
2487
|
+
# resp = client.describe_tapes({
|
2488
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
2489
|
+
# limit: 2,
|
2490
|
+
# marker: "1",
|
2491
|
+
# tape_arns: [
|
2492
|
+
# "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
|
2493
|
+
# "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
|
2494
|
+
# ],
|
2495
|
+
# })
|
2496
|
+
#
|
2497
|
+
# resp.to_h outputs the following:
|
2498
|
+
# {
|
2499
|
+
# marker: "1",
|
2500
|
+
# tapes: [
|
2501
|
+
# {
|
2502
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
|
2503
|
+
# tape_barcode: "TEST04A2A1",
|
2504
|
+
# tape_size_in_bytes: 107374182400,
|
2505
|
+
# tape_status: "AVAILABLE",
|
2506
|
+
# },
|
2507
|
+
# {
|
2508
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
|
2509
|
+
# tape_barcode: "TEST05A2A0",
|
2510
|
+
# tape_size_in_bytes: 107374182400,
|
2511
|
+
# tape_status: "AVAILABLE",
|
2512
|
+
# },
|
2513
|
+
# ],
|
2514
|
+
# }
|
2515
|
+
#
|
1899
2516
|
# @example Request syntax with placeholder values
|
1900
2517
|
#
|
1901
2518
|
# resp = client.describe_tapes({
|
@@ -1946,6 +2563,45 @@ module Aws::StorageGateway
|
|
1946
2563
|
# * {Types::DescribeUploadBufferOutput#upload_buffer_used_in_bytes #upload_buffer_used_in_bytes} => Integer
|
1947
2564
|
# * {Types::DescribeUploadBufferOutput#upload_buffer_allocated_in_bytes #upload_buffer_allocated_in_bytes} => Integer
|
1948
2565
|
#
|
2566
|
+
#
|
2567
|
+
# @example Example: To describe upload buffer of gateway
|
2568
|
+
#
|
2569
|
+
# # Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.
|
2570
|
+
#
|
2571
|
+
# resp = client.describe_upload_buffer({
|
2572
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2573
|
+
# })
|
2574
|
+
#
|
2575
|
+
# resp.to_h outputs the following:
|
2576
|
+
# {
|
2577
|
+
# disk_ids: [
|
2578
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
2579
|
+
# "pci-0000:04:00.0-scsi-0:1:0:0",
|
2580
|
+
# ],
|
2581
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2582
|
+
# upload_buffer_allocated_in_bytes: 0,
|
2583
|
+
# upload_buffer_used_in_bytes: 161061273600,
|
2584
|
+
# }
|
2585
|
+
#
|
2586
|
+
# @example Example: To describe upload buffer of a gateway
|
2587
|
+
#
|
2588
|
+
# # Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.
|
2589
|
+
#
|
2590
|
+
# resp = client.describe_upload_buffer({
|
2591
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2592
|
+
# })
|
2593
|
+
#
|
2594
|
+
# resp.to_h outputs the following:
|
2595
|
+
# {
|
2596
|
+
# disk_ids: [
|
2597
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
2598
|
+
# "pci-0000:04:00.0-scsi-0:1:0:0",
|
2599
|
+
# ],
|
2600
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2601
|
+
# upload_buffer_allocated_in_bytes: 161061273600,
|
2602
|
+
# upload_buffer_used_in_bytes: 0,
|
2603
|
+
# }
|
2604
|
+
#
|
1949
2605
|
# @example Request syntax with placeholder values
|
1950
2606
|
#
|
1951
2607
|
# resp = client.describe_upload_buffer({
|
@@ -2003,6 +2659,63 @@ module Aws::StorageGateway
|
|
2003
2659
|
# * {Types::DescribeVTLDevicesOutput#vtl_devices #vtl_devices} => Array<Types::VTLDevice>
|
2004
2660
|
# * {Types::DescribeVTLDevicesOutput#marker #marker} => String
|
2005
2661
|
#
|
2662
|
+
#
|
2663
|
+
# @example Example: To describe virtual tape library (VTL) devices of a single gateway
|
2664
|
+
#
|
2665
|
+
# # Returns a description of virtual tape library (VTL) devices for the specified gateway.
|
2666
|
+
#
|
2667
|
+
# resp = client.describe_vtl_devices({
|
2668
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
2669
|
+
# limit: 123,
|
2670
|
+
# marker: "1",
|
2671
|
+
# vtl_device_arns: [
|
2672
|
+
# ],
|
2673
|
+
# })
|
2674
|
+
#
|
2675
|
+
# resp.to_h outputs the following:
|
2676
|
+
# {
|
2677
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
2678
|
+
# marker: "1",
|
2679
|
+
# vtl_devices: [
|
2680
|
+
# {
|
2681
|
+
# device_iscsi_attributes: {
|
2682
|
+
# chap_enabled: false,
|
2683
|
+
# network_interface_id: "10.243.43.207",
|
2684
|
+
# network_interface_port: 3260,
|
2685
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger",
|
2686
|
+
# },
|
2687
|
+
# vtl_device_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
|
2688
|
+
# vtl_device_product_identifier: "L700",
|
2689
|
+
# vtl_device_type: "Medium Changer",
|
2690
|
+
# vtl_device_vendor: "STK",
|
2691
|
+
# },
|
2692
|
+
# {
|
2693
|
+
# device_iscsi_attributes: {
|
2694
|
+
# chap_enabled: false,
|
2695
|
+
# network_interface_id: "10.243.43.209",
|
2696
|
+
# network_interface_port: 3260,
|
2697
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01",
|
2698
|
+
# },
|
2699
|
+
# vtl_device_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001",
|
2700
|
+
# vtl_device_product_identifier: "ULT3580-TD5",
|
2701
|
+
# vtl_device_type: "Tape Drive",
|
2702
|
+
# vtl_device_vendor: "IBM",
|
2703
|
+
# },
|
2704
|
+
# {
|
2705
|
+
# device_iscsi_attributes: {
|
2706
|
+
# chap_enabled: false,
|
2707
|
+
# network_interface_id: "10.243.43.209",
|
2708
|
+
# network_interface_port: 3260,
|
2709
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02",
|
2710
|
+
# },
|
2711
|
+
# vtl_device_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002",
|
2712
|
+
# vtl_device_product_identifier: "ULT3580-TD5",
|
2713
|
+
# vtl_device_type: "Tape Drive",
|
2714
|
+
# vtl_device_vendor: "IBM",
|
2715
|
+
# },
|
2716
|
+
# ],
|
2717
|
+
# }
|
2718
|
+
#
|
2006
2719
|
# @example Request syntax with placeholder values
|
2007
2720
|
#
|
2008
2721
|
# resp = client.describe_vtl_devices({
|
@@ -2060,6 +2773,26 @@ module Aws::StorageGateway
|
|
2060
2773
|
# * {Types::DescribeWorkingStorageOutput#working_storage_used_in_bytes #working_storage_used_in_bytes} => Integer
|
2061
2774
|
# * {Types::DescribeWorkingStorageOutput#working_storage_allocated_in_bytes #working_storage_allocated_in_bytes} => Integer
|
2062
2775
|
#
|
2776
|
+
#
|
2777
|
+
# @example Example: To describe the working storage of a gateway [Depreciated]
|
2778
|
+
#
|
2779
|
+
# # This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
|
2780
|
+
#
|
2781
|
+
# resp = client.describe_working_storage({
|
2782
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2783
|
+
# })
|
2784
|
+
#
|
2785
|
+
# resp.to_h outputs the following:
|
2786
|
+
# {
|
2787
|
+
# disk_ids: [
|
2788
|
+
# "pci-0000:03:00.0-scsi-0:0:0:0",
|
2789
|
+
# "pci-0000:03:00.0-scsi-0:0:1:0",
|
2790
|
+
# ],
|
2791
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2792
|
+
# working_storage_allocated_in_bytes: 2199023255552,
|
2793
|
+
# working_storage_used_in_bytes: 789207040,
|
2794
|
+
# }
|
2795
|
+
#
|
2063
2796
|
# @example Request syntax with placeholder values
|
2064
2797
|
#
|
2065
2798
|
# resp = client.describe_working_storage({
|
@@ -2101,6 +2834,20 @@ module Aws::StorageGateway
|
|
2101
2834
|
#
|
2102
2835
|
# * {Types::DisableGatewayOutput#gateway_arn #gateway_arn} => String
|
2103
2836
|
#
|
2837
|
+
#
|
2838
|
+
# @example Example: To disable a gateway when it is no longer functioning
|
2839
|
+
#
|
2840
|
+
# # Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.
|
2841
|
+
#
|
2842
|
+
# resp = client.disable_gateway({
|
2843
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2844
|
+
# })
|
2845
|
+
#
|
2846
|
+
# resp.to_h outputs the following:
|
2847
|
+
# {
|
2848
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2849
|
+
# }
|
2850
|
+
#
|
2104
2851
|
# @example Request syntax with placeholder values
|
2105
2852
|
#
|
2106
2853
|
# resp = client.disable_gateway({
|
@@ -2197,6 +2944,29 @@ module Aws::StorageGateway
|
|
2197
2944
|
# * {Types::ListGatewaysOutput#gateways #gateways} => Array<Types::GatewayInfo>
|
2198
2945
|
# * {Types::ListGatewaysOutput#marker #marker} => String
|
2199
2946
|
#
|
2947
|
+
#
|
2948
|
+
# @example Example: To lists region specific gateways per AWS account
|
2949
|
+
#
|
2950
|
+
# # 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.
|
2951
|
+
#
|
2952
|
+
# resp = client.list_gateways({
|
2953
|
+
# limit: 2,
|
2954
|
+
# marker: "1",
|
2955
|
+
# })
|
2956
|
+
#
|
2957
|
+
# resp.to_h outputs the following:
|
2958
|
+
# {
|
2959
|
+
# gateways: [
|
2960
|
+
# {
|
2961
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
2962
|
+
# },
|
2963
|
+
# {
|
2964
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C",
|
2965
|
+
# },
|
2966
|
+
# ],
|
2967
|
+
# marker: "1",
|
2968
|
+
# }
|
2969
|
+
#
|
2200
2970
|
# @example Request syntax with placeholder values
|
2201
2971
|
#
|
2202
2972
|
# resp = client.list_gateways({
|
@@ -2244,6 +3014,39 @@ module Aws::StorageGateway
|
|
2244
3014
|
# * {Types::ListLocalDisksOutput#gateway_arn #gateway_arn} => String
|
2245
3015
|
# * {Types::ListLocalDisksOutput#disks #disks} => Array<Types::Disk>
|
2246
3016
|
#
|
3017
|
+
#
|
3018
|
+
# @example Example: To list the gateway's local disks
|
3019
|
+
#
|
3020
|
+
# # 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.
|
3021
|
+
#
|
3022
|
+
# resp = client.list_local_disks({
|
3023
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3024
|
+
# })
|
3025
|
+
#
|
3026
|
+
# resp.to_h outputs the following:
|
3027
|
+
# {
|
3028
|
+
# disks: [
|
3029
|
+
# {
|
3030
|
+
# disk_allocation_type: "CACHE_STORAGE",
|
3031
|
+
# disk_id: "pci-0000:03:00.0-scsi-0:0:0:0",
|
3032
|
+
# disk_node: "SCSI(0:0)",
|
3033
|
+
# disk_path: "/dev/sda",
|
3034
|
+
# disk_size_in_bytes: 1099511627776,
|
3035
|
+
# disk_status: "missing",
|
3036
|
+
# },
|
3037
|
+
# {
|
3038
|
+
# disk_allocation_resource: "",
|
3039
|
+
# disk_allocation_type: "UPLOAD_BUFFER",
|
3040
|
+
# disk_id: "pci-0000:03:00.0-scsi-0:0:1:0",
|
3041
|
+
# disk_node: "SCSI(0:1)",
|
3042
|
+
# disk_path: "/dev/sdb",
|
3043
|
+
# disk_size_in_bytes: 1099511627776,
|
3044
|
+
# disk_status: "present",
|
3045
|
+
# },
|
3046
|
+
# ],
|
3047
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3048
|
+
# }
|
3049
|
+
#
|
2247
3050
|
# @example Request syntax with placeholder values
|
2248
3051
|
#
|
2249
3052
|
# resp = client.list_local_disks({
|
@@ -2293,6 +3096,29 @@ module Aws::StorageGateway
|
|
2293
3096
|
# * {Types::ListTagsForResourceOutput#marker #marker} => String
|
2294
3097
|
# * {Types::ListTagsForResourceOutput#tags #tags} => Array<Types::Tag>
|
2295
3098
|
#
|
3099
|
+
#
|
3100
|
+
# @example Example: To list tags that have been added to a resource
|
3101
|
+
#
|
3102
|
+
# # Lists the tags that have been added to the specified resource.
|
3103
|
+
#
|
3104
|
+
# resp = client.list_tags_for_resource({
|
3105
|
+
# limit: 1,
|
3106
|
+
# marker: "1",
|
3107
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
3108
|
+
# })
|
3109
|
+
#
|
3110
|
+
# resp.to_h outputs the following:
|
3111
|
+
# {
|
3112
|
+
# marker: "1",
|
3113
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
3114
|
+
# tags: [
|
3115
|
+
# {
|
3116
|
+
# key: "Dev Gatgeway Region",
|
3117
|
+
# value: "East Coast",
|
3118
|
+
# },
|
3119
|
+
# ],
|
3120
|
+
# }
|
3121
|
+
#
|
2296
3122
|
# @example Request syntax with placeholder values
|
2297
3123
|
#
|
2298
3124
|
# resp = client.list_tags_for_resource({
|
@@ -2428,6 +3254,27 @@ module Aws::StorageGateway
|
|
2428
3254
|
# * {Types::ListVolumeRecoveryPointsOutput#gateway_arn #gateway_arn} => String
|
2429
3255
|
# * {Types::ListVolumeRecoveryPointsOutput#volume_recovery_point_infos #volume_recovery_point_infos} => Array<Types::VolumeRecoveryPointInfo>
|
2430
3256
|
#
|
3257
|
+
#
|
3258
|
+
# @example Example: To list recovery points for a gateway
|
3259
|
+
#
|
3260
|
+
# # 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.
|
3261
|
+
#
|
3262
|
+
# resp = client.list_volume_recovery_points({
|
3263
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3264
|
+
# })
|
3265
|
+
#
|
3266
|
+
# resp.to_h outputs the following:
|
3267
|
+
# {
|
3268
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3269
|
+
# volume_recovery_point_infos: [
|
3270
|
+
# {
|
3271
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
3272
|
+
# volume_recovery_point_time: "2012-09-04T21:08:44.627Z",
|
3273
|
+
# volume_size_in_bytes: 536870912000,
|
3274
|
+
# },
|
3275
|
+
# ],
|
3276
|
+
# }
|
3277
|
+
#
|
2431
3278
|
# @example Request syntax with placeholder values
|
2432
3279
|
#
|
2433
3280
|
# resp = client.list_volume_recovery_points({
|
@@ -2485,6 +3332,41 @@ module Aws::StorageGateway
|
|
2485
3332
|
# * {Types::ListVolumesOutput#marker #marker} => String
|
2486
3333
|
# * {Types::ListVolumesOutput#volume_infos #volume_infos} => Array<Types::VolumeInfo>
|
2487
3334
|
#
|
3335
|
+
#
|
3336
|
+
# @example Example: To list the iSCSI stored volumes of a gateway
|
3337
|
+
#
|
3338
|
+
# # Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.
|
3339
|
+
#
|
3340
|
+
# resp = client.list_volumes({
|
3341
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3342
|
+
# limit: 2,
|
3343
|
+
# marker: "1",
|
3344
|
+
# })
|
3345
|
+
#
|
3346
|
+
# resp.to_h outputs the following:
|
3347
|
+
# {
|
3348
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3349
|
+
# marker: "1",
|
3350
|
+
# volume_infos: [
|
3351
|
+
# {
|
3352
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3353
|
+
# gateway_id: "sgw-12A3456B",
|
3354
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
3355
|
+
# volume_id: "vol-1122AABB",
|
3356
|
+
# volume_size_in_bytes: 107374182400,
|
3357
|
+
# volume_type: "STORED",
|
3358
|
+
# },
|
3359
|
+
# {
|
3360
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
|
3361
|
+
# gateway_id: "sgw-gw-13B4567C",
|
3362
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
|
3363
|
+
# volume_id: "vol-1122AABB",
|
3364
|
+
# volume_size_in_bytes: 107374182400,
|
3365
|
+
# volume_type: "STORED",
|
3366
|
+
# },
|
3367
|
+
# ],
|
3368
|
+
# }
|
3369
|
+
#
|
2488
3370
|
# @example Request syntax with placeholder values
|
2489
3371
|
#
|
2490
3372
|
# resp = client.list_volumes({
|
@@ -2560,6 +3442,24 @@ module Aws::StorageGateway
|
|
2560
3442
|
#
|
2561
3443
|
# * {Types::RemoveTagsFromResourceOutput#resource_arn #resource_arn} => String
|
2562
3444
|
#
|
3445
|
+
#
|
3446
|
+
# @example Example: To remove tags from a resource
|
3447
|
+
#
|
3448
|
+
# # Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.
|
3449
|
+
#
|
3450
|
+
# resp = client.remove_tags_from_resource({
|
3451
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
3452
|
+
# tag_keys: [
|
3453
|
+
# "Dev Gatgeway Region",
|
3454
|
+
# "East Coast",
|
3455
|
+
# ],
|
3456
|
+
# })
|
3457
|
+
#
|
3458
|
+
# resp.to_h outputs the following:
|
3459
|
+
# {
|
3460
|
+
# resource_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
3461
|
+
# }
|
3462
|
+
#
|
2563
3463
|
# @example Request syntax with placeholder values
|
2564
3464
|
#
|
2565
3465
|
# resp = client.remove_tags_from_resource({
|
@@ -2603,6 +3503,20 @@ module Aws::StorageGateway
|
|
2603
3503
|
#
|
2604
3504
|
# * {Types::ResetCacheOutput#gateway_arn #gateway_arn} => String
|
2605
3505
|
#
|
3506
|
+
#
|
3507
|
+
# @example Example: To reset cache disks in error status
|
3508
|
+
#
|
3509
|
+
# # Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.
|
3510
|
+
#
|
3511
|
+
# resp = client.reset_cache({
|
3512
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
|
3513
|
+
# })
|
3514
|
+
#
|
3515
|
+
# resp.to_h outputs the following:
|
3516
|
+
# {
|
3517
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
|
3518
|
+
# }
|
3519
|
+
#
|
2606
3520
|
# @example Request syntax with placeholder values
|
2607
3521
|
#
|
2608
3522
|
# resp = client.reset_cache({
|
@@ -2650,6 +3564,21 @@ module Aws::StorageGateway
|
|
2650
3564
|
#
|
2651
3565
|
# * {Types::RetrieveTapeArchiveOutput#tape_arn #tape_arn} => String
|
2652
3566
|
#
|
3567
|
+
#
|
3568
|
+
# @example Example: To retrieve an archived tape from the VTS
|
3569
|
+
#
|
3570
|
+
# # 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.
|
3571
|
+
#
|
3572
|
+
# resp = client.retrieve_tape_archive({
|
3573
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3574
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF",
|
3575
|
+
# })
|
3576
|
+
#
|
3577
|
+
# resp.to_h outputs the following:
|
3578
|
+
# {
|
3579
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF",
|
3580
|
+
# }
|
3581
|
+
#
|
2653
3582
|
# @example Request syntax with placeholder values
|
2654
3583
|
#
|
2655
3584
|
# resp = client.retrieve_tape_archive({
|
@@ -2696,6 +3625,21 @@ module Aws::StorageGateway
|
|
2696
3625
|
#
|
2697
3626
|
# * {Types::RetrieveTapeRecoveryPointOutput#tape_arn #tape_arn} => String
|
2698
3627
|
#
|
3628
|
+
#
|
3629
|
+
# @example Example: To retrieve the recovery point of a virtual tape
|
3630
|
+
#
|
3631
|
+
# # Retrieves the recovery point for the specified virtual tape.
|
3632
|
+
#
|
3633
|
+
# resp = client.retrieve_tape_recovery_point({
|
3634
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3635
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF",
|
3636
|
+
# })
|
3637
|
+
#
|
3638
|
+
# resp.to_h outputs the following:
|
3639
|
+
# {
|
3640
|
+
# tape_arn: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF",
|
3641
|
+
# }
|
3642
|
+
#
|
2699
3643
|
# @example Request syntax with placeholder values
|
2700
3644
|
#
|
2701
3645
|
# resp = client.retrieve_tape_recovery_point({
|
@@ -2732,6 +3676,21 @@ module Aws::StorageGateway
|
|
2732
3676
|
#
|
2733
3677
|
# * {Types::SetLocalConsolePasswordOutput#gateway_arn #gateway_arn} => String
|
2734
3678
|
#
|
3679
|
+
#
|
3680
|
+
# @example Example: To set a password for your VM
|
3681
|
+
#
|
3682
|
+
# # Sets the password for your VM local console.
|
3683
|
+
#
|
3684
|
+
# resp = client.set_local_console_password({
|
3685
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3686
|
+
# local_console_password: "PassWordMustBeAtLeast6Chars.",
|
3687
|
+
# })
|
3688
|
+
#
|
3689
|
+
# resp.to_h outputs the following:
|
3690
|
+
# {
|
3691
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3692
|
+
# }
|
3693
|
+
#
|
2735
3694
|
# @example Request syntax with placeholder values
|
2736
3695
|
#
|
2737
3696
|
# resp = client.set_local_console_password({
|
@@ -2789,6 +3748,20 @@ module Aws::StorageGateway
|
|
2789
3748
|
#
|
2790
3749
|
# * {Types::ShutdownGatewayOutput#gateway_arn #gateway_arn} => String
|
2791
3750
|
#
|
3751
|
+
#
|
3752
|
+
# @example Example: To shut down a gateway service
|
3753
|
+
#
|
3754
|
+
# # This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
|
3755
|
+
#
|
3756
|
+
# resp = client.shutdown_gateway({
|
3757
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3758
|
+
# })
|
3759
|
+
#
|
3760
|
+
# resp.to_h outputs the following:
|
3761
|
+
# {
|
3762
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3763
|
+
# }
|
3764
|
+
#
|
2792
3765
|
# @example Request syntax with placeholder values
|
2793
3766
|
#
|
2794
3767
|
# resp = client.shutdown_gateway({
|
@@ -2832,6 +3805,20 @@ module Aws::StorageGateway
|
|
2832
3805
|
#
|
2833
3806
|
# * {Types::StartGatewayOutput#gateway_arn #gateway_arn} => String
|
2834
3807
|
#
|
3808
|
+
#
|
3809
|
+
# @example Example: To start a gateway service
|
3810
|
+
#
|
3811
|
+
# # Starts a gateway service that was previously shut down.
|
3812
|
+
#
|
3813
|
+
# resp = client.start_gateway({
|
3814
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3815
|
+
# })
|
3816
|
+
#
|
3817
|
+
# resp.to_h outputs the following:
|
3818
|
+
# {
|
3819
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
3820
|
+
# }
|
3821
|
+
#
|
2835
3822
|
# @example Request syntax with placeholder values
|
2836
3823
|
#
|
2837
3824
|
# resp = client.start_gateway({
|
@@ -2878,6 +3865,22 @@ module Aws::StorageGateway
|
|
2878
3865
|
#
|
2879
3866
|
# * {Types::UpdateBandwidthRateLimitOutput#gateway_arn #gateway_arn} => String
|
2880
3867
|
#
|
3868
|
+
#
|
3869
|
+
# @example Example: To update the bandwidth rate limits of a gateway
|
3870
|
+
#
|
3871
|
+
# # 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.
|
3872
|
+
#
|
3873
|
+
# resp = client.update_bandwidth_rate_limit({
|
3874
|
+
# average_download_rate_limit_in_bits_per_sec: 102400,
|
3875
|
+
# average_upload_rate_limit_in_bits_per_sec: 51200,
|
3876
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3877
|
+
# })
|
3878
|
+
#
|
3879
|
+
# resp.to_h outputs the following:
|
3880
|
+
# {
|
3881
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
3882
|
+
# }
|
3883
|
+
#
|
2881
3884
|
# @example Request syntax with placeholder values
|
2882
3885
|
#
|
2883
3886
|
# resp = client.update_bandwidth_rate_limit({
|
@@ -2938,6 +3941,24 @@ module Aws::StorageGateway
|
|
2938
3941
|
# * {Types::UpdateChapCredentialsOutput#target_arn #target_arn} => String
|
2939
3942
|
# * {Types::UpdateChapCredentialsOutput#initiator_name #initiator_name} => String
|
2940
3943
|
#
|
3944
|
+
#
|
3945
|
+
# @example Example: To update CHAP credentials for an iSCSI target
|
3946
|
+
#
|
3947
|
+
# # Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
3948
|
+
#
|
3949
|
+
# resp = client.update_chap_credentials({
|
3950
|
+
# initiator_name: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
3951
|
+
# secret_to_authenticate_initiator: "111111111111",
|
3952
|
+
# secret_to_authenticate_target: "222222222222",
|
3953
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
3954
|
+
# })
|
3955
|
+
#
|
3956
|
+
# resp.to_h outputs the following:
|
3957
|
+
# {
|
3958
|
+
# initiator_name: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
3959
|
+
# target_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
|
3960
|
+
# }
|
3961
|
+
#
|
2941
3962
|
# @example Request syntax with placeholder values
|
2942
3963
|
#
|
2943
3964
|
# resp = client.update_chap_credentials({
|
@@ -2985,6 +4006,23 @@ module Aws::StorageGateway
|
|
2985
4006
|
# * {Types::UpdateGatewayInformationOutput#gateway_arn #gateway_arn} => String
|
2986
4007
|
# * {Types::UpdateGatewayInformationOutput#gateway_name #gateway_name} => String
|
2987
4008
|
#
|
4009
|
+
#
|
4010
|
+
# @example Example: To update a gateway's metadata
|
4011
|
+
#
|
4012
|
+
# # Updates a gateway's metadata, which includes the gateway's name and time zone.
|
4013
|
+
#
|
4014
|
+
# resp = client.update_gateway_information({
|
4015
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4016
|
+
# gateway_name: "MyGateway2",
|
4017
|
+
# gateway_timezone: "GMT-12:00",
|
4018
|
+
# })
|
4019
|
+
#
|
4020
|
+
# resp.to_h outputs the following:
|
4021
|
+
# {
|
4022
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4023
|
+
# gateway_name: "",
|
4024
|
+
# }
|
4025
|
+
#
|
2988
4026
|
# @example Request syntax with placeholder values
|
2989
4027
|
#
|
2990
4028
|
# resp = client.update_gateway_information({
|
@@ -3037,6 +4075,20 @@ module Aws::StorageGateway
|
|
3037
4075
|
#
|
3038
4076
|
# * {Types::UpdateGatewaySoftwareNowOutput#gateway_arn #gateway_arn} => String
|
3039
4077
|
#
|
4078
|
+
#
|
4079
|
+
# @example Example: To update a gateway's VM software
|
4080
|
+
#
|
4081
|
+
# # Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
|
4082
|
+
#
|
4083
|
+
# resp = client.update_gateway_software_now({
|
4084
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4085
|
+
# })
|
4086
|
+
#
|
4087
|
+
# resp.to_h outputs the following:
|
4088
|
+
# {
|
4089
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4090
|
+
# }
|
4091
|
+
#
|
3040
4092
|
# @example Request syntax with placeholder values
|
3041
4093
|
#
|
3042
4094
|
# resp = client.update_gateway_software_now({
|
@@ -3082,6 +4134,23 @@ module Aws::StorageGateway
|
|
3082
4134
|
#
|
3083
4135
|
# * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #gateway_arn} => String
|
3084
4136
|
#
|
4137
|
+
#
|
4138
|
+
# @example Example: To update a gateway's maintenance start time
|
4139
|
+
#
|
4140
|
+
# # 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.
|
4141
|
+
#
|
4142
|
+
# resp = client.update_maintenance_start_time({
|
4143
|
+
# day_of_week: 2,
|
4144
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4145
|
+
# hour_of_day: 0,
|
4146
|
+
# minute_of_hour: 30,
|
4147
|
+
# })
|
4148
|
+
#
|
4149
|
+
# resp.to_h outputs the following:
|
4150
|
+
# {
|
4151
|
+
# gateway_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
4152
|
+
# }
|
4153
|
+
#
|
3085
4154
|
# @example Request syntax with placeholder values
|
3086
4155
|
#
|
3087
4156
|
# resp = client.update_maintenance_start_time({
|
@@ -3234,6 +4303,23 @@ module Aws::StorageGateway
|
|
3234
4303
|
#
|
3235
4304
|
# * {Types::UpdateSnapshotScheduleOutput#volume_arn #volume_arn} => String
|
3236
4305
|
#
|
4306
|
+
#
|
4307
|
+
# @example Example: To update a volume snapshot schedule
|
4308
|
+
#
|
4309
|
+
# # Updates a snapshot schedule configured for a gateway volume.
|
4310
|
+
#
|
4311
|
+
# resp = client.update_snapshot_schedule({
|
4312
|
+
# description: "Hourly snapshot",
|
4313
|
+
# recurrence_in_hours: 1,
|
4314
|
+
# start_at: 0,
|
4315
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
4316
|
+
# })
|
4317
|
+
#
|
4318
|
+
# resp.to_h outputs the following:
|
4319
|
+
# {
|
4320
|
+
# volume_arn: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
4321
|
+
# }
|
4322
|
+
#
|
3237
4323
|
# @example Request syntax with placeholder values
|
3238
4324
|
#
|
3239
4325
|
# resp = client.update_snapshot_schedule({
|
@@ -3275,6 +4361,21 @@ module Aws::StorageGateway
|
|
3275
4361
|
#
|
3276
4362
|
# * {Types::UpdateVTLDeviceTypeOutput#vtl_device_arn #vtl_device_arn} => String
|
3277
4363
|
#
|
4364
|
+
#
|
4365
|
+
# @example Example: To update a VTL device type
|
4366
|
+
#
|
4367
|
+
# # Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.
|
4368
|
+
#
|
4369
|
+
# resp = client.update_vtl_device_type({
|
4370
|
+
# device_type: "Medium Changer",
|
4371
|
+
# vtl_device_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
|
4372
|
+
# })
|
4373
|
+
#
|
4374
|
+
# resp.to_h outputs the following:
|
4375
|
+
# {
|
4376
|
+
# vtl_device_arn: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
|
4377
|
+
# }
|
4378
|
+
#
|
3278
4379
|
# @example Request syntax with placeholder values
|
3279
4380
|
#
|
3280
4381
|
# resp = client.update_vtl_device_type({
|
@@ -3308,7 +4409,7 @@ module Aws::StorageGateway
|
|
3308
4409
|
params: params,
|
3309
4410
|
config: config)
|
3310
4411
|
context[:gem_name] = 'aws-sdk-storagegateway'
|
3311
|
-
context[:gem_version] = '1.0.0.
|
4412
|
+
context[:gem_version] = '1.0.0.rc9'
|
3312
4413
|
Seahorse::Client::Request.new(handlers, context)
|
3313
4414
|
end
|
3314
4415
|
|