|
25 | 25 | "errors":[
|
26 | 26 | {"shape":"ServiceUnavailableException"},
|
27 | 27 | {"shape":"InternalServiceError"},
|
28 |
| - {"shape":"InvalidRequestException"} |
| 28 | + {"shape":"InvalidRequestException"}, |
| 29 | + {"shape":"ResourceExistsException"} |
29 | 30 | ],
|
30 | 31 | "documentation":"<p>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the <code>ServerId</code> property assigned by the service to the newly created server. Reference this <code>ServerId</code> property when you make updates to your server, or work with users.</p> <p>The response returns the <code>ServerId</code> value for the newly created server.</p>"
|
31 | 32 | },
|
|
305 | 306 | "CreateServerRequest":{
|
306 | 307 | "type":"structure",
|
307 | 308 | "members":{
|
308 |
| - "EndpointDetails":{"shape":"EndpointDetails"}, |
309 |
| - "EndpointType":{"shape":"EndpointType"}, |
| 309 | + "EndpointDetails":{ |
| 310 | + "shape":"EndpointDetails", |
| 311 | + "documentation":"<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.</p>" |
| 312 | + }, |
| 313 | + "EndpointType":{ |
| 314 | + "shape":"EndpointType", |
| 315 | + "documentation":"<p>The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>" |
| 316 | + }, |
| 317 | + "HostKey":{ |
| 318 | + "shape":"HostKey", |
| 319 | + "documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code> command.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>" |
| 320 | + }, |
310 | 321 | "IdentityProviderDetails":{
|
311 | 322 | "shape":"IdentityProviderDetails",
|
312 | 323 | "documentation":"<p>An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the <code>IdentityProviderType</code> value of server that is created uses the <code>SERVICE_MANAGED</code> authentication method.</p>"
|
|
369 | 380 | },
|
370 | 381 | "UserName":{
|
371 | 382 | "shape":"UserName",
|
372 |
| - "documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>.</p>" |
| 383 | + "documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>" |
373 | 384 | }
|
374 | 385 | }
|
375 | 386 | },
|
|
502 | 513 | "shape":"Arn",
|
503 | 514 | "documentation":"<p>Specifies the unique Amazon Resource Name (ARN) for the server to be described.</p>"
|
504 | 515 | },
|
505 |
| - "EndpointDetails":{"shape":"EndpointDetails"}, |
506 |
| - "EndpointType":{"shape":"EndpointType"}, |
| 516 | + "EndpointDetails":{ |
| 517 | + "shape":"EndpointDetails", |
| 518 | + "documentation":"<p>The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.</p>" |
| 519 | + }, |
| 520 | + "EndpointType":{ |
| 521 | + "shape":"EndpointType", |
| 522 | + "documentation":"<p>The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>" |
| 523 | + }, |
| 524 | + "HostKeyFingerprint":{ |
| 525 | + "shape":"HostKeyFingerprint", |
| 526 | + "documentation":"<p>This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of <code>ssh-keygen -l -E md5 -f my-new-server-key</code> command.</p>" |
| 527 | + }, |
507 | 528 | "IdentityProviderDetails":{
|
508 | 529 | "shape":"IdentityProviderDetails",
|
509 | 530 | "documentation":"<p>Specifies information to call a customer-supplied authentication API. This field is not populated when the <code>IdentityProviderType</code> of the server is <code>SERVICE_MANAGED</code>>.</p>"
|
|
573 | 594 | "EndpointDetails":{
|
574 | 595 | "type":"structure",
|
575 | 596 | "members":{
|
576 |
| - "VpcEndpointId":{"shape":"VpcEndpointId"} |
577 |
| - } |
| 597 | + "VpcEndpointId":{ |
| 598 | + "shape":"VpcEndpointId", |
| 599 | + "documentation":"<p>The ID of the VPC endpoint.</p>" |
| 600 | + } |
| 601 | + }, |
| 602 | + "documentation":"<p>The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.</p>" |
578 | 603 | },
|
579 | 604 | "EndpointType":{
|
580 | 605 | "type":"string",
|
|
588 | 613 | "max":1024,
|
589 | 614 | "pattern":"^$|/.*"
|
590 | 615 | },
|
| 616 | + "HostKey":{ |
| 617 | + "type":"string", |
| 618 | + "max":4096 |
| 619 | + }, |
| 620 | + "HostKeyFingerprint":{"type":"string"}, |
591 | 621 | "IdentityProviderDetails":{
|
592 | 622 | "type":"structure",
|
593 | 623 | "members":{
|
|
796 | 826 | "shape":"IdentityProviderType",
|
797 | 827 | "documentation":"<p>The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>"
|
798 | 828 | },
|
799 |
| - "EndpointType":{"shape":"EndpointType"}, |
| 829 | + "EndpointType":{ |
| 830 | + "shape":"EndpointType", |
| 831 | + "documentation":"<p>The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.</p>" |
| 832 | + }, |
800 | 833 | "LoggingRole":{
|
801 | 834 | "shape":"Role",
|
802 | 835 | "documentation":"<p>The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.</p>"
|
|
1101 | 1134 | "type":"structure",
|
1102 | 1135 | "required":["ServerId"],
|
1103 | 1136 | "members":{
|
1104 |
| - "EndpointDetails":{"shape":"EndpointDetails"}, |
1105 |
| - "EndpointType":{"shape":"EndpointType"}, |
| 1137 | + "EndpointDetails":{ |
| 1138 | + "shape":"EndpointDetails", |
| 1139 | + "documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>" |
| 1140 | + }, |
| 1141 | + "EndpointType":{ |
| 1142 | + "shape":"EndpointType", |
| 1143 | + "documentation":"<p>The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet. </p>" |
| 1144 | + }, |
| 1145 | + "HostKey":{ |
| 1146 | + "shape":"HostKey", |
| 1147 | + "documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code>.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>" |
| 1148 | + }, |
1106 | 1149 | "IdentityProviderDetails":{
|
1107 | 1150 | "shape":"IdentityProviderDetails",
|
1108 | 1151 | "documentation":"<p>This response parameter is an array containing all of the information required to call a customer's authentication API method.</p>"
|
1109 | 1152 | },
|
1110 | 1153 | "LoggingRole":{
|
1111 | 1154 | "shape":"NullableRole",
|
1112 |
| - "documentation":"<p>Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>" |
| 1155 | + "documentation":"<p>A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>" |
1113 | 1156 | },
|
1114 | 1157 | "ServerId":{
|
1115 | 1158 | "shape":"ServerId",
|
|
1152 | 1195 | },
|
1153 | 1196 | "UserName":{
|
1154 | 1197 | "shape":"UserName",
|
1155 |
| - "documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server.</p>" |
| 1198 | + "documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>" |
1156 | 1199 | }
|
1157 | 1200 | }
|
1158 | 1201 | },
|
|
0 commit comments