翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartFileTransfer
ローカル AWS ストレージとリモート AS2 または SFTP サーバー間のファイル転送を開始します。
-
AS2 コネクタでは、転送するファイルを識別するために
ConnectorIdと 1 つ以上のSendFilePathsを指定します。 -
SFTP コネクタの場合、ファイル転送はアウトバウンドでもインバウンドでもかまいません。いずれの場合も、
ConnectorIdを指定します。転送方向に応じて、次の項目も指定します。-
パートナーの SFTP サーバーから Amazon Web Services ストレージにファイルを転送する場合は、転送するファイルを識別するために 1 つ以上の
RetrieveFilePathsを指定し、宛先フォルダを指定するLocalDirectoryPathを指定します。 -
AWS ストレージからパートナーの SFTP サーバーにファイルを転送する場合は、転送するファイルを識別するために 1 つ以上の
SendFilePathsを指定し、宛先フォルダを指定するRemoteDirectoryPathを指定します。
-
リクエストの構文
{
"ConnectorId": "string",
"LocalDirectoryPath": "string",
"RemoteDirectoryPath": "string",
"RetrieveFilePaths": [ "string" ],
"SendFilePaths": [ "string" ]
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ConnectorId
-
コネクタの一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
c-([0-9a-f]{17})必須：はい
- LocalDirectoryPath
-
インバウンド転送の場合、
LocaDirectoryPathはパートナーの SFTP サーバーから転送される 1 つ以上のファイルの宛先を指定します。型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
(.)+必須: いいえ
- RemoteDirectoryPath
-
アウトバウンド転送の場合、
RemoteDirectoryPathはパートナーの SFTP サーバーに転送される 1 つ以上のファイルの宛先を指定します。RemoteDirectoryPathを指定しない場合、ファイルの送信先は SFTP ユーザーのホームディレクトリです。型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
(.)+必須: いいえ
- RetrieveFilePaths
-
パートナーの SFTP サーバーの 1 つ以上のソースパス。各文字列は、1 回のインバウンドファイル転送のソースファイルパスを表します。
タイプ：文字列の配列
配列メンバー：最小数は 1 項目です。最大数は 10 項目です。
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
(.)+必須: いいえ
- SendFilePaths
-
Amazon S3 ストレージの 1 つ以上のソースパス。各文字列は、1 回のアウトバウンドファイル転送のソースファイルパスを表します。例えば
DOC-EXAMPLE-BUCKET/myfile.txtです。注記
DOC-EXAMPLE-BUCKETを実際のバケットの 1 つに置き換えてください。タイプ：文字列の配列
配列メンバー：最小数は 1 項目です。最大数は 10 項目です。
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
(.)+必須: いいえ
レスポンスの構文
{
"TransferId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- TransferId
-
ファイル転送の一意の識別子を返します。
型: 文字列
長さの制限：最小長は 1 です。最大長は 512 です。
パターン：
[0-9a-zA-Z./-]+
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
例
例
次の例では、Transfer Family サーバーからリモートの取引相手のエンドポイントへの AS2 ファイル転送を開始します。
DOC-EXAMPLE-BUCKET
を実際のバケットの 1 つに置き換えてください。
リクエスト例
{
"ConnectorId": "c-AAAA1111BBBB2222C",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
]
}レスポンス例
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}例
次の例では、ローカル AWS ストレージからリモート SFTP サーバーへのファイル転送を開始します。
リクエスト例
{
"ConnectorId": "c-01234567890abcdef",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
],
"RemoteDirectoryPath": "/MySFTPRootFolder/fromTranferFamilyServer"
}レスポンス例
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}例
次の例では、リモート SFTP サーバーからローカル AWS ストレージへのファイル転送を開始します。
リクエスト例
{
"ConnectorId": "c-111122223333AAAAA",
"RetrieveFilePaths": [
"/MySFTPFolder/toTranferFamily/myfile-1.txt",
"/MySFTPFolder/toTranferFamily/myfile-2.txt",
"/MySFTPFolder/toTranferFamily/myfile-3.txt"
],
"LocalDirectoryPath": "/DOC-EXAMPLE-BUCKET/mySourceFiles"
}レスポンス例
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa"
}その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
