CreateAgent - AWS DataSync

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.

CreateAgent

Active unAWS DataSyncagent que vous avez déployé sur votre hôte. Le processus d'activation associe votre agent au compte AWS. Dans le processus d'activation, vous spécifiez des informations telles que laRégion AWSdans laquelle vous souhaitez activer l'agent. Vous activez l'agent dans laRégion AWSoù résident vos emplacements cibles (dans Amazon S3 ou Amazon EFS). Vos tâches sont créées dans cetteRégion AWS.

Vous pouvez activer l'agent dans un VPC (Virtual Private Cloud) ou fournir à l'agent l'accès à un point de terminaison de VPC pour pouvoir exécuter des tâches sans passer par l'Internet public.

Vous pouvez utiliser un agent pour plusieurs emplacements. Si une tâche utilise plusieurs agents, ils doivent tous avoir le statut AVAILABLE (DISPONIBLE) pour que la tâche s'exécute. Si vous utilisez plusieurs agents pour un emplacement source, le statut de tous les agents doit être AVAILABLE pour pouvoir exécuter la tâche.

Pour de plus amples informations, veuillez consulterCréation et activation d'un agentdans le AWS DataSyncGuide de l'utilisateur.

Les agents sont automatiquement mis à jour parAWSrégulièrement, à l'aide d'un mécanisme qui garantit une interruption minimale de vos tâches.

Syntaxe de la demande

{ "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" }

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voirParamètres courants.

Cette demande accepte les données suivantes au format JSON.

ActivationKey

Votre clé d'activation de l'agent. Vous pouvez obtenir la clé d'activation en envoyant une requête GET HTTP avec des redirections qui vous permettent d'obtenir l'adresse IP de l'agent (port 80). Vous pouvez également l'obtenir à partir de la console DataSync.

L'URL de redirection renvoyée dans la réponse vous fournit la clé d'activation de votre agent dans le paramètre de chaîne de requête activationKey. Elle peut également inclure d'autres paramètres liés à l'activation ; cependant, ce ne sont que des valeurs par défaut. Les arguments que vous transmettez à cet appel d'API déterminent la configuration réelle de votre agent.

Pour de plus amples informations, veuillez consulterCréation et activation d'un agentdans le AWS DataSyncGuide de l'utilisateur .

Type : Chaîne

Contraintes de longueur : Longueur maximale de 29.

Modèle : [A-Z0-9]{5}(-[A-Z0-9]{5}){4}

Prérequis : Oui

AgentName

Nom que vous avez configuré pour votre agent. Cette valeur est une référence de texte utilisée pour identifier l'agent dans la console.

Type : Chaîne

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

Modèle : ^[a-zA-Z0-9\s+=._:@/-]+$

Prérequis : Non

SecurityGroupArns

ARN des groupes de sécurité utilisés pour protéger vos sous-réseaux de tâches de transfert de données. VoirSecurityGroupArns.

Type : Tableau de chaînes

Membres du tableau : Nombre fixe de 1 élément.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Prérequis : Non

SubnetArns

Les Amazon Resource Name (ARN) des sous-réseaux dans lesquels DataSync créera des interfaces réseau Elastic pour chaque tâche de transfert de données. L'agent qui exécute une tâche doit être privé. Lorsque vous démarrez une tâche associée à un agent créé dans un VPC ou qui a accès à une adresse IP dans un VPC, la tâche est également privée. Dans ce cas, DataSync crée quatre interfaces réseau pour chaque tâche de votre sous-réseau. Pour qu'un transfert de données fonctionne, l'agent doit pouvoir acheminer vers ces quatre interfaces réseau.

Type : Tableau de chaînes

Membres du tableau : Nombre fixe de 1 élément.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$

Prérequis : Non

Tags

Paire clé-valeur qui représente la balise que vous souhaitez associer à l'agent. La valeur peut être une chaîne vide. Cette valeur vous aide à gérer, filtrer et rechercher vos agents.

Note

Les caractères valides pour la clé et la valeur sont des lettres, des espaces et des nombres représentables au format UTF-8, et les caractères spéciaux suivants : + - = . _ : / @.

Type : Grappe deTagListEntryobjets

Membres du tableau : Nombre minimal de 0 éléments. Nombre maximal de 50 éléments.

Prérequis : Non

VpcEndpointId

ID du point de terminaison de VPC (Virtual Private Cloud) auquel l'agent a accès. Il s'agit du point de terminaison de VPC côté client, également appelé PrivateLink. Si vous n'avez pas de point de terminaison de VPC PrivateLink, reportez-vous à la sectionCréation d'une configuration de service de point de terminaison de VPCdu Guide de l'utilisateur Amazon VPC.

L'ID du point de terminaison de VPC ressemble à ceci : vpce-01234d5aff67890e1.

Type : Chaîne

Modèle : ^vpce-[0-9a-f]{17}$

Prérequis : Non

Syntaxe de la réponse

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

AgentArn

Amazon Resource Name (ARN) de l'agent. Utilisation de l'ListAgentspour renvoyer une liste d'agents pour votre compte etRégion AWS.

Type : Chaîne

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}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, voirErreurs courantes.

InternalException

Cette exception est renvoyée lorsqu'une erreur se produit dans laAWS DataSyncservice.

HTTP Status Code : 500

InvalidRequestException

Cette exception est renvoyée lorsque le client envoie une demande mal formée.

HTTP Status Code : 400

Exemples

Exemple

L'exemple suivant crée un agent et l'active à l'aide d'une clé d'activation.

Exemple de demande

{ "ActivationKey": "AAAAA-7AAAA-GG7MC-3I9R3-27COD", "AgentName": "MyAgent", "Tags": [ { "Key": "Job", "Value": "TransferJob-1" } ] }

Exemple

La réponse renvoie l'Amazon Resource Name (ARN) de l'agent activé.

Exemple de réponse

{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }

Voir aussi

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :