Skip to content

Commit 1aff6a6

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Documentation updates for AWS Transfer Family
1 parent 29cc470 commit 1aff6a6

22 files changed

+894
-1142
lines changed

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

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

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

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ internal bool IsSetExternalId()
9696
/// <para>
9797
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
9898
/// </para>
99+
/// <note>
100+
/// <para>
101+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
102+
/// is set to <code>LOGICAL</code>.
103+
/// </para>
104+
/// </note>
99105
/// </summary>
100106
[AWSProperty(Max=1024)]
101107
public string HomeDirectory
@@ -164,10 +170,20 @@ internal bool IsSetHomeDirectoryMappings()
164170
/// <para>
165171
/// The type of landing directory (folder) that you want your users' home directory to
166172
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
167-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
168-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
169-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
173+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
174+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
175+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
176+
/// EFS paths visible to your users.
170177
/// </para>
178+
/// <note>
179+
/// <para>
180+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
181+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
182+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
183+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
184+
/// in your template.
185+
/// </para>
186+
/// </note>
171187
/// </summary>
172188
public HomeDirectoryType HomeDirectoryType
173189
{

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ public partial class CreateUserRequest : AmazonTransferRequest
6161
/// <para>
6262
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
6363
/// </para>
64+
/// <note>
65+
/// <para>
66+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
67+
/// is set to <code>LOGICAL</code>.
68+
/// </para>
69+
/// </note>
6470
/// </summary>
6571
[AWSProperty(Max=1024)]
6672
public string HomeDirectory
@@ -129,10 +135,20 @@ internal bool IsSetHomeDirectoryMappings()
129135
/// <para>
130136
/// The type of landing directory (folder) that you want your users' home directory to
131137
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
132-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
133-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
134-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
138+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
139+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
140+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
141+
/// EFS paths visible to your users.
135142
/// </para>
143+
/// <note>
144+
/// <para>
145+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
146+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
147+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
148+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
149+
/// in your template.
150+
/// </para>
151+
/// </note>
136152
/// </summary>
137153
public HomeDirectoryType HomeDirectoryType
138154
{

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ internal bool IsSetExternalId()
8989
/// <para>
9090
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
9191
/// </para>
92+
/// <note>
93+
/// <para>
94+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
95+
/// is set to <code>LOGICAL</code>.
96+
/// </para>
97+
/// </note>
9298
/// </summary>
9399
[AWSProperty(Max=1024)]
94100
public string HomeDirectory
@@ -140,10 +146,20 @@ internal bool IsSetHomeDirectoryMappings()
140146
/// <para>
141147
/// The type of landing directory (folder) that you want your users' home directory to
142148
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
143-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
144-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
145-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
149+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
150+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
151+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
152+
/// EFS paths visible to your users.
153+
/// </para>
154+
/// <note>
155+
/// <para>
156+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
157+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
158+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
159+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
160+
/// in your template.
146161
/// </para>
162+
/// </note>
147163
/// </summary>
148164
public HomeDirectoryType HomeDirectoryType
149165
{

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ internal bool IsSetArn()
7474
/// <para>
7575
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
7676
/// </para>
77+
/// <note>
78+
/// <para>
79+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
80+
/// is set to <code>LOGICAL</code>.
81+
/// </para>
82+
/// </note>
7783
/// </summary>
7884
[AWSProperty(Max=1024)]
7985
public string HomeDirectory
@@ -125,10 +131,20 @@ internal bool IsSetHomeDirectoryMappings()
125131
/// <para>
126132
/// The type of landing directory (folder) that you want your users' home directory to
127133
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
128-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
129-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
130-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
134+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
135+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
136+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
137+
/// EFS paths visible to your users.
138+
/// </para>
139+
/// <note>
140+
/// <para>
141+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
142+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
143+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
144+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
145+
/// in your template.
131146
/// </para>
147+
/// </note>
132148
/// </summary>
133149
public HomeDirectoryType HomeDirectoryType
134150
{

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929
namespace Amazon.Transfer.Model
3030
{
3131
/// <summary>
32-
/// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family
33-
/// service.
32+
/// This exception is thrown when an error occurs in the Transfer Family service.
3433
/// </summary>
3534
#if !NETSTANDARD
3635
[Serializable]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ internal bool IsSetMaxResults()
6262
/// <summary>
6363
/// Gets and sets the property NextToken.
6464
/// <para>
65-
/// When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code>
66-
/// parameter is returned in the output. You can then pass in a subsequent command to
67-
/// the <code>NextToken</code> parameter to continue listing additional users.
65+
/// If there are additional results from the <code>ListUsers</code> call, a <code>NextToken</code>
66+
/// parameter is returned in the output. You can then pass the <code>NextToken</code>
67+
/// to a subsequent <code>ListUsers</code> command, to continue listing additional users.
6868
/// </para>
6969
/// </summary>
7070
[AWSProperty(Min=1, Max=6144)]

‎sdk/src/Services/Transfer/Generated/Model/ListedAccess.cs

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,12 @@ internal bool IsSetExternalId()
8686
/// <para>
8787
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
8888
/// </para>
89+
/// <note>
90+
/// <para>
91+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
92+
/// is set to <code>LOGICAL</code>.
93+
/// </para>
94+
/// </note>
8995
/// </summary>
9096
[AWSProperty(Max=1024)]
9197
public string HomeDirectory
@@ -105,10 +111,20 @@ internal bool IsSetHomeDirectory()
105111
/// <para>
106112
/// The type of landing directory (folder) that you want your users' home directory to
107113
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
108-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
109-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
110-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
114+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
115+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
116+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
117+
/// EFS paths visible to your users.
118+
/// </para>
119+
/// <note>
120+
/// <para>
121+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
122+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
123+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
124+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
125+
/// in your template.
111126
/// </para>
127+
/// </note>
112128
/// </summary>
113129
public HomeDirectoryType HomeDirectoryType
114130
{

‎sdk/src/Services/Transfer/Generated/Model/ListedUser.cs

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ internal bool IsSetArn()
7070
/// <para>
7171
/// A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.
7272
/// </para>
73+
/// <note>
74+
/// <para>
75+
/// The <code>HomeDirectory</code> parameter is only used if <code>HomeDirectoryType</code>
76+
/// is set to <code>LOGICAL</code>.
77+
/// </para>
78+
/// </note>
7379
/// </summary>
7480
[AWSProperty(Max=1024)]
7581
public string HomeDirectory
@@ -89,10 +95,20 @@ internal bool IsSetHomeDirectory()
8995
/// <para>
9096
/// The type of landing directory (folder) that you want your users' home directory to
9197
/// be when they log in to the server. If you set it to <code>PATH</code>, the user will
92-
/// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
93-
/// clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code>
94-
/// for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
98+
/// see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
99+
/// protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings
100+
/// in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon
101+
/// EFS paths visible to your users.
95102
/// </para>
103+
/// <note>
104+
/// <para>
105+
/// If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings,
106+
/// using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code>
107+
/// is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code>
108+
/// parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code>
109+
/// in your template.
110+
/// </para>
111+
/// </note>
96112
/// </summary>
97113
public HomeDirectoryType HomeDirectoryType
98114
{

0 commit comments

Comments
 (0)