Documentation updates for AWS Transfer Family

Author: aws-sdk-dotnet-automation

generator/ServiceModels/transfer/transfer-2018-11-05.docs.json

@@ -96,6 +96,12 @@ internal bool IsSetExternalId()
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -164,10 +170,20 @@ internal bool IsSetHomeDirectoryMappings()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
+        /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {

generator/ServiceModels/transfer/transfer-2018-11-05.normal.json

@@ -61,6 +61,12 @@ public partial class CreateUserRequest : AmazonTransferRequest
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -129,10 +135,20 @@ internal bool IsSetHomeDirectoryMappings()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
+        /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {

sdk/src/Services/Transfer/Generated/Model/CreateAccessRequest.cs

@@ -89,6 +89,12 @@ internal bool IsSetExternalId()
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -140,10 +146,20 @@ internal bool IsSetHomeDirectoryMappings()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
+        /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
         /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {

sdk/src/Services/Transfer/Generated/Model/CreateUserRequest.cs

@@ -74,6 +74,12 @@ internal bool IsSetArn()
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -125,10 +131,20 @@ internal bool IsSetHomeDirectoryMappings()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
+        /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
         /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {

sdk/src/Services/Transfer/Generated/Model/DescribedAccess.cs

@@ -29,8 +29,7 @@
 namespace Amazon.Transfer.Model
 {
     /// <summary>
-    /// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family
-    /// service.
+    /// This exception is thrown when an error occurs in the Transfer Family service.
     /// </summary>
     #if !NETSTANDARD
     [Serializable]

sdk/src/Services/Transfer/Generated/Model/DescribedUser.cs

@@ -62,9 +62,9 @@ internal bool IsSetMaxResults()
         /// <summary>
         /// Gets and sets the property NextToken. 
         /// <para>
-        /// When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code>
-        /// parameter is returned in the output. You can then pass in a subsequent command to
-        /// the <code>NextToken</code> parameter to continue listing additional users.
+        /// If there are additional results from the <code>ListUsers</code> call, a <code>NextToken</code>
+        /// parameter is returned in the output. You can then pass the <code>NextToken</code>
+        /// to a subsequent <code>ListUsers</code> command, to continue listing additional users.
         /// </para>
         /// </summary>
         [AWSProperty(Min=1, Max=6144)]

sdk/src/Services/Transfer/Generated/Model/InternalServiceErrorException.cs

@@ -86,6 +86,12 @@ internal bool IsSetExternalId()
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -105,10 +111,20 @@ internal bool IsSetHomeDirectory()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
+        /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
         /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {

sdk/src/Services/Transfer/Generated/Model/ListUsersRequest.cs

@@ -70,6 +70,12 @@ internal bool IsSetArn()
         /// <para>
         /// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
+        /// is set to <code>LOGICAL</code>.
+        /// </para>
+        ///  </note>
         /// </summary>
         [AWSProperty(Max=1024)]
         public string HomeDirectory
@@ -89,10 +95,20 @@ internal bool IsSetHomeDirectory()
         /// <para>
         /// 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 <code>PATH</code>, the user will
-        /// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
-        /// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
-        /// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
+        /// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
+        /// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
+        /// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
+        /// EFS paths visible to your users.
         /// </para>
+        ///  <note> 
+        /// <para>
+        /// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
+        /// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
+        /// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
+        /// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
+        /// in your template.
+        /// </para>
+        ///  </note>
         /// </summary>
         public HomeDirectoryType HomeDirectoryType
         {