Syntaxe de la requête Paramètres de demande Syntaxe de la réponse Eléments de réponse Erreurs Exemples consultez aussi

CreateLocationSmb

Crée un emplacement de transfert pour un serveur de fichiers SMB (Server Message Block). AWS DataSync peut utiliser cet emplacement comme source ou destination pour le transfert de données.

Avant de commencer, assurez-vous de bien comprendre comment DataSync accéder aux serveurs de fichiers SMB. Pour plus d'informations, consultez la section Fournir un DataSync accès aux serveurs de fichiers SMB.

Syntaxe de la requête


{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "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.

AgentArns

Spécifie l' DataSync agent (ou les agents) qui peuvent se connecter à votre serveur de fichiers SMB. Vous spécifiez un agent en utilisant son Amazon Resource Name (ARN).

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 4 articles.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Obligatoire : oui

AuthenticationType

Spécifie le protocole d'authentification DataSync utilisé pour se connecter à votre serveur de fichiers SMB. DataSync supports NTLM (par défaut) et KERBEROS authentification.

Pour plus d'informations, consultez la section Fournir un DataSync accès aux serveurs de fichiers SMB.

Type : String

Valeurs valides : NTLM | KERBEROS

Obligatoire : non

DnsIpAddresses

Spécifie les IPv4 adresses des serveurs DNS auxquels appartient votre serveur de fichiers SMB. Ce paramètre ne s'applique que s'AuthenticationTypeil est défini surKERBEROS.

Si votre environnement comporte plusieurs domaines, la configuration de ce paramètre garantit la DataSync connexion au bon serveur de fichiers SMB.

Type : tableau de chaînes

Membres du tableau : nombre maximum de 2 éléments.

Contraintes de longueur : longueur minimale de 7. Longueur maximale de 15.

Modèle : \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Obligatoire : non

Domain

Spécifie le nom de domaine Windows auquel appartient votre serveur de fichiers SMB. Ce paramètre ne s'applique que s'AuthenticationTypeil est défini surNTLM.

Si votre environnement comporte plusieurs domaines, la configuration de ce paramètre garantit la DataSync connexion au bon serveur de fichiers.

Type : String

Contraintes de longueur : longueur maximale de 253.

Modèle : ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

Obligatoire : non

KerberosKeytab

Spécifie votre fichier de table de clés Kerberos (keytab), qui inclut les mappages entre votre clé principale Kerberos et vos clés de chiffrement.

Le fichier doit être codé en base64. Si vous utilisez le AWS CLI, le codage est fait pour vous.

Pour éviter les erreurs d'exécution des tâches, assurez-vous que le principal Kerberos que vous utilisez pour créer le fichier keytab correspond exactement à ce que vous spécifiez. KerberosPrincipal

Type : objet de données binaires encodées en base64

Contraintes de longueur : longueur maximale de 65536.

Obligatoire : non

KerberosKrb5Conf

Spécifie un fichier de configuration Kerberos (krb5.conf) qui définit la configuration de votre domaine Kerberos.

Le fichier doit être codé en base64. Si vous utilisez le AWS CLI, le codage est fait pour vous.

Type : objet de données binaires encodées en base64

Contraintes de longueur : longueur maximale de 131072.

Obligatoire : non

KerberosPrincipal

Spécifie un principal Kerberos, c'est-à-dire une identité dans votre domaine Kerberos autorisée à accéder aux fichiers, aux dossiers et aux métadonnées des fichiers sur votre serveur de fichiers SMB.

Un principal Kerberos peut ressembler à. HOST/kerberosuser@MYDOMAIN.ORG

Les noms principaux distinguent les majuscules et minuscules. L'exécution de votre DataSync tâche échouera si le principal que vous spécifiez pour ce paramètre ne correspond pas exactement au principal que vous avez utilisé pour créer le fichier keytab.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : ^.+$

Obligatoire : non

MountOptions

Spécifie la version du protocole SMB DataSync utilisée pour accéder à votre serveur de fichiers SMB.

Type : objet SmbMountOptions

Obligatoire : non

Password

Spécifie le mot de passe de l'utilisateur qui peut monter votre serveur de fichiers SMB et qui est autorisé à accéder aux fichiers et dossiers concernés par votre transfert. Ce paramètre ne s'applique que s'AuthenticationTypeil est défini surNTLM.

Type : String

Contraintes de longueur : longueur maximale de 104.

Modèle : ^.{0,104}$

Obligatoire : non

ServerHostname

Spécifie le nom de domaine ou l'adresse IP du serveur de fichiers SMB que votre DataSync agent va monter.

N'oubliez pas les points suivants lors de la configuration de ce paramètre :

Vous ne pouvez pas spécifier d'adresse IP version 6 (IPv6).
Si vous utilisez l'authentification Kerberos, vous devez spécifier un nom de domaine.

Type : String

Contraintes de longueur : longueur maximale de 255.

Modèle : ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

Obligatoire : oui

Subdirectory

Spécifie le nom du partage exporté par votre serveur de fichiers SMB où les données DataSync seront lues ou écrites. Vous pouvez inclure un sous-répertoire dans le chemin de partage (par exemple,/path/to/subdirectory). Assurez-vous que les autres clients SMB de votre réseau peuvent également monter ce chemin.

Pour copier toutes les données du sous-répertoire, vous DataSync devez être en mesure de monter le partage SMB et d'accéder à toutes ses données. Pour plus d'informations, consultez la section Fournir un DataSync accès aux serveurs de fichiers SMB.

Type : String

Contraintes de longueur : longueur maximale de 4096.

Modèle : ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$

Obligatoire : oui

Tags

Spécifie des étiquettes qui vous aident à catégoriser, filtrer et rechercher vos ressources AWS . Nous vous recommandons de créer au moins une balise de nom pour votre emplacement.

Type : tableau d’objets TagListEntry

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.

Obligatoire : non

User

Spécifie l'utilisateur qui peut monter et accéder aux fichiers, aux dossiers et aux métadonnées des fichiers sur votre serveur de fichiers SMB. Ce paramètre ne s'applique que s'AuthenticationTypeil est défini surNTLM.

Pour plus d'informations sur le choix d'un utilisateur disposant du niveau d'accès approprié pour votre transfert, consultez la section Fournir un DataSync accès aux serveurs de fichiers SMB.

Type : String

Contraintes de longueur : longueur maximale de 104.

Modèle : ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

Obligatoire : non

Syntaxe de la réponse


{
   "LocationArn": "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.

LocationArn

L'ARN de l'emplacement SMB que vous avez créé.

Type : String

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync 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

Exemples

Exemple de demande

L'exemple suivant crée un emplacement pour un serveur de fichiers SMB.


{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
   ],
   "Domain":"AMAZON",
   "MountOptions":{
      "Version":"SMB3"
   },
   "Password":"string",
   "ServerHostname":"MyServer.amazon.com",
   "Subdirectory":"share",
   "Tags":[
      {
         "Key":"department",
         "Value":"finance"
      }
   ],
   "User":"user-1"
}

Exemple de réponse

Une réponse renvoie l'ARN de l'emplacement de votre serveur de fichiers SMB.


{
    "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CreateLocationS3

CreateTask