CreateAgent - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

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 un AWS DataSync agent que vous avez déployé dans votre environnement de stockage. Le processus d'activation associe l'agent à votreCompte AWS.

Si vous n'avez pas encore déployé d'agent, consultez les rubriques suivantes pour en savoir plus :

Note

Si vous effectuez un transfert entre services AWS de stockage, vous n'avez pas besoin d'un DataSync agent.

Syntaxe de la requête

{
   "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, voir Paramètres communs.

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

ActivationKey

Spécifie la clé d'activation de votre DataSync agent. Si vous ne possédez pas de clé d'activation, consultez la section Activer votre agent.

Type : String

Contraintes de longueur : Longueur maximum de 29.

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

Obligatoire : oui

AgentName

Spécifie le nom de votre agent. Vous pouvez voir ce nom dans la DataSync console.

Type : String

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

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

Obligatoire : non

SecurityGroupArns

Spécifie le nom de ressource Amazon (ARN) du groupe de sécurité qui protège les interfaces réseau de votre tâche lors de l'utilisation d'un point de terminaison de cloud privé virtuel (VPC).

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/sg-[a-f0-9]+$

Obligatoire : non

SubnetArns

Spécifie l'ARN du sous-réseau sur lequel vous souhaitez exécuter votre DataSync tâche lorsque vous utilisez un point de terminaison VPC. Il s'agit du sous-réseau qui DataSync crée et gère les interfaces réseau pour votre transfert.

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/.*$

Obligatoire : non

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 pour votre agent.

Type : tableau d’objets TagListEntry

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

Obligatoire : non

VpcEndpointId

Spécifie l'ID du point de terminaison d'un VPC auquel vous souhaitez que votre agent se connecte. Par exemple, un ID de point de terminaison d'un VPC ressemble vpce-01234d5aff67890e1 à.

Important

Le point de terminaison du VPC que vous utilisez doit inclure le nom du DataSync service (par exemple,com.amazonaws.us-east-2.datasync).

Type : String

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

Obligatoire : 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

L'ARN de l'agent que vous venez d'activer. Utilisez cette ListAgentsopération pour renvoyer la liste des agents présents dans votre Compte AWS annonceRégion AWS.

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}:agent/agent-[0-9a-z]{17}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, reportez-vous à la sectionErreurs 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 active un DataSync agent et l'associe à votreCompte AWS.

{
    "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE",
    "AgentName": "MyAgent",
    "Tags": [{
        "Key": "Job",
        "Value": "TransferJob-1"
    }]
}

Exemple de réponse

La réponse renvoie l'ARN de l'agent activé.

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