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 remote AS2 atau SFTP server.

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

  • Untuk SFTP konektor, 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 SFTP server mitra ke penyimpanan Amazon Web Services, Anda menentukan satu atau beberapa RetreiveFilePaths untuk mengidentifikasi file yang ingin ditransfer, dan LocalDirectoryPath untuk menentukan folder tujuan.

    • Jika Anda mentransfer file ke SFTP server 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 JSON format.

ConnectorId

Pengidentifikasi unik untuk konektor.

Tipe: 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 mitraSFTP.

Tipe: 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 mitraSFTP. Jika Anda tidak menentukanRemoteDirectoryPath, tujuan untuk file yang ditransfer adalah direktori home SFTP pengguna.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: (.)+

Wajib: Tidak

RetrieveFilePaths

Satu atau lebih jalur sumber untuk SFTP server 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.

Data berikut dikembalikan dalam JSON format oleh layanan.

TransferId

Mengembalikan identifier unik untuk transfer file.

Tipe: 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.

HTTPKode Status: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

HTTPKode Status: 400

ResourceNotFoundException

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

HTTPKode Status: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

HTTPKode Status: 500

ThrottlingException

Permintaan ditolak karena throttling permintaan.

HTTPKode Status: 400

Contoh

Contoh

Contoh berikut memulai transfer AS2 file 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 SFTP server 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 SFTP server jauh ke AWS penyimpanan lokal.

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 ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini: