Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
UpdateAccess
Memungkinkan Anda memperbarui parameter untuk akses yang ditentukan dalam ExternalID
parameter ServerID
dan.
Sintaksis Permintaan
{
"ExternalId": "string
",
"HomeDirectory": "string
",
"HomeDirectoryMappings": [
{
"Entry": "string
",
"Target": "string
",
"Type": "string
"
}
],
"HomeDirectoryType": "string
",
"Policy": "string
",
"PosixProfile": {
"Gid": number
,
"SecondaryGids": [ number
],
"Uid": number
},
"Role": "string
",
"ServerId": "string
"
}
Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
Permintaan menerima data berikut dalam format JSON.
- ExternalId
-
Pengidentifikasi unik yang diperlukan untuk mengidentifikasi grup tertentu dalam direktori Anda. Pengguna grup yang Anda asosiasikan memiliki akses ke sumber daya Amazon S3 atau Amazon EFS Anda melalui protokol yang diaktifkan. AWS Transfer Family Jika Anda tahu nama grup, Anda dapat melihat nilai SID dengan menjalankan perintah berikut menggunakan Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
Dalam perintah itu, ganti YourGroupNamedengan nama grup Active Directory Anda.
Ekspresi reguler yang digunakan untuk memvalidasi parameter ini adalah string karakter yang terdiri dari huruf besar dan huruf kecil karakter alfanumerik tanpa spasi. Anda juga dapat menyertakan garis bawah atau salah satu karakter berikut: =, . @: /-
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
S-1-[\d-]+
Diperlukan: Ya
- HomeDirectory
-
Direktori arahan (folder) untuk pengguna ketika mereka masuk ke server menggunakan klien.
Contoh
HomeDirectory
adalah/bucket_name/home/mydirectory
.catatan
Parameter
HomeDirectory
hanya digunakan jikaHomeDirectoryType
diatur kePATH
.Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.
Pola:
(|/.*)
Diperlukan: Tidak
- HomeDirectoryMappings
-
Pemetaan direktori logis yang menentukan jalur dan kunci Amazon S3 atau Amazon EFS apa yang harus terlihat oleh pengguna Anda dan bagaimana Anda ingin membuatnya terlihat. Anda harus menentukan
Entry
danTarget
memasangkan, di manaEntry
menunjukkan bagaimana jalur dibuat terlihat danTarget
merupakan jalur Amazon S3 atau Amazon EFS yang sebenarnya. Jika Anda hanya menentukan target, itu ditampilkan apa adanya. Anda juga harus memastikan bahwa peran AWS Identity and Access Management (IAM) Anda menyediakan akses ke jalur masukTarget
. Nilai ini dapat diatur hanya ketikaHomeDirectoryType
diatur ke LOGICAL.Berikut ini adalah contoh
Entry
danTarget
pair.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
Dalam kebanyakan kasus, Anda dapat menggunakan nilai ini alih-alih kebijakan sesi untuk mengunci pengguna Anda ke direktori home yang ditunjuk (
chroot
“”). Untuk melakukan ini, Anda dapat mengaturEntry
ke/
dan mengaturTarget
ke nilaiHomeDirectory
parameter.Berikut ini adalah contoh
Entry
danTarget
pair untukchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
Tipe: Array objek HomeDirectoryMapEntry
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 50000 item.
Diperlukan: Tidak
- HomeDirectoryType
-
Jenis direktori pendaratan (folder) yang Anda inginkan direktori home pengguna Anda ketika mereka masuk ke server. Jika Anda mengaturnya
PATH
, pengguna akan melihat bucket Amazon S3 absolut atau jalur Amazon EFS seperti pada klien protokol transfer file mereka. Jika Anda menyetelnyaLOGICAL
, Anda harus menyediakan pemetaanHomeDirectoryMappings
untuk bagaimana Anda ingin membuat jalur Amazon S3 atau Amazon EFS terlihat oleh pengguna Anda.catatan
Jika
HomeDirectoryType
yaLOGICAL
, Anda harus memberikan pemetaan, menggunakan parameter.HomeDirectoryMappings
Jika, di sisi lain,HomeDirectoryType
adalahPATH
, Anda memberikan jalur absolut menggunakanHomeDirectory
parameter. Anda tidak dapat memiliki keduanyaHomeDirectory
danHomeDirectoryMappings
di template Anda.Jenis: String
Nilai yang Valid:
PATH | LOGICAL
Diperlukan: Tidak
- Policy
-
Kebijakan sesi untuk pengguna Anda sehingga Anda dapat menggunakan peran yang sama AWS Identity and Access Management (IAM) di beberapa pengguna. Kebijakan ini mencakup akses pengguna ke sebagian bucket Amazon S3 mereka. Variabel yang dapat Anda gunakan dalam kebijakan ini meliputi
${Transfer:UserName}
,${Transfer:HomeDirectory}
, dan${Transfer:HomeBucket}
.catatan
Kebijakan ini hanya berlaku jika domainnya
ServerId
adalah Amazon S3. Amazon EFS tidak menggunakan kebijakan sesi.Untuk kebijakan sesi, AWS Transfer Family menyimpan kebijakan sebagai gumpalan JSON, bukan Nama Sumber Daya Amazon (ARN) kebijakan tersebut. Anda menyimpan kebijakan sebagai blob JSON dan meneruskan dalam argumen
Policy
.Untuk contoh kebijakan sesi, lihat Contoh kebijakan sesi.
Untuk informasi selengkapnya, lihat AssumeRoledi Referensi API Layanan Token AWS Keamanan.
Jenis: String
Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2048.
Diperlukan: Tidak
- PosixProfile
-
Identitas POSIX lengkap, termasuk ID pengguna (
Uid
), ID grup (Gid
), dan setiap grup sekunder ID (SecondaryGids
), yang mengendalikan akses pengguna Anda ke sistem file Amazon EFS Anda. POSIX izin yang ditetapkan pada file dan direktori dalam sistem file Anda menentukan tingkat akses yang pengguna Anda dapatkan ketika mentransfer file ke dalam dan keluar dari sistem file Amazon EFS Anda.Tipe: Objek PosixProfile
Diperlukan: Tidak
- Role
-
Nama Sumber Daya Amazon (ARN) dari peran AWS Identity and Access Management (IAM) yang mengontrol akses pengguna ke bucket Amazon S3 atau sistem file Amazon EFS. Kebijakan yang dilampirkan pada peran ini menentukan tingkat akses yang ingin Anda berikan kepada pengguna saat mentransfer file masuk dan keluar dari bucket Amazon S3 atau sistem file Amazon EFS. IAM role juga harus berisi hubungan kepercayaan yang mengizinkan server untuk mengakses sumber daya Anda saat melayani permintaan transfer pengguna.
Jenis: String
Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.
Pola:
arn:.*role/\S+
Diperlukan: Tidak
- ServerId
-
Pengidentifikasi unik yang ditetapkan sistem untuk instans server. Ini adalah server tertentu tempat Anda menambahkan pengguna.
Jenis: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17})
Diperlukan: Ya
Sintaksis Respons
{
"ExternalId": "string",
"ServerId": "string"
}
Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- ExternalId
-
Pengenal eksternal grup yang penggunanya memiliki akses ke sumber daya Amazon S3 atau Amazon EFS Anda melalui protokol yang diaktifkan menggunakan AWS Transfer Family.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
S-1-[\d-]+
- ServerId
-
Pengidentifikasi server tempat pengguna dilampirkan.
Jenis: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17})
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- InternalServiceError
-
Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS Transfer Family.
Kode Status HTTP: 500
- InvalidRequestException
-
Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.
Kode Status HTTP: 400
- ResourceExistsException
-
Sumber daya yang diminta tidak ada, atau ada di wilayah selain yang ditentukan untuk perintah.
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
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: