Transfer Family referensi detail acara

Semua peristiwa dari AWS layanan memiliki seperangkat bidang umum yang berisi metadata tentang acara tersebut. Metadata ini dapat mencakup AWS layanan yang merupakan sumber acara, waktu acara dibuat, akun dan Wilayah tempat acara berlangsung, dan lainnya. Untuk definisi bidang umum ini, lihat Referensi struktur acara di Panduan Amazon EventBridge Pengguna.

Selain itu, setiap acara memiliki detail bidang yang berisi data khusus untuk peristiwa tertentu. Referensi berikut mendefinisikan bidang detail untuk berbagai Transfer Family acara.

Saat Anda menggunakan EventBridge untuk memilih dan mengelola Transfer Family acara, pertimbangkan hal berikut:

sourceBidang untuk semua acara dari Transfer Family diatur keaws.transfer.
detail-typeBidang menentukan jenis acara.

Misalnya, FTP File Server Download Completed.
detailBidang berisi data yang spesifik untuk peristiwa tertentu.

Untuk informasi tentang membuat pola peristiwa yang memungkinkan aturan untuk mencocokkan Transfer Family peristiwa, lihat Pola acara di Panduan Amazon EventBridge Pengguna.

Untuk informasi selengkapnya tentang peristiwa dan cara EventBridge memprosesnya, lihat Amazon EventBridge peristiwa di Panduan Amazon EventBridge Pengguna.

Acara server SFTP, FTPS, dan FTP

Berikut ini adalah bidang detail untuk acara server SFTP, FTPS, dan FTP:

Unduhan Server File FTP Selesai
Unduhan Server File FTP Gagal
Unggahan Server File FTP Selesai
Unggahan Server File FTP Gagal
Unduhan Server File FTPS Selesai
Unduhan Server File FTPS Gagal
Unggahan Server File FTPS Selesai
Unggahan Server File FTPS Gagal
Unduhan File Server SFTP Selesai
Unduhan File Server SFTP Gagal
Unggahan File Server SFTP Selesai
Unggahan File Server SFTP Gagal

detail-typeBidang source dan disertakan di bawah ini karena mengandung nilai khusus untuk Transfer Family acara. Untuk definisi bidang metadata lain yang disertakan dalam semua peristiwa, lihat Referensi struktur acara di Amazon EventBridge Panduan Pengguna.


{
  . . .,
  "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

Mengidentifikasi jenis acara.

Untuk acara ini, nilainya adalah salah satu nama acara server SFTP, FTPS, atau FTP yang tercantum sebelumnya.

source

Mengidentifikasi layanan yang menghasilkan peristiwa. Untuk acara Transfer Family, nilai ini adalahaws.transfer.

detail

Objek JSON yang berisi informasi tentang peristiwa. Layanan yang menghasilkan acara menentukan konten bidang ini.

Untuk acara ini, data meliputi yang berikut:

failure-code: Kategori mengapa transfer gagal. Nilai: PARTIAL_UPLOAD | PARTIAL_DOWNLOAD | UNKNOWN_ERROR
status-code: Apakah transfer berhasil. Nilai:COMPLETED | FAILED.
protocol: Protokol yang digunakan untuk transfer. Nilai: SFTP | FTPS | FTP
bytes: Jumlah byte yang ditransfer.
client-ip: Alamat IP untuk klien yang terlibat dalam transfer
failure-message: Untuk transfer yang gagal, detail mengapa transfer gagal.
end-timestamp: Untuk transfer yang berhasil, stempel waktu ketika file selesai diproses.
etag: Tag entitas (hanya digunakan untuk file Amazon S3).
file-path: Jalur ke file yang ditransfer.
server-id: ID unik untuk server Transfer Family.
username: Pengguna yang melakukan transfer.
session-id: Pengenal unik untuk sesi transfer.
start-timestamp: Untuk transfer yang berhasil, stempel waktu saat pemrosesan file dimulai.

contoh Unduhan File Server SFTP Gagal contoh peristiwa

Contoh berikut menunjukkan peristiwa di mana unduhan gagal di server SFTP (Amazon EFS adalah penyimpanan yang digunakan).


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

contoh Unggah Server File FTP Contoh acara yang lengkap

Contoh berikut menunjukkan peristiwa di mana unggahan berhasil diselesaikan pada server FTP (Amazon S3 adalah penyimpanan yang digunakan).


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

Acara konektor SFTP

Berikut ini adalah bidang detail untuk acara konektor SFTP:

Kirim File Konektor SFTP Selesai
Kirim File Konektor SFTP Gagal
Pengambilan File Konektor SFTP Selesai
Pengambilan File Konektor SFTP Gagal
Daftar Direktori Konektor SFTP Selesai
Daftar Direktori Konektor SFTP Gagal


{
  . . .,
  "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

Mengidentifikasi jenis acara.

Untuk acara ini, nilainya adalah salah satu nama acara konektor SFTP yang tercantum sebelumnya.

source

Mengidentifikasi layanan yang menghasilkan peristiwa. Untuk Transfer Family acara, nilai ini adalahaws.transfer.

detail

Objek JSON yang berisi informasi tentang peristiwa. Layanan yang menghasilkan acara menentukan konten bidang ini.

Untuk acara ini, data meliputi yang berikut:

max-items

Jumlah maksimum nama direktori/file yang akan dikembalikan.

operation

Apakah StartFileTransfer permintaan mengirim atau mengambil file. Nilai:SEND|RETRIEVE.

connector-id

Pengidentifikasi unik untuk konektor SFTP yang digunakan.

output-directory-path

Jalur (bucket dan awalan) di Amazon S3 untuk menyimpan hasil daftar file/direktori.

listing-id

Pengenal unik untuk panggilan StartDirectoryListing API. Pengenal ini dapat digunakan untuk memeriksa CloudWatch log untuk melihat status permintaan daftar.

transfer-id

Pengenal unik untuk acara transfer (StartFileTransferpermintaan).

file-transfer-id

Pengidentifikasi unik untuk file yang ditransfer.

url

URL titik akhir AS2 atau SFTP mitra.

file-path

Lokasi dan file yang sedang dikirim atau diambil.

status-code

Apakah transfer berhasil. Nilai:FAILED | COMPLETED.

failure-code

Untuk transfer yang gagal, kode alasan mengapa transfer gagal.

failure-message

Untuk transfer yang gagal, detail mengapa transfer gagal.

start-timestamp

Untuk transfer yang berhasil, stempel waktu saat pemrosesan file dimulai.

end-timestamp

Untuk transfer yang berhasil, stempel waktu saat pemrosesan file selesai.

local-directory-path

Untuk RETRIEVE permintaan, lokasi untuk menempatkan file yang diambil.

remote-directory-path

Untuk SEND permintaan, direktori file tempat menempatkan file di server SFTP mitra. Ini adalah nilai untuk RemoteDirectoryPath yang diteruskan pengguna ke StartFileTransfer permintaan. Anda dapat menentukan direktori default di server SFTP mitra. Jika demikian, bidang ini kosong.

item-count

Jumlah item (direktori dan file) yang dikembalikan untuk permintaan daftar.

truncated

Apakah output daftar berisi semua item yang terkandung dalam direktori jarak jauh atau tidak.

bytes

Jumlah byte yang ditransfer. Nilainya adalah 0 untuk transfer yang gagal.

local-file-location

Parameter ini berisi rincian lokasi file AWS penyimpanan.

domain: Penyimpanan yang digunakan. Saat ini, satu-satunya nilai adalahS3.
bucket: Wadah untuk objek di Amazon S3.
key: Nama yang ditetapkan untuk objek di Amazon S3.

output-file-location

Parameter ini berisi rincian lokasi tempat menyimpan hasil daftar direktori dalam AWS penyimpanan.

domain: Penyimpanan yang digunakan. Saat ini, satu-satunya nilai adalahS3.
bucket: Wadah untuk objek di Amazon S3.
key: Nama yang ditetapkan untuk objek di Amazon S3.

contoh SFTP Connector File Kirim contoh peristiwa gagal

Contoh berikut menunjukkan peristiwa di mana konektor SFTP gagal saat mencoba mengirim file ke server SFTP jarak jauh.


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

contoh File Konektor SFTP Mengambil contoh acara yang lengkap

Contoh berikut menunjukkan peristiwa di mana konektor SFTP berhasil mengambil file yang dikirim dari server SFTP jarak jauh.


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

contoh Daftar Direktori Konektor SFTP Contoh acara yang lengkap

Contoh berikut menunjukkan peristiwa di mana panggilan daftar direktori awal diambil file daftar dari server SFTP jarak jauh.


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

Acara AS2

Berikut ini adalah bidang detail untuk acara AS2:

Terima Muatan AS2 Selesai
Penerimaan Muatan AS2 Gagal
Kirim Muatan AS2 Selesai
Kirim Muatan AS2 Gagal
AS2 MDN Terima Selesai
AS2 MDN Menerima Gagal
AS2 MDN Kirim Selesai
AS2 MDN Kirim Gagal


{
   . . .,
  "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

Mengidentifikasi jenis acara.

Untuk acara ini, nilainya adalah salah satu peristiwa AS2 yang tercantum sebelumnya.

source

Mengidentifikasi layanan yang menghasilkan peristiwa. Untuk Transfer Family acara, nilai ini adalahaws.transfer.

detail

Objek JSON yang berisi informasi tentang peristiwa. Layanan yang menghasilkan acara menentukan konten bidang ini.

s3-attributes

Mengidentifikasi bucket dan kunci Amazon S3 untuk file yang ditransfer. Untuk acara MDN, ini juga mengidentifikasi bucket dan kunci untuk file MDN.

file-bucket: Wadah untuk objek di Amazon S3.
file-key: Nama yang ditetapkan untuk objek di Amazon S3.
json-bucket: Untuk transfer SELESAI atau GAGAL, wadah untuk file JSON.
json-key: Untuk transfer SELESAI atau GAGAL, nama yang ditetapkan ke file JSON di Amazon S3.
mdn-bucket: Untuk acara MDN, wadah untuk file MDN.
mdn-key: Untuk peristiwa MDN, nama ditetapkan ke file MDN di Amazon S3.

mdn-subject

Untuk acara MDN, deskripsi teks untuk disposisi pesan.

mdn-message-id

Untuk acara MDN, ID unik untuk pesan MDN.

disposition

Untuk acara MDN, kategori untuk disposisi.

bytes

Jumlah byte dalam pesan.

as2-from

Mitra dagang AS2 yang mengirim pesan.

as2-message-id

Pengenal unik untuk pesan AS2 yang ditransfer.

as2-to

Mitra dagang AS2 yang menerima pesan.

connector-id

Untuk pesan AS2 yang dikirim dari server Transfer Family ke mitra dagang, pengenal unik untuk konektor AS2 digunakan.

client-ip

Untuk kejadian server (transfer dari mitra dagang ke server Transfer Family), alamat IP untuk klien yang terlibat dalam transfer.

agreement-id

Untuk peristiwa server, pengenal unik untuk perjanjian AS2.

server-id

Untuk kejadian server, ID unik hanya untuk server Transfer Family.

requester-file-name

Untuk acara payload, nama asli untuk file yang diterima selama transfer.

message-subject

Deskripsi teks untuk subjek pesan.

start-timestamp

Untuk transfer yang berhasil, stempel waktu saat pemrosesan file dimulai.

end-timestamp

Untuk transfer yang berhasil, stempel waktu saat pemrosesan file selesai.

status-code

Kode yang sesuai dengan keadaan proses transfer pesan AS2. Nilai yang valid:COMPLETED | FAILED | PROCESSING.

failure-code

Untuk transfer yang gagal, kategori mengapa transfer gagal.

failure-message

Untuk transfer yang gagal, detail mengapa transfer gagal.

transfer-id

Pengenal unik untuk acara transfer.

contoh AS2 Payload Receive Contoh acara Selesai


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

contoh AS2 MDN Menerima contoh peristiwa Gagal


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

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Mengelola acara menggunakan EventBridge

Keamanan