aws-sdk-storagegateway 1.54.0 → 1.58.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6100cd8b682bb19d3dd56d5faebdaf27e79d0b4b4f1211b8d3dac623cd324e19
4
- data.tar.gz: 3e8d1b47e6a49cd7683923b4c9ae2440b2cd270c5232e60e5b7ab04295ed8a6a
3
+ metadata.gz: ac2104fe6629d507bd85cac4680e6697415f5599aed5902555c395dca15c4bd4
4
+ data.tar.gz: cd5bca0a9f136b4cb8a36c360e76d912988bb75d5e9850f4d5c1864d61c42488
5
5
  SHA512:
6
- metadata.gz: f175dc2e7ef450e9cb7dae996748a630c18c9f5221810ef1202be76f902eab16569acd6e7788447a6bd2a1afa2e7bf56c1fc919791761c6c67923b43ccaf4967
7
- data.tar.gz: 4143fc71ac27929200edc68cff3f976ae8fbb0a557b4582d4bd4ce1b1d33b5bbef630b87c794b76b701750c5af10a0fe02cc9d8f5de7198f80a9d695a8e2493e
6
+ metadata.gz: 3972501da343e2f307b2a5c7139103ff6cdbaced39c847e989d1854eb5fea1c99c7b3e54bd2fca983eaa72ae710fdbac9f02d2d30350bfa19986ece58f83ab58
7
+ data.tar.gz: a9c4f8bce963b9d6424af759d3050c7c62994fffda471feaa8c97a38e83868354438c893291f9c2b8f3f72f4b6bae1946065ca2e5d8d88f80e52a67e3315a8ad
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.58.0 (2021-07-30)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.57.0 (2021-07-28)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.56.0 (2021-07-07)
15
+ ------------------
16
+
17
+ * 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
18
+
19
+ 1.55.0 (2021-04-07)
20
+ ------------------
21
+
22
+ * Feature - File Gateway APIs now support FSx for Windows as a cloud storage.
23
+
4
24
  1.54.0 (2021-03-10)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.54.0
1
+ 1.58.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
48
48
  # @!group service
49
49
  module Aws::StorageGateway
50
50
 
51
- GEM_VERSION = '1.54.0'
51
+ GEM_VERSION = '1.58.0'
52
52
 
53
53
  end
@@ -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 AWS Region
342
- # that you want to use for storing snapshots or tapes, the time zone for
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 *AWS
363
- # Storage Gateway User Guide*.
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 AWS Region where you want to store your
382
- # data. The gateway AWS Region specified must be the same AWS Region as
383
- # the AWS Region in your `Host` header in the request. For more
384
- # information about available AWS Regions and endpoints for AWS Storage
385
- # Gateway, see [AWS Storage Gateway endpoints and quotas][1] in the *AWS
386
- # General Reference*.
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 [AWS Storage Gateway endpoints and quotas][1] in the
389
- # *AWS General Reference*.
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 AWS Storage Gateway works (architecture)][1].
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 AWS
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 AWS Storage
550
- # Gateway resources:
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.
@@ -627,7 +629,7 @@ module Aws::StorageGateway
627
629
 
628
630
  # Configures one or more gateway local disks as upload buffer for a
629
631
  # specified gateway. This operation is supported for the stored volume,
630
- # cached volume and tape gateway types.
632
+ # cached volume, and tape gateway types.
631
633
  #
632
634
  # In the request, you specify the gateway Amazon Resource Name (ARN) to
633
635
  # which you want to add upload buffer, and one or more disk IDs that you
@@ -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 AWS
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 AWS
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,6 +809,90 @@ module Aws::StorageGateway
809
809
  req.send_request(options)
810
810
  end
811
811
 
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
+ #
817
+ # @option params [required, String] :user_name
818
+ # The user name of the user credential that has permission to access the
819
+ # root share D$ of the Amazon FSx file system. The user account must
820
+ # belong to the Amazon FSx delegated admin user group.
821
+ #
822
+ # @option params [required, String] :password
823
+ # The password of the user credential.
824
+ #
825
+ # @option params [required, String] :client_token
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
+ #
829
+ # @option params [required, String] :gateway_arn
830
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
831
+ # operation to return a list of gateways for your account and Region.
832
+ #
833
+ # @option params [required, String] :location_arn
834
+ # The Amazon Resource Name (ARN) of the Amazon FSx file system to
835
+ # associate with the FSx File Gateway.
836
+ #
837
+ # @option params [Array<Types::Tag>] :tags
838
+ # A list of up to 50 tags that can be assigned to the file system
839
+ # association. Each tag is a key-value pair.
840
+ #
841
+ # @option params [String] :audit_destination_arn
842
+ # The Amazon Resource Name (ARN) of the storage used for the audit logs.
843
+ #
844
+ # @option params [Types::CacheAttributes] :cache_attributes
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>
855
+ #
856
+ # @return [Types::AssociateFileSystemOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
857
+ #
858
+ # * {Types::AssociateFileSystemOutput#file_system_association_arn #file_system_association_arn} => String
859
+ #
860
+ # @example Request syntax with placeholder values
861
+ #
862
+ # resp = client.associate_file_system({
863
+ # user_name: "DomainUserName", # required
864
+ # password: "DomainUserPassword", # required
865
+ # client_token: "ClientToken", # required
866
+ # gateway_arn: "GatewayARN", # required
867
+ # location_arn: "FileSystemLocationARN", # required
868
+ # tags: [
869
+ # {
870
+ # key: "TagKey", # required
871
+ # value: "TagValue", # required
872
+ # },
873
+ # ],
874
+ # audit_destination_arn: "AuditDestinationARN",
875
+ # cache_attributes: {
876
+ # cache_stale_timeout_in_seconds: 1,
877
+ # },
878
+ # endpoint_network_configuration: {
879
+ # ip_addresses: ["IPV4Address"],
880
+ # },
881
+ # })
882
+ #
883
+ # @example Response structure
884
+ #
885
+ # resp.file_system_association_arn #=> String
886
+ #
887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssociateFileSystem AWS API Documentation
888
+ #
889
+ # @overload associate_file_system(params = {})
890
+ # @param [Hash] params ({})
891
+ def associate_file_system(params = {}, options = {})
892
+ req = build_request(:associate_file_system, params)
893
+ req.send_request(options)
894
+ end
895
+
812
896
  # Connects a volume to an iSCSI connection and then attaches the volume
813
897
  # to the specified gateway. Detaching and attaching a volume enables you
814
898
  # to recover your data from one gateway to a different gateway without
@@ -881,8 +965,7 @@ module Aws::StorageGateway
881
965
  #
882
966
  # @option params [required, String] :gateway_arn
883
967
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
884
- # operation to return a list of gateways for your account and AWS
885
- # Region.
968
+ # operation to return a list of gateways for your account and Region.
886
969
  #
887
970
  # @option params [required, String] :tape_arn
888
971
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -934,8 +1017,7 @@ module Aws::StorageGateway
934
1017
  #
935
1018
  # @option params [required, String] :gateway_arn
936
1019
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
937
- # operation to return a list of gateways for your account and AWS
938
- # Region.
1020
+ # operation to return a list of gateways for your account and Region.
939
1021
  #
940
1022
  # @option params [required, String] :tape_arn
941
1023
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -1005,8 +1087,7 @@ module Aws::StorageGateway
1005
1087
  #
1006
1088
  # @option params [required, String] :gateway_arn
1007
1089
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1008
- # operation to return a list of gateways for your account and AWS
1009
- # Region.
1090
+ # operation to return a list of gateways for your account and Region.
1010
1091
  #
1011
1092
  # @option params [required, Integer] :volume_size_in_bytes
1012
1093
  # The size of the volume in bytes.
@@ -1053,7 +1134,7 @@ module Aws::StorageGateway
1053
1134
  #
1054
1135
  # @option params [Boolean] :kms_encrypted
1055
1136
  # Set to `true` to use Amazon S3 server-side encryption with your own
1056
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1137
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1057
1138
  #
1058
1139
  # Valid Values: `true` \| `false`
1059
1140
  #
@@ -1134,21 +1215,20 @@ module Aws::StorageGateway
1134
1215
  req.send_request(options)
1135
1216
  end
1136
1217
 
1137
- # Creates a Network File System (NFS) file share on an existing file
1138
- # gateway. In Storage Gateway, a file share is a file system mount point
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
1139
1220
  # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
1140
- # using an NFS interface. This operation is only supported for file
1141
- # gateways.
1221
+ # using an NFS interface. This operation is only supported for S3 File
1222
+ # Gateways.
1142
1223
  #
1143
- # File gateway requires AWS Security Token Service (AWS STS) to be
1144
- # activated to enable you to create a file share. Make sure AWS STS is
1145
- # activated in the AWS Region you are creating your file gateway in. If
1146
- # AWS STS is not activated in the AWS Region, activate it. For
1147
- # information about how to activate AWS STS, see [Activating and
1148
- # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1149
- # 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*.
1150
1230
  #
1151
- # File gateway does not support creating hard or symbolic links on a
1231
+ # S3 File Gateways do not support creating hard or symbolic links on a
1152
1232
  # file share.
1153
1233
  #
1154
1234
  #
@@ -1156,19 +1236,19 @@ module Aws::StorageGateway
1156
1236
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
1157
1237
  #
1158
1238
  # @option params [required, String] :client_token
1159
- # A unique string value that you supply that is used by file gateway to
1160
- # 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.
1161
1241
  #
1162
1242
  # @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
1163
1243
  # File share default values. Optional.
1164
1244
  #
1165
1245
  # @option params [required, String] :gateway_arn
1166
- # The Amazon Resource Name (ARN) of the file gateway on which you want
1167
- # 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.
1168
1248
  #
1169
1249
  # @option params [Boolean] :kms_encrypted
1170
1250
  # Set to `true` to use Amazon S3 server-side encryption with your own
1171
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1251
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1172
1252
  #
1173
1253
  # Valid Values: `true` \| `false`
1174
1254
  #
@@ -1179,16 +1259,32 @@ module Aws::StorageGateway
1179
1259
  # `KMSEncrypted` is `true`. Optional.
1180
1260
  #
1181
1261
  # @option params [required, String] :role
1182
- # The ARN of the AWS Identity and Access Management (IAM) role that a
1183
- # file gateway assumes when it accesses the underlying storage.
1262
+ # The ARN of the Identity and Access Management (IAM) role that an S3
1263
+ # File Gateway assumes when it accesses the underlying storage.
1184
1264
  #
1185
1265
  # @option params [required, String] :location_arn
1186
1266
  # The ARN of the backend storage used for storing file data. A prefix
1187
1267
  # name can be added to the S3 bucket name. It must end with a "/".
1188
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
+ #
1189
1285
  # @option params [String] :default_storage_class
1190
1286
  # The default storage class for objects put into an Amazon S3 bucket by
1191
- # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1287
+ # the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
1192
1288
  # Optional.
1193
1289
  #
1194
1290
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
@@ -1196,12 +1292,12 @@ module Aws::StorageGateway
1196
1292
  #
1197
1293
  # @option params [String] :object_acl
1198
1294
  # A value that sets the access control list (ACL) permission for objects
1199
- # in the S3 bucket that a file gateway puts objects into. The default
1295
+ # in the S3 bucket that a S3 File Gateway puts objects into. The default
1200
1296
  # value is `private`.
1201
1297
  #
1202
1298
  # @option params [Array<String>] :client_list
1203
- # The list of clients that are allowed to access the file gateway. The
1204
- # 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.
1205
1301
  #
1206
1302
  # @option params [String] :squash
1207
1303
  # A value that maps a user to anonymous user.
@@ -1262,10 +1358,50 @@ module Aws::StorageGateway
1262
1358
  # </note>
1263
1359
  #
1264
1360
  # @option params [Types::CacheAttributes] :cache_attributes
1265
- # Refresh cache information.
1361
+ # Specifies refresh cache information for the file share.
1266
1362
  #
1267
1363
  # @option params [String] :notification_policy
1268
- # The notification policy of the file share.
1364
+ # The notification policy of the file share. `SettlingTimeInSeconds`
1365
+ # controls the number of seconds to wait after the last point in time a
1366
+ # client wrote to a file before generating an `ObjectUploaded`
1367
+ # notification. Because clients can make many small writes to files,
1368
+ # it's best to set this parameter for as long as possible to avoid
1369
+ # generating multiple notifications for the same file in a small time
1370
+ # period.
1371
+ #
1372
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
1373
+ # uploading to Amazon S3, only the timing of the notification.
1374
+ #
1375
+ # </note>
1376
+ #
1377
+ # The following example sets `NotificationPolicy` on with
1378
+ # `SettlingTimeInSeconds` set to 60.
1379
+ #
1380
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
1381
+ #
1382
+ # The following example sets `NotificationPolicy` off.
1383
+ #
1384
+ # `\{\}`
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>
1269
1405
  #
1270
1406
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1271
1407
  #
@@ -1304,6 +1440,8 @@ module Aws::StorageGateway
1304
1440
  # cache_stale_timeout_in_seconds: 1,
1305
1441
  # },
1306
1442
  # notification_policy: "NotificationPolicy",
1443
+ # vpc_endpoint_dns_name: "DNSHostName",
1444
+ # bucket_region: "RegionId",
1307
1445
  # })
1308
1446
  #
1309
1447
  # @example Response structure
@@ -1319,19 +1457,18 @@ module Aws::StorageGateway
1319
1457
  req.send_request(options)
1320
1458
  end
1321
1459
 
1322
- # Creates a Server Message Block (SMB) file share on an existing file
1323
- # gateway. In Storage Gateway, a file share is a file system mount point
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
1324
1462
  # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
1325
- # using an SMB interface. This operation is only supported for file
1326
- # gateways.
1463
+ # using an SMB interface. This operation is only supported for S3 File
1464
+ # Gateways.
1327
1465
  #
1328
- # File gateways require AWS Security Token Service (AWS STS) to be
1329
- # activated to enable you to create a file share. Make sure that AWS STS
1330
- # is activated in the AWS Region you are creating your file gateway in.
1331
- # If AWS STS is not activated in this AWS Region, activate it. For
1332
- # information about how to activate AWS STS, see [Activating and
1333
- # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1334
- # 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*.
1335
1472
  #
1336
1473
  # File gateways don't support creating hard or symbolic links on a
1337
1474
  # file
@@ -1342,15 +1479,16 @@ module Aws::StorageGateway
1342
1479
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
1343
1480
  #
1344
1481
  # @option params [required, String] :client_token
1345
- # A unique string value that you supply that is used by file gateway to
1346
- # 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.
1347
1484
  #
1348
1485
  # @option params [required, String] :gateway_arn
1349
- # The ARN of the file gateway on which you want to create a file share.
1486
+ # The ARN of the S3 File Gateway on which you want to create a file
1487
+ # share.
1350
1488
  #
1351
1489
  # @option params [Boolean] :kms_encrypted
1352
1490
  # Set to `true` to use Amazon S3 server-side encryption with your own
1353
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1491
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1354
1492
  #
1355
1493
  # Valid Values: `true` \| `false`
1356
1494
  #
@@ -1361,16 +1499,32 @@ module Aws::StorageGateway
1361
1499
  # `KMSEncrypted` is `true`. Optional.
1362
1500
  #
1363
1501
  # @option params [required, String] :role
1364
- # The ARN of the AWS Identity and Access Management (IAM) role that a
1365
- # file gateway assumes when it accesses the underlying storage.
1502
+ # The ARN of the Identity and Access Management (IAM) role that an S3
1503
+ # File Gateway assumes when it accesses the underlying storage.
1366
1504
  #
1367
1505
  # @option params [required, String] :location_arn
1368
1506
  # The ARN of the backend storage used for storing file data. A prefix
1369
1507
  # name can be added to the S3 bucket name. It must end with a "/".
1370
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
+ #
1371
1525
  # @option params [String] :default_storage_class
1372
1526
  # The default storage class for objects put into an Amazon S3 bucket by
1373
- # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1527
+ # the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
1374
1528
  # Optional.
1375
1529
  #
1376
1530
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
@@ -1378,7 +1532,7 @@ module Aws::StorageGateway
1378
1532
  #
1379
1533
  # @option params [String] :object_acl
1380
1534
  # A value that sets the access control list (ACL) permission for objects
1381
- # in the S3 bucket that a file gateway puts objects into. The default
1535
+ # in the S3 bucket that a S3 File Gateway puts objects into. The default
1382
1536
  # value is `private`.
1383
1537
  #
1384
1538
  # @option params [Boolean] :read_only
@@ -1415,8 +1569,7 @@ module Aws::StorageGateway
1415
1569
  # permissions to the POSIX permissions.
1416
1570
  #
1417
1571
  # For more information, see [Using Microsoft Windows ACLs to control
1418
- # access to an SMB file share][1] in the *AWS Storage Gateway User
1419
- # Guide*.
1572
+ # access to an SMB file share][1] in the *Storage Gateway User Guide*.
1420
1573
  #
1421
1574
  # Valid Values: `true` \| `false`
1422
1575
  #
@@ -1452,7 +1605,7 @@ module Aws::StorageGateway
1452
1605
  # set to `ActiveDirectory`.
1453
1606
  #
1454
1607
  # @option params [String] :audit_destination_arn
1455
- # The Amazon Resource Name (ARN) of the storage used for the audit logs.
1608
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
1456
1609
  #
1457
1610
  # @option params [String] :authentication
1458
1611
  # The authentication method that users use to access the file share. The
@@ -1486,10 +1639,62 @@ module Aws::StorageGateway
1486
1639
  # </note>
1487
1640
  #
1488
1641
  # @option params [Types::CacheAttributes] :cache_attributes
1489
- # Refresh cache information.
1642
+ # Specifies refresh cache information for the file share.
1490
1643
  #
1491
1644
  # @option params [String] :notification_policy
1492
- # The notification policy of the file share.
1645
+ # The notification policy of the file share. `SettlingTimeInSeconds`
1646
+ # controls the number of seconds to wait after the last point in time a
1647
+ # client wrote to a file before generating an `ObjectUploaded`
1648
+ # notification. Because clients can make many small writes to files,
1649
+ # it's best to set this parameter for as long as possible to avoid
1650
+ # generating multiple notifications for the same file in a small time
1651
+ # period.
1652
+ #
1653
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
1654
+ # uploading to Amazon S3, only the timing of the notification.
1655
+ #
1656
+ # </note>
1657
+ #
1658
+ # The following example sets `NotificationPolicy` on with
1659
+ # `SettlingTimeInSeconds` set to 60.
1660
+ #
1661
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
1662
+ #
1663
+ # The following example sets `NotificationPolicy` off.
1664
+ #
1665
+ # `\{\}`
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`
1493
1698
  #
1494
1699
  # @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1495
1700
  #
@@ -1511,9 +1716,9 @@ module Aws::StorageGateway
1511
1716
  # requester_pays: false,
1512
1717
  # smbacl_enabled: false,
1513
1718
  # access_based_enumeration: false,
1514
- # admin_user_list: ["FileShareUser"],
1515
- # valid_user_list: ["FileShareUser"],
1516
- # invalid_user_list: ["FileShareUser"],
1719
+ # admin_user_list: ["UserListUser"],
1720
+ # valid_user_list: ["UserListUser"],
1721
+ # invalid_user_list: ["UserListUser"],
1517
1722
  # audit_destination_arn: "AuditDestinationARN",
1518
1723
  # authentication: "Authentication",
1519
1724
  # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
@@ -1528,6 +1733,9 @@ module Aws::StorageGateway
1528
1733
  # cache_stale_timeout_in_seconds: 1,
1529
1734
  # },
1530
1735
  # notification_policy: "NotificationPolicy",
1736
+ # vpc_endpoint_dns_name: "DNSHostName",
1737
+ # bucket_region: "RegionId",
1738
+ # oplocks_enabled: false,
1531
1739
  # })
1532
1740
  #
1533
1741
  # @example Response structure
@@ -1545,9 +1753,9 @@ module Aws::StorageGateway
1545
1753
 
1546
1754
  # Initiates a snapshot of a volume.
1547
1755
  #
1548
- # AWS Storage Gateway provides the ability to back up point-in-time
1756
+ # Storage Gateway provides the ability to back up point-in-time
1549
1757
  # snapshots of your data to Amazon Simple Storage (Amazon S3) for
1550
- # durable off-site recovery, as well as import the data to an Amazon
1758
+ # durable off-site recovery, and also import the data to an Amazon
1551
1759
  # Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
1552
1760
  # (EC2). You can take snapshots of your gateway volume on a scheduled or
1553
1761
  # ad hoc basis. This API enables you to take an ad hoc snapshot. For
@@ -1555,13 +1763,12 @@ module Aws::StorageGateway
1555
1763
  #
1556
1764
  # In the `CreateSnapshot` request, you identify the volume by providing
1557
1765
  # its Amazon Resource Name (ARN). You must also provide description for
1558
- # the snapshot. When AWS Storage Gateway takes the snapshot of specified
1559
- # volume, the snapshot and description appears in the AWS Storage
1560
- # Gateway console. In response, AWS Storage Gateway returns you a
1561
- # snapshot ID. You can use this snapshot ID to check the snapshot
1562
- # progress or later use it when you want to create a volume from a
1563
- # snapshot. This operation is only supported in stored and cached volume
1564
- # 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.
1565
1772
  #
1566
1773
  # <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
1567
1774
  # more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
@@ -1586,7 +1793,7 @@ module Aws::StorageGateway
1586
1793
  # @option params [required, String] :snapshot_description
1587
1794
  # Textual description of the snapshot that appears in the Amazon EC2
1588
1795
  # console, Elastic Block Store snapshots panel in the **Description**
1589
- # field, and in the AWS Storage Gateway snapshot **Details** pane,
1796
+ # field, and in the Storage Gateway snapshot **Details** pane,
1590
1797
  # **Description** field.
1591
1798
  #
1592
1799
  # @option params [Array<Types::Tag>] :tags
@@ -1660,7 +1867,7 @@ module Aws::StorageGateway
1660
1867
  # the volume by providing its Amazon Resource Name (ARN). You must also
1661
1868
  # provide a description for the snapshot. When the gateway takes a
1662
1869
  # snapshot of the specified volume, the snapshot and its description
1663
- # appear in the AWS Storage Gateway console. In response, the gateway
1870
+ # appear in the Storage Gateway console. In response, the gateway
1664
1871
  # returns you a snapshot ID. You can use this snapshot ID to check the
1665
1872
  # snapshot progress or later use it when you want to create a volume
1666
1873
  # from a snapshot.
@@ -1684,7 +1891,7 @@ module Aws::StorageGateway
1684
1891
  # @option params [required, String] :snapshot_description
1685
1892
  # Textual description of the snapshot that appears in the Amazon EC2
1686
1893
  # console, Elastic Block Store snapshots panel in the **Description**
1687
- # field, and in the AWS Storage Gateway snapshot **Details** pane,
1894
+ # field, and in the Storage Gateway snapshot **Details** pane,
1688
1895
  # **Description** field.
1689
1896
  #
1690
1897
  # @option params [Array<Types::Tag>] :tags
@@ -1766,8 +1973,7 @@ module Aws::StorageGateway
1766
1973
  #
1767
1974
  # @option params [required, String] :gateway_arn
1768
1975
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1769
- # operation to return a list of gateways for your account and AWS
1770
- # Region.
1976
+ # operation to return a list of gateways for your account and Region.
1771
1977
  #
1772
1978
  # @option params [required, String] :disk_id
1773
1979
  # The unique identifier for the gateway local disk that is configured as
@@ -1779,8 +1985,8 @@ module Aws::StorageGateway
1779
1985
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html
1780
1986
  #
1781
1987
  # @option params [String] :snapshot_id
1782
- # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
1783
- # the new stored volume. Specify this field if you want to create the
1988
+ # The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore
1989
+ # as the new stored volume. Specify this field if you want to create the
1784
1990
  # iSCSI storage volume from a snapshot; otherwise, do not include this
1785
1991
  # field. To list snapshots for your account use [DescribeSnapshots][1]
1786
1992
  # in the *Amazon Elastic Compute Cloud API Reference*.
@@ -1790,7 +1996,7 @@ module Aws::StorageGateway
1790
1996
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
1791
1997
  #
1792
1998
  # @option params [required, Boolean] :preserve_existing_data
1793
- # Set to true `true` if you want to preserve the data on the local disk.
1999
+ # Set to `true` if you want to preserve the data on the local disk.
1794
2000
  # Otherwise, set to `false` to create an empty volume.
1795
2001
  #
1796
2002
  # Valid Values: `true` \| `false`
@@ -1815,7 +2021,7 @@ module Aws::StorageGateway
1815
2021
  #
1816
2022
  # @option params [Boolean] :kms_encrypted
1817
2023
  # Set to `true` to use Amazon S3 server-side encryption with your own
1818
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2024
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1819
2025
  #
1820
2026
  # Valid Values: `true` \| `false`
1821
2027
  #
@@ -1911,10 +2117,10 @@ module Aws::StorageGateway
1911
2117
  #
1912
2118
  # @option params [String] :retention_lock_type
1913
2119
  # 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.
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.
1918
2124
  #
1919
2125
  # @option params [Integer] :retention_lock_time_in_days
1920
2126
  # Tape retention lock time is set in days. Tape retention lock can be
@@ -1978,7 +2184,7 @@ module Aws::StorageGateway
1978
2184
  # @option params [required, String] :gateway_arn
1979
2185
  # The unique Amazon Resource Name (ARN) that represents the gateway to
1980
2186
  # associate the virtual tape with. Use the ListGateways operation to
1981
- # return a list of gateways for your account and AWS Region.
2187
+ # return a list of gateways for your account and Region.
1982
2188
  #
1983
2189
  # @option params [required, Integer] :tape_size_in_bytes
1984
2190
  # The size, in bytes, of the virtual tape that you want to create.
@@ -1997,7 +2203,7 @@ module Aws::StorageGateway
1997
2203
  #
1998
2204
  # @option params [Boolean] :kms_encrypted
1999
2205
  # Set to `true` to use Amazon S3 server-side encryption with your own
2000
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2206
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
2001
2207
  #
2002
2208
  # Valid Values: `true` \| `false`
2003
2209
  #
@@ -2095,7 +2301,7 @@ module Aws::StorageGateway
2095
2301
  # @option params [required, String] :gateway_arn
2096
2302
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2097
2303
  # associate the virtual tapes with. Use the ListGateways operation to
2098
- # return a list of gateways for your account and AWS Region.
2304
+ # return a list of gateways for your account and Region.
2099
2305
  #
2100
2306
  # @option params [required, Integer] :tape_size_in_bytes
2101
2307
  # The size, in bytes, of the virtual tapes that you want to create.
@@ -2121,14 +2327,14 @@ module Aws::StorageGateway
2121
2327
  # A prefix that you append to the barcode of the virtual tape you are
2122
2328
  # creating. This prefix makes the barcode unique.
2123
2329
  #
2124
- # <note markdown="1"> The prefix must be 1 to 4 characters in length and must be one of the
2330
+ # <note markdown="1"> The prefix must be 1-4 characters in length and must be one of the
2125
2331
  # uppercase letters from A to Z.
2126
2332
  #
2127
2333
  # </note>
2128
2334
  #
2129
2335
  # @option params [Boolean] :kms_encrypted
2130
2336
  # Set to `true` to use Amazon S3 server-side encryption with your own
2131
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2337
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
2132
2338
  #
2133
2339
  # Valid Values: `true` \| `false`
2134
2340
  #
@@ -2229,8 +2435,7 @@ module Aws::StorageGateway
2229
2435
  #
2230
2436
  # @option params [required, String] :gateway_arn
2231
2437
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2232
- # operation to return a list of gateways for your account and AWS
2233
- # Region.
2438
+ # operation to return a list of gateways for your account and Region.
2234
2439
  #
2235
2440
  # @return [Types::DeleteAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2236
2441
  #
@@ -2264,8 +2469,7 @@ module Aws::StorageGateway
2264
2469
  #
2265
2470
  # @option params [required, String] :gateway_arn
2266
2471
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2267
- # operation to return a list of gateways for your account and AWS
2268
- # Region.
2472
+ # operation to return a list of gateways for your account and Region.
2269
2473
  #
2270
2474
  # @option params [required, String] :bandwidth_type
2271
2475
  # One of the BandwidthType values that indicates the gateway bandwidth
@@ -2366,18 +2570,18 @@ module Aws::StorageGateway
2366
2570
  req.send_request(options)
2367
2571
  end
2368
2572
 
2369
- # Deletes a file share from a file gateway. This operation is only
2370
- # supported for file gateways.
2573
+ # Deletes a file share from an S3 File Gateway. This operation is only
2574
+ # supported for S3 File Gateways.
2371
2575
  #
2372
2576
  # @option params [required, String] :file_share_arn
2373
2577
  # The Amazon Resource Name (ARN) of the file share to be deleted.
2374
2578
  #
2375
2579
  # @option params [Boolean] :force_delete
2376
2580
  # If this value is set to `true`, the operation deletes a file share
2377
- # immediately and aborts all data uploads to AWS. Otherwise, the file
2378
- # share is not deleted until all data is uploaded to AWS. This process
2379
- # aborts the data upload process, and the file share enters the
2380
- # `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.
2381
2585
  #
2382
2586
  # Valid Values: `true` \| `false`
2383
2587
  #
@@ -2422,7 +2626,7 @@ module Aws::StorageGateway
2422
2626
  # all remaining Amazon EBS snapshots by canceling your Amazon EC2
2423
2627
  # subscription.  If you prefer not to cancel your Amazon EC2
2424
2628
  # subscription, you can delete your snapshots using the Amazon EC2
2425
- # console. For more information, see the [AWS Storage Gateway detail
2629
+ # console. For more information, see the [Storage Gateway detail
2426
2630
  # page][1].
2427
2631
  #
2428
2632
  #
@@ -2431,8 +2635,7 @@ module Aws::StorageGateway
2431
2635
  #
2432
2636
  # @option params [required, String] :gateway_arn
2433
2637
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2434
- # operation to return a list of gateways for your account and AWS
2435
- # Region.
2638
+ # operation to return a list of gateways for your account and Region.
2436
2639
  #
2437
2640
  # @return [Types::DeleteGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2438
2641
  #
@@ -2537,7 +2740,7 @@ module Aws::StorageGateway
2537
2740
  # @option params [required, String] :gateway_arn
2538
2741
  # The unique Amazon Resource Name (ARN) of the gateway that the virtual
2539
2742
  # tape to delete is associated with. Use the ListGateways operation to
2540
- # return a list of gateways for your account and AWS Region.
2743
+ # return a list of gateways for your account and Region.
2541
2744
  #
2542
2745
  # @option params [required, String] :tape_arn
2543
2746
  # The Amazon Resource Name (ARN) of the virtual tape to delete.
@@ -2733,14 +2936,13 @@ module Aws::StorageGateway
2733
2936
  req.send_request(options)
2734
2937
  end
2735
2938
 
2736
- # Returns information about the most recent High Availability monitoring
2939
+ # Returns information about the most recent high availability monitoring
2737
2940
  # test that was performed on the host in a cluster. If a test isn't
2738
2941
  # performed, the status and start time in the response would be null.
2739
2942
  #
2740
2943
  # @option params [required, String] :gateway_arn
2741
2944
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2742
- # operation to return a list of gateways for your account and AWS
2743
- # Region.
2945
+ # operation to return a list of gateways for your account and Region.
2744
2946
  #
2745
2947
  # @return [Types::DescribeAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2746
2948
  #
@@ -2782,8 +2984,7 @@ module Aws::StorageGateway
2782
2984
  #
2783
2985
  # @option params [required, String] :gateway_arn
2784
2986
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2785
- # operation to return a list of gateways for your account and AWS
2786
- # Region.
2987
+ # operation to return a list of gateways for your account and Region.
2787
2988
  #
2788
2989
  # @return [Types::DescribeBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2789
2990
  #
@@ -2851,8 +3052,7 @@ module Aws::StorageGateway
2851
3052
  #
2852
3053
  # @option params [required, String] :gateway_arn
2853
3054
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2854
- # operation to return a list of gateways for your account and AWS
2855
- # Region.
3055
+ # operation to return a list of gateways for your account and Region.
2856
3056
  #
2857
3057
  # @return [Types::DescribeBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2858
3058
  #
@@ -2895,8 +3095,7 @@ module Aws::StorageGateway
2895
3095
  #
2896
3096
  # @option params [required, String] :gateway_arn
2897
3097
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2898
- # operation to return a list of gateways for your account and AWS
2899
- # Region.
3098
+ # operation to return a list of gateways for your account and Region.
2900
3099
  #
2901
3100
  # @return [Types::DescribeCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2902
3101
  #
@@ -2961,8 +3160,8 @@ module Aws::StorageGateway
2961
3160
  # This operation is only supported in the cached volume gateway types.
2962
3161
  #
2963
3162
  # The list of gateway volumes in the request must be from one gateway.
2964
- # In the response, AWS Storage Gateway returns volume information sorted
2965
- # by volume Amazon Resource Name (ARN).
3163
+ # In the response, Storage Gateway returns volume information sorted by
3164
+ # volume Amazon Resource Name (ARN).
2966
3165
  #
2967
3166
  # @option params [required, Array<String>] :volume_arns
2968
3167
  # An array of strings where each string represents the Amazon Resource
@@ -3100,6 +3299,47 @@ module Aws::StorageGateway
3100
3299
  req.send_request(options)
3101
3300
  end
3102
3301
 
3302
+ # Gets the file system association information. This operation is only
3303
+ # supported for FSx File Gateways.
3304
+ #
3305
+ # @option params [required, Array<String>] :file_system_association_arn_list
3306
+ # An array containing the Amazon Resource Name (ARN) of each file system
3307
+ # association to be described.
3308
+ #
3309
+ # @return [Types::DescribeFileSystemAssociationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3310
+ #
3311
+ # * {Types::DescribeFileSystemAssociationsOutput#file_system_association_info_list #file_system_association_info_list} => Array&lt;Types::FileSystemAssociationInfo&gt;
3312
+ #
3313
+ # @example Request syntax with placeholder values
3314
+ #
3315
+ # resp = client.describe_file_system_associations({
3316
+ # file_system_association_arn_list: ["FileSystemAssociationARN"], # required
3317
+ # })
3318
+ #
3319
+ # @example Response structure
3320
+ #
3321
+ # resp.file_system_association_info_list #=> Array
3322
+ # resp.file_system_association_info_list[0].file_system_association_arn #=> String
3323
+ # resp.file_system_association_info_list[0].location_arn #=> String
3324
+ # resp.file_system_association_info_list[0].file_system_association_status #=> String
3325
+ # resp.file_system_association_info_list[0].audit_destination_arn #=> String
3326
+ # resp.file_system_association_info_list[0].gateway_arn #=> String
3327
+ # resp.file_system_association_info_list[0].tags #=> Array
3328
+ # resp.file_system_association_info_list[0].tags[0].key #=> String
3329
+ # resp.file_system_association_info_list[0].tags[0].value #=> String
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
3333
+ #
3334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociations AWS API Documentation
3335
+ #
3336
+ # @overload describe_file_system_associations(params = {})
3337
+ # @param [Hash] params ({})
3338
+ def describe_file_system_associations(params = {}, options = {})
3339
+ req = build_request(:describe_file_system_associations, params)
3340
+ req.send_request(options)
3341
+ end
3342
+
3103
3343
  # Returns metadata about a gateway such as its name, network interfaces,
3104
3344
  # configured time zone, and the state (whether the gateway is running or
3105
3345
  # not). To specify which gateway to describe, use the Amazon Resource
@@ -3107,8 +3347,7 @@ module Aws::StorageGateway
3107
3347
  #
3108
3348
  # @option params [required, String] :gateway_arn
3109
3349
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3110
- # operation to return a list of gateways for your account and AWS
3111
- # Region.
3350
+ # operation to return a list of gateways for your account and Region.
3112
3351
  #
3113
3352
  # @return [Types::DescribeGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3114
3353
  #
@@ -3130,6 +3369,8 @@ module Aws::StorageGateway
3130
3369
  # * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
3131
3370
  # * {Types::DescribeGatewayInformationOutput#software_updates_end_date #software_updates_end_date} => String
3132
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&lt;String&gt;
3133
3374
  #
3134
3375
  #
3135
3376
  # @example Example: To describe metadata about the gateway
@@ -3189,6 +3430,9 @@ module Aws::StorageGateway
3189
3430
  # resp.endpoint_type #=> String
3190
3431
  # resp.software_updates_end_date #=> String
3191
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"
3192
3436
  #
3193
3437
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
3194
3438
  #
@@ -3205,8 +3449,7 @@ module Aws::StorageGateway
3205
3449
  #
3206
3450
  # @option params [required, String] :gateway_arn
3207
3451
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3208
- # operation to return a list of gateways for your account and AWS
3209
- # Region.
3452
+ # operation to return a list of gateways for your account and Region.
3210
3453
  #
3211
3454
  # @return [Types::DescribeMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3212
3455
  #
@@ -3260,8 +3503,8 @@ module Aws::StorageGateway
3260
3503
  end
3261
3504
 
3262
3505
  # Gets a description for one or more Network File System (NFS) file
3263
- # shares from a file gateway. This operation is only supported for file
3264
- # gateways.
3506
+ # shares from an S3 File Gateway. This operation is only supported for
3507
+ # S3 File Gateways.
3265
3508
  #
3266
3509
  # @option params [required, Array<String>] :file_share_arn_list
3267
3510
  # An array containing the Amazon Resource Name (ARN) of each file share
@@ -3307,6 +3550,8 @@ module Aws::StorageGateway
3307
3550
  # resp.nfs_file_share_info_list[0].file_share_name #=> String
3308
3551
  # resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3309
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
3310
3555
  #
3311
3556
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
3312
3557
  #
@@ -3318,8 +3563,8 @@ module Aws::StorageGateway
3318
3563
  end
3319
3564
 
3320
3565
  # Gets a description for one or more Server Message Block (SMB) file
3321
- # shares from a file gateway. This operation is only supported for file
3322
- # gateways.
3566
+ # shares from a S3 File Gateway. This operation is only supported for S3
3567
+ # File Gateways.
3323
3568
  #
3324
3569
  # @option params [required, Array<String>] :file_share_arn_list
3325
3570
  # An array containing the Amazon Resource Name (ARN) of each file share
@@ -3369,6 +3614,9 @@ module Aws::StorageGateway
3369
3614
  # resp.smb_file_share_info_list[0].file_share_name #=> String
3370
3615
  # resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3371
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
3372
3620
  #
3373
3621
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
3374
3622
  #
@@ -3385,8 +3633,7 @@ module Aws::StorageGateway
3385
3633
  #
3386
3634
  # @option params [required, String] :gateway_arn
3387
3635
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3388
- # operation to return a list of gateways for your account and AWS
3389
- # Region.
3636
+ # operation to return a list of gateways for your account and Region.
3390
3637
  #
3391
3638
  # @return [Types::DescribeSMBSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3392
3639
  #
@@ -3486,9 +3733,9 @@ module Aws::StorageGateway
3486
3733
 
3487
3734
  # Returns the description of the gateway volumes specified in the
3488
3735
  # request. The list of gateway volumes in the request must be from one
3489
- # gateway. In the response, AWS Storage Gateway returns volume
3490
- # information sorted by volume ARNs. This operation is only supported in
3491
- # stored volume gateway type.
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.
3492
3739
  #
3493
3740
  # @option params [required, Array<String>] :volume_arns
3494
3741
  # An array of strings where each string represents the Amazon Resource
@@ -3574,9 +3821,9 @@ module Aws::StorageGateway
3574
3821
  # shelf (VTS). This operation is only supported in the tape gateway
3575
3822
  # type.
3576
3823
  #
3577
- # If a specific `TapeARN` is not specified, AWS Storage Gateway returns
3578
- # a description of all virtual tapes found in the VTS associated with
3579
- # your account.
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.
3580
3827
  #
3581
3828
  # @option params [Array<String>] :tape_arns
3582
3829
  # Specifies one or more unique Amazon Resource Names (ARNs) that
@@ -3678,8 +3925,7 @@ module Aws::StorageGateway
3678
3925
  #
3679
3926
  # @option params [required, String] :gateway_arn
3680
3927
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3681
- # operation to return a list of gateways for your account and AWS
3682
- # Region.
3928
+ # operation to return a list of gateways for your account and Region.
3683
3929
  #
3684
3930
  # @option params [String] :marker
3685
3931
  # An opaque string that indicates the position at which to begin
@@ -3756,8 +4002,7 @@ module Aws::StorageGateway
3756
4002
  #
3757
4003
  # @option params [required, String] :gateway_arn
3758
4004
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3759
- # operation to return a list of gateways for your account and AWS
3760
- # Region.
4005
+ # operation to return a list of gateways for your account and Region.
3761
4006
  #
3762
4007
  # @option params [Array<String>] :tape_arns
3763
4008
  # Specifies one or more unique Amazon Resource Names (ARNs) that
@@ -3868,8 +4113,7 @@ module Aws::StorageGateway
3868
4113
  #
3869
4114
  # @option params [required, String] :gateway_arn
3870
4115
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3871
- # operation to return a list of gateways for your account and AWS
3872
- # Region.
4116
+ # operation to return a list of gateways for your account and Region.
3873
4117
  #
3874
4118
  # @return [Types::DescribeUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3875
4119
  #
@@ -3943,15 +4187,14 @@ module Aws::StorageGateway
3943
4187
  end
3944
4188
 
3945
4189
  # Returns a description of virtual tape library (VTL) devices for the
3946
- # specified tape gateway. In the response, AWS Storage Gateway returns
3947
- # VTL device information.
4190
+ # specified tape gateway. In the response, Storage Gateway returns VTL
4191
+ # device information.
3948
4192
  #
3949
4193
  # This operation is only supported in the tape gateway type.
3950
4194
  #
3951
4195
  # @option params [required, String] :gateway_arn
3952
4196
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3953
- # operation to return a list of gateways for your account and AWS
3954
- # Region.
4197
+ # operation to return a list of gateways for your account and Region.
3955
4198
  #
3956
4199
  # @option params [Array<String>] :vtl_device_arns
3957
4200
  # An array of strings, where each string represents the Amazon Resource
@@ -4084,8 +4327,7 @@ module Aws::StorageGateway
4084
4327
  #
4085
4328
  # @option params [required, String] :gateway_arn
4086
4329
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4087
- # operation to return a list of gateways for your account and AWS
4088
- # Region.
4330
+ # operation to return a list of gateways for your account and Region.
4089
4331
  #
4090
4332
  # @return [Types::DescribeWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4091
4333
  #
@@ -4194,8 +4436,7 @@ module Aws::StorageGateway
4194
4436
  #
4195
4437
  # @option params [required, String] :gateway_arn
4196
4438
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4197
- # operation to return a list of gateways for your account and AWS
4198
- # Region.
4439
+ # operation to return a list of gateways for your account and Region.
4199
4440
  #
4200
4441
  # @return [Types::DisableGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4201
4442
  #
@@ -4235,13 +4476,52 @@ module Aws::StorageGateway
4235
4476
  req.send_request(options)
4236
4477
  end
4237
4478
 
4479
+ # Disassociates an Amazon FSx file system from the specified gateway.
4480
+ # After the disassociation process finishes, the gateway can no longer
4481
+ # access the Amazon FSx file system. This operation is only supported in
4482
+ # the FSx File Gateway type.
4483
+ #
4484
+ # @option params [required, String] :file_system_association_arn
4485
+ # The Amazon Resource Name (ARN) of the file system association to be
4486
+ # deleted.
4487
+ #
4488
+ # @option params [Boolean] :force_delete
4489
+ # If this value is set to true, the operation disassociates an Amazon
4490
+ # FSx file system immediately. It ends all data uploads to the file
4491
+ # system, and the file system association enters the `FORCE_DELETING`
4492
+ # status. If this value is set to false, the Amazon FSx file system does
4493
+ # not disassociate until all data is uploaded.
4494
+ #
4495
+ # @return [Types::DisassociateFileSystemOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4496
+ #
4497
+ # * {Types::DisassociateFileSystemOutput#file_system_association_arn #file_system_association_arn} => String
4498
+ #
4499
+ # @example Request syntax with placeholder values
4500
+ #
4501
+ # resp = client.disassociate_file_system({
4502
+ # file_system_association_arn: "FileSystemAssociationARN", # required
4503
+ # force_delete: false,
4504
+ # })
4505
+ #
4506
+ # @example Response structure
4507
+ #
4508
+ # resp.file_system_association_arn #=> String
4509
+ #
4510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisassociateFileSystem AWS API Documentation
4511
+ #
4512
+ # @overload disassociate_file_system(params = {})
4513
+ # @param [Hash] params ({})
4514
+ def disassociate_file_system(params = {}, options = {})
4515
+ req = build_request(:disassociate_file_system, params)
4516
+ req.send_request(options)
4517
+ end
4518
+
4238
4519
  # Adds a file gateway to an Active Directory domain. This operation is
4239
4520
  # only supported for file gateways that support the SMB file protocol.
4240
4521
  #
4241
4522
  # @option params [required, String] :gateway_arn
4242
4523
  # The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways`
4243
- # operation to return a list of gateways for your account and AWS
4244
- # Region.
4524
+ # operation to return a list of gateways for your account and Region.
4245
4525
  #
4246
4526
  # @option params [required, String] :domain_name
4247
4527
  # The name of the domain that you want the gateway to join.
@@ -4311,8 +4591,7 @@ module Aws::StorageGateway
4311
4591
  #
4312
4592
  # @option params [String] :gateway_arn
4313
4593
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4314
- # operation to return a list of gateways for your account and AWS
4315
- # Region.
4594
+ # operation to return a list of gateways for your account and Region.
4316
4595
  #
4317
4596
  # @return [Types::ListAutomaticTapeCreationPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4318
4597
  #
@@ -4344,9 +4623,9 @@ module Aws::StorageGateway
4344
4623
  req.send_request(options)
4345
4624
  end
4346
4625
 
4347
- # Gets a list of the file shares for a specific file gateway, or the
4626
+ # Gets a list of the file shares for a specific S3 File Gateway, or the
4348
4627
  # list of file shares that belong to the calling user account. This
4349
- # operation is only supported for file gateways.
4628
+ # operation is only supported for S3 File Gateways.
4350
4629
  #
4351
4630
  # @option params [String] :gateway_arn
4352
4631
  # The Amazon Resource Name (ARN) of the gateway whose file shares you
@@ -4398,9 +4677,63 @@ module Aws::StorageGateway
4398
4677
  req.send_request(options)
4399
4678
  end
4400
4679
 
4401
- # Lists gateways owned by an AWS account in an AWS Region specified in
4402
- # the request. The returned list is ordered by gateway Amazon Resource
4403
- # Name (ARN).
4680
+ # Gets a list of `FileSystemAssociationSummary` objects. Each object
4681
+ # contains a summary of a file system association. This operation is
4682
+ # only supported for FSx File Gateways.
4683
+ #
4684
+ # @option params [String] :gateway_arn
4685
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4686
+ # operation to return a list of gateways for your account and Region.
4687
+ #
4688
+ # @option params [Integer] :limit
4689
+ # The maximum number of file system associations to return in the
4690
+ # response. If present, `Limit` must be an integer with a value greater
4691
+ # than zero. Optional.
4692
+ #
4693
+ # @option params [String] :marker
4694
+ # Opaque pagination token returned from a previous
4695
+ # `ListFileSystemAssociations` operation. If present, `Marker` specifies
4696
+ # where to continue the list from after a previous call to
4697
+ # `ListFileSystemAssociations`. Optional.
4698
+ #
4699
+ # @return [Types::ListFileSystemAssociationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4700
+ #
4701
+ # * {Types::ListFileSystemAssociationsOutput#marker #marker} => String
4702
+ # * {Types::ListFileSystemAssociationsOutput#next_marker #next_marker} => String
4703
+ # * {Types::ListFileSystemAssociationsOutput#file_system_association_summary_list #file_system_association_summary_list} => Array&lt;Types::FileSystemAssociationSummary&gt;
4704
+ #
4705
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4706
+ #
4707
+ # @example Request syntax with placeholder values
4708
+ #
4709
+ # resp = client.list_file_system_associations({
4710
+ # gateway_arn: "GatewayARN",
4711
+ # limit: 1,
4712
+ # marker: "Marker",
4713
+ # })
4714
+ #
4715
+ # @example Response structure
4716
+ #
4717
+ # resp.marker #=> String
4718
+ # resp.next_marker #=> String
4719
+ # resp.file_system_association_summary_list #=> Array
4720
+ # resp.file_system_association_summary_list[0].file_system_association_id #=> String
4721
+ # resp.file_system_association_summary_list[0].file_system_association_arn #=> String
4722
+ # resp.file_system_association_summary_list[0].file_system_association_status #=> String
4723
+ # resp.file_system_association_summary_list[0].gateway_arn #=> String
4724
+ #
4725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileSystemAssociations AWS API Documentation
4726
+ #
4727
+ # @overload list_file_system_associations(params = {})
4728
+ # @param [Hash] params ({})
4729
+ def list_file_system_associations(params = {}, options = {})
4730
+ req = build_request(:list_file_system_associations, params)
4731
+ req.send_request(options)
4732
+ end
4733
+
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).
4404
4737
  #
4405
4738
  # By default, the operation returns a maximum of 100 gateways. This
4406
4739
  # operation supports pagination that allows you to optionally reduce the
@@ -4492,8 +4825,7 @@ module Aws::StorageGateway
4492
4825
  #
4493
4826
  # @option params [required, String] :gateway_arn
4494
4827
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4495
- # operation to return a list of gateways for your account and AWS
4496
- # Region.
4828
+ # operation to return a list of gateways for your account and Region.
4497
4829
  #
4498
4830
  # @return [Types::ListLocalDisksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4499
4831
  #
@@ -4801,8 +5133,7 @@ module Aws::StorageGateway
4801
5133
  #
4802
5134
  # @option params [required, String] :gateway_arn
4803
5135
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4804
- # operation to return a list of gateways for your account and AWS
4805
- # Region.
5136
+ # operation to return a list of gateways for your account and Region.
4806
5137
  #
4807
5138
  # @return [Types::ListVolumeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4808
5139
  #
@@ -4871,8 +5202,7 @@ module Aws::StorageGateway
4871
5202
  #
4872
5203
  # @option params [String] :gateway_arn
4873
5204
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4874
- # operation to return a list of gateways for your account and AWS
4875
- # Region.
5205
+ # operation to return a list of gateways for your account and Region.
4876
5206
  #
4877
5207
  # @option params [String] :marker
4878
5208
  # A string that indicates the position at which to begin the returned
@@ -4959,18 +5289,18 @@ module Aws::StorageGateway
4959
5289
  # Sends you notification through CloudWatch Events when all files
4960
5290
  # written to your file share have been uploaded to Amazon S3.
4961
5291
  #
4962
- # AWS Storage Gateway can send a notification through Amazon CloudWatch
5292
+ # Storage Gateway can send a notification through Amazon CloudWatch
4963
5293
  # Events when all files written to your file share up to that point in
4964
5294
  # time have been uploaded to Amazon S3. These files include files
4965
5295
  # written to the file share up to the time that you make a request for
4966
5296
  # notification. When the upload is done, Storage Gateway sends you
4967
5297
  # notification through an Amazon CloudWatch Event. You can configure
4968
5298
  # CloudWatch Events to send the notification through event targets such
4969
- # as Amazon SNS or AWS Lambda function. This operation is only supported
4970
- # for file gateways.
5299
+ # as Amazon SNS or Lambda function. This operation is only supported for
5300
+ # S3 File Gateways.
4971
5301
  #
4972
5302
  # For more information, see [Getting file upload notification][1] in the
4973
- # *AWS Storage Gateway User Guide*.
5303
+ # *Storage Gateway User Guide*.
4974
5304
  #
4975
5305
  #
4976
5306
  #
@@ -5004,28 +5334,34 @@ module Aws::StorageGateway
5004
5334
  req.send_request(options)
5005
5335
  end
5006
5336
 
5007
- # Refreshes the cache for the specified file share. This operation finds
5008
- # objects in the Amazon S3 bucket that were added, removed, or replaced
5009
- # since the gateway last listed the bucket's contents and cached the
5010
- # results. This operation is only supported in the file gateway type.
5337
+ # Refreshes the cached inventory of objects for the specified file
5338
+ # share. This operation finds objects in the Amazon S3 bucket that were
5339
+ # added, removed, or replaced since the gateway last listed the
5340
+ # bucket's contents and cached the results. This operation does not
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
+ #
5011
5346
  # You can subscribe to be notified through an Amazon CloudWatch event
5012
- # when your RefreshCache operation completes. For more information, see
5013
- # [Getting notified about file operations][1] in the *AWS Storage
5014
- # Gateway User Guide*.
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.
5015
5351
  #
5016
5352
  # When this API is called, it only initiates the refresh operation. When
5017
5353
  # the API call completes and returns a success code, it doesn't
5018
5354
  # necessarily mean that the file refresh has completed. You should use
5019
5355
  # the refresh-complete notification to determine that the operation has
5020
5356
  # completed before you check for new files on the gateway file share.
5021
- # You can subscribe to be notified through an CloudWatch event when your
5357
+ # You can subscribe to be notified through a CloudWatch event when your
5022
5358
  # `RefreshCache` operation completes.
5023
5359
  #
5024
- # Throttle limit: This API is asynchronous so the gateway will accept no
5025
- # more than two refreshes at any time. We recommend using the
5360
+ # Throttle limit: This API is asynchronous, so the gateway will accept
5361
+ # no more than two refreshes at any time. We recommend using the
5026
5362
  # refresh-complete CloudWatch event notification before issuing
5027
5363
  # additional requests. For more information, see [Getting notified about
5028
- # file operations][1] in the *AWS Storage Gateway User Guide*.
5364
+ # file operations][1] in the *Storage Gateway User Guide*.
5029
5365
  #
5030
5366
  # If you invoke the RefreshCache API when two requests are already being
5031
5367
  # processed, any new request will cause an
@@ -5033,7 +5369,7 @@ module Aws::StorageGateway
5033
5369
  # sent to the server.
5034
5370
  #
5035
5371
  # For more information, see [Getting notified about file operations][1]
5036
- # in the *AWS Storage Gateway User Guide*.
5372
+ # in the *Storage Gateway User Guide*.
5037
5373
  #
5038
5374
  #
5039
5375
  #
@@ -5157,8 +5493,7 @@ module Aws::StorageGateway
5157
5493
  #
5158
5494
  # @option params [required, String] :gateway_arn
5159
5495
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5160
- # operation to return a list of gateways for your account and AWS
5161
- # Region.
5496
+ # operation to return a list of gateways for your account and Region.
5162
5497
  #
5163
5498
  # @return [Types::ResetCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5164
5499
  #
@@ -5216,7 +5551,7 @@ module Aws::StorageGateway
5216
5551
  # @option params [required, String] :gateway_arn
5217
5552
  # The Amazon Resource Name (ARN) of the gateway you want to retrieve the
5218
5553
  # virtual tape to. Use the ListGateways operation to return a list of
5219
- # gateways for your account and AWS Region.
5554
+ # gateways for your account and Region.
5220
5555
  #
5221
5556
  # You retrieve archived virtual tapes to only one gateway and the
5222
5557
  # gateway must be a tape gateway.
@@ -5281,8 +5616,7 @@ module Aws::StorageGateway
5281
5616
  #
5282
5617
  # @option params [required, String] :gateway_arn
5283
5618
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5284
- # operation to return a list of gateways for your account and AWS
5285
- # Region.
5619
+ # operation to return a list of gateways for your account and Region.
5286
5620
  #
5287
5621
  # @return [Types::RetrieveTapeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5288
5622
  #
@@ -5330,8 +5664,7 @@ module Aws::StorageGateway
5330
5664
  #
5331
5665
  # @option params [required, String] :gateway_arn
5332
5666
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5333
- # operation to return a list of gateways for your account and AWS
5334
- # Region.
5667
+ # operation to return a list of gateways for your account and Region.
5335
5668
  #
5336
5669
  # @option params [required, String] :local_console_password
5337
5670
  # The password you want to set for your VM local console.
@@ -5377,11 +5710,11 @@ module Aws::StorageGateway
5377
5710
 
5378
5711
  # Sets the password for the guest user `smbguest`. The `smbguest` user
5379
5712
  # is the user when the authentication method for the file share is set
5380
- # to `GuestAccess`.
5713
+ # to `GuestAccess`. This operation only supported for S3 File Gateways
5381
5714
  #
5382
5715
  # @option params [required, String] :gateway_arn
5383
- # The Amazon Resource Name (ARN) of the file gateway the SMB file share
5384
- # is associated with.
5716
+ # The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file
5717
+ # share is associated with.
5385
5718
  #
5386
5719
  # @option params [required, String] :password
5387
5720
  # The password that you want to set for your SMB server.
@@ -5441,8 +5774,7 @@ module Aws::StorageGateway
5441
5774
  #
5442
5775
  # @option params [required, String] :gateway_arn
5443
5776
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5444
- # operation to return a list of gateways for your account and AWS
5445
- # Region.
5777
+ # operation to return a list of gateways for your account and Region.
5446
5778
  #
5447
5779
  # @return [Types::ShutdownGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5448
5780
  #
@@ -5496,8 +5828,7 @@ module Aws::StorageGateway
5496
5828
  #
5497
5829
  # @option params [required, String] :gateway_arn
5498
5830
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5499
- # operation to return a list of gateways for your account and AWS
5500
- # Region.
5831
+ # operation to return a list of gateways for your account and Region.
5501
5832
  #
5502
5833
  # @return [Types::StartAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5503
5834
  #
@@ -5540,8 +5871,7 @@ module Aws::StorageGateway
5540
5871
  #
5541
5872
  # @option params [required, String] :gateway_arn
5542
5873
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5543
- # operation to return a list of gateways for your account and AWS
5544
- # Region.
5874
+ # operation to return a list of gateways for your account and Region.
5545
5875
  #
5546
5876
  # @return [Types::StartGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5547
5877
  #
@@ -5597,8 +5927,7 @@ module Aws::StorageGateway
5597
5927
  #
5598
5928
  # @option params [required, String] :gateway_arn
5599
5929
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5600
- # operation to return a list of gateways for your account and AWS
5601
- # Region.
5930
+ # operation to return a list of gateways for your account and Region.
5602
5931
  #
5603
5932
  # @return [Types::UpdateAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5604
5933
  #
@@ -5648,8 +5977,7 @@ module Aws::StorageGateway
5648
5977
  #
5649
5978
  # @option params [required, String] :gateway_arn
5650
5979
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5651
- # operation to return a list of gateways for your account and AWS
5652
- # Region.
5980
+ # operation to return a list of gateways for your account and Region.
5653
5981
  #
5654
5982
  # @option params [Integer] :average_upload_rate_limit_in_bits_per_sec
5655
5983
  # The average upload bandwidth rate limit in bits per second.
@@ -5707,8 +6035,7 @@ module Aws::StorageGateway
5707
6035
  #
5708
6036
  # @option params [required, String] :gateway_arn
5709
6037
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5710
- # operation to return a list of gateways for your account and AWS
5711
- # Region.
6038
+ # operation to return a list of gateways for your account and Region.
5712
6039
  #
5713
6040
  # @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
5714
6041
  # An array containing bandwidth rate limit schedule intervals for a
@@ -5830,6 +6157,56 @@ module Aws::StorageGateway
5830
6157
  req.send_request(options)
5831
6158
  end
5832
6159
 
6160
+ # Updates a file system association. This operation is only supported in
6161
+ # the FSx File Gateways.
6162
+ #
6163
+ # @option params [required, String] :file_system_association_arn
6164
+ # The Amazon Resource Name (ARN) of the file system association that you
6165
+ # want to update.
6166
+ #
6167
+ # @option params [String] :user_name
6168
+ # The user name of the user credential that has permission to access the
6169
+ # root share D$ of the Amazon FSx file system. The user account must
6170
+ # belong to the Amazon FSx delegated admin user group.
6171
+ #
6172
+ # @option params [String] :password
6173
+ # The password of the user credential.
6174
+ #
6175
+ # @option params [String] :audit_destination_arn
6176
+ # The Amazon Resource Name (ARN) of the storage used for the audit logs.
6177
+ #
6178
+ # @option params [Types::CacheAttributes] :cache_attributes
6179
+ # The refresh cache information for the file share or FSx file systems.
6180
+ #
6181
+ # @return [Types::UpdateFileSystemAssociationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6182
+ #
6183
+ # * {Types::UpdateFileSystemAssociationOutput#file_system_association_arn #file_system_association_arn} => String
6184
+ #
6185
+ # @example Request syntax with placeholder values
6186
+ #
6187
+ # resp = client.update_file_system_association({
6188
+ # file_system_association_arn: "FileSystemAssociationARN", # required
6189
+ # user_name: "DomainUserName",
6190
+ # password: "DomainUserPassword",
6191
+ # audit_destination_arn: "AuditDestinationARN",
6192
+ # cache_attributes: {
6193
+ # cache_stale_timeout_in_seconds: 1,
6194
+ # },
6195
+ # })
6196
+ #
6197
+ # @example Response structure
6198
+ #
6199
+ # resp.file_system_association_arn #=> String
6200
+ #
6201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateFileSystemAssociation AWS API Documentation
6202
+ #
6203
+ # @overload update_file_system_association(params = {})
6204
+ # @param [Hash] params ({})
6205
+ def update_file_system_association(params = {}, options = {})
6206
+ req = build_request(:update_file_system_association, params)
6207
+ req.send_request(options)
6208
+ end
6209
+
5833
6210
  # Updates a gateway's metadata, which includes the gateway's name and
5834
6211
  # time zone. To specify which gateway to update, use the Amazon Resource
5835
6212
  # Name (ARN) of the gateway in your request.
@@ -5842,8 +6219,7 @@ module Aws::StorageGateway
5842
6219
  #
5843
6220
  # @option params [required, String] :gateway_arn
5844
6221
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5845
- # operation to return a list of gateways for your account and AWS
5846
- # Region.
6222
+ # operation to return a list of gateways for your account and Region.
5847
6223
  #
5848
6224
  # @option params [String] :gateway_name
5849
6225
  # The name you configured for your gateway.
@@ -5861,6 +6237,9 @@ module Aws::StorageGateway
5861
6237
  #
5862
6238
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html
5863
6239
  #
6240
+ # @option params [String] :gateway_capacity
6241
+ # Specifies the size of the gateway's metadata cache.
6242
+ #
5864
6243
  # @return [Types::UpdateGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5865
6244
  #
5866
6245
  # * {Types::UpdateGatewayInformationOutput#gateway_arn #gateway_arn} => String
@@ -5890,6 +6269,7 @@ module Aws::StorageGateway
5890
6269
  # gateway_name: "GatewayName",
5891
6270
  # gateway_timezone: "GatewayTimezone",
5892
6271
  # cloud_watch_log_group_arn: "CloudWatchLogGroupARN",
6272
+ # gateway_capacity: "Small", # accepts Small, Medium, Large
5893
6273
  # })
5894
6274
  #
5895
6275
  # @example Response structure
@@ -5930,8 +6310,7 @@ module Aws::StorageGateway
5930
6310
  #
5931
6311
  # @option params [required, String] :gateway_arn
5932
6312
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5933
- # operation to return a list of gateways for your account and AWS
5934
- # Region.
6313
+ # operation to return a list of gateways for your account and Region.
5935
6314
  #
5936
6315
  # @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5937
6316
  #
@@ -5976,8 +6355,7 @@ module Aws::StorageGateway
5976
6355
  #
5977
6356
  # @option params [required, String] :gateway_arn
5978
6357
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5979
- # operation to return a list of gateways for your account and AWS
5980
- # Region.
6358
+ # operation to return a list of gateways for your account and Region.
5981
6359
  #
5982
6360
  # @option params [required, Integer] :hour_of_day
5983
6361
  # The hour component of the maintenance start time represented as *hh*,
@@ -6045,7 +6423,7 @@ module Aws::StorageGateway
6045
6423
  end
6046
6424
 
6047
6425
  # Updates a Network File System (NFS) file share. This operation is only
6048
- # supported in the file gateway type.
6426
+ # supported in S3 File Gateways.
6049
6427
  #
6050
6428
  # <note markdown="1"> To leave a file share field unchanged, set the corresponding input
6051
6429
  # field to null.
@@ -6069,7 +6447,7 @@ module Aws::StorageGateway
6069
6447
  #
6070
6448
  # @option params [Boolean] :kms_encrypted
6071
6449
  # Set to `true` to use Amazon S3 server-side encryption with your own
6072
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
6450
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
6073
6451
  #
6074
6452
  # Valid Values: `true` \| `false`
6075
6453
  #
@@ -6084,7 +6462,7 @@ module Aws::StorageGateway
6084
6462
  #
6085
6463
  # @option params [String] :default_storage_class
6086
6464
  # The default storage class for objects put into an Amazon S3 bucket by
6087
- # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6465
+ # the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
6088
6466
  # Optional.
6089
6467
  #
6090
6468
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
@@ -6092,12 +6470,12 @@ module Aws::StorageGateway
6092
6470
  #
6093
6471
  # @option params [String] :object_acl
6094
6472
  # A value that sets the access control list (ACL) permission for objects
6095
- # in the S3 bucket that a file gateway puts objects into. The default
6473
+ # in the S3 bucket that a S3 File Gateway puts objects into. The default
6096
6474
  # value is `private`.
6097
6475
  #
6098
6476
  # @option params [Array<String>] :client_list
6099
- # The list of clients that are allowed to access the file gateway. The
6100
- # 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.
6101
6479
  #
6102
6480
  # @option params [String] :squash
6103
6481
  # The user mapped to anonymous user.
@@ -6147,10 +6525,30 @@ module Aws::StorageGateway
6147
6525
  # </note>
6148
6526
  #
6149
6527
  # @option params [Types::CacheAttributes] :cache_attributes
6150
- # Refresh cache information.
6528
+ # specifies refresh cache information for the file share.
6151
6529
  #
6152
6530
  # @option params [String] :notification_policy
6153
- # The notification policy of the file share.
6531
+ # The notification policy of the file share. `SettlingTimeInSeconds`
6532
+ # controls the number of seconds to wait after the last point in time a
6533
+ # client wrote to a file before generating an `ObjectUploaded`
6534
+ # notification. Because clients can make many small writes to files,
6535
+ # it's best to set this parameter for as long as possible to avoid
6536
+ # generating multiple notifications for the same file in a small time
6537
+ # period.
6538
+ #
6539
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
6540
+ # uploading to Amazon S3, only the timing of the notification.
6541
+ #
6542
+ # </note>
6543
+ #
6544
+ # The following example sets `NotificationPolicy` on with
6545
+ # `SettlingTimeInSeconds` set to 60.
6546
+ #
6547
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
6548
+ #
6549
+ # The following example sets `NotificationPolicy` off.
6550
+ #
6551
+ # `\{\}`
6154
6552
  #
6155
6553
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6156
6554
  #
@@ -6196,20 +6594,19 @@ module Aws::StorageGateway
6196
6594
  end
6197
6595
 
6198
6596
  # Updates a Server Message Block (SMB) file share. This operation is
6199
- # only supported for file gateways.
6597
+ # only supported for S3 File Gateways.
6200
6598
  #
6201
6599
  # <note markdown="1"> To leave a file share field unchanged, set the corresponding input
6202
6600
  # field to null.
6203
6601
  #
6204
6602
  # </note>
6205
6603
  #
6206
- # File gateways require AWS Security Token Service (AWS STS) to be
6207
- # activated to enable you to create a file share. Make sure that AWS STS
6208
- # is activated in the AWS Region you are creating your file gateway in.
6209
- # If AWS STS is not activated in this AWS Region, activate it. For
6210
- # information about how to activate AWS STS, see [Activating and
6211
- # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
6212
- # 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*.
6213
6610
  #
6214
6611
  # File gateways don't support creating hard or symbolic links on a
6215
6612
  # file
@@ -6225,7 +6622,7 @@ module Aws::StorageGateway
6225
6622
  #
6226
6623
  # @option params [Boolean] :kms_encrypted
6227
6624
  # Set to `true` to use Amazon S3 server-side encryption with your own
6228
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
6625
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
6229
6626
  #
6230
6627
  # Valid Values: `true` \| `false`
6231
6628
  #
@@ -6237,7 +6634,7 @@ module Aws::StorageGateway
6237
6634
  #
6238
6635
  # @option params [String] :default_storage_class
6239
6636
  # The default storage class for objects put into an Amazon S3 bucket by
6240
- # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6637
+ # the S3 File Gateway. The default value is `S3_INTELLIGENT_TIERING`.
6241
6638
  # Optional.
6242
6639
  #
6243
6640
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
@@ -6245,7 +6642,7 @@ module Aws::StorageGateway
6245
6642
  #
6246
6643
  # @option params [String] :object_acl
6247
6644
  # A value that sets the access control list (ACL) permission for objects
6248
- # in the S3 bucket that a file gateway puts objects into. The default
6645
+ # in the S3 bucket that a S3 File Gateway puts objects into. The default
6249
6646
  # value is `private`.
6250
6647
  #
6251
6648
  # @option params [Boolean] :read_only
@@ -6282,8 +6679,7 @@ module Aws::StorageGateway
6282
6679
  # permissions to the POSIX permissions.
6283
6680
  #
6284
6681
  # For more information, see [Using Microsoft Windows ACLs to control
6285
- # access to an SMB file share][1] in the *AWS Storage Gateway User
6286
- # Guide*.
6682
+ # access to an SMB file share][1] in the *Storage Gateway User Guide*.
6287
6683
  #
6288
6684
  # Valid Values: `true` \| `false`
6289
6685
  #
@@ -6317,7 +6713,7 @@ module Aws::StorageGateway
6317
6713
  # set to `ActiveDirectory`.
6318
6714
  #
6319
6715
  # @option params [String] :audit_destination_arn
6320
- # The Amazon Resource Name (ARN) of the storage used for the audit logs.
6716
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
6321
6717
  #
6322
6718
  # @option params [String] :case_sensitivity
6323
6719
  # The case of an object name in an Amazon S3 bucket. For
@@ -6334,10 +6730,42 @@ module Aws::StorageGateway
6334
6730
  # </note>
6335
6731
  #
6336
6732
  # @option params [Types::CacheAttributes] :cache_attributes
6337
- # Refresh cache information.
6733
+ # Specifies refresh cache information for the file share.
6338
6734
  #
6339
6735
  # @option params [String] :notification_policy
6340
- # The notification policy of the file share.
6736
+ # The notification policy of the file share. `SettlingTimeInSeconds`
6737
+ # controls the number of seconds to wait after the last point in time a
6738
+ # client wrote to a file before generating an `ObjectUploaded`
6739
+ # notification. Because clients can make many small writes to files,
6740
+ # it's best to set this parameter for as long as possible to avoid
6741
+ # generating multiple notifications for the same file in a small time
6742
+ # period.
6743
+ #
6744
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
6745
+ # uploading to Amazon S3, only the timing of the notification.
6746
+ #
6747
+ # </note>
6748
+ #
6749
+ # The following example sets `NotificationPolicy` on with
6750
+ # `SettlingTimeInSeconds` set to 60.
6751
+ #
6752
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
6753
+ #
6754
+ # The following example sets `NotificationPolicy` off.
6755
+ #
6756
+ # `\{\}`
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`
6341
6769
  #
6342
6770
  # @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6343
6771
  #
@@ -6356,9 +6784,9 @@ module Aws::StorageGateway
6356
6784
  # requester_pays: false,
6357
6785
  # smbacl_enabled: false,
6358
6786
  # access_based_enumeration: false,
6359
- # admin_user_list: ["FileShareUser"],
6360
- # valid_user_list: ["FileShareUser"],
6361
- # invalid_user_list: ["FileShareUser"],
6787
+ # admin_user_list: ["UserListUser"],
6788
+ # valid_user_list: ["UserListUser"],
6789
+ # invalid_user_list: ["UserListUser"],
6362
6790
  # audit_destination_arn: "AuditDestinationARN",
6363
6791
  # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
6364
6792
  # file_share_name: "FileShareName",
@@ -6366,6 +6794,7 @@ module Aws::StorageGateway
6366
6794
  # cache_stale_timeout_in_seconds: 1,
6367
6795
  # },
6368
6796
  # notification_policy: "NotificationPolicy",
6797
+ # oplocks_enabled: false,
6369
6798
  # })
6370
6799
  #
6371
6800
  # @example Response structure
@@ -6381,13 +6810,13 @@ module Aws::StorageGateway
6381
6810
  req.send_request(options)
6382
6811
  end
6383
6812
 
6384
- # Controls whether the shares on a gateway are visible in a net view or
6385
- # 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.
6386
6816
  #
6387
6817
  # @option params [required, String] :gateway_arn
6388
6818
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6389
- # operation to return a list of gateways for your account and AWS
6390
- # Region.
6819
+ # operation to return a list of gateways for your account and Region.
6391
6820
  #
6392
6821
  # @option params [required, Boolean] :file_shares_visible
6393
6822
  # The shares on this gateway appear when listing shares.
@@ -6427,8 +6856,7 @@ module Aws::StorageGateway
6427
6856
  #
6428
6857
  # @option params [required, String] :gateway_arn
6429
6858
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6430
- # operation to return a list of gateways for your account and AWS
6431
- # Region.
6859
+ # operation to return a list of gateways for your account and Region.
6432
6860
  #
6433
6861
  # @option params [required, String] :smb_security_strategy
6434
6862
  # Specifies the type of security strategy.
@@ -6436,7 +6864,7 @@ module Aws::StorageGateway
6436
6864
  # ClientSpecified: if you use this option, requests are established
6437
6865
  # based on what is negotiated by the client. This option is recommended
6438
6866
  # when you want to maximize compatibility across different clients in
6439
- # your environment.
6867
+ # your environment. Supported only in S3 File Gateway.
6440
6868
  #
6441
6869
  # MandatorySigning: if you use this option, file gateway only allows
6442
6870
  # connections from SMBv2 or SMBv3 clients that have signing enabled.
@@ -6629,7 +7057,7 @@ module Aws::StorageGateway
6629
7057
  params: params,
6630
7058
  config: config)
6631
7059
  context[:gem_name] = 'aws-sdk-storagegateway'
6632
- context[:gem_version] = '1.54.0'
7060
+ context[:gem_version] = '1.58.0'
6633
7061
  Seahorse::Client::Request.new(handlers, context)
6634
7062
  end
6635
7063