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à.
ListUsers
Elenca gli utenti di un server abilitato al protocollo di trasferimento file che specificate passando il ServerId parametro.
Sintassi della richiesta
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "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.
- MaxResults
-
Speciifica il numero di utenti da restituire come risposta alla
ListUsersrichiesta.Tipo: integer
Intervallo valido: valore minimo di 1. Valore massimo pari a 1000.
Campo obbligatorio: no
- NextToken
-
Se ci sono risultati aggiuntivi dalla
ListUserschiamata, viene restituito unNextTokenparametro nell'output. È quindi possibileNextTokenpassarlo a unListUserscomando successivo per continuare a elencare altri utenti.Tipo: stringa
Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 6144.
Campo obbligatorio: no
- ServerId
-
Un identificatore univoco assegnato dal sistema per un server a cui sono assegnati utenti.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
s-([0-9a-f]{17})Campo obbligatorio: sì
Sintassi della risposta
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"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.
- NextToken
-
Quando è possibile ottenere risultati aggiuntivi dalla
ListUserschiamata, viene restituito unNextTokenparametro nell'output. È quindi possibile passare un comando successivo alNextTokenparametro per continuare a elencare altri utenti.Tipo: stringa
Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 6144.
- ServerId
-
Un identificatore univoco assegnato dal sistema per un server a cui sono assegnati gli utenti.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
s-([0-9a-f]{17}) - Users
-
Restituisce gli utenti di Transfer Family e le relative proprietà per il
ServerIdvalore specificato.Tipo: matrice di oggetti ListedUser
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
- InvalidNextTokenException
-
Il
NextTokenparametro passato non è valido.HTTPCodice di stato: 400
- 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
La ListUsers API chiamata restituisce un elenco di utenti associati a un server specificato dall'utente.
Richiesta di esempio
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
Esempio
Questo è un esempio di risposta per questa API chiamata.
Risposta di esempio
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef",
"Users": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
"HomeDirectory": "/tests/home/charlie",
"SshPublicKeyCount": 1,
"Role": "arn:aws:iam::176354371281:role/transfer-role1",
"Tags": [
{
"Key": "Name",
"Value": "user1"
}
],
"UserName": "my_user"
}
]
}Vedi anche
Per ulteriori informazioni sull'utilizzo di questa API opzione in una delle lingue specifiche AWS SDKs, consulta quanto segue:
