aws-sdk-storagegateway 1.49.0 → 1.54.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -605,6 +605,78 @@ module Aws::StorageGateway
605
605
  include Aws::Structure
606
606
  end
607
607
 
608
+ # Describes a bandwidth rate limit interval for a gateway. A bandwidth
609
+ # rate limit schedule consists of one or more bandwidth rate limit
610
+ # intervals. A bandwidth rate limit interval defines a period of time on
611
+ # one or more days of the week, during which bandwidth rate limits are
612
+ # specified for uploading, downloading, or both.
613
+ #
614
+ # @note When making an API call, you may pass BandwidthRateLimitInterval
615
+ # data as a hash:
616
+ #
617
+ # {
618
+ # start_hour_of_day: 1, # required
619
+ # start_minute_of_hour: 1, # required
620
+ # end_hour_of_day: 1, # required
621
+ # end_minute_of_hour: 1, # required
622
+ # days_of_week: [1], # required
623
+ # average_upload_rate_limit_in_bits_per_sec: 1,
624
+ # average_download_rate_limit_in_bits_per_sec: 1,
625
+ # }
626
+ #
627
+ # @!attribute [rw] start_hour_of_day
628
+ # The hour of the day to start the bandwidth rate limit interval.
629
+ # @return [Integer]
630
+ #
631
+ # @!attribute [rw] start_minute_of_hour
632
+ # The minute of the hour to start the bandwidth rate limit interval.
633
+ # The interval begins at the start of that minute. To begin an
634
+ # interval exactly at the start of the hour, use the value `0`.
635
+ # @return [Integer]
636
+ #
637
+ # @!attribute [rw] end_hour_of_day
638
+ # The hour of the day to end the bandwidth rate limit interval.
639
+ # @return [Integer]
640
+ #
641
+ # @!attribute [rw] end_minute_of_hour
642
+ # The minute of the hour to end the bandwidth rate limit interval.
643
+ #
644
+ # The bandwidth rate limit interval ends at the end of the minute. To
645
+ # end an interval at the end of an hour, use the value `59`.
646
+ # @return [Integer]
647
+ #
648
+ # @!attribute [rw] days_of_week
649
+ # The days of the week component of the bandwidth rate limit interval,
650
+ # represented as ordinal numbers from 0 to 6, where 0 represents
651
+ # Sunday and 6 Saturday.
652
+ # @return [Array<Integer>]
653
+ #
654
+ # @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
655
+ # The average upload rate limit component of the bandwidth rate limit
656
+ # interval, in bits per second. This field does not appear in the
657
+ # response if the upload rate limit is not set.
658
+ # @return [Integer]
659
+ #
660
+ # @!attribute [rw] average_download_rate_limit_in_bits_per_sec
661
+ # The average download rate limit component of the bandwidth rate
662
+ # limit interval, in bits per second. This field does not appear in
663
+ # the response if the download rate limit is not set.
664
+ # @return [Integer]
665
+ #
666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/BandwidthRateLimitInterval AWS API Documentation
667
+ #
668
+ class BandwidthRateLimitInterval < Struct.new(
669
+ :start_hour_of_day,
670
+ :start_minute_of_hour,
671
+ :end_hour_of_day,
672
+ :end_minute_of_hour,
673
+ :days_of_week,
674
+ :average_upload_rate_limit_in_bits_per_sec,
675
+ :average_download_rate_limit_in_bits_per_sec)
676
+ SENSITIVE = []
677
+ include Aws::Structure
678
+ end
679
+
608
680
  # Lists refresh cache information.
609
681
  #
610
682
  # @note When making an API call, you may pass CacheAttributes
@@ -1043,6 +1115,7 @@ module Aws::StorageGateway
1043
1115
  # cache_attributes: {
1044
1116
  # cache_stale_timeout_in_seconds: 1,
1045
1117
  # },
1118
+ # notification_policy: "NotificationPolicy",
1046
1119
  # }
1047
1120
  #
1048
1121
  # @!attribute [rw] client_token
@@ -1173,6 +1246,10 @@ module Aws::StorageGateway
1173
1246
  # Refresh cache information.
1174
1247
  # @return [Types::CacheAttributes]
1175
1248
  #
1249
+ # @!attribute [rw] notification_policy
1250
+ # The notification policy of the file share.
1251
+ # @return [String]
1252
+ #
1176
1253
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateNFSFileShareInput AWS API Documentation
1177
1254
  #
1178
1255
  class CreateNFSFileShareInput < Struct.new(
@@ -1192,7 +1269,8 @@ module Aws::StorageGateway
1192
1269
  :requester_pays,
1193
1270
  :tags,
1194
1271
  :file_share_name,
1195
- :cache_attributes)
1272
+ :cache_attributes,
1273
+ :notification_policy)
1196
1274
  SENSITIVE = []
1197
1275
  include Aws::Structure
1198
1276
  end
@@ -1229,6 +1307,7 @@ module Aws::StorageGateway
1229
1307
  # guess_mime_type_enabled: false,
1230
1308
  # requester_pays: false,
1231
1309
  # smbacl_enabled: false,
1310
+ # access_based_enumeration: false,
1232
1311
  # admin_user_list: ["FileShareUser"],
1233
1312
  # valid_user_list: ["FileShareUser"],
1234
1313
  # invalid_user_list: ["FileShareUser"],
@@ -1245,6 +1324,7 @@ module Aws::StorageGateway
1245
1324
  # cache_attributes: {
1246
1325
  # cache_stale_timeout_in_seconds: 1,
1247
1326
  # },
1327
+ # notification_policy: "NotificationPolicy",
1248
1328
  # }
1249
1329
  #
1250
1330
  # @!attribute [rw] client_token
@@ -1345,6 +1425,11 @@ module Aws::StorageGateway
1345
1425
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1346
1426
  # @return [Boolean]
1347
1427
  #
1428
+ # @!attribute [rw] access_based_enumeration
1429
+ # The files and folders on this share will only be visible to users
1430
+ # with read access.
1431
+ # @return [Boolean]
1432
+ #
1348
1433
  # @!attribute [rw] admin_user_list
1349
1434
  # A list of users or groups in the Active Directory that will be
1350
1435
  # granted administrator privileges on the file share. These users can
@@ -1416,6 +1501,10 @@ module Aws::StorageGateway
1416
1501
  # Refresh cache information.
1417
1502
  # @return [Types::CacheAttributes]
1418
1503
  #
1504
+ # @!attribute [rw] notification_policy
1505
+ # The notification policy of the file share.
1506
+ # @return [String]
1507
+ #
1419
1508
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSMBFileShareInput AWS API Documentation
1420
1509
  #
1421
1510
  class CreateSMBFileShareInput < Struct.new(
@@ -1431,6 +1520,7 @@ module Aws::StorageGateway
1431
1520
  :guess_mime_type_enabled,
1432
1521
  :requester_pays,
1433
1522
  :smbacl_enabled,
1523
+ :access_based_enumeration,
1434
1524
  :admin_user_list,
1435
1525
  :valid_user_list,
1436
1526
  :invalid_user_list,
@@ -1439,7 +1529,8 @@ module Aws::StorageGateway
1439
1529
  :case_sensitivity,
1440
1530
  :tags,
1441
1531
  :file_share_name,
1442
- :cache_attributes)
1532
+ :cache_attributes,
1533
+ :notification_policy)
1443
1534
  SENSITIVE = []
1444
1535
  include Aws::Structure
1445
1536
  end
@@ -2619,6 +2710,47 @@ module Aws::StorageGateway
2619
2710
  include Aws::Structure
2620
2711
  end
2621
2712
 
2713
+ # @note When making an API call, you may pass DescribeBandwidthRateLimitScheduleInput
2714
+ # data as a hash:
2715
+ #
2716
+ # {
2717
+ # gateway_arn: "GatewayARN", # required
2718
+ # }
2719
+ #
2720
+ # @!attribute [rw] gateway_arn
2721
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2722
+ # operation to return a list of gateways for your account and AWS
2723
+ # Region.
2724
+ # @return [String]
2725
+ #
2726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimitScheduleInput AWS API Documentation
2727
+ #
2728
+ class DescribeBandwidthRateLimitScheduleInput < Struct.new(
2729
+ :gateway_arn)
2730
+ SENSITIVE = []
2731
+ include Aws::Structure
2732
+ end
2733
+
2734
+ # @!attribute [rw] gateway_arn
2735
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2736
+ # operation to return a list of gateways for your account and AWS
2737
+ # Region.
2738
+ # @return [String]
2739
+ #
2740
+ # @!attribute [rw] bandwidth_rate_limit_intervals
2741
+ # An array that contains the bandwidth rate limit intervals for a tape
2742
+ # or volume gateway.
2743
+ # @return [Array<Types::BandwidthRateLimitInterval>]
2744
+ #
2745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimitScheduleOutput AWS API Documentation
2746
+ #
2747
+ class DescribeBandwidthRateLimitScheduleOutput < Struct.new(
2748
+ :gateway_arn,
2749
+ :bandwidth_rate_limit_intervals)
2750
+ SENSITIVE = []
2751
+ include Aws::Structure
2752
+ end
2753
+
2622
2754
  # @note When making an API call, you may pass DescribeCacheInput
2623
2755
  # data as a hash:
2624
2756
  #
@@ -3169,6 +3301,10 @@ module Aws::StorageGateway
3169
3301
  # Microsoft Windows 8, Windows Server 2012 or newer.
3170
3302
  # @return [String]
3171
3303
  #
3304
+ # @!attribute [rw] file_shares_visible
3305
+ # The shares on this gateway appear when listing shares.
3306
+ # @return [Boolean]
3307
+ #
3172
3308
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettingsOutput AWS API Documentation
3173
3309
  #
3174
3310
  class DescribeSMBSettingsOutput < Struct.new(
@@ -3176,7 +3312,8 @@ module Aws::StorageGateway
3176
3312
  :domain_name,
3177
3313
  :active_directory_status,
3178
3314
  :smb_guest_password_set,
3179
- :smb_security_strategy)
3315
+ :smb_security_strategy,
3316
+ :file_shares_visible)
3180
3317
  SENSITIVE = []
3181
3318
  include Aws::Structure
3182
3319
  end
@@ -4887,6 +5024,10 @@ module Aws::StorageGateway
4887
5024
  # Refresh cache information.
4888
5025
  # @return [Types::CacheAttributes]
4889
5026
  #
5027
+ # @!attribute [rw] notification_policy
5028
+ # The notification policy of the file share.
5029
+ # @return [String]
5030
+ #
4890
5031
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NFSFileShareInfo AWS API Documentation
4891
5032
  #
4892
5033
  class NFSFileShareInfo < Struct.new(
@@ -4909,7 +5050,8 @@ module Aws::StorageGateway
4909
5050
  :requester_pays,
4910
5051
  :tags,
4911
5052
  :file_share_name,
4912
- :cache_attributes)
5053
+ :cache_attributes,
5054
+ :notification_policy)
4913
5055
  SENSITIVE = []
4914
5056
  include Aws::Structure
4915
5057
  end
@@ -5385,6 +5527,10 @@ module Aws::StorageGateway
5385
5527
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
5386
5528
  # @return [Boolean]
5387
5529
  #
5530
+ # @!attribute [rw] access_based_enumeration
5531
+ # Indicates whether `AccessBasedEnumeration` is enabled.
5532
+ # @return [Boolean]
5533
+ #
5388
5534
  # @!attribute [rw] admin_user_list
5389
5535
  # A list of users or groups in the Active Directory that have
5390
5536
  # administrator rights to the file share. A group must be prefixed
@@ -5448,6 +5594,10 @@ module Aws::StorageGateway
5448
5594
  # Refresh cache information.
5449
5595
  # @return [Types::CacheAttributes]
5450
5596
  #
5597
+ # @!attribute [rw] notification_policy
5598
+ # The notification policy of the file share.
5599
+ # @return [String]
5600
+ #
5451
5601
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SMBFileShareInfo AWS API Documentation
5452
5602
  #
5453
5603
  class SMBFileShareInfo < Struct.new(
@@ -5466,6 +5616,7 @@ module Aws::StorageGateway
5466
5616
  :guess_mime_type_enabled,
5467
5617
  :requester_pays,
5468
5618
  :smbacl_enabled,
5619
+ :access_based_enumeration,
5469
5620
  :admin_user_list,
5470
5621
  :valid_user_list,
5471
5622
  :invalid_user_list,
@@ -5474,7 +5625,8 @@ module Aws::StorageGateway
5474
5625
  :case_sensitivity,
5475
5626
  :tags,
5476
5627
  :file_share_name,
5477
- :cache_attributes)
5628
+ :cache_attributes,
5629
+ :notification_policy)
5478
5630
  SENSITIVE = []
5479
5631
  include Aws::Structure
5480
5632
  end
@@ -6268,6 +6420,59 @@ module Aws::StorageGateway
6268
6420
  include Aws::Structure
6269
6421
  end
6270
6422
 
6423
+ # @note When making an API call, you may pass UpdateBandwidthRateLimitScheduleInput
6424
+ # data as a hash:
6425
+ #
6426
+ # {
6427
+ # gateway_arn: "GatewayARN", # required
6428
+ # bandwidth_rate_limit_intervals: [ # required
6429
+ # {
6430
+ # start_hour_of_day: 1, # required
6431
+ # start_minute_of_hour: 1, # required
6432
+ # end_hour_of_day: 1, # required
6433
+ # end_minute_of_hour: 1, # required
6434
+ # days_of_week: [1], # required
6435
+ # average_upload_rate_limit_in_bits_per_sec: 1,
6436
+ # average_download_rate_limit_in_bits_per_sec: 1,
6437
+ # },
6438
+ # ],
6439
+ # }
6440
+ #
6441
+ # @!attribute [rw] gateway_arn
6442
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6443
+ # operation to return a list of gateways for your account and AWS
6444
+ # Region.
6445
+ # @return [String]
6446
+ #
6447
+ # @!attribute [rw] bandwidth_rate_limit_intervals
6448
+ # An array containing bandwidth rate limit schedule intervals for a
6449
+ # gateway. When no bandwidth rate limit intervals have been scheduled,
6450
+ # the array is empty.
6451
+ # @return [Array<Types::BandwidthRateLimitInterval>]
6452
+ #
6453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimitScheduleInput AWS API Documentation
6454
+ #
6455
+ class UpdateBandwidthRateLimitScheduleInput < Struct.new(
6456
+ :gateway_arn,
6457
+ :bandwidth_rate_limit_intervals)
6458
+ SENSITIVE = []
6459
+ include Aws::Structure
6460
+ end
6461
+
6462
+ # @!attribute [rw] gateway_arn
6463
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6464
+ # operation to return a list of gateways for your account and AWS
6465
+ # Region.
6466
+ # @return [String]
6467
+ #
6468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimitScheduleOutput AWS API Documentation
6469
+ #
6470
+ class UpdateBandwidthRateLimitScheduleOutput < Struct.new(
6471
+ :gateway_arn)
6472
+ SENSITIVE = []
6473
+ include Aws::Structure
6474
+ end
6475
+
6271
6476
  # A JSON object containing one or more of the following fields:
6272
6477
  #
6273
6478
  # * UpdateChapCredentialsInput$InitiatorName
@@ -6568,6 +6773,7 @@ module Aws::StorageGateway
6568
6773
  # cache_attributes: {
6569
6774
  # cache_stale_timeout_in_seconds: 1,
6570
6775
  # },
6776
+ # notification_policy: "NotificationPolicy",
6571
6777
  # }
6572
6778
  #
6573
6779
  # @!attribute [rw] file_share_arn
@@ -6670,6 +6876,10 @@ module Aws::StorageGateway
6670
6876
  # Refresh cache information.
6671
6877
  # @return [Types::CacheAttributes]
6672
6878
  #
6879
+ # @!attribute [rw] notification_policy
6880
+ # The notification policy of the file share.
6881
+ # @return [String]
6882
+ #
6673
6883
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShareInput AWS API Documentation
6674
6884
  #
6675
6885
  class UpdateNFSFileShareInput < Struct.new(
@@ -6685,7 +6895,8 @@ module Aws::StorageGateway
6685
6895
  :guess_mime_type_enabled,
6686
6896
  :requester_pays,
6687
6897
  :file_share_name,
6688
- :cache_attributes)
6898
+ :cache_attributes,
6899
+ :notification_policy)
6689
6900
  SENSITIVE = []
6690
6901
  include Aws::Structure
6691
6902
  end
@@ -6719,6 +6930,7 @@ module Aws::StorageGateway
6719
6930
  # guess_mime_type_enabled: false,
6720
6931
  # requester_pays: false,
6721
6932
  # smbacl_enabled: false,
6933
+ # access_based_enumeration: false,
6722
6934
  # admin_user_list: ["FileShareUser"],
6723
6935
  # valid_user_list: ["FileShareUser"],
6724
6936
  # invalid_user_list: ["FileShareUser"],
@@ -6728,6 +6940,7 @@ module Aws::StorageGateway
6728
6940
  # cache_attributes: {
6729
6941
  # cache_stale_timeout_in_seconds: 1,
6730
6942
  # },
6943
+ # notification_policy: "NotificationPolicy",
6731
6944
  # }
6732
6945
  #
6733
6946
  # @!attribute [rw] file_share_arn
@@ -6813,6 +7026,11 @@ module Aws::StorageGateway
6813
7026
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
6814
7027
  # @return [Boolean]
6815
7028
  #
7029
+ # @!attribute [rw] access_based_enumeration
7030
+ # The files and folders on this share will only be visible to users
7031
+ # with read access.
7032
+ # @return [Boolean]
7033
+ #
6816
7034
  # @!attribute [rw] admin_user_list
6817
7035
  # A list of users or groups in the Active Directory that have
6818
7036
  # administrator rights to the file share. A group must be prefixed
@@ -6862,6 +7080,10 @@ module Aws::StorageGateway
6862
7080
  # Refresh cache information.
6863
7081
  # @return [Types::CacheAttributes]
6864
7082
  #
7083
+ # @!attribute [rw] notification_policy
7084
+ # The notification policy of the file share.
7085
+ # @return [String]
7086
+ #
6865
7087
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareInput AWS API Documentation
6866
7088
  #
6867
7089
  class UpdateSMBFileShareInput < Struct.new(
@@ -6874,13 +7096,15 @@ module Aws::StorageGateway
6874
7096
  :guess_mime_type_enabled,
6875
7097
  :requester_pays,
6876
7098
  :smbacl_enabled,
7099
+ :access_based_enumeration,
6877
7100
  :admin_user_list,
6878
7101
  :valid_user_list,
6879
7102
  :invalid_user_list,
6880
7103
  :audit_destination_arn,
6881
7104
  :case_sensitivity,
6882
7105
  :file_share_name,
6883
- :cache_attributes)
7106
+ :cache_attributes,
7107
+ :notification_policy)
6884
7108
  SENSITIVE = []
6885
7109
  include Aws::Structure
6886
7110
  end
@@ -6899,6 +7123,47 @@ module Aws::StorageGateway
6899
7123
  include Aws::Structure
6900
7124
  end
6901
7125
 
7126
+ # @note When making an API call, you may pass UpdateSMBFileShareVisibilityInput
7127
+ # data as a hash:
7128
+ #
7129
+ # {
7130
+ # gateway_arn: "GatewayARN", # required
7131
+ # file_shares_visible: false, # required
7132
+ # }
7133
+ #
7134
+ # @!attribute [rw] gateway_arn
7135
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7136
+ # operation to return a list of gateways for your account and AWS
7137
+ # Region.
7138
+ # @return [String]
7139
+ #
7140
+ # @!attribute [rw] file_shares_visible
7141
+ # The shares on this gateway appear when listing shares.
7142
+ # @return [Boolean]
7143
+ #
7144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareVisibilityInput AWS API Documentation
7145
+ #
7146
+ class UpdateSMBFileShareVisibilityInput < Struct.new(
7147
+ :gateway_arn,
7148
+ :file_shares_visible)
7149
+ SENSITIVE = []
7150
+ include Aws::Structure
7151
+ end
7152
+
7153
+ # @!attribute [rw] gateway_arn
7154
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7155
+ # operation to return a list of gateways for your account and AWS
7156
+ # Region.
7157
+ # @return [String]
7158
+ #
7159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareVisibilityOutput AWS API Documentation
7160
+ #
7161
+ class UpdateSMBFileShareVisibilityOutput < Struct.new(
7162
+ :gateway_arn)
7163
+ SENSITIVE = []
7164
+ include Aws::Structure
7165
+ end
7166
+
6902
7167
  # @note When making an API call, you may pass UpdateSMBSecurityStrategyInput
6903
7168
  # data as a hash:
6904
7169
  #