Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
DescribeUser
Beschreibt den Benutzer, der dem spezifischen Server mit aktiviertem Dateiübertragungsprotokoll zugewiesen ist, wie durch seine Eigenschaft identifiziert. ServerId
Die Antwort auf diesen Aufruf gibt die Eigenschaften des Benutzers zurück, die dem angegebenen ServerId Wert zugeordnet sind.
Anforderungssyntax
{
"ServerId": "string",
"UserName": "string"
}Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.
Die Anfrage akzeptiert die folgenden Daten im JSON Format.
- ServerId
-
Ein vom System zugewiesener eindeutiger Bezeichner für einen Server, dem dieser Benutzer zugewiesen wurde.
Typ: Zeichenfolge
Längenbeschränkungen: Feste Länge von 19.
Pattern:
s-([0-9a-f]{17})Erforderlich: Ja
- UserName
-
Der Name des Benutzers, der einem oder mehreren Servern zugewiesen ist. Benutzernamen sind Teil der Anmeldeinformationen für die Nutzung des AWS Transfer Family Dienstes und die Ausführung von Dateiübertragungsaufgaben.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 100 Zeichen.
Pattern:
[\w][\w@.-]{2,99}Erforderlich: Ja
Antwortsyntax
{
"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"
}
}Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.
- ServerId
-
Ein vom System zugewiesener eindeutiger Bezeichner für einen Server, dem dieser Benutzer zugewiesen wurde.
Typ: Zeichenfolge
Längenbeschränkungen: Feste Länge von 19.
Pattern:
s-([0-9a-f]{17}) - User
-
Ein Array, das die Eigenschaften des Transfer Family Family-Benutzers für den von Ihnen angegebenen
ServerIDWert enthält.Typ: DescribedUser Objekt
Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.
- InternalServiceError
-
Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.
HTTPStatuscode: 500
- InvalidRequestException
-
Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.
HTTPStatuscode: 400
- ResourceNotFoundException
-
Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.
HTTPStatuscode: 400
- ServiceUnavailableException
-
Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.
HTTPStatuscode: 500
Beispiele
Beispiel
Das folgende Beispiel zeigt die Details für einen vorhandenen Benutzer.
Beispielanforderung
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-testBeispielantwort
{
"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"
}
}Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
