Module Values.TestConnectionResponseSource

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.

Sourcetype nonrec t = {
  1. connectorId : ConnectorId.t option;
    (*

    Returns the identifier of the connector object that you are testing.

    *)
  2. status : Status.t option;
    (*

    Returns OK for successful test, or ERROR if the test fails.

    *)
  3. statusMessage : Message.t option;
    (*

    Returns Connection succeeded 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. Verify that your secret name aligns with the one in Transfer Role permissions. Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector. Verify that the secret exists and is formatted correctly. Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

    *)
  4. sftpConnectionDetails : SftpConnectorConnectionDetails.t option;
    (*

    Structure that contains the SFTP connector host key.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceError of InternalServiceError.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ServiceUnavailableException of ServiceUnavailableException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?connectorId:??? -> ?status:??? -> ?statusMessage:??? -> ?sftpConnectionDetails:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceError of InternalServiceError.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ServiceUnavailableException of ServiceUnavailableException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceError of InternalServiceError.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ServiceUnavailableException of ServiceUnavailableException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of ConnectorId.t | `Structure of (string * [> `String of SftpConnectorHostKey.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t