software.amazon.awssdk.services.transfer.model

Interface TestConnectionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>, SdkBuilder<TestConnectionResponse.Builder,TestConnectionResponse>, SdkPojo, SdkResponse.Builder, TransferResponse.Builder

Enclosing class:

TestConnectionResponse

public static interface TestConnectionResponse.Builder
extends TransferResponse.Builder, SdkPojo, CopyableBuilder<TestConnectionResponse.Builder,TestConnectionResponse>

Method Summary

Modifier and Type	Method and Description
TestConnectionResponse.Builder	connectorId(String connectorId) Returns the identifier of the connector object that you are testing.
TestConnectionResponse.Builder	status(String status) Returns OK for successful test, or ERROR if the test fails.
TestConnectionResponse.Builder	statusMessage(String statusMessage) Returns Connection succeeded if the test is successful.

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

connectorId

TestConnectionResponse.Builder connectorId(String connectorId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

TestConnectionResponse.Builder status(String status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

statusMessage

TestConnectionResponse.Builder statusMessage(String statusMessage)

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

• Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.

• Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

• Private key not found: Verify that the secret exists and is formatted correctly.

• Invalid trusted host keys: Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

Parameters:

statusMessage - Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

• Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.

• Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

• Private key not found: Verify that the secret exists and is formatted correctly.

• Invalid trusted host keys: Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

Returns:

Returns a reference to this object so that method calls can be chained together.