本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeUser
描述指派給已啟用檔案傳輸通訊協定之特定伺服器的使用者，如其ServerId內容所識別。
此呼叫的回應會傳回與指定ServerId值相關聯的使用者屬性。
請求語法
{
"ServerId": "string",
"UserName": "string"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
回應語法
{
"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"
}
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ServerId
-
系統指派給已指派此使用者之伺服器的唯一識別碼。
類型：字串
長度約束：固定長度為 19。
模式：
s-([0-9a-f]{17}) - User
-
陣列，其中包含您指定
ServerID值的「Transfer Family」使用者性質。類型：DescribedUser 物件
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InternalServiceError
-
當在 AWS Transfer Family 服務中發生錯誤時，拋出此異常。
HTTP 狀態碼：500
- InvalidRequestException
-
當客戶端提交格式錯誤的請求時，拋出此異常。
HTTP 狀態碼：400
- ResourceNotFoundException
-
當 AWS Transfer Family 服務找不到資源時，會擲回此例外狀況。
HTTP 狀態碼：400
- ServiceUnavailableException
-
申請失敗，因為 AWS Transfer Family 服務不可用。
HTTP 狀態碼：500
範例
範例
下列範例顯示現有使用者的詳細資訊。
請求範例
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-test回應範例
{
"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"
}
}另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
