As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Retorna informações sobre um AWS DataSync agente, como nome, tipo de endpoint de serviço e status.

## Sintaxe da solicitação
<a name="API_DescribeAgent_RequestSyntax"></a>

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

## Parâmetros da solicitação
<a name="API_DescribeAgent_RequestParameters"></a>

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

A solicitação aceita os dados a seguir no formato JSON.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Especifica o Amazon Resource Name (ARN) do agente sobre DataSync o qual você deseja obter informações.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 128.  
Padrão: `^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}$`   
Obrigatório: sim

## Sintaxe da resposta
<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 resposta
<a name="API_DescribeAgent_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
O ARN do agente.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 128.  
Padrão: `^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>
A hora em que o agente foi [ativado](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).  
Tipo: Timestamp

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
O tipo de [endpoint de serviço](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) ao qual seu agente está conectado.  
Tipo: string  
Valores válidos: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
A última vez em que o agente estava se comunicando com o DataSync serviço.  
Tipo: Timestamp

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
O nome do agente.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
Os detalhes relacionados à plataforma sobre o agente, como o número da versão.  
Tipo: objeto [Platform](API_Platform.md)

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
A configuração de rede que o agente usa ao se conectar a um [endpoint de serviço 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>
O status do agente.  
+ Se o status for `ONLINE`, o agente está configurado corretamente e pronto para uso.
+ Se o status for`OFFLINE`, o agente esteve fora de contato DataSync por cinco minutos ou mais. Isso pode acontecer por alguns motivos. Para obter mais informações, consulte [O que eu faço se meu agente estiver off-line?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Tipo: string  
Valores válidos: `ONLINE | OFFLINE` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Tipos de erro comuns](CommonErrors.md).

 ** InternalException **   
Essa exceção é lançada quando ocorre um erro no serviço AWS DataSync .  
Código de status HTTP: 500

 ** InvalidRequestException **   
Essa exceção é lançada quando o cliente envia uma solicitação malformada.  
Código de status HTTP: 400

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

### Exemplo de solicitação
<a name="API_DescribeAgent_Example_1"></a>

O exemplo a seguir retorna informações sobre um agente especificado em uma solicitação.

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

### Resposta da amostra
<a name="API_DescribeAgent_Example_2"></a>

O exemplo de resposta a seguir descreve um agente que usa um endpoint de serviço 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"
    }
}
```

## Consulte também
<a name="API_DescribeAgent_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando 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)