aws-sdk-storagegateway 1.46.0 → 1.47.0
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 +215 -17
- data/lib/aws-sdk-storagegateway/client_api.rb +96 -0
- data/lib/aws-sdk-storagegateway/types.rb +355 -23
- metadata +2 -2
@@ -111,7 +111,7 @@ module Aws::StorageGateway
|
|
111
111
|
# The value that indicates the type of medium changer to use for tape
|
112
112
|
# gateway. This field is optional.
|
113
113
|
#
|
114
|
-
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
114
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
|
115
115
|
# @return [String]
|
116
116
|
#
|
117
117
|
# @!attribute [rw] tags
|
@@ -368,6 +368,7 @@ module Aws::StorageGateway
|
|
368
368
|
# {
|
369
369
|
# tape_arn: "TapeARN", # required
|
370
370
|
# pool_id: "PoolId", # required
|
371
|
+
# bypass_governance_retention: false,
|
371
372
|
# }
|
372
373
|
#
|
373
374
|
# @!attribute [rw] tape_arn
|
@@ -386,11 +387,23 @@ module Aws::StorageGateway
|
|
386
387
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
387
388
|
# @return [String]
|
388
389
|
#
|
390
|
+
# @!attribute [rw] bypass_governance_retention
|
391
|
+
# Set permissions to bypass governance retention. If the lock type of
|
392
|
+
# the archived tape is `Governance`, the tape's archived age is not
|
393
|
+
# older than `RetentionLockInDays`, and the user does not already have
|
394
|
+
# `BypassGovernanceRetention`, setting this to TRUE enables the user
|
395
|
+
# to bypass the retention lock. This parameter is set to true by
|
396
|
+
# default for calls from the console.
|
397
|
+
#
|
398
|
+
# Valid values: `TRUE` \| `FALSE`
|
399
|
+
# @return [Boolean]
|
400
|
+
#
|
389
401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePoolInput AWS API Documentation
|
390
402
|
#
|
391
403
|
class AssignTapePoolInput < Struct.new(
|
392
404
|
:tape_arn,
|
393
|
-
:pool_id
|
405
|
+
:pool_id,
|
406
|
+
:bypass_governance_retention)
|
394
407
|
SENSITIVE = []
|
395
408
|
include Aws::Structure
|
396
409
|
end
|
@@ -517,7 +530,13 @@ module Aws::StorageGateway
|
|
517
530
|
end
|
518
531
|
|
519
532
|
# An automatic tape creation policy consists of automatic tape creation
|
520
|
-
# rules where each rule defines when and how to create new tapes.
|
533
|
+
# rules where each rule defines when and how to create new tapes. For
|
534
|
+
# more information about automatic tape creation, see [Creating Tapes
|
535
|
+
# Automatically][1].
|
536
|
+
#
|
537
|
+
#
|
538
|
+
#
|
539
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically
|
521
540
|
#
|
522
541
|
# @note When making an API call, you may pass AutomaticTapeCreationRule
|
523
542
|
# data as a hash:
|
@@ -527,6 +546,7 @@ module Aws::StorageGateway
|
|
527
546
|
# pool_id: "PoolId", # required
|
528
547
|
# tape_size_in_bytes: 1, # required
|
529
548
|
# minimum_num_tapes: 1, # required
|
549
|
+
# worm: false,
|
530
550
|
# }
|
531
551
|
#
|
532
552
|
# @!attribute [rw] tape_barcode_prefix
|
@@ -558,16 +578,29 @@ module Aws::StorageGateway
|
|
558
578
|
# The minimum number of available virtual tapes that the gateway
|
559
579
|
# maintains at all times. If the number of tapes on the gateway goes
|
560
580
|
# below this value, the gateway creates as many new tapes as are
|
561
|
-
# needed to have `MinimumNumTapes` on the gateway.
|
581
|
+
# needed to have `MinimumNumTapes` on the gateway. For more
|
582
|
+
# information about automatic tape creation, see [Creating Tapes
|
583
|
+
# Automatically][1].
|
584
|
+
#
|
585
|
+
#
|
586
|
+
#
|
587
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically
|
562
588
|
# @return [Integer]
|
563
589
|
#
|
590
|
+
# @!attribute [rw] worm
|
591
|
+
# Set to `true` to indicate that tapes are to be archived as
|
592
|
+
# write-once-read-many (WORM). Set to `false` when WORM is not enabled
|
593
|
+
# for tapes.
|
594
|
+
# @return [Boolean]
|
595
|
+
#
|
564
596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AutomaticTapeCreationRule AWS API Documentation
|
565
597
|
#
|
566
598
|
class AutomaticTapeCreationRule < Struct.new(
|
567
599
|
:tape_barcode_prefix,
|
568
600
|
:pool_id,
|
569
601
|
:tape_size_in_bytes,
|
570
|
-
:minimum_num_tapes
|
602
|
+
:minimum_num_tapes,
|
603
|
+
:worm)
|
571
604
|
SENSITIVE = []
|
572
605
|
include Aws::Structure
|
573
606
|
end
|
@@ -606,7 +639,7 @@ module Aws::StorageGateway
|
|
606
639
|
# @return [String]
|
607
640
|
#
|
608
641
|
# @!attribute [rw] volume_id
|
609
|
-
# The unique identifier of the volume, e.g
|
642
|
+
# The unique identifier of the volume, e.g., vol-AE4B946D.
|
610
643
|
# @return [String]
|
611
644
|
#
|
612
645
|
# @!attribute [rw] volume_type
|
@@ -642,7 +675,7 @@ module Aws::StorageGateway
|
|
642
675
|
#
|
643
676
|
# @!attribute [rw] source_snapshot_id
|
644
677
|
# If the cached volume was created from a snapshot, this field
|
645
|
-
# contains the snapshot ID used, e.g
|
678
|
+
# contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this
|
646
679
|
# field is not included.
|
647
680
|
# @return [String]
|
648
681
|
#
|
@@ -653,7 +686,7 @@ module Aws::StorageGateway
|
|
653
686
|
#
|
654
687
|
# @!attribute [rw] created_date
|
655
688
|
# The date the volume was created. Volumes created prior to March 28,
|
656
|
-
# 2017 don’t have this
|
689
|
+
# 2017 don’t have this timestamp.
|
657
690
|
# @return [Time]
|
658
691
|
#
|
659
692
|
# @!attribute [rw] volume_used_in_bytes
|
@@ -821,7 +854,7 @@ module Aws::StorageGateway
|
|
821
854
|
#
|
822
855
|
# @!attribute [rw] secret_to_authenticate_target
|
823
856
|
# The secret key that the target must provide to participate in mutual
|
824
|
-
# CHAP with the initiator (e.g
|
857
|
+
# CHAP with the initiator (e.g., Windows client).
|
825
858
|
# @return [String]
|
826
859
|
#
|
827
860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ChapInfo AWS API Documentation
|
@@ -1730,6 +1763,84 @@ module Aws::StorageGateway
|
|
1730
1763
|
include Aws::Structure
|
1731
1764
|
end
|
1732
1765
|
|
1766
|
+
# @note When making an API call, you may pass CreateTapePoolInput
|
1767
|
+
# data as a hash:
|
1768
|
+
#
|
1769
|
+
# {
|
1770
|
+
# pool_name: "PoolName", # required
|
1771
|
+
# storage_class: "DEEP_ARCHIVE", # required, accepts DEEP_ARCHIVE, GLACIER
|
1772
|
+
# retention_lock_type: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE, NONE
|
1773
|
+
# retention_lock_time_in_days: 1,
|
1774
|
+
# tags: [
|
1775
|
+
# {
|
1776
|
+
# key: "TagKey", # required
|
1777
|
+
# value: "TagValue", # required
|
1778
|
+
# },
|
1779
|
+
# ],
|
1780
|
+
# }
|
1781
|
+
#
|
1782
|
+
# @!attribute [rw] pool_name
|
1783
|
+
# The name of the new custom tape pool.
|
1784
|
+
# @return [String]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] storage_class
|
1787
|
+
# The storage class that is associated with the new custom pool. When
|
1788
|
+
# you use your backup application to eject the tape, the tape is
|
1789
|
+
# archived directly into the storage class (S3 Glacier or S3 Glacier
|
1790
|
+
# Deep Archive) that corresponds to the pool.
|
1791
|
+
# @return [String]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] retention_lock_type
|
1794
|
+
# Tape retention lock can be configured in two modes. When configured
|
1795
|
+
# in governance mode, AWS accounts with specific IAM permissions are
|
1796
|
+
# authorized to remove the tape retention lock from archived virtual
|
1797
|
+
# tapes. When configured in compliance mode, the tape retention lock
|
1798
|
+
# cannot be removed by any user, including the root AWS account.
|
1799
|
+
# @return [String]
|
1800
|
+
#
|
1801
|
+
# @!attribute [rw] retention_lock_time_in_days
|
1802
|
+
# Tape retention lock time is set in days. Tape retention lock can be
|
1803
|
+
# enabled for up to 100 years (36,500 days).
|
1804
|
+
# @return [Integer]
|
1805
|
+
#
|
1806
|
+
# @!attribute [rw] tags
|
1807
|
+
# A list of up to 50 tags that can be assigned to tape pool. Each tag
|
1808
|
+
# is a key-value pair.
|
1809
|
+
#
|
1810
|
+
# <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
|
1811
|
+
# representable in UTF-8 format, and the following special characters:
|
1812
|
+
# + - = . \_ : / @. The maximum length of a tag's key is 128
|
1813
|
+
# characters, and the maximum length for a tag's value is 256.
|
1814
|
+
#
|
1815
|
+
# </note>
|
1816
|
+
# @return [Array<Types::Tag>]
|
1817
|
+
#
|
1818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePoolInput AWS API Documentation
|
1819
|
+
#
|
1820
|
+
class CreateTapePoolInput < Struct.new(
|
1821
|
+
:pool_name,
|
1822
|
+
:storage_class,
|
1823
|
+
:retention_lock_type,
|
1824
|
+
:retention_lock_time_in_days,
|
1825
|
+
:tags)
|
1826
|
+
SENSITIVE = []
|
1827
|
+
include Aws::Structure
|
1828
|
+
end
|
1829
|
+
|
1830
|
+
# @!attribute [rw] pool_arn
|
1831
|
+
# The unique Amazon Resource Name (ARN) that represents the custom
|
1832
|
+
# tape pool. Use the ListTapePools operation to return a list of tape
|
1833
|
+
# pools for your account and AWS Region.
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePoolOutput AWS API Documentation
|
1837
|
+
#
|
1838
|
+
class CreateTapePoolOutput < Struct.new(
|
1839
|
+
:pool_arn)
|
1840
|
+
SENSITIVE = []
|
1841
|
+
include Aws::Structure
|
1842
|
+
end
|
1843
|
+
|
1733
1844
|
# CreateTapeWithBarcodeInput
|
1734
1845
|
#
|
1735
1846
|
# @note When making an API call, you may pass CreateTapeWithBarcodeInput
|
@@ -1742,6 +1853,7 @@ module Aws::StorageGateway
|
|
1742
1853
|
# kms_encrypted: false,
|
1743
1854
|
# kms_key: "KMSKey",
|
1744
1855
|
# pool_id: "PoolId",
|
1856
|
+
# worm: false,
|
1745
1857
|
# tags: [
|
1746
1858
|
# {
|
1747
1859
|
# key: "TagKey", # required
|
@@ -1797,6 +1909,11 @@ module Aws::StorageGateway
|
|
1797
1909
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1798
1910
|
# @return [String]
|
1799
1911
|
#
|
1912
|
+
# @!attribute [rw] worm
|
1913
|
+
# Set to `TRUE` if the tape you are creating is to be configured as a
|
1914
|
+
# write-once-read-many (WORM) tape.
|
1915
|
+
# @return [Boolean]
|
1916
|
+
#
|
1800
1917
|
# @!attribute [rw] tags
|
1801
1918
|
# A list of up to 50 tags that can be assigned to a virtual tape that
|
1802
1919
|
# has a barcode. Each tag is a key-value pair.
|
@@ -1818,6 +1935,7 @@ module Aws::StorageGateway
|
|
1818
1935
|
:kms_encrypted,
|
1819
1936
|
:kms_key,
|
1820
1937
|
:pool_id,
|
1938
|
+
:worm,
|
1821
1939
|
:tags)
|
1822
1940
|
SENSITIVE = []
|
1823
1941
|
include Aws::Structure
|
@@ -1852,6 +1970,7 @@ module Aws::StorageGateway
|
|
1852
1970
|
# kms_encrypted: false,
|
1853
1971
|
# kms_key: "KMSKey",
|
1854
1972
|
# pool_id: "PoolId",
|
1973
|
+
# worm: false,
|
1855
1974
|
# tags: [
|
1856
1975
|
# {
|
1857
1976
|
# key: "TagKey", # required
|
@@ -1924,6 +2043,11 @@ module Aws::StorageGateway
|
|
1924
2043
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1925
2044
|
# @return [String]
|
1926
2045
|
#
|
2046
|
+
# @!attribute [rw] worm
|
2047
|
+
# Set to `TRUE` if the tape you are creating is to be configured as a
|
2048
|
+
# write-once-read-many (WORM) tape.
|
2049
|
+
# @return [Boolean]
|
2050
|
+
#
|
1927
2051
|
# @!attribute [rw] tags
|
1928
2052
|
# A list of up to 50 tags that can be assigned to a virtual tape. Each
|
1929
2053
|
# tag is a key-value pair.
|
@@ -1947,6 +2071,7 @@ module Aws::StorageGateway
|
|
1947
2071
|
:kms_encrypted,
|
1948
2072
|
:kms_key,
|
1949
2073
|
:pool_id,
|
2074
|
+
:worm,
|
1950
2075
|
:tags)
|
1951
2076
|
SENSITIVE = []
|
1952
2077
|
include Aws::Structure
|
@@ -2026,7 +2151,7 @@ module Aws::StorageGateway
|
|
2026
2151
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
2027
2152
|
# rate limit to delete.
|
2028
2153
|
#
|
2029
|
-
# Valid Values: `
|
2154
|
+
# Valid Values: `UPLOAD` \| `DOWNLOAD` \| `ALL`
|
2030
2155
|
# @return [String]
|
2031
2156
|
#
|
2032
2157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimitInput AWS API Documentation
|
@@ -2231,6 +2356,7 @@ module Aws::StorageGateway
|
|
2231
2356
|
#
|
2232
2357
|
# {
|
2233
2358
|
# tape_arn: "TapeARN", # required
|
2359
|
+
# bypass_governance_retention: false,
|
2234
2360
|
# }
|
2235
2361
|
#
|
2236
2362
|
# @!attribute [rw] tape_arn
|
@@ -2238,10 +2364,18 @@ module Aws::StorageGateway
|
|
2238
2364
|
# the virtual tape shelf (VTS).
|
2239
2365
|
# @return [String]
|
2240
2366
|
#
|
2367
|
+
# @!attribute [rw] bypass_governance_retention
|
2368
|
+
# Set to `TRUE` to delete an archived tape that belongs to a custom
|
2369
|
+
# pool with tape retention lock. Only archived tapes with tape
|
2370
|
+
# retention lock set to `governance` can be deleted. Archived tapes
|
2371
|
+
# with tape retention lock set to `compliance` can't be deleted.
|
2372
|
+
# @return [Boolean]
|
2373
|
+
#
|
2241
2374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapeArchiveInput AWS API Documentation
|
2242
2375
|
#
|
2243
2376
|
class DeleteTapeArchiveInput < Struct.new(
|
2244
|
-
:tape_arn
|
2377
|
+
:tape_arn,
|
2378
|
+
:bypass_governance_retention)
|
2245
2379
|
SENSITIVE = []
|
2246
2380
|
include Aws::Structure
|
2247
2381
|
end
|
@@ -2269,6 +2403,7 @@ module Aws::StorageGateway
|
|
2269
2403
|
# {
|
2270
2404
|
# gateway_arn: "GatewayARN", # required
|
2271
2405
|
# tape_arn: "TapeARN", # required
|
2406
|
+
# bypass_governance_retention: false,
|
2272
2407
|
# }
|
2273
2408
|
#
|
2274
2409
|
# @!attribute [rw] gateway_arn
|
@@ -2282,11 +2417,19 @@ module Aws::StorageGateway
|
|
2282
2417
|
# The Amazon Resource Name (ARN) of the virtual tape to delete.
|
2283
2418
|
# @return [String]
|
2284
2419
|
#
|
2420
|
+
# @!attribute [rw] bypass_governance_retention
|
2421
|
+
# Set to `TRUE` to delete an archived tape that belongs to a custom
|
2422
|
+
# pool with tape retention lock. Only archived tapes with tape
|
2423
|
+
# retention lock set to `governance` can be deleted. Archived tapes
|
2424
|
+
# with tape retention lock set to `compliance` can't be deleted.
|
2425
|
+
# @return [Boolean]
|
2426
|
+
#
|
2285
2427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapeInput AWS API Documentation
|
2286
2428
|
#
|
2287
2429
|
class DeleteTapeInput < Struct.new(
|
2288
2430
|
:gateway_arn,
|
2289
|
-
:tape_arn
|
2431
|
+
:tape_arn,
|
2432
|
+
:bypass_governance_retention)
|
2290
2433
|
SENSITIVE = []
|
2291
2434
|
include Aws::Structure
|
2292
2435
|
end
|
@@ -2305,6 +2448,38 @@ module Aws::StorageGateway
|
|
2305
2448
|
include Aws::Structure
|
2306
2449
|
end
|
2307
2450
|
|
2451
|
+
# @note When making an API call, you may pass DeleteTapePoolInput
|
2452
|
+
# data as a hash:
|
2453
|
+
#
|
2454
|
+
# {
|
2455
|
+
# pool_arn: "PoolARN", # required
|
2456
|
+
# }
|
2457
|
+
#
|
2458
|
+
# @!attribute [rw] pool_arn
|
2459
|
+
# The Amazon Resource Name (ARN) of the custom tape pool to delete.
|
2460
|
+
# @return [String]
|
2461
|
+
#
|
2462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapePoolInput AWS API Documentation
|
2463
|
+
#
|
2464
|
+
class DeleteTapePoolInput < Struct.new(
|
2465
|
+
:pool_arn)
|
2466
|
+
SENSITIVE = []
|
2467
|
+
include Aws::Structure
|
2468
|
+
end
|
2469
|
+
|
2470
|
+
# @!attribute [rw] pool_arn
|
2471
|
+
# The Amazon Resource Name (ARN) of the custom tape pool being
|
2472
|
+
# deleted.
|
2473
|
+
# @return [String]
|
2474
|
+
#
|
2475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapePoolOutput AWS API Documentation
|
2476
|
+
#
|
2477
|
+
class DeleteTapePoolOutput < Struct.new(
|
2478
|
+
:pool_arn)
|
2479
|
+
SENSITIVE = []
|
2480
|
+
include Aws::Structure
|
2481
|
+
end
|
2482
|
+
|
2308
2483
|
# A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
|
2309
2484
|
#
|
2310
2485
|
# @note When making an API call, you may pass DeleteVolumeInput
|
@@ -2704,7 +2879,7 @@ module Aws::StorageGateway
|
|
2704
2879
|
# @return [String]
|
2705
2880
|
#
|
2706
2881
|
# @!attribute [rw] cloud_watch_log_group_arn
|
2707
|
-
# The Amazon Resource Name (ARN) of the Amazon CloudWatch
|
2882
|
+
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
|
2708
2883
|
# that is used to monitor events in the gateway.
|
2709
2884
|
# @return [String]
|
2710
2885
|
#
|
@@ -4213,7 +4388,7 @@ module Aws::StorageGateway
|
|
4213
4388
|
# ListTagsForResourceOutput
|
4214
4389
|
#
|
4215
4390
|
# @!attribute [rw] resource_arn
|
4216
|
-
#
|
4391
|
+
# The Amazon Resource Name (ARN) of the resource for which you want to
|
4217
4392
|
# list tags.
|
4218
4393
|
# @return [String]
|
4219
4394
|
#
|
@@ -4236,6 +4411,63 @@ module Aws::StorageGateway
|
|
4236
4411
|
include Aws::Structure
|
4237
4412
|
end
|
4238
4413
|
|
4414
|
+
# @note When making an API call, you may pass ListTapePoolsInput
|
4415
|
+
# data as a hash:
|
4416
|
+
#
|
4417
|
+
# {
|
4418
|
+
# pool_arns: ["PoolARN"],
|
4419
|
+
# marker: "Marker",
|
4420
|
+
# limit: 1,
|
4421
|
+
# }
|
4422
|
+
#
|
4423
|
+
# @!attribute [rw] pool_arns
|
4424
|
+
# The Amazon Resource Name (ARN) of each of the custom tape pools you
|
4425
|
+
# want to list. If you don't specify a custom tape pool ARN, the
|
4426
|
+
# response lists all custom tape pools.
|
4427
|
+
# @return [Array<String>]
|
4428
|
+
#
|
4429
|
+
# @!attribute [rw] marker
|
4430
|
+
# A string that indicates the position at which to begin the returned
|
4431
|
+
# list of tape pools.
|
4432
|
+
# @return [String]
|
4433
|
+
#
|
4434
|
+
# @!attribute [rw] limit
|
4435
|
+
# An optional number limit for the tape pools in the list returned by
|
4436
|
+
# this call.
|
4437
|
+
# @return [Integer]
|
4438
|
+
#
|
4439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapePoolsInput AWS API Documentation
|
4440
|
+
#
|
4441
|
+
class ListTapePoolsInput < Struct.new(
|
4442
|
+
:pool_arns,
|
4443
|
+
:marker,
|
4444
|
+
:limit)
|
4445
|
+
SENSITIVE = []
|
4446
|
+
include Aws::Structure
|
4447
|
+
end
|
4448
|
+
|
4449
|
+
# @!attribute [rw] pool_infos
|
4450
|
+
# An array of `PoolInfo` objects, where each object describes a single
|
4451
|
+
# custom tape pool. If there are no custom tape pools, the `PoolInfos`
|
4452
|
+
# is an empty array.
|
4453
|
+
# @return [Array<Types::PoolInfo>]
|
4454
|
+
#
|
4455
|
+
# @!attribute [rw] marker
|
4456
|
+
# A string that indicates the position at which to begin the returned
|
4457
|
+
# list of tape pools. Use the marker in your next request to continue
|
4458
|
+
# pagination of tape pools. If there are no more tape pools to list,
|
4459
|
+
# this element does not appear in the response body.
|
4460
|
+
# @return [String]
|
4461
|
+
#
|
4462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapePoolsOutput AWS API Documentation
|
4463
|
+
#
|
4464
|
+
class ListTapePoolsOutput < Struct.new(
|
4465
|
+
:pool_infos,
|
4466
|
+
:marker)
|
4467
|
+
SENSITIVE = []
|
4468
|
+
include Aws::Structure
|
4469
|
+
end
|
4470
|
+
|
4239
4471
|
# A JSON object that contains one or more of the following fields:
|
4240
4472
|
#
|
4241
4473
|
# * ListTapesInput$Limit
|
@@ -4748,6 +4980,57 @@ module Aws::StorageGateway
|
|
4748
4980
|
include Aws::Structure
|
4749
4981
|
end
|
4750
4982
|
|
4983
|
+
# Describes a custom tape pool.
|
4984
|
+
#
|
4985
|
+
# @!attribute [rw] pool_arn
|
4986
|
+
# The Amazon Resource Name (ARN) of the custom tape pool. Use the
|
4987
|
+
# ListTapePools operation to return a list of custom tape pools for
|
4988
|
+
# your account and AWS Region.
|
4989
|
+
# @return [String]
|
4990
|
+
#
|
4991
|
+
# @!attribute [rw] pool_name
|
4992
|
+
# The name of the custom tape pool. `PoolName` can use all ASCII
|
4993
|
+
# characters, except '/' and '\\'.
|
4994
|
+
# @return [String]
|
4995
|
+
#
|
4996
|
+
# @!attribute [rw] storage_class
|
4997
|
+
# The storage class that is associated with the custom pool. When you
|
4998
|
+
# use your backup application to eject the tape, the tape is archived
|
4999
|
+
# directly into the storage class (S3 Glacier or S3 Glacier Deep
|
5000
|
+
# Archive) that corresponds to the pool.
|
5001
|
+
# @return [String]
|
5002
|
+
#
|
5003
|
+
# @!attribute [rw] retention_lock_type
|
5004
|
+
# Tape retention lock type, which can be configured in two modes. When
|
5005
|
+
# configured in governance mode, AWS accounts with specific IAM
|
5006
|
+
# permissions are authorized to remove the tape retention lock from
|
5007
|
+
# archived virtual tapes. When configured in compliance mode, the tape
|
5008
|
+
# retention lock cannot be removed by any user, including the root AWS
|
5009
|
+
# account.
|
5010
|
+
# @return [String]
|
5011
|
+
#
|
5012
|
+
# @!attribute [rw] retention_lock_time_in_days
|
5013
|
+
# Tape retention lock time is set in days. Tape retention lock can be
|
5014
|
+
# enabled for up to 100 years (36,500 days).
|
5015
|
+
# @return [Integer]
|
5016
|
+
#
|
5017
|
+
# @!attribute [rw] pool_status
|
5018
|
+
# Status of the custom tape pool. Pool can be `ACTIVE` or `DELETED`.
|
5019
|
+
# @return [String]
|
5020
|
+
#
|
5021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/PoolInfo AWS API Documentation
|
5022
|
+
#
|
5023
|
+
class PoolInfo < Struct.new(
|
5024
|
+
:pool_arn,
|
5025
|
+
:pool_name,
|
5026
|
+
:storage_class,
|
5027
|
+
:retention_lock_type,
|
5028
|
+
:retention_lock_time_in_days,
|
5029
|
+
:pool_status)
|
5030
|
+
SENSITIVE = []
|
5031
|
+
include Aws::Structure
|
5032
|
+
end
|
5033
|
+
|
4751
5034
|
# RefreshCacheInput
|
4752
5035
|
#
|
4753
5036
|
# @note When making an API call, you may pass RefreshCacheInput
|
@@ -5448,7 +5731,7 @@ module Aws::StorageGateway
|
|
5448
5731
|
# @return [String]
|
5449
5732
|
#
|
5450
5733
|
# @!attribute [rw] volume_id
|
5451
|
-
# The unique identifier of the volume, e.g
|
5734
|
+
# The unique identifier of the volume, e.g., vol-AE4B946D.
|
5452
5735
|
# @return [String]
|
5453
5736
|
#
|
5454
5737
|
# @!attribute [rw] volume_type
|
@@ -5508,7 +5791,7 @@ module Aws::StorageGateway
|
|
5508
5791
|
#
|
5509
5792
|
# @!attribute [rw] created_date
|
5510
5793
|
# The date the volume was created. Volumes created prior to March 28,
|
5511
|
-
# 2017 don’t have this
|
5794
|
+
# 2017 don’t have this timestamp.
|
5512
5795
|
# @return [Time]
|
5513
5796
|
#
|
5514
5797
|
# @!attribute [rw] volume_used_in_bytes
|
@@ -5655,6 +5938,20 @@ module Aws::StorageGateway
|
|
5655
5938
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5656
5939
|
# @return [String]
|
5657
5940
|
#
|
5941
|
+
# @!attribute [rw] worm
|
5942
|
+
# If the tape is archived as write-once-read-many (WORM), this value
|
5943
|
+
# is `true`.
|
5944
|
+
# @return [Boolean]
|
5945
|
+
#
|
5946
|
+
# @!attribute [rw] retention_start_date
|
5947
|
+
# The date that the tape is first archived with tape retention lock
|
5948
|
+
# enabled.
|
5949
|
+
# @return [Time]
|
5950
|
+
#
|
5951
|
+
# @!attribute [rw] pool_entry_date
|
5952
|
+
# The date that the tape enters a custom tape pool.
|
5953
|
+
# @return [Time]
|
5954
|
+
#
|
5658
5955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/Tape AWS API Documentation
|
5659
5956
|
#
|
5660
5957
|
class Tape < Struct.new(
|
@@ -5667,7 +5964,10 @@ module Aws::StorageGateway
|
|
5667
5964
|
:progress,
|
5668
5965
|
:tape_used_in_bytes,
|
5669
5966
|
:kms_key,
|
5670
|
-
:pool_id
|
5967
|
+
:pool_id,
|
5968
|
+
:worm,
|
5969
|
+
:retention_start_date,
|
5970
|
+
:pool_entry_date)
|
5671
5971
|
SENSITIVE = []
|
5672
5972
|
include Aws::Structure
|
5673
5973
|
end
|
@@ -5694,7 +5994,7 @@ module Aws::StorageGateway
|
|
5694
5994
|
# @!attribute [rw] completion_time
|
5695
5995
|
# The time that the archiving of the virtual tape was completed.
|
5696
5996
|
#
|
5697
|
-
# The default
|
5997
|
+
# The default timestamp format is in the ISO8601 extended
|
5698
5998
|
# YYYY-MM-DD'T'HH:MM:SS'Z' format.
|
5699
5999
|
# @return [Time]
|
5700
6000
|
#
|
@@ -5732,6 +6032,23 @@ module Aws::StorageGateway
|
|
5732
6032
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5733
6033
|
# @return [String]
|
5734
6034
|
#
|
6035
|
+
# @!attribute [rw] worm
|
6036
|
+
# Set to `true` if the archived tape is stored as write-once-read-many
|
6037
|
+
# (WORM).
|
6038
|
+
# @return [Boolean]
|
6039
|
+
#
|
6040
|
+
# @!attribute [rw] retention_start_date
|
6041
|
+
# If the archived tape is subject to tape retention lock, the date
|
6042
|
+
# that the archived tape started being retained.
|
6043
|
+
# @return [Time]
|
6044
|
+
#
|
6045
|
+
# @!attribute [rw] pool_entry_date
|
6046
|
+
# The time that the tape entered the custom tape pool.
|
6047
|
+
#
|
6048
|
+
# The default timestamp format is in the ISO8601 extended
|
6049
|
+
# YYYY-MM-DD'T'HH:MM:SS'Z' format.
|
6050
|
+
# @return [Time]
|
6051
|
+
#
|
5735
6052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeArchive AWS API Documentation
|
5736
6053
|
#
|
5737
6054
|
class TapeArchive < Struct.new(
|
@@ -5744,7 +6061,10 @@ module Aws::StorageGateway
|
|
5744
6061
|
:tape_status,
|
5745
6062
|
:tape_used_in_bytes,
|
5746
6063
|
:kms_key,
|
5747
|
-
:pool_id
|
6064
|
+
:pool_id,
|
6065
|
+
:worm,
|
6066
|
+
:retention_start_date,
|
6067
|
+
:pool_entry_date)
|
5748
6068
|
SENSITIVE = []
|
5749
6069
|
include Aws::Structure
|
5750
6070
|
end
|
@@ -5784,6 +6104,15 @@ module Aws::StorageGateway
|
|
5784
6104
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5785
6105
|
# @return [String]
|
5786
6106
|
#
|
6107
|
+
# @!attribute [rw] retention_start_date
|
6108
|
+
# The date that the tape became subject to tape retention lock.
|
6109
|
+
# @return [Time]
|
6110
|
+
#
|
6111
|
+
# @!attribute [rw] pool_entry_date
|
6112
|
+
# The date that the tape entered the custom tape pool with tape
|
6113
|
+
# retention lock enabled.
|
6114
|
+
# @return [Time]
|
6115
|
+
#
|
5787
6116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeInfo AWS API Documentation
|
5788
6117
|
#
|
5789
6118
|
class TapeInfo < Struct.new(
|
@@ -5792,7 +6121,9 @@ module Aws::StorageGateway
|
|
5792
6121
|
:tape_size_in_bytes,
|
5793
6122
|
:tape_status,
|
5794
6123
|
:gateway_arn,
|
5795
|
-
:pool_id
|
6124
|
+
:pool_id,
|
6125
|
+
:retention_start_date,
|
6126
|
+
:pool_entry_date)
|
5796
6127
|
SENSITIVE = []
|
5797
6128
|
include Aws::Structure
|
5798
6129
|
end
|
@@ -5807,7 +6138,7 @@ module Aws::StorageGateway
|
|
5807
6138
|
# The time when the point-in-time view of the virtual tape was
|
5808
6139
|
# replicated for later recovery.
|
5809
6140
|
#
|
5810
|
-
# The default
|
6141
|
+
# The default timestamp format of the tape recovery point time is in
|
5811
6142
|
# the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
|
5812
6143
|
# @return [Time]
|
5813
6144
|
#
|
@@ -5840,6 +6171,7 @@ module Aws::StorageGateway
|
|
5840
6171
|
# pool_id: "PoolId", # required
|
5841
6172
|
# tape_size_in_bytes: 1, # required
|
5842
6173
|
# minimum_num_tapes: 1, # required
|
6174
|
+
# worm: false,
|
5843
6175
|
# },
|
5844
6176
|
# ],
|
5845
6177
|
# gateway_arn: "GatewayARN", # required
|
@@ -6048,7 +6380,7 @@ module Aws::StorageGateway
|
|
6048
6380
|
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
|
6049
6381
|
# that you want to use to monitor and log events in the gateway.
|
6050
6382
|
#
|
6051
|
-
# For more information, see [What is Amazon CloudWatch
|
6383
|
+
# For more information, see [What is Amazon CloudWatch Logs?][1]
|
6052
6384
|
#
|
6053
6385
|
#
|
6054
6386
|
#
|
@@ -6727,7 +7059,7 @@ module Aws::StorageGateway
|
|
6727
7059
|
# @!attribute [rw] device_type
|
6728
7060
|
# The type of medium changer you want to select.
|
6729
7061
|
#
|
6730
|
-
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
7062
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
|
6731
7063
|
# @return [String]
|
6732
7064
|
#
|
6733
7065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateVTLDeviceTypeInput AWS API Documentation
|