aws-sdk-storagegateway 1.55.0 → 1.56.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-storagegateway.rb +1 -1
- data/lib/aws-sdk-storagegateway/client.rb +337 -249
- data/lib/aws-sdk-storagegateway/client_api.rb +29 -0
- data/lib/aws-sdk-storagegateway/types.rb +469 -305
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 73da947879b4b680f56f30be0161a2660b3f64e7c228e27bc3723c4ceb9f7e22
|
4
|
+
data.tar.gz: e51737f3e8e2377b403d2684eaeb057bfd05648aff873835e7064594fb09fdcb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 31ddaf59ee44db7d3a6e442c9825bab6d6d43ca2766961874991853f9bd806641303b7a62f8eff2106400f80fea3e822ea722155cd39eecc8f8d62d1ce861c78
|
7
|
+
data.tar.gz: a83e0c2f6f95bfbd0fd6c99f70a80eb4a8274d2fd6b0d024fd1851d77a434258efc9d47bf378cff905c9a68c0fffae2166f545c58040249691a778b90f70520d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.56.0 (2021-07-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adding support for oplocks for SMB file shares, S3 Access Point and S3 Private Link for all file shares and IP address support for file system associations
|
8
|
+
|
4
9
|
1.55.0 (2021-04-07)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.56.0
|
@@ -338,8 +338,8 @@ module Aws::StorageGateway
|
|
338
338
|
# @!group API Operations
|
339
339
|
|
340
340
|
# Activates the gateway you previously deployed on your host. In the
|
341
|
-
# activation process, you specify information such as the
|
342
|
-
#
|
341
|
+
# activation process, you specify information such as the Region that
|
342
|
+
# you want to use for storing snapshots or tapes, the time zone for
|
343
343
|
# scheduled snapshots the gateway snapshot schedule window, an
|
344
344
|
# activation key, and a name for your gateway. The activation process
|
345
345
|
# also associates your gateway with your account. For more information,
|
@@ -359,8 +359,8 @@ module Aws::StorageGateway
|
|
359
359
|
# pass to the `ActivateGateway` API call determine the actual
|
360
360
|
# configuration of your gateway.
|
361
361
|
#
|
362
|
-
# For more information, see [Getting activation key][1] in the *
|
363
|
-
#
|
362
|
+
# For more information, see [Getting activation key][1] in the *Storage
|
363
|
+
# Gateway User Guide*.
|
364
364
|
#
|
365
365
|
#
|
366
366
|
#
|
@@ -378,15 +378,15 @@ module Aws::StorageGateway
|
|
378
378
|
# schedule.
|
379
379
|
#
|
380
380
|
# @option params [required, String] :gateway_region
|
381
|
-
# A value that indicates the
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
# Gateway
|
386
|
-
#
|
381
|
+
# A value that indicates the Region where you want to store your data.
|
382
|
+
# The gateway Region specified must be the same Region as the Region in
|
383
|
+
# your `Host` header in the request. For more information about
|
384
|
+
# available Regions and endpoints for Storage Gateway, see [ Storage
|
385
|
+
# Gateway endpoints and quotas][1] in the *Amazon Web Services General
|
386
|
+
# Reference*.
|
387
387
|
#
|
388
|
-
# Valid Values: See [
|
389
|
-
# *
|
388
|
+
# Valid Values: See [ Storage Gateway endpoints and quotas][1] in the
|
389
|
+
# *Amazon Web Services General Reference*.
|
390
390
|
#
|
391
391
|
#
|
392
392
|
#
|
@@ -397,7 +397,8 @@ module Aws::StorageGateway
|
|
397
397
|
# specified is critical to all later functions of the gateway and cannot
|
398
398
|
# be changed after activation. The default value is `CACHED`.
|
399
399
|
#
|
400
|
-
# Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
|
400
|
+
# Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3` \|
|
401
|
+
# `FILE_FSX_SMB|`
|
401
402
|
#
|
402
403
|
# @option params [String] :tape_drive_type
|
403
404
|
# The value that indicates the type of tape drive to use for tape
|
@@ -480,7 +481,7 @@ module Aws::StorageGateway
|
|
480
481
|
|
481
482
|
# Configures one or more gateway local disks as cache for a gateway.
|
482
483
|
# This operation is only supported in the cached volume, tape, and file
|
483
|
-
# gateway type (see [How
|
484
|
+
# gateway type (see [How Storage Gateway works (architecture)][1].
|
484
485
|
#
|
485
486
|
# In the request, you specify the gateway Amazon Resource Name (ARN) to
|
486
487
|
# which you want to add cache, and one or more disk IDs that you want to
|
@@ -492,8 +493,7 @@ module Aws::StorageGateway
|
|
492
493
|
#
|
493
494
|
# @option params [required, String] :gateway_arn
|
494
495
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
495
|
-
# operation to return a list of gateways for your account and
|
496
|
-
# Region.
|
496
|
+
# operation to return a list of gateways for your account and Region.
|
497
497
|
#
|
498
498
|
# @option params [required, Array<String>] :disk_ids
|
499
499
|
# An array of strings that identify disks that are to be configured as
|
@@ -546,8 +546,8 @@ module Aws::StorageGateway
|
|
546
546
|
# metadata to resources, which you can use to categorize these
|
547
547
|
# resources. For example, you can categorize resources by purpose,
|
548
548
|
# owner, environment, or team. Each tag consists of a key and a value,
|
549
|
-
# which you define. You can add tags to the following
|
550
|
-
#
|
549
|
+
# which you define. You can add tags to the following Storage Gateway
|
550
|
+
# resources:
|
551
551
|
#
|
552
552
|
# * Storage gateways of all types
|
553
553
|
#
|
@@ -557,6 +557,8 @@ module Aws::StorageGateway
|
|
557
557
|
#
|
558
558
|
# * NFS and SMB file shares
|
559
559
|
#
|
560
|
+
# * File System associations
|
561
|
+
#
|
560
562
|
# You can create a maximum of 50 tags for each resource. Virtual tapes
|
561
563
|
# and storage volumes that are recovered to a new gateway maintain their
|
562
564
|
# tags.
|
@@ -635,8 +637,7 @@ module Aws::StorageGateway
|
|
635
637
|
#
|
636
638
|
# @option params [required, String] :gateway_arn
|
637
639
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
638
|
-
# operation to return a list of gateways for your account and
|
639
|
-
# Region.
|
640
|
+
# operation to return a list of gateways for your account and Region.
|
640
641
|
#
|
641
642
|
# @option params [required, Array<String>] :disk_ids
|
642
643
|
# An array of strings that identify disks that are to be configured as
|
@@ -702,8 +703,7 @@ module Aws::StorageGateway
|
|
702
703
|
#
|
703
704
|
# @option params [required, String] :gateway_arn
|
704
705
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
705
|
-
# operation to return a list of gateways for your account and
|
706
|
-
# Region.
|
706
|
+
# operation to return a list of gateways for your account and Region.
|
707
707
|
#
|
708
708
|
# @option params [required, Array<String>] :disk_ids
|
709
709
|
# An array of strings that identify disks that are to be configured as
|
@@ -809,10 +809,10 @@ module Aws::StorageGateway
|
|
809
809
|
req.send_request(options)
|
810
810
|
end
|
811
811
|
|
812
|
-
# Associate an Amazon FSx file system with the
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
812
|
+
# Associate an Amazon FSx file system with the FSx File Gateway. After
|
813
|
+
# the association process is complete, the file shares on the Amazon FSx
|
814
|
+
# file system are available for access through the gateway. This
|
815
|
+
# operation only supports the FSx File Gateway type.
|
816
816
|
#
|
817
817
|
# @option params [required, String] :user_name
|
818
818
|
# The user name of the user credential that has permission to access the
|
@@ -823,17 +823,16 @@ module Aws::StorageGateway
|
|
823
823
|
# The password of the user credential.
|
824
824
|
#
|
825
825
|
# @option params [required, String] :client_token
|
826
|
-
# A unique string value that you supply that is used by the
|
827
|
-
# to ensure idempotent file system association creation.
|
826
|
+
# A unique string value that you supply that is used by the FSx File
|
827
|
+
# Gateway to ensure idempotent file system association creation.
|
828
828
|
#
|
829
829
|
# @option params [required, String] :gateway_arn
|
830
830
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
831
|
-
# operation to return a list of gateways for your account and
|
832
|
-
# Region.
|
831
|
+
# operation to return a list of gateways for your account and Region.
|
833
832
|
#
|
834
833
|
# @option params [required, String] :location_arn
|
835
834
|
# The Amazon Resource Name (ARN) of the Amazon FSx file system to
|
836
|
-
# associate with the
|
835
|
+
# associate with the FSx File Gateway.
|
837
836
|
#
|
838
837
|
# @option params [Array<Types::Tag>] :tags
|
839
838
|
# A list of up to 50 tags that can be assigned to the file system
|
@@ -843,7 +842,16 @@ module Aws::StorageGateway
|
|
843
842
|
# The Amazon Resource Name (ARN) of the storage used for the audit logs.
|
844
843
|
#
|
845
844
|
# @option params [Types::CacheAttributes] :cache_attributes
|
846
|
-
# The refresh cache information for the file share.
|
845
|
+
# The refresh cache information for the file share or FSx file systems.
|
846
|
+
#
|
847
|
+
# @option params [Types::EndpointNetworkConfiguration] :endpoint_network_configuration
|
848
|
+
# Specifies the network configuration information for the gateway
|
849
|
+
# associated with the Amazon FSx file system.
|
850
|
+
#
|
851
|
+
# <note markdown="1"> If multiple file systems are associated with this gateway, this
|
852
|
+
# parameter's `IpAddresses` field is required.
|
853
|
+
#
|
854
|
+
# </note>
|
847
855
|
#
|
848
856
|
# @return [Types::AssociateFileSystemOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
849
857
|
#
|
@@ -867,6 +875,9 @@ module Aws::StorageGateway
|
|
867
875
|
# cache_attributes: {
|
868
876
|
# cache_stale_timeout_in_seconds: 1,
|
869
877
|
# },
|
878
|
+
# endpoint_network_configuration: {
|
879
|
+
# ip_addresses: ["IPV4Address"],
|
880
|
+
# },
|
870
881
|
# })
|
871
882
|
#
|
872
883
|
# @example Response structure
|
@@ -954,8 +965,7 @@ module Aws::StorageGateway
|
|
954
965
|
#
|
955
966
|
# @option params [required, String] :gateway_arn
|
956
967
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
957
|
-
# operation to return a list of gateways for your account and
|
958
|
-
# Region.
|
968
|
+
# operation to return a list of gateways for your account and Region.
|
959
969
|
#
|
960
970
|
# @option params [required, String] :tape_arn
|
961
971
|
# The Amazon Resource Name (ARN) of the virtual tape you want to cancel
|
@@ -1007,8 +1017,7 @@ module Aws::StorageGateway
|
|
1007
1017
|
#
|
1008
1018
|
# @option params [required, String] :gateway_arn
|
1009
1019
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1010
|
-
# operation to return a list of gateways for your account and
|
1011
|
-
# Region.
|
1020
|
+
# operation to return a list of gateways for your account and Region.
|
1012
1021
|
#
|
1013
1022
|
# @option params [required, String] :tape_arn
|
1014
1023
|
# The Amazon Resource Name (ARN) of the virtual tape you want to cancel
|
@@ -1078,8 +1087,7 @@ module Aws::StorageGateway
|
|
1078
1087
|
#
|
1079
1088
|
# @option params [required, String] :gateway_arn
|
1080
1089
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1081
|
-
# operation to return a list of gateways for your account and
|
1082
|
-
# Region.
|
1090
|
+
# operation to return a list of gateways for your account and Region.
|
1083
1091
|
#
|
1084
1092
|
# @option params [required, Integer] :volume_size_in_bytes
|
1085
1093
|
# The size of the volume in bytes.
|
@@ -1126,7 +1134,7 @@ module Aws::StorageGateway
|
|
1126
1134
|
#
|
1127
1135
|
# @option params [Boolean] :kms_encrypted
|
1128
1136
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1129
|
-
#
|
1137
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1130
1138
|
#
|
1131
1139
|
# Valid Values: `true` \| `false`
|
1132
1140
|
#
|
@@ -1207,21 +1215,20 @@ module Aws::StorageGateway
|
|
1207
1215
|
req.send_request(options)
|
1208
1216
|
end
|
1209
1217
|
|
1210
|
-
# Creates a Network File System (NFS) file share on an existing
|
1211
|
-
#
|
1218
|
+
# Creates a Network File System (NFS) file share on an existing S3 File
|
1219
|
+
# Gateway. In Storage Gateway, a file share is a file system mount point
|
1212
1220
|
# backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
|
1213
|
-
# using an NFS interface. This operation is only supported for
|
1214
|
-
#
|
1221
|
+
# using an NFS interface. This operation is only supported for S3 File
|
1222
|
+
# Gateways.
|
1215
1223
|
#
|
1216
|
-
# File gateway requires
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
# Access Management User Guide*.
|
1224
|
+
# S3 File gateway requires Security Token Service (STS) to be activated
|
1225
|
+
# to enable you to create a file share. Make sure STS is activated in
|
1226
|
+
# the Region you are creating your S3 File Gateway in. If STS is not
|
1227
|
+
# activated in the Region, activate it. For information about how to
|
1228
|
+
# activate STS, see [Activating and deactivating STS in an Region][1] in
|
1229
|
+
# the *Identity and Access Management User Guide*.
|
1223
1230
|
#
|
1224
|
-
# File
|
1231
|
+
# S3 File Gateways do not support creating hard or symbolic links on a
|
1225
1232
|
# file share.
|
1226
1233
|
#
|
1227
1234
|
#
|
@@ -1229,19 +1236,19 @@ module Aws::StorageGateway
|
|
1229
1236
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
|
1230
1237
|
#
|
1231
1238
|
# @option params [required, String] :client_token
|
1232
|
-
# A unique string value that you supply that is used by
|
1233
|
-
# ensure idempotent file share creation.
|
1239
|
+
# A unique string value that you supply that is used by S3 File Gateway
|
1240
|
+
# to ensure idempotent file share creation.
|
1234
1241
|
#
|
1235
1242
|
# @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
|
1236
1243
|
# File share default values. Optional.
|
1237
1244
|
#
|
1238
1245
|
# @option params [required, String] :gateway_arn
|
1239
|
-
# The Amazon Resource Name (ARN) of the
|
1240
|
-
# to create a file share.
|
1246
|
+
# The Amazon Resource Name (ARN) of the S3 File Gateway on which you
|
1247
|
+
# want to create a file share.
|
1241
1248
|
#
|
1242
1249
|
# @option params [Boolean] :kms_encrypted
|
1243
1250
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1244
|
-
#
|
1251
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1245
1252
|
#
|
1246
1253
|
# Valid Values: `true` \| `false`
|
1247
1254
|
#
|
@@ -1252,16 +1259,32 @@ module Aws::StorageGateway
|
|
1252
1259
|
# `KMSEncrypted` is `true`. Optional.
|
1253
1260
|
#
|
1254
1261
|
# @option params [required, String] :role
|
1255
|
-
# The ARN of the
|
1256
|
-
#
|
1262
|
+
# The ARN of the Identity and Access Management (IAM) role that an S3
|
1263
|
+
# File Gateway assumes when it accesses the underlying storage.
|
1257
1264
|
#
|
1258
1265
|
# @option params [required, String] :location_arn
|
1259
1266
|
# The ARN of the backend storage used for storing file data. A prefix
|
1260
1267
|
# name can be added to the S3 bucket name. It must end with a "/".
|
1261
1268
|
#
|
1269
|
+
# <note markdown="1"> You can specify a bucket attached to an access point using a complete
|
1270
|
+
# ARN that includes the bucket region as shown:
|
1271
|
+
#
|
1272
|
+
# `arn:aws:s3:region:account-id:accesspoint/access-point-name `
|
1273
|
+
#
|
1274
|
+
# If you specify a bucket attached to an access point, the bucket policy
|
1275
|
+
# must be configured to delegate access control to the access point. For
|
1276
|
+
# information, see [Delegating access control to access points][1] in
|
1277
|
+
# the *Amazon S3 User Guide*.
|
1278
|
+
#
|
1279
|
+
# </note>
|
1280
|
+
#
|
1281
|
+
#
|
1282
|
+
#
|
1283
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control
|
1284
|
+
#
|
1262
1285
|
# @option params [String] :default_storage_class
|
1263
1286
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1264
|
-
# the
|
1287
|
+
# the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1265
1288
|
# Optional.
|
1266
1289
|
#
|
1267
1290
|
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
@@ -1269,12 +1292,12 @@ module Aws::StorageGateway
|
|
1269
1292
|
#
|
1270
1293
|
# @option params [String] :object_acl
|
1271
1294
|
# A value that sets the access control list (ACL) permission for objects
|
1272
|
-
# in the S3 bucket that a
|
1295
|
+
# in the S3 bucket that a S3 File Gateway puts objects into. The default
|
1273
1296
|
# value is `private`.
|
1274
1297
|
#
|
1275
1298
|
# @option params [Array<String>] :client_list
|
1276
|
-
# The list of clients that are allowed to access the
|
1277
|
-
# list must contain either valid IP addresses or valid CIDR blocks.
|
1299
|
+
# The list of clients that are allowed to access the S3 File Gateway.
|
1300
|
+
# The list must contain either valid IP addresses or valid CIDR blocks.
|
1278
1301
|
#
|
1279
1302
|
# @option params [String] :squash
|
1280
1303
|
# A value that maps a user to anonymous user.
|
@@ -1360,6 +1383,26 @@ module Aws::StorageGateway
|
|
1360
1383
|
#
|
1361
1384
|
# `\{\}`
|
1362
1385
|
#
|
1386
|
+
# @option params [String] :vpc_endpoint_dns_name
|
1387
|
+
# Specifies the DNS name for the VPC endpoint that the NFS file share
|
1388
|
+
# uses to connect to Amazon S3.
|
1389
|
+
#
|
1390
|
+
# <note markdown="1"> This parameter is required for NFS file shares that connect to Amazon
|
1391
|
+
# S3 through a VPC endpoint, a VPC access point, or an access point
|
1392
|
+
# alias that points to a VPC access point.
|
1393
|
+
#
|
1394
|
+
# </note>
|
1395
|
+
#
|
1396
|
+
# @option params [String] :bucket_region
|
1397
|
+
# Specifies the Region of the S3 bucket where the NFS file share stores
|
1398
|
+
# files.
|
1399
|
+
#
|
1400
|
+
# <note markdown="1"> This parameter is required for NFS file shares that connect to Amazon
|
1401
|
+
# S3 through a VPC endpoint, a VPC access point, or an access point
|
1402
|
+
# alias that points to a VPC access point.
|
1403
|
+
#
|
1404
|
+
# </note>
|
1405
|
+
#
|
1363
1406
|
# @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1364
1407
|
#
|
1365
1408
|
# * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1397,6 +1440,8 @@ module Aws::StorageGateway
|
|
1397
1440
|
# cache_stale_timeout_in_seconds: 1,
|
1398
1441
|
# },
|
1399
1442
|
# notification_policy: "NotificationPolicy",
|
1443
|
+
# vpc_endpoint_dns_name: "DNSHostName",
|
1444
|
+
# bucket_region: "RegionId",
|
1400
1445
|
# })
|
1401
1446
|
#
|
1402
1447
|
# @example Response structure
|
@@ -1412,19 +1457,18 @@ module Aws::StorageGateway
|
|
1412
1457
|
req.send_request(options)
|
1413
1458
|
end
|
1414
1459
|
|
1415
|
-
# Creates a Server Message Block (SMB) file share on an existing
|
1416
|
-
#
|
1460
|
+
# Creates a Server Message Block (SMB) file share on an existing S3 File
|
1461
|
+
# Gateway. In Storage Gateway, a file share is a file system mount point
|
1417
1462
|
# backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
|
1418
|
-
# using an SMB interface. This operation is only supported for
|
1419
|
-
#
|
1463
|
+
# using an SMB interface. This operation is only supported for S3 File
|
1464
|
+
# Gateways.
|
1420
1465
|
#
|
1421
|
-
# File
|
1422
|
-
#
|
1423
|
-
#
|
1424
|
-
#
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
# Access Management User Guide*.
|
1466
|
+
# S3 File Gateways require Security Token Service (STS) to be activated
|
1467
|
+
# to enable you to create a file share. Make sure that STS is activated
|
1468
|
+
# in the Region you are creating your S3 File Gateway in. If STS is not
|
1469
|
+
# activated in this Region, activate it. For information about how to
|
1470
|
+
# activate STS, see [Activating and deactivating STS in an Region][1] in
|
1471
|
+
# the *Identity and Access Management User Guide*.
|
1428
1472
|
#
|
1429
1473
|
# File gateways don't support creating hard or symbolic links on a
|
1430
1474
|
# file
|
@@ -1435,15 +1479,16 @@ module Aws::StorageGateway
|
|
1435
1479
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
|
1436
1480
|
#
|
1437
1481
|
# @option params [required, String] :client_token
|
1438
|
-
# A unique string value that you supply that is used by
|
1439
|
-
# ensure idempotent file share creation.
|
1482
|
+
# A unique string value that you supply that is used by S3 File Gateway
|
1483
|
+
# to ensure idempotent file share creation.
|
1440
1484
|
#
|
1441
1485
|
# @option params [required, String] :gateway_arn
|
1442
|
-
# The ARN of the
|
1486
|
+
# The ARN of the S3 File Gateway on which you want to create a file
|
1487
|
+
# share.
|
1443
1488
|
#
|
1444
1489
|
# @option params [Boolean] :kms_encrypted
|
1445
1490
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1446
|
-
#
|
1491
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1447
1492
|
#
|
1448
1493
|
# Valid Values: `true` \| `false`
|
1449
1494
|
#
|
@@ -1454,16 +1499,32 @@ module Aws::StorageGateway
|
|
1454
1499
|
# `KMSEncrypted` is `true`. Optional.
|
1455
1500
|
#
|
1456
1501
|
# @option params [required, String] :role
|
1457
|
-
# The ARN of the
|
1458
|
-
#
|
1502
|
+
# The ARN of the Identity and Access Management (IAM) role that an S3
|
1503
|
+
# File Gateway assumes when it accesses the underlying storage.
|
1459
1504
|
#
|
1460
1505
|
# @option params [required, String] :location_arn
|
1461
1506
|
# The ARN of the backend storage used for storing file data. A prefix
|
1462
1507
|
# name can be added to the S3 bucket name. It must end with a "/".
|
1463
1508
|
#
|
1509
|
+
# <note markdown="1"> You can specify a bucket attached to an access point using a complete
|
1510
|
+
# ARN that includes the bucket region as shown:
|
1511
|
+
#
|
1512
|
+
# `arn:aws:s3:region:account-id:accesspoint/access-point-name `
|
1513
|
+
#
|
1514
|
+
# If you specify a bucket attached to an access point, the bucket policy
|
1515
|
+
# must be configured to delegate access control to the access point. For
|
1516
|
+
# information, see [Delegating access control to access points][1] in
|
1517
|
+
# the *Amazon S3 User Guide*.
|
1518
|
+
#
|
1519
|
+
# </note>
|
1520
|
+
#
|
1521
|
+
#
|
1522
|
+
#
|
1523
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control
|
1524
|
+
#
|
1464
1525
|
# @option params [String] :default_storage_class
|
1465
1526
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1466
|
-
# the
|
1527
|
+
# the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1467
1528
|
# Optional.
|
1468
1529
|
#
|
1469
1530
|
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
@@ -1471,7 +1532,7 @@ module Aws::StorageGateway
|
|
1471
1532
|
#
|
1472
1533
|
# @option params [String] :object_acl
|
1473
1534
|
# A value that sets the access control list (ACL) permission for objects
|
1474
|
-
# in the S3 bucket that a
|
1535
|
+
# in the S3 bucket that a S3 File Gateway puts objects into. The default
|
1475
1536
|
# value is `private`.
|
1476
1537
|
#
|
1477
1538
|
# @option params [Boolean] :read_only
|
@@ -1508,8 +1569,7 @@ module Aws::StorageGateway
|
|
1508
1569
|
# permissions to the POSIX permissions.
|
1509
1570
|
#
|
1510
1571
|
# For more information, see [Using Microsoft Windows ACLs to control
|
1511
|
-
# access to an SMB file share][1] in the *
|
1512
|
-
# Guide*.
|
1572
|
+
# access to an SMB file share][1] in the *Storage Gateway User Guide*.
|
1513
1573
|
#
|
1514
1574
|
# Valid Values: `true` \| `false`
|
1515
1575
|
#
|
@@ -1604,6 +1664,38 @@ module Aws::StorageGateway
|
|
1604
1664
|
#
|
1605
1665
|
# `\{\}`
|
1606
1666
|
#
|
1667
|
+
# @option params [String] :vpc_endpoint_dns_name
|
1668
|
+
# Specifies the DNS name for the VPC endpoint that the SMB file share
|
1669
|
+
# uses to connect to Amazon S3.
|
1670
|
+
#
|
1671
|
+
# <note markdown="1"> This parameter is required for SMB file shares that connect to Amazon
|
1672
|
+
# S3 through a VPC endpoint, a VPC access point, or an access point
|
1673
|
+
# alias that points to a VPC access point.
|
1674
|
+
#
|
1675
|
+
# </note>
|
1676
|
+
#
|
1677
|
+
# @option params [String] :bucket_region
|
1678
|
+
# Specifies the Region of the S3 bucket where the SMB file share stores
|
1679
|
+
# files.
|
1680
|
+
#
|
1681
|
+
# <note markdown="1"> This parameter is required for SMB file shares that connect to Amazon
|
1682
|
+
# S3 through a VPC endpoint, a VPC access point, or an access point
|
1683
|
+
# alias that points to a VPC access point.
|
1684
|
+
#
|
1685
|
+
# </note>
|
1686
|
+
#
|
1687
|
+
# @option params [Boolean] :oplocks_enabled
|
1688
|
+
# Specifies whether opportunistic locking is enabled for the SMB file
|
1689
|
+
# share.
|
1690
|
+
#
|
1691
|
+
# <note markdown="1"> Enabling opportunistic locking on case-sensitive shares is not
|
1692
|
+
# recommended for workloads that involve access to files with the same
|
1693
|
+
# name in different case.
|
1694
|
+
#
|
1695
|
+
# </note>
|
1696
|
+
#
|
1697
|
+
# Valid Values: `true` \| `false`
|
1698
|
+
#
|
1607
1699
|
# @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1608
1700
|
#
|
1609
1701
|
# * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1641,6 +1733,9 @@ module Aws::StorageGateway
|
|
1641
1733
|
# cache_stale_timeout_in_seconds: 1,
|
1642
1734
|
# },
|
1643
1735
|
# notification_policy: "NotificationPolicy",
|
1736
|
+
# vpc_endpoint_dns_name: "DNSHostName",
|
1737
|
+
# bucket_region: "RegionId",
|
1738
|
+
# oplocks_enabled: false,
|
1644
1739
|
# })
|
1645
1740
|
#
|
1646
1741
|
# @example Response structure
|
@@ -1658,7 +1753,7 @@ module Aws::StorageGateway
|
|
1658
1753
|
|
1659
1754
|
# Initiates a snapshot of a volume.
|
1660
1755
|
#
|
1661
|
-
#
|
1756
|
+
# Storage Gateway provides the ability to back up point-in-time
|
1662
1757
|
# snapshots of your data to Amazon Simple Storage (Amazon S3) for
|
1663
1758
|
# durable off-site recovery, and also import the data to an Amazon
|
1664
1759
|
# Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
|
@@ -1668,13 +1763,12 @@ module Aws::StorageGateway
|
|
1668
1763
|
#
|
1669
1764
|
# In the `CreateSnapshot` request, you identify the volume by providing
|
1670
1765
|
# its Amazon Resource Name (ARN). You must also provide description for
|
1671
|
-
# the snapshot. When
|
1672
|
-
# volume, the snapshot and description appears in the
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
-
# gateway type.
|
1766
|
+
# the snapshot. When Storage Gateway takes the snapshot of specified
|
1767
|
+
# volume, the snapshot and description appears in the Storage Gateway
|
1768
|
+
# console. In response, Storage Gateway returns you a snapshot ID. You
|
1769
|
+
# can use this snapshot ID to check the snapshot progress or later use
|
1770
|
+
# it when you want to create a volume from a snapshot. This operation is
|
1771
|
+
# only supported in stored and cached volume gateway type.
|
1678
1772
|
#
|
1679
1773
|
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
|
1680
1774
|
# more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
|
@@ -1699,7 +1793,7 @@ module Aws::StorageGateway
|
|
1699
1793
|
# @option params [required, String] :snapshot_description
|
1700
1794
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1701
1795
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1702
|
-
# field, and in the
|
1796
|
+
# field, and in the Storage Gateway snapshot **Details** pane,
|
1703
1797
|
# **Description** field.
|
1704
1798
|
#
|
1705
1799
|
# @option params [Array<Types::Tag>] :tags
|
@@ -1773,7 +1867,7 @@ module Aws::StorageGateway
|
|
1773
1867
|
# the volume by providing its Amazon Resource Name (ARN). You must also
|
1774
1868
|
# provide a description for the snapshot. When the gateway takes a
|
1775
1869
|
# snapshot of the specified volume, the snapshot and its description
|
1776
|
-
# appear in the
|
1870
|
+
# appear in the Storage Gateway console. In response, the gateway
|
1777
1871
|
# returns you a snapshot ID. You can use this snapshot ID to check the
|
1778
1872
|
# snapshot progress or later use it when you want to create a volume
|
1779
1873
|
# from a snapshot.
|
@@ -1797,7 +1891,7 @@ module Aws::StorageGateway
|
|
1797
1891
|
# @option params [required, String] :snapshot_description
|
1798
1892
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1799
1893
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1800
|
-
# field, and in the
|
1894
|
+
# field, and in the Storage Gateway snapshot **Details** pane,
|
1801
1895
|
# **Description** field.
|
1802
1896
|
#
|
1803
1897
|
# @option params [Array<Types::Tag>] :tags
|
@@ -1879,8 +1973,7 @@ module Aws::StorageGateway
|
|
1879
1973
|
#
|
1880
1974
|
# @option params [required, String] :gateway_arn
|
1881
1975
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1882
|
-
# operation to return a list of gateways for your account and
|
1883
|
-
# Region.
|
1976
|
+
# operation to return a list of gateways for your account and Region.
|
1884
1977
|
#
|
1885
1978
|
# @option params [required, String] :disk_id
|
1886
1979
|
# The unique identifier for the gateway local disk that is configured as
|
@@ -1928,7 +2021,7 @@ module Aws::StorageGateway
|
|
1928
2021
|
#
|
1929
2022
|
# @option params [Boolean] :kms_encrypted
|
1930
2023
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1931
|
-
#
|
2024
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1932
2025
|
#
|
1933
2026
|
# Valid Values: `true` \| `false`
|
1934
2027
|
#
|
@@ -2024,10 +2117,10 @@ module Aws::StorageGateway
|
|
2024
2117
|
#
|
2025
2118
|
# @option params [String] :retention_lock_type
|
2026
2119
|
# Tape retention lock can be configured in two modes. When configured in
|
2027
|
-
# governance mode,
|
2028
|
-
#
|
2029
|
-
#
|
2030
|
-
#
|
2120
|
+
# governance mode, accounts with specific IAM permissions are authorized
|
2121
|
+
# to remove the tape retention lock from archived virtual tapes. When
|
2122
|
+
# configured in compliance mode, the tape retention lock cannot be
|
2123
|
+
# removed by any user, including the root account.
|
2031
2124
|
#
|
2032
2125
|
# @option params [Integer] :retention_lock_time_in_days
|
2033
2126
|
# Tape retention lock time is set in days. Tape retention lock can be
|
@@ -2091,7 +2184,7 @@ module Aws::StorageGateway
|
|
2091
2184
|
# @option params [required, String] :gateway_arn
|
2092
2185
|
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
2093
2186
|
# associate the virtual tape with. Use the ListGateways operation to
|
2094
|
-
# return a list of gateways for your account and
|
2187
|
+
# return a list of gateways for your account and Region.
|
2095
2188
|
#
|
2096
2189
|
# @option params [required, Integer] :tape_size_in_bytes
|
2097
2190
|
# The size, in bytes, of the virtual tape that you want to create.
|
@@ -2110,7 +2203,7 @@ module Aws::StorageGateway
|
|
2110
2203
|
#
|
2111
2204
|
# @option params [Boolean] :kms_encrypted
|
2112
2205
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
2113
|
-
#
|
2206
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
2114
2207
|
#
|
2115
2208
|
# Valid Values: `true` \| `false`
|
2116
2209
|
#
|
@@ -2208,7 +2301,7 @@ module Aws::StorageGateway
|
|
2208
2301
|
# @option params [required, String] :gateway_arn
|
2209
2302
|
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
2210
2303
|
# associate the virtual tapes with. Use the ListGateways operation to
|
2211
|
-
# return a list of gateways for your account and
|
2304
|
+
# return a list of gateways for your account and Region.
|
2212
2305
|
#
|
2213
2306
|
# @option params [required, Integer] :tape_size_in_bytes
|
2214
2307
|
# The size, in bytes, of the virtual tapes that you want to create.
|
@@ -2241,7 +2334,7 @@ module Aws::StorageGateway
|
|
2241
2334
|
#
|
2242
2335
|
# @option params [Boolean] :kms_encrypted
|
2243
2336
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
2244
|
-
#
|
2337
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
2245
2338
|
#
|
2246
2339
|
# Valid Values: `true` \| `false`
|
2247
2340
|
#
|
@@ -2342,8 +2435,7 @@ module Aws::StorageGateway
|
|
2342
2435
|
#
|
2343
2436
|
# @option params [required, String] :gateway_arn
|
2344
2437
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2345
|
-
# operation to return a list of gateways for your account and
|
2346
|
-
# Region.
|
2438
|
+
# operation to return a list of gateways for your account and Region.
|
2347
2439
|
#
|
2348
2440
|
# @return [Types::DeleteAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2349
2441
|
#
|
@@ -2377,8 +2469,7 @@ module Aws::StorageGateway
|
|
2377
2469
|
#
|
2378
2470
|
# @option params [required, String] :gateway_arn
|
2379
2471
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2380
|
-
# operation to return a list of gateways for your account and
|
2381
|
-
# Region.
|
2472
|
+
# operation to return a list of gateways for your account and Region.
|
2382
2473
|
#
|
2383
2474
|
# @option params [required, String] :bandwidth_type
|
2384
2475
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
@@ -2479,18 +2570,18 @@ module Aws::StorageGateway
|
|
2479
2570
|
req.send_request(options)
|
2480
2571
|
end
|
2481
2572
|
|
2482
|
-
# Deletes a file share from
|
2483
|
-
# supported for
|
2573
|
+
# Deletes a file share from an S3 File Gateway. This operation is only
|
2574
|
+
# supported for S3 File Gateways.
|
2484
2575
|
#
|
2485
2576
|
# @option params [required, String] :file_share_arn
|
2486
2577
|
# The Amazon Resource Name (ARN) of the file share to be deleted.
|
2487
2578
|
#
|
2488
2579
|
# @option params [Boolean] :force_delete
|
2489
2580
|
# If this value is set to `true`, the operation deletes a file share
|
2490
|
-
# immediately and aborts all data uploads to
|
2491
|
-
# share is not deleted until all data is uploaded to
|
2492
|
-
# aborts the data upload process, and
|
2493
|
-
# `FORCE_DELETING` status.
|
2581
|
+
# immediately and aborts all data uploads to Amazon Web Services.
|
2582
|
+
# Otherwise, the file share is not deleted until all data is uploaded to
|
2583
|
+
# Amazon Web Services. This process aborts the data upload process, and
|
2584
|
+
# the file share enters the `FORCE_DELETING` status.
|
2494
2585
|
#
|
2495
2586
|
# Valid Values: `true` \| `false`
|
2496
2587
|
#
|
@@ -2535,7 +2626,7 @@ module Aws::StorageGateway
|
|
2535
2626
|
# all remaining Amazon EBS snapshots by canceling your Amazon EC2
|
2536
2627
|
# subscription. If you prefer not to cancel your Amazon EC2
|
2537
2628
|
# subscription, you can delete your snapshots using the Amazon EC2
|
2538
|
-
# console. For more information, see the [
|
2629
|
+
# console. For more information, see the [Storage Gateway detail
|
2539
2630
|
# page][1].
|
2540
2631
|
#
|
2541
2632
|
#
|
@@ -2544,8 +2635,7 @@ module Aws::StorageGateway
|
|
2544
2635
|
#
|
2545
2636
|
# @option params [required, String] :gateway_arn
|
2546
2637
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2547
|
-
# operation to return a list of gateways for your account and
|
2548
|
-
# Region.
|
2638
|
+
# operation to return a list of gateways for your account and Region.
|
2549
2639
|
#
|
2550
2640
|
# @return [Types::DeleteGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2551
2641
|
#
|
@@ -2650,7 +2740,7 @@ module Aws::StorageGateway
|
|
2650
2740
|
# @option params [required, String] :gateway_arn
|
2651
2741
|
# The unique Amazon Resource Name (ARN) of the gateway that the virtual
|
2652
2742
|
# tape to delete is associated with. Use the ListGateways operation to
|
2653
|
-
# return a list of gateways for your account and
|
2743
|
+
# return a list of gateways for your account and Region.
|
2654
2744
|
#
|
2655
2745
|
# @option params [required, String] :tape_arn
|
2656
2746
|
# The Amazon Resource Name (ARN) of the virtual tape to delete.
|
@@ -2852,8 +2942,7 @@ module Aws::StorageGateway
|
|
2852
2942
|
#
|
2853
2943
|
# @option params [required, String] :gateway_arn
|
2854
2944
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2855
|
-
# operation to return a list of gateways for your account and
|
2856
|
-
# Region.
|
2945
|
+
# operation to return a list of gateways for your account and Region.
|
2857
2946
|
#
|
2858
2947
|
# @return [Types::DescribeAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2859
2948
|
#
|
@@ -2895,8 +2984,7 @@ module Aws::StorageGateway
|
|
2895
2984
|
#
|
2896
2985
|
# @option params [required, String] :gateway_arn
|
2897
2986
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2898
|
-
# operation to return a list of gateways for your account and
|
2899
|
-
# Region.
|
2987
|
+
# operation to return a list of gateways for your account and Region.
|
2900
2988
|
#
|
2901
2989
|
# @return [Types::DescribeBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2902
2990
|
#
|
@@ -2964,8 +3052,7 @@ module Aws::StorageGateway
|
|
2964
3052
|
#
|
2965
3053
|
# @option params [required, String] :gateway_arn
|
2966
3054
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2967
|
-
# operation to return a list of gateways for your account and
|
2968
|
-
# Region.
|
3055
|
+
# operation to return a list of gateways for your account and Region.
|
2969
3056
|
#
|
2970
3057
|
# @return [Types::DescribeBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2971
3058
|
#
|
@@ -3008,8 +3095,7 @@ module Aws::StorageGateway
|
|
3008
3095
|
#
|
3009
3096
|
# @option params [required, String] :gateway_arn
|
3010
3097
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3011
|
-
# operation to return a list of gateways for your account and
|
3012
|
-
# Region.
|
3098
|
+
# operation to return a list of gateways for your account and Region.
|
3013
3099
|
#
|
3014
3100
|
# @return [Types::DescribeCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3015
3101
|
#
|
@@ -3074,8 +3160,8 @@ module Aws::StorageGateway
|
|
3074
3160
|
# This operation is only supported in the cached volume gateway types.
|
3075
3161
|
#
|
3076
3162
|
# The list of gateway volumes in the request must be from one gateway.
|
3077
|
-
# In the response,
|
3078
|
-
#
|
3163
|
+
# In the response, Storage Gateway returns volume information sorted by
|
3164
|
+
# volume Amazon Resource Name (ARN).
|
3079
3165
|
#
|
3080
3166
|
# @option params [required, Array<String>] :volume_arns
|
3081
3167
|
# An array of strings where each string represents the Amazon Resource
|
@@ -3214,7 +3300,7 @@ module Aws::StorageGateway
|
|
3214
3300
|
end
|
3215
3301
|
|
3216
3302
|
# Gets the file system association information. This operation is only
|
3217
|
-
# supported for
|
3303
|
+
# supported for FSx File Gateways.
|
3218
3304
|
#
|
3219
3305
|
# @option params [required, Array<String>] :file_system_association_arn_list
|
3220
3306
|
# An array containing the Amazon Resource Name (ARN) of each file system
|
@@ -3242,6 +3328,8 @@ module Aws::StorageGateway
|
|
3242
3328
|
# resp.file_system_association_info_list[0].tags[0].key #=> String
|
3243
3329
|
# resp.file_system_association_info_list[0].tags[0].value #=> String
|
3244
3330
|
# resp.file_system_association_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3331
|
+
# resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses #=> Array
|
3332
|
+
# resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses[0] #=> String
|
3245
3333
|
#
|
3246
3334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociations AWS API Documentation
|
3247
3335
|
#
|
@@ -3259,8 +3347,7 @@ module Aws::StorageGateway
|
|
3259
3347
|
#
|
3260
3348
|
# @option params [required, String] :gateway_arn
|
3261
3349
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3262
|
-
# operation to return a list of gateways for your account and
|
3263
|
-
# Region.
|
3350
|
+
# operation to return a list of gateways for your account and Region.
|
3264
3351
|
#
|
3265
3352
|
# @return [Types::DescribeGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3266
3353
|
#
|
@@ -3282,6 +3369,8 @@ module Aws::StorageGateway
|
|
3282
3369
|
# * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
|
3283
3370
|
# * {Types::DescribeGatewayInformationOutput#software_updates_end_date #software_updates_end_date} => String
|
3284
3371
|
# * {Types::DescribeGatewayInformationOutput#deprecation_date #deprecation_date} => String
|
3372
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_capacity #gateway_capacity} => String
|
3373
|
+
# * {Types::DescribeGatewayInformationOutput#supported_gateway_capacities #supported_gateway_capacities} => Array<String>
|
3285
3374
|
#
|
3286
3375
|
#
|
3287
3376
|
# @example Example: To describe metadata about the gateway
|
@@ -3341,6 +3430,9 @@ module Aws::StorageGateway
|
|
3341
3430
|
# resp.endpoint_type #=> String
|
3342
3431
|
# resp.software_updates_end_date #=> String
|
3343
3432
|
# resp.deprecation_date #=> String
|
3433
|
+
# resp.gateway_capacity #=> String, one of "Small", "Medium", "Large"
|
3434
|
+
# resp.supported_gateway_capacities #=> Array
|
3435
|
+
# resp.supported_gateway_capacities[0] #=> String, one of "Small", "Medium", "Large"
|
3344
3436
|
#
|
3345
3437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
|
3346
3438
|
#
|
@@ -3357,8 +3449,7 @@ module Aws::StorageGateway
|
|
3357
3449
|
#
|
3358
3450
|
# @option params [required, String] :gateway_arn
|
3359
3451
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3360
|
-
# operation to return a list of gateways for your account and
|
3361
|
-
# Region.
|
3452
|
+
# operation to return a list of gateways for your account and Region.
|
3362
3453
|
#
|
3363
3454
|
# @return [Types::DescribeMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3364
3455
|
#
|
@@ -3412,8 +3503,8 @@ module Aws::StorageGateway
|
|
3412
3503
|
end
|
3413
3504
|
|
3414
3505
|
# Gets a description for one or more Network File System (NFS) file
|
3415
|
-
# shares from
|
3416
|
-
#
|
3506
|
+
# shares from an S3 File Gateway. This operation is only supported for
|
3507
|
+
# S3 File Gateways.
|
3417
3508
|
#
|
3418
3509
|
# @option params [required, Array<String>] :file_share_arn_list
|
3419
3510
|
# An array containing the Amazon Resource Name (ARN) of each file share
|
@@ -3459,6 +3550,8 @@ module Aws::StorageGateway
|
|
3459
3550
|
# resp.nfs_file_share_info_list[0].file_share_name #=> String
|
3460
3551
|
# resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3461
3552
|
# resp.nfs_file_share_info_list[0].notification_policy #=> String
|
3553
|
+
# resp.nfs_file_share_info_list[0].vpc_endpoint_dns_name #=> String
|
3554
|
+
# resp.nfs_file_share_info_list[0].bucket_region #=> String
|
3462
3555
|
#
|
3463
3556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
|
3464
3557
|
#
|
@@ -3470,8 +3563,8 @@ module Aws::StorageGateway
|
|
3470
3563
|
end
|
3471
3564
|
|
3472
3565
|
# Gets a description for one or more Server Message Block (SMB) file
|
3473
|
-
# shares from a
|
3474
|
-
#
|
3566
|
+
# shares from a S3 File Gateway. This operation is only supported for S3
|
3567
|
+
# File Gateways.
|
3475
3568
|
#
|
3476
3569
|
# @option params [required, Array<String>] :file_share_arn_list
|
3477
3570
|
# An array containing the Amazon Resource Name (ARN) of each file share
|
@@ -3521,6 +3614,9 @@ module Aws::StorageGateway
|
|
3521
3614
|
# resp.smb_file_share_info_list[0].file_share_name #=> String
|
3522
3615
|
# resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3523
3616
|
# resp.smb_file_share_info_list[0].notification_policy #=> String
|
3617
|
+
# resp.smb_file_share_info_list[0].vpc_endpoint_dns_name #=> String
|
3618
|
+
# resp.smb_file_share_info_list[0].bucket_region #=> String
|
3619
|
+
# resp.smb_file_share_info_list[0].oplocks_enabled #=> Boolean
|
3524
3620
|
#
|
3525
3621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
|
3526
3622
|
#
|
@@ -3537,8 +3633,7 @@ module Aws::StorageGateway
|
|
3537
3633
|
#
|
3538
3634
|
# @option params [required, String] :gateway_arn
|
3539
3635
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3540
|
-
# operation to return a list of gateways for your account and
|
3541
|
-
# Region.
|
3636
|
+
# operation to return a list of gateways for your account and Region.
|
3542
3637
|
#
|
3543
3638
|
# @return [Types::DescribeSMBSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3544
3639
|
#
|
@@ -3638,9 +3733,9 @@ module Aws::StorageGateway
|
|
3638
3733
|
|
3639
3734
|
# Returns the description of the gateway volumes specified in the
|
3640
3735
|
# request. The list of gateway volumes in the request must be from one
|
3641
|
-
# gateway. In the response,
|
3642
|
-
#
|
3643
|
-
#
|
3736
|
+
# gateway. In the response, Storage Gateway returns volume information
|
3737
|
+
# sorted by volume ARNs. This operation is only supported in stored
|
3738
|
+
# volume gateway type.
|
3644
3739
|
#
|
3645
3740
|
# @option params [required, Array<String>] :volume_arns
|
3646
3741
|
# An array of strings where each string represents the Amazon Resource
|
@@ -3726,9 +3821,9 @@ module Aws::StorageGateway
|
|
3726
3821
|
# shelf (VTS). This operation is only supported in the tape gateway
|
3727
3822
|
# type.
|
3728
3823
|
#
|
3729
|
-
# If a specific `TapeARN` is not specified,
|
3730
|
-
#
|
3731
|
-
#
|
3824
|
+
# If a specific `TapeARN` is not specified, Storage Gateway returns a
|
3825
|
+
# description of all virtual tapes found in the VTS associated with your
|
3826
|
+
# account.
|
3732
3827
|
#
|
3733
3828
|
# @option params [Array<String>] :tape_arns
|
3734
3829
|
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
@@ -3830,8 +3925,7 @@ module Aws::StorageGateway
|
|
3830
3925
|
#
|
3831
3926
|
# @option params [required, String] :gateway_arn
|
3832
3927
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3833
|
-
# operation to return a list of gateways for your account and
|
3834
|
-
# Region.
|
3928
|
+
# operation to return a list of gateways for your account and Region.
|
3835
3929
|
#
|
3836
3930
|
# @option params [String] :marker
|
3837
3931
|
# An opaque string that indicates the position at which to begin
|
@@ -3908,8 +4002,7 @@ module Aws::StorageGateway
|
|
3908
4002
|
#
|
3909
4003
|
# @option params [required, String] :gateway_arn
|
3910
4004
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
3911
|
-
# operation to return a list of gateways for your account and
|
3912
|
-
# Region.
|
4005
|
+
# operation to return a list of gateways for your account and Region.
|
3913
4006
|
#
|
3914
4007
|
# @option params [Array<String>] :tape_arns
|
3915
4008
|
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
@@ -4020,8 +4113,7 @@ module Aws::StorageGateway
|
|
4020
4113
|
#
|
4021
4114
|
# @option params [required, String] :gateway_arn
|
4022
4115
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4023
|
-
# operation to return a list of gateways for your account and
|
4024
|
-
# Region.
|
4116
|
+
# operation to return a list of gateways for your account and Region.
|
4025
4117
|
#
|
4026
4118
|
# @return [Types::DescribeUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4027
4119
|
#
|
@@ -4095,15 +4187,14 @@ module Aws::StorageGateway
|
|
4095
4187
|
end
|
4096
4188
|
|
4097
4189
|
# Returns a description of virtual tape library (VTL) devices for the
|
4098
|
-
# specified tape gateway. In the response,
|
4099
|
-
#
|
4190
|
+
# specified tape gateway. In the response, Storage Gateway returns VTL
|
4191
|
+
# device information.
|
4100
4192
|
#
|
4101
4193
|
# This operation is only supported in the tape gateway type.
|
4102
4194
|
#
|
4103
4195
|
# @option params [required, String] :gateway_arn
|
4104
4196
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4105
|
-
# operation to return a list of gateways for your account and
|
4106
|
-
# Region.
|
4197
|
+
# operation to return a list of gateways for your account and Region.
|
4107
4198
|
#
|
4108
4199
|
# @option params [Array<String>] :vtl_device_arns
|
4109
4200
|
# An array of strings, where each string represents the Amazon Resource
|
@@ -4236,8 +4327,7 @@ module Aws::StorageGateway
|
|
4236
4327
|
#
|
4237
4328
|
# @option params [required, String] :gateway_arn
|
4238
4329
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4239
|
-
# operation to return a list of gateways for your account and
|
4240
|
-
# Region.
|
4330
|
+
# operation to return a list of gateways for your account and Region.
|
4241
4331
|
#
|
4242
4332
|
# @return [Types::DescribeWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4243
4333
|
#
|
@@ -4346,8 +4436,7 @@ module Aws::StorageGateway
|
|
4346
4436
|
#
|
4347
4437
|
# @option params [required, String] :gateway_arn
|
4348
4438
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4349
|
-
# operation to return a list of gateways for your account and
|
4350
|
-
# Region.
|
4439
|
+
# operation to return a list of gateways for your account and Region.
|
4351
4440
|
#
|
4352
4441
|
# @return [Types::DisableGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4353
4442
|
#
|
@@ -4390,7 +4479,7 @@ module Aws::StorageGateway
|
|
4390
4479
|
# Disassociates an Amazon FSx file system from the specified gateway.
|
4391
4480
|
# After the disassociation process finishes, the gateway can no longer
|
4392
4481
|
# access the Amazon FSx file system. This operation is only supported in
|
4393
|
-
# the
|
4482
|
+
# the FSx File Gateway type.
|
4394
4483
|
#
|
4395
4484
|
# @option params [required, String] :file_system_association_arn
|
4396
4485
|
# The Amazon Resource Name (ARN) of the file system association to be
|
@@ -4432,8 +4521,7 @@ module Aws::StorageGateway
|
|
4432
4521
|
#
|
4433
4522
|
# @option params [required, String] :gateway_arn
|
4434
4523
|
# The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways`
|
4435
|
-
# operation to return a list of gateways for your account and
|
4436
|
-
# Region.
|
4524
|
+
# operation to return a list of gateways for your account and Region.
|
4437
4525
|
#
|
4438
4526
|
# @option params [required, String] :domain_name
|
4439
4527
|
# The name of the domain that you want the gateway to join.
|
@@ -4503,8 +4591,7 @@ module Aws::StorageGateway
|
|
4503
4591
|
#
|
4504
4592
|
# @option params [String] :gateway_arn
|
4505
4593
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4506
|
-
# operation to return a list of gateways for your account and
|
4507
|
-
# Region.
|
4594
|
+
# operation to return a list of gateways for your account and Region.
|
4508
4595
|
#
|
4509
4596
|
# @return [Types::ListAutomaticTapeCreationPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4510
4597
|
#
|
@@ -4536,9 +4623,9 @@ module Aws::StorageGateway
|
|
4536
4623
|
req.send_request(options)
|
4537
4624
|
end
|
4538
4625
|
|
4539
|
-
# Gets a list of the file shares for a specific
|
4626
|
+
# Gets a list of the file shares for a specific S3 File Gateway, or the
|
4540
4627
|
# list of file shares that belong to the calling user account. This
|
4541
|
-
# operation is only supported for
|
4628
|
+
# operation is only supported for S3 File Gateways.
|
4542
4629
|
#
|
4543
4630
|
# @option params [String] :gateway_arn
|
4544
4631
|
# The Amazon Resource Name (ARN) of the gateway whose file shares you
|
@@ -4592,12 +4679,11 @@ module Aws::StorageGateway
|
|
4592
4679
|
|
4593
4680
|
# Gets a list of `FileSystemAssociationSummary` objects. Each object
|
4594
4681
|
# contains a summary of a file system association. This operation is
|
4595
|
-
# only supported for
|
4682
|
+
# only supported for FSx File Gateways.
|
4596
4683
|
#
|
4597
4684
|
# @option params [String] :gateway_arn
|
4598
4685
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4599
|
-
# operation to return a list of gateways for your account and
|
4600
|
-
# Region.
|
4686
|
+
# operation to return a list of gateways for your account and Region.
|
4601
4687
|
#
|
4602
4688
|
# @option params [Integer] :limit
|
4603
4689
|
# The maximum number of file system associations to return in the
|
@@ -4645,9 +4731,9 @@ module Aws::StorageGateway
|
|
4645
4731
|
req.send_request(options)
|
4646
4732
|
end
|
4647
4733
|
|
4648
|
-
# Lists gateways owned by an
|
4649
|
-
#
|
4650
|
-
#
|
4734
|
+
# Lists gateways owned by an account in an Region specified in the
|
4735
|
+
# request. The returned list is ordered by gateway Amazon Resource Name
|
4736
|
+
# (ARN).
|
4651
4737
|
#
|
4652
4738
|
# By default, the operation returns a maximum of 100 gateways. This
|
4653
4739
|
# operation supports pagination that allows you to optionally reduce the
|
@@ -4739,8 +4825,7 @@ module Aws::StorageGateway
|
|
4739
4825
|
#
|
4740
4826
|
# @option params [required, String] :gateway_arn
|
4741
4827
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
4742
|
-
# operation to return a list of gateways for your account and
|
4743
|
-
# Region.
|
4828
|
+
# operation to return a list of gateways for your account and Region.
|
4744
4829
|
#
|
4745
4830
|
# @return [Types::ListLocalDisksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4746
4831
|
#
|
@@ -5048,8 +5133,7 @@ module Aws::StorageGateway
|
|
5048
5133
|
#
|
5049
5134
|
# @option params [required, String] :gateway_arn
|
5050
5135
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5051
|
-
# operation to return a list of gateways for your account and
|
5052
|
-
# Region.
|
5136
|
+
# operation to return a list of gateways for your account and Region.
|
5053
5137
|
#
|
5054
5138
|
# @return [Types::ListVolumeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5055
5139
|
#
|
@@ -5118,8 +5202,7 @@ module Aws::StorageGateway
|
|
5118
5202
|
#
|
5119
5203
|
# @option params [String] :gateway_arn
|
5120
5204
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5121
|
-
# operation to return a list of gateways for your account and
|
5122
|
-
# Region.
|
5205
|
+
# operation to return a list of gateways for your account and Region.
|
5123
5206
|
#
|
5124
5207
|
# @option params [String] :marker
|
5125
5208
|
# A string that indicates the position at which to begin the returned
|
@@ -5206,18 +5289,18 @@ module Aws::StorageGateway
|
|
5206
5289
|
# Sends you notification through CloudWatch Events when all files
|
5207
5290
|
# written to your file share have been uploaded to Amazon S3.
|
5208
5291
|
#
|
5209
|
-
#
|
5292
|
+
# Storage Gateway can send a notification through Amazon CloudWatch
|
5210
5293
|
# Events when all files written to your file share up to that point in
|
5211
5294
|
# time have been uploaded to Amazon S3. These files include files
|
5212
5295
|
# written to the file share up to the time that you make a request for
|
5213
5296
|
# notification. When the upload is done, Storage Gateway sends you
|
5214
5297
|
# notification through an Amazon CloudWatch Event. You can configure
|
5215
5298
|
# CloudWatch Events to send the notification through event targets such
|
5216
|
-
# as Amazon SNS or
|
5217
|
-
#
|
5299
|
+
# as Amazon SNS or Lambda function. This operation is only supported for
|
5300
|
+
# S3 File Gateways.
|
5218
5301
|
#
|
5219
5302
|
# For more information, see [Getting file upload notification][1] in the
|
5220
|
-
# *
|
5303
|
+
# *Storage Gateway User Guide*.
|
5221
5304
|
#
|
5222
5305
|
#
|
5223
5306
|
#
|
@@ -5255,13 +5338,16 @@ module Aws::StorageGateway
|
|
5255
5338
|
# share. This operation finds objects in the Amazon S3 bucket that were
|
5256
5339
|
# added, removed, or replaced since the gateway last listed the
|
5257
5340
|
# bucket's contents and cached the results. This operation does not
|
5258
|
-
# import files into the
|
5259
|
-
# cached inventory to reflect changes in the inventory of the
|
5260
|
-
# the S3 bucket. This operation is only supported in the
|
5261
|
-
#
|
5262
|
-
#
|
5263
|
-
#
|
5264
|
-
#
|
5341
|
+
# import files into the S3 File Gateway cache storage. It only updates
|
5342
|
+
# the cached inventory to reflect changes in the inventory of the
|
5343
|
+
# objects in the S3 bucket. This operation is only supported in the S3
|
5344
|
+
# File Gateway types.
|
5345
|
+
#
|
5346
|
+
# You can subscribe to be notified through an Amazon CloudWatch event
|
5347
|
+
# when your `RefreshCache` operation completes. For more information,
|
5348
|
+
# see [Getting notified about file operations][1] in the *Storage
|
5349
|
+
# Gateway User Guide*. This operation is Only supported for S3 File
|
5350
|
+
# Gateways.
|
5265
5351
|
#
|
5266
5352
|
# When this API is called, it only initiates the refresh operation. When
|
5267
5353
|
# the API call completes and returns a success code, it doesn't
|
@@ -5275,7 +5361,7 @@ module Aws::StorageGateway
|
|
5275
5361
|
# no more than two refreshes at any time. We recommend using the
|
5276
5362
|
# refresh-complete CloudWatch event notification before issuing
|
5277
5363
|
# additional requests. For more information, see [Getting notified about
|
5278
|
-
# file operations][1] in the *
|
5364
|
+
# file operations][1] in the *Storage Gateway User Guide*.
|
5279
5365
|
#
|
5280
5366
|
# If you invoke the RefreshCache API when two requests are already being
|
5281
5367
|
# processed, any new request will cause an
|
@@ -5283,7 +5369,7 @@ module Aws::StorageGateway
|
|
5283
5369
|
# sent to the server.
|
5284
5370
|
#
|
5285
5371
|
# For more information, see [Getting notified about file operations][1]
|
5286
|
-
# in the *
|
5372
|
+
# in the *Storage Gateway User Guide*.
|
5287
5373
|
#
|
5288
5374
|
#
|
5289
5375
|
#
|
@@ -5407,8 +5493,7 @@ module Aws::StorageGateway
|
|
5407
5493
|
#
|
5408
5494
|
# @option params [required, String] :gateway_arn
|
5409
5495
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5410
|
-
# operation to return a list of gateways for your account and
|
5411
|
-
# Region.
|
5496
|
+
# operation to return a list of gateways for your account and Region.
|
5412
5497
|
#
|
5413
5498
|
# @return [Types::ResetCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5414
5499
|
#
|
@@ -5466,7 +5551,7 @@ module Aws::StorageGateway
|
|
5466
5551
|
# @option params [required, String] :gateway_arn
|
5467
5552
|
# The Amazon Resource Name (ARN) of the gateway you want to retrieve the
|
5468
5553
|
# virtual tape to. Use the ListGateways operation to return a list of
|
5469
|
-
# gateways for your account and
|
5554
|
+
# gateways for your account and Region.
|
5470
5555
|
#
|
5471
5556
|
# You retrieve archived virtual tapes to only one gateway and the
|
5472
5557
|
# gateway must be a tape gateway.
|
@@ -5531,8 +5616,7 @@ module Aws::StorageGateway
|
|
5531
5616
|
#
|
5532
5617
|
# @option params [required, String] :gateway_arn
|
5533
5618
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5534
|
-
# operation to return a list of gateways for your account and
|
5535
|
-
# Region.
|
5619
|
+
# operation to return a list of gateways for your account and Region.
|
5536
5620
|
#
|
5537
5621
|
# @return [Types::RetrieveTapeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5538
5622
|
#
|
@@ -5580,8 +5664,7 @@ module Aws::StorageGateway
|
|
5580
5664
|
#
|
5581
5665
|
# @option params [required, String] :gateway_arn
|
5582
5666
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5583
|
-
# operation to return a list of gateways for your account and
|
5584
|
-
# Region.
|
5667
|
+
# operation to return a list of gateways for your account and Region.
|
5585
5668
|
#
|
5586
5669
|
# @option params [required, String] :local_console_password
|
5587
5670
|
# The password you want to set for your VM local console.
|
@@ -5627,11 +5710,11 @@ module Aws::StorageGateway
|
|
5627
5710
|
|
5628
5711
|
# Sets the password for the guest user `smbguest`. The `smbguest` user
|
5629
5712
|
# is the user when the authentication method for the file share is set
|
5630
|
-
# to `GuestAccess`.
|
5713
|
+
# to `GuestAccess`. This operation only supported for S3 File Gateways
|
5631
5714
|
#
|
5632
5715
|
# @option params [required, String] :gateway_arn
|
5633
|
-
# The Amazon Resource Name (ARN) of the
|
5634
|
-
# is associated with.
|
5716
|
+
# The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file
|
5717
|
+
# share is associated with.
|
5635
5718
|
#
|
5636
5719
|
# @option params [required, String] :password
|
5637
5720
|
# The password that you want to set for your SMB server.
|
@@ -5691,8 +5774,7 @@ module Aws::StorageGateway
|
|
5691
5774
|
#
|
5692
5775
|
# @option params [required, String] :gateway_arn
|
5693
5776
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5694
|
-
# operation to return a list of gateways for your account and
|
5695
|
-
# Region.
|
5777
|
+
# operation to return a list of gateways for your account and Region.
|
5696
5778
|
#
|
5697
5779
|
# @return [Types::ShutdownGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5698
5780
|
#
|
@@ -5746,8 +5828,7 @@ module Aws::StorageGateway
|
|
5746
5828
|
#
|
5747
5829
|
# @option params [required, String] :gateway_arn
|
5748
5830
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5749
|
-
# operation to return a list of gateways for your account and
|
5750
|
-
# Region.
|
5831
|
+
# operation to return a list of gateways for your account and Region.
|
5751
5832
|
#
|
5752
5833
|
# @return [Types::StartAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5753
5834
|
#
|
@@ -5790,8 +5871,7 @@ module Aws::StorageGateway
|
|
5790
5871
|
#
|
5791
5872
|
# @option params [required, String] :gateway_arn
|
5792
5873
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5793
|
-
# operation to return a list of gateways for your account and
|
5794
|
-
# Region.
|
5874
|
+
# operation to return a list of gateways for your account and Region.
|
5795
5875
|
#
|
5796
5876
|
# @return [Types::StartGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5797
5877
|
#
|
@@ -5847,8 +5927,7 @@ module Aws::StorageGateway
|
|
5847
5927
|
#
|
5848
5928
|
# @option params [required, String] :gateway_arn
|
5849
5929
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5850
|
-
# operation to return a list of gateways for your account and
|
5851
|
-
# Region.
|
5930
|
+
# operation to return a list of gateways for your account and Region.
|
5852
5931
|
#
|
5853
5932
|
# @return [Types::UpdateAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5854
5933
|
#
|
@@ -5898,8 +5977,7 @@ module Aws::StorageGateway
|
|
5898
5977
|
#
|
5899
5978
|
# @option params [required, String] :gateway_arn
|
5900
5979
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5901
|
-
# operation to return a list of gateways for your account and
|
5902
|
-
# Region.
|
5980
|
+
# operation to return a list of gateways for your account and Region.
|
5903
5981
|
#
|
5904
5982
|
# @option params [Integer] :average_upload_rate_limit_in_bits_per_sec
|
5905
5983
|
# The average upload bandwidth rate limit in bits per second.
|
@@ -5957,8 +6035,7 @@ module Aws::StorageGateway
|
|
5957
6035
|
#
|
5958
6036
|
# @option params [required, String] :gateway_arn
|
5959
6037
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
5960
|
-
# operation to return a list of gateways for your account and
|
5961
|
-
# Region.
|
6038
|
+
# operation to return a list of gateways for your account and Region.
|
5962
6039
|
#
|
5963
6040
|
# @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
|
5964
6041
|
# An array containing bandwidth rate limit schedule intervals for a
|
@@ -6081,7 +6158,7 @@ module Aws::StorageGateway
|
|
6081
6158
|
end
|
6082
6159
|
|
6083
6160
|
# Updates a file system association. This operation is only supported in
|
6084
|
-
# the
|
6161
|
+
# the FSx File Gateways.
|
6085
6162
|
#
|
6086
6163
|
# @option params [required, String] :file_system_association_arn
|
6087
6164
|
# The Amazon Resource Name (ARN) of the file system association that you
|
@@ -6099,7 +6176,7 @@ module Aws::StorageGateway
|
|
6099
6176
|
# The Amazon Resource Name (ARN) of the storage used for the audit logs.
|
6100
6177
|
#
|
6101
6178
|
# @option params [Types::CacheAttributes] :cache_attributes
|
6102
|
-
# The refresh cache information for the file share.
|
6179
|
+
# The refresh cache information for the file share or FSx file systems.
|
6103
6180
|
#
|
6104
6181
|
# @return [Types::UpdateFileSystemAssociationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6105
6182
|
#
|
@@ -6142,8 +6219,7 @@ module Aws::StorageGateway
|
|
6142
6219
|
#
|
6143
6220
|
# @option params [required, String] :gateway_arn
|
6144
6221
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6145
|
-
# operation to return a list of gateways for your account and
|
6146
|
-
# Region.
|
6222
|
+
# operation to return a list of gateways for your account and Region.
|
6147
6223
|
#
|
6148
6224
|
# @option params [String] :gateway_name
|
6149
6225
|
# The name you configured for your gateway.
|
@@ -6161,6 +6237,9 @@ module Aws::StorageGateway
|
|
6161
6237
|
#
|
6162
6238
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html
|
6163
6239
|
#
|
6240
|
+
# @option params [String] :gateway_capacity
|
6241
|
+
# Specifies the size of the gateway's metadata cache.
|
6242
|
+
#
|
6164
6243
|
# @return [Types::UpdateGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6165
6244
|
#
|
6166
6245
|
# * {Types::UpdateGatewayInformationOutput#gateway_arn #gateway_arn} => String
|
@@ -6190,6 +6269,7 @@ module Aws::StorageGateway
|
|
6190
6269
|
# gateway_name: "GatewayName",
|
6191
6270
|
# gateway_timezone: "GatewayTimezone",
|
6192
6271
|
# cloud_watch_log_group_arn: "CloudWatchLogGroupARN",
|
6272
|
+
# gateway_capacity: "Small", # accepts Small, Medium, Large
|
6193
6273
|
# })
|
6194
6274
|
#
|
6195
6275
|
# @example Response structure
|
@@ -6230,8 +6310,7 @@ module Aws::StorageGateway
|
|
6230
6310
|
#
|
6231
6311
|
# @option params [required, String] :gateway_arn
|
6232
6312
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6233
|
-
# operation to return a list of gateways for your account and
|
6234
|
-
# Region.
|
6313
|
+
# operation to return a list of gateways for your account and Region.
|
6235
6314
|
#
|
6236
6315
|
# @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6237
6316
|
#
|
@@ -6276,8 +6355,7 @@ module Aws::StorageGateway
|
|
6276
6355
|
#
|
6277
6356
|
# @option params [required, String] :gateway_arn
|
6278
6357
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6279
|
-
# operation to return a list of gateways for your account and
|
6280
|
-
# Region.
|
6358
|
+
# operation to return a list of gateways for your account and Region.
|
6281
6359
|
#
|
6282
6360
|
# @option params [required, Integer] :hour_of_day
|
6283
6361
|
# The hour component of the maintenance start time represented as *hh*,
|
@@ -6345,7 +6423,7 @@ module Aws::StorageGateway
|
|
6345
6423
|
end
|
6346
6424
|
|
6347
6425
|
# Updates a Network File System (NFS) file share. This operation is only
|
6348
|
-
# supported in
|
6426
|
+
# supported in S3 File Gateways.
|
6349
6427
|
#
|
6350
6428
|
# <note markdown="1"> To leave a file share field unchanged, set the corresponding input
|
6351
6429
|
# field to null.
|
@@ -6369,7 +6447,7 @@ module Aws::StorageGateway
|
|
6369
6447
|
#
|
6370
6448
|
# @option params [Boolean] :kms_encrypted
|
6371
6449
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
6372
|
-
#
|
6450
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
6373
6451
|
#
|
6374
6452
|
# Valid Values: `true` \| `false`
|
6375
6453
|
#
|
@@ -6384,7 +6462,7 @@ module Aws::StorageGateway
|
|
6384
6462
|
#
|
6385
6463
|
# @option params [String] :default_storage_class
|
6386
6464
|
# The default storage class for objects put into an Amazon S3 bucket by
|
6387
|
-
# the
|
6465
|
+
# the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
6388
6466
|
# Optional.
|
6389
6467
|
#
|
6390
6468
|
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
@@ -6392,12 +6470,12 @@ module Aws::StorageGateway
|
|
6392
6470
|
#
|
6393
6471
|
# @option params [String] :object_acl
|
6394
6472
|
# A value that sets the access control list (ACL) permission for objects
|
6395
|
-
# in the S3 bucket that a
|
6473
|
+
# in the S3 bucket that a S3 File Gateway puts objects into. The default
|
6396
6474
|
# value is `private`.
|
6397
6475
|
#
|
6398
6476
|
# @option params [Array<String>] :client_list
|
6399
|
-
# The list of clients that are allowed to access the
|
6400
|
-
# list must contain either valid IP addresses or valid CIDR blocks.
|
6477
|
+
# The list of clients that are allowed to access the S3 File Gateway.
|
6478
|
+
# The list must contain either valid IP addresses or valid CIDR blocks.
|
6401
6479
|
#
|
6402
6480
|
# @option params [String] :squash
|
6403
6481
|
# The user mapped to anonymous user.
|
@@ -6516,20 +6594,19 @@ module Aws::StorageGateway
|
|
6516
6594
|
end
|
6517
6595
|
|
6518
6596
|
# Updates a Server Message Block (SMB) file share. This operation is
|
6519
|
-
# only supported for
|
6597
|
+
# only supported for S3 File Gateways.
|
6520
6598
|
#
|
6521
6599
|
# <note markdown="1"> To leave a file share field unchanged, set the corresponding input
|
6522
6600
|
# field to null.
|
6523
6601
|
#
|
6524
6602
|
# </note>
|
6525
6603
|
#
|
6526
|
-
# File gateways require
|
6527
|
-
#
|
6528
|
-
#
|
6529
|
-
#
|
6530
|
-
#
|
6531
|
-
#
|
6532
|
-
# Access Management User Guide*.
|
6604
|
+
# File gateways require Security Token Service (STS) to be activated to
|
6605
|
+
# enable you to create a file share. Make sure that STS is activated in
|
6606
|
+
# the Region you are creating your file gateway in. If STS is not
|
6607
|
+
# activated in this Region, activate it. For information about how to
|
6608
|
+
# activate STS, see [Activating and deactivating STS in an Region][1] in
|
6609
|
+
# the *Identity and Access Management User Guide*.
|
6533
6610
|
#
|
6534
6611
|
# File gateways don't support creating hard or symbolic links on a
|
6535
6612
|
# file
|
@@ -6545,7 +6622,7 @@ module Aws::StorageGateway
|
|
6545
6622
|
#
|
6546
6623
|
# @option params [Boolean] :kms_encrypted
|
6547
6624
|
# Set to `true` to use Amazon S3 server-side encryption with your own
|
6548
|
-
#
|
6625
|
+
# KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
6549
6626
|
#
|
6550
6627
|
# Valid Values: `true` \| `false`
|
6551
6628
|
#
|
@@ -6557,7 +6634,7 @@ module Aws::StorageGateway
|
|
6557
6634
|
#
|
6558
6635
|
# @option params [String] :default_storage_class
|
6559
6636
|
# The default storage class for objects put into an Amazon S3 bucket by
|
6560
|
-
# the
|
6637
|
+
# the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
6561
6638
|
# Optional.
|
6562
6639
|
#
|
6563
6640
|
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
@@ -6565,7 +6642,7 @@ module Aws::StorageGateway
|
|
6565
6642
|
#
|
6566
6643
|
# @option params [String] :object_acl
|
6567
6644
|
# A value that sets the access control list (ACL) permission for objects
|
6568
|
-
# in the S3 bucket that a
|
6645
|
+
# in the S3 bucket that a S3 File Gateway puts objects into. The default
|
6569
6646
|
# value is `private`.
|
6570
6647
|
#
|
6571
6648
|
# @option params [Boolean] :read_only
|
@@ -6602,8 +6679,7 @@ module Aws::StorageGateway
|
|
6602
6679
|
# permissions to the POSIX permissions.
|
6603
6680
|
#
|
6604
6681
|
# For more information, see [Using Microsoft Windows ACLs to control
|
6605
|
-
# access to an SMB file share][1] in the *
|
6606
|
-
# Guide*.
|
6682
|
+
# access to an SMB file share][1] in the *Storage Gateway User Guide*.
|
6607
6683
|
#
|
6608
6684
|
# Valid Values: `true` \| `false`
|
6609
6685
|
#
|
@@ -6679,6 +6755,18 @@ module Aws::StorageGateway
|
|
6679
6755
|
#
|
6680
6756
|
# `\{\}`
|
6681
6757
|
#
|
6758
|
+
# @option params [Boolean] :oplocks_enabled
|
6759
|
+
# Specifies whether opportunistic locking is enabled for the SMB file
|
6760
|
+
# share.
|
6761
|
+
#
|
6762
|
+
# <note markdown="1"> Enabling opportunistic locking on case-sensitive shares is not
|
6763
|
+
# recommended for workloads that involve access to files with the same
|
6764
|
+
# name in different case.
|
6765
|
+
#
|
6766
|
+
# </note>
|
6767
|
+
#
|
6768
|
+
# Valid Values: `true` \| `false`
|
6769
|
+
#
|
6682
6770
|
# @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6683
6771
|
#
|
6684
6772
|
# * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -6706,6 +6794,7 @@ module Aws::StorageGateway
|
|
6706
6794
|
# cache_stale_timeout_in_seconds: 1,
|
6707
6795
|
# },
|
6708
6796
|
# notification_policy: "NotificationPolicy",
|
6797
|
+
# oplocks_enabled: false,
|
6709
6798
|
# })
|
6710
6799
|
#
|
6711
6800
|
# @example Response structure
|
@@ -6721,13 +6810,13 @@ module Aws::StorageGateway
|
|
6721
6810
|
req.send_request(options)
|
6722
6811
|
end
|
6723
6812
|
|
6724
|
-
# Controls whether the shares on
|
6725
|
-
# browse list.
|
6813
|
+
# Controls whether the shares on an S3 File Gateway are visible in a net
|
6814
|
+
# view or browse list. The operation is only supported for S3 File
|
6815
|
+
# Gateways.
|
6726
6816
|
#
|
6727
6817
|
# @option params [required, String] :gateway_arn
|
6728
6818
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6729
|
-
# operation to return a list of gateways for your account and
|
6730
|
-
# Region.
|
6819
|
+
# operation to return a list of gateways for your account and Region.
|
6731
6820
|
#
|
6732
6821
|
# @option params [required, Boolean] :file_shares_visible
|
6733
6822
|
# The shares on this gateway appear when listing shares.
|
@@ -6767,8 +6856,7 @@ module Aws::StorageGateway
|
|
6767
6856
|
#
|
6768
6857
|
# @option params [required, String] :gateway_arn
|
6769
6858
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
6770
|
-
# operation to return a list of gateways for your account and
|
6771
|
-
# Region.
|
6859
|
+
# operation to return a list of gateways for your account and Region.
|
6772
6860
|
#
|
6773
6861
|
# @option params [required, String] :smb_security_strategy
|
6774
6862
|
# Specifies the type of security strategy.
|
@@ -6776,7 +6864,7 @@ module Aws::StorageGateway
|
|
6776
6864
|
# ClientSpecified: if you use this option, requests are established
|
6777
6865
|
# based on what is negotiated by the client. This option is recommended
|
6778
6866
|
# when you want to maximize compatibility across different clients in
|
6779
|
-
# your environment.
|
6867
|
+
# your environment. Supported only in S3 File Gateway.
|
6780
6868
|
#
|
6781
6869
|
# MandatorySigning: if you use this option, file gateway only allows
|
6782
6870
|
# connections from SMBv2 or SMBv3 clients that have signing enabled.
|
@@ -6969,7 +7057,7 @@ module Aws::StorageGateway
|
|
6969
7057
|
params: params,
|
6970
7058
|
config: config)
|
6971
7059
|
context[:gem_name] = 'aws-sdk-storagegateway'
|
6972
|
-
context[:gem_version] = '1.
|
7060
|
+
context[:gem_version] = '1.56.0'
|
6973
7061
|
Seahorse::Client::Request.new(handlers, context)
|
6974
7062
|
end
|
6975
7063
|
|