Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
DescribeUser
Menjelaskan pengguna yang ditugaskan ke server berkemampuan protokol transfer file tertentu, seperti yang diidentifikasi oleh propertinya. ServerId
Respons dari panggilan ini mengembalikan properti pengguna yang terkait dengan ServerId nilai yang ditentukan.
Sintaksis Permintaan
{
"ServerId": "string",
"UserName": "string"
}Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
Permintaan menerima data berikut dalam JSON format.
- ServerId
-
Pengidentifikasi unik yang ditetapkan sistem untuk server yang telah ditetapkan pengguna ini.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17})Wajib: Ya
- UserName
-
Nama pengguna yang ditetapkan ke satu atau lebih server. Nama pengguna adalah bagian dari kredensi masuk untuk menggunakan AWS Transfer Family layanan dan melakukan tugas transfer file.
Tipe: String
Batasan Panjang: Panjang minimum 3. Panjang maksimum 100.
Pola:
[\w][\w@.-]{2,99}Diperlukan: Ya
Sintaksis Respons
{
"ServerId": "string",
"User": {
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"SshPublicKeys": [
{
"DateImported": number,
"SshPublicKeyBody": "string",
"SshPublicKeyId": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string"
}
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Data berikut dikembalikan dalam JSON format oleh layanan.
- ServerId
-
Pengidentifikasi unik yang ditetapkan sistem untuk server yang telah ditetapkan pengguna ini.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
s-([0-9a-f]{17}) - User
-
Array yang berisi properti pengguna Transfer Family untuk
ServerIDnilai yang Anda tentukan.Tipe: Objek DescribedUser
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
Contoh
Contoh
Contoh berikut menunjukkan rincian untuk pengguna yang ada.
Permintaan Sampel
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-testContoh Respons
{
"ServerId": "s-1111aaaa2222bbbb3",
"User": {
"Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob-test",
"HomeDirectory": "/DOC-EXAMPLE-BUCKET",
"HomeDirectoryType": "PATH",
"Role": "arn:aws:iam::111122223333:role/bob-role",
"SshPublicKeys": [
{
"DateImported": "2022-03-31T12:27:52.614000-04:00",
"SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us-east-1.amaazon.com",
"SshPublicKeyId": "key-abcde12345fghik67"
}
],
"Tags": [],
"UserName": "bob-test"
}
}Lihat Juga
Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
