Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
UpdateAccess
Vous permet de mettre à jour les paramètres d'accès spécifiés dans les ExternalID
paramètres ServerID
et.
Syntaxe de la requête
{
"ExternalId": "string
",
"HomeDirectory": "string
",
"HomeDirectoryMappings": [
{
"Entry": "string
",
"Target": "string
",
"Type": "string
"
}
],
"HomeDirectoryType": "string
",
"Policy": "string
",
"PosixProfile": {
"Gid": number
,
"SecondaryGids": [ number
],
"Uid": number
},
"Role": "string
",
"ServerId": "string
"
}
Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
Cette demande accepte les données suivantes au format JSON.
- ExternalId
-
Identifiant unique requis pour identifier des groupes spécifiques au sein de votre annuaire. Les utilisateurs du groupe que vous associez ont accès à vos ressources Amazon S3 ou Amazon EFS via les protocoles activés à l'aide de AWS Transfer Family. Si vous connaissez le nom du groupe, vous pouvez afficher les valeurs SID en exécutant la commande suivante sous Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
Dans cette commande, remplacez YourGroupNamepar le nom de votre groupe Active Directory.
L'expression régulière utilisée pour valider ce paramètre est une chaîne de caractères composée de caractères alphanumériques majuscules et minuscules sans espaces. Vous pouvez également inclure des traits de soulignement ou l'un des caractères suivants : =, . @ : /-
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
S-1-[\d-]+
Obligatoire : oui
- HomeDirectory
-
La destination d'un répertoire (dossier) pour un utilisateur lorsqu'il se connecte au serveur à l'aide de son client.
Un exemple de
HomeDirectory
est/bucket_name/home/mydirectory
.Note
Le paramètre
HomeDirectory
est uniquement utilisé siHomeDirectoryType
est défini sur la valeurPATH
.Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.
Modèle :
(|/.*)
Obligatoire : non
- HomeDirectoryMappings
-
Des mappages de répertoires logiques qui spécifient quels chemins et clés Amazon S3 ou Amazon EFS doivent être visibles par votre utilisateur et comment vous souhaitez les rendre visibles. Vous devez spécifier la
Target
paireEntry
et, quiEntry
indique comment le chemin est rendu visible et correspondTarget
au chemin Amazon S3 ou Amazon EFS réel. Si vous spécifiez uniquement une cible, elle est affichée telle quelle. Vous devez également vous assurer que votre rôle AWS Identity and Access Management (IAM) donne accès aux chemins d'accès.Target
Cette valeur ne peut être définie que si elleHomeDirectoryType
est définie sur LOGICAL.Voici un exemple de
Target
paireEntry
et.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
Dans la plupart des cas, vous pouvez utiliser cette valeur au lieu de la politique de session pour verrouiller votre utilisateur dans le répertoire de base désigné (»
chroot
«). Pour ce faire, vous pouvezEntry
définir/
etTarget
définir la valeur duHomeDirectory
paramètre.Voici un exemple de
Target
paireEntry
et pourchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
Type : tableau d’objets HomeDirectoryMapEntry
Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 50 000 articles.
Obligatoire : non
- HomeDirectoryType
-
Le type de répertoire (dossier) de destination du répertoire de base de vos utilisateurs lorsqu'ils se connectent au serveur. Si vous le définissez sur
PATH
, l'utilisateur verra le bucket Amazon S3 ou le chemin Amazon EFS absolu tels quels dans leurs clients de protocole de transfert de fichiers. Si vous le définissez surLOGICAL
, vous devez fournir des mappages indiquant comment vous souhaitez rendre lesHomeDirectoryMappings
chemins Amazon S3 ou Amazon EFS visibles pour vos utilisateurs.Note
Dans
HomeDirectoryType
l'affirmativeLOGICAL
, vous devez fournir des mappages à l'aide duHomeDirectoryMappings
paramètre. Si, par contre,HomeDirectoryType
c'est le casPATH
, vous fournissez un chemin absolu à l'aide duHomeDirectory
paramètre. Vous ne pouvez pas avoir les deuxHomeDirectory
etHomeDirectoryMappings
dans votre modèle.Type : chaîne
Valeurs valides :
PATH | LOGICAL
Obligatoire : non
- Policy
-
Une politique de session pour votre utilisateur afin que vous puissiez utiliser le même rôle AWS Identity and Access Management (IAM) pour plusieurs utilisateurs. Cette politique limite l'accès d'un utilisateur à certaines parties de son compartiment Amazon S3. Les variables que vous pouvez utiliser à l'intérieur de cette politique incluent
${Transfer:UserName}
,${Transfer:HomeDirectory}
et${Transfer:HomeBucket}
.Note
Cette politique s'applique uniquement lorsque le domaine de
ServerId
est Amazon S3. Amazon EFS n'utilise pas de politiques de session.Pour les politiques de session, AWS Transfer Family stocke la politique sous forme de blob JSON, au lieu du nom de ressource Amazon (ARN) de la politique. Vous enregistrez la politique comme objet blob JSON et la transmettez dans l'argument
Policy
.Pour obtenir un exemple de politique de session, veuillez consulter la rubrique Exemple de politique de session.
Pour plus d'informations, consultez le document AssumeRolede référence AWS de l'API du Security Token Service.
Type : chaîne
Contraintes de longueur : longueur minimale de 0. Longueur maximale de 2048.
Obligatoire : non
- PosixProfile
-
Identité POSIX complète, y compris l'ID utilisateur (
Uid
), l'ID de groupe (Gid
) et les ID de groupes secondaires (SecondaryGids
), qui contrôle l'accès de vos utilisateurs à vos systèmes de fichiers Amazon EFS. Les autorisations POSIX définies sur les fichiers et répertoires de votre système de fichiers déterminent le niveau d'accès accordé à vos utilisateurs lors du transfert de fichiers depuis et vers vos systèmes de fichiers Amazon EFS.Type : objet PosixProfile
Obligatoire : non
- Role
-
Le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui contrôle l'accès de vos utilisateurs à votre compartiment Amazon S3 ou à votre système de fichiers Amazon EFS. Les politiques associées à ce rôle déterminent le niveau d'accès que vous souhaitez accorder à vos utilisateurs lorsqu'ils transfèrent des fichiers depuis et vers votre compartiment Amazon S3 ou votre système de fichiers Amazon EFS. Le rôle IAM doit également contenir une relation d'approbation qui permet au serveur d'accéder à vos ressources lors du traitement des demandes de transfert de votre utilisateur.
Type : chaîne
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.
Modèle :
arn:.*role/\S+
Obligatoire : non
- ServerId
-
Identifiant unique attribué par le système pour une instance de serveur. Il s'agit du serveur spécifique auquel vous avez ajouté votre utilisateur.
Type : chaîne
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})
Obligatoire : oui
Syntaxe de la réponse
{
"ExternalId": "string",
"ServerId": "string"
}
Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- ExternalId
-
Identifiant externe du groupe dont les utilisateurs ont accès à vos ressources Amazon S3 ou Amazon EFS via les protocoles activés à l'aide de AWS Transfer Family.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
S-1-[\d-]+
- ServerId
-
Identifiant du serveur auquel l'utilisateur est rattaché.
Type : chaîne
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InternalServiceError
-
Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.
Code d’état HTTP : 500
- InvalidRequestException
-
Cette exception est levée lorsque le client soumet une demande mal formée.
Code d’état HTTP : 400
- ResourceExistsException
-
La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.
Code d’état HTTP : 400
- ResourceNotFoundException
-
Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.
Code d’état HTTP : 400
- ServiceUnavailableException
-
La demande a échoué car le service AWS Transfer Family n'est pas disponible.
Code d’état HTTP : 500
- ThrottlingException
-
La demande a été refusée suite à une limitation des demandes.
Code d’état HTTP : 400
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :