|
4478 | 4478 | "DIRECTORY" |
4479 | 4479 | ] |
4480 | 4480 | }, |
| 4481 | + "MaxConcurrentConnections":{ |
| 4482 | + "type":"integer", |
| 4483 | + "documentation":"<p>The number of concurrent connections that the connector will create to the remote server.</p>", |
| 4484 | + "box":true, |
| 4485 | + "min":1 |
| 4486 | + }, |
4481 | 4487 | "MaxItems":{ |
4482 | 4488 | "type":"integer", |
4483 | 4489 | "box":true, |
|
4979 | 4985 | "members":{ |
4980 | 4986 | "UserSecretId":{ |
4981 | 4987 | "shape":"SecretId", |
4982 | | - "documentation":"<p>The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.</p>" |
| 4988 | + "documentation":"<p>The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.</p> <note> <ul> <li> <p>Required when creating an SFTP connector</p> </li> <li> <p>Optional when updating an existing SFTP connector</p> </li> </ul> </note>" |
4983 | 4989 | }, |
4984 | 4990 | "TrustedHostKeys":{ |
4985 | 4991 | "shape":"SftpConnectorTrustedHostKeyList", |
4986 | | - "documentation":"<p>The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the <code>ssh-keyscan</code> command against the SFTP server to retrieve the necessary key.</p> <p>The three standard SSH public key format elements are <code><key type></code>, <code><body base64></code>, and an optional <code><comment></code>, with spaces between each element. Specify only the <code><key type></code> and <code><body base64></code>: do not enter the <code><comment></code> portion of the key.</p> <p>For the trusted host key, Transfer Family accepts RSA and ECDSA keys.</p> <ul> <li> <p>For RSA keys, the <code><key type></code> string is <code>ssh-rsa</code>.</p> </li> <li> <p>For ECDSA keys, the <code><key type></code> string is either <code>ecdsa-sha2-nistp256</code>, <code>ecdsa-sha2-nistp384</code>, or <code>ecdsa-sha2-nistp521</code>, depending on the size of the key you generated.</p> </li> </ul> <p>Run this command to retrieve the SFTP server host key, where your SFTP server name is <code>ftp.host.com</code>.</p> <p> <code>ssh-keyscan ftp.host.com</code> </p> <p>This prints the public host key to standard output.</p> <p> <code>ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key</code> </p> <p>Copy and paste this string into the <code>TrustedHostKeys</code> field for the <code>create-connector</code> command or into the <b>Trusted host keys</b> field in the console.</p>" |
| 4992 | + "documentation":"<p>The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the <code>ssh-keyscan</code> command against the SFTP server to retrieve the necessary key.</p> <note> <p> <code>TrustedHostKeys</code> is optional for <code>CreateConnector</code>. If not provided, you can use <code>TestConnection</code> to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key.</p> </note> <p>The three standard SSH public key format elements are <code><key type></code>, <code><body base64></code>, and an optional <code><comment></code>, with spaces between each element. Specify only the <code><key type></code> and <code><body base64></code>: do not enter the <code><comment></code> portion of the key.</p> <p>For the trusted host key, Transfer Family accepts RSA and ECDSA keys.</p> <ul> <li> <p>For RSA keys, the <code><key type></code> string is <code>ssh-rsa</code>.</p> </li> <li> <p>For ECDSA keys, the <code><key type></code> string is either <code>ecdsa-sha2-nistp256</code>, <code>ecdsa-sha2-nistp384</code>, or <code>ecdsa-sha2-nistp521</code>, depending on the size of the key you generated.</p> </li> </ul> <p>Run this command to retrieve the SFTP server host key, where your SFTP server name is <code>ftp.host.com</code>.</p> <p> <code>ssh-keyscan ftp.host.com</code> </p> <p>This prints the public host key to standard output.</p> <p> <code>ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key</code> </p> <p>Copy and paste this string into the <code>TrustedHostKeys</code> field for the <code>create-connector</code> command or into the <b>Trusted host keys</b> field in the console.</p>" |
| 4993 | + }, |
| 4994 | + "MaxConcurrentConnections":{ |
| 4995 | + "shape":"MaxConcurrentConnections", |
| 4996 | + "documentation":"<p>Specify the number of concurrent connections that your connector creates to the remote server. The default value is <code>5</code> (this is also the maximum value allowed).</p> <p>This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.</p>" |
| 4997 | + } |
| 4998 | + }, |
| 4999 | + "documentation":"<p>Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.</p>" |
| 5000 | + }, |
| 5001 | + "SftpConnectorConnectionDetails":{ |
| 5002 | + "type":"structure", |
| 5003 | + "members":{ |
| 5004 | + "HostKey":{ |
| 5005 | + "shape":"SftpConnectorHostKey", |
| 5006 | + "documentation":"<p>The SSH public key of the remote SFTP server. This is returned during the initial connection attempt when you call <code>TestConnection</code>. It allows you to retrieve the valid server host key to update the connector when you are unable to obtain it in advance.</p>" |
4987 | 5007 | } |
4988 | 5008 | }, |
4989 | | - "documentation":"<p>Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.</p> <note> <p>Because the <code>SftpConnectorConfig</code> data type is used for both creating and updating SFTP connectors, its parameters, <code>TrustedHostKeys</code> and <code>UserSecretId</code> are marked as not required. This is a bit misleading, as they are not required when you are updating an existing SFTP connector, but <i>are required</i> when you are creating a new SFTP connector.</p> </note>" |
| 5009 | + "documentation":"<p>Contains the details for an SFTP connector connection.</p>" |
| 5010 | + }, |
| 5011 | + "SftpConnectorHostKey":{ |
| 5012 | + "type":"string", |
| 5013 | + "max":2048, |
| 5014 | + "min":1 |
4990 | 5015 | }, |
4991 | 5016 | "SftpConnectorTrustedHostKey":{ |
4992 | 5017 | "type":"string", |
|
4997 | 5022 | "type":"list", |
4998 | 5023 | "member":{"shape":"SftpConnectorTrustedHostKey"}, |
4999 | 5024 | "max":10, |
5000 | | - "min":1 |
| 5025 | + "min":0 |
5001 | 5026 | }, |
5002 | 5027 | "SigningAlg":{ |
5003 | 5028 | "type":"string", |
|
5353 | 5378 | "StatusMessage":{ |
5354 | 5379 | "shape":"Message", |
5355 | 5380 | "documentation":"<p>Returns <code>Connection succeeded</code> if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.</p> <ul> <li> <p>Verify that your secret name aligns with the one in Transfer Role permissions.</p> </li> <li> <p>Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.</p> </li> <li> <p>Verify that the secret exists and is formatted correctly.</p> </li> <li> <p>Verify that the trusted host key in the connector configuration matches the <code>ssh-keyscan</code> output.</p> </li> </ul>" |
| 5381 | + }, |
| 5382 | + "SftpConnectionDetails":{ |
| 5383 | + "shape":"SftpConnectorConnectionDetails", |
| 5384 | + "documentation":"<p>Structure that contains the SFTP connector host key.</p>" |
5356 | 5385 | } |
5357 | 5386 | } |
5358 | 5387 | }, |
|
0 commit comments