Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Devuelve información sobre un AWS DataSync agente, como su nombre, tipo de punto final del servicio y estado.

## Sintaxis de la solicitud
<a name="API_DescribeAgent_RequestSyntax"></a>

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

## Parámetros de la solicitud
<a name="API_DescribeAgent_RequestParameters"></a>

Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

La solicitud acepta los siguientes datos en formato JSON.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Especifica el nombre de recurso de Amazon (ARN) del DataSync agente sobre el que desea obtener información.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 128 caracteres.  
Patrón: `^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}$`   
Obligatorio: sí

## Sintaxis de la respuesta
<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"
}
```

## Elementos de respuesta
<a name="API_DescribeAgent_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
El ARN del agente.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 128 caracteres.  
Patrón: `^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>
La hora a la que se [activó](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) el agente.  
Tipo: marca temporal

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
El tipo de [punto de conexión del servicio](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) al que está conectado el agente.  
Tipo: cadena  
Valores válidos: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
La última vez que el agente se comunicó con el DataSync servicio.  
Tipo: marca temporal

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
El nombre del agente.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Patrón: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
Los detalles relacionados con la plataforma sobre el agente, como el número de versión.  
Tipo: objeto [Platform](API_Platform.md)

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
La configuración de red que usa el agente cuando se conecta a un [punto de conexión del servicio de VPC](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc).  
Tipo: objeto [PrivateLinkConfig](API_PrivateLinkConfig.md)

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
El estado del agente.  
+ Si el estado es `ONLINE`, el agente está configurado correctamente y listo para usarse.
+ Si el estado es`OFFLINE`, el agente no ha estado en contacto con él DataSync durante cinco minutos o más. Esto puede suceder por varias razones. Para obtener más información, consulte [What do I do if my agent is offline?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Tipo: cadena  
Valores válidos: `ONLINE | OFFLINE` 

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Tipos de errores comunes](CommonErrors.md).

 ** InternalException **   
Esta excepción se produce cuando se genera un error en el servicio AWS DataSync .  
Código de estado HTTP: 500

 ** InvalidRequestException **   
Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.  
Código de estado HTTP: 400

## Ejemplos
<a name="API_DescribeAgent_Examples"></a>

### Solicitud de ejemplo
<a name="API_DescribeAgent_Example_1"></a>

En el siguiente ejemplo, se arroja información sobre un agente especificado en una solicitud.

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

### Respuesta de ejemplo
<a name="API_DescribeAgent_Example_2"></a>

El siguiente ejemplo de respuesta describe un agente que usa un punto de conexión de servicio público.

```
{
    "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"
    }
}
```

## Véase también
<a name="API_DescribeAgent_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent)