client.rb in aws-sdk-transfer-1.80.0

- old
+ new

@@ -410,19 +410,32 @@
     #   The landing directory (folder) for a user when they log in to the
     #   server using the client.
     #
     #   A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
     #
+    #   <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
+    #   set to `LOGICAL`.
+    #
+    #    </note>
+    #
     # @option params [String] :home_directory_type
     #   The type of landing directory (folder) that you want your users' home
     #   directory to be when they log in to the server. If you set it to
-    #   `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
-    #   as is in their file transfer protocol clients. If you set it
+    #   `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
+    #   path as is in their file transfer protocol clients. If you set it to
     #   `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
     #   for how you want to make Amazon S3 or Amazon EFS paths visible to your
     #   users.
     #
+    #   <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
+    #   the `HomeDirectoryMappings` parameter. If, on the other hand,
+    #   `HomeDirectoryType` is `PATH`, you provide an absolute path using the
+    #   `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
+    #   `HomeDirectoryMappings` in your template.
+    #
+    #    </note>
+    #
     # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
     #   Logical directory mappings that specify what Amazon S3 or Amazon EFS
     #   paths and keys should be visible to your user and how you want to make
     #   them visible. You must specify the `Entry` and `Target` pair, where
     #   `Entry` shows how the path is made visible and `Target` is the actual
@@ -1203,19 +1216,32 @@
     #   The landing directory (folder) for a user when they log in to the
     #   server using the client.
     #
     #   A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
     #
+    #   <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
+    #   set to `LOGICAL`.
+    #
+    #    </note>
+    #
     # @option params [String] :home_directory_type
     #   The type of landing directory (folder) that you want your users' home
     #   directory to be when they log in to the server. If you set it to
-    #   `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
-    #   as is in their file transfer protocol clients. If you set it
+    #   `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
+    #   path as is in their file transfer protocol clients. If you set it to
     #   `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
     #   for how you want to make Amazon S3 or Amazon EFS paths visible to your
     #   users.
     #
+    #   <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
+    #   the `HomeDirectoryMappings` parameter. If, on the other hand,
+    #   `HomeDirectoryType` is `PATH`, you provide an absolute path using the
+    #   `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
+    #   `HomeDirectoryMappings` in your template.
+    #
+    #    </note>
+    #
     # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
     #   Logical directory mappings that specify what Amazon S3 or Amazon EFS
     #   paths and keys should be visible to your user and how you want to make
     #   them visible. You must specify the `Entry` and `Target` pair, where
     #   `Entry` shows how the path is made visible and `Target` is the actual
@@ -3159,13 +3185,13 @@
     # @option params [Integer] :max_results
     #   Specifies the number of users to return as a response to the
     #   `ListUsers` request.
     #
     # @option params [String] :next_token
-    #   When you can get additional results from the `ListUsers` call, a
-    #   `NextToken` parameter is returned in the output. You can then pass in
-    #   a subsequent command to the `NextToken` parameter to continue listing
+    #   If there are additional results from the `ListUsers` call, a
+    #   `NextToken` parameter is returned in the output. You can then pass the
+    #   `NextToken` to a subsequent `ListUsers` command, to continue listing
     #   additional users.
     #
     # @option params [required, String] :server_id
     #   A system-assigned unique identifier for a server that has users
     #   assigned to it.
@@ -3469,11 +3495,11 @@
       req.send_request(options)
     end
 
     # Tests whether your SFTP connector is set up successfully. We highly
     # recommend that you call this operation to test your ability to
-    # transfer files between a Transfer Family server and a trading
+    # transfer files between local Amazon Web Services storage and a trading
     # partner's SFTP server.
     #
     # @option params [required, String] :connector_id
     #   The unique identifier for the connector.
     #
@@ -3647,19 +3673,32 @@
     #   The landing directory (folder) for a user when they log in to the
     #   server using the client.
     #
     #   A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
     #
+    #   <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
+    #   set to `LOGICAL`.
+    #
+    #    </note>
+    #
     # @option params [String] :home_directory_type
     #   The type of landing directory (folder) that you want your users' home
     #   directory to be when they log in to the server. If you set it to
-    #   `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
-    #   as is in their file transfer protocol clients. If you set it
+    #   `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
+    #   path as is in their file transfer protocol clients. If you set it to
     #   `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
     #   for how you want to make Amazon S3 or Amazon EFS paths visible to your
     #   users.
     #
+    #   <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
+    #   the `HomeDirectoryMappings` parameter. If, on the other hand,
+    #   `HomeDirectoryType` is `PATH`, you provide an absolute path using the
+    #   `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
+    #   `HomeDirectoryMappings` in your template.
+    #
+    #    </note>
+    #
     # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
     #   Logical directory mappings that specify what Amazon S3 or Amazon EFS
     #   paths and keys should be visible to your user and how you want to make
     #   them visible. You must specify the `Entry` and `Target` pair, where
     #   `Entry` shows how the path is made visible and `Target` is the actual
@@ -4431,19 +4470,32 @@
     #   The landing directory (folder) for a user when they log in to the
     #   server using the client.
     #
     #   A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
     #
+    #   <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
+    #   set to `LOGICAL`.
+    #
+    #    </note>
+    #
     # @option params [String] :home_directory_type
     #   The type of landing directory (folder) that you want your users' home
     #   directory to be when they log in to the server. If you set it to
-    #   `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
-    #   as is in their file transfer protocol clients. If you set it
+    #   `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
+    #   path as is in their file transfer protocol clients. If you set it to
     #   `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
     #   for how you want to make Amazon S3 or Amazon EFS paths visible to your
     #   users.
     #
+    #   <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
+    #   the `HomeDirectoryMappings` parameter. If, on the other hand,
+    #   `HomeDirectoryType` is `PATH`, you provide an absolute path using the
+    #   `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
+    #   `HomeDirectoryMappings` in your template.
+    #
+    #    </note>
+    #
     # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
     #   Logical directory mappings that specify what Amazon S3 or Amazon EFS
     #   paths and keys should be visible to your user and how you want to make
     #   them visible. You must specify the `Entry` and `Target` pair, where
     #   `Entry` shows how the path is made visible and `Target` is the actual
@@ -4576,10 +4628,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.79.0'
+      context[:gem_version] = '1.80.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # Polls an API operation until a resource enters a desired state.
     #