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á.

# CreateAgent
<a name="API_CreateAgent"></a>

Ativa um AWS DataSync agente que você implanta em seu ambiente de armazenamento. O processo de ativação associa o agente ao seu Conta da AWS.

Se você ainda não implantou um agente, consulte [Preciso de um DataSync agente](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html)? 

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

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

## Parâmetros da solicitação
<a name="API_CreateAgent_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.

 ** [ActivationKey](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-ActivationKey"></a>
Especifica a chave de ativação do seu DataSync agente. Se você não tiver uma chave de ativação, consulte [Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 29.  
Padrão: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}`   
Obrigatório: Sim

 ** [AgentName](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-AgentName"></a>
Especifica um nome para o seu agente. Recomendamos especificar um nome que possa lembrar.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\s+=._:@/-]+$`   
Obrigatório: não

 ** [SecurityGroupArns](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-SecurityGroupArns"></a>
Especifica o nome do recurso da Amazon (ARN) do grupo de segurança que permite tráfego entre o agente e endpoint de serviço da VPC. Você pode especificar apenas ARN.  
Tipo: matriz de strings  
Membros da matriz: número fixo de 1 item.  
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):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`   
Obrigatório: não

 ** [SubnetArns](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-SubnetArns"></a>
Especifica o ARN da sub-rede em que o endpoint da VPC está localizado. Você pode especificar apenas ARN.  
Tipo: matriz de strings  
Membros da matriz: número fixo de 1 item.  
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):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$`   
Obrigatório: não

 ** [Tags](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus AWS recursos. Recomendamos criar pelo menos uma etiqueta para o seu agente.  
Tipo: matriz de objetos [TagListEntry](API_TagListEntry.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 50 itens.  
Obrigatório: não

 ** [VpcEndpointId](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-VpcEndpointId"></a>
Especifica o ID do [endpoint de serviço da VPC](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc) que você está usando. Por exemplo, um ID de endpoint da VPC parece `vpce-01234d5aff67890e1`.  
O endpoint de serviço VPC que você usa deve incluir o nome do DataSync serviço (por exemplo,). `com.amazonaws.us-east-2.datasync`
Tipo: sequência  
Padrão: `^vpce-[0-9a-f]{17}$`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_CreateAgent_ResponseSyntax"></a>

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

## Elementos de resposta
<a name="API_CreateAgent_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_CreateAgent_ResponseSyntax) **   <a name="DataSync-CreateAgent-response-AgentArn"></a>
O ARN do agente que você acabou de ativar. Use a [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html)operação para retornar uma lista de agentes em seu Conta da AWS Região da AWS e.  
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}$` 

## Erros
<a name="API_CreateAgent_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_CreateAgent_Examples"></a>

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

O exemplo a seguir ativa um DataSync agente.

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

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

A resposta retorna o ARN do agente ativado.

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

## Consulte também
<a name="API_CreateAgent_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/CreateAgent) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateAgent) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateAgent)