aws-sdk-storagegateway 1.56.0 → 1.60.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.
@@ -338,12 +338,12 @@ 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 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.
341
+ # activation process, you specify information such as the Amazon Web
342
+ # Services Region that you want to use for storing snapshots or tapes,
343
+ # the time zone for scheduled snapshots the gateway snapshot schedule
344
+ # window, an activation key, and a name for your gateway. The activation
345
+ # process also associates your gateway with your account. For more
346
+ # information, see UpdateGatewayInformation.
347
347
  #
348
348
  # <note markdown="1"> You must turn on the gateway VM before you can activate your gateway.
349
349
  #
@@ -378,12 +378,13 @@ module Aws::StorageGateway
378
378
  # schedule.
379
379
  #
380
380
  # @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*.
381
+ # A value that indicates the Amazon Web Services Region where you want
382
+ # to store your data. The gateway Amazon Web Services Region specified
383
+ # must be the same Amazon Web Services Region as the Amazon Web Services
384
+ # Region in your `Host` header in the request. For more information
385
+ # about available Amazon Web Services Regions and endpoints for Storage
386
+ # Gateway, see [ Storage Gateway endpoints and quotas][1] in the *Amazon
387
+ # Web Services General Reference*.
387
388
  #
388
389
  # Valid Values: See [ Storage Gateway endpoints and quotas][1] in the
389
390
  # *Amazon Web Services General Reference*.
@@ -493,7 +494,8 @@ module Aws::StorageGateway
493
494
  #
494
495
  # @option params [required, String] :gateway_arn
495
496
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
496
- # operation to return a list of gateways for your account and Region.
497
+ # operation to return a list of gateways for your account and Amazon Web
498
+ # Services Region.
497
499
  #
498
500
  # @option params [required, Array<String>] :disk_ids
499
501
  # An array of strings that identify disks that are to be configured as
@@ -637,7 +639,8 @@ module Aws::StorageGateway
637
639
  #
638
640
  # @option params [required, String] :gateway_arn
639
641
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
640
- # operation to return a list of gateways for your account and Region.
642
+ # operation to return a list of gateways for your account and Amazon Web
643
+ # Services Region.
641
644
  #
642
645
  # @option params [required, Array<String>] :disk_ids
643
646
  # An array of strings that identify disks that are to be configured as
@@ -703,7 +706,8 @@ module Aws::StorageGateway
703
706
  #
704
707
  # @option params [required, String] :gateway_arn
705
708
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
706
- # operation to return a list of gateways for your account and Region.
709
+ # operation to return a list of gateways for your account and Amazon Web
710
+ # Services Region.
707
711
  #
708
712
  # @option params [required, Array<String>] :disk_ids
709
713
  # An array of strings that identify disks that are to be configured as
@@ -828,7 +832,8 @@ module Aws::StorageGateway
828
832
  #
829
833
  # @option params [required, String] :gateway_arn
830
834
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
831
- # operation to return a list of gateways for your account and Region.
835
+ # operation to return a list of gateways for your account and Amazon Web
836
+ # Services Region.
832
837
  #
833
838
  # @option params [required, String] :location_arn
834
839
  # The Amazon Resource Name (ARN) of the Amazon FSx file system to
@@ -965,7 +970,8 @@ module Aws::StorageGateway
965
970
  #
966
971
  # @option params [required, String] :gateway_arn
967
972
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
968
- # operation to return a list of gateways for your account and Region.
973
+ # operation to return a list of gateways for your account and Amazon Web
974
+ # Services Region.
969
975
  #
970
976
  # @option params [required, String] :tape_arn
971
977
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -1017,7 +1023,8 @@ module Aws::StorageGateway
1017
1023
  #
1018
1024
  # @option params [required, String] :gateway_arn
1019
1025
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1020
- # operation to return a list of gateways for your account and Region.
1026
+ # operation to return a list of gateways for your account and Amazon Web
1027
+ # Services Region.
1021
1028
  #
1022
1029
  # @option params [required, String] :tape_arn
1023
1030
  # The Amazon Resource Name (ARN) of the virtual tape you want to cancel
@@ -1087,7 +1094,8 @@ module Aws::StorageGateway
1087
1094
  #
1088
1095
  # @option params [required, String] :gateway_arn
1089
1096
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1090
- # operation to return a list of gateways for your account and Region.
1097
+ # operation to return a list of gateways for your account and Amazon Web
1098
+ # Services Region.
1091
1099
  #
1092
1100
  # @option params [required, Integer] :volume_size_in_bytes
1093
1101
  # The size of the volume in bytes.
@@ -1221,12 +1229,15 @@ module Aws::StorageGateway
1221
1229
  # using an NFS interface. This operation is only supported for S3 File
1222
1230
  # Gateways.
1223
1231
  #
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*.
1232
+ # S3 File gateway requires Security Token Service (Amazon Web Services
1233
+ # STS) to be activated to enable you to create a file share. Make sure
1234
+ # Amazon Web Services STS is activated in the Amazon Web Services Region
1235
+ # you are creating your S3 File Gateway in. If Amazon Web Services STS
1236
+ # is not activated in the Amazon Web Services Region, activate it. For
1237
+ # information about how to activate Amazon Web Services STS, see
1238
+ # [Activating and deactivating Amazon Web Services STS in an Amazon Web
1239
+ # Services Region][1] in the *Identity and Access Management User
1240
+ # Guide*.
1230
1241
  #
1231
1242
  # S3 File Gateways do not support creating hard or symbolic links on a
1232
1243
  # file share.
@@ -1263,18 +1274,29 @@ module Aws::StorageGateway
1263
1274
  # File Gateway assumes when it accesses the underlying storage.
1264
1275
  #
1265
1276
  # @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 "/".
1277
+ # A custom ARN for the backend storage used for storing data for file
1278
+ # shares. It includes a resource ARN with an optional prefix
1279
+ # concatenation. The prefix must end with a forward slash (/).
1268
1280
  #
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:
1281
+ # <note markdown="1"> You can specify LocationARN as a bucket ARN, access point ARN or
1282
+ # access point alias, as shown in the following examples.
1271
1283
  #
1272
- # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1284
+ # Bucket ARN:
1273
1285
  #
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*.
1286
+ # `arn:aws:s3:::my-bucket/prefix/`
1287
+ #
1288
+ # Access point ARN:
1289
+ #
1290
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`
1291
+ #
1292
+ # If you specify an access point, the bucket policy must be configured
1293
+ # to delegate access control to the access point. For information, see
1294
+ # [Delegating access control to access points][1] in the *Amazon S3 User
1295
+ # Guide*.
1296
+ #
1297
+ # Access point alias:
1298
+ #
1299
+ # `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias`
1278
1300
  #
1279
1301
  # </note>
1280
1302
  #
@@ -1353,7 +1375,7 @@ module Aws::StorageGateway
1353
1375
  # The name of the file share. Optional.
1354
1376
  #
1355
1377
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1356
- # `LocationARN`.
1378
+ # `LocationARN`, or if an access point or access point alias is used.
1357
1379
  #
1358
1380
  # </note>
1359
1381
  #
@@ -1403,6 +1425,9 @@ module Aws::StorageGateway
1403
1425
  #
1404
1426
  # </note>
1405
1427
  #
1428
+ # @option params [String] :audit_destination_arn
1429
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
1430
+ #
1406
1431
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1407
1432
  #
1408
1433
  # * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1442,6 +1467,7 @@ module Aws::StorageGateway
1442
1467
  # notification_policy: "NotificationPolicy",
1443
1468
  # vpc_endpoint_dns_name: "DNSHostName",
1444
1469
  # bucket_region: "RegionId",
1470
+ # audit_destination_arn: "AuditDestinationARN",
1445
1471
  # })
1446
1472
  #
1447
1473
  # @example Response structure
@@ -1463,12 +1489,15 @@ module Aws::StorageGateway
1463
1489
  # using an SMB interface. This operation is only supported for S3 File
1464
1490
  # Gateways.
1465
1491
  #
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*.
1492
+ # S3 File Gateways require Security Token Service (Amazon Web Services
1493
+ # STS) to be activated to enable you to create a file share. Make sure
1494
+ # that Amazon Web Services STS is activated in the Amazon Web Services
1495
+ # Region you are creating your S3 File Gateway in. If Amazon Web
1496
+ # Services STS is not activated in this Amazon Web Services Region,
1497
+ # activate it. For information about how to activate Amazon Web Services
1498
+ # STS, see [Activating and deactivating Amazon Web Services STS in an
1499
+ # Amazon Web Services Region][1] in the *Identity and Access Management
1500
+ # User Guide*.
1472
1501
  #
1473
1502
  # File gateways don't support creating hard or symbolic links on a
1474
1503
  # file
@@ -1503,18 +1532,29 @@ module Aws::StorageGateway
1503
1532
  # File Gateway assumes when it accesses the underlying storage.
1504
1533
  #
1505
1534
  # @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 "/".
1535
+ # A custom ARN for the backend storage used for storing data for file
1536
+ # shares. It includes a resource ARN with an optional prefix
1537
+ # concatenation. The prefix must end with a forward slash (/).
1538
+ #
1539
+ # <note markdown="1"> You can specify LocationARN as a bucket ARN, access point ARN or
1540
+ # access point alias, as shown in the following examples.
1541
+ #
1542
+ # Bucket ARN:
1508
1543
  #
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:
1544
+ # `arn:aws:s3:::my-bucket/prefix/`
1511
1545
  #
1512
- # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1546
+ # Access point ARN:
1513
1547
  #
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*.
1548
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`
1549
+ #
1550
+ # If you specify an access point, the bucket policy must be configured
1551
+ # to delegate access control to the access point. For information, see
1552
+ # [Delegating access control to access points][1] in the *Amazon S3 User
1553
+ # Guide*.
1554
+ #
1555
+ # Access point alias:
1556
+ #
1557
+ # `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias`
1518
1558
  #
1519
1559
  # </note>
1520
1560
  #
@@ -1634,7 +1674,7 @@ module Aws::StorageGateway
1634
1674
  # The name of the file share. Optional.
1635
1675
  #
1636
1676
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1637
- # `LocationARN`.
1677
+ # `LocationARN`, or if an access point or access point alias is used.
1638
1678
  #
1639
1679
  # </note>
1640
1680
  #
@@ -1973,7 +2013,8 @@ module Aws::StorageGateway
1973
2013
  #
1974
2014
  # @option params [required, String] :gateway_arn
1975
2015
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1976
- # operation to return a list of gateways for your account and Region.
2016
+ # operation to return a list of gateways for your account and Amazon Web
2017
+ # Services Region.
1977
2018
  #
1978
2019
  # @option params [required, String] :disk_id
1979
2020
  # The unique identifier for the gateway local disk that is configured as
@@ -2117,10 +2158,11 @@ module Aws::StorageGateway
2117
2158
  #
2118
2159
  # @option params [String] :retention_lock_type
2119
2160
  # 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.
2161
+ # governance mode, Amazon Web Services accounts with specific IAM
2162
+ # permissions are authorized to remove the tape retention lock from
2163
+ # archived virtual tapes. When configured in compliance mode, the tape
2164
+ # retention lock cannot be removed by any user, including the root
2165
+ # Amazon Web Services account.
2124
2166
  #
2125
2167
  # @option params [Integer] :retention_lock_time_in_days
2126
2168
  # Tape retention lock time is set in days. Tape retention lock can be
@@ -2184,7 +2226,8 @@ module Aws::StorageGateway
2184
2226
  # @option params [required, String] :gateway_arn
2185
2227
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2186
2228
  # associate the virtual tape with. Use the ListGateways operation to
2187
- # return a list of gateways for your account and Region.
2229
+ # return a list of gateways for your account and Amazon Web Services
2230
+ # Region.
2188
2231
  #
2189
2232
  # @option params [required, Integer] :tape_size_in_bytes
2190
2233
  # The size, in bytes, of the virtual tape that you want to create.
@@ -2301,7 +2344,8 @@ module Aws::StorageGateway
2301
2344
  # @option params [required, String] :gateway_arn
2302
2345
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2303
2346
  # associate the virtual tapes with. Use the ListGateways operation to
2304
- # return a list of gateways for your account and Region.
2347
+ # return a list of gateways for your account and Amazon Web Services
2348
+ # Region.
2305
2349
  #
2306
2350
  # @option params [required, Integer] :tape_size_in_bytes
2307
2351
  # The size, in bytes, of the virtual tapes that you want to create.
@@ -2435,7 +2479,8 @@ module Aws::StorageGateway
2435
2479
  #
2436
2480
  # @option params [required, String] :gateway_arn
2437
2481
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2438
- # operation to return a list of gateways for your account and Region.
2482
+ # operation to return a list of gateways for your account and Amazon Web
2483
+ # Services Region.
2439
2484
  #
2440
2485
  # @return [Types::DeleteAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2441
2486
  #
@@ -2469,7 +2514,8 @@ module Aws::StorageGateway
2469
2514
  #
2470
2515
  # @option params [required, String] :gateway_arn
2471
2516
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2472
- # operation to return a list of gateways for your account and Region.
2517
+ # operation to return a list of gateways for your account and Amazon Web
2518
+ # Services Region.
2473
2519
  #
2474
2520
  # @option params [required, String] :bandwidth_type
2475
2521
  # One of the BandwidthType values that indicates the gateway bandwidth
@@ -2635,7 +2681,8 @@ module Aws::StorageGateway
2635
2681
  #
2636
2682
  # @option params [required, String] :gateway_arn
2637
2683
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2638
- # operation to return a list of gateways for your account and Region.
2684
+ # operation to return a list of gateways for your account and Amazon Web
2685
+ # Services Region.
2639
2686
  #
2640
2687
  # @return [Types::DeleteGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2641
2688
  #
@@ -2740,7 +2787,8 @@ module Aws::StorageGateway
2740
2787
  # @option params [required, String] :gateway_arn
2741
2788
  # The unique Amazon Resource Name (ARN) of the gateway that the virtual
2742
2789
  # tape to delete is associated with. Use the ListGateways operation to
2743
- # return a list of gateways for your account and Region.
2790
+ # return a list of gateways for your account and Amazon Web Services
2791
+ # Region.
2744
2792
  #
2745
2793
  # @option params [required, String] :tape_arn
2746
2794
  # The Amazon Resource Name (ARN) of the virtual tape to delete.
@@ -2942,7 +2990,8 @@ module Aws::StorageGateway
2942
2990
  #
2943
2991
  # @option params [required, String] :gateway_arn
2944
2992
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2945
- # operation to return a list of gateways for your account and Region.
2993
+ # operation to return a list of gateways for your account and Amazon Web
2994
+ # Services Region.
2946
2995
  #
2947
2996
  # @return [Types::DescribeAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2948
2997
  #
@@ -2984,7 +3033,8 @@ module Aws::StorageGateway
2984
3033
  #
2985
3034
  # @option params [required, String] :gateway_arn
2986
3035
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2987
- # operation to return a list of gateways for your account and Region.
3036
+ # operation to return a list of gateways for your account and Amazon Web
3037
+ # Services Region.
2988
3038
  #
2989
3039
  # @return [Types::DescribeBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2990
3040
  #
@@ -3052,7 +3102,8 @@ module Aws::StorageGateway
3052
3102
  #
3053
3103
  # @option params [required, String] :gateway_arn
3054
3104
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3055
- # operation to return a list of gateways for your account and Region.
3105
+ # operation to return a list of gateways for your account and Amazon Web
3106
+ # Services Region.
3056
3107
  #
3057
3108
  # @return [Types::DescribeBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3058
3109
  #
@@ -3095,7 +3146,8 @@ module Aws::StorageGateway
3095
3146
  #
3096
3147
  # @option params [required, String] :gateway_arn
3097
3148
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3098
- # operation to return a list of gateways for your account and Region.
3149
+ # operation to return a list of gateways for your account and Amazon Web
3150
+ # Services Region.
3099
3151
  #
3100
3152
  # @return [Types::DescribeCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3101
3153
  #
@@ -3330,6 +3382,8 @@ module Aws::StorageGateway
3330
3382
  # resp.file_system_association_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3331
3383
  # resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses #=> Array
3332
3384
  # resp.file_system_association_info_list[0].endpoint_network_configuration.ip_addresses[0] #=> String
3385
+ # resp.file_system_association_info_list[0].file_system_association_status_details #=> Array
3386
+ # resp.file_system_association_info_list[0].file_system_association_status_details[0].error_code #=> String
3333
3387
  #
3334
3388
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociations AWS API Documentation
3335
3389
  #
@@ -3347,7 +3401,8 @@ module Aws::StorageGateway
3347
3401
  #
3348
3402
  # @option params [required, String] :gateway_arn
3349
3403
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3350
- # operation to return a list of gateways for your account and Region.
3404
+ # operation to return a list of gateways for your account and Amazon Web
3405
+ # Services Region.
3351
3406
  #
3352
3407
  # @return [Types::DescribeGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3353
3408
  #
@@ -3449,7 +3504,8 @@ module Aws::StorageGateway
3449
3504
  #
3450
3505
  # @option params [required, String] :gateway_arn
3451
3506
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3452
- # operation to return a list of gateways for your account and Region.
3507
+ # operation to return a list of gateways for your account and Amazon Web
3508
+ # Services Region.
3453
3509
  #
3454
3510
  # @return [Types::DescribeMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3455
3511
  #
@@ -3552,6 +3608,7 @@ module Aws::StorageGateway
3552
3608
  # resp.nfs_file_share_info_list[0].notification_policy #=> String
3553
3609
  # resp.nfs_file_share_info_list[0].vpc_endpoint_dns_name #=> String
3554
3610
  # resp.nfs_file_share_info_list[0].bucket_region #=> String
3611
+ # resp.nfs_file_share_info_list[0].audit_destination_arn #=> String
3555
3612
  #
3556
3613
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
3557
3614
  #
@@ -3633,7 +3690,8 @@ module Aws::StorageGateway
3633
3690
  #
3634
3691
  # @option params [required, String] :gateway_arn
3635
3692
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3636
- # operation to return a list of gateways for your account and Region.
3693
+ # operation to return a list of gateways for your account and Amazon Web
3694
+ # Services Region.
3637
3695
  #
3638
3696
  # @return [Types::DescribeSMBSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3639
3697
  #
@@ -3643,6 +3701,7 @@ module Aws::StorageGateway
3643
3701
  # * {Types::DescribeSMBSettingsOutput#smb_guest_password_set #smb_guest_password_set} => Boolean
3644
3702
  # * {Types::DescribeSMBSettingsOutput#smb_security_strategy #smb_security_strategy} => String
3645
3703
  # * {Types::DescribeSMBSettingsOutput#file_shares_visible #file_shares_visible} => Boolean
3704
+ # * {Types::DescribeSMBSettingsOutput#smb_local_groups #smb_local_groups} => Types::SMBLocalGroups
3646
3705
  #
3647
3706
  # @example Request syntax with placeholder values
3648
3707
  #
@@ -3658,6 +3717,8 @@ module Aws::StorageGateway
3658
3717
  # resp.smb_guest_password_set #=> Boolean
3659
3718
  # resp.smb_security_strategy #=> String, one of "ClientSpecified", "MandatorySigning", "MandatoryEncryption"
3660
3719
  # resp.file_shares_visible #=> Boolean
3720
+ # resp.smb_local_groups.gateway_admins #=> Array
3721
+ # resp.smb_local_groups.gateway_admins[0] #=> String
3661
3722
  #
3662
3723
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettings AWS API Documentation
3663
3724
  #
@@ -3925,7 +3986,8 @@ module Aws::StorageGateway
3925
3986
  #
3926
3987
  # @option params [required, String] :gateway_arn
3927
3988
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3928
- # operation to return a list of gateways for your account and Region.
3989
+ # operation to return a list of gateways for your account and Amazon Web
3990
+ # Services Region.
3929
3991
  #
3930
3992
  # @option params [String] :marker
3931
3993
  # An opaque string that indicates the position at which to begin
@@ -4002,7 +4064,8 @@ module Aws::StorageGateway
4002
4064
  #
4003
4065
  # @option params [required, String] :gateway_arn
4004
4066
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4005
- # operation to return a list of gateways for your account and Region.
4067
+ # operation to return a list of gateways for your account and Amazon Web
4068
+ # Services Region.
4006
4069
  #
4007
4070
  # @option params [Array<String>] :tape_arns
4008
4071
  # Specifies one or more unique Amazon Resource Names (ARNs) that
@@ -4113,7 +4176,8 @@ module Aws::StorageGateway
4113
4176
  #
4114
4177
  # @option params [required, String] :gateway_arn
4115
4178
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4116
- # operation to return a list of gateways for your account and Region.
4179
+ # operation to return a list of gateways for your account and Amazon Web
4180
+ # Services Region.
4117
4181
  #
4118
4182
  # @return [Types::DescribeUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4119
4183
  #
@@ -4194,7 +4258,8 @@ module Aws::StorageGateway
4194
4258
  #
4195
4259
  # @option params [required, String] :gateway_arn
4196
4260
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4197
- # operation to return a list of gateways for your account and Region.
4261
+ # operation to return a list of gateways for your account and Amazon Web
4262
+ # Services Region.
4198
4263
  #
4199
4264
  # @option params [Array<String>] :vtl_device_arns
4200
4265
  # An array of strings, where each string represents the Amazon Resource
@@ -4327,7 +4392,8 @@ module Aws::StorageGateway
4327
4392
  #
4328
4393
  # @option params [required, String] :gateway_arn
4329
4394
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4330
- # operation to return a list of gateways for your account and Region.
4395
+ # operation to return a list of gateways for your account and Amazon Web
4396
+ # Services Region.
4331
4397
  #
4332
4398
  # @return [Types::DescribeWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4333
4399
  #
@@ -4436,7 +4502,8 @@ module Aws::StorageGateway
4436
4502
  #
4437
4503
  # @option params [required, String] :gateway_arn
4438
4504
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4439
- # operation to return a list of gateways for your account and Region.
4505
+ # operation to return a list of gateways for your account and Amazon Web
4506
+ # Services Region.
4440
4507
  #
4441
4508
  # @return [Types::DisableGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4442
4509
  #
@@ -4521,7 +4588,8 @@ module Aws::StorageGateway
4521
4588
  #
4522
4589
  # @option params [required, String] :gateway_arn
4523
4590
  # The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways`
4524
- # operation to return a list of gateways for your account and Region.
4591
+ # operation to return a list of gateways for your account and Amazon Web
4592
+ # Services Region.
4525
4593
  #
4526
4594
  # @option params [required, String] :domain_name
4527
4595
  # The name of the domain that you want the gateway to join.
@@ -4591,7 +4659,8 @@ module Aws::StorageGateway
4591
4659
  #
4592
4660
  # @option params [String] :gateway_arn
4593
4661
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4594
- # operation to return a list of gateways for your account and Region.
4662
+ # operation to return a list of gateways for your account and Amazon Web
4663
+ # Services Region.
4595
4664
  #
4596
4665
  # @return [Types::ListAutomaticTapeCreationPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4597
4666
  #
@@ -4683,7 +4752,8 @@ module Aws::StorageGateway
4683
4752
  #
4684
4753
  # @option params [String] :gateway_arn
4685
4754
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4686
- # operation to return a list of gateways for your account and Region.
4755
+ # operation to return a list of gateways for your account and Amazon Web
4756
+ # Services Region.
4687
4757
  #
4688
4758
  # @option params [Integer] :limit
4689
4759
  # The maximum number of file system associations to return in the
@@ -4731,9 +4801,9 @@ module Aws::StorageGateway
4731
4801
  req.send_request(options)
4732
4802
  end
4733
4803
 
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).
4804
+ # Lists gateways owned by an Amazon Web Services account in an Amazon
4805
+ # Web Services Region specified in the request. The returned list is
4806
+ # ordered by gateway Amazon Resource Name (ARN).
4737
4807
  #
4738
4808
  # By default, the operation returns a maximum of 100 gateways. This
4739
4809
  # operation supports pagination that allows you to optionally reduce the
@@ -4825,7 +4895,8 @@ module Aws::StorageGateway
4825
4895
  #
4826
4896
  # @option params [required, String] :gateway_arn
4827
4897
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4828
- # operation to return a list of gateways for your account and Region.
4898
+ # operation to return a list of gateways for your account and Amazon Web
4899
+ # Services Region.
4829
4900
  #
4830
4901
  # @return [Types::ListLocalDisksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4831
4902
  #
@@ -5133,7 +5204,8 @@ module Aws::StorageGateway
5133
5204
  #
5134
5205
  # @option params [required, String] :gateway_arn
5135
5206
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5136
- # operation to return a list of gateways for your account and Region.
5207
+ # operation to return a list of gateways for your account and Amazon Web
5208
+ # Services Region.
5137
5209
  #
5138
5210
  # @return [Types::ListVolumeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5139
5211
  #
@@ -5202,7 +5274,8 @@ module Aws::StorageGateway
5202
5274
  #
5203
5275
  # @option params [String] :gateway_arn
5204
5276
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5205
- # operation to return a list of gateways for your account and Region.
5277
+ # operation to return a list of gateways for your account and Amazon Web
5278
+ # Services Region.
5206
5279
  #
5207
5280
  # @option params [String] :marker
5208
5281
  # A string that indicates the position at which to begin the returned
@@ -5493,7 +5566,8 @@ module Aws::StorageGateway
5493
5566
  #
5494
5567
  # @option params [required, String] :gateway_arn
5495
5568
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5496
- # operation to return a list of gateways for your account and Region.
5569
+ # operation to return a list of gateways for your account and Amazon Web
5570
+ # Services Region.
5497
5571
  #
5498
5572
  # @return [Types::ResetCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5499
5573
  #
@@ -5551,7 +5625,7 @@ module Aws::StorageGateway
5551
5625
  # @option params [required, String] :gateway_arn
5552
5626
  # The Amazon Resource Name (ARN) of the gateway you want to retrieve the
5553
5627
  # virtual tape to. Use the ListGateways operation to return a list of
5554
- # gateways for your account and Region.
5628
+ # gateways for your account and Amazon Web Services Region.
5555
5629
  #
5556
5630
  # You retrieve archived virtual tapes to only one gateway and the
5557
5631
  # gateway must be a tape gateway.
@@ -5616,7 +5690,8 @@ module Aws::StorageGateway
5616
5690
  #
5617
5691
  # @option params [required, String] :gateway_arn
5618
5692
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5619
- # operation to return a list of gateways for your account and Region.
5693
+ # operation to return a list of gateways for your account and Amazon Web
5694
+ # Services Region.
5620
5695
  #
5621
5696
  # @return [Types::RetrieveTapeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5622
5697
  #
@@ -5664,7 +5739,8 @@ module Aws::StorageGateway
5664
5739
  #
5665
5740
  # @option params [required, String] :gateway_arn
5666
5741
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5667
- # operation to return a list of gateways for your account and Region.
5742
+ # operation to return a list of gateways for your account and Amazon Web
5743
+ # Services Region.
5668
5744
  #
5669
5745
  # @option params [required, String] :local_console_password
5670
5746
  # The password you want to set for your VM local console.
@@ -5774,7 +5850,8 @@ module Aws::StorageGateway
5774
5850
  #
5775
5851
  # @option params [required, String] :gateway_arn
5776
5852
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5777
- # operation to return a list of gateways for your account and Region.
5853
+ # operation to return a list of gateways for your account and Amazon Web
5854
+ # Services Region.
5778
5855
  #
5779
5856
  # @return [Types::ShutdownGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5780
5857
  #
@@ -5828,7 +5905,8 @@ module Aws::StorageGateway
5828
5905
  #
5829
5906
  # @option params [required, String] :gateway_arn
5830
5907
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5831
- # operation to return a list of gateways for your account and Region.
5908
+ # operation to return a list of gateways for your account and Amazon Web
5909
+ # Services Region.
5832
5910
  #
5833
5911
  # @return [Types::StartAvailabilityMonitorTestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5834
5912
  #
@@ -5871,7 +5949,8 @@ module Aws::StorageGateway
5871
5949
  #
5872
5950
  # @option params [required, String] :gateway_arn
5873
5951
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5874
- # operation to return a list of gateways for your account and Region.
5952
+ # operation to return a list of gateways for your account and Amazon Web
5953
+ # Services Region.
5875
5954
  #
5876
5955
  # @return [Types::StartGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5877
5956
  #
@@ -5927,7 +6006,8 @@ module Aws::StorageGateway
5927
6006
  #
5928
6007
  # @option params [required, String] :gateway_arn
5929
6008
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5930
- # operation to return a list of gateways for your account and Region.
6009
+ # operation to return a list of gateways for your account and Amazon Web
6010
+ # Services Region.
5931
6011
  #
5932
6012
  # @return [Types::UpdateAutomaticTapeCreationPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5933
6013
  #
@@ -5977,7 +6057,8 @@ module Aws::StorageGateway
5977
6057
  #
5978
6058
  # @option params [required, String] :gateway_arn
5979
6059
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5980
- # operation to return a list of gateways for your account and Region.
6060
+ # operation to return a list of gateways for your account and Amazon Web
6061
+ # Services Region.
5981
6062
  #
5982
6063
  # @option params [Integer] :average_upload_rate_limit_in_bits_per_sec
5983
6064
  # The average upload bandwidth rate limit in bits per second.
@@ -6035,7 +6116,8 @@ module Aws::StorageGateway
6035
6116
  #
6036
6117
  # @option params [required, String] :gateway_arn
6037
6118
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6038
- # operation to return a list of gateways for your account and Region.
6119
+ # operation to return a list of gateways for your account and Amazon Web
6120
+ # Services Region.
6039
6121
  #
6040
6122
  # @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
6041
6123
  # An array containing bandwidth rate limit schedule intervals for a
@@ -6219,7 +6301,8 @@ module Aws::StorageGateway
6219
6301
  #
6220
6302
  # @option params [required, String] :gateway_arn
6221
6303
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6222
- # operation to return a list of gateways for your account and Region.
6304
+ # operation to return a list of gateways for your account and Amazon Web
6305
+ # Services Region.
6223
6306
  #
6224
6307
  # @option params [String] :gateway_name
6225
6308
  # The name you configured for your gateway.
@@ -6310,7 +6393,8 @@ module Aws::StorageGateway
6310
6393
  #
6311
6394
  # @option params [required, String] :gateway_arn
6312
6395
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6313
- # operation to return a list of gateways for your account and Region.
6396
+ # operation to return a list of gateways for your account and Amazon Web
6397
+ # Services Region.
6314
6398
  #
6315
6399
  # @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6316
6400
  #
@@ -6355,7 +6439,8 @@ module Aws::StorageGateway
6355
6439
  #
6356
6440
  # @option params [required, String] :gateway_arn
6357
6441
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6358
- # operation to return a list of gateways for your account and Region.
6442
+ # operation to return a list of gateways for your account and Amazon Web
6443
+ # Services Region.
6359
6444
  #
6360
6445
  # @option params [required, Integer] :hour_of_day
6361
6446
  # The hour component of the maintenance start time represented as *hh*,
@@ -6520,12 +6605,12 @@ module Aws::StorageGateway
6520
6605
  # The name of the file share. Optional.
6521
6606
  #
6522
6607
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6523
- # `LocationARN`.
6608
+ # `LocationARN`, or if an access point or access point alias is used.
6524
6609
  #
6525
6610
  # </note>
6526
6611
  #
6527
6612
  # @option params [Types::CacheAttributes] :cache_attributes
6528
- # specifies refresh cache information for the file share.
6613
+ # Specifies refresh cache information for the file share.
6529
6614
  #
6530
6615
  # @option params [String] :notification_policy
6531
6616
  # The notification policy of the file share. `SettlingTimeInSeconds`
@@ -6550,6 +6635,9 @@ module Aws::StorageGateway
6550
6635
  #
6551
6636
  # `\{\}`
6552
6637
  #
6638
+ # @option params [String] :audit_destination_arn
6639
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
6640
+ #
6553
6641
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6554
6642
  #
6555
6643
  # * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -6578,6 +6666,7 @@ module Aws::StorageGateway
6578
6666
  # cache_stale_timeout_in_seconds: 1,
6579
6667
  # },
6580
6668
  # notification_policy: "NotificationPolicy",
6669
+ # audit_destination_arn: "AuditDestinationARN",
6581
6670
  # })
6582
6671
  #
6583
6672
  # @example Response structure
@@ -6601,12 +6690,15 @@ module Aws::StorageGateway
6601
6690
  #
6602
6691
  # </note>
6603
6692
  #
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*.
6693
+ # File gateways require Security Token Service (Amazon Web Services STS)
6694
+ # to be activated to enable you to create a file share. Make sure that
6695
+ # Amazon Web Services STS is activated in the Amazon Web Services Region
6696
+ # you are creating your file gateway in. If Amazon Web Services STS is
6697
+ # not activated in this Amazon Web Services Region, activate it. For
6698
+ # information about how to activate Amazon Web Services STS, see
6699
+ # [Activating and deactivating Amazon Web Services STS in an Amazon Web
6700
+ # Services Region][1] in the *Identity and Access Management User
6701
+ # Guide*.
6610
6702
  #
6611
6703
  # File gateways don't support creating hard or symbolic links on a
6612
6704
  # file
@@ -6725,7 +6817,7 @@ module Aws::StorageGateway
6725
6817
  # The name of the file share. Optional.
6726
6818
  #
6727
6819
  # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6728
- # `LocationARN`.
6820
+ # `LocationARN`, or if an access point or access point alias is used.
6729
6821
  #
6730
6822
  # </note>
6731
6823
  #
@@ -6816,7 +6908,8 @@ module Aws::StorageGateway
6816
6908
  #
6817
6909
  # @option params [required, String] :gateway_arn
6818
6910
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6819
- # operation to return a list of gateways for your account and Region.
6911
+ # operation to return a list of gateways for your account and Amazon Web
6912
+ # Services Region.
6820
6913
  #
6821
6914
  # @option params [required, Boolean] :file_shares_visible
6822
6915
  # The shares on this gateway appear when listing shares.
@@ -6845,6 +6938,44 @@ module Aws::StorageGateway
6845
6938
  req.send_request(options)
6846
6939
  end
6847
6940
 
6941
+ # Updates the list of Active Directory users and groups that have
6942
+ # special permissions for SMB file shares on the gateway.
6943
+ #
6944
+ # @option params [required, String] :gateway_arn
6945
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6946
+ # operation to return a list of gateways for your account and Amazon Web
6947
+ # Services Region.
6948
+ #
6949
+ # @option params [required, Types::SMBLocalGroups] :smb_local_groups
6950
+ # A list of Active Directory users and groups that you want to grant
6951
+ # special permissions for SMB file shares on the gateway.
6952
+ #
6953
+ # @return [Types::UpdateSMBLocalGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6954
+ #
6955
+ # * {Types::UpdateSMBLocalGroupsOutput#gateway_arn #gateway_arn} => String
6956
+ #
6957
+ # @example Request syntax with placeholder values
6958
+ #
6959
+ # resp = client.update_smb_local_groups({
6960
+ # gateway_arn: "GatewayARN", # required
6961
+ # smb_local_groups: { # required
6962
+ # gateway_admins: ["UserListUser"],
6963
+ # },
6964
+ # })
6965
+ #
6966
+ # @example Response structure
6967
+ #
6968
+ # resp.gateway_arn #=> String
6969
+ #
6970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBLocalGroups AWS API Documentation
6971
+ #
6972
+ # @overload update_smb_local_groups(params = {})
6973
+ # @param [Hash] params ({})
6974
+ def update_smb_local_groups(params = {}, options = {})
6975
+ req = build_request(:update_smb_local_groups, params)
6976
+ req.send_request(options)
6977
+ end
6978
+
6848
6979
  # Updates the SMB security strategy on a file gateway. This action is
6849
6980
  # only supported in file gateways.
6850
6981
  #
@@ -6856,7 +6987,8 @@ module Aws::StorageGateway
6856
6987
  #
6857
6988
  # @option params [required, String] :gateway_arn
6858
6989
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6859
- # operation to return a list of gateways for your account and Region.
6990
+ # operation to return a list of gateways for your account and Amazon Web
6991
+ # Services Region.
6860
6992
  #
6861
6993
  # @option params [required, String] :smb_security_strategy
6862
6994
  # Specifies the type of security strategy.
@@ -7057,7 +7189,7 @@ module Aws::StorageGateway
7057
7189
  params: params,
7058
7190
  config: config)
7059
7191
  context[:gem_name] = 'aws-sdk-storagegateway'
7060
- context[:gem_version] = '1.56.0'
7192
+ context[:gem_version] = '1.60.0'
7061
7193
  Seahorse::Client::Request.new(handlers, context)
7062
7194
  end
7063
7195