Class: Aws::Transfer::Types::TestConnectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::TestConnectionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #connector_id ⇒ String

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

• #sftp_connection_details ⇒ Types::SftpConnectorConnectionDetails

  Structure that contains the SFTP connector host key.

• #status ⇒ String

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

• #status_message ⇒ String

  Returns ‘Connection succeeded` if the test is successful.

Instance Attribute Details

#connector_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 6140

class TestConnectionResponse < Struct.new(
  :connector_id,
  :status,
  :status_message,
  :sftp_connection_details)
  SENSITIVE = []
  include Aws::Structure
end

#sftp_connection_details ⇒ Types::SftpConnectorConnectionDetails

Structure that contains the SFTP connector host key.

Returns:

• (Types::SftpConnectorConnectionDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 6140

class TestConnectionResponse < Struct.new(
  :connector_id,
  :status,
  :status_message,
  :sftp_connection_details)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 6140

class TestConnectionResponse < Struct.new(
  :connector_id,
  :status,
  :status_message,
  :sftp_connection_details)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 6140

class TestConnectionResponse < Struct.new(
  :connector_id,
  :status,
  :status_message,
  :sftp_connection_details)
  SENSITIVE = []
  include Aws::Structure
end