aws-sdk-fsx 1.15.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 2d65127593453505228eb4ab9b59682baa219fed
4
- data.tar.gz: 2f87a84ed601fbd98f151fa7722a171a0ced2058
2
+ SHA256:
3
+ metadata.gz: 672f464f9df3f4a8e5cf72931c1d35904616c38fe7a251a10634fb9b9e2b07c2
4
+ data.tar.gz: f45d7c865658096307178b18dc0e2fe997ffe2b0c83037d5c12fe0a355605b75
5
5
  SHA512:
6
- metadata.gz: 04bc0f9a48aabc9f7e246ef86604d8cd4ffbb1b8209bf85e8e6371da38a8f226be6aa60da20e80cae3a5de7b18102fb5c35b0f4d605567dd8b9ff9164452dffe
7
- data.tar.gz: 1d4d4c2de67e5dbc7415a077fc548b043ccd73d42676814aa6896eecfbde16bd7c4c64182df2f983fa4e041266e34a5de56fcb1f6a78c5498d563e9dbd86a5fe
6
+ metadata.gz: 8c5a21f95bf10c55f586ad145bf0b2605c21dafde4a4ca11666474f7165aadd3a03761b90d833d8a8c523a472bf988614b03076d5cd4ff7ecd4e98b5ccc0a5ae
7
+ data.tar.gz: 9feaaeb1e29b525b7af4be116c6704001e2f88eef349f38f9cf442529404f4ca59412a97ce665307d406cadc1bb7cc5d46352c56b02a0b427c39430c81aa2020
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-fsx/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # f_sx = Aws::FSx::Client.new
28
+ # resp = f_sx.cancel_data_repository_task(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon FSx all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon FSx are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::FSx::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon FSx API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-fsx/customizations'
42
45
  # @service
43
46
  module Aws::FSx
44
47
 
45
- GEM_VERSION = '1.15.0'
48
+ GEM_VERSION = '1.20.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:fsx)
31
31
 
32
32
  module Aws::FSx
33
+ # An API client for FSx. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::FSx::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::FSx
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::FSx
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::FSx
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::FSx
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::FSx
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::FSx
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::FSx
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::FSx
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::FSx
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -434,6 +488,7 @@ module Aws::FSx
434
488
  # resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
435
489
  # resp.backup.file_system.failure_details.message #=> String
436
490
  # resp.backup.file_system.storage_capacity #=> Integer
491
+ # resp.backup.file_system.storage_type #=> String, one of "SSD", "HDD"
437
492
  # resp.backup.file_system.vpc_id #=> String
438
493
  # resp.backup.file_system.subnet_ids #=> Array
439
494
  # resp.backup.file_system.subnet_ids[0] #=> String
@@ -452,7 +507,7 @@ module Aws::FSx
452
507
  # resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
453
508
  # resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
454
509
  # resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
455
- # resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
510
+ # resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
456
511
  # resp.backup.file_system.windows_configuration.remote_administration_endpoint #=> String
457
512
  # resp.backup.file_system.windows_configuration.preferred_subnet_id #=> String
458
513
  # resp.backup.file_system.windows_configuration.preferred_file_server_ip #=> String
@@ -470,6 +525,13 @@ module Aws::FSx
470
525
  # resp.backup.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
471
526
  # resp.backup.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
472
527
  # resp.backup.file_system.lustre_configuration.mount_name #=> String
528
+ # resp.backup.file_system.administrative_actions #=> Array
529
+ # resp.backup.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
530
+ # resp.backup.file_system.administrative_actions[0].progress_percent #=> Integer
531
+ # resp.backup.file_system.administrative_actions[0].request_time #=> Time
532
+ # resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
533
+ # resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
534
+ # resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
473
535
  # resp.backup.directory_information.domain_name #=> String
474
536
  # resp.backup.directory_information.active_directory_id #=> String
475
537
  #
@@ -491,13 +553,13 @@ module Aws::FSx
491
553
  # `CreateDataRepositoryTask` operation will fail if a data repository is
492
554
  # not linked to the FSx file system. To learn more about data repository
493
555
  # tasks, see [Using Data Repository Tasks][1]. To learn more about
494
- # linking a data repository to your file system, see [Step 1: Create
495
- # Your Amazon FSx for Lustre File System][2].
556
+ # linking a data repository to your file system, see [Setting the Export
557
+ # Prefix][2].
496
558
  #
497
559
  #
498
560
  #
499
561
  # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html
500
- # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/getting-started-step1.html
562
+ # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repository.html#export-prefix
501
563
  #
502
564
  # @option params [required, String] :type
503
565
  # Specifies the type of data repository task to create.
@@ -505,7 +567,11 @@ module Aws::FSx
505
567
  # @option params [Array<String>] :paths
506
568
  # (Optional) The path or paths on the Amazon FSx file system to use when
507
569
  # the data repository task is processed. The default path is the file
508
- # system root directory.
570
+ # system root directory. The paths you provide need to be relative to
571
+ # the mount point of the file system. If the mount point is `/mnt/fsx`
572
+ # and `/mnt/fsx/path1` is a directory or file on the file system you
573
+ # want to export, then the path to provide is `path1`. If a path that
574
+ # you provide isn't valid, the task fails.
509
575
  #
510
576
  # @option params [required, String] :file_system_id
511
577
  # The globally unique ID of the file system, assigned by Amazon FSx.
@@ -514,7 +580,12 @@ module Aws::FSx
514
580
  # Defines whether or not Amazon FSx provides a CompletionReport once the
515
581
  # task has completed. A CompletionReport provides a detailed report on
516
582
  # the files that Amazon FSx processed that meet the criteria specified
517
- # by the `Scope` parameter.
583
+ # by the `Scope` parameter. For more information, see [Working with Task
584
+ # Completion Reports][1].
585
+ #
586
+ #
587
+ #
588
+ # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html
518
589
  #
519
590
  # @option params [String] :client_request_token
520
591
  # (Optional) An idempotency token for resource creation, in a string of
@@ -635,14 +706,39 @@ module Aws::FSx
635
706
  # `LUSTRE`.
636
707
  #
637
708
  # @option params [required, Integer] :storage_capacity
638
- # The storage capacity of the file system being created.
709
+ # Sets the storage capacity of the file system that you're creating.
710
+ #
711
+ # For Lustre file systems:
712
+ #
713
+ # * For `SCRATCH_2` and `PERSISTENT_1` deployment types, valid values
714
+ # are 1.2, 2.4, and increments of 2.4 TiB.
639
715
  #
640
- # For Windows file systems, valid values are 32 GiB - 65,536 GiB.
716
+ # * For `SCRATCH_1` deployment type, valid values are 1.2, 2.4, and
717
+ # increments of 3.6 TiB.
641
718
  #
642
- # For `SCRATCH_1` Lustre file systems, valid values are 1,200, 2,400,
643
- # 3,600, then continuing in increments of 3600 GiB. For `SCRATCH_2` and
644
- # `PERSISTENT_1` file systems, valid values are 1200, 2400, then
645
- # continuing in increments of 2400 GiB.
719
+ # For Windows file systems:
720
+ #
721
+ # * If `StorageType=SSD`, valid values are 32 GiB - 65,536 GiB (64 TiB).
722
+ #
723
+ # * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64
724
+ # TiB).
725
+ #
726
+ # @option params [String] :storage_type
727
+ # Sets the storage type for the Amazon FSx for Windows file system
728
+ # you're creating. Valid values are `SSD` and `HDD`.
729
+ #
730
+ # * Set to `SSD` to use solid state drive storage. SSD is supported on
731
+ # all Windows deployment types.
732
+ #
733
+ # * Set to `HDD` to use hard disk drive storage. HDD is supported on
734
+ # `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types.
735
+ #
736
+ # Default value is `SSD`. For more information, see [ Storage Type
737
+ # Options][1] in the *Amazon FSx for Windows User Guide*.
738
+ #
739
+ #
740
+ #
741
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options
646
742
  #
647
743
  # @option params [required, Array<String>] :subnet_ids
648
744
  # Specifies the IDs of the subnets that the file system will be
@@ -652,9 +748,9 @@ module Aws::FSx
652
748
  # subnets as the preferred subnet using the `WindowsConfiguration >
653
749
  # PreferredSubnetID` property.
654
750
  #
655
- # For Windows `SINGLE_AZ_1` file system deployment types and Lustre file
656
- # systems, provide exactly one subnet ID. The file server is launched in
657
- # that subnet's Availability Zone.
751
+ # For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
752
+ # types and Lustre file systems, provide exactly one subnet ID. The file
753
+ # server is launched in that subnet's Availability Zone.
658
754
  #
659
755
  # @option params [Array<String>] :security_group_ids
660
756
  # A list of IDs specifying the security groups to apply to all network
@@ -681,11 +777,9 @@ module Aws::FSx
681
777
  #
682
778
  # @option params [Types::CreateFileSystemWindowsConfiguration] :windows_configuration
683
779
  # The Microsoft Windows configuration for the file system being created.
684
- # This value is required if `FileSystemType` is set to `WINDOWS`.
685
780
  #
686
781
  # @option params [Types::CreateFileSystemLustreConfiguration] :lustre_configuration
687
- # The Lustre configuration for the file system being created. This value
688
- # is required if `FileSystemType` is set to `LUSTRE`.
782
+ # The Lustre configuration for the file system being created.
689
783
  #
690
784
  # @return [Types::CreateFileSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
691
785
  #
@@ -759,6 +853,7 @@ module Aws::FSx
759
853
  # client_request_token: "ClientRequestToken",
760
854
  # file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
761
855
  # storage_capacity: 1, # required
856
+ # storage_type: "SSD", # accepts SSD, HDD
762
857
  # subnet_ids: ["SubnetId"], # required
763
858
  # security_group_ids: ["SecurityGroupId"],
764
859
  # tags: [
@@ -778,7 +873,7 @@ module Aws::FSx
778
873
  # password: "DirectoryPassword", # required
779
874
  # dns_ips: ["IpAddress"], # required
780
875
  # },
781
- # deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1
876
+ # deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
782
877
  # preferred_subnet_id: "SubnetId",
783
878
  # throughput_capacity: 1, # required
784
879
  # weekly_maintenance_start_time: "WeeklyTime",
@@ -805,6 +900,7 @@ module Aws::FSx
805
900
  # resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
806
901
  # resp.file_system.failure_details.message #=> String
807
902
  # resp.file_system.storage_capacity #=> Integer
903
+ # resp.file_system.storage_type #=> String, one of "SSD", "HDD"
808
904
  # resp.file_system.vpc_id #=> String
809
905
  # resp.file_system.subnet_ids #=> Array
810
906
  # resp.file_system.subnet_ids[0] #=> String
@@ -823,7 +919,7 @@ module Aws::FSx
823
919
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
824
920
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
825
921
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
826
- # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
922
+ # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
827
923
  # resp.file_system.windows_configuration.remote_administration_endpoint #=> String
828
924
  # resp.file_system.windows_configuration.preferred_subnet_id #=> String
829
925
  # resp.file_system.windows_configuration.preferred_file_server_ip #=> String
@@ -841,6 +937,13 @@ module Aws::FSx
841
937
  # resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
842
938
  # resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
843
939
  # resp.file_system.lustre_configuration.mount_name #=> String
940
+ # resp.file_system.administrative_actions #=> Array
941
+ # resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
942
+ # resp.file_system.administrative_actions[0].progress_percent #=> Integer
943
+ # resp.file_system.administrative_actions[0].request_time #=> Time
944
+ # resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
945
+ # resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
946
+ # resp.file_system.administrative_actions[0].failure_details.message #=> String
844
947
  #
845
948
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystem AWS API Documentation
846
949
  #
@@ -902,15 +1005,22 @@ module Aws::FSx
902
1005
  # not need to pass this option.**
903
1006
  #
904
1007
  # @option params [required, Array<String>] :subnet_ids
905
- # A list of IDs for the subnets that the file system will be accessible
906
- # from. Currently, you can specify only one subnet. The file server is
907
- # also launched in that subnet's Availability Zone.
1008
+ # Specifies the IDs of the subnets that the file system will be
1009
+ # accessible from. For Windows `MULTI_AZ_1` file system deployment
1010
+ # types, provide exactly two subnet IDs, one for the preferred file
1011
+ # server and one for the standby file server. You specify one of these
1012
+ # subnets as the preferred subnet using the `WindowsConfiguration >
1013
+ # PreferredSubnetID` property.
1014
+ #
1015
+ # For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types and
1016
+ # Lustre file systems, provide exactly one subnet ID. The file server is
1017
+ # launched in that subnet's Availability Zone.
908
1018
  #
909
1019
  # @option params [Array<String>] :security_group_ids
910
1020
  # A list of IDs for the security groups that apply to the specified
911
1021
  # network interfaces created for file system access. These security
912
1022
  # groups apply to all network interfaces. This value isn't returned in
913
- # later describe requests.
1023
+ # later DescribeFileSystem requests.
914
1024
  #
915
1025
  # @option params [Array<Types::Tag>] :tags
916
1026
  # The tags to be applied to the file system at file system creation. The
@@ -920,6 +1030,27 @@ module Aws::FSx
920
1030
  # @option params [Types::CreateFileSystemWindowsConfiguration] :windows_configuration
921
1031
  # The configuration for this Microsoft Windows file system.
922
1032
  #
1033
+ # @option params [String] :storage_type
1034
+ # Sets the storage type for the Windows file system you're creating
1035
+ # from a backup. Valid values are `SSD` and `HDD`.
1036
+ #
1037
+ # * Set to `SSD` to use solid state drive storage. Supported on all
1038
+ # Windows deployment types.
1039
+ #
1040
+ # * Set to `HDD` to use hard disk drive storage. Supported on
1041
+ # `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types.
1042
+ #
1043
+ # Default value is `SSD`.
1044
+ #
1045
+ # <note markdown="1"> HDD and SSD storage types have different minimum storage capacity
1046
+ # requirements. A restored file system's storage capacity is tied to
1047
+ # the file system that was backed up. You can create a file system that
1048
+ # uses HDD storage from a backup of a file system that used SSD storage
1049
+ # only if the original SSD file system had a storage capacity of at
1050
+ # least 2000 GiB.
1051
+ #
1052
+ # </note>
1053
+ #
923
1054
  # @return [Types::CreateFileSystemFromBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
924
1055
  #
925
1056
  # * {Types::CreateFileSystemFromBackupResponse#file_system #file_system} => Types::FileSystem
@@ -1003,7 +1134,7 @@ module Aws::FSx
1003
1134
  # password: "DirectoryPassword", # required
1004
1135
  # dns_ips: ["IpAddress"], # required
1005
1136
  # },
1006
- # deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1
1137
+ # deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
1007
1138
  # preferred_subnet_id: "SubnetId",
1008
1139
  # throughput_capacity: 1, # required
1009
1140
  # weekly_maintenance_start_time: "WeeklyTime",
@@ -1011,6 +1142,7 @@ module Aws::FSx
1011
1142
  # automatic_backup_retention_days: 1,
1012
1143
  # copy_tags_to_backups: false,
1013
1144
  # },
1145
+ # storage_type: "SSD", # accepts SSD, HDD
1014
1146
  # })
1015
1147
  #
1016
1148
  # @example Response structure
@@ -1022,6 +1154,7 @@ module Aws::FSx
1022
1154
  # resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
1023
1155
  # resp.file_system.failure_details.message #=> String
1024
1156
  # resp.file_system.storage_capacity #=> Integer
1157
+ # resp.file_system.storage_type #=> String, one of "SSD", "HDD"
1025
1158
  # resp.file_system.vpc_id #=> String
1026
1159
  # resp.file_system.subnet_ids #=> Array
1027
1160
  # resp.file_system.subnet_ids[0] #=> String
@@ -1040,7 +1173,7 @@ module Aws::FSx
1040
1173
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
1041
1174
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
1042
1175
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
1043
- # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
1176
+ # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
1044
1177
  # resp.file_system.windows_configuration.remote_administration_endpoint #=> String
1045
1178
  # resp.file_system.windows_configuration.preferred_subnet_id #=> String
1046
1179
  # resp.file_system.windows_configuration.preferred_file_server_ip #=> String
@@ -1058,6 +1191,13 @@ module Aws::FSx
1058
1191
  # resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
1059
1192
  # resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
1060
1193
  # resp.file_system.lustre_configuration.mount_name #=> String
1194
+ # resp.file_system.administrative_actions #=> Array
1195
+ # resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
1196
+ # resp.file_system.administrative_actions[0].progress_percent #=> Integer
1197
+ # resp.file_system.administrative_actions[0].request_time #=> Time
1198
+ # resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
1199
+ # resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
1200
+ # resp.file_system.administrative_actions[0].failure_details.message #=> String
1061
1201
  #
1062
1202
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup AWS API Documentation
1063
1203
  #
@@ -1278,6 +1418,8 @@ module Aws::FSx
1278
1418
  # * {Types::DescribeBackupsResponse#backups #backups} => Array&lt;Types::Backup&gt;
1279
1419
  # * {Types::DescribeBackupsResponse#next_token #next_token} => String
1280
1420
  #
1421
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1422
+ #
1281
1423
  #
1282
1424
  # @example Example: To describe Amazon FSx backups
1283
1425
  #
@@ -1351,6 +1493,7 @@ module Aws::FSx
1351
1493
  # resp.backups[0].file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
1352
1494
  # resp.backups[0].file_system.failure_details.message #=> String
1353
1495
  # resp.backups[0].file_system.storage_capacity #=> Integer
1496
+ # resp.backups[0].file_system.storage_type #=> String, one of "SSD", "HDD"
1354
1497
  # resp.backups[0].file_system.vpc_id #=> String
1355
1498
  # resp.backups[0].file_system.subnet_ids #=> Array
1356
1499
  # resp.backups[0].file_system.subnet_ids[0] #=> String
@@ -1369,7 +1512,7 @@ module Aws::FSx
1369
1512
  # resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
1370
1513
  # resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
1371
1514
  # resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
1372
- # resp.backups[0].file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
1515
+ # resp.backups[0].file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
1373
1516
  # resp.backups[0].file_system.windows_configuration.remote_administration_endpoint #=> String
1374
1517
  # resp.backups[0].file_system.windows_configuration.preferred_subnet_id #=> String
1375
1518
  # resp.backups[0].file_system.windows_configuration.preferred_file_server_ip #=> String
@@ -1387,6 +1530,13 @@ module Aws::FSx
1387
1530
  # resp.backups[0].file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
1388
1531
  # resp.backups[0].file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
1389
1532
  # resp.backups[0].file_system.lustre_configuration.mount_name #=> String
1533
+ # resp.backups[0].file_system.administrative_actions #=> Array
1534
+ # resp.backups[0].file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
1535
+ # resp.backups[0].file_system.administrative_actions[0].progress_percent #=> Integer
1536
+ # resp.backups[0].file_system.administrative_actions[0].request_time #=> Time
1537
+ # resp.backups[0].file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
1538
+ # resp.backups[0].file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
1539
+ # resp.backups[0].file_system.administrative_actions[0].failure_details.message #=> String
1390
1540
  # resp.backups[0].directory_information.domain_name #=> String
1391
1541
  # resp.backups[0].directory_information.active_directory_id #=> String
1392
1542
  # resp.next_token #=> String
@@ -1439,6 +1589,8 @@ module Aws::FSx
1439
1589
  # * {Types::DescribeDataRepositoryTasksResponse#data_repository_tasks #data_repository_tasks} => Array&lt;Types::DataRepositoryTask&gt;
1440
1590
  # * {Types::DescribeDataRepositoryTasksResponse#next_token #next_token} => String
1441
1591
  #
1592
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1593
+ #
1442
1594
  # @example Request syntax with placeholder values
1443
1595
  #
1444
1596
  # resp = client.describe_data_repository_tasks({
@@ -1537,6 +1689,8 @@ module Aws::FSx
1537
1689
  # * {Types::DescribeFileSystemsResponse#file_systems #file_systems} => Array&lt;Types::FileSystem&gt;
1538
1690
  # * {Types::DescribeFileSystemsResponse#next_token #next_token} => String
1539
1691
  #
1692
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1693
+ #
1540
1694
  #
1541
1695
  # @example Example: To describe an Amazon FSx file system
1542
1696
  #
@@ -1599,6 +1753,7 @@ module Aws::FSx
1599
1753
  # resp.file_systems[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
1600
1754
  # resp.file_systems[0].failure_details.message #=> String
1601
1755
  # resp.file_systems[0].storage_capacity #=> Integer
1756
+ # resp.file_systems[0].storage_type #=> String, one of "SSD", "HDD"
1602
1757
  # resp.file_systems[0].vpc_id #=> String
1603
1758
  # resp.file_systems[0].subnet_ids #=> Array
1604
1759
  # resp.file_systems[0].subnet_ids[0] #=> String
@@ -1617,7 +1772,7 @@ module Aws::FSx
1617
1772
  # resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.user_name #=> String
1618
1773
  # resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
1619
1774
  # resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
1620
- # resp.file_systems[0].windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
1775
+ # resp.file_systems[0].windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
1621
1776
  # resp.file_systems[0].windows_configuration.remote_administration_endpoint #=> String
1622
1777
  # resp.file_systems[0].windows_configuration.preferred_subnet_id #=> String
1623
1778
  # resp.file_systems[0].windows_configuration.preferred_file_server_ip #=> String
@@ -1635,6 +1790,13 @@ module Aws::FSx
1635
1790
  # resp.file_systems[0].lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
1636
1791
  # resp.file_systems[0].lustre_configuration.per_unit_storage_throughput #=> Integer
1637
1792
  # resp.file_systems[0].lustre_configuration.mount_name #=> String
1793
+ # resp.file_systems[0].administrative_actions #=> Array
1794
+ # resp.file_systems[0].administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
1795
+ # resp.file_systems[0].administrative_actions[0].progress_percent #=> Integer
1796
+ # resp.file_systems[0].administrative_actions[0].request_time #=> Time
1797
+ # resp.file_systems[0].administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
1798
+ # resp.file_systems[0].administrative_actions[0].target_file_system_values #=> Types::FileSystem
1799
+ # resp.file_systems[0].administrative_actions[0].failure_details.message #=> String
1638
1800
  # resp.next_token #=> String
1639
1801
  #
1640
1802
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystems AWS API Documentation
@@ -1820,24 +1982,54 @@ module Aws::FSx
1820
1982
  req.send_request(options)
1821
1983
  end
1822
1984
 
1823
- # Updates a file system configuration.
1985
+ # Use this operation to update the configuration of an existing Amazon
1986
+ # FSx file system. For an Amazon FSx for Lustre file system, you can
1987
+ # update only the WeeklyMaintenanceStartTime. For an Amazon for Windows
1988
+ # File Server file system, you can update the following properties:
1989
+ #
1990
+ # * AutomaticBackupRetentionDays
1991
+ #
1992
+ # * DailyAutomaticBackupStartTime
1993
+ #
1994
+ # * SelfManagedActiveDirectoryConfiguration
1995
+ #
1996
+ # * StorageCapacity
1997
+ #
1998
+ # * ThroughputCapacity
1999
+ #
2000
+ # * WeeklyMaintenanceStartTime
2001
+ #
2002
+ # You can update multiple properties in a single request.
1824
2003
  #
1825
2004
  # @option params [required, String] :file_system_id
1826
- # The globally unique ID of the file system, assigned by Amazon FSx.
2005
+ # Identifies the file system that you are updating.
1827
2006
  #
1828
2007
  # @option params [String] :client_request_token
1829
- # (Optional) A string of up to 64 ASCII characters that Amazon FSx uses
1830
- # to ensure idempotent updates. This string is automatically filled on
1831
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
1832
- # an AWS SDK.
2008
+ # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
2009
+ # idempotent updates. This string is automatically filled on your behalf
2010
+ # when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
1833
2011
  #
1834
2012
  # **A suitable default value is auto-generated.** You should normally
1835
2013
  # not need to pass this option.**
1836
2014
  #
2015
+ # @option params [Integer] :storage_capacity
2016
+ # Use this parameter to increase the storage capacity of an Amazon FSx
2017
+ # for Windows File Server file system. Specifies the storage capacity
2018
+ # target value, GiB, for the file system you're updating. The storage
2019
+ # capacity target value must be at least 10 percent (%) greater than the
2020
+ # current storage capacity value. In order to increase storage capacity,
2021
+ # the file system needs to have at least 16 MB/s of throughput capacity.
2022
+ # You cannot make a storage capacity increase request if there is an
2023
+ # existing storage capacity increase request in progress. For more
2024
+ # information, see [Managing Storage Capacity][1].
2025
+ #
2026
+ #
2027
+ #
2028
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
2029
+ #
1837
2030
  # @option params [Types::UpdateFileSystemWindowsConfiguration] :windows_configuration
1838
- # The configuration update for this Microsoft Windows file system. The
1839
- # only supported options are for backup and maintenance and for
1840
- # self-managed Active Directory configuration.
2031
+ # The configuration updates for an Amazon FSx for Windows File Server
2032
+ # file system.
1841
2033
  #
1842
2034
  # @option params [Types::UpdateFileSystemLustreConfiguration] :lustre_configuration
1843
2035
  # The configuration object for Amazon FSx for Lustre file systems used
@@ -1896,10 +2088,12 @@ module Aws::FSx
1896
2088
  # resp = client.update_file_system({
1897
2089
  # file_system_id: "FileSystemId", # required
1898
2090
  # client_request_token: "ClientRequestToken",
2091
+ # storage_capacity: 1,
1899
2092
  # windows_configuration: {
1900
2093
  # weekly_maintenance_start_time: "WeeklyTime",
1901
2094
  # daily_automatic_backup_start_time: "DailyTime",
1902
2095
  # automatic_backup_retention_days: 1,
2096
+ # throughput_capacity: 1,
1903
2097
  # self_managed_active_directory_configuration: {
1904
2098
  # user_name: "DirectoryUserName",
1905
2099
  # password: "DirectoryPassword",
@@ -1920,6 +2114,7 @@ module Aws::FSx
1920
2114
  # resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
1921
2115
  # resp.file_system.failure_details.message #=> String
1922
2116
  # resp.file_system.storage_capacity #=> Integer
2117
+ # resp.file_system.storage_type #=> String, one of "SSD", "HDD"
1923
2118
  # resp.file_system.vpc_id #=> String
1924
2119
  # resp.file_system.subnet_ids #=> Array
1925
2120
  # resp.file_system.subnet_ids[0] #=> String
@@ -1938,7 +2133,7 @@ module Aws::FSx
1938
2133
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
1939
2134
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
1940
2135
  # resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
1941
- # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
2136
+ # resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
1942
2137
  # resp.file_system.windows_configuration.remote_administration_endpoint #=> String
1943
2138
  # resp.file_system.windows_configuration.preferred_subnet_id #=> String
1944
2139
  # resp.file_system.windows_configuration.preferred_file_server_ip #=> String
@@ -1956,6 +2151,13 @@ module Aws::FSx
1956
2151
  # resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
1957
2152
  # resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
1958
2153
  # resp.file_system.lustre_configuration.mount_name #=> String
2154
+ # resp.file_system.administrative_actions #=> Array
2155
+ # resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
2156
+ # resp.file_system.administrative_actions[0].progress_percent #=> Integer
2157
+ # resp.file_system.administrative_actions[0].request_time #=> Time
2158
+ # resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
2159
+ # resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
2160
+ # resp.file_system.administrative_actions[0].failure_details.message #=> String
1959
2161
  #
1960
2162
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystem AWS API Documentation
1961
2163
  #
@@ -1979,7 +2181,7 @@ module Aws::FSx
1979
2181
  params: params,
1980
2182
  config: config)
1981
2183
  context[:gem_name] = 'aws-sdk-fsx'
1982
- context[:gem_version] = '1.15.0'
2184
+ context[:gem_version] = '1.20.0'
1983
2185
  Seahorse::Client::Request.new(handlers, context)
1984
2186
  end
1985
2187