aws-sdk-storagegateway 1.43.0 → 1.48.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f5669dfd19d46585b533d8ec2bd2a7baaccc9561ad0aed7c8238230e88417a7b
4
- data.tar.gz: 36d90bb39cc46d874659280bcdb047fb6d781b991528a0a554e920d87ce59b6a
3
+ metadata.gz: 602c6641c19db74da9581d192d8fdfdfe50c4a087ff6d93afdf7e9f4c510b5af
4
+ data.tar.gz: c14d27b7f5580f79c38a4e5801ac6b9d3298736dda482c6c2e34ad4cb354a2d0
5
5
  SHA512:
6
- metadata.gz: 62353f4c2a5306ff473c791dcacb4df64dd979a5c5645e7f97d33fbcce9a970de6d24900531cd268a56209c76e0117acba99641b6ae987d2c85312df1aea3f1f
7
- data.tar.gz: 36a7f347cc8e347d317738f643cbc7dfc897dfd7c1a5a3f1cac13ab65a4624125b88bfa533569bd1665492cd7aaa3810ce57e883284a173f1d28780f8d54e4b9
6
+ metadata.gz: f9aefdaa10217a05bab84a6474718ebe1012d824f7427e2a4477c3ec5a683be5eec4ec063b07afc7ad2573fa38a36ad2a3f7b74b3f2fd1a3fe0cc218ac063092
7
+ data.tar.gz: 16655c24baf56654ed0477df9ee2679971f341aad82bc91a57d14954dca9bee3cde0383b246055b90cc2a960ac497123cf6bdf8a22505a8fa00f35707db5c9ba
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -42,9 +44,9 @@ require_relative 'aws-sdk-storagegateway/customizations'
42
44
  #
43
45
  # See {Errors} for more information.
44
46
  #
45
- # @service
47
+ # @!group service
46
48
  module Aws::StorageGateway
47
49
 
48
- GEM_VERSION = '1.43.0'
50
+ GEM_VERSION = '1.48.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::StorageGateway
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::StorageGateway
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -392,7 +409,7 @@ module Aws::StorageGateway
392
409
  # The value that indicates the type of medium changer to use for tape
393
410
  # gateway. This field is optional.
394
411
  #
395
- # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
412
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
396
413
  #
397
414
  # @option params [Array<Types::Tag>] :tags
398
415
  # A list of up to 50 tags that you can assign to the gateway. Each tag
@@ -757,6 +774,16 @@ module Aws::StorageGateway
757
774
  #
758
775
  # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
759
776
  #
777
+ # @option params [Boolean] :bypass_governance_retention
778
+ # Set permissions to bypass governance retention. If the lock type of
779
+ # the archived tape is `Governance`, the tape's archived age is not
780
+ # older than `RetentionLockInDays`, and the user does not already have
781
+ # `BypassGovernanceRetention`, setting this to TRUE enables the user to
782
+ # bypass the retention lock. This parameter is set to true by default
783
+ # for calls from the console.
784
+ #
785
+ # Valid values: `TRUE` \| `FALSE`
786
+ #
760
787
  # @return [Types::AssignTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
761
788
  #
762
789
  # * {Types::AssignTapePoolOutput#tape_arn #tape_arn} => String
@@ -766,6 +793,7 @@ module Aws::StorageGateway
766
793
  # resp = client.assign_tape_pool({
767
794
  # tape_arn: "TapeARN", # required
768
795
  # pool_id: "PoolId", # required
796
+ # bypass_governance_retention: false,
769
797
  # })
770
798
  #
771
799
  # @example Response structure
@@ -1155,7 +1183,8 @@ module Aws::StorageGateway
1155
1183
  # file gateway assumes when it accesses the underlying storage.
1156
1184
  #
1157
1185
  # @option params [required, String] :location_arn
1158
- # The ARN of the backed storage used for storing file data.
1186
+ # The ARN of the backend storage used for storing file data. A prefix
1187
+ # name can be added to the S3 bucket name. It must end with a "/".
1159
1188
  #
1160
1189
  # @option params [String] :default_storage_class
1161
1190
  # The default storage class for objects put into an Amazon S3 bucket by
@@ -1224,6 +1253,17 @@ module Aws::StorageGateway
1224
1253
  #
1225
1254
  # </note>
1226
1255
  #
1256
+ # @option params [String] :file_share_name
1257
+ # The name of the file share. Optional.
1258
+ #
1259
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1260
+ # `LocationARN`.
1261
+ #
1262
+ # </note>
1263
+ #
1264
+ # @option params [Types::CacheAttributes] :cache_attributes
1265
+ # Refresh cache information.
1266
+ #
1227
1267
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1228
1268
  #
1229
1269
  # * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1256,6 +1296,10 @@ module Aws::StorageGateway
1256
1296
  # value: "TagValue", # required
1257
1297
  # },
1258
1298
  # ],
1299
+ # file_share_name: "FileShareName",
1300
+ # cache_attributes: {
1301
+ # cache_stale_timeout_in_seconds: 1,
1302
+ # },
1259
1303
  # })
1260
1304
  #
1261
1305
  # @example Response structure
@@ -1273,7 +1317,7 @@ module Aws::StorageGateway
1273
1317
 
1274
1318
  # Creates a Server Message Block (SMB) file share on an existing file
1275
1319
  # gateway. In Storage Gateway, a file share is a file system mount point
1276
- # backed by Amazon S3 cloud storage. Storage Gateway expose file shares
1320
+ # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
1277
1321
  # using an SMB interface. This operation is only supported for file
1278
1322
  # gateways.
1279
1323
  #
@@ -1317,7 +1361,8 @@ module Aws::StorageGateway
1317
1361
  # file gateway assumes when it accesses the underlying storage.
1318
1362
  #
1319
1363
  # @option params [required, String] :location_arn
1320
- # The ARN of the backed storage used for storing file data.
1364
+ # The ARN of the backend storage used for storing file data. A prefix
1365
+ # name can be added to the S3 bucket name. It must end with a "/".
1321
1366
  #
1322
1367
  # @option params [String] :default_storage_class
1323
1368
  # The default storage class for objects put into an Amazon S3 bucket by
@@ -1376,24 +1421,27 @@ module Aws::StorageGateway
1376
1421
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1377
1422
  #
1378
1423
  # @option params [Array<String>] :admin_user_list
1379
- # A list of users in the Active Directory that will be granted
1424
+ # A list of users or groups in the Active Directory that will be granted
1380
1425
  # administrator privileges on the file share. These users can do all
1381
- # file operations as the super-user.
1426
+ # file operations as the super-user. Acceptable formats include:
1427
+ # `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`.
1382
1428
  #
1383
1429
  # Use this option very carefully, because any user in this list can do
1384
1430
  # anything they like on the file share, regardless of file permissions.
1385
1431
  #
1386
1432
  # @option params [Array<String>] :valid_user_list
1387
1433
  # A list of users or groups in the Active Directory that are allowed to
1388
- # access the file share. A group must be prefixed with the @ character.
1389
- # For example, `@group1`. Can only be set if Authentication is set to
1390
- # `ActiveDirectory`.
1434
+ # access the file []() share. A group must be prefixed with the @
1435
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
1436
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
1437
+ # set to `ActiveDirectory`.
1391
1438
  #
1392
1439
  # @option params [Array<String>] :invalid_user_list
1393
1440
  # A list of users or groups in the Active Directory that are not allowed
1394
1441
  # to access the file share. A group must be prefixed with the @
1395
- # character. For example, `@group1`. Can only be set if Authentication
1396
- # is set to `ActiveDirectory`.
1442
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
1443
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
1444
+ # set to `ActiveDirectory`.
1397
1445
  #
1398
1446
  # @option params [String] :audit_destination_arn
1399
1447
  # The Amazon Resource Name (ARN) of the storage used for the audit logs.
@@ -1404,6 +1452,12 @@ module Aws::StorageGateway
1404
1452
  #
1405
1453
  # Valid Values: `ActiveDirectory` \| `GuestAccess`
1406
1454
  #
1455
+ # @option params [String] :case_sensitivity
1456
+ # The case of an object name in an Amazon S3 bucket. For
1457
+ # `ClientSpecified`, the client determines the case sensitivity. For
1458
+ # `CaseSensitive`, the gateway determines the case sensitivity. The
1459
+ # default value is `ClientSpecified`.
1460
+ #
1407
1461
  # @option params [Array<Types::Tag>] :tags
1408
1462
  # A list of up to 50 tags that can be assigned to the NFS file share.
1409
1463
  # Each tag is a key-value pair.
@@ -1415,6 +1469,17 @@ module Aws::StorageGateway
1415
1469
  #
1416
1470
  # </note>
1417
1471
  #
1472
+ # @option params [String] :file_share_name
1473
+ # The name of the file share. Optional.
1474
+ #
1475
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1476
+ # `LocationARN`.
1477
+ #
1478
+ # </note>
1479
+ #
1480
+ # @option params [Types::CacheAttributes] :cache_attributes
1481
+ # Refresh cache information.
1482
+ #
1418
1483
  # @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1419
1484
  #
1420
1485
  # * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1439,12 +1504,17 @@ module Aws::StorageGateway
1439
1504
  # invalid_user_list: ["FileShareUser"],
1440
1505
  # audit_destination_arn: "AuditDestinationARN",
1441
1506
  # authentication: "Authentication",
1507
+ # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
1442
1508
  # tags: [
1443
1509
  # {
1444
1510
  # key: "TagKey", # required
1445
1511
  # value: "TagValue", # required
1446
1512
  # },
1447
1513
  # ],
1514
+ # file_share_name: "FileShareName",
1515
+ # cache_attributes: {
1516
+ # cache_stale_timeout_in_seconds: 1,
1517
+ # },
1448
1518
  # })
1449
1519
  #
1450
1520
  # @example Response structure
@@ -1467,14 +1537,14 @@ module Aws::StorageGateway
1467
1537
  # durable off-site recovery, as well as import the data to an Amazon
1468
1538
  # Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
1469
1539
  # (EC2). You can take snapshots of your gateway volume on a scheduled or
1470
- # ad hoc basis. This API enables you to take ad-hoc snapshot. For more
1471
- # information, see [Editing a snapshot schedule][1].
1540
+ # ad hoc basis. This API enables you to take an ad hoc snapshot. For
1541
+ # more information, see [Editing a snapshot schedule][1].
1472
1542
  #
1473
- # In the CreateSnapshot request you identify the volume by providing its
1474
- # Amazon Resource Name (ARN). You must also provide description for the
1475
- # snapshot. When AWS Storage Gateway takes the snapshot of specified
1543
+ # In the `CreateSnapshot` request, you identify the volume by providing
1544
+ # its Amazon Resource Name (ARN). You must also provide description for
1545
+ # the snapshot. When AWS Storage Gateway takes the snapshot of specified
1476
1546
  # volume, the snapshot and description appears in the AWS Storage
1477
- # Gateway Console. In response, AWS Storage Gateway returns you a
1547
+ # Gateway console. In response, AWS Storage Gateway returns you a
1478
1548
  # snapshot ID. You can use this snapshot ID to check the snapshot
1479
1549
  # progress or later use it when you want to create a volume from a
1480
1550
  # snapshot. This operation is only supported in stored and cached volume
@@ -1675,7 +1745,7 @@ module Aws::StorageGateway
1675
1745
  # create an empty gateway volume, then any existing data on the disk is
1676
1746
  # erased.
1677
1747
  #
1678
- # In the request you must specify the gateway and the disk information
1748
+ # In the request, you must specify the gateway and the disk information
1679
1749
  # on which you are creating the volume. In response, the gateway creates
1680
1750
  # the volume and returns volume information such as the volume Amazon
1681
1751
  # Resource Name (ARN), its size, and the iSCSI target ARN that
@@ -1814,9 +1884,75 @@ module Aws::StorageGateway
1814
1884
  req.send_request(options)
1815
1885
  end
1816
1886
 
1887
+ # Creates a new custom tape pool. You can use custom tape pool to enable
1888
+ # tape retention lock on tapes that are archived in the custom pool.
1889
+ #
1890
+ # @option params [required, String] :pool_name
1891
+ # The name of the new custom tape pool.
1892
+ #
1893
+ # @option params [required, String] :storage_class
1894
+ # The storage class that is associated with the new custom pool. When
1895
+ # you use your backup application to eject the tape, the tape is
1896
+ # archived directly into the storage class (S3 Glacier or S3 Glacier
1897
+ # Deep Archive) that corresponds to the pool.
1898
+ #
1899
+ # @option params [String] :retention_lock_type
1900
+ # Tape retention lock can be configured in two modes. When configured in
1901
+ # governance mode, AWS accounts with specific IAM permissions are
1902
+ # authorized to remove the tape retention lock from archived virtual
1903
+ # tapes. When configured in compliance mode, the tape retention lock
1904
+ # cannot be removed by any user, including the root AWS account.
1905
+ #
1906
+ # @option params [Integer] :retention_lock_time_in_days
1907
+ # Tape retention lock time is set in days. Tape retention lock can be
1908
+ # enabled for up to 100 years (36,500 days).
1909
+ #
1910
+ # @option params [Array<Types::Tag>] :tags
1911
+ # A list of up to 50 tags that can be assigned to tape pool. Each tag is
1912
+ # a key-value pair.
1913
+ #
1914
+ # <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
1915
+ # representable in UTF-8 format, and the following special characters: +
1916
+ # - = . \_ : / @. The maximum length of a tag's key is 128 characters,
1917
+ # and the maximum length for a tag's value is 256.
1918
+ #
1919
+ # </note>
1920
+ #
1921
+ # @return [Types::CreateTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1922
+ #
1923
+ # * {Types::CreateTapePoolOutput#pool_arn #pool_arn} => String
1924
+ #
1925
+ # @example Request syntax with placeholder values
1926
+ #
1927
+ # resp = client.create_tape_pool({
1928
+ # pool_name: "PoolName", # required
1929
+ # storage_class: "DEEP_ARCHIVE", # required, accepts DEEP_ARCHIVE, GLACIER
1930
+ # retention_lock_type: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE, NONE
1931
+ # retention_lock_time_in_days: 1,
1932
+ # tags: [
1933
+ # {
1934
+ # key: "TagKey", # required
1935
+ # value: "TagValue", # required
1936
+ # },
1937
+ # ],
1938
+ # })
1939
+ #
1940
+ # @example Response structure
1941
+ #
1942
+ # resp.pool_arn #=> String
1943
+ #
1944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePool AWS API Documentation
1945
+ #
1946
+ # @overload create_tape_pool(params = {})
1947
+ # @param [Hash] params ({})
1948
+ def create_tape_pool(params = {}, options = {})
1949
+ req = build_request(:create_tape_pool, params)
1950
+ req.send_request(options)
1951
+ end
1952
+
1817
1953
  # Creates a virtual tape by using your own barcode. You write data to
1818
1954
  # the virtual tape and then archive the tape. A barcode is unique and
1819
- # can not be reused if it has already been used on a tape. This applies
1955
+ # cannot be reused if it has already been used on a tape. This applies
1820
1956
  # to barcodes used on deleted tapes. This operation is only supported in
1821
1957
  # the tape gateway type.
1822
1958
  #
@@ -1867,6 +2003,10 @@ module Aws::StorageGateway
1867
2003
  #
1868
2004
  # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1869
2005
  #
2006
+ # @option params [Boolean] :worm
2007
+ # Set to `TRUE` if the tape you are creating is to be configured as a
2008
+ # write-once-read-many (WORM) tape.
2009
+ #
1870
2010
  # @option params [Array<Types::Tag>] :tags
1871
2011
  # A list of up to 50 tags that can be assigned to a virtual tape that
1872
2012
  # has a barcode. Each tag is a key-value pair.
@@ -1907,6 +2047,7 @@ module Aws::StorageGateway
1907
2047
  # kms_encrypted: false,
1908
2048
  # kms_key: "KMSKey",
1909
2049
  # pool_id: "PoolId",
2050
+ # worm: false,
1910
2051
  # tags: [
1911
2052
  # {
1912
2053
  # key: "TagKey", # required
@@ -1993,6 +2134,10 @@ module Aws::StorageGateway
1993
2134
  #
1994
2135
  # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1995
2136
  #
2137
+ # @option params [Boolean] :worm
2138
+ # Set to `TRUE` if the tape you are creating is to be configured as a
2139
+ # write-once-read-many (WORM) tape.
2140
+ #
1996
2141
  # @option params [Array<Types::Tag>] :tags
1997
2142
  # A list of up to 50 tags that can be assigned to a virtual tape. Each
1998
2143
  # tag is a key-value pair.
@@ -2041,6 +2186,7 @@ module Aws::StorageGateway
2041
2186
  # kms_encrypted: false,
2042
2187
  # kms_key: "KMSKey",
2043
2188
  # pool_id: "PoolId",
2189
+ # worm: false,
2044
2190
  # tags: [
2045
2191
  # {
2046
2192
  # key: "TagKey", # required
@@ -2112,7 +2258,7 @@ module Aws::StorageGateway
2112
2258
  # One of the BandwidthType values that indicates the gateway bandwidth
2113
2259
  # rate limit to delete.
2114
2260
  #
2115
- # Valid Values: `Upload` \| `Download` \| `All`
2261
+ # Valid Values: `UPLOAD` \| `DOWNLOAD` \| `ALL`
2116
2262
  #
2117
2263
  # @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2118
2264
  #
@@ -2329,7 +2475,7 @@ module Aws::StorageGateway
2329
2475
  #
2330
2476
  #
2331
2477
  #
2332
- # [1]: https://docs.aws.amazon.com/storagegatewaylatest/userguide/backing-up-volumes.html
2478
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html
2333
2479
  # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
2334
2480
  #
2335
2481
  # @option params [required, String] :volume_arn
@@ -2383,6 +2529,12 @@ module Aws::StorageGateway
2383
2529
  # @option params [required, String] :tape_arn
2384
2530
  # The Amazon Resource Name (ARN) of the virtual tape to delete.
2385
2531
  #
2532
+ # @option params [Boolean] :bypass_governance_retention
2533
+ # Set to `TRUE` to delete an archived tape that belongs to a custom pool
2534
+ # with tape retention lock. Only archived tapes with tape retention lock
2535
+ # set to `governance` can be deleted. Archived tapes with tape retention
2536
+ # lock set to `compliance` can't be deleted.
2537
+ #
2386
2538
  # @return [Types::DeleteTapeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2387
2539
  #
2388
2540
  # * {Types::DeleteTapeOutput#tape_arn #tape_arn} => String
@@ -2407,6 +2559,7 @@ module Aws::StorageGateway
2407
2559
  # resp = client.delete_tape({
2408
2560
  # gateway_arn: "GatewayARN", # required
2409
2561
  # tape_arn: "TapeARN", # required
2562
+ # bypass_governance_retention: false,
2410
2563
  # })
2411
2564
  #
2412
2565
  # @example Response structure
@@ -2429,6 +2582,12 @@ module Aws::StorageGateway
2429
2582
  # The Amazon Resource Name (ARN) of the virtual tape to delete from the
2430
2583
  # virtual tape shelf (VTS).
2431
2584
  #
2585
+ # @option params [Boolean] :bypass_governance_retention
2586
+ # Set to `TRUE` to delete an archived tape that belongs to a custom pool
2587
+ # with tape retention lock. Only archived tapes with tape retention lock
2588
+ # set to `governance` can be deleted. Archived tapes with tape retention
2589
+ # lock set to `compliance` can't be deleted.
2590
+ #
2432
2591
  # @return [Types::DeleteTapeArchiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2433
2592
  #
2434
2593
  # * {Types::DeleteTapeArchiveOutput#tape_arn #tape_arn} => String
@@ -2451,6 +2610,7 @@ module Aws::StorageGateway
2451
2610
  #
2452
2611
  # resp = client.delete_tape_archive({
2453
2612
  # tape_arn: "TapeARN", # required
2613
+ # bypass_governance_retention: false,
2454
2614
  # })
2455
2615
  #
2456
2616
  # @example Response structure
@@ -2466,6 +2626,36 @@ module Aws::StorageGateway
2466
2626
  req.send_request(options)
2467
2627
  end
2468
2628
 
2629
+ # Delete a custom tape pool. A custom tape pool can only be deleted if
2630
+ # there are no tapes in the pool and if there are no automatic tape
2631
+ # creation policies that reference the custom tape pool.
2632
+ #
2633
+ # @option params [required, String] :pool_arn
2634
+ # The Amazon Resource Name (ARN) of the custom tape pool to delete.
2635
+ #
2636
+ # @return [Types::DeleteTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2637
+ #
2638
+ # * {Types::DeleteTapePoolOutput#pool_arn #pool_arn} => String
2639
+ #
2640
+ # @example Request syntax with placeholder values
2641
+ #
2642
+ # resp = client.delete_tape_pool({
2643
+ # pool_arn: "PoolARN", # required
2644
+ # })
2645
+ #
2646
+ # @example Response structure
2647
+ #
2648
+ # resp.pool_arn #=> String
2649
+ #
2650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapePool AWS API Documentation
2651
+ #
2652
+ # @overload delete_tape_pool(params = {})
2653
+ # @param [Hash] params ({})
2654
+ def delete_tape_pool(params = {}, options = {})
2655
+ req = build_request(:delete_tape_pool, params)
2656
+ req.send_request(options)
2657
+ end
2658
+
2469
2659
  # Deletes the specified storage volume that you previously created using
2470
2660
  # the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This
2471
2661
  # operation is only supported in the cached volume and stored volume
@@ -2569,7 +2759,7 @@ module Aws::StorageGateway
2569
2759
  # Returns the bandwidth rate limits of a gateway. By default, these
2570
2760
  # limits are not set, which means no bandwidth rate limiting is in
2571
2761
  # effect. This operation is supported for the stored volume, cached
2572
- # volume and tape gateway types.
2762
+ # volume, and tape gateway types.
2573
2763
  #
2574
2764
  # This operation only returns a value for a bandwidth rate limit only if
2575
2765
  # the limit is set. If no limits are set for the gateway, then this
@@ -2866,6 +3056,8 @@ module Aws::StorageGateway
2866
3056
  # * {Types::DescribeGatewayInformationOutput#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
2867
3057
  # * {Types::DescribeGatewayInformationOutput#host_environment #host_environment} => String
2868
3058
  # * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
3059
+ # * {Types::DescribeGatewayInformationOutput#software_updates_end_date #software_updates_end_date} => String
3060
+ # * {Types::DescribeGatewayInformationOutput#deprecation_date #deprecation_date} => String
2869
3061
  #
2870
3062
  #
2871
3063
  # @example Example: To describe metadata about the gateway
@@ -2923,6 +3115,8 @@ module Aws::StorageGateway
2923
3115
  # resp.cloud_watch_log_group_arn #=> String
2924
3116
  # resp.host_environment #=> String, one of "VMWARE", "HYPER-V", "EC2", "KVM", "OTHER"
2925
3117
  # resp.endpoint_type #=> String
3118
+ # resp.software_updates_end_date #=> String
3119
+ # resp.deprecation_date #=> String
2926
3120
  #
2927
3121
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
2928
3122
  #
@@ -3038,6 +3232,8 @@ module Aws::StorageGateway
3038
3232
  # resp.nfs_file_share_info_list[0].tags #=> Array
3039
3233
  # resp.nfs_file_share_info_list[0].tags[0].key #=> String
3040
3234
  # resp.nfs_file_share_info_list[0].tags[0].value #=> String
3235
+ # resp.nfs_file_share_info_list[0].file_share_name #=> String
3236
+ # resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3041
3237
  #
3042
3238
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
3043
3239
  #
@@ -3092,9 +3288,12 @@ module Aws::StorageGateway
3092
3288
  # resp.smb_file_share_info_list[0].invalid_user_list[0] #=> String
3093
3289
  # resp.smb_file_share_info_list[0].audit_destination_arn #=> String
3094
3290
  # resp.smb_file_share_info_list[0].authentication #=> String
3291
+ # resp.smb_file_share_info_list[0].case_sensitivity #=> String, one of "ClientSpecified", "CaseSensitive"
3095
3292
  # resp.smb_file_share_info_list[0].tags #=> Array
3096
3293
  # resp.smb_file_share_info_list[0].tags[0].key #=> String
3097
3294
  # resp.smb_file_share_info_list[0].tags[0].value #=> String
3295
+ # resp.smb_file_share_info_list[0].file_share_name #=> String
3296
+ # resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3098
3297
  #
3099
3298
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
3100
3299
  #
@@ -3377,6 +3576,9 @@ module Aws::StorageGateway
3377
3576
  # resp.tape_archives[0].tape_used_in_bytes #=> Integer
3378
3577
  # resp.tape_archives[0].kms_key #=> String
3379
3578
  # resp.tape_archives[0].pool_id #=> String
3579
+ # resp.tape_archives[0].worm #=> Boolean
3580
+ # resp.tape_archives[0].retention_start_date #=> Time
3581
+ # resp.tape_archives[0].pool_entry_date #=> Time
3380
3582
  # resp.marker #=> String
3381
3583
  #
3382
3584
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeArchives AWS API Documentation
@@ -3565,6 +3767,9 @@ module Aws::StorageGateway
3565
3767
  # resp.tapes[0].tape_used_in_bytes #=> Integer
3566
3768
  # resp.tapes[0].kms_key #=> String
3567
3769
  # resp.tapes[0].pool_id #=> String
3770
+ # resp.tapes[0].worm #=> Boolean
3771
+ # resp.tapes[0].retention_start_date #=> Time
3772
+ # resp.tapes[0].pool_entry_date #=> Time
3568
3773
  # resp.marker #=> String
3569
3774
  #
3570
3775
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapes AWS API Documentation
@@ -4050,6 +4255,7 @@ module Aws::StorageGateway
4050
4255
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].pool_id #=> String
4051
4256
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].tape_size_in_bytes #=> Integer
4052
4257
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].minimum_num_tapes #=> Integer
4258
+ # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].worm #=> Boolean
4053
4259
  # resp.automatic_tape_creation_policy_infos[0].gateway_arn #=> String
4054
4260
  #
4055
4261
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies AWS API Documentation
@@ -4351,6 +4557,63 @@ module Aws::StorageGateway
4351
4557
  req.send_request(options)
4352
4558
  end
4353
4559
 
4560
+ # Lists custom tape pools. You specify custom tape pools to list by
4561
+ # specifying one or more custom tape pool Amazon Resource Names (ARNs).
4562
+ # If you don't specify a custom tape pool ARN, the operation lists all
4563
+ # custom tape pools.
4564
+ #
4565
+ # This operation supports pagination. You can optionally specify the
4566
+ # `Limit` parameter in the body to limit the number of tape pools in the
4567
+ # response. If the number of tape pools returned in the response is
4568
+ # truncated, the response includes a `Marker` element that you can use
4569
+ # in your subsequent request to retrieve the next set of tape pools.
4570
+ #
4571
+ # @option params [Array<String>] :pool_arns
4572
+ # The Amazon Resource Name (ARN) of each of the custom tape pools you
4573
+ # want to list. If you don't specify a custom tape pool ARN, the
4574
+ # response lists all custom tape pools.
4575
+ #
4576
+ # @option params [String] :marker
4577
+ # A string that indicates the position at which to begin the returned
4578
+ # list of tape pools.
4579
+ #
4580
+ # @option params [Integer] :limit
4581
+ # An optional number limit for the tape pools in the list returned by
4582
+ # this call.
4583
+ #
4584
+ # @return [Types::ListTapePoolsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4585
+ #
4586
+ # * {Types::ListTapePoolsOutput#pool_infos #pool_infos} => Array&lt;Types::PoolInfo&gt;
4587
+ # * {Types::ListTapePoolsOutput#marker #marker} => String
4588
+ #
4589
+ # @example Request syntax with placeholder values
4590
+ #
4591
+ # resp = client.list_tape_pools({
4592
+ # pool_arns: ["PoolARN"],
4593
+ # marker: "Marker",
4594
+ # limit: 1,
4595
+ # })
4596
+ #
4597
+ # @example Response structure
4598
+ #
4599
+ # resp.pool_infos #=> Array
4600
+ # resp.pool_infos[0].pool_arn #=> String
4601
+ # resp.pool_infos[0].pool_name #=> String
4602
+ # resp.pool_infos[0].storage_class #=> String, one of "DEEP_ARCHIVE", "GLACIER"
4603
+ # resp.pool_infos[0].retention_lock_type #=> String, one of "COMPLIANCE", "GOVERNANCE", "NONE"
4604
+ # resp.pool_infos[0].retention_lock_time_in_days #=> Integer
4605
+ # resp.pool_infos[0].pool_status #=> String, one of "ACTIVE", "DELETED"
4606
+ # resp.marker #=> String
4607
+ #
4608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapePools AWS API Documentation
4609
+ #
4610
+ # @overload list_tape_pools(params = {})
4611
+ # @param [Hash] params ({})
4612
+ def list_tape_pools(params = {}, options = {})
4613
+ req = build_request(:list_tape_pools, params)
4614
+ req.send_request(options)
4615
+ end
4616
+
4354
4617
  # Lists virtual tapes in your virtual tape library (VTL) and your
4355
4618
  # virtual tape shelf (VTS). You specify the tapes to list by specifying
4356
4619
  # one or more tape Amazon Resource Names (ARNs). If you don't specify a
@@ -4402,6 +4665,8 @@ module Aws::StorageGateway
4402
4665
  # resp.tape_infos[0].tape_status #=> String
4403
4666
  # resp.tape_infos[0].gateway_arn #=> String
4404
4667
  # resp.tape_infos[0].pool_id #=> String
4668
+ # resp.tape_infos[0].retention_start_date #=> Time
4669
+ # resp.tape_infos[0].pool_entry_date #=> Time
4405
4670
  # resp.marker #=> String
4406
4671
  #
4407
4672
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes AWS API Documentation
@@ -4661,7 +4926,7 @@ module Aws::StorageGateway
4661
4926
  end
4662
4927
 
4663
4928
  # Refreshes the cache for the specified file share. This operation finds
4664
- # objects in the Amazon S3 bucket that were added, removed or replaced
4929
+ # objects in the Amazon S3 bucket that were added, removed, or replaced
4665
4930
  # since the gateway last listed the bucket's contents and cached the
4666
4931
  # results. This operation is only supported in the file gateway type.
4667
4932
  # You can subscribe to be notified through an Amazon CloudWatch event
@@ -5269,6 +5534,7 @@ module Aws::StorageGateway
5269
5534
  # pool_id: "PoolId", # required
5270
5535
  # tape_size_in_bytes: 1, # required
5271
5536
  # minimum_num_tapes: 1, # required
5537
+ # worm: false,
5272
5538
  # },
5273
5539
  # ],
5274
5540
  # gateway_arn: "GatewayARN", # required
@@ -5439,7 +5705,7 @@ module Aws::StorageGateway
5439
5705
  # time zone. To specify which gateway to update, use the Amazon Resource
5440
5706
  # Name (ARN) of the gateway in your request.
5441
5707
  #
5442
- # <note markdown="1"> For Gateways activated after September 2, 2015, the gateway's ARN
5708
+ # <note markdown="1"> For gateways activated after September 2, 2015, the gateway's ARN
5443
5709
  # contains the gateway ID rather than the gateway name. However,
5444
5710
  # changing the name of the gateway has no effect on the gateway's ARN.
5445
5711
  #
@@ -5460,7 +5726,7 @@ module Aws::StorageGateway
5460
5726
  # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
5461
5727
  # you want to use to monitor and log events in the gateway.
5462
5728
  #
5463
- # For more information, see [What is Amazon CloudWatch logs?][1].
5729
+ # For more information, see [What is Amazon CloudWatch Logs?][1]
5464
5730
  #
5465
5731
  #
5466
5732
  #
@@ -5748,6 +6014,17 @@ module Aws::StorageGateway
5748
6014
  #
5749
6015
  # Valid Values: `true` \| `false`
5750
6016
  #
6017
+ # @option params [String] :file_share_name
6018
+ # The name of the file share. Optional.
6019
+ #
6020
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6021
+ # `LocationARN`.
6022
+ #
6023
+ # </note>
6024
+ #
6025
+ # @option params [Types::CacheAttributes] :cache_attributes
6026
+ # Refresh cache information.
6027
+ #
5751
6028
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5752
6029
  #
5753
6030
  # * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -5771,6 +6048,10 @@ module Aws::StorageGateway
5771
6048
  # read_only: false,
5772
6049
  # guess_mime_type_enabled: false,
5773
6050
  # requester_pays: false,
6051
+ # file_share_name: "FileShareName",
6052
+ # cache_attributes: {
6053
+ # cache_stale_timeout_in_seconds: 1,
6054
+ # },
5774
6055
  # })
5775
6056
  #
5776
6057
  # @example Response structure
@@ -5882,26 +6163,46 @@ module Aws::StorageGateway
5882
6163
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
5883
6164
  #
5884
6165
  # @option params [Array<String>] :admin_user_list
5885
- # A list of users in the Active Directory that have administrator rights
5886
- # to the file share. A group must be prefixed with the @ character. For
5887
- # example, `@group1`. Can only be set if Authentication is set to
5888
- # `ActiveDirectory`.
6166
+ # A list of users or groups in the Active Directory that have
6167
+ # administrator rights to the file share. A group must be prefixed with
6168
+ # the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`,
6169
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
6170
+ # set to `ActiveDirectory`.
5889
6171
  #
5890
6172
  # @option params [Array<String>] :valid_user_list
5891
6173
  # A list of users or groups in the Active Directory that are allowed to
5892
6174
  # access the file share. A group must be prefixed with the @ character.
5893
- # For example, `@group1`. Can only be set if Authentication is set to
6175
+ # Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and
6176
+ # `@DOMAIN\group1`. Can only be set if Authentication is set to
5894
6177
  # `ActiveDirectory`.
5895
6178
  #
5896
6179
  # @option params [Array<String>] :invalid_user_list
5897
6180
  # A list of users or groups in the Active Directory that are not allowed
5898
6181
  # to access the file share. A group must be prefixed with the @
5899
- # character. For example `@group1`. Can only be set if Authentication is
6182
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
6183
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
5900
6184
  # set to `ActiveDirectory`.
5901
6185
  #
5902
6186
  # @option params [String] :audit_destination_arn
5903
6187
  # The Amazon Resource Name (ARN) of the storage used for the audit logs.
5904
6188
  #
6189
+ # @option params [String] :case_sensitivity
6190
+ # The case of an object name in an Amazon S3 bucket. For
6191
+ # `ClientSpecified`, the client determines the case sensitivity. For
6192
+ # `CaseSensitive`, the gateway determines the case sensitivity. The
6193
+ # default value is `ClientSpecified`.
6194
+ #
6195
+ # @option params [String] :file_share_name
6196
+ # The name of the file share. Optional.
6197
+ #
6198
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6199
+ # `LocationARN`.
6200
+ #
6201
+ # </note>
6202
+ #
6203
+ # @option params [Types::CacheAttributes] :cache_attributes
6204
+ # Refresh cache information.
6205
+ #
5905
6206
  # @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5906
6207
  #
5907
6208
  # * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
@@ -5922,6 +6223,11 @@ module Aws::StorageGateway
5922
6223
  # valid_user_list: ["FileShareUser"],
5923
6224
  # invalid_user_list: ["FileShareUser"],
5924
6225
  # audit_destination_arn: "AuditDestinationARN",
6226
+ # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
6227
+ # file_share_name: "FileShareName",
6228
+ # cache_attributes: {
6229
+ # cache_stale_timeout_in_seconds: 1,
6230
+ # },
5925
6231
  # })
5926
6232
  #
5927
6233
  # @example Response structure
@@ -6096,7 +6402,7 @@ module Aws::StorageGateway
6096
6402
  # @option params [required, String] :device_type
6097
6403
  # The type of medium changer you want to select.
6098
6404
  #
6099
- # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
6405
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
6100
6406
  #
6101
6407
  # @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6102
6408
  #
@@ -6150,7 +6456,7 @@ module Aws::StorageGateway
6150
6456
  params: params,
6151
6457
  config: config)
6152
6458
  context[:gem_name] = 'aws-sdk-storagegateway'
6153
- context[:gem_version] = '1.43.0'
6459
+ context[:gem_version] = '1.48.0'
6154
6460
  Seahorse::Client::Request.new(handlers, context)
6155
6461
  end
6156
6462