aws-sdk-storagegateway 1.46.0 → 1.51.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 +3 -2
- data/lib/aws-sdk-storagegateway/client.rb +307 -32
- data/lib/aws-sdk-storagegateway/client_api.rb +126 -0
- data/lib/aws-sdk-storagegateway/types.rb +461 -30
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fa0ca8f99dca968fb092a22ac2061016b0f63efbaf65ac5d2edbf8d03835fe16
|
4
|
+
data.tar.gz: a69afa95f5ab8f8096e4e1d8011ce5fe28ab26065f8943424afa1bf90bf430c3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8faadd9af2ba7764f4db65ecfbfe8716e9cafc084c546bc597c94981ad3578c46a26e0a78277ac9c94dee05db4ab3e723e4742d68cdf9046473e099b1a5d3e11
|
7
|
+
data.tar.gz: 4e55a9a39911640c191ac4662a55ea9cb226eea49abb8a91170922dfc86d05b8c3e00cf8483e009a899d228fa8e6cf69b7660013332616ebecd5c8c380609bb9
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-storagegateway/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::StorageGateway
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.51.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::StorageGateway
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
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
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::StorageGateway
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# 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.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -394,7 +409,7 @@ module Aws::StorageGateway
|
|
394
409
|
# The value that indicates the type of medium changer to use for tape
|
395
410
|
# gateway. This field is optional.
|
396
411
|
#
|
397
|
-
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
412
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
|
398
413
|
#
|
399
414
|
# @option params [Array<Types::Tag>] :tags
|
400
415
|
# A list of up to 50 tags that you can assign to the gateway. Each tag
|
@@ -759,6 +774,16 @@ module Aws::StorageGateway
|
|
759
774
|
#
|
760
775
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
761
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
|
+
#
|
762
787
|
# @return [Types::AssignTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
763
788
|
#
|
764
789
|
# * {Types::AssignTapePoolOutput#tape_arn #tape_arn} => String
|
@@ -768,6 +793,7 @@ module Aws::StorageGateway
|
|
768
793
|
# resp = client.assign_tape_pool({
|
769
794
|
# tape_arn: "TapeARN", # required
|
770
795
|
# pool_id: "PoolId", # required
|
796
|
+
# bypass_governance_retention: false,
|
771
797
|
# })
|
772
798
|
#
|
773
799
|
# @example Response structure
|
@@ -1238,6 +1264,9 @@ module Aws::StorageGateway
|
|
1238
1264
|
# @option params [Types::CacheAttributes] :cache_attributes
|
1239
1265
|
# Refresh cache information.
|
1240
1266
|
#
|
1267
|
+
# @option params [String] :notification_policy
|
1268
|
+
# The notification policy of the file share.
|
1269
|
+
#
|
1241
1270
|
# @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1242
1271
|
#
|
1243
1272
|
# * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1274,6 +1303,7 @@ module Aws::StorageGateway
|
|
1274
1303
|
# cache_attributes: {
|
1275
1304
|
# cache_stale_timeout_in_seconds: 1,
|
1276
1305
|
# },
|
1306
|
+
# notification_policy: "NotificationPolicy",
|
1277
1307
|
# })
|
1278
1308
|
#
|
1279
1309
|
# @example Response structure
|
@@ -1291,7 +1321,7 @@ module Aws::StorageGateway
|
|
1291
1321
|
|
1292
1322
|
# Creates a Server Message Block (SMB) file share on an existing file
|
1293
1323
|
# gateway. In Storage Gateway, a file share is a file system mount point
|
1294
|
-
# backed by Amazon S3 cloud storage. Storage Gateway
|
1324
|
+
# backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
|
1295
1325
|
# using an SMB interface. This operation is only supported for file
|
1296
1326
|
# gateways.
|
1297
1327
|
#
|
@@ -1394,6 +1424,10 @@ module Aws::StorageGateway
|
|
1394
1424
|
#
|
1395
1425
|
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
1396
1426
|
#
|
1427
|
+
# @option params [Boolean] :access_based_enumeration
|
1428
|
+
# The files and folders on this share will only be visible to users with
|
1429
|
+
# read access.
|
1430
|
+
#
|
1397
1431
|
# @option params [Array<String>] :admin_user_list
|
1398
1432
|
# A list of users or groups in the Active Directory that will be granted
|
1399
1433
|
# administrator privileges on the file share. These users can do all
|
@@ -1454,6 +1488,9 @@ module Aws::StorageGateway
|
|
1454
1488
|
# @option params [Types::CacheAttributes] :cache_attributes
|
1455
1489
|
# Refresh cache information.
|
1456
1490
|
#
|
1491
|
+
# @option params [String] :notification_policy
|
1492
|
+
# The notification policy of the file share.
|
1493
|
+
#
|
1457
1494
|
# @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1458
1495
|
#
|
1459
1496
|
# * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1473,6 +1510,7 @@ module Aws::StorageGateway
|
|
1473
1510
|
# guess_mime_type_enabled: false,
|
1474
1511
|
# requester_pays: false,
|
1475
1512
|
# smbacl_enabled: false,
|
1513
|
+
# access_based_enumeration: false,
|
1476
1514
|
# admin_user_list: ["FileShareUser"],
|
1477
1515
|
# valid_user_list: ["FileShareUser"],
|
1478
1516
|
# invalid_user_list: ["FileShareUser"],
|
@@ -1489,6 +1527,7 @@ module Aws::StorageGateway
|
|
1489
1527
|
# cache_attributes: {
|
1490
1528
|
# cache_stale_timeout_in_seconds: 1,
|
1491
1529
|
# },
|
1530
|
+
# notification_policy: "NotificationPolicy",
|
1492
1531
|
# })
|
1493
1532
|
#
|
1494
1533
|
# @example Response structure
|
@@ -1511,14 +1550,14 @@ module Aws::StorageGateway
|
|
1511
1550
|
# durable off-site recovery, as well as import the data to an Amazon
|
1512
1551
|
# Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
|
1513
1552
|
# (EC2). You can take snapshots of your gateway volume on a scheduled or
|
1514
|
-
# ad hoc basis. This API enables you to take ad
|
1515
|
-
# information, see [Editing a snapshot schedule][1].
|
1553
|
+
# ad hoc basis. This API enables you to take an ad hoc snapshot. For
|
1554
|
+
# more information, see [Editing a snapshot schedule][1].
|
1516
1555
|
#
|
1517
|
-
# In the CreateSnapshot request you identify the volume by providing
|
1518
|
-
# Amazon Resource Name (ARN). You must also provide description for
|
1519
|
-
# snapshot. When AWS Storage Gateway takes the snapshot of specified
|
1556
|
+
# In the `CreateSnapshot` request, you identify the volume by providing
|
1557
|
+
# its Amazon Resource Name (ARN). You must also provide description for
|
1558
|
+
# the snapshot. When AWS Storage Gateway takes the snapshot of specified
|
1520
1559
|
# volume, the snapshot and description appears in the AWS Storage
|
1521
|
-
# Gateway
|
1560
|
+
# Gateway console. In response, AWS Storage Gateway returns you a
|
1522
1561
|
# snapshot ID. You can use this snapshot ID to check the snapshot
|
1523
1562
|
# progress or later use it when you want to create a volume from a
|
1524
1563
|
# snapshot. This operation is only supported in stored and cached volume
|
@@ -1719,7 +1758,7 @@ module Aws::StorageGateway
|
|
1719
1758
|
# create an empty gateway volume, then any existing data on the disk is
|
1720
1759
|
# erased.
|
1721
1760
|
#
|
1722
|
-
# In the request you must specify the gateway and the disk information
|
1761
|
+
# In the request, you must specify the gateway and the disk information
|
1723
1762
|
# on which you are creating the volume. In response, the gateway creates
|
1724
1763
|
# the volume and returns volume information such as the volume Amazon
|
1725
1764
|
# Resource Name (ARN), its size, and the iSCSI target ARN that
|
@@ -1858,9 +1897,75 @@ module Aws::StorageGateway
|
|
1858
1897
|
req.send_request(options)
|
1859
1898
|
end
|
1860
1899
|
|
1900
|
+
# Creates a new custom tape pool. You can use custom tape pool to enable
|
1901
|
+
# tape retention lock on tapes that are archived in the custom pool.
|
1902
|
+
#
|
1903
|
+
# @option params [required, String] :pool_name
|
1904
|
+
# The name of the new custom tape pool.
|
1905
|
+
#
|
1906
|
+
# @option params [required, String] :storage_class
|
1907
|
+
# The storage class that is associated with the new custom pool. When
|
1908
|
+
# you use your backup application to eject the tape, the tape is
|
1909
|
+
# archived directly into the storage class (S3 Glacier or S3 Glacier
|
1910
|
+
# Deep Archive) that corresponds to the pool.
|
1911
|
+
#
|
1912
|
+
# @option params [String] :retention_lock_type
|
1913
|
+
# Tape retention lock can be configured in two modes. When configured in
|
1914
|
+
# governance mode, AWS accounts with specific IAM permissions are
|
1915
|
+
# authorized to remove the tape retention lock from archived virtual
|
1916
|
+
# tapes. When configured in compliance mode, the tape retention lock
|
1917
|
+
# cannot be removed by any user, including the root AWS account.
|
1918
|
+
#
|
1919
|
+
# @option params [Integer] :retention_lock_time_in_days
|
1920
|
+
# Tape retention lock time is set in days. Tape retention lock can be
|
1921
|
+
# enabled for up to 100 years (36,500 days).
|
1922
|
+
#
|
1923
|
+
# @option params [Array<Types::Tag>] :tags
|
1924
|
+
# A list of up to 50 tags that can be assigned to tape pool. Each tag is
|
1925
|
+
# a key-value pair.
|
1926
|
+
#
|
1927
|
+
# <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
|
1928
|
+
# representable in UTF-8 format, and the following special characters: +
|
1929
|
+
# - = . \_ : / @. The maximum length of a tag's key is 128 characters,
|
1930
|
+
# and the maximum length for a tag's value is 256.
|
1931
|
+
#
|
1932
|
+
# </note>
|
1933
|
+
#
|
1934
|
+
# @return [Types::CreateTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1935
|
+
#
|
1936
|
+
# * {Types::CreateTapePoolOutput#pool_arn #pool_arn} => String
|
1937
|
+
#
|
1938
|
+
# @example Request syntax with placeholder values
|
1939
|
+
#
|
1940
|
+
# resp = client.create_tape_pool({
|
1941
|
+
# pool_name: "PoolName", # required
|
1942
|
+
# storage_class: "DEEP_ARCHIVE", # required, accepts DEEP_ARCHIVE, GLACIER
|
1943
|
+
# retention_lock_type: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE, NONE
|
1944
|
+
# retention_lock_time_in_days: 1,
|
1945
|
+
# tags: [
|
1946
|
+
# {
|
1947
|
+
# key: "TagKey", # required
|
1948
|
+
# value: "TagValue", # required
|
1949
|
+
# },
|
1950
|
+
# ],
|
1951
|
+
# })
|
1952
|
+
#
|
1953
|
+
# @example Response structure
|
1954
|
+
#
|
1955
|
+
# resp.pool_arn #=> String
|
1956
|
+
#
|
1957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePool AWS API Documentation
|
1958
|
+
#
|
1959
|
+
# @overload create_tape_pool(params = {})
|
1960
|
+
# @param [Hash] params ({})
|
1961
|
+
def create_tape_pool(params = {}, options = {})
|
1962
|
+
req = build_request(:create_tape_pool, params)
|
1963
|
+
req.send_request(options)
|
1964
|
+
end
|
1965
|
+
|
1861
1966
|
# Creates a virtual tape by using your own barcode. You write data to
|
1862
1967
|
# the virtual tape and then archive the tape. A barcode is unique and
|
1863
|
-
#
|
1968
|
+
# cannot be reused if it has already been used on a tape. This applies
|
1864
1969
|
# to barcodes used on deleted tapes. This operation is only supported in
|
1865
1970
|
# the tape gateway type.
|
1866
1971
|
#
|
@@ -1911,6 +2016,10 @@ module Aws::StorageGateway
|
|
1911
2016
|
#
|
1912
2017
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1913
2018
|
#
|
2019
|
+
# @option params [Boolean] :worm
|
2020
|
+
# Set to `TRUE` if the tape you are creating is to be configured as a
|
2021
|
+
# write-once-read-many (WORM) tape.
|
2022
|
+
#
|
1914
2023
|
# @option params [Array<Types::Tag>] :tags
|
1915
2024
|
# A list of up to 50 tags that can be assigned to a virtual tape that
|
1916
2025
|
# has a barcode. Each tag is a key-value pair.
|
@@ -1951,6 +2060,7 @@ module Aws::StorageGateway
|
|
1951
2060
|
# kms_encrypted: false,
|
1952
2061
|
# kms_key: "KMSKey",
|
1953
2062
|
# pool_id: "PoolId",
|
2063
|
+
# worm: false,
|
1954
2064
|
# tags: [
|
1955
2065
|
# {
|
1956
2066
|
# key: "TagKey", # required
|
@@ -2037,6 +2147,10 @@ module Aws::StorageGateway
|
|
2037
2147
|
#
|
2038
2148
|
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
2039
2149
|
#
|
2150
|
+
# @option params [Boolean] :worm
|
2151
|
+
# Set to `TRUE` if the tape you are creating is to be configured as a
|
2152
|
+
# write-once-read-many (WORM) tape.
|
2153
|
+
#
|
2040
2154
|
# @option params [Array<Types::Tag>] :tags
|
2041
2155
|
# A list of up to 50 tags that can be assigned to a virtual tape. Each
|
2042
2156
|
# tag is a key-value pair.
|
@@ -2085,6 +2199,7 @@ module Aws::StorageGateway
|
|
2085
2199
|
# kms_encrypted: false,
|
2086
2200
|
# kms_key: "KMSKey",
|
2087
2201
|
# pool_id: "PoolId",
|
2202
|
+
# worm: false,
|
2088
2203
|
# tags: [
|
2089
2204
|
# {
|
2090
2205
|
# key: "TagKey", # required
|
@@ -2156,7 +2271,7 @@ module Aws::StorageGateway
|
|
2156
2271
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
2157
2272
|
# rate limit to delete.
|
2158
2273
|
#
|
2159
|
-
# Valid Values: `
|
2274
|
+
# Valid Values: `UPLOAD` \| `DOWNLOAD` \| `ALL`
|
2160
2275
|
#
|
2161
2276
|
# @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2162
2277
|
#
|
@@ -2373,7 +2488,7 @@ module Aws::StorageGateway
|
|
2373
2488
|
#
|
2374
2489
|
#
|
2375
2490
|
#
|
2376
|
-
# [1]: https://docs.aws.amazon.com/
|
2491
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html
|
2377
2492
|
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
2378
2493
|
#
|
2379
2494
|
# @option params [required, String] :volume_arn
|
@@ -2427,6 +2542,12 @@ module Aws::StorageGateway
|
|
2427
2542
|
# @option params [required, String] :tape_arn
|
2428
2543
|
# The Amazon Resource Name (ARN) of the virtual tape to delete.
|
2429
2544
|
#
|
2545
|
+
# @option params [Boolean] :bypass_governance_retention
|
2546
|
+
# Set to `TRUE` to delete an archived tape that belongs to a custom pool
|
2547
|
+
# with tape retention lock. Only archived tapes with tape retention lock
|
2548
|
+
# set to `governance` can be deleted. Archived tapes with tape retention
|
2549
|
+
# lock set to `compliance` can't be deleted.
|
2550
|
+
#
|
2430
2551
|
# @return [Types::DeleteTapeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2431
2552
|
#
|
2432
2553
|
# * {Types::DeleteTapeOutput#tape_arn #tape_arn} => String
|
@@ -2451,6 +2572,7 @@ module Aws::StorageGateway
|
|
2451
2572
|
# resp = client.delete_tape({
|
2452
2573
|
# gateway_arn: "GatewayARN", # required
|
2453
2574
|
# tape_arn: "TapeARN", # required
|
2575
|
+
# bypass_governance_retention: false,
|
2454
2576
|
# })
|
2455
2577
|
#
|
2456
2578
|
# @example Response structure
|
@@ -2473,6 +2595,12 @@ module Aws::StorageGateway
|
|
2473
2595
|
# The Amazon Resource Name (ARN) of the virtual tape to delete from the
|
2474
2596
|
# virtual tape shelf (VTS).
|
2475
2597
|
#
|
2598
|
+
# @option params [Boolean] :bypass_governance_retention
|
2599
|
+
# Set to `TRUE` to delete an archived tape that belongs to a custom pool
|
2600
|
+
# with tape retention lock. Only archived tapes with tape retention lock
|
2601
|
+
# set to `governance` can be deleted. Archived tapes with tape retention
|
2602
|
+
# lock set to `compliance` can't be deleted.
|
2603
|
+
#
|
2476
2604
|
# @return [Types::DeleteTapeArchiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2477
2605
|
#
|
2478
2606
|
# * {Types::DeleteTapeArchiveOutput#tape_arn #tape_arn} => String
|
@@ -2495,6 +2623,7 @@ module Aws::StorageGateway
|
|
2495
2623
|
#
|
2496
2624
|
# resp = client.delete_tape_archive({
|
2497
2625
|
# tape_arn: "TapeARN", # required
|
2626
|
+
# bypass_governance_retention: false,
|
2498
2627
|
# })
|
2499
2628
|
#
|
2500
2629
|
# @example Response structure
|
@@ -2510,6 +2639,36 @@ module Aws::StorageGateway
|
|
2510
2639
|
req.send_request(options)
|
2511
2640
|
end
|
2512
2641
|
|
2642
|
+
# Delete a custom tape pool. A custom tape pool can only be deleted if
|
2643
|
+
# there are no tapes in the pool and if there are no automatic tape
|
2644
|
+
# creation policies that reference the custom tape pool.
|
2645
|
+
#
|
2646
|
+
# @option params [required, String] :pool_arn
|
2647
|
+
# The Amazon Resource Name (ARN) of the custom tape pool to delete.
|
2648
|
+
#
|
2649
|
+
# @return [Types::DeleteTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2650
|
+
#
|
2651
|
+
# * {Types::DeleteTapePoolOutput#pool_arn #pool_arn} => String
|
2652
|
+
#
|
2653
|
+
# @example Request syntax with placeholder values
|
2654
|
+
#
|
2655
|
+
# resp = client.delete_tape_pool({
|
2656
|
+
# pool_arn: "PoolARN", # required
|
2657
|
+
# })
|
2658
|
+
#
|
2659
|
+
# @example Response structure
|
2660
|
+
#
|
2661
|
+
# resp.pool_arn #=> String
|
2662
|
+
#
|
2663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapePool AWS API Documentation
|
2664
|
+
#
|
2665
|
+
# @overload delete_tape_pool(params = {})
|
2666
|
+
# @param [Hash] params ({})
|
2667
|
+
def delete_tape_pool(params = {}, options = {})
|
2668
|
+
req = build_request(:delete_tape_pool, params)
|
2669
|
+
req.send_request(options)
|
2670
|
+
end
|
2671
|
+
|
2513
2672
|
# Deletes the specified storage volume that you previously created using
|
2514
2673
|
# the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This
|
2515
2674
|
# operation is only supported in the cached volume and stored volume
|
@@ -2613,7 +2772,7 @@ module Aws::StorageGateway
|
|
2613
2772
|
# Returns the bandwidth rate limits of a gateway. By default, these
|
2614
2773
|
# limits are not set, which means no bandwidth rate limiting is in
|
2615
2774
|
# effect. This operation is supported for the stored volume, cached
|
2616
|
-
# volume and tape gateway types.
|
2775
|
+
# volume, and tape gateway types.
|
2617
2776
|
#
|
2618
2777
|
# This operation only returns a value for a bandwidth rate limit only if
|
2619
2778
|
# the limit is set. If no limits are set for the gateway, then this
|
@@ -3088,6 +3247,7 @@ module Aws::StorageGateway
|
|
3088
3247
|
# resp.nfs_file_share_info_list[0].tags[0].value #=> String
|
3089
3248
|
# resp.nfs_file_share_info_list[0].file_share_name #=> String
|
3090
3249
|
# resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3250
|
+
# resp.nfs_file_share_info_list[0].notification_policy #=> String
|
3091
3251
|
#
|
3092
3252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
|
3093
3253
|
#
|
@@ -3134,6 +3294,7 @@ module Aws::StorageGateway
|
|
3134
3294
|
# resp.smb_file_share_info_list[0].guess_mime_type_enabled #=> Boolean
|
3135
3295
|
# resp.smb_file_share_info_list[0].requester_pays #=> Boolean
|
3136
3296
|
# resp.smb_file_share_info_list[0].smbacl_enabled #=> Boolean
|
3297
|
+
# resp.smb_file_share_info_list[0].access_based_enumeration #=> Boolean
|
3137
3298
|
# resp.smb_file_share_info_list[0].admin_user_list #=> Array
|
3138
3299
|
# resp.smb_file_share_info_list[0].admin_user_list[0] #=> String
|
3139
3300
|
# resp.smb_file_share_info_list[0].valid_user_list #=> Array
|
@@ -3148,6 +3309,7 @@ module Aws::StorageGateway
|
|
3148
3309
|
# resp.smb_file_share_info_list[0].tags[0].value #=> String
|
3149
3310
|
# resp.smb_file_share_info_list[0].file_share_name #=> String
|
3150
3311
|
# resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3312
|
+
# resp.smb_file_share_info_list[0].notification_policy #=> String
|
3151
3313
|
#
|
3152
3314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
|
3153
3315
|
#
|
@@ -3174,6 +3336,7 @@ module Aws::StorageGateway
|
|
3174
3336
|
# * {Types::DescribeSMBSettingsOutput#active_directory_status #active_directory_status} => String
|
3175
3337
|
# * {Types::DescribeSMBSettingsOutput#smb_guest_password_set #smb_guest_password_set} => Boolean
|
3176
3338
|
# * {Types::DescribeSMBSettingsOutput#smb_security_strategy #smb_security_strategy} => String
|
3339
|
+
# * {Types::DescribeSMBSettingsOutput#file_shares_visible #file_shares_visible} => Boolean
|
3177
3340
|
#
|
3178
3341
|
# @example Request syntax with placeholder values
|
3179
3342
|
#
|
@@ -3188,6 +3351,7 @@ module Aws::StorageGateway
|
|
3188
3351
|
# resp.active_directory_status #=> String, one of "ACCESS_DENIED", "DETACHED", "JOINED", "JOINING", "NETWORK_ERROR", "TIMEOUT", "UNKNOWN_ERROR"
|
3189
3352
|
# resp.smb_guest_password_set #=> Boolean
|
3190
3353
|
# resp.smb_security_strategy #=> String, one of "ClientSpecified", "MandatorySigning", "MandatoryEncryption"
|
3354
|
+
# resp.file_shares_visible #=> Boolean
|
3191
3355
|
#
|
3192
3356
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettings AWS API Documentation
|
3193
3357
|
#
|
@@ -3430,6 +3594,9 @@ module Aws::StorageGateway
|
|
3430
3594
|
# resp.tape_archives[0].tape_used_in_bytes #=> Integer
|
3431
3595
|
# resp.tape_archives[0].kms_key #=> String
|
3432
3596
|
# resp.tape_archives[0].pool_id #=> String
|
3597
|
+
# resp.tape_archives[0].worm #=> Boolean
|
3598
|
+
# resp.tape_archives[0].retention_start_date #=> Time
|
3599
|
+
# resp.tape_archives[0].pool_entry_date #=> Time
|
3433
3600
|
# resp.marker #=> String
|
3434
3601
|
#
|
3435
3602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeArchives AWS API Documentation
|
@@ -3618,6 +3785,9 @@ module Aws::StorageGateway
|
|
3618
3785
|
# resp.tapes[0].tape_used_in_bytes #=> Integer
|
3619
3786
|
# resp.tapes[0].kms_key #=> String
|
3620
3787
|
# resp.tapes[0].pool_id #=> String
|
3788
|
+
# resp.tapes[0].worm #=> Boolean
|
3789
|
+
# resp.tapes[0].retention_start_date #=> Time
|
3790
|
+
# resp.tapes[0].pool_entry_date #=> Time
|
3621
3791
|
# resp.marker #=> String
|
3622
3792
|
#
|
3623
3793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapes AWS API Documentation
|
@@ -4103,6 +4273,7 @@ module Aws::StorageGateway
|
|
4103
4273
|
# resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].pool_id #=> String
|
4104
4274
|
# resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].tape_size_in_bytes #=> Integer
|
4105
4275
|
# resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].minimum_num_tapes #=> Integer
|
4276
|
+
# resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].worm #=> Boolean
|
4106
4277
|
# resp.automatic_tape_creation_policy_infos[0].gateway_arn #=> String
|
4107
4278
|
#
|
4108
4279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies AWS API Documentation
|
@@ -4404,6 +4575,63 @@ module Aws::StorageGateway
|
|
4404
4575
|
req.send_request(options)
|
4405
4576
|
end
|
4406
4577
|
|
4578
|
+
# Lists custom tape pools. You specify custom tape pools to list by
|
4579
|
+
# specifying one or more custom tape pool Amazon Resource Names (ARNs).
|
4580
|
+
# If you don't specify a custom tape pool ARN, the operation lists all
|
4581
|
+
# custom tape pools.
|
4582
|
+
#
|
4583
|
+
# This operation supports pagination. You can optionally specify the
|
4584
|
+
# `Limit` parameter in the body to limit the number of tape pools in the
|
4585
|
+
# response. If the number of tape pools returned in the response is
|
4586
|
+
# truncated, the response includes a `Marker` element that you can use
|
4587
|
+
# in your subsequent request to retrieve the next set of tape pools.
|
4588
|
+
#
|
4589
|
+
# @option params [Array<String>] :pool_arns
|
4590
|
+
# The Amazon Resource Name (ARN) of each of the custom tape pools you
|
4591
|
+
# want to list. If you don't specify a custom tape pool ARN, the
|
4592
|
+
# response lists all custom tape pools.
|
4593
|
+
#
|
4594
|
+
# @option params [String] :marker
|
4595
|
+
# A string that indicates the position at which to begin the returned
|
4596
|
+
# list of tape pools.
|
4597
|
+
#
|
4598
|
+
# @option params [Integer] :limit
|
4599
|
+
# An optional number limit for the tape pools in the list returned by
|
4600
|
+
# this call.
|
4601
|
+
#
|
4602
|
+
# @return [Types::ListTapePoolsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4603
|
+
#
|
4604
|
+
# * {Types::ListTapePoolsOutput#pool_infos #pool_infos} => Array<Types::PoolInfo>
|
4605
|
+
# * {Types::ListTapePoolsOutput#marker #marker} => String
|
4606
|
+
#
|
4607
|
+
# @example Request syntax with placeholder values
|
4608
|
+
#
|
4609
|
+
# resp = client.list_tape_pools({
|
4610
|
+
# pool_arns: ["PoolARN"],
|
4611
|
+
# marker: "Marker",
|
4612
|
+
# limit: 1,
|
4613
|
+
# })
|
4614
|
+
#
|
4615
|
+
# @example Response structure
|
4616
|
+
#
|
4617
|
+
# resp.pool_infos #=> Array
|
4618
|
+
# resp.pool_infos[0].pool_arn #=> String
|
4619
|
+
# resp.pool_infos[0].pool_name #=> String
|
4620
|
+
# resp.pool_infos[0].storage_class #=> String, one of "DEEP_ARCHIVE", "GLACIER"
|
4621
|
+
# resp.pool_infos[0].retention_lock_type #=> String, one of "COMPLIANCE", "GOVERNANCE", "NONE"
|
4622
|
+
# resp.pool_infos[0].retention_lock_time_in_days #=> Integer
|
4623
|
+
# resp.pool_infos[0].pool_status #=> String, one of "ACTIVE", "DELETED"
|
4624
|
+
# resp.marker #=> String
|
4625
|
+
#
|
4626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapePools AWS API Documentation
|
4627
|
+
#
|
4628
|
+
# @overload list_tape_pools(params = {})
|
4629
|
+
# @param [Hash] params ({})
|
4630
|
+
def list_tape_pools(params = {}, options = {})
|
4631
|
+
req = build_request(:list_tape_pools, params)
|
4632
|
+
req.send_request(options)
|
4633
|
+
end
|
4634
|
+
|
4407
4635
|
# Lists virtual tapes in your virtual tape library (VTL) and your
|
4408
4636
|
# virtual tape shelf (VTS). You specify the tapes to list by specifying
|
4409
4637
|
# one or more tape Amazon Resource Names (ARNs). If you don't specify a
|
@@ -4455,6 +4683,8 @@ module Aws::StorageGateway
|
|
4455
4683
|
# resp.tape_infos[0].tape_status #=> String
|
4456
4684
|
# resp.tape_infos[0].gateway_arn #=> String
|
4457
4685
|
# resp.tape_infos[0].pool_id #=> String
|
4686
|
+
# resp.tape_infos[0].retention_start_date #=> Time
|
4687
|
+
# resp.tape_infos[0].pool_entry_date #=> Time
|
4458
4688
|
# resp.marker #=> String
|
4459
4689
|
#
|
4460
4690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes AWS API Documentation
|
@@ -5322,6 +5552,7 @@ module Aws::StorageGateway
|
|
5322
5552
|
# pool_id: "PoolId", # required
|
5323
5553
|
# tape_size_in_bytes: 1, # required
|
5324
5554
|
# minimum_num_tapes: 1, # required
|
5555
|
+
# worm: false,
|
5325
5556
|
# },
|
5326
5557
|
# ],
|
5327
5558
|
# gateway_arn: "GatewayARN", # required
|
@@ -5492,7 +5723,7 @@ module Aws::StorageGateway
|
|
5492
5723
|
# time zone. To specify which gateway to update, use the Amazon Resource
|
5493
5724
|
# Name (ARN) of the gateway in your request.
|
5494
5725
|
#
|
5495
|
-
# <note markdown="1"> For
|
5726
|
+
# <note markdown="1"> For gateways activated after September 2, 2015, the gateway's ARN
|
5496
5727
|
# contains the gateway ID rather than the gateway name. However,
|
5497
5728
|
# changing the name of the gateway has no effect on the gateway's ARN.
|
5498
5729
|
#
|
@@ -5513,7 +5744,7 @@ module Aws::StorageGateway
|
|
5513
5744
|
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
|
5514
5745
|
# you want to use to monitor and log events in the gateway.
|
5515
5746
|
#
|
5516
|
-
# For more information, see [What is Amazon CloudWatch
|
5747
|
+
# For more information, see [What is Amazon CloudWatch Logs?][1]
|
5517
5748
|
#
|
5518
5749
|
#
|
5519
5750
|
#
|
@@ -5710,7 +5941,7 @@ module Aws::StorageGateway
|
|
5710
5941
|
#
|
5711
5942
|
# </note>
|
5712
5943
|
#
|
5713
|
-
# Updates the following file share
|
5944
|
+
# Updates the following file share settings:
|
5714
5945
|
#
|
5715
5946
|
# * Default storage class for your S3 bucket
|
5716
5947
|
#
|
@@ -5722,11 +5953,6 @@ module Aws::StorageGateway
|
|
5722
5953
|
#
|
5723
5954
|
# * Write status of your file share
|
5724
5955
|
#
|
5725
|
-
# <note markdown="1"> To leave a file share field unchanged, set the corresponding input
|
5726
|
-
# field to null. This operation is only supported in file gateways.
|
5727
|
-
#
|
5728
|
-
# </note>
|
5729
|
-
#
|
5730
5956
|
# @option params [required, String] :file_share_arn
|
5731
5957
|
# The Amazon Resource Name (ARN) of the file share to be updated.
|
5732
5958
|
#
|
@@ -5812,6 +6038,9 @@ module Aws::StorageGateway
|
|
5812
6038
|
# @option params [Types::CacheAttributes] :cache_attributes
|
5813
6039
|
# Refresh cache information.
|
5814
6040
|
#
|
6041
|
+
# @option params [String] :notification_policy
|
6042
|
+
# The notification policy of the file share.
|
6043
|
+
#
|
5815
6044
|
# @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5816
6045
|
#
|
5817
6046
|
# * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -5839,6 +6068,7 @@ module Aws::StorageGateway
|
|
5839
6068
|
# cache_attributes: {
|
5840
6069
|
# cache_stale_timeout_in_seconds: 1,
|
5841
6070
|
# },
|
6071
|
+
# notification_policy: "NotificationPolicy",
|
5842
6072
|
# })
|
5843
6073
|
#
|
5844
6074
|
# @example Response structure
|
@@ -5854,10 +6084,11 @@ module Aws::StorageGateway
|
|
5854
6084
|
req.send_request(options)
|
5855
6085
|
end
|
5856
6086
|
|
5857
|
-
# Updates a Server Message Block (SMB) file share.
|
6087
|
+
# Updates a Server Message Block (SMB) file share. This operation is
|
6088
|
+
# only supported for file gateways.
|
5858
6089
|
#
|
5859
6090
|
# <note markdown="1"> To leave a file share field unchanged, set the corresponding input
|
5860
|
-
# field to null.
|
6091
|
+
# field to null.
|
5861
6092
|
#
|
5862
6093
|
# </note>
|
5863
6094
|
#
|
@@ -5949,6 +6180,10 @@ module Aws::StorageGateway
|
|
5949
6180
|
#
|
5950
6181
|
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
5951
6182
|
#
|
6183
|
+
# @option params [Boolean] :access_based_enumeration
|
6184
|
+
# The files and folders on this share will only be visible to users with
|
6185
|
+
# read access.
|
6186
|
+
#
|
5952
6187
|
# @option params [Array<String>] :admin_user_list
|
5953
6188
|
# A list of users or groups in the Active Directory that have
|
5954
6189
|
# administrator rights to the file share. A group must be prefixed with
|
@@ -5990,6 +6225,9 @@ module Aws::StorageGateway
|
|
5990
6225
|
# @option params [Types::CacheAttributes] :cache_attributes
|
5991
6226
|
# Refresh cache information.
|
5992
6227
|
#
|
6228
|
+
# @option params [String] :notification_policy
|
6229
|
+
# The notification policy of the file share.
|
6230
|
+
#
|
5993
6231
|
# @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5994
6232
|
#
|
5995
6233
|
# * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -6006,6 +6244,7 @@ module Aws::StorageGateway
|
|
6006
6244
|
# guess_mime_type_enabled: false,
|
6007
6245
|
# requester_pays: false,
|
6008
6246
|
# smbacl_enabled: false,
|
6247
|
+
# access_based_enumeration: false,
|
6009
6248
|
# admin_user_list: ["FileShareUser"],
|
6010
6249
|
# valid_user_list: ["FileShareUser"],
|
6011
6250
|
# invalid_user_list: ["FileShareUser"],
|
@@ -6015,6 +6254,7 @@ module Aws::StorageGateway
|
|
6015
6254
|
# cache_attributes: {
|
6016
6255
|
# cache_stale_timeout_in_seconds: 1,
|
6017
6256
|
# },
|
6257
|
+
# notification_policy: "NotificationPolicy",
|
6018
6258
|
# })
|
6019
6259
|
#
|
6020
6260
|
# @example Response structure
|
@@ -6030,6 +6270,41 @@ module Aws::StorageGateway
|
|
6030
6270
|
req.send_request(options)
|
6031
6271
|
end
|
6032
6272
|
|
6273
|
+
# Controls whether the shares on a gateway are visible in a net view or
|
6274
|
+
# browse list.
|
6275
|
+
#
|
6276
|
+
# @option params [required, String] :gateway_arn
|
6277
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6278
|
+
# operation to return a list of gateways for your account and AWS
|
6279
|
+
# Region.
|
6280
|
+
#
|
6281
|
+
# @option params [required, Boolean] :file_shares_visible
|
6282
|
+
# The shares on this gateway appear when listing shares.
|
6283
|
+
#
|
6284
|
+
# @return [Types::UpdateSMBFileShareVisibilityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6285
|
+
#
|
6286
|
+
# * {Types::UpdateSMBFileShareVisibilityOutput#gateway_arn #gateway_arn} => String
|
6287
|
+
#
|
6288
|
+
# @example Request syntax with placeholder values
|
6289
|
+
#
|
6290
|
+
# resp = client.update_smb_file_share_visibility({
|
6291
|
+
# gateway_arn: "GatewayARN", # required
|
6292
|
+
# file_shares_visible: false, # required
|
6293
|
+
# })
|
6294
|
+
#
|
6295
|
+
# @example Response structure
|
6296
|
+
#
|
6297
|
+
# resp.gateway_arn #=> String
|
6298
|
+
#
|
6299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareVisibility AWS API Documentation
|
6300
|
+
#
|
6301
|
+
# @overload update_smb_file_share_visibility(params = {})
|
6302
|
+
# @param [Hash] params ({})
|
6303
|
+
def update_smb_file_share_visibility(params = {}, options = {})
|
6304
|
+
req = build_request(:update_smb_file_share_visibility, params)
|
6305
|
+
req.send_request(options)
|
6306
|
+
end
|
6307
|
+
|
6033
6308
|
# Updates the SMB security strategy on a file gateway. This action is
|
6034
6309
|
# only supported in file gateways.
|
6035
6310
|
#
|
@@ -6189,7 +6464,7 @@ module Aws::StorageGateway
|
|
6189
6464
|
# @option params [required, String] :device_type
|
6190
6465
|
# The type of medium changer you want to select.
|
6191
6466
|
#
|
6192
|
-
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
6467
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
|
6193
6468
|
#
|
6194
6469
|
# @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6195
6470
|
#
|
@@ -6243,7 +6518,7 @@ module Aws::StorageGateway
|
|
6243
6518
|
params: params,
|
6244
6519
|
config: config)
|
6245
6520
|
context[:gem_name] = 'aws-sdk-storagegateway'
|
6246
|
-
context[:gem_version] = '1.
|
6521
|
+
context[:gem_version] = '1.51.0'
|
6247
6522
|
Seahorse::Client::Request.new(handlers, context)
|
6248
6523
|
end
|
6249
6524
|
|