TestConnection - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

TestConnection

Testet, ob Ihr SFTP Connector erfolgreich eingerichtet wurde. Es wird dringend empfohlen, diesen Vorgang aufzurufen, um zu testen, ob Sie Dateien zwischen dem lokalen AWS Speicher und dem SFTP Server eines Handelspartners übertragen können.

Anforderungssyntax

{
   "ConnectorId": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

ConnectorId

Die eindeutige Kennung für den Konnektor.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: c-([0-9a-f]{17})

Erforderlich: Ja

Antwortsyntax

{
   "ConnectorId": "string",
   "Status": "string",
   "StatusMessage": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

ConnectorId

Gibt den Bezeichner des Connector-Objekts zurück, das Sie testen.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: c-([0-9a-f]{17})

Status

Wird zurückgegebenOK, wenn der Test erfolgreich war oder ERROR wenn der Test fehlschlägt.

Typ: Zeichenfolge

StatusMessage

Gibt zurückConnection succeeded, ob der Test erfolgreich war. Oder gibt eine beschreibende Fehlermeldung zurück, wenn der Test fehlschlägt. Die folgende Liste enthält je nach der Fehlermeldung, die Sie erhalten, Einzelheiten zur Problembehandlung.

  • Vergewissern Sie sich, dass Ihr geheimer Name mit dem Namen in den Berechtigungen für die Übertragung von Rollen übereinstimmt.

  • Überprüfen Sie den Server URL in der Connector-Konfiguration und stellen Sie sicher, dass die Anmeldeinformationen außerhalb des Connectors erfolgreich funktionieren.

  • Stellen Sie sicher, dass der geheime Schlüssel existiert und richtig formatiert ist.

  • Stellen Sie sicher, dass der vertrauenswürdige Hostschlüssel in der Connectorkonfiguration mit der ssh-keyscan Ausgabe übereinstimmt.

Typ: Zeichenfolge

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, weil der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

Beispiele

Beispiel

Das folgende Beispiel testet die Verbindung zu einem Remoteserver.

aws transfer test-connection --connector-id c-abcd1234567890fff

Beispielantwort

Bei Erfolg gibt der API Aufruf die folgenden Details zurück.

{                                                                                                                                                             
    "Status": "OK",                                                                                                                                           
    "StatusMessage": "Connection succeeded"                                                                                                                   
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: