aws_sdk_transfer/client/

test_connection.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`TestConnection`](crate::operation::test_connection::builders::TestConnectionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`connector_id(impl Into<String>)`](crate::operation::test_connection::builders::TestConnectionFluentBuilder::connector_id) / [`set_connector_id(Option<String>)`](crate::operation::test_connection::builders::TestConnectionFluentBuilder::set_connector_id):<br>required: **true**<br><p>The unique identifier for the connector.</p><br>
    /// - On success, responds with [`TestConnectionOutput`](crate::operation::test_connection::TestConnectionOutput) with field(s):
    ///   - [`connector_id(Option<String>)`](crate::operation::test_connection::TestConnectionOutput::connector_id): <p>Returns the identifier of the connector object that you are testing.</p>
    ///   - [`status(Option<String>)`](crate::operation::test_connection::TestConnectionOutput::status): <p>Returns <code>OK</code> for successful test, or <code>ERROR</code> if the test fails.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::test_connection::TestConnectionOutput::status_message): <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>
    ///   - [`sftp_connection_details(Option<SftpConnectorConnectionDetails>)`](crate::operation::test_connection::TestConnectionOutput::sftp_connection_details): <p>Structure that contains the SFTP connector host key.</p>
    /// - On failure, responds with [`SdkError<TestConnectionError>`](crate::operation::test_connection::TestConnectionError)
    pub fn test_connection(&self) -> crate::operation::test_connection::builders::TestConnectionFluentBuilder {
        crate::operation::test_connection::builders::TestConnectionFluentBuilder::new(self.handle.clone())
    }
}