Transfer Family イベント詳細リファレンス - AWS Transfer Family
サーバーイベントコネクタイベントAS2 イベント

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Transfer Family イベント詳細リファレンス

AWS サービスからのすべてのイベントには、イベントに関するメタデータを含む共通のフィールドセットがあります。これらのメタデータには、イベントのソースである AWS サービス、イベントが生成された時刻、イベントが発生したアカウントとリージョンなどが含まれます。これらの一般的なフィールドの定義については、「Amazon EventBridge ユーザーガイド」の「イベント構造リファレンス」を参照してください。

さらに、各イベントには、その特定のイベントに固有のデータを含む detail フィールドがあります。次のリファレンスでは、さまざまな Transfer Family イベントの詳細フィールドを定義します。

EventBridge を使用して Transfer Family イベントを選択および管理する場合は、次の点を考慮してください。

  • からのすべてのイベントの sourceフィールド Transfer Family は に設定されますaws.transfer。

  • detail-type フィールドはイベントタイプを指定します。

    例えば FTP File Server Download Completed です。

  • detail フィールドには、その特定のイベントに固有のデータが含まれます。

Transfer Family イベントに一致するようにルールを有効化するイベントパターンの作成方法については、「Amazon EventBridge ユーザーガイド」の「Amazon EventBridge のイベントパターン」を参照してください。

イベントとその EventBridge 処理方法の詳細については、「 Amazon EventBridge ユーザーガイド」の「 Amazon EventBridge イベント」を参照してください。

SFTP、FTPS、および FTP サーバーイベント

SFTP、FTPS、および FTP サーバーイベントの詳細フィールドは次のとおりです。

  • FTP ファイルサーバーのダウンロードが完了しました

  • FTP ファイルサーバーのダウンロードに失敗しました

  • FTP ファイルサーバーのアップロードが完了しました

  • FTP ファイルサーバーのアップロードに失敗しました

  • FTPS ファイルサーバーのダウンロードが完了しました

  • FTPS ファイルサーバーのダウンロードに失敗しました

  • FTPS ファイルサーバーのアップロードが完了しました

  • FTPS ファイルサーバーのアップロードに失敗しました

  • SFTP サーバーファイルのダウンロードが完了しました

  • SFTP サーバーファイルのダウンロードに失敗しました

  • SFTP サーバーファイルのアップロードが完了しました

  • SFTP サーバーファイルのアップロードに失敗しました

source および detail-typeフィールドには、 Transfer Family イベントの特定の値が含まれているため、以下が含まれます。すべてのイベントに含まれる他のメタデータフィールドの定義については、「 ユーザーガイド」の「イベント構造のリファレンスAmazon EventBridge 」を参照してください。

{
  . . .,
  "detail-type": "string",
  "source": "aws.transfer",
  . . .,
  "detail": {
    "failure-code" : "string",
    "status-code" : "string",
    "protocol" : "string",
    "bytes" : "number",
    "client-ip" : "string",
    "failure-message" : "string",
    "end-timestamp" : "string",
    "etag" : "string",
    "file-path" : "string",
    "server-id" : "string",
    "username" : "string",
    "session-id" : "string",
    "start-timestamp" : "string"
  }
}
detail-type

イベントのタイプを示します。

このイベントの場合、値は前述の SFTP、FTPS、または FTP サーバーイベント名のいずれかです。

source

イベントを発生させたサービスを識別します。Transfer Family イベントの場合、この値は ですaws.transfer。

detail

イベントに関する情報を含む JSON オブジェクト。このフィールドの内容は、イベントを生成するサービスによって決まります。

このイベントでは、データには以下が含まれます。

failure-code

転送が失敗した理由のカテゴリ。値: PARTIAL_UPLOAD | PARTIAL_DOWNLOAD | UNKNOWN_ERROR

status-code

転送が成功したかどうか。値: COMPLETED | FAILED。

protocol

転送に使用されるプロトコル。値: SFTP | FTPS | FTP

bytes

転送バイト数。

client-ip

転送に関係するクライアントの IP アドレス

failure-message

失敗した転送の場合、転送が失敗した理由の詳細。

end-timestamp

転送が成功した場合、ファイルの処理が終了する時刻のタイムスタンプ。

etag

エンティティタグ (Amazon S3 ファイルにのみ使用されます）。

file-path

転送されるファイルへのパス。

server-id

Transfer Family サーバーの一意の ID。

username

転送を実行しているユーザー。

session-id

転送セッションの一意の識別子。

start-timestamp

転送が成功した場合、ファイル処理が開始される時刻のタイムスタンプ。

例 SFTP サーバーファイルのダウンロード失敗サンプルイベント

次の例は、SFTP サーバー (使用されているストレージAmazon EFS ) でダウンロードが失敗するイベントを示しています。

{
    "version": "0",
    "id": "event-ID",
    "detail-type": "SFTP Server File Download Failed",
    "source": "aws.transfer",
    "account": "958412138249",
    "time": "2024-01-29T17:20:27Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:transfer:us-east-1:958412138249:server/s-1234abcd5678efghi"
    ],
    "detail": {
        "failure-code": "PARTIAL_DOWNLOAD",
        "status-code": "FAILED",
        "protocol": "SFTP",
        "bytes": 4100,
        "client-ip": "IP-address",
        "failure-message": "File was partially downloaded.",
        "end-timestamp": "2024-01-29T17:20:27.749749117Z",
        "file-path": "/fs-1234abcd5678efghi/user0/test-file",
        "server-id": "s-1234abcd5678efghi",
        "username": "test",
        "session-id": "session-ID",
        "start-timestamp": "2024-01-29T17:20:16.706282454Z"
    }
}
例 FTP ファイルサーバーのアップロード完了サンプルイベント

次の例は、FTP サーバー (使用されているストレージAmazon S3 ) でアップロードが正常に完了したイベントを示しています。

{
    "version": "0",
    "id": "event-ID",
    "detail-type": "FTP Server File Upload Completed",
    "source": "aws.transfer",
    "account": "958412138249",
    "time": "2024-01-29T16:31:43Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:transfer:us-east-1:958412138249:server/s-1111aaaa2222bbbb3"
    ],
    "detail": {
        "status-code": "COMPLETED",
        "protocol": "FTP",
        "bytes": 1048576,
        "client-ip": "10.0.0.141",
        "end-timestamp": "2024-01-29T16:31:43.311866408Z",
        "etag": "b6d81b360a5672d80c27430f39153e2c",
        "file-path": "/DOC-EXAMPLE-BUCKET/test/1mb_file",
        "server-id": "s-1111aaaa2222bbbb3",
        "username": "test",
        "session-id": "event-ID",
        "start-timestamp": "2024-01-29T16:31:42.462088327Z"
    }
}

SFTP コネクタイベント

SFTP コネクタイベントの詳細フィールドは次のとおりです。

  • SFTP コネクタファイルの送信が完了しました

  • SFTP コネクタファイルの送信に失敗しました

  • SFTP コネクタファイルの取得が完了しました

  • SFTP コネクタファイルの取得に失敗しました

  • SFTP コネクタディレクトリの一覧表示が完了しました

  • SFTP コネクタディレクトリの一覧表示に失敗しました

source および detail-typeフィールドには、 Transfer Family イベントの特定の値が含まれているため、以下が含まれます。すべてのイベントに含まれる他のメタデータフィールドの定義については、「 ユーザーガイド」の「イベント構造のリファレンスAmazon EventBridge 」を参照してください。

{
  . . .,
  "detail-type": "string",
  "source": "aws.transfer",
  . . .,
  "detail": {
    "operation" : "string",
    "max-items" : "number",
    "connector-id" : "string",
    "output-directory-path" : "string",
    "listing-id" : "string",
    "transfer-id" : "string",
    "file-transfer-id" : "string",
    "url" : "string",
    "file-path" : "string",
    "status-code" : "string",
    "failure-code" : "string",
    "failure-message" : "string",
    "start-timestamp" : "string",
    "end-timestamp" : "string",
    "local-directory-path" : "string",
    "remote-directory-path" : "string"
    "item-count" : "number"
    "truncated" : "boolean"
    "bytes" : "number",
    "local-file-location" : {
      "domain" : "string",
      "bucket" : "string",
      "key" : "string"
    },
    "output-file-location" : {
      "domain" : "string",
      "bucket" : "string",
      "key" : "string"
    }
  }
}
detail-type

イベントのタイプを示します。

このイベントの場合、値は前述の SFTP コネクタイベント名の 1 つです。

source

イベントを発生させたサービスを識別します。イベントの場合 Transfer Family 、この値は ですaws.transfer。

detail

イベントに関する情報を含む JSON オブジェクト。イベントを生成するサービスによって、このフィールドの内容が決まります。

このイベントでは、データには以下が含まれます。

max-items

返されるディレクトリ/ファイル名の最大数。

operation

StartFileTransfer リクエストがファイルを送信または取得するかどうか。値: SEND|RETRIEVE。

connector-id

使用されている SFTP コネクタの一意の識別子。

output-directory-path

ファイル/ディレクトリのリストの結果を保存する Amazon S3 のパス (バケットとプレフィックス）。

listing-id

StartDirectoryListing API コールの一意の識別子。この識別子を使用して、 CloudWatch ログをチェックし、リストリクエストのステータスを確認できます。

transfer-id

転送イベント (StartFileTransferリクエスト) の一意の識別子。

file-transfer-id

転送されるファイルの一意の識別子。

url

パートナーの AS2 または SFTP エンドポイントの URL。

file-path

送信または取得される場所とファイル。

status-code

転送が成功したかどうか。値: FAILED | COMPLETED。

failure-code

失敗した転送の場合、転送が失敗した理由の理由コード。

failure-message

失敗した転送の場合、転送が失敗した理由の詳細。

start-timestamp

転送が成功した場合、ファイル処理が開始される時刻のタイムスタンプ。

end-timestamp

転送が成功した場合、ファイル処理が完了したときのタイムスタンプ。

local-directory-path

RETRIEVE リクエストの場合、取得したファイルを配置する場所。

remote-directory-path

SEND リクエストの場合、ファイルをパートナーの SFTP サーバーに配置するファイルディレクトリ。これは、RemoteDirectoryPathユーザーがStartFileTransferリクエストに渡した の値です。パートナーの SFTP サーバーでデフォルトのディレクトリを指定できます。その場合は、このフィールドは空です。

item-count

出品リクエストに対して返された項目 (ディレクトリとファイル) の数。

truncated

リスト出力にリモートディレクトリに含まれるすべての項目が含まれているかどうか。

bytes

転送されるバイト数。失敗した転送の値は 0 です。

local-file-location

このパラメータには、 AWS ストレージファイルの場所の詳細が含まれます。

domain

使用されているストレージ。現在、唯一の値は ですS3。

bucket

Amazon S3 内のオブジェクトのコンテナ。

key

Amazon S3 のオブジェクトに割り当てられた名前。

output-file-location

このパラメータには、ディレクトリリストの結果を AWS ストレージに保存する場所の詳細が含まれます。

domain

使用されているストレージ。現在、唯一の値は ですS3。

bucket

Amazon S3 内のオブジェクトのコンテナ。

key

Amazon S3 のオブジェクトに割り当てられた名前。

例 SFTP コネクタファイル送信失敗の例イベント

次の例は、リモート SFTP サーバーにファイルを送信しようとしたときに SFTP コネクタが失敗するイベントを示しています。

{
    "version": "0",
    "id": "event-ID",
    "detail-type": "SFTP Connector File Send Failed",
    "source": "aws.transfer",
    "account": "123456789012",
    "time": "2024-01-24T19:30:45Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:transfer:us-east-1:123456789012:connector/c-f1111aaaa2222bbbb3"
    ],
    "detail": {
        "operation": "SEND",
        "connector-id": "c-f1111aaaa2222bbbb3",
        "transfer-id": "transfer-ID",
        "file-transfer-id": "file-transfer-ID",
        "url": "sftp://s-21a23456789012a.server.transfer.us-east-1.amazonaws.com",
        "file-path": "/DOC-EXAMPLE-BUCKET/testfile.txt",
        "status-code": "FAILED",
        "failure-code": "CONNECTION_ERROR",
        "failure-message": "Unknown Host",
        "remote-directory-path": "",
        "bytes": 0,
        "start-timestamp": "2024-01-24T18:29:33.658729Z",
        "end-timestamp": "2024-01-24T18:29:33.993196Z",
        "local-file-location": {
            "domain": "S3",
            "bucket": "DOC-EXAMPLE-BUCKET",
            "key": "testfile.txt"
        }
    }
}
例 SFTP コネクタファイルの取得完了サンプルイベント

次の例は、SFTP コネクタがリモート SFTP サーバーから送信されたファイルを正常に取得するイベントを示しています。

{
    "version": "0",
    "id": "event-ID",
    "detail-type": "SFTP Connector File Retrieve Completed",
    "source": "aws.transfer",
    "account": "123456789012",
    "time": "2024-01-24T18:28:08Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:transfer:us-east-1:123456789012:connector/c-f1111aaaa2222bbbb3"
    ],
    "detail": {
        "operation": "RETRIEVE",
        "connector-id": "c-fc68000012345aa18",
        "transfer-id": "file-transfer-ID",
        "file-transfer-id": "file-transfer-ID",
        "url": "sftp://s-21a23456789012a.server.transfer.us-east-1.amazonaws.com",
        "file-path": "testfile.txt",
        "status-code": "COMPLETED",
        "local-directory-path": "/DOC-EXAMPLE-BUCKET",
        "bytes": 63533,
        "start-timestamp": "2024-01-24T18:28:07.632388Z",
        "end-timestamp": "2024-01-24T18:28:07.774898Z",
        "local-file-location": {
            "domain": "S3",
            "bucket": "DOC-EXAMPLE-BUCKET",
            "key": "testfile.txt"
        }
    }
}
例 SFTP Connector Directory Listing Completed サンプルイベント

次の例は、スタートディレクトリリスト呼び出しがリモート SFTP サーバーからリストファイルを取得するイベントを示しています。

{
    "version": "0",
    "id": "event-ID",
    "detail-type": "SFTP Connector Directory Listing Completed",
    "source": "aws.transfer",
    "account": "123456789012",
    "time": "2024-01-24T18:28:08Z",
    "region": "us-east-1",
    "resources": [
        "arn:aws:transfer:us-east-1:123456789012:connector/c-f1111aaaa2222bbbb3"
    ],
    "detail": {
        "max-items": 10000,
        "connector-id": "c-fc68000012345aa18",
        "output-directory-path": "/DOC-EXAMPLE-BUCKET/example/file-listing-output",
        "listing-id": "123456-23aa-7980-abc1-1a2b3c4d5e",
        "url": "sftp://s-21a23456789012a.server.transfer.us-east-1.amazonaws.com",        
        "status-code": "COMPLETED",
        "remote-directory-path": "/home",
        "item-count": 10000,
        "truncated": true,
        "start-timestamp": "2024-01-24T18:28:07.632388Z",
        "end-timestamp": "2024-01-24T18:28:07.774898Z",
        "output-file-location": {
            "domain": "S3",
            "bucket": "DOC-EXAMPLE-BUCKET",
            "key": "c-fc1ab90fd0d047e7a-70987273-49nn-4006-bab1-1a7290cc412ba.json"
        }
    }
}

AS2 イベント

AS2 イベントの詳細フィールドは次のとおりです。

  • AS2 ペイロード受信完了

  • AS2 ペイロード受信失敗

  • AS2 ペイロードの送信が完了しました

  • AS2 ペイロードの送信に失敗しました

  • AS2 MDN 受信完了

  • AS2 MDN 受信失敗

  • AS2 MDN 送信が完了しました

  • AS2 MDN 送信失敗

source および detail-typeフィールドには、 Transfer Family イベントの特定の値が含まれているため、以下が含まれます。すべてのイベントに含まれる他のメタデータフィールドの定義については、「 ユーザーガイド」の「イベント構造のリファレンスAmazon EventBridge 」を参照してください。

{
   . . .,
  "detail-type": "string",
  "source": "aws.transfer",
  . . .,
  "detail": {    
    "s3-attributes" : {
      "file-bucket" : "string",
      "file-key" : "string",
      "json-bucket" : "string",
      "json-key" : "string", 
      "mdn-bucket" : "string",
      "mdn-key" : "string"
      }
    "mdn-subject" : "string",
    "mdn-message-id" : "string",
    "disposition" : "string",
    "bytes" : "number",
    "as2-from" : "string",
    "as2-message-id" : "string",
    "as2-to" : "string",
    "connector-id" : "string",
    "client-ip" : "string",
    "agreement-id" : "string",
    "server-id" : "string",
    "requester-file-name" : "string",
    "message-subject" : "string",
    "start-timestamp" : "string",
    "end-timestamp" : "string",
    "status-code" : "string",
    "failure-code" : "string",
    "failure-message" : "string",
    "transfer-id" : "string"
  }
}
detail-type

イベントのタイプを示します。

このイベントの場合、値は前述の AS2 イベントの 1 つです。

source

イベントを発生させたサービスを識別します。イベントの場合 Transfer Family 、この値は ですaws.transfer。

detail

イベントに関する情報を含む JSON オブジェクト。このフィールドの内容は、イベントを生成するサービスによって決まります。

s3-attributes

転送されるファイルの Amazon S3 バケットとキーを識別します。MDN イベントの場合、MDN ファイルのバケットとキーも識別されます。

file-bucket

Amazon S3 内のオブジェクトのコンテナ。

file-key

Amazon S3 のオブジェクトに割り当てられた名前。

json-bucket

完了または失敗した転送の場合、JSON ファイルのコンテナ。

json-key

COMPLETED 転送または FAILED 転送の場合、Amazon S3 の JSON ファイルに割り当てられた名前。

mdn-bucket

MDN イベントの場合、MDN ファイルのコンテナ。

mdn-key

MDN イベントの場合、Amazon S3 の MDN ファイルに割り当てられた名前。

mdn-subject

MDN イベントの場合、メッセージ処理のテキスト説明。

mdn-message-id

MDN イベントの場合、MDN メッセージの一意の ID。

disposition

MDN イベントの場合、処理のカテゴリ。

bytes

メッセージ内のバイト数。

as2-from

メッセージを送信している AS2 取引相手。

as2-message-id

転送される AS2 メッセージの一意の識別子。

as2-to

メッセージを受信している AS2 取引相手。

connector-id

Transfer Family サーバーから取引相手に送信される AS2 メッセージの場合、使用されている AS2 コネクタの一意の識別子。

client-ip

サーバーイベント (取引相手から Transfer Family サーバーへの転送) の場合、転送に関係するクライアントの IP アドレス。

agreement-id

サーバーイベントの場合、AS2 契約の一意の識別子。

server-id

サーバーイベントの場合、Transfer Family サーバーのみの一意の ID。

requester-file-name

ペイロードイベントの場合、転送中に受信したファイルの元の名前。

message-subject

メッセージの件名のテキストの説明。

start-timestamp

転送が成功した場合、ファイル処理が開始される時刻のタイムスタンプ。

end-timestamp

転送が成功した場合、ファイル処理が完了したときのタイムスタンプ。

status-code

AS2 メッセージ転送プロセスの状態に対応するコード。有効な値: COMPLETED | FAILED | PROCESSING。

failure-code

失敗した転送の場合、転送が失敗した理由のカテゴリ。

failure-message

失敗した転送の場合、転送が失敗した理由の詳細。

transfer-id

転送イベントの一意の識別子。

例 AS2 ペイロード受信完了サンプルイベント
{
    "version": "0",
     "id": "event-ID",
    "detail-type": "AS2 Payload Receive Completed",
    "source": "aws.transfer",
    "account": "076722215406",
    "time": "2024-02-07T06:47:05Z",
    "region": "us-east-1",
    "resources": ["arn:aws:transfer:us-east-1:076722215406:connector/c-1111aaaa2222bbbb3"],
    "detail": {
        "s3-attributes": {
            "file-key": "/inbound/processed/testAs2Message.dat",
            "file-bucket": "DOC-EXAMPLE-BUCKET"
        },
        "client-ip": "client-IP-address",
        "requester-file-name": "testAs2MessageVerifyFile.dat",
        "end-timestamp": "2024-02-07T06:47:06.040031Z",
        "as2-from": "as2-from-ID",
        "as2-message-id": "as2-message-ID",
        "message-subject": "Message from AS2 tests",
        "start-timestamp": "2024-02-07T06:47:05.410Z",
        "status-code": "PROCESSING",
        "bytes": 63,
        "as2-to": "as2-to-ID",
        "agreement-id": "a-1111aaaa2222bbbb3",
        "server-id": "s-1234abcd5678efghi"
    }
}
例 AS2 MDN 受信失敗サンプルイベント
{
  "version": "0",
  "id": "event-ID",
  "detail-type": "AS2 MDN Receive Failed",
  "source": "aws.transfer",
  "account": "889901007463",
  "time": "2024-02-06T22:05:09Z",
  "region": "us-east-1",
  "resources": ["arn:aws:transfer:us-east-1:076722215406:server/s-1111aaaa2222bbbb3"],
  "detail": {      
      "mdn-subject": "Your Requested MDN Response re: Test run from Id 123456789abcde to partner ijklmnop987654",
      "s3-attributes": {
          "json-bucket": "DOC-EXAMPLE-BUCKET1",
          "file-key": "/as2Integ/TestOutboundWrongCert.dat",
          "file-bucket": "DOC-EXAMPLE-BUCKET2",
          "json-key": "/as2Integ/failed/TestOutboundWrongCert.dat.json"
      },
      "mdn-message-id": "MDN-message-ID",
      "end-timestamp": "2024-02-06T22:05:09.479878Z",
      "as2-from": "PartnerA",
      "as2-message-id": "as2-message-ID",
      "connector-id": "c-1234abcd5678efghj",
      "message-subject": "Test run from Id 123456789abcde to partner ijklmnop987654",
      "start-timestamp": "2024-02-06T22:05:03Z",
      "failure-code": "VERIFICATION_FAILED_NO_MATCHING_KEY_FOUND",
      "status-code": "FAILED",
      "as2-to": "MyCompany",
      "failure-message": "No public certificate matching message signature could be found in profile: p-1234abcd5678efghj",
      "transfer-id": "transfer-ID"
  }
}