Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
DescribeUser
Descrive l'utente assegnato allo specifico server abilitato al protocollo di trasferimento file, come identificato dalla relativa ServerId
proprietà.
La risposta di questa chiamata restituisce le proprietà dell'utente associato al ServerId
valore specificato.
Sintassi della richiesta
{
"ServerId": "string
",
"UserName": "string
"
}
Parametri della richiesta
Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.
La richiesta accetta i seguenti dati nel JSON formato.
- ServerId
-
Un identificatore univoco assegnato dal sistema per un server a cui è assegnato questo utente.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
s-([0-9a-f]{17})
Campo obbligatorio: sì
- UserName
-
Il nome dell'utente assegnato a uno o più server. I nomi utente fanno parte delle credenziali di accesso per utilizzare il AWS Transfer Family servizio ed eseguire attività di trasferimento di file.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima di 3. Lunghezza massima di 100.
Modello:
[\w][\w@.-]{2,99}
Campo obbligatorio: sì
Sintassi della risposta
{
"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"
}
}
Elementi di risposta
Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.
I seguenti dati vengono restituiti in JSON formato dal servizio.
- ServerId
-
Un identificatore univoco assegnato dal sistema per un server a cui è assegnato questo utente.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
s-([0-9a-f]{17})
- User
-
Un array contenente le proprietà dell'utente Transfer Family per il
ServerID
valore specificato.Tipo: oggetto DescribedUser
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- InternalServiceError
-
Questa eccezione viene generata quando si verifica un errore nel AWS Transfer Family servizio.
HTTPCodice di stato: 500
- InvalidRequestException
-
Questa eccezione viene generata quando il client invia una richiesta non valida.
HTTPCodice di stato: 400
- ResourceNotFoundException
-
Questa eccezione viene generata quando una risorsa non viene trovata dal servizio AWS Transfer Family.
HTTPCodice di stato: 400
- ServiceUnavailableException
-
La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.
HTTPCodice di stato: 500
Esempi
Esempio
L'esempio seguente mostra i dettagli di un utente esistente.
Richiesta di esempio
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-test
Risposta di esempio
{
"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"
}
}
Vedi anche
Per ulteriori informazioni sull'utilizzo di questa API opzione in una delle lingue specifiche AWS SDKs, consulta quanto segue: