SFTP コネクタイベント - AWS Transfer Family

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

SFTP コネクタイベント

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

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

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

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

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

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

{
  . . .,
  "detail-type": "string",
  "source": "aws.transfer",
  . . .,
  "detail": {
    "operation" : "string",
    "connector-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"
    "bytes" : "number",
    "local-file-location" : {
      "domain" : "string",
      "bucket" : "string",
      "key" : "string"
    },
  }
}
detail-type

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

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

source

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

detail

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

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

operation

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

connector-id

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

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

bytes

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

local-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"
        }
    }
}