aws-sdk-storagegateway 1.58.0 → 1.62.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.
@@ -285,6 +285,15 @@ module Aws::StorageGateway
285
285
  # ** Please note ** When response stubbing is enabled, no HTTP
286
286
  # requests are made, and retries are disabled.
287
287
  #
288
+ # @option options [Boolean] :use_dualstack_endpoint
289
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
290
+ # will be used if available.
291
+ #
292
+ # @option options [Boolean] :use_fips_endpoint
293
+ # When set to `true`, fips compatible endpoints will be used if available.
294
+ # When a `fips` region is used, the region is normalized and this config
295
+ # is set to `true`.
296
+ #
288
297
  # @option options [Boolean] :validate_params (true)
289
298
  # When `true`, request parameters are validated before
290
299
  # sending the request.
@@ -338,12 +347,12 @@ module Aws::StorageGateway
338
347
  # @!group API Operations
339
348
 
340
349
  # Activates the gateway you previously deployed on your host. In the
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
- # scheduled snapshots the gateway snapshot schedule window, an
344
- # activation key, and a name for your gateway. The activation process
345
- # also associates your gateway with your account. For more information,
346
- # see UpdateGatewayInformation.
350
+ # activation process, you specify information such as the Amazon Web
351
+ # Services Region that you want to use for storing snapshots or tapes,
352
+ # the time zone for scheduled snapshots the gateway snapshot schedule
353
+ # window, an activation key, and a name for your gateway. The activation
354
+ # process also associates your gateway with your account. For more
355
+ # information, see UpdateGatewayInformation.
347
356
  #
348
357
  # <note markdown="1"> You must turn on the gateway VM before you can activate your gateway.
349
358
  #
@@ -378,12 +387,13 @@ module Aws::StorageGateway
378
387
  # schedule.
379
388
  #
380
389
  # @option params [required, String] :gateway_region
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*.
390
+ # A value that indicates the Amazon Web Services Region where you want
391
+ # to store your data. The gateway Amazon Web Services Region specified
392
+ # must be the same Amazon Web Services Region as the Amazon Web Services
393
+ # Region in your `Host` header in the request. For more information
394
+ # about available Amazon Web Services Regions and endpoints for Storage
395
+ # Gateway, see [ Storage Gateway endpoints and quotas][1] in the *Amazon
396
+ # Web Services General Reference*.
387
397
  #
388
398
  # Valid Values: See [ Storage Gateway endpoints and quotas][1] in the
389
399
  # *Amazon Web Services General Reference*.
@@ -493,7 +503,8 @@ module Aws::StorageGateway
493
503
  #
494
504
  # @option params [required, String] :gateway_arn
495
505
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
496
- # operation to return a list of gateways for your account and Region.
506
+ # operation to return a list of gateways for your account and Amazon Web
507
+ # Services Region.
497
508
  #
498
509
  # @option params [required, Array<String>] :disk_ids
499
510
  # An array of strings that identify disks that are to be configured as
@@ -637,7 +648,8 @@ module Aws::StorageGateway
637
648
  #
638
649
  # @option params [required, String] :gateway_arn
639
650
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
640
- # operation to return a list of gateways for your account and Region.
651
+ # operation to return a list of gateways for your account and Amazon Web
652
+ # Services Region.
641
653
  #
642
654
  # @option params [required, Array<String>] :disk_ids
643
655
  # An array of strings that identify disks that are to be configured as
@@ -703,7 +715,8 @@ module Aws::StorageGateway
703
715
  #
704
716
  # @option params [required, String] :gateway_arn
705
717
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
706
- # operation to return a list of gateways for your account and Region.
718
+ # operation to return a list of gateways for your account and Amazon Web
719
+ # Services Region.
707
720
  #
708
721
  # @option params [required, Array<String>] :disk_ids
709
722
  # An array of strings that identify disks that are to be configured as
@@ -828,7 +841,8 @@ module Aws::StorageGateway
828
841
  #
829
842
  # @option params [required, String] :gateway_arn
830
843
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
831
- # operation to return a list of gateways for your account and Region.
844
+ # operation to return a list of gateways for your account and Amazon Web
845
+ # Services Region.
832
846
  #
833
847
  # @option params [required, String] :location_arn
834
848
  # The Amazon Resource Name (ARN) of the Amazon FSx file system to
@@ -965,7 +979,8 @@ module Aws::StorageGateway
965
979
  #
966
980
  # @option params [required, String] :gateway_arn
967
981
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
968
- # operation to return a list of gateways for your account and Region.
982
+ # operation to return a list of gateways for your account and Amazon Web
983
+ # Services Region.
969
984
  #
970
985
  # @option params [required, String] :tape_arn
971
986
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -1017,7 +1032,8 @@ module Aws::StorageGateway
1017
1032
  #
1018
1033
  # @option params [required, String] :gateway_arn
1019
1034
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1020
- # operation to return a list of gateways for your account and Region.
1035
+ # operation to return a list of gateways for your account and Amazon Web
1036
+ # Services Region.
1021
1037
  #
1022
1038
  # @option params [required, String] :tape_arn
1023
1039
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -1087,7 +1103,8 @@ module Aws::StorageGateway
1087
1103
  #
1088
1104
  # @option params [required, String] :gateway_arn
1089
1105
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1090
- # operation to return a list of gateways for your account and Region.
1106
+ # operation to return a list of gateways for your account and Amazon Web
1107
+ # Services Region.
1091
1108
  #
1092
1109
  # @option params [required, Integer] :volume_size_in_bytes
1093
1110
  # The size of the volume in bytes.
@@ -1221,12 +1238,15 @@ module Aws::StorageGateway
1221
1238
  # using an NFS interface. This operation is only supported for S3 File
1222
1239
  # Gateways.
1223
1240
  #
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*.
1241
+ # S3 File gateway requires Security Token Service (Amazon Web Services
1242
+ # STS) to be activated to enable you to create a file share. Make sure
1243
+ # Amazon Web Services STS is activated in the Amazon Web Services Region
1244
+ # you are creating your S3 File Gateway in. If Amazon Web Services STS
1245
+ # is not activated in the Amazon Web Services Region, activate it. For
1246
+ # information about how to activate Amazon Web Services STS, see
1247
+ # [Activating and deactivating Amazon Web Services STS in an Amazon Web
1248
+ # Services Region][1] in the *Identity and Access Management User
1249
+ # Guide*.
1230
1250
  #
1231
1251
  # S3 File Gateways do not support creating hard or symbolic links on a
1232
1252
  # file share.
@@ -1263,18 +1283,29 @@ module Aws::StorageGateway
1263
1283
  # File Gateway assumes when it accesses the underlying storage.
1264
1284
  #
1265
1285
  # @option params [required, String] :location_arn
1266
- # The ARN of the backend storage used for storing file data. A prefix
1267
- # name can be added to the S3 bucket name. It must end with a "/".
1286
+ # A custom ARN for the backend storage used for storing data for file
1287
+ # shares. It includes a resource ARN with an optional prefix
1288
+ # concatenation. The prefix must end with a forward slash (/).
1289
+ #
1290
+ # <note markdown="1"> You can specify LocationARN as a bucket ARN, access point ARN or
1291
+ # access point alias, as shown in the following examples.
1292
+ #
1293
+ # Bucket ARN:
1294
+ #
1295
+ # `arn:aws:s3:::my-bucket/prefix/`
1268
1296
  #
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:
1297
+ # Access point ARN:
1271
1298
  #
1272
- # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1299
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`
1273
1300
  #
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*.
1301
+ # If you specify an access point, the bucket policy must be configured
1302
+ # to delegate access control to the access point. For information, see
1303
+ # [Delegating access control to access points][1] in the *Amazon S3 User
1304
+ # Guide*.
1305
+ #
1306
+ # Access point alias:
1307
+ #
1308
+ # `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias`
1278
1309
  #
1279
1310
  # </note>
1280
1311
  #
@@ -1353,7 +1384,7 @@ module Aws::StorageGateway
1353
1384
  # The name of the file share. Optional.
1354
1385
  #
1355
1386
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1356
- # `LocationARN`.
1387
+ # `LocationARN`, or if an access point or access point alias is used.
1357
1388
  #
1358
1389
  # </note>
1359
1390
  #
@@ -1403,6 +1434,9 @@ module Aws::StorageGateway
1403
1434
  #
1404
1435
  # </note>
1405
1436
  #
1437
+ # @option params [String] :audit_destination_arn
1438
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
1439
+ #
1406
1440
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1407
1441
  #
1408
1442
  # * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1442,6 +1476,7 @@ module Aws::StorageGateway
1442
1476
  # notification_policy: "NotificationPolicy",
1443
1477
  # vpc_endpoint_dns_name: "DNSHostName",
1444
1478
  # bucket_region: "RegionId",
1479
+ # audit_destination_arn: "AuditDestinationARN",
1445
1480
  # })
1446
1481
  #
1447
1482
  # @example Response structure
@@ -1463,12 +1498,15 @@ module Aws::StorageGateway
1463
1498
  # using an SMB interface. This operation is only supported for S3 File
1464
1499
  # Gateways.
1465
1500
  #
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*.
1501
+ # S3 File Gateways require Security Token Service (Amazon Web Services
1502
+ # STS) to be activated to enable you to create a file share. Make sure
1503
+ # that Amazon Web Services STS is activated in the Amazon Web Services
1504
+ # Region you are creating your S3 File Gateway in. If Amazon Web
1505
+ # Services STS is not activated in this Amazon Web Services Region,
1506
+ # activate it. For information about how to activate Amazon Web Services
1507
+ # STS, see [Activating and deactivating Amazon Web Services STS in an
1508
+ # Amazon Web Services Region][1] in the *Identity and Access Management
1509
+ # User Guide*.
1472
1510
  #
1473
1511
  # File gateways don't support creating hard or symbolic links on a
1474
1512
  # file
@@ -1503,18 +1541,29 @@ module Aws::StorageGateway
1503
1541
  # File Gateway assumes when it accesses the underlying storage.
1504
1542
  #
1505
1543
  # @option params [required, String] :location_arn
1506
- # The ARN of the backend storage used for storing file data. A prefix
1507
- # name can be added to the S3 bucket name. It must end with a "/".
1544
+ # A custom ARN for the backend storage used for storing data for file
1545
+ # shares. It includes a resource ARN with an optional prefix
1546
+ # concatenation. The prefix must end with a forward slash (/).
1547
+ #
1548
+ # <note markdown="1"> You can specify LocationARN as a bucket ARN, access point ARN or
1549
+ # access point alias, as shown in the following examples.
1550
+ #
1551
+ # Bucket ARN:
1552
+ #
1553
+ # `arn:aws:s3:::my-bucket/prefix/`
1554
+ #
1555
+ # Access point ARN:
1556
+ #
1557
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`
1508
1558
  #
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:
1559
+ # If you specify an access point, the bucket policy must be configured
1560
+ # to delegate access control to the access point. For information, see
1561
+ # [Delegating access control to access points][1] in the *Amazon S3 User
1562
+ # Guide*.
1511
1563
  #
1512
- # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1564
+ # Access point alias:
1513
1565
  #
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*.
1566
+ # `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias`
1518
1567
  #
1519
1568
  # </note>
1520
1569
  #
@@ -1634,7 +1683,7 @@ module Aws::StorageGateway
1634
1683
  # The name of the file share. Optional.
1635
1684
  #
1636
1685
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1637
- # `LocationARN`.
1686
+ # `LocationARN`, or if an access point or access point alias is used.
1638
1687
  #
1639
1688
  # </note>
1640
1689
  #
@@ -1973,7 +2022,8 @@ module Aws::StorageGateway
1973
2022
  #
1974
2023
  # @option params [required, String] :gateway_arn
1975
2024
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1976
- # operation to return a list of gateways for your account and Region.
2025
+ # operation to return a list of gateways for your account and Amazon Web
2026
+ # Services Region.
1977
2027
  #
1978
2028
  # @option params [required, String] :disk_id
1979
2029
  # The unique identifier for the gateway local disk that is configured as
@@ -2117,10 +2167,11 @@ module Aws::StorageGateway
2117
2167
  #
2118
2168
  # @option params [String] :retention_lock_type
2119
2169
  # Tape retention lock can be configured in two modes. When configured in
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.
2170
+ # governance mode, Amazon Web Services accounts with specific IAM
2171
+ # permissions are authorized to remove the tape retention lock from
2172
+ # archived virtual tapes. When configured in compliance mode, the tape
2173
+ # retention lock cannot be removed by any user, including the root
2174
+ # Amazon Web Services account.
2124
2175
  #
2125
2176
  # @option params [Integer] :retention_lock_time_in_days
2126
2177
  # Tape retention lock time is set in days. Tape retention lock can be
@@ -2184,7 +2235,8 @@ module Aws::StorageGateway
2184
2235
  # @option params [required, String] :gateway_arn
2185
2236
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2186
2237
  # associate the virtual tape with. Use the ListGateways operation to
2187
- # return a list of gateways for your account and Region.
2238
+ # return a list of gateways for your account and Amazon Web Services
2239
+ # Region.
2188
2240
  #
2189
2241
  # @option params [required, Integer] :tape_size_in_bytes
2190
2242
  # The size, in bytes, of the virtual tape that you want to create.
@@ -2301,7 +2353,8 @@ module Aws::StorageGateway
2301
2353
  # @option params [required, String] :gateway_arn
2302
2354
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2303
2355
  # associate the virtual tapes with. Use the ListGateways operation to
2304
- # return a list of gateways for your account and Region.
2356
+ # return a list of gateways for your account and Amazon Web Services
2357
+ # Region.
2305
2358
  #
2306
2359
  # @option params [required, Integer] :tape_size_in_bytes
2307
2360
  # The size, in bytes, of the virtual tapes that you want to create.
@@ -2435,7 +2488,8 @@ module Aws::StorageGateway
2435
2488
  #
2436
2489
  # @option params [required, String] :gateway_arn
2437
2490
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2438
- # operation to return a list of gateways for your account and Region.
2491
+ # operation to return a list of gateways for your account and Amazon Web
2492
+ # Services Region.
2439
2493
  #
2440
2494
  # @return [Types::DeleteAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2441
2495
  #
@@ -2469,7 +2523,8 @@ module Aws::StorageGateway
2469
2523
  #
2470
2524
  # @option params [required, String] :gateway_arn
2471
2525
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2472
- # operation to return a list of gateways for your account and Region.
2526
+ # operation to return a list of gateways for your account and Amazon Web
2527
+ # Services Region.
2473
2528
  #
2474
2529
  # @option params [required, String] :bandwidth_type
2475
2530
  # One of the BandwidthType values that indicates the gateway bandwidth
@@ -2635,7 +2690,8 @@ module Aws::StorageGateway
2635
2690
  #
2636
2691
  # @option params [required, String] :gateway_arn
2637
2692
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2638
- # operation to return a list of gateways for your account and Region.
2693
+ # operation to return a list of gateways for your account and Amazon Web
2694
+ # Services Region.
2639
2695
  #
2640
2696
  # @return [Types::DeleteGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2641
2697
  #
@@ -2740,7 +2796,8 @@ module Aws::StorageGateway
2740
2796
  # @option params [required, String] :gateway_arn
2741
2797
  # The unique Amazon Resource Name (ARN) of the gateway that the virtual
2742
2798
  # tape to delete is associated with. Use the ListGateways operation to
2743
- # return a list of gateways for your account and Region.
2799
+ # return a list of gateways for your account and Amazon Web Services
2800
+ # Region.
2744
2801
  #
2745
2802
  # @option params [required, String] :tape_arn
2746
2803
  # The Amazon Resource Name (ARN) of the virtual tape to delete.
@@ -2942,7 +2999,8 @@ module Aws::StorageGateway
2942
2999
  #
2943
3000
  # @option params [required, String] :gateway_arn
2944
3001
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2945
- # operation to return a list of gateways for your account and Region.
3002
+ # operation to return a list of gateways for your account and Amazon Web
3003
+ # Services Region.
2946
3004
  #
2947
3005
  # @return [Types::DescribeAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2948
3006
  #
@@ -2984,7 +3042,8 @@ module Aws::StorageGateway
2984
3042
  #
2985
3043
  # @option params [required, String] :gateway_arn
2986
3044
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2987
- # operation to return a list of gateways for your account and Region.
3045
+ # operation to return a list of gateways for your account and Amazon Web
3046
+ # Services Region.
2988
3047
  #
2989
3048
  # @return [Types::DescribeBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2990
3049
  #
@@ -3052,7 +3111,8 @@ module Aws::StorageGateway
3052
3111
  #
3053
3112
  # @option params [required, String] :gateway_arn
3054
3113
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3055
- # operation to return a list of gateways for your account and Region.
3114
+ # operation to return a list of gateways for your account and Amazon Web
3115
+ # Services Region.
3056
3116
  #
3057
3117
  # @return [Types::DescribeBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3058
3118
  #
@@ -3095,7 +3155,8 @@ module Aws::StorageGateway
3095
3155
  #
3096
3156
  # @option params [required, String] :gateway_arn
3097
3157
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3098
- # operation to return a list of gateways for your account and Region.
3158
+ # operation to return a list of gateways for your account and Amazon Web
3159
+ # Services Region.
3099
3160
  #
3100
3161
  # @return [Types::DescribeCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3101
3162
  #
@@ -3330,6 +3391,8 @@ module Aws::StorageGateway
3330
3391
  # resp.file_system_association_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3331
3392
  # resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses #=> Array
3332
3393
  # resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses[0] #=> String
3394
+ # resp.file_system_association_info_list[0].file_system_association_status_details #=> Array
3395
+ # resp.file_system_association_info_list[0].file_system_association_status_details[0].error_code #=> String
3333
3396
  #
3334
3397
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociations AWS API Documentation
3335
3398
  #
@@ -3347,7 +3410,8 @@ module Aws::StorageGateway
3347
3410
  #
3348
3411
  # @option params [required, String] :gateway_arn
3349
3412
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3350
- # operation to return a list of gateways for your account and Region.
3413
+ # operation to return a list of gateways for your account and Amazon Web
3414
+ # Services Region.
3351
3415
  #
3352
3416
  # @return [Types::DescribeGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3353
3417
  #
@@ -3449,7 +3513,8 @@ module Aws::StorageGateway
3449
3513
  #
3450
3514
  # @option params [required, String] :gateway_arn
3451
3515
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3452
- # operation to return a list of gateways for your account and Region.
3516
+ # operation to return a list of gateways for your account and Amazon Web
3517
+ # Services Region.
3453
3518
  #
3454
3519
  # @return [Types::DescribeMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3455
3520
  #
@@ -3552,6 +3617,7 @@ module Aws::StorageGateway
3552
3617
  # resp.nfs_file_share_info_list[0].notification_policy #=> String
3553
3618
  # resp.nfs_file_share_info_list[0].vpc_endpoint_dns_name #=> String
3554
3619
  # resp.nfs_file_share_info_list[0].bucket_region #=> String
3620
+ # resp.nfs_file_share_info_list[0].audit_destination_arn #=> String
3555
3621
  #
3556
3622
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
3557
3623
  #
@@ -3633,7 +3699,8 @@ module Aws::StorageGateway
3633
3699
  #
3634
3700
  # @option params [required, String] :gateway_arn
3635
3701
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3636
- # operation to return a list of gateways for your account and Region.
3702
+ # operation to return a list of gateways for your account and Amazon Web
3703
+ # Services Region.
3637
3704
  #
3638
3705
  # @return [Types::DescribeSMBSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3639
3706
  #
@@ -3643,6 +3710,7 @@ module Aws::StorageGateway
3643
3710
  # * {Types::DescribeSMBSettingsOutput#smb_guest_password_set #smb_guest_password_set} => Boolean
3644
3711
  # * {Types::DescribeSMBSettingsOutput#smb_security_strategy #smb_security_strategy} => String
3645
3712
  # * {Types::DescribeSMBSettingsOutput#file_shares_visible #file_shares_visible} => Boolean
3713
+ # * {Types::DescribeSMBSettingsOutput#smb_local_groups #smb_local_groups} => Types::SMBLocalGroups
3646
3714
  #
3647
3715
  # @example Request syntax with placeholder values
3648
3716
  #
@@ -3658,6 +3726,8 @@ module Aws::StorageGateway
3658
3726
  # resp.smb_guest_password_set #=> Boolean
3659
3727
  # resp.smb_security_strategy #=> String, one of "ClientSpecified", "MandatorySigning", "MandatoryEncryption"
3660
3728
  # resp.file_shares_visible #=> Boolean
3729
+ # resp.smb_local_groups.gateway_admins #=> Array
3730
+ # resp.smb_local_groups.gateway_admins[0] #=> String
3661
3731
  #
3662
3732
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettings AWS API Documentation
3663
3733
  #
@@ -3925,7 +3995,8 @@ module Aws::StorageGateway
3925
3995
  #
3926
3996
  # @option params [required, String] :gateway_arn
3927
3997
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3928
- # operation to return a list of gateways for your account and Region.
3998
+ # operation to return a list of gateways for your account and Amazon Web
3999
+ # Services Region.
3929
4000
  #
3930
4001
  # @option params [String] :marker
3931
4002
  # An opaque string that indicates the position at which to begin
@@ -4002,7 +4073,8 @@ module Aws::StorageGateway
4002
4073
  #
4003
4074
  # @option params [required, String] :gateway_arn
4004
4075
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4005
- # operation to return a list of gateways for your account and Region.
4076
+ # operation to return a list of gateways for your account and Amazon Web
4077
+ # Services Region.
4006
4078
  #
4007
4079
  # @option params [Array<String>] :tape_arns
4008
4080
  # Specifies one or more unique Amazon Resource Names (ARNs) that
@@ -4113,7 +4185,8 @@ module Aws::StorageGateway
4113
4185
  #
4114
4186
  # @option params [required, String] :gateway_arn
4115
4187
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4116
- # operation to return a list of gateways for your account and Region.
4188
+ # operation to return a list of gateways for your account and Amazon Web
4189
+ # Services Region.
4117
4190
  #
4118
4191
  # @return [Types::DescribeUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4119
4192
  #
@@ -4194,7 +4267,8 @@ module Aws::StorageGateway
4194
4267
  #
4195
4268
  # @option params [required, String] :gateway_arn
4196
4269
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4197
- # operation to return a list of gateways for your account and Region.
4270
+ # operation to return a list of gateways for your account and Amazon Web
4271
+ # Services Region.
4198
4272
  #
4199
4273
  # @option params [Array<String>] :vtl_device_arns
4200
4274
  # An array of strings, where each string represents the Amazon Resource
@@ -4327,7 +4401,8 @@ module Aws::StorageGateway
4327
4401
  #
4328
4402
  # @option params [required, String] :gateway_arn
4329
4403
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4330
- # operation to return a list of gateways for your account and Region.
4404
+ # operation to return a list of gateways for your account and Amazon Web
4405
+ # Services Region.
4331
4406
  #
4332
4407
  # @return [Types::DescribeWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4333
4408
  #
@@ -4436,7 +4511,8 @@ module Aws::StorageGateway
4436
4511
  #
4437
4512
  # @option params [required, String] :gateway_arn
4438
4513
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4439
- # operation to return a list of gateways for your account and Region.
4514
+ # operation to return a list of gateways for your account and Amazon Web
4515
+ # Services Region.
4440
4516
  #
4441
4517
  # @return [Types::DisableGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4442
4518
  #
@@ -4521,7 +4597,8 @@ module Aws::StorageGateway
4521
4597
  #
4522
4598
  # @option params [required, String] :gateway_arn
4523
4599
  # The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways`
4524
- # operation to return a list of gateways for your account and Region.
4600
+ # operation to return a list of gateways for your account and Amazon Web
4601
+ # Services Region.
4525
4602
  #
4526
4603
  # @option params [required, String] :domain_name
4527
4604
  # The name of the domain that you want the gateway to join.
@@ -4591,7 +4668,8 @@ module Aws::StorageGateway
4591
4668
  #
4592
4669
  # @option params [String] :gateway_arn
4593
4670
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4594
- # operation to return a list of gateways for your account and Region.
4671
+ # operation to return a list of gateways for your account and Amazon Web
4672
+ # Services Region.
4595
4673
  #
4596
4674
  # @return [Types::ListAutomaticTapeCreationPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4597
4675
  #
@@ -4683,7 +4761,8 @@ module Aws::StorageGateway
4683
4761
  #
4684
4762
  # @option params [String] :gateway_arn
4685
4763
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4686
- # operation to return a list of gateways for your account and Region.
4764
+ # operation to return a list of gateways for your account and Amazon Web
4765
+ # Services Region.
4687
4766
  #
4688
4767
  # @option params [Integer] :limit
4689
4768
  # The maximum number of file system associations to return in the
@@ -4731,9 +4810,9 @@ module Aws::StorageGateway
4731
4810
  req.send_request(options)
4732
4811
  end
4733
4812
 
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).
4813
+ # Lists gateways owned by an Amazon Web Services account in an Amazon
4814
+ # Web Services Region specified in the request. The returned list is
4815
+ # ordered by gateway Amazon Resource Name (ARN).
4737
4816
  #
4738
4817
  # By default, the operation returns a maximum of 100 gateways. This
4739
4818
  # operation supports pagination that allows you to optionally reduce the
@@ -4825,7 +4904,8 @@ module Aws::StorageGateway
4825
4904
  #
4826
4905
  # @option params [required, String] :gateway_arn
4827
4906
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4828
- # operation to return a list of gateways for your account and Region.
4907
+ # operation to return a list of gateways for your account and Amazon Web
4908
+ # Services Region.
4829
4909
  #
4830
4910
  # @return [Types::ListLocalDisksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4831
4911
  #
@@ -5133,7 +5213,8 @@ module Aws::StorageGateway
5133
5213
  #
5134
5214
  # @option params [required, String] :gateway_arn
5135
5215
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5136
- # operation to return a list of gateways for your account and Region.
5216
+ # operation to return a list of gateways for your account and Amazon Web
5217
+ # Services Region.
5137
5218
  #
5138
5219
  # @return [Types::ListVolumeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5139
5220
  #
@@ -5202,7 +5283,8 @@ module Aws::StorageGateway
5202
5283
  #
5203
5284
  # @option params [String] :gateway_arn
5204
5285
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5205
- # operation to return a list of gateways for your account and Region.
5286
+ # operation to return a list of gateways for your account and Amazon Web
5287
+ # Services Region.
5206
5288
  #
5207
5289
  # @option params [String] :marker
5208
5290
  # A string that indicates the position at which to begin the returned
@@ -5493,7 +5575,8 @@ module Aws::StorageGateway
5493
5575
  #
5494
5576
  # @option params [required, String] :gateway_arn
5495
5577
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5496
- # operation to return a list of gateways for your account and Region.
5578
+ # operation to return a list of gateways for your account and Amazon Web
5579
+ # Services Region.
5497
5580
  #
5498
5581
  # @return [Types::ResetCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5499
5582
  #
@@ -5551,7 +5634,7 @@ module Aws::StorageGateway
5551
5634
  # @option params [required, String] :gateway_arn
5552
5635
  # The Amazon Resource Name (ARN) of the gateway you want to retrieve the
5553
5636
  # virtual tape to. Use the ListGateways operation to return a list of
5554
- # gateways for your account and Region.
5637
+ # gateways for your account and Amazon Web Services Region.
5555
5638
  #
5556
5639
  # You retrieve archived virtual tapes to only one gateway and the
5557
5640
  # gateway must be a tape gateway.
@@ -5616,7 +5699,8 @@ module Aws::StorageGateway
5616
5699
  #
5617
5700
  # @option params [required, String] :gateway_arn
5618
5701
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5619
- # operation to return a list of gateways for your account and Region.
5702
+ # operation to return a list of gateways for your account and Amazon Web
5703
+ # Services Region.
5620
5704
  #
5621
5705
  # @return [Types::RetrieveTapeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5622
5706
  #
@@ -5664,7 +5748,8 @@ module Aws::StorageGateway
5664
5748
  #
5665
5749
  # @option params [required, String] :gateway_arn
5666
5750
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5667
- # operation to return a list of gateways for your account and Region.
5751
+ # operation to return a list of gateways for your account and Amazon Web
5752
+ # Services Region.
5668
5753
  #
5669
5754
  # @option params [required, String] :local_console_password
5670
5755
  # The password you want to set for your VM local console.
@@ -5774,7 +5859,8 @@ module Aws::StorageGateway
5774
5859
  #
5775
5860
  # @option params [required, String] :gateway_arn
5776
5861
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5777
- # operation to return a list of gateways for your account and Region.
5862
+ # operation to return a list of gateways for your account and Amazon Web
5863
+ # Services Region.
5778
5864
  #
5779
5865
  # @return [Types::ShutdownGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5780
5866
  #
@@ -5828,7 +5914,8 @@ module Aws::StorageGateway
5828
5914
  #
5829
5915
  # @option params [required, String] :gateway_arn
5830
5916
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5831
- # operation to return a list of gateways for your account and Region.
5917
+ # operation to return a list of gateways for your account and Amazon Web
5918
+ # Services Region.
5832
5919
  #
5833
5920
  # @return [Types::StartAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5834
5921
  #
@@ -5871,7 +5958,8 @@ module Aws::StorageGateway
5871
5958
  #
5872
5959
  # @option params [required, String] :gateway_arn
5873
5960
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5874
- # operation to return a list of gateways for your account and Region.
5961
+ # operation to return a list of gateways for your account and Amazon Web
5962
+ # Services Region.
5875
5963
  #
5876
5964
  # @return [Types::StartGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5877
5965
  #
@@ -5927,7 +6015,8 @@ module Aws::StorageGateway
5927
6015
  #
5928
6016
  # @option params [required, String] :gateway_arn
5929
6017
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5930
- # operation to return a list of gateways for your account and Region.
6018
+ # operation to return a list of gateways for your account and Amazon Web
6019
+ # Services Region.
5931
6020
  #
5932
6021
  # @return [Types::UpdateAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5933
6022
  #
@@ -5977,7 +6066,8 @@ module Aws::StorageGateway
5977
6066
  #
5978
6067
  # @option params [required, String] :gateway_arn
5979
6068
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5980
- # operation to return a list of gateways for your account and Region.
6069
+ # operation to return a list of gateways for your account and Amazon Web
6070
+ # Services Region.
5981
6071
  #
5982
6072
  # @option params [Integer] :average_upload_rate_limit_in_bits_per_sec
5983
6073
  # The average upload bandwidth rate limit in bits per second.
@@ -6035,7 +6125,8 @@ module Aws::StorageGateway
6035
6125
  #
6036
6126
  # @option params [required, String] :gateway_arn
6037
6127
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6038
- # operation to return a list of gateways for your account and Region.
6128
+ # operation to return a list of gateways for your account and Amazon Web
6129
+ # Services Region.
6039
6130
  #
6040
6131
  # @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
6041
6132
  # An array containing bandwidth rate limit schedule intervals for a
@@ -6219,7 +6310,8 @@ module Aws::StorageGateway
6219
6310
  #
6220
6311
  # @option params [required, String] :gateway_arn
6221
6312
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6222
- # operation to return a list of gateways for your account and Region.
6313
+ # operation to return a list of gateways for your account and Amazon Web
6314
+ # Services Region.
6223
6315
  #
6224
6316
  # @option params [String] :gateway_name
6225
6317
  # The name you configured for your gateway.
@@ -6310,7 +6402,8 @@ module Aws::StorageGateway
6310
6402
  #
6311
6403
  # @option params [required, String] :gateway_arn
6312
6404
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6313
- # operation to return a list of gateways for your account and Region.
6405
+ # operation to return a list of gateways for your account and Amazon Web
6406
+ # Services Region.
6314
6407
  #
6315
6408
  # @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6316
6409
  #
@@ -6355,7 +6448,8 @@ module Aws::StorageGateway
6355
6448
  #
6356
6449
  # @option params [required, String] :gateway_arn
6357
6450
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6358
- # operation to return a list of gateways for your account and Region.
6451
+ # operation to return a list of gateways for your account and Amazon Web
6452
+ # Services Region.
6359
6453
  #
6360
6454
  # @option params [required, Integer] :hour_of_day
6361
6455
  # The hour component of the maintenance start time represented as *hh*,
@@ -6520,12 +6614,12 @@ module Aws::StorageGateway
6520
6614
  # The name of the file share. Optional.
6521
6615
  #
6522
6616
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6523
- # `LocationARN`.
6617
+ # `LocationARN`, or if an access point or access point alias is used.
6524
6618
  #
6525
6619
  # </note>
6526
6620
  #
6527
6621
  # @option params [Types::CacheAttributes] :cache_attributes
6528
- # specifies refresh cache information for the file share.
6622
+ # Specifies refresh cache information for the file share.
6529
6623
  #
6530
6624
  # @option params [String] :notification_policy
6531
6625
  # The notification policy of the file share. `SettlingTimeInSeconds`
@@ -6550,6 +6644,9 @@ module Aws::StorageGateway
6550
6644
  #
6551
6645
  # `\{\}`
6552
6646
  #
6647
+ # @option params [String] :audit_destination_arn
6648
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
6649
+ #
6553
6650
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6554
6651
  #
6555
6652
  # * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -6578,6 +6675,7 @@ module Aws::StorageGateway
6578
6675
  # cache_stale_timeout_in_seconds: 1,
6579
6676
  # },
6580
6677
  # notification_policy: "NotificationPolicy",
6678
+ # audit_destination_arn: "AuditDestinationARN",
6581
6679
  # })
6582
6680
  #
6583
6681
  # @example Response structure
@@ -6601,12 +6699,15 @@ module Aws::StorageGateway
6601
6699
  #
6602
6700
  # </note>
6603
6701
  #
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*.
6702
+ # File gateways require Security Token Service (Amazon Web Services STS)
6703
+ # to be activated to enable you to create a file share. Make sure that
6704
+ # Amazon Web Services STS is activated in the Amazon Web Services Region
6705
+ # you are creating your file gateway in. If Amazon Web Services STS is
6706
+ # not activated in this Amazon Web Services Region, activate it. For
6707
+ # information about how to activate Amazon Web Services STS, see
6708
+ # [Activating and deactivating Amazon Web Services STS in an Amazon Web
6709
+ # Services Region][1] in the *Identity and Access Management User
6710
+ # Guide*.
6610
6711
  #
6611
6712
  # File gateways don't support creating hard or symbolic links on a
6612
6713
  # file
@@ -6725,7 +6826,7 @@ module Aws::StorageGateway
6725
6826
  # The name of the file share. Optional.
6726
6827
  #
6727
6828
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6728
- # `LocationARN`.
6829
+ # `LocationARN`, or if an access point or access point alias is used.
6729
6830
  #
6730
6831
  # </note>
6731
6832
  #
@@ -6816,7 +6917,8 @@ module Aws::StorageGateway
6816
6917
  #
6817
6918
  # @option params [required, String] :gateway_arn
6818
6919
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6819
- # operation to return a list of gateways for your account and Region.
6920
+ # operation to return a list of gateways for your account and Amazon Web
6921
+ # Services Region.
6820
6922
  #
6821
6923
  # @option params [required, Boolean] :file_shares_visible
6822
6924
  # The shares on this gateway appear when listing shares.
@@ -6845,6 +6947,44 @@ module Aws::StorageGateway
6845
6947
  req.send_request(options)
6846
6948
  end
6847
6949
 
6950
+ # Updates the list of Active Directory users and groups that have
6951
+ # special permissions for SMB file shares on the gateway.
6952
+ #
6953
+ # @option params [required, String] :gateway_arn
6954
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6955
+ # operation to return a list of gateways for your account and Amazon Web
6956
+ # Services Region.
6957
+ #
6958
+ # @option params [required, Types::SMBLocalGroups] :smb_local_groups
6959
+ # A list of Active Directory users and groups that you want to grant
6960
+ # special permissions for SMB file shares on the gateway.
6961
+ #
6962
+ # @return [Types::UpdateSMBLocalGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6963
+ #
6964
+ # * {Types::UpdateSMBLocalGroupsOutput#gateway_arn #gateway_arn} => String
6965
+ #
6966
+ # @example Request syntax with placeholder values
6967
+ #
6968
+ # resp = client.update_smb_local_groups({
6969
+ # gateway_arn: "GatewayARN", # required
6970
+ # smb_local_groups: { # required
6971
+ # gateway_admins: ["UserListUser"],
6972
+ # },
6973
+ # })
6974
+ #
6975
+ # @example Response structure
6976
+ #
6977
+ # resp.gateway_arn #=> String
6978
+ #
6979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBLocalGroups AWS API Documentation
6980
+ #
6981
+ # @overload update_smb_local_groups(params = {})
6982
+ # @param [Hash] params ({})
6983
+ def update_smb_local_groups(params = {}, options = {})
6984
+ req = build_request(:update_smb_local_groups, params)
6985
+ req.send_request(options)
6986
+ end
6987
+
6848
6988
  # Updates the SMB security strategy on a file gateway. This action is
6849
6989
  # only supported in file gateways.
6850
6990
  #
@@ -6856,7 +6996,8 @@ module Aws::StorageGateway
6856
6996
  #
6857
6997
  # @option params [required, String] :gateway_arn
6858
6998
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6859
- # operation to return a list of gateways for your account and Region.
6999
+ # operation to return a list of gateways for your account and Amazon Web
7000
+ # Services Region.
6860
7001
  #
6861
7002
  # @option params [required, String] :smb_security_strategy
6862
7003
  # Specifies the type of security strategy.
@@ -7057,7 +7198,7 @@ module Aws::StorageGateway
7057
7198
  params: params,
7058
7199
  config: config)
7059
7200
  context[:gem_name] = 'aws-sdk-storagegateway'
7060
- context[:gem_version] = '1.58.0'
7201
+ context[:gem_version] = '1.62.0'
7061
7202
  Seahorse::Client::Request.new(handlers, context)
7062
7203
  end
7063
7204