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.

# DescribeAgent
<a name="API_DescribeAgent"></a>

Renvoie des informations sur un AWS DataSync agent, telles que son nom, son type de point de terminaison de service et son statut.

## Syntaxe de la requête
<a name="API_DescribeAgent_RequestSyntax"></a>

```
{
   "AgentArn": "string"
}
```

## Paramètres de demande
<a name="API_DescribeAgent_RequestParameters"></a>

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

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

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Spécifie le nom de ressource Amazon (ARN) de l' DataSync agent sur lequel vous souhaitez obtenir des informations.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
Obligatoire : oui

## Syntaxe de la réponse
<a name="API_DescribeAgent_ResponseSyntax"></a>

```
{
   "AgentArn": "string",
   "CreationTime": number,
   "EndpointType": "string",
   "LastConnectionTime": number,
   "Name": "string",
   "Platform": { 
      "Version": "string"
   },
   "PrivateLinkConfig": { 
      "PrivateLinkEndpoint": "string",
      "SecurityGroupArns": [ "string" ],
      "SubnetArns": [ "string" ],
      "VpcEndpointId": "string"
   },
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeAgent_ResponseElements"></a>

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](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
ARN de l’agent.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 128.  
Modèle : `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` 

 ** [CreationTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-CreationTime"></a>
Heure à laquelle l'agent a été [activé](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).  
Type : Timestamp

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
Type de point de [terminaison de service](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) auquel votre agent est connecté.  
Type : Chaîne  
Valeurs valides : `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
La dernière fois que l'agent a communiqué avec le DataSync service.  
Type : Timestamp

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
Le nom de l'agent.  
Type : Chaîne  
Contraintes de longueur : Longueur minimum de 0. Longueur maximum de 256.  
Modèle : `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
Les informations relatives à la plate-forme concernant l'agent, telles que le numéro de version.  
Type : objet [Platform](API_Platform.md)

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
Configuration réseau utilisée par l'agent lors de la connexion à un point de terminaison de [service VPC](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc).  
Type : objet [PrivateLinkConfig](API_PrivateLinkConfig.md)

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
Le statut de l'agent.  
+ Si le statut est défini`ONLINE`, l'agent est correctement configuré et prêt à être utilisé.
+ Si le statut est le cas`OFFLINE`, cela signifie que l'agent a été hors de contact avec DataSync lui pendant cinq minutes ou plus. Cela peut se produire pour plusieurs raisons. Pour plus d'informations, voir [Que dois-je faire si mon agent est hors ligne ?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Type : Chaîne  
Valeurs valides : `ONLINE | OFFLINE` 

## Erreurs
<a name="API_DescribeAgent_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** 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
<a name="API_DescribeAgent_Examples"></a>

### Exemple de demande
<a name="API_DescribeAgent_Example_1"></a>

L'exemple suivant renvoie des informations sur un agent spécifié dans une demande.

```
{
  "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}
```

### Exemple de réponse
<a name="API_DescribeAgent_Example_2"></a>

L'exemple de réponse suivant décrit un agent qui utilise un point de terminaison de service public.

```
{
    "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
    "Name": "Data center migration agent",
    "Status": "ONLINE",
    "LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
    "CreationTime": "2022-10-05T20:52:29.499000+00:00",
    "EndpointType": "PUBLIC",
    "Platform": {
        "Version": "2"
    }
}
```

## Voir aussi
<a name="API_DescribeAgent_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent)