ListUsers - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

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.

ListUsers

Führt die Benutzer für einen Server mit aktiviertem Dateiübertragungsprotokoll auf, den Sie durch Übergabe des Parameters angeben. ServerId

Anforderungssyntax

{
   "MaxResults": number,
   "NextToken": "string",
   "ServerId": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im Format. JSON

MaxResults

Gibt die Anzahl der Benutzer an, die als Antwort auf die ListUsers Anfrage zurückgegeben werden sollen.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.

Erforderlich: Nein

NextToken

Wenn der ListUsers Aufruf zusätzliche Ergebnisse liefert, wird in der Ausgabe ein NextToken Parameter zurückgegeben. Sie können das dann NextToken an einen nachfolgenden ListUsers Befehl übergeben, um weitere Benutzer aufzulisten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

Erforderlich: Nein

ServerId

Ein vom System zugewiesener eindeutiger Bezeichner für einen Server, dem Benutzer zugewiesen sind.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Erforderlich: Ja

Antwortsyntax

{
   "NextToken": "string",
   "ServerId": "string",
   "Users": [ 
      { 
         "Arn": "string",
         "HomeDirectory": "string",
         "HomeDirectoryType": "string",
         "Role": "string",
         "SshPublicKeyCount": number,
         "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.

NextToken

Wenn Sie mit dem ListUsers Aufruf zusätzliche Ergebnisse erzielen können, wird in der Ausgabe ein NextToken Parameter zurückgegeben. Sie können dann einen nachfolgenden Befehl an den NextToken Parameter übergeben, um weitere Benutzer aufzulisten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

ServerId

Ein vom System zugewiesener eindeutiger Bezeichner für einen Server, dem die Benutzer zugewiesen sind.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Users

Gibt die Transfer Family Family-Benutzer und ihre Eigenschaften für den von Ihnen angegebenen ServerId Wert zurück.

Typ: Array von ListedUser-Objekten

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

InvalidNextTokenException

Der übergebene NextToken Parameter ist ungültig.

HTTPStatuscode: 400

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

Der ListUsers API Anruf gibt eine Liste von Benutzern zurück, die einem von Ihnen angegebenen Server zugeordnet sind.

Beispielanforderung

     
         {
          "MaxResults": 100,
          "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
          "ServerId": "s-01234567890abcdef"
          }

Beispiel

Dies ist eine Beispielantwort für diesen API Anruf.

Beispielantwort

{
   "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"
      }
   ]
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: