UpdateUser - 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.

UpdateUser

Weist einem Benutzer neue Eigenschaften zu. Parameter, die Sie übergeben, ändern einige oder alle der folgenden Elemente: das Basisverzeichnis, die Rolle und die Richtlinie für die UserName und, die ServerId Sie angeben.

Die Antwort gibt das ServerId und das UserName für den aktualisierten Benutzer zurück.

In der Konsole können Sie Eingeschränkt auswählen, wenn Sie einen Benutzer erstellen oder aktualisieren. Dadurch wird sichergestellt, dass der Benutzer auf nichts außerhalb seines Home-Verzeichnisses zugreifen kann. Die programmatische Methode zur Konfiguration dieses Verhaltens besteht darin, den Benutzer zu aktualisieren. Setzen Sie sie HomeDirectoryType auf LOGICAL und geben Sie sie HomeDirectoryMappings mit Entry als root (/) und Target als ihr Heimatverzeichnis an.

Wenn das Home-Verzeichnis des Benutzers beispielsweise lautet/test/admin-user, aktualisiert der folgende Befehl den Benutzer so, dass in seiner Konfiguration in der Konsole das Kennzeichen Eingeschränkt als ausgewählt angezeigt wird.

aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"

Anforderungssyntax

{
   "HomeDirectory": "string",
   "HomeDirectoryMappings": [ 
      { 
         "Entry": "string",
         "Target": "string",
         "Type": "string"
      }
   ],
   "HomeDirectoryType": "string",
   "Policy": "string",
   "PosixProfile": { 
      "Gid": number,
      "SecondaryGids": [ number ],
      "Uid": number
   },
   "Role": "string",
   "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.

HomeDirectory

Das Zielverzeichnis (Ordner) für einen Benutzer bei der Serveranmeldung mithilfe des Client.

Ein Beispiel für HomeDirectory ist /bucket_name/home/mydirectory.

Anmerkung

Der HomeDirectory-Parameter wird nur verwendet, wenn HomeDirectoryType auf PATH gesetzt ist.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: (|/.*)

Erforderlich: Nein

HomeDirectoryMappings

Logische Verzeichniszuordnungen, die angeben, welche Amazon S3- oder EFS Amazon-Pfade und -Schlüssel für Ihren Benutzer sichtbar sein sollen und wie Sie sie sichtbar machen möchten. Sie müssen das Entry Target Und-Paar angeben, das Entry zeigt, wie der Pfad sichtbar gemacht Target wird und der tatsächliche Amazon S3- oder EFS Amazon-Pfad ist. Wenn Sie nur ein Ziel angeben, wird es unverändert angezeigt. Sie müssen außerdem sicherstellen, dass Ihre Rolle AWS Identity and Access Management (IAM) Zugriff auf Pfade in bietetTarget. Dieser Wert kann nur gesetzt werden, wenn er auf gesetzt HomeDirectoryType ist LOGICAL.

Im Folgenden finden Sie ein Entry Beispiel für ein Target Und-Paar.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In den meisten Fällen können Sie diesen Wert anstelle der Sitzungsrichtlinie verwenden, um Ihren Benutzer auf das angegebene Home-Verzeichnis (“ chroot „) zu sperren. Dazu können Sie den Wert Entry auf '/' und dann Target auf den HomeDirectory Parameterwert setzen.

Im Folgenden finden Sie ein Entry Target Und-Pair-Beispiel fürchroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

Typ: Array von HomeDirectoryMapEntry-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl von 50000 Artikeln.

Erforderlich: Nein

HomeDirectoryType

Die Art des Zielverzeichnisses (Ordners), das das Home-Verzeichnis Ihrer Benutzer sein soll, wenn sie sich beim Server anmelden. Wenn Sie es auf einstellenPATH, sieht der Benutzer den absoluten Amazon S3-Bucket oder EFS Amazon-Pfad so, wie er in seinen File Transfer Protocol-Clients ist. Wenn Sie es auf einstellenLOGICAL, müssen Sie Zuordnungen angeben, wie Sie Amazon S3- oder EFS Amazon-Pfade HomeDirectoryMappings für Ihre Benutzer sichtbar machen möchten.

Anmerkung

HomeDirectoryTypeIst dies der LOGICAL Fall, müssen Sie mithilfe des Parameters Zuordnungen angeben. HomeDirectoryMappings Ist dies hingegen der Fall, HomeDirectoryType geben Sie mithilfe des Parameters einen absoluten Pfad anHomeDirectory. PATH Sie können nicht beides HomeDirectory und HomeDirectoryMappings in Ihrer Vorlage haben.

Typ: Zeichenfolge

Zulässige Werte: PATH | LOGICAL

Erforderlich: Nein

Policy

Eine Sitzungsrichtlinie für Ihren Benutzer, sodass Sie dieselbe AWS Identity and Access Management (IAM) Rolle für mehrere Benutzer verwenden können. Diese Richtlinie beschränkt den Zugriff eines Benutzers auf Teile seines Amazon S3 S3-Buckets. Variablen, die Sie in dieser Richtlinie verwenden können: ${Transfer:UserName}, ${Transfer:HomeDirectory} und ${Transfer:HomeBucket}.

Anmerkung

Diese Richtlinie gilt nur, wenn die Domain von Amazon S3 ServerId ist. Amazon verwendet EFS keine Sitzungsrichtlinien.

AWS Transfer Family Speichert für Sitzungsrichtlinien die Richtlinie als JSON Blob und nicht als Amazon-Ressourcennamen (ARN) der Richtlinie. Sie speichern die Richtlinie als JSON Blob und übergeben sie im Policy Argument.

Ein Beispiel für eine Sitzungsrichtlinien finden Sie unter Sitzungsrichtlinien.

Weitere Informationen finden Sie AssumeRolein der AWS Security Token Service API Reference.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 2048 Zeichen.

Erforderlich: Nein

PosixProfile

Gibt die vollständige POSIX Identität an, einschließlich Benutzer-ID (Uid), Gruppen-ID (Gid) und aller sekundären Gruppen IDs (SecondaryGids), die den Zugriff Ihrer Benutzer auf Ihre Amazon Elastic File Systems (AmazonEFS) steuert. Die POSIX Berechtigungen, die für Dateien und Verzeichnisse in Ihrem Dateisystem festgelegt sind, bestimmen die Zugriffsebene, die Ihre Benutzer erhalten, wenn sie Dateien in und aus Ihren EFS Amazon-Dateisystemen übertragen.

Typ: PosixProfile Objekt

Erforderlich: Nein

Role

Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), die den Zugriff Ihrer Benutzer auf Ihren Amazon S3-Bucket oder Ihr EFS Amazon-Dateisystem steuert. Die mit dieser Rolle verknüpften Richtlinien bestimmen die Zugriffsebene, die Sie Ihren Benutzern beim Übertragen von Dateien in und aus Ihrem Amazon S3 S3-Bucket oder EFS Amazon-Dateisystem gewähren möchten. Die IAM Rolle sollte auch eine Vertrauensbeziehung beinhalten, die es dem Server ermöglicht, bei der Bearbeitung der Übertragungsanfragen Ihrer Benutzer auf Ihre Ressourcen zuzugreifen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 2048 Zeichen.

Pattern: arn:.*role/\S+

Erforderlich: Nein

ServerId

Eine vom System zugewiesene eindeutige Kennung für eine Transfer Family Family-Serverinstanz, der der Benutzer zugewiesen ist.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

UserName

Eine eindeutige Zeichenfolge, die einen Benutzer identifiziert und einem Server zugeordnet ist, wie durch die ServerId festgelegt. Dieser Benutzername muss mindestens 3 und maximal 100 Zeichen enthalten. Folgende Zeichen sind gültig: a-z, A-Z, 0-9, Unterstrich '_', Bindestrich '-', Punkt '.'und beim Zeichen '@'. Der Benutzername kann nicht mit einem Bindestrich, einem Punkt oder einem At beginnen.

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",
   "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

Eine vom System zugewiesene eindeutige Kennung für eine Transfer Family Family-Serverinstanz, der das Konto zugewiesen ist.

Typ: Zeichenfolge

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

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

UserName

Der eindeutige Bezeichner für einen Benutzer, der einer Serverinstanz zugewiesen ist, die in der Anfrage angegeben wurde.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 100 Zeichen.

Pattern: [\w][\w@.-]{2,99}

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

ThrottlingException

Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.

HTTPStatuscode: 400

Beispiele

Beispiel

Im folgenden Beispiel wird ein Transfer Family Family-Benutzer aktualisiert.

Beispielanforderung

{
   "HomeDirectory": "/bucket2/documentation",
   "HomeDirectoryMappings": [ 
      { 
         "Entry": "/directory1",
         "Target": "/bucket_name/home/mydirectory"
      }
   ],
   "HomeDirectoryType:" "PATH",
   "Role": "AssumeRole",
   "ServerId": "s-01234567890abcdef",
   "UserName": "my_user"
}

Beispiel

Dies ist eine Beispielantwort für diesen API Anruf.

Beispielantwort

{
   "ServerId": "s-01234567890abcdef",
   "UserName": "my_user"
}

Weitere Informationen finden Sie unter:

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