翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
TestConnection
SFTP コネクタが正常にセットアップされているかどうかをテストします。このオペレーションを呼び出して、ローカル AWS ストレージと取引相手の SFTP サーバー間でファイルを転送できるかどうかをテストすることを強くお勧めします。
リクエストの構文
{
"ConnectorId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ConnectorId
-
コネクタの一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
c-([0-9a-f]{17})必須：はい
レスポンスの構文
{
"ConnectorId": "string",
"Status": "string",
"StatusMessage": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ConnectorId
-
テストしているコネクタオブジェクトの識別子を返します。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
c-([0-9a-f]{17}) - Status
-
テストに成功した場合は
OKを、テストに失敗した場合はERRORを返します。型: 文字列
- StatusMessage
-
テストが成功した場合は
Connection succeededを返します。または、テストが失敗した場合は説明的なエラーメッセージを返します。以下のリストは、表示されるエラーメッセージに応じて、トラブルシューティングの詳細を示しています。-
シークレット名がロールの転送権限のシークレット名と一致していることを確認します。
-
コネクタ構成内のサーバー URL を確認し、ログイン認証情報がコネクタ外でも正常に機能することを確認します。
-
シークレットが存在し、正しい形式になっていることを確認します。
-
コネクタ設定のトラステッドホストキーが
ssh-keyscan出力と一致することを確認します。
型: 文字列
-
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
例
例
次の例では、リモートサーバーへの接続をテストします。
aws transfer test-connection --connector-id c-abcd1234567890fff
レスポンス例
API コールが成功すると、以下の詳細が返されます。
{ "Status": "OK", "StatusMessage": "Connection succeeded" }
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
