Referensi API - AWS Transfer Family

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

Referensi API

Bagian berikut mendokumentasikan panggilan layanan AWS Transfer Family API, tipe data, parameter, dan kesalahan.

Selamat datang di AWS Transfer Family API

AWS Transfer Family adalah layanan transfer aman yang dapat Anda gunakan untuk mentransfer file masuk dan keluar dari penyimpanan Amazon Simple Storage Service (Amazon S3) melalui protokol berikut:

  • Protokol Transfer File Secure Shell (SSH) (SFTP)

  • Protokol Transfer File Aman (FTPS)

  • Protokol Transfer File (FTP)

  • Pernyataan Penerapan 2 (AS2)

Protokol transfer file digunakan dalam alur kerja pertukaran data di berbagai industri seperti layanan keuangan, perawatan kesehatan, periklanan, dan ritel, antara lain. AWS Transfer Family menyederhanakan migrasi alur kerja transfer file ke. AWS

Untuk menggunakan AWS Transfer Family layanan ini, Anda membuat instance server di AWS Wilayah pilihan Anda. Anda dapat membuat server, daftar server yang tersedia, dan memperbarui dan menghapus server. Server adalah entitas yang meminta operasi file dari AWS Transfer Family. Server memiliki sejumlah properti penting. Server adalah contoh bernama seperti yang diidentifikasi oleh ServerId pengidentifikasi yang ditetapkan sistem. Anda dapat secara opsional menetapkan nama host, atau bahkan nama host khusus ke server. Tagihan layanan untuk setiap server instantiated (bahkan yangOFFLINE), dan untuk jumlah data yang ditransfer.

Pengguna harus diketahui oleh server yang meminta operasi file. Seorang pengguna yang diidentifikasi oleh nama pengguna mereka ditugaskan ke server. Nama pengguna digunakan untuk mengautentikasi permintaan. Server hanya dapat memiliki satu metode otentikasi:AWS_DIRECTORY_SERVICE,, SERVICE_MANAGEDAWS_LAMBDA, atauAPI_GATEWAY.

Anda dapat menggunakan salah satu jenis penyedia identitas berikut untuk mengautentikasi pengguna:

  • UntukSERVICE_MANAGED, kunci publik SSH disimpan dengan properti pengguna di server. Seorang pengguna dapat memiliki satu atau lebih kunci publik SSH pada file untuk metode SERVICE_MANAGED otentikasi. Ketika klien meminta operasi file untuk SERVICE_MANAGED metode, klien menyediakan nama pengguna dan kunci pribadi SSH, yang diautentikasi, dan akses disediakan.

  • Anda dapat mengelola otentikasi dan akses pengguna dengan grup Microsoft Active Directory Anda dengan memilih metode AWS_DIRECTORY_SERVICE otentikasi.

  • Anda dapat terhubung ke penyedia identitas kustom dengan menggunakan AWS Lambda. Pilih metode AWS_LAMBDA otentikasi.

  • Anda juga dapat mengautentikasi permintaan pengguna menggunakan metode otentikasi khusus yang menyediakan otentikasi dan akses pengguna. Metode ini bergantung pada Amazon API Gateway untuk menggunakan panggilan API Anda dari penyedia identitas Anda untuk memvalidasi permintaan pengguna. Metode ini disebut sebagai API_GATEWAY dalam panggilan API, dan sebagai Kustom di konsol. Anda dapat menggunakan metode kustom ini untuk mengautentikasi pengguna terhadap layanan direktori, pasangan nama/kata sandi database, atau mekanisme lainnya.

Pengguna diberi kebijakan dengan hubungan kepercayaan antara mereka dan bucket Amazon S3. Mereka mungkin dapat mengakses semua atau sebagian ember. Agar server bertindak atas nama pengguna, server harus mewarisi hubungan kepercayaan dari pengguna. Peran AWS Identity and Access Management (IAM) dibuat yang berisi hubungan kepercayaan, dan peran itu diberi AssumeRole tindakan. Server kemudian dapat melakukan operasi file seolah-olah itu adalah pengguna.

Pengguna yang memiliki set properti home direktori akan memiliki direktori (atau folder) yang bertindak sebagai target dan sumber operasi file. Ketika tidak ada home direktori yang disetel, root direktori bucket menjadi direktori pendaratan.

Server, pengguna, dan peran semuanya diidentifikasi oleh Amazon Resource Name (ARN) mereka. Anda dapat menetapkan tag, yang merupakan pasangan nilai kunci, ke entitas dengan ARN. Tag adalah metadata yang dapat digunakan untuk mengelompokkan atau mencari entitas ini. Salah satu contoh di mana tag berguna adalah untuk tujuan akuntansi.

Konvensi berikut diamati dalam format AWS Transfer Family ID:

  • ServerIdnilai mengambil bentuks-01234567890abcdef.

  • SshPublicKeyIdnilai mengambil bentukkey-01234567890abcdef.

Format Amazon Resource Name (ARN) mengambil bentuk berikut:

  • Untuk server, ARN mengambil formulirarn:aws:transfer:region:account-id:server/server-id.

    Contoh dari ARN server adalah: arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef.

  • Untuk pengguna, ARN mengambil formulirarn:aws:transfer:region:account-id:user/server-id/username.

    Contohnya adalah arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1.

Entri DNS (endpoint) yang digunakan adalah sebagai berikut:

  • Titik akhir API mengambil formulirtransfer.region.amazonaws.com.

  • Titik akhir server mengambil formulirserver.transfer.region.amazonaws.com.

Untuk daftar titik akhir Transfer Family menurut AWS Wilayah, lihat AWS Transfer Family titik akhir dan kuota di. Referensi Umum AWS

Referensi antarmuka API ini AWS Transfer Family berisi dokumentasi untuk antarmuka pemrograman yang dapat Anda gunakan untuk mengelola AWS Transfer Family. Struktur referensi adalah sebagai berikut:

Tip

Daripada benar-benar menjalankan perintah, Anda dapat menggunakan --generate-cli-skeleton parameter dengan panggilan API apa pun untuk menghasilkan dan menampilkan templat parameter. Anda kemudian dapat menggunakan template yang dihasilkan untuk menyesuaikan dan digunakan sebagai input pada perintah selanjutnya. Untuk detailnya, lihat Menghasilkan dan menggunakan file kerangka parameter.