StartFileTransfer - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContohLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

StartFileTransfer

Memulai transfer file antara AWS penyimpanan lokal dan server AS2 atau SFTP jarak jauh.

  • Untuk konektor AS2, Anda menentukan ConnectorId dan satu atau lebih SendFilePaths untuk mengidentifikasi file yang ingin Anda transfer.

  • Untuk konektor SFTP, transfer file dapat berupa outbound atau inbound. Dalam kedua kasus, Anda menentukanConnectorId. Tergantung pada arah transfer, Anda juga menentukan item berikut:

    • Jika Anda mentransfer file dari server SFTP mitra ke penyimpanan Amazon Web Services, Anda menentukan satu atau beberapa RetrieveFilePaths untuk mengidentifikasi file yang ingin ditransfer, dan LocalDirectoryPath untuk menentukan folder tujuan.

    • Jika Anda mentransfer file ke server SFTP mitra dari AWS penyimpanan, Anda menentukan satu atau lebih SendFilePaths untuk mengidentifikasi file yang ingin Anda transfer, dan RemoteDirectoryPath untuk menentukan folder tujuan.

Sintaksis Permintaan

{
   "ConnectorId": "string",
   "LocalDirectoryPath": "string",
   "RemoteDirectoryPath": "string",
   "RetrieveFilePaths": [ "string" ],
   "SendFilePaths": [ "string" ]
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

ConnectorId

Pengidentifikasi unik untuk konektor.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: c-([0-9a-f]{17})

Wajib: Ya

LocalDirectoryPath

Untuk transfer masuk, LocaDirectoryPath menentukan tujuan untuk satu atau lebih file yang ditransfer dari server SFTP mitra.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: (.)+

Wajib: Tidak

RemoteDirectoryPath

Untuk transfer keluar, RemoteDirectoryPath menentukan tujuan untuk satu atau lebih file yang ditransfer ke server SFTP mitra. Jika Anda tidak menentukanRemoteDirectoryPath, tujuan untuk file yang ditransfer adalah direktori home pengguna SFTP.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: (.)+

Wajib: Tidak

RetrieveFilePaths

Satu atau lebih jalur sumber untuk server SFTP mitra. Setiap string mewakili jalur file sumber untuk satu transfer file masuk.

Tipe: Array string

Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 10 item.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: (.)+

Wajib: Tidak

SendFilePaths

Satu atau lebih jalur sumber untuk penyimpanan Amazon S3. Setiap string mewakili jalur file sumber untuk satu transfer file keluar. Misalnya, DOC-EXAMPLE-BUCKET/myfile.txt .

catatan

Ganti DOC-EXAMPLE-BUCKET dengan salah satu ember Anda yang sebenarnya.

Tipe: Array string

Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 10 item.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: (.)+

Diperlukan: Tidak

Sintaksis Respons

{
   "TransferId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

TransferId

Mengembalikan identifier unik untuk transfer file.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 512.

Pola: [0-9a-zA-Z./-]+

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

ThrottlingException

Permintaan ditolak karena throttling permintaan.

Kode Status HTTP: 400

Contoh

Contoh

Contoh berikut memulai transfer file AS2 dari server Transfer Family ke titik akhir mitra dagang jarak jauh. Ganti DOC-EXAMPLE-BUCKET dengan salah satu ember Anda yang sebenarnya.

Permintaan Sampel

{    
    "ConnectorId": "c-AAAA1111BBBB2222C",
    "SendFilePaths": [
        "/DOC-EXAMPLE-BUCKET/myfile-1.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-2.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-3.txt"
    ]
}

Contoh Respons

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Contoh

Contoh berikut memulai transfer file dari AWS penyimpanan lokal ke server SFTP jarak jauh.

Permintaan Sampel

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

Contoh Respons

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}

Contoh

Contoh berikut memulai transfer file dari server SFTP jarak jauh ke penyimpanan lokal AWS .

Permintaan Sampel

{    
    "ConnectorId": "c-111122223333AAAAA",
    "RetrieveFilePaths": [
        "/MySFTPFolder/toTranferFamily/myfile-1.txt",
        "/MySFTPFolder/toTranferFamily/myfile-2.txt",
        "/MySFTPFolder/toTranferFamily/myfile-3.txt"
    ],
    "LocalDirectoryPath": "/DOC-EXAMPLE-BUCKET/mySourceFiles"
}

Contoh Respons

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa"
}

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: