

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

# AWS DataSync API
<a name="API_Reference"></a>

Além do Console de gerenciamento da AWS e AWS CLI, você pode usar a AWS DataSync API para configurar e gerenciar DataSync com [AWS SDKs](https://aws.amazon.com/developer/tools/)o.

**Topics**
+ [

# Ações
](API_Operations.md)
+ [

# Tipos de dados
](API_Types.md)
+ [

# Erros comuns
](CommonErrors.md)
+ [

# Parâmetros gerais
](CommonParameters.md)

# Ações
<a name="API_Operations"></a>

As ações a seguir são compatíveis:
+  [CancelTaskExecution](API_CancelTaskExecution.md) 
+  [CreateAgent](API_CreateAgent.md) 
+  [CreateLocationAzureBlob](API_CreateLocationAzureBlob.md) 
+  [CreateLocationEfs](API_CreateLocationEfs.md) 
+  [CreateLocationFsxLustre](API_CreateLocationFsxLustre.md) 
+  [CreateLocationFsxOntap](API_CreateLocationFsxOntap.md) 
+  [CreateLocationFsxOpenZfs](API_CreateLocationFsxOpenZfs.md) 
+  [CreateLocationFsxWindows](API_CreateLocationFsxWindows.md) 
+  [CreateLocationHdfs](API_CreateLocationHdfs.md) 
+  [CreateLocationNfs](API_CreateLocationNfs.md) 
+  [CreateLocationObjectStorage](API_CreateLocationObjectStorage.md) 
+  [CreateLocationS3](API_CreateLocationS3.md) 
+  [CreateLocationSmb](API_CreateLocationSmb.md) 
+  [CreateTask](API_CreateTask.md) 
+  [DeleteAgent](API_DeleteAgent.md) 
+  [DeleteLocation](API_DeleteLocation.md) 
+  [DeleteTask](API_DeleteTask.md) 
+  [DescribeAgent](API_DescribeAgent.md) 
+  [DescribeLocationAzureBlob](API_DescribeLocationAzureBlob.md) 
+  [DescribeLocationEfs](API_DescribeLocationEfs.md) 
+  [DescribeLocationFsxLustre](API_DescribeLocationFsxLustre.md) 
+  [DescribeLocationFsxOntap](API_DescribeLocationFsxOntap.md) 
+  [DescribeLocationFsxOpenZfs](API_DescribeLocationFsxOpenZfs.md) 
+  [DescribeLocationFsxWindows](API_DescribeLocationFsxWindows.md) 
+  [DescribeLocationHdfs](API_DescribeLocationHdfs.md) 
+  [DescribeLocationNfs](API_DescribeLocationNfs.md) 
+  [DescribeLocationObjectStorage](API_DescribeLocationObjectStorage.md) 
+  [DescribeLocationS3](API_DescribeLocationS3.md) 
+  [DescribeLocationSmb](API_DescribeLocationSmb.md) 
+  [DescribeTask](API_DescribeTask.md) 
+  [DescribeTaskExecution](API_DescribeTaskExecution.md) 
+  [ListAgents](API_ListAgents.md) 
+  [ListLocations](API_ListLocations.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTaskExecutions](API_ListTaskExecutions.md) 
+  [ListTasks](API_ListTasks.md) 
+  [StartTaskExecution](API_StartTaskExecution.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAgent](API_UpdateAgent.md) 
+  [UpdateLocationAzureBlob](API_UpdateLocationAzureBlob.md) 
+  [UpdateLocationEfs](API_UpdateLocationEfs.md) 
+  [UpdateLocationFsxLustre](API_UpdateLocationFsxLustre.md) 
+  [UpdateLocationFsxOntap](API_UpdateLocationFsxOntap.md) 
+  [UpdateLocationFsxOpenZfs](API_UpdateLocationFsxOpenZfs.md) 
+  [UpdateLocationFsxWindows](API_UpdateLocationFsxWindows.md) 
+  [UpdateLocationHdfs](API_UpdateLocationHdfs.md) 
+  [UpdateLocationNfs](API_UpdateLocationNfs.md) 
+  [UpdateLocationObjectStorage](API_UpdateLocationObjectStorage.md) 
+  [UpdateLocationS3](API_UpdateLocationS3.md) 
+  [UpdateLocationSmb](API_UpdateLocationSmb.md) 
+  [UpdateTask](API_UpdateTask.md) 
+  [UpdateTaskExecution](API_UpdateTaskExecution.md) 

# CancelTaskExecution
<a name="API_CancelTaskExecution"></a>

Interrompe AWS DataSync a execução de uma tarefa que está em andamento. A transferência de alguns arquivos é interrompida abruptamente. O conteúdo do arquivo transferido para o destino pode estar incompleto ou inconsistente com os arquivos de origem.

No entanto, se você iniciar uma nova execução de tarefa usando a mesma tarefa e permitir que ela termine, o conteúdo do arquivo no destino será completo e consistente. Isto se aplica a outras falhas inesperadas que interrompem a execução de uma tarefa. Em todos esses casos, conclui DataSync com êxito a transferência ao iniciar a próxima execução da tarefa.

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

```
{
   "TaskExecutionArn": "string"
}
```

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

 ** [TaskExecutionArn](#API_CancelTaskExecution_RequestSyntax) **   <a name="DataSync-CancelTaskExecution-request-TaskExecutionArn"></a>
O nome do recurso da Amazon (ARN) da execução da tarefa a ser interrompida.  
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_CancelTaskExecution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# 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 [Erros 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) 

# CreateLocationAzureBlob
<a name="API_CreateLocationAzureBlob"></a>

Cria um *local* de transferência para um contêiner do Microsoft Azure Blob Storage. AWS DataSync pode usar esse local como origem ou destino de transferência. Você pode fazer transferências com ou sem um [DataSync agente](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent) que se conecta ao seu contêiner.

[Antes de começar, certifique-se de saber [como DataSync acessa o Armazenamento de Blobs do Azure e trabalha com [camadas de acesso](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) e tipos de blob](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access).](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types)

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

```
{
   "AccessTier": "string",
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlobType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "ContainerUrl": "string",
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "SasConfiguration": { 
      "Token": "string"
   },
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [AccessTier](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-AccessTier"></a>
Especifica o nível de acesso para o qual deseja que seus objetos ou arquivos sejam transferidos. Isso só se aplica ao usar o local como destino de transferência. Para obter mais informações, consulte [Níveis de acesso](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers).  
Tipo: String  
Valores válidos: `HOT | COOL | ARCHIVE`   
Obrigatório: não

 ** [AgentArns](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-AgentArns"></a>
(Opcional) Especifica o Amazon Resource Name (ARN) do agente que pode se conectar DataSync ao seu contêiner do Azure Blob Storage. Se você estiver configurando uma transferência entre nuvens sem atendente, não precisará especificar um valor para esse parâmetro.  
Você pode especificar mais de um atendente. Para obter mais informações, consulte [Utilizar vários agentes para sua transferência](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html).  
Certifique-se de configurar esse parâmetro corretamente ao criar ao local de armazenamento pela primeira vez. Você não pode adicionar ou remover atendentes de um local de armazenamento depois de criá-lo.
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [AuthenticationType](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-AuthenticationType"></a>
Especifica o método de autenticação DataSync usado para acessar seu Armazenamento de Blobs do Azure. DataSync pode acessar o armazenamento de blobs usando uma assinatura de acesso compartilhado (SAS).  
Tipo: string  
Valores válidos: `SAS | NONE`   
Obrigatório: Sim

 ** [BlobType](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-BlobType"></a>
Especifica o tipo de blob que você deseja que seus objetos ou arquivos sejam ao transferi-los para o Armazenamento de Blobs do Azure. Atualmente, DataSync só dá suporte à movimentação de dados para o Armazenamento de Blobs do Azure como blobs de blocos. Para obter mais informações sobre os tipos de blob, consulte a [Documentação do armazenamento de blobs do Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs).  
Tipo: String  
Valores válidos: `BLOCK`   
Obrigatório: não

 ** [CmkSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, que inclui o token de autenticação DataSync usado para acessar um local de AzureBlob armazenamento específico, com um gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationAzureBlob` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com o token de autenticação que você especifica `SasConfiguration` para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS que você especificou. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com `SasConfiguration`) ou `CustomSecretConfig` (sem `SasConfiguration`) para fornecer credenciais para uma solicitação `CreateLocationAzureBlob`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [ContainerUrl](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-ContainerUrl"></a>
Especifica a URL do contêiner de Armazenamento de Blobs do Azure envolvido na transferência.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 325.  
Padrão: `^https:\/\/[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}\/[a-z0-9](-?[a-z0-9]){2,62}$`   
Obrigatório: Sim

 ** [CustomSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que o token de autenticação de um local AzureBlob de armazenamento é armazenado em texto simples, no Secrets Manager. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `SasConfiguration`) ou `CustomSecretConfig` (sem `SasConfiguration`) para fornecer credenciais para uma solicitação `CreateLocationAzureBlob`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [SasConfiguration](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-SasConfiguration"></a>
Especifica a configuração SAS que permite acessar seu DataSync Armazenamento de Blobs do Azure.  
Se você fornecer um token de autenticação usando`SasConfiguration`, mas não fornecer detalhes de configuração secreta usando `CmkSecretConfig` ou`CustomSecretConfig`, então DataSync armazena o token usando o segredo do gerenciador de segredos da sua AWS conta.
Tipo: objeto [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md)  
Obrigatório: Não

 ** [Subdirectory](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-Subdirectory"></a>
Especifica segmentos de caminho se você quiser limitar a transferência para um diretório virtual no contêiner (por exemplo, `/my/images`).  
Tipo: String  
Restrições de comprimento: comprimento máximo de 1024.  
Padrão: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$`   
Obrigatório: Não

 ** [Tags](#API_CreateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-CreateLocationAzureBlob-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS . Recomendamos criar pelo menos uma etiqueta de nome para seu local de transferência.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationAzureBlob_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.

 ** [LocationArn](#API_CreateLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-CreateLocationAzureBlob-response-LocationArn"></a>
O ARN do local de transferência do Armazenamento de Blobs do Azure que você criou.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationEfs
<a name="API_CreateLocationEfs"></a>

Criar um *local* de transferência para um sistema de arquivos Amazon EFS. O AWS DataSync pode usar esse local como origem ou de destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessa os sistemas de arquivos do Amazon EFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access).

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

```
{
   "AccessPointArn": "string",
   "Ec2Config": { 
      "SecurityGroupArns": [ "string" ],
      "SubnetArn": "string"
   },
   "EfsFilesystemArn": "string",
   "FileSystemAccessRoleArn": "string",
   "InTransitEncryption": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [AccessPointArn](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-AccessPointArn"></a>
Especifica o Amazon Resource Name (ARN) do ponto DataSync de acesso usado para montar seu sistema de arquivos Amazon EFS.  
Para obter mais informações, consulte [Acesso a sistemas de arquivos restritos](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam).  
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):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$`   
Obrigatório: não

 ** [Ec2Config](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-Ec2Config"></a>
Especifica a sub-rede e os grupos de segurança DataSync usados para se conectar a um dos destinos de [montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) do seu sistema de arquivos Amazon EFS.  
Tipo: objeto [Ec2Config](API_Ec2Config.md)  
Obrigatório: Sim

 ** [EfsFilesystemArn](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-EfsFilesystemArn"></a>
Especifica o ARN do sistema de arquivos Amazon EFS.  
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):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}$`   
Obrigatório: Sim

 ** [FileSystemAccessRoleArn](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-FileSystemAccessRoleArn"></a>
Especifica uma função AWS Identity and Access Management (IAM) que permite DataSync acessar seu sistema de arquivos Amazon EFS.  
Para obter informações sobre como criar essa função, consulte [Criação de uma função DataSync do IAM para acesso ao sistema de arquivos](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Obrigatório: não

 ** [InTransitEncryption](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-InTransitEncryption"></a>
Especifica se você deseja usar DataSync a criptografia Transport Layer Security (TLS) 1.2 ao transferir dados para ou do seu sistema de arquivos Amazon EFS.  
Se você especificar um ponto de acesso usando `AccessPointArn` ou um perfil do IAM usando `FileSystemAccessRoleArn`, deverá definir esse parâmetro como `TLS1_2`.  
Tipo: string  
Valores válidos: `NONE | TLS1_2`   
Obrigatório: não

 ** [Subdirectory](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos do Amazon EFS. É aqui que DataSync lê ou grava dados em seu sistema de arquivos (dependendo se esse é um local de origem ou destino).  
Por padrão, DataSync usa o diretório raiz (ou [ponto de acesso](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html), se você fornecer um usando`AccessPointArn`). Você também pode incluir subdiretórios usando barras (por exemplo, `/path/to/folder`).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: não

 ** [Tags](#API_CreateLocationEfs_RequestSyntax) **   <a name="DataSync-CreateLocationEfs-request-Tags"></a>
Especifica o par de chave-valor que representa uma etiqueta que você deseja adicionar ao recurso. O valor pode ser uma string vazia. Esse valor ajuda você a gerenciar, filtrar e pesquisar seus recursos. Recomendamos que você crie uma tag de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationEfs_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.

 ** [LocationArn](#API_CreateLocationEfs_ResponseSyntax) **   <a name="DataSync-CreateLocationEfs-response-LocationArn"></a>
O nome de recurso da Amazon (ARN) do local do sistema de arquivos do Amazon EFS que você criar.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_CreateLocationEfs_Examples"></a>

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

O exemplo a seguir cria um local para um sistema de arquivos do Amazon EFS.

```
{
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
        ]
    },
    "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}
```

### Solicitação de amostra: criar um local para um sistema de arquivos restrito do Amazon EFS
<a name="API_CreateLocationEfs_Example_2"></a>

O exemplo a seguir cria um local para um sistema de arquivos do Amazon EFS configurado para acesso restrito. Nesse tipo de cenário, talvez você precise especificar valores para `AccessPointArn`, `FileSystemAccessRoleArn` e `InTransitEncryption` na sua solicitação.

```
{
    "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
        ]
    },
    "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
    "InTransitEncryption": "TLS1_2",
    "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
    "LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}
```

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

Uma resposta retorna o ARN de localização do sistema de arquivos do Amazon EFS.

```
{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}
```

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

# CreateLocationFsxLustre
<a name="API_CreateLocationFsxLustre"></a>

Cria um *local* de transferência para um sistema de arquivos Amazon FSx for Lustre. AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessar os sistemas FSx de arquivos Lustre.](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access)

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

```
{
   "FsxFilesystemArn": "string",
   "SecurityGroupArns": [ "string" ],
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [FsxFilesystemArn](#API_CreateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-CreateLocationFsxLustre-request-FsxFilesystemArn"></a>
Especifica o Amazon Resource Name (ARN) do sistema de FSx arquivos for Lustre.  
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):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`   
Obrigatório: Sim

 ** [SecurityGroupArns](#API_CreateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-CreateLocationFsxLustre-request-SecurityGroupArns"></a>
Especifica os nomes de recursos da Amazon (ARNs) de até cinco grupos de segurança que fornecem acesso ao seu sistema de arquivos FSx for Lustre.  
Os grupos de segurança devem conseguir acessar as portas do sistema de arquivos. O sistema de arquivos também deve permitir o acesso a partir dos grupos de segurança. Para obter informações sobre o acesso ao sistema de arquivos, consulte o [https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html).  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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: Sim

 ** [Subdirectory](#API_CreateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-CreateLocationFsxLustre-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos FSx for Lustre. O caminho pode incluir subdiretórios.  
Quando o local é usado como fonte, DataSync lê os dados do caminho de montagem. Quando o local é usado como destino, DataSync grava dados no caminho de montagem. Se você não incluir esse parâmetro, DataSync usa o diretório raiz do sistema de arquivos (`/`).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Não

 ** [Tags](#API_CreateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-CreateLocationFsxLustre-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS . Recomendamos criar pelo menos uma etiqueta de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationFsxLustre_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.

 ** [LocationArn](#API_CreateLocationFsxLustre_ResponseSyntax) **   <a name="DataSync-CreateLocationFsxLustre-response-LocationArn"></a>
O Amazon Resource Name (ARN) da localização do sistema de arquivos FSx for Lustre que você criou.   
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationFsxOntap
<a name="API_CreateLocationFsxOntap"></a>

Cria um *local* de transferência para um sistema de arquivos Amazon FSx for NetApp ONTAP. AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessar os sistemas FSx de arquivos ONTAP.](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access)

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

```
{
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "ManagedSecretConfig": { 
            "SecretArn": "string"
         },
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "SecurityGroupArns": [ "string" ],
   "StorageVirtualMachineArn": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [Protocol](#API_CreateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOntap-request-Protocol"></a>
Especifica o protocolo de transferência de dados AWS DataSync usado para acessar seu sistema de FSx arquivos da Amazon.  
Tipo: objeto [FsxProtocol](API_FsxProtocol.md)  
Obrigatório: Sim

 ** [SecurityGroupArns](#API_CreateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOntap-request-SecurityGroupArns"></a>
Especifica os grupos de segurança do Amazon EC2 que fornecem acesso à sub-rede preferencial do seu sistema de arquivos.  
Os grupos de segurança devem permitir tráfego de saída nas seguintes portas (dependendo do protocolo em uso):  
+  **Sistema de arquivos de rede (NFS)**: portas TCP 111, 635 e 2049
+  **Server Message Block (SMB)**: porta TCP 445
Os grupos de segurança do seu sistema de arquivos também devem permitir tráfego de entrada na mesma porta.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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: Sim

 ** [StorageVirtualMachineArn](#API_CreateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOntap-request-StorageVirtualMachineArn"></a>
Especifica o ARN da máquina virtual de armazenamento (SVM) no sistema de arquivos para o qual e do qual você copia dados.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 162.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$`   
Obrigatório: Sim

 ** [Subdirectory](#API_CreateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOntap-request-Subdirectory"></a>
Especifica um caminho para o compartilhamento de arquivos na SVM de/para o qual você deseja transferir dados.  
Você pode especificar um caminho de união (também conhecido como ponto de montagem), caminho qtree (para compartilhamentos de arquivos NFS) ou nome de compartilhamento (para compartilhamentos de arquivos SMB). Por exemplo, seu caminho de montagem pode ser `/vol1`, `/vol1/tree1` ou `/share1`.  
Não especifique um caminho de junção no volume raiz do SVM. Para obter mais informações, consulte [Gerenciamento FSx de máquinas virtuais de armazenamento ONTAP no Guia](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) do *usuário do Amazon FSx for NetApp ONTAP*.
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`   
Obrigatório: Não

 ** [Tags](#API_CreateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOntap-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS . Recomendamos criar pelo menos uma etiqueta de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationFsxOntap_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.

 ** [LocationArn](#API_CreateLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-CreateLocationFsxOntap-response-LocationArn"></a>
Especifica o ARN da localização FSx do sistema de arquivos for ONTAP que você cria.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOntap) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOntap) 

# CreateLocationFsxOpenZfs
<a name="API_CreateLocationFsxOpenZfs"></a>

Cria um *local* de transferência para um sistema de arquivos Amazon FSx for OpenZFS. AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessar os sistemas FSx de arquivos OpenZFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access).

**nota**  
Os parâmetros de solicitação relacionados a `SMB` não são compatíveis com a operação `CreateLocationFsxOpenZfs`.

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

```
{
   "FsxFilesystemArn": "string",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "ManagedSecretConfig": { 
            "SecretArn": "string"
         },
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "SecurityGroupArns": [ "string" ],
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [FsxFilesystemArn](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-FsxFilesystemArn"></a>
O Amazon Resource Name (ARN) do sistema de arquivos FSx for OpenZFS.  
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):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`   
Obrigatório: Sim

 ** [Protocol](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-Protocol"></a>
O tipo de protocolo AWS DataSync usado para acessar seu sistema de arquivos.  
Tipo: objeto [FsxProtocol](API_FsxProtocol.md)  
Obrigatório: Sim

 ** [SecurityGroupArns](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-SecurityGroupArns"></a>
Os grupos ARNs de segurança usados para configurar o sistema de arquivos FSx para OpenZFS.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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: Sim

 ** [Subdirectory](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-Subdirectory"></a>
Um subdiretório no caminho do local que deve começar com`/fsx`. DataSync usa esse subdiretório para ler ou gravar dados (dependendo se o sistema de arquivos é um local de origem ou destino).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$`   
Obrigatório: não

 ** [Tags](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-Tags"></a>
O par de chave-valor que representa uma tag que você deseja adicionar ao recurso. O valor pode ser uma string vazia. Esse valor ajuda você a gerenciar, filtrar e pesquisar seus recursos. Recomendamos que você crie uma tag de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationFsxOpenZfs_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.

 ** [LocationArn](#API_CreateLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-response-LocationArn"></a>
O ARN da localização do sistema de arquivos FSx para OpenZFS que você criou.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 

# CreateLocationFsxWindows
<a name="API_CreateLocationFsxWindows"></a>

Cria um *local* de transferência para um sistema de arquivos Amazon FSx for Windows File Server. AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessar os sistemas FSx de arquivos do Windows File Server](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access).

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

```
{
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "Domain": "string",
   "FsxFilesystemArn": "string",
   "Password": "string",
   "SecurityGroupArns": [ "string" ],
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "string"
}
```

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

 ** [CmkSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, que inclui a senha DataSync usada para acessar um local de armazenamento específico FSx do Windows, com um gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationFsxWindows` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com a `Password` que você especificou para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS que você especificou. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com `Password`) ou `CustomSecretConfig` (sem `Password`) para fornecer credenciais para uma solicitação `CreateLocationFsxWindows`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que a senha de um local FSx de armazenamento do Windows File Server é armazenada em texto simples, no Secrets Manager. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `Password`) ou `CustomSecretConfig` (sem `Password`) para fornecer credenciais para uma solicitação `CreateLocationFsxWindows`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [Domain](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-Domain"></a>
Especifica o nome do domínio do Windows ao qual o sistema FSx de arquivos do Windows File Server pertence.  
Se você tiver vários domínios do Active Directory em seu ambiente, a configuração desse parâmetro garante que ele DataSync se conecte ao sistema de arquivos correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`   
Obrigatório: não

 ** [FsxFilesystemArn](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-FsxFilesystemArn"></a>
Especifica o Amazon Resource Name (ARN) para FSx o sistema de arquivos do Windows File Server.  
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):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`   
Obrigatório: Sim

 ** [Password](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-Password"></a>
Especifica a senha do usuário com as permissões para montar e acessar os arquivos, pastas e metadados de arquivos no seu FSx sistema de arquivos do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: não

 ** [SecurityGroupArns](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-SecurityGroupArns"></a>
Especifica os ARNs dos grupos de segurança do Amazon EC2 que fornecem acesso à sub-rede preferencial do seu sistema de arquivos.  
Os grupos de segurança que você especificar devem ser capazes de se comunicar com os grupos de segurança do seu sistema de arquivos. Para obter informações sobre a configuração de grupos de segurança para acesso ao sistema de arquivos, consulte o [https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html).  
Se você escolher um grupo de segurança que não permite conexões de dentro de si mesmo, siga um destes procedimentos:  
+ Configure o grupo de segurança para permitir que ele se comunique dentro de si próprio.
+ Escolha outro grupo de segurança diferente que possa se comunicar com o grupo de segurança do destino de montagem.
Tipo: Matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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: Sim

 ** [Subdirectory](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos usando barras. É aqui que DataSync lê ou grava dados (dependendo se esse é um local de origem ou destino).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Não

 ** [Tags](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS . Recomendamos criar pelo menos uma etiqueta de nome para a sua localização.  
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

 ** [User](#API_CreateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-CreateLocationFsxWindows-request-User"></a>
Especifica o usuário com as permissões para montar e acessar os arquivos, pastas e metadados de arquivos no seu FSx sistema de arquivos do Windows File Server.  
Para obter informações sobre como escolher um usuário com o nível certo de acesso para sua transferência, consulte [as permissões necessárias](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) FSx para locais do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: sim

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationFsxWindows_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.

 ** [LocationArn](#API_CreateLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-CreateLocationFsxWindows-response-LocationArn"></a>
O ARN da localização do sistema FSx de arquivos do Windows File Server que você criou.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationHdfs
<a name="API_CreateLocationHdfs"></a>

Cria um *local* de transferência para um Hadoop Distributed File System (HDFS). AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessa os clusters do HDFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs).

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlockSize": number,
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "KmsKeyProviderUri": "string",
   "NameNodes": [ 
      { 
         "Hostname": "string",
         "Port": number
      }
   ],
   "QopConfiguration": { 
      "DataTransferProtection": "string",
      "RpcProtection": "string"
   },
   "ReplicationFactor": number,
   "SimpleUser": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [AgentArns](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-AgentArns"></a>
Os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu cluster HDFS.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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

 ** [AuthenticationType](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-AuthenticationType"></a>
O tipo de autenticação usado para determinar a identidade do usuário.   
Tipo: string  
Valores válidos: `SIMPLE | KERBEROS`   
Obrigatório: Sim

 ** [BlockSize](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-BlockSize"></a>
O tamanho dos blocos de dados a serem gravados no cluster do HDFS. O tamanho deve ser um múltiplo de 512 bytes. O tamanho padrão do bloco é 128 mebibytes (MiB).  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.048.576. Valor máximo de 1.073.741.824  
Obrigatório: não

 ** [CmkSecretConfig](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-CmkSecretConfig"></a>
Especifica as informações de configuração de um segredo DataSync gerenciado, que inclui a tecla Kerberos DataSync usada para acessar um local de armazenamento específico do Hadoop Distributed File System (HDFS), com um local gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationHdfs` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com a `KerberosKeytab` que você especificou para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS que você especificou. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com `KerberosKeytab`) ou `CustomSecretConfig` (sem `KerberosKeytab`) para fornecer credenciais para uma solicitação `CreateLocationHdfs`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que a tecla Kerberos do local de armazenamento do HDFS é armazenada em binário, no Secrets Manager. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `KerberosKeytab`) ou `CustomSecretConfig` (sem `KerberosKeytab`) para fornecer credenciais para uma solicitação `CreateLocationHdfs`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [KerberosKeytab](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-KerberosKeytab"></a>
A tabela de chaves Kerberos (keytab) que contém mapeamentos entre a entidade principal Kerberos definida e as chaves criptografadas. Você pode carregar o keytab de um arquivo fornecendo o endereço do arquivo.  
Se `KERBEROS` for especificado para `AuthenticationType`, esse parâmetro será obrigatório. 
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 65536.  
Obrigatório: não

 ** [KerberosKrb5Conf](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-KerberosKrb5Conf"></a>
O arquivo `krb5.conf` que contém as informações de configuração do Kerberos. Você pode carregar o arquivo `krb5.conf` fornecendo o endereço do arquivo. Se você estiver usando o AWS CLI, ele executa a codificação base64 para você. Caso contrário, você deve fornecer o texto codificado em base64.   
Se `KERBEROS` for especificado para `AuthenticationType`, esse parâmetro será obrigatório.
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 131.072.  
Obrigatório: não

 ** [KerberosPrincipal](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-KerberosPrincipal"></a>
A entidade principal do Kerberos com acesso aos arquivos e pastas no cluster do HDFS.   
Se `KERBEROS` for especificado para `AuthenticationType`, esse parâmetro será obrigatório.
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$`   
Obrigatório: não

 ** [KmsKeyProviderUri](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-KmsKeyProviderUri"></a>
O URI do Key Management Server (KMS) do cluster do HDFS.   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$`   
Obrigatório: não

 ** [NameNodes](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-NameNodes"></a>
O NameNode que gerencia o namespace HDFS. O NameNode executa operações como abrir, fechar e renomear arquivos e diretórios. O NameNode contém as informações para mapear blocos de dados para DataNodes o. Você pode usar apenas um NameNode.  
Tipo: matriz de objetos [HdfsNameNode](API_HdfsNameNode.md)  
Membros da matriz: número mínimo de 1 item.  
Obrigatório: Sim

 ** [QopConfiguration](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-QopConfiguration"></a>
A configuração da Qualidade da Proteção (QOP) especifica as configurações de privacidade da Chamada de Procedimento Remoto (RPC) e das configurações de proteção de transferência de dados definidas no cluster do Hadoop Distributed File System (HDFS). Se `QopConfiguration` não for especificado, `RpcProtection` e `DataTransferProtection` assumirão `PRIVACY` como padrão. Se você definir `RpcProtection` ou `DataTransferProtection`, o outro parâmetro assumirá o mesmo valor.   
Tipo: objeto [QopConfiguration](API_QopConfiguration.md)  
Obrigatório: não

 ** [ReplicationFactor](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-ReplicationFactor"></a>
O número de DataNodes para os quais replicar os dados ao gravar no cluster HDFS. Por padrão, os dados são replicados para três DataNodes.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 512.  
Obrigatório: não

 ** [SimpleUser](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-SimpleUser"></a>
O nome de usuário utilizado para identificar o cliente no sistema operacional host.   
Se `SIMPLE` for especificado para `AuthenticationType`, esse parâmetro será obrigatório. 
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`   
Obrigatório: não

 ** [Subdirectory](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-Subdirectory"></a>
Um subdiretório no cluster do HDFS. Esse subdiretório é utilizado para ler ou gravar dados no cluster do HDFS. Se o subdiretório não for especificado, o padrão será `/`.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: não

 ** [Tags](#API_CreateLocationHdfs_RequestSyntax) **   <a name="DataSync-CreateLocationHdfs-request-Tags"></a>
O par de chave-valor que representa a tag que você deseja adicionar ao local. O valor pode ser uma string vazia. Recomendamos usar tags para nomear os recursos.   
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationHdfs_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.

 ** [LocationArn](#API_CreateLocationHdfs_ResponseSyntax) **   <a name="DataSync-CreateLocationHdfs-response-LocationArn"></a>
O ARN do local do cluster de origem do HDFS que você criou.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationNfs
<a name="API_CreateLocationNfs"></a>

Cria um *local* de transferência para um servidor de arquivos do Network File System (NFS). AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync [acessa os servidores de arquivos NFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs).

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

```
{
   "MountOptions": { 
      "Version": "string"
   },
   "OnPremConfig": { 
      "AgentArns": [ "string" ]
   },
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [MountOptions](#API_CreateLocationNfs_RequestSyntax) **   <a name="DataSync-CreateLocationNfs-request-MountOptions"></a>
Especifica as opções que DataSync podem ser usadas para montar seu servidor de arquivos NFS.  
Tipo: objeto [NfsMountOptions](API_NfsMountOptions.md)  
Obrigatório: não

 ** [OnPremConfig](#API_CreateLocationNfs_RequestSyntax) **   <a name="DataSync-CreateLocationNfs-request-OnPremConfig"></a>
Especifica o Amazon Resource Name (ARN) do DataSync agente que pode se conectar ao seu servidor de arquivos NFS.  
Você pode especificar mais de um atendente. Para obter mais informações, consulte [Uso de vários DataSync agentes](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents).  
Tipo: objeto [OnPremConfig](API_OnPremConfig.md)  
Obrigatório: Sim

 ** [ServerHostname](#API_CreateLocationNfs_RequestSyntax) **   <a name="DataSync-CreateLocationNfs-request-ServerHostname"></a>
Especifica o nome DNS ou endereço IP (IPv4 ou IPv6) do servidor de arquivos NFS ao qual seu DataSync agente se conecta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: Sim

 ** [Subdirectory](#API_CreateLocationNfs_RequestSyntax) **   <a name="DataSync-CreateLocationNfs-request-Subdirectory"></a>
Especifica o caminho de exportação no servidor de arquivos NFS que você deseja DataSync montar.  
Esse caminho (ou um subdiretório do caminho) é onde os dados são DataSync transferidos de ou para. Para obter informações sobre como configurar uma exportação para DataSync, consulte [Acessando servidores de arquivos NFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$`   
Obrigatório: Sim

 ** [Tags](#API_CreateLocationNfs_RequestSyntax) **   <a name="DataSync-CreateLocationNfs-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus AWS recursos. Recomendamos criar pelo menos uma etiqueta de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationNfs_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.

 ** [LocationArn](#API_CreateLocationNfs_ResponseSyntax) **   <a name="DataSync-CreateLocationNfs-response-LocationArn"></a>
O ARN do local de transferência que você criou para seu servidor de arquivos NFS.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_CreateLocationNfs_Examples"></a>

### Exemplo
<a name="API_CreateLocationNfs_Example_1"></a>

O exemplo a seguir cria um local DataSync de transferência para um servidor de arquivos NFS.

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

```
{
  "MountOptions": {
     "Version": : "NFS4_0"
     },
  "OnPremConfig": {
    "AgentArn": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ]
          },
          
           "ServerHostname": "MyServer@amazon.com",
           "Subdirectory": "/MyFolder",
           "Tags": [
              {
                "Key": "Name",
                "Value": "FileSystem-1"
              }
           ]
}
```

### Exemplo
<a name="API_CreateLocationNfs_Example_2"></a>

A resposta retorna o ARN do local do NFS.

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

```
{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa"
}
```

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

# CreateLocationObjectStorage
<a name="API_CreateLocationObjectStorage"></a>

Cria um *local* de transferência para um sistema de armazenamento de objetos. AWS DataSync pode usar esse local como origem ou destino para transferir dados. Você pode fazer transferências com ou sem um [DataSyncagente](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#when-agent-required).

Antes de começar, certifique-se de compreender os [pré-requisitos](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites) para trabalhar com sistemas de DataSync armazenamento de objetos.

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

```
{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "BucketName": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "SecretKey": "string",
   "ServerCertificate": blob,
   "ServerHostname": "string",
   "ServerPort": number,
   "ServerProtocol": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [AccessKey](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-AccessKey"></a>
Especifica a chave de acesso (por exemplo, um nome de usuário) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Padrão: `^.*$`   
Obrigatório: não

 ** [AgentArns](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-AgentArns"></a>
(Opcional) Especifica os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu sistema de armazenamento de objetos. Se você estiver configurando uma transferência entre nuvens sem atendente, não precisará especificar um valor para esse parâmetro.  
Certifique-se de configurar esse parâmetro corretamente ao criar ao local de armazenamento pela primeira vez. Você não pode adicionar ou remover atendentes de um local de armazenamento depois de criá-lo.
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [BucketName](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-BucketName"></a>
Especifica o nome do bucket de armazenamento de objetos envolvido na transferência.  
Tipo: string  
Restrições de tamanho: comprimento mínimo de 3. O comprimento máximo é 63.  
Padrão: `^[a-zA-Z0-9_\-\+\.\(\)\$\p{Zs}]+$`   
Obrigatório: Sim

 ** [CmkSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-CmkSecretConfig"></a>
Especifica as informações de configuração de um segredo DataSync gerenciado, que inclui o `SecretKey` que é DataSync usado para acessar um local específico de armazenamento de objetos, com um gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationObjectStorage` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com o valor que você especifica para o `SecretKey` parâmetro para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS especificada. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com `SecretKey`) ou `CustomSecretConfig` (sem `SecretKey`) para fornecer credenciais para uma solicitação `CreateLocationObjectStorage`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que a chave secreta de um local específico de armazenamento de objetos é armazenada em texto simples, no Secrets Manager. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `SecretKey`) ou `CustomSecretConfig` (sem `SecretKey`) para fornecer credenciais para uma solicitação `CreateLocationObjectStorage`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [SecretKey](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-SecretKey"></a>
Especifica a chave secreta (por exemplo, uma senha) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.  
Se você fornecer um segredo usando`SecretKey`, mas não fornecer detalhes de configuração secreta usando `CmkSecretConfig` ou`CustomSecretConfig`, então DataSync armazena o token usando o segredo do Secrets Manager da sua AWS conta.
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Padrão: `^.*$`   
Obrigatório: não

 ** [ServerCertificate](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-ServerCertificate"></a>
Especifica uma cadeia de certificados DataSync para autenticação em seu sistema de armazenamento de objetos se o sistema usar uma autoridade de certificação (CA) privada ou autoassinada. Você deve especificar um único arquivo `.pem` com uma cadeia de certificados completa (por exemplo, `file:///home/user/.ssh/object_storage_certificates.pem`).  
A cadeia de certificados pode incluir:  
+ O certificado do sistema de armazenamento de objetos
+ Todos os certificados intermediários (se for o caso)
+ O certificado-raiz da CA assinante
Você pode concatenar os certificados em um arquivo `.pem` (que pode ter até 32.768 bytes antes da codificação base64). O exemplo de comando `cat` a seguir cria um arquivo `object_storage_certificates.pem` que inclui três certificados:  
 `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`   
Para usar esse parâmetro, configure `ServerProtocol` para `HTTPS`.  
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 32768.  
Obrigatório: não

 ** [ServerHostname](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-ServerHostname"></a>
Especifica o nome de domínio ou endereço IP (IPv4 ou IPv6) do servidor de armazenamento de objetos ao qual seu DataSync agente se conecta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: Sim

 ** [ServerPort](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-ServerPort"></a>
Especifica a porta em que o servidor de armazenamento de objetos aceita o tráfego de rede de entrada (por exemplo, a porta 443).  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 65536.  
Obrigatório: não

 ** [ServerProtocol](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-ServerProtocol"></a>
Especifica o protocolo que o servidor de armazenamento de objetos utiliza para se comunicar. Se não for especificado, o valor padrão será `HTTPS`.  
Tipo: string  
Valores válidos: `HTTPS | HTTP`   
Obrigatório: não

 ** [Subdirectory](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-Subdirectory"></a>
Especifica o prefixo de objeto do servidor de armazenamento de objetos. Se esse for um local de origem, DataSync copiará somente objetos com esse prefixo. Se for um local de destino, DataSync grava todos os objetos com esse prefixo.   
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: não

 ** [Tags](#API_CreateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-CreateLocationObjectStorage-request-Tags"></a>
Especifica o par de chave-valor que representa uma etiqueta que você deseja adicionar ao recurso. Tags ajudam a gerenciar, filtrar e procurar recursos. Recomendamos criar uma etiqueta de nome para a sua localização.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationObjectStorage_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.

 ** [LocationArn](#API_CreateLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-CreateLocationObjectStorage-response-LocationArn"></a>
Especifica o ARN da localização do sistema de armazenamento de objetos que você cria.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationS3
<a name="API_CreateLocationS3"></a>

Cria um *local* de transferência para um bucket do Amazon S3. O AWS DataSync pode usar esse local como origem ou destino para transferência de dados.

**Importante**  
Antes de começar, não deixe de ler os seguintes tópicos:  
 [Considerações sobre a classe de armazenamento com locais do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) 
 [Avaliando os custos de solicitação do S3 ao usar DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) 

 Para obter mais informações, consulte [Configurar transferências com o Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html).

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

```
{
   "AgentArns": [ "string" ],
   "S3BucketArn": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [AgentArns](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-AgentArns"></a>
(Somente Amazon S3 em Outposts) Especifica o Amazon Resource Name (ARN) do agente em seu Outpost. DataSync   
Para obter mais informações, consulte [Implantar seu DataSync agente em AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent).  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [S3BucketArn](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-S3BucketArn"></a>
Especifica o ARN do bucket do S3 que você deseja usar como um local. (Ao criar sua DataSync tarefa posteriormente, você especifica se esse local é uma origem ou um destino de transferência.)   
Se seu bucket do S3 estiver localizado em um AWS Outposts recurso, você deverá especificar um ponto de acesso do Amazon S3. Para obter mais informações, consulte [Gerenciando o acesso a dados com o recurso Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) no *Guia do usuário do Amazon S3*.  
Tipo: string  
Restrições de comprimento: comprimento máximo de 268.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`   
Obrigatório: Sim

 ** [S3Config](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-S3Config"></a>
Especifica o Amazon Resource Name (ARN) AWS Identity and Access Management da função DataSync (IAM) usada para acessar seu bucket do S3.  
Para obter mais informações, consulte [Fornecendo DataSync acesso aos buckets do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).  
Tipo: objeto [S3Config](API_S3Config.md)  
Obrigatório: Sim

 ** [S3StorageClass](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-S3StorageClass"></a>
Especifica a classe de armazenamento que você deseja que seus objetos usem quando o Amazon S3 for um destino de transferência.  
Para buckets em Regiões da AWS, o padrão da classe de armazenamento é. `STANDARD` Para buckets ativados AWS Outposts, o padrão da classe de armazenamento é. `OUTPOSTS`  
Para obter mais informações, consulte [Considerações sobre classes de armazenamento com transferências do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).  
Tipo: string  
Valores válidos: `STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL`   
Obrigatório: não

 ** [Subdirectory](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-Subdirectory"></a>
Especifica um prefixo no bucket do S3 que DataSync lê ou grava (dependendo se o bucket é um local de origem ou destino).  
DataSync não é possível transferir objetos com um prefixo que comece com uma barra (`/`) ou inclua `//``/./`, ou `/../` padrões. Por exemplo:  
+  `/photos` 
+  `photos//2006/January` 
+  `photos/./2006/February` 
+  `photos/../2006/March` 
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: não

 ** [Tags](#API_CreateLocationS3_RequestSyntax) **   <a name="DataSync-CreateLocationS3-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus AWS recursos. Recomendamos criar pelo menos uma etiqueta de nome para seu local de transferência.  
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

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationS3_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.

 ** [LocationArn](#API_CreateLocationS3_ResponseSyntax) **   <a name="DataSync-CreateLocationS3-response-LocationArn"></a>
O ARN do local do S3 que você criou.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# CreateLocationSmb
<a name="API_CreateLocationSmb"></a>

Cria um *local* de transferência para um servidor de arquivos do Server Message Block (SMB). AWS DataSync pode usar esse local como origem ou destino para transferir dados.

Antes de começar, certifique-se de entender como DataSync acessa os servidores de arquivos SMB. Para obter mais informações, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "string"
}
```

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

 ** [AgentArns](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-AgentArns"></a>
Especifica o DataSync agente (ou agentes) que podem se conectar ao seu servidor de arquivos SMB. Você especifica um agente usando seu nome do recurso da Amazon (ARN).  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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

 ** [AuthenticationType](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-AuthenticationType"></a>
Especifica o protocolo de autenticação DataSync usado para se conectar ao seu servidor de arquivos SMB. DataSync suporte `NTLM` (padrão) e `KERBEROS` autenticação.  
Para obter mais informações, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Valores válidos: `NTLM | KERBEROS`   
Obrigatório: não

 ** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, um `Password` ou `KerberosKeytab` (para tipos `NTLM` (padrão) e de `KERBEROS` autenticação, respectivamente) DataSync usado para acessar um local de armazenamento SMB específico, com um gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationSmbRequest` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com a `Password` ou `KerberosKeytab` que você especificou para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS que você especificou. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com um `Password` ou`KerberosKeytab`) ou `CustomSecretConfig` (sem nenhum `Password` e`KerberosKeytab`) para fornecer credenciais para uma `CreateLocationSmbRequest` solicitação. Não forneça ambos `CmkSecretConfig` e `CustomSecretConfig` parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente em que as credenciais do local de armazenamento SMB são armazenadas no Secrets Manager como texto simples (para`Password`) ou binário (para). `KerberosKeytab` Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `SasConfiguration`) ou `CustomSecretConfig` (sem `SasConfiguration`) para fornecer credenciais para uma solicitação `CreateLocationSmbRequest`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [DnsIpAddresses](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-DnsIpAddresses"></a>
Especifica os IPv6 endereços IPv4 ou dos servidores DNS aos quais seu servidor de arquivos SMB pertence. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `KERBEROS`.  
Se você tiver vários domínios em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao servidor de arquivos SMB correto.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 2 itens.  
Restrições de comprimento: comprimento mínimo de 7. Comprimento máximo de 39.  
Padrão: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`   
Obrigatório: não

 ** [Domain](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-Domain"></a>
Especifica o nome de domínio do Windows ao qual o servidor de arquivos SMB pertence. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Se você tiver vários domínios em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao servidor de arquivos correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`   
Obrigatório: não

 ** [KerberosKeytab](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-KerberosKeytab"></a>
Especifica o arquivo da tabela de chaves Kerberos (keytab), que inclui mapeamentos entre a entidade principal Kerberos e as chaves de criptografia.  
Para evitar erros de execução de tarefas, confira se a entidade principal Kerberos usada para criar o arquivo keytab corresponde exatamente ao que você especificou para `KerberosPrincipal`.   
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 65536.  
Obrigatório: não

 ** [KerberosKrb5Conf](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-KerberosKrb5Conf"></a>
Especifica um arquivo de configuração Kerberos (`krb5.conf`) que define a configuração do realm Kerberos.  
O arquivo deve ser codificado em base64. Se você estiver usando o AWS CLI, a codificação é feita para você.  
Tipo: Objeto de dados binários codificado em Base64  
Restrições de tamanho: tamanho máximo de 131.072.  
Obrigatório: não

 ** [KerberosPrincipal](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-KerberosPrincipal"></a>
Especifica uma entidade principal Kerberos, que é uma identidade no realm Kerberos que tem permissão para acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB.  
Uma entidade principal Kerberos pode ter a aparência de `HOST/kerberosuser@MYDOMAIN.ORG`.  
Os nomes de entidade principal diferenciam letras maiúsculas de minúsculas A execução da DataSync tarefa falhará se o principal que você especificar para esse parâmetro não corresponder exatamente ao principal usado para criar o arquivo keytab.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$`   
Obrigatório: não

 ** [MountOptions](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-MountOptions"></a>
Especifica a versão do protocolo SMB DataSync usada para acessar seu servidor de arquivos SMB.  
Tipo: objeto [SmbMountOptions](API_SmbMountOptions.md)  
Obrigatório: não

 ** [Password](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-Password"></a>
Especifica a senha do usuário que pode montar o servidor de arquivos SMB e tenha permissão para acessar os arquivos e pastas envolvidos na sua transferência. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: não

 ** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-ServerHostname"></a>
Especifica o nome de domínio ou endereço IP (IPv4 ou IPv6) do servidor de arquivos SMB ao qual seu DataSync agente se conecta.  
Se você estiver usando a autenticação Kerberos, deverá especificar um nome de domínio.
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: Sim

 ** [Subdirectory](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-Subdirectory"></a>
Especifica o nome do compartilhamento exportado pelo seu servidor de arquivos SMB onde DataSync lerá ou gravará dados. Você pode incluir um subdiretório no caminho de compartilhamento (por exemplo, `/path/to/subdirectory`). Certifique-se de que outros clientes do SMB em sua rede também possam montar este caminho.  
Para copiar todos os dados no subdiretório, DataSync deve ser capaz de montar o compartilhamento SMB e acessar todos os seus dados. Para obter mais informações, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Sim

 ** [Tags](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-Tags"></a>
Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS . Recomendamos criar pelo menos uma etiqueta de nome para a sua localização.  
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

 ** [User](#API_CreateLocationSmb_RequestSyntax) **   <a name="DataSync-CreateLocationSmb-request-User"></a>
Especifica o usuário que pode montar e acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Para obter informações sobre como escolher um usuário com o nível certo de acesso para sua transferência, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: Não

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

```
{
   "LocationArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateLocationSmb_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.

 ** [LocationArn](#API_CreateLocationSmb_ResponseSyntax) **   <a name="DataSync-CreateLocationSmb-response-LocationArn"></a>
O ARN do local no SMB criado por você.  
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}:location/loc-[0-9a-z]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_CreateLocationSmb_Examples"></a>

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

O exemplo a seguir cria um local para um servidor de arquivos SMB.

```
{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
   ],
   "Domain":"AMAZON",
   "MountOptions":{
      "Version":"SMB3"
   },
   "Password":"string",
   "ServerHostname":"MyServer.amazon.com",
   "Subdirectory":"share",
   "Tags":[
      {
         "Key":"department",
         "Value":"finance"
      }
   ],
   "User":"user-1"
}
```

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

Uma resposta retorna o ARN do local do seu servidor de arquivos do SMB.

```
{
    "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```

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

# CreateTask
<a name="API_CreateTask"></a>

Configura uma *tarefa* de transferência, que define onde e como o AWS DataSync transfere os dados.

Uma tarefa inclui um local de origem, um local de destino e opções de transferência (como limites de largura de banda, agendamento etc.).

**Importante**  
Se você planeja transferir dados de ou para um local do Amazon S3, analise [como isso DataSync pode afetar as cobranças de suas solicitações do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) e a [página de DataSync preços](https://aws.amazon.com/datasync/pricing/) antes de começar.

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

```
{
   "CloudWatchLogGroupArn": "string",
   "DestinationLocationArn": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "Name": "string",
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Schedule": { 
      "ScheduleExpression": "string",
      "Status": "string"
   },
   "SourceLocationArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskMode": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}
```

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

 ** [CloudWatchLogGroupArn](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-CloudWatchLogGroupArn"></a>
Especifica o Amazon Resource Name (ARN) de um grupo de logs da CloudWatch Amazon para monitorar sua tarefa.  
Para tarefas do modo Avançado, você não precisa especificar nada. DataSyncenvia automaticamente os registros para um grupo de CloudWatch registros chamado`/aws/datasync`.  
Para obter mais informações, consulte [Monitoramento de transferências de dados com o CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 562.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$`   
Obrigatório: não

 ** [DestinationLocationArn](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-DestinationLocationArn"></a>
Especifica o ARN do local de destino da transferência.   
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Excludes](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Excludes"></a>
Especifica filtros de exclusão que definem os arquivos, objetos e pastas em seu local de origem que você não deseja DataSync transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [Includes](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Includes"></a>
Especifica a inclusão de filtros que definem os arquivos, objetos e pastas no local de origem que você deseja DataSync transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [ManifestConfig](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-ManifestConfig"></a>
Configura um manifesto, que é uma lista de arquivos ou objetos que você deseja DataSync transferir. Para obter mais informações e exemplos de configuração, consulte [Especificação do que é DataSync transferido usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Tipo: objeto [ManifestConfig](API_ManifestConfig.md)  
Obrigatório: não

 ** [Name](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Name"></a>
Especifica o nome da tarefa.  
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

 ** [Options](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Options"></a>
Especifica as configurações da tarefa, como preservar os metadados do arquivo, verificar a integridade dos dados, entre outras opções.  
Tipo: objeto [Options](API_Options.md)  
Obrigatório: não

 ** [Schedule](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Schedule"></a>
Especifica um agendamento de quando você deseja que a tarefa seja executada. Para obter mais informações, consulte [Programar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Tipo: objeto [TaskSchedule](API_TaskSchedule.md)  
Obrigatório: não

 ** [SourceLocationArn](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-SourceLocationArn"></a>
Especifica o ARN do local de origem da transferência.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Tags](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-Tags"></a>
Especifica as tags que você deseja aplicar à tarefa.  
 As *tags* são pares de valores-chave que ajudam você a gerenciar, filtrar e pesquisar seus DataSync recursos.  
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

 ** [TaskMode](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-TaskMode"></a>
Especifica um dos seguintes modos de tarefa para a transferência de dados:  
+  `ENHANCED`: transfira um número praticamente ilimitado de objetos com desempenho superior ao do modo Básico. As tarefas do modo Avançado otimizam o processo de transferência de dados listando, preparando, transferindo e verificando os dados em paralelo. Atualmente, o modo avançado está disponível para transferências entre locais do Amazon S3, transferências entre Azure Blob e o Amazon S3 sem um atendente e transferências entre outras nuvens e o Amazon S3 sem um atendente.
**nota**  
Para criar uma tarefa no modo Avançado, o perfil do IAM que você usa para chamar a operação `CreateTask` precisa ter a permissão `iam:CreateServiceLinkedRole`.
+  `BASIC`(padrão) - Transfira arquivos ou objetos entre o AWS armazenamento e todos os outros DataSync locais compatíveis. As tarefas do modo Básico estão sujeitas a [cotas](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html) no número de arquivos, objetos e diretórios em um conjunto de dados. O modo Básico prepara, transfere e verifica os dados sequencialmente, tornando-se mais lento do que o modo Avançado para a maioria das workloads.
Para obter mais informações, consulte [Como entender as diferenças do modo de tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences).  
Tipo: string  
Valores válidos: `BASIC | ENHANCED`   
Obrigatório: não

 ** [TaskReportConfig](#API_CreateTask_RequestSyntax) **   <a name="DataSync-CreateTask-request-TaskReportConfig"></a>
Especifica como você deseja configurar um relatório de tarefas, que fornece informações detalhadas sobre sua DataSync transferência. Para obter mais informações, consulte [Monitorando suas DataSync transferências com relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Tipo: objeto [TaskReportConfig](API_TaskReportConfig.md)  
Obrigatório: não

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

```
{
   "TaskArn": "string"
}
```

## Elementos de resposta
<a name="API_CreateTask_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.

 ** [TaskArn](#API_CreateTask_ResponseSyntax) **   <a name="DataSync-CreateTask-response-TaskArn"></a>
O nome do recurso da Amazon (ARN) da tarefa.  
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}:task/task-[0-9a-f]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_CreateTask_Examples"></a>

### Solicitação de amostra para uma tarefa no modo Avançado
<a name="API_CreateTask_Example_1"></a>

O exemplo a seguir cria uma DataSync tarefa que usa o modo Avançado.

Ao contrário da criação de tarefas no modo Básico, você não precisa especificar um grupo de CloudWatch registros da Amazon. Com as tarefas do modo Avançado, envia DataSync automaticamente os registros de tarefas para um grupo de registros chamado`/aws/datasync`. Se esse grupo de registros não existir no seu Região da AWS, DataSync criará o grupo de registros em seu nome ao criar a tarefa.

```
{
  "SourceLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/1111aaaa2222bbbb3",
  "DestinationLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/0000zzzz1111yyyy2",
  "Name": "My Enhanced mode task",
  "TaskMode": "ENHANCED",
  "Options": {
    "TransferMode": "CHANGED",
    "VerifyMode": "ONLY_FILES_TRANSFERRED",
    "ObjectTags": "PRESERVE",
    "LogLevel": "TRANSFER"
  }
}
```

### Solicitação de amostra para uma tarefa do modo Básico
<a name="API_CreateTask_Example_2"></a>

O exemplo a seguir cria uma DataSync tarefa que usa o modo Básico.

```
{
    "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
    "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
    "Name": "My Basic mode task",
    "TaskMode": "BASIC",
    "Options": {
        "Atime": "BEST_EFFORT",
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "ONLY_FILES_TRANSFERRED"
    },
    "Schedule": {
        "ScheduleExpression": "0 12 ? * SUN,WED *"
    },
    "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*",
    "Tags": [
        {
            "Key": "Name",
            "Value": "Migration-wave-1"
        }
    ]
}
```

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

A resposta a seguir inclui o ARN de uma tarefa criada.

```
{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```

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

# DeleteAgent
<a name="API_DeleteAgent"></a>

Remove um recurso de AWS DataSync agente do seu Conta da AWS.

Lembre-se de que essa operação (que não pode ser desfeita) não remove a máquina virtual (VM) do agente ou a instância do Amazon EC2 do seu ambiente de armazenamento. Nas próximas etapas, você pode excluir a VM ou a instância do seu ambiente de armazenamento ou reutilizá-la para [ativar um novo agente](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).

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

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

## Parâmetros da solicitação
<a name="API_DeleteAgent_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_DeleteAgent_RequestSyntax) **   <a name="DataSync-DeleteAgent-request-AgentArn"></a>
O nome do recurso da Amazon (ARN) do agente a ser excluído. Use a `ListAgents` operação para retornar uma lista de agentes para sua conta 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}$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteAgent_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DeleteLocation
<a name="API_DeleteLocation"></a>

Exclui um recurso de local de transferência de AWS DataSync. 

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DeleteLocation_RequestSyntax) **   <a name="DataSync-DeleteLocation-request-LocationArn"></a>
O nome do recurso da Amazon (ARN) do local a ser removido.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteLocation_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DeleteTask
<a name="API_DeleteTask"></a>

Exclui um recurso de tarefa de transferência de AWS DataSync.

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

```
{
   "TaskArn": "string"
}
```

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

 ** [TaskArn](#API_DeleteTask_RequestSyntax) **   <a name="DataSync-DeleteTask-request-TaskArn"></a>
Especifica o nome do recurso da Amazon (ARN) da tarefa que deseja excluir.  
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}:task/task-[0-9a-f]{17}$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteTask_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# 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 [Erros 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) 

# DescribeLocationAzureBlob
<a name="API_DescribeLocationAzureBlob"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para o Microsoft Azure Blob Storage é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationAzureBlob_RequestSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local da transferência do armazenamento de blobs do Azure.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AccessTier": "string",
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlobType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeLocationAzureBlob_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.

 ** [AccessTier](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-AccessTier"></a>
O nível de acesso para o qual você deseja que seus objetos ou arquivos sejam transferidos. Isso só se aplica ao usar o local como destino de transferência. Para obter mais informações, consulte [Níveis de acesso](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers).  
Tipo: String  
Valores válidos: `HOT | COOL | ARCHIVE` 

 ** [AgentArns](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-AgentArns"></a>
Os ARNs DataSync agentes que podem se conectar ao seu contêiner do Azure Blob Storage.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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}$` 

 ** [AuthenticationType](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-AuthenticationType"></a>
O método de autenticação DataSync usado para acessar seu Armazenamento de Blobs do Azure. DataSync pode acessar o armazenamento de blobs usando uma assinatura de acesso compartilhado (SAS).  
Tipo: string  
Valores válidos: `SAS | NONE` 

 ** [BlobType](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-BlobType"></a>
O tipo de blob no qual você deseja que seus objetos ou arquivos estejam ao transferi-los para o armazenamento de blobs do Azure. Atualmente, DataSync só dá suporte à movimentação de dados para o Armazenamento de Blobs do Azure como blobs de blocos. Para obter mais informações sobre os tipos de blob, consulte a [Documentação do armazenamento de blobs do Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs).  
Tipo: String  
Valores válidos: `BLOCK` 

 ** [CmkSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-CmkSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação DataSync usado para acessar um local de armazenamento específico, com um gerenciado pelo cliente AWS KMS key.  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)

 ** [CreationTime](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-CreationTime"></a>
A hora em que seu local de transferência do armazenamento de blobs do Azure foi criado.  
Tipo: Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-CustomSecretConfig"></a>
Descreve as informações de configuração de um segredo gerenciado pelo cliente, como um token de autenticação DataSync usado para acessar um local de armazenamento específico, com uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)

 ** [LocationArn](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-LocationArn"></a>
O ARN do seu local de transferência do armazenamento de blobs do Azure.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-LocationUri"></a>
A URL do contêiner de armazenamento de blobs do Azure envolvido na sua transferência.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) **   <a name="DataSync-DescribeLocationAzureBlob-response-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationEfs
<a name="API_DescribeLocationEfs"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de arquivos Amazon EFS é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationEfs_RequestSyntax) **   <a name="DataSync-DescribeLocationEfs-request-LocationArn"></a>
O nome do recurso da Amazon (ARN) do local do sistema de arquivos do Amazon EFS do 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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AccessPointArn": "string",
   "CreationTime": number,
   "Ec2Config": { 
      "SecurityGroupArns": [ "string" ],
      "SubnetArn": "string"
   },
   "FileSystemAccessRoleArn": "string",
   "InTransitEncryption": "string",
   "LocationArn": "string",
   "LocationUri": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationEfs_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.

 ** [AccessPointArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-AccessPointArn"></a>
O ARN do ponto de acesso DataSync usado para acessar o sistema de arquivos Amazon EFS.  
Para obter mais informações, consulte [Acesso a sistemas de arquivos restritos](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam).  
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):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` 

 ** [CreationTime](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-CreationTime"></a>
O horário em que a localização foi criada.  
Tipo: Timestamp

 ** [Ec2Config](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-Ec2Config"></a>
A sub-rede e os grupos de segurança AWS DataSync usados para se conectar a um dos [destinos de montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) do seu sistema de arquivos Amazon EFS.  
Tipo: objeto [Ec2Config](API_Ec2Config.md)

 ** [FileSystemAccessRoleArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-FileSystemAccessRoleArn"></a>
A função AWS Identity and Access Management (IAM) que permite DataSync acessar seu sistema de arquivos Amazon EFS.  
Para obter mais informações, consulte [Criação de uma função DataSync do IAM para acesso ao sistema de arquivos](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` 

 ** [InTransitEncryption](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-InTransitEncryption"></a>
Indica se DataSync usa criptografia Transport Layer Security (TLS) ao transferir dados para ou do sistema de arquivos Amazon EFS.  
Tipo: string  
Valores válidos: `NONE | TLS1_2` 

 ** [LocationArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-LocationArn"></a>
O ARN da localização do sistema de arquivos do Amazon EFS.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-LocationUri"></a>
O URL da localização do sistema de arquivos do Amazon EFS.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeLocationEfs_Examples"></a>

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

O exemplo a seguir mostra como obter informações sobre um local do sistema de arquivos do Amazon EFS específico.

```
{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}
```

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

O exemplo a seguir retorna detalhes de localização de um sistema de arquivos do Amazon EFS.

```
{
    "CreationTime": 1653319021.353,
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
        ]
    },
    "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
    "LocationUri": "efs://us-east-2.fs-021345abcdef6789/"
}
```

### Exemplo de resposta: descrevendo uma localização de um sistema de arquivos restrito do Amazon EFS
<a name="API_DescribeLocationEfs_Example_3"></a>

O exemplo a seguir retorna detalhes de localização sobre um sistema de arquivos do Amazon EFS com acesso restrito, incluindo os elementos `AccessPointArn`, `FileSystemAccessRoleArn` e `InTransitEncryption`.

```
{
    "CreationTime": 1653319021.353,
    "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
        ]
    },
    "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
    "InTransitEncryption": "TLS1_2",
    "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
    "LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}
```

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

# DescribeLocationFsxLustre
<a name="API_DescribeLocationFsxLustre"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de arquivos Amazon FSx for Lustre é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationFsxLustre_RequestSyntax) **   <a name="DataSync-DescribeLocationFsxLustre-request-LocationArn"></a>
O nome de recurso da Amazon (ARN) do local do FSx for Lustre a ser descrito.   
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "LocationArn": "string",
   "LocationUri": "string",
   "SecurityGroupArns": [ "string" ]
}
```

## Elementos de resposta
<a name="API_DescribeLocationFsxLustre_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.

 ** [CreationTime](#API_DescribeLocationFsxLustre_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxLustre-response-CreationTime"></a>
A hora em que o local FSx for Lustre foi criado.  
Tipo: Timestamp

 ** [LocationArn](#API_DescribeLocationFsxLustre_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxLustre-response-LocationArn"></a>
O Amazon Resource Name (ARN) do local do FSx for Lustre que foi descrito.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationFsxLustre_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxLustre-response-LocationUri"></a>
O URI da localização do FSx for Lustre que foi descrita.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [SecurityGroupArns](#API_DescribeLocationFsxLustre_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxLustre-response-SecurityGroupArns"></a>
Os Amazon Resource Names (ARNs) dos grupos de segurança configurados FSx para o sistema de arquivos for Lustre.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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]+$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationFsxOntap
<a name="API_DescribeLocationFsxOntap"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de arquivos Amazon FSx for NetApp ONTAP é configurado.

**nota**  
Se sua localização usa SMB, a operação `DescribeLocationFsxOntap` não retorna realmente um `Password`.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationFsxOntap_RequestSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-request-LocationArn"></a>
Especifica o Amazon Resource Name (ARN) do local do sistema de arquivos ONTAP sobre FSx 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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "FsxFilesystemArn": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "ManagedSecretConfig": { 
            "SecretArn": "string"
         },
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "SecurityGroupArns": [ "string" ],
   "StorageVirtualMachineArn": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationFsxOntap_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.

 ** [CreationTime](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-CreationTime"></a>
O horário em que a localização foi criada.  
Tipo: Timestamp

 ** [FsxFilesystemArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-FsxFilesystemArn"></a>
O ARN do sistema de arquivos FSx for ONTAP.  
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):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` 

 ** [LocationArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-LocationArn"></a>
O ARN da localização do sistema de arquivos FSx for ONTAP.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-LocationUri"></a>
O identificador uniforme de recursos (URI) da localização do sistema de arquivos FSx for ONTAP.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [Protocol](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-Protocol"></a>
Especifica o protocolo de transferência de dados AWS DataSync usado para acessar seu sistema de FSx arquivos da Amazon.  
Tipo: objeto [FsxProtocol](API_FsxProtocol.md)

 ** [SecurityGroupArns](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-SecurityGroupArns"></a>
Os grupos de segurança DataSync usados para acessar seu FSx sistema de arquivos do ONTAP.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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]+$` 

 ** [StorageVirtualMachineArn](#API_DescribeLocationFsxOntap_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOntap-response-StorageVirtualMachineArn"></a>
O ARN da máquina virtual de armazenamento (SVM) em seu sistema de arquivos FSx for ONTAP de onde você está copiando dados de ou para.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 162.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationFsxOpenZfs
<a name="API_DescribeLocationFsxOpenZfs"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de arquivos Amazon FSx for OpenZFS é configurado.

**nota**  
Os elementos de resposta relacionados a `SMB` não são compatíveis com a operação `DescribeLocationFsxOpenZfs`.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-request-LocationArn"></a>
O nome de recurso da Amazon (ARN) do local do OpenZFS FSx a ser descrito.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "LocationArn": "string",
   "LocationUri": "string",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "ManagedSecretConfig": { 
            "SecretArn": "string"
         },
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "SecurityGroupArns": [ "string" ]
}
```

## Elementos de resposta
<a name="API_DescribeLocationFsxOpenZfs_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.

 ** [CreationTime](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-response-CreationTime"></a>
A hora em que o local FSx for OpenZFS foi criado.  
Tipo: Timestamp

 ** [LocationArn](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-response-LocationArn"></a>
O ARN da localização do FSx OpenZFS que foi descrita.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-response-LocationUri"></a>
O identificador uniforme de recursos (URI) da localização do FSx OpenZFS que foi descrita.  
Exemplo: `fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder`   
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [Protocol](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-response-Protocol"></a>
O tipo de protocolo AWS DataSync usado para acessar seu sistema de arquivos.  
Tipo: objeto [FsxProtocol](API_FsxProtocol.md)

 ** [SecurityGroupArns](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxOpenZfs-response-SecurityGroupArns"></a>
Os grupos ARNs de segurança que estão configurados FSx para o sistema de arquivos do OpenZFS.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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]+$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationFsxWindows
<a name="API_DescribeLocationFsxWindows"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de arquivos Amazon FSx para Windows File Server é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationFsxWindows_RequestSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-request-LocationArn"></a>
Especifica o nome de recurso da Amazon (ARN) da localização FSx do servidor de arquivos para Windows.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "Domain": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "SecurityGroupArns": [ "string" ],
   "User": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationFsxWindows_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.

 ** [CmkSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-CmkSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como `Password` aquele DataSync usado para acessar um local de armazenamento específico, com um segredo gerenciado pelo cliente AWS KMS key.  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)

 ** [CreationTime](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-CreationTime"></a>
A hora em que o FSx local do servidor de arquivos do Windows foi criado.  
Tipo: Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-CustomSecretConfig"></a>
Descreve as informações de configuração de um segredo gerenciado pelo cliente, como `Password` aquele DataSync usado para acessar um local de armazenamento específico, com uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)

 ** [Domain](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-Domain"></a>
O nome do domínio do Microsoft Active Directory ao qual pertence o FSx sistema de arquivos do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 

 ** [LocationArn](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-LocationArn"></a>
O ARN da localização do servidor FSx de arquivos do Windows.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-LocationUri"></a>
O identificador uniforme de recursos (URI) do FSx local do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como `Password` aquele DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)

 ** [SecurityGroupArns](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-SecurityGroupArns"></a>
Os ARNs dos grupos de segurança do Amazon EC2 que fornecem acesso à sub-rede preferencial do sistema de arquivos.  
Para obter informações sobre a configuração de grupos de segurança para acesso ao sistema de arquivos, consulte o [https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html).  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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]+$` 

 ** [User](#API_DescribeLocationFsxWindows_ResponseSyntax) **   <a name="DataSync-DescribeLocationFsxWindows-response-User"></a>
O usuário com as permissões para montar e acessar o sistema FSx de arquivos do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationHdfs
<a name="API_DescribeLocationHdfs"></a>

Fornece detalhes sobre como um local de AWS DataSync transferência para um Hadoop Distributed File System (HDFS) é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationHdfs_RequestSyntax) **   <a name="DataSync-DescribeLocationHdfs-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local do HDFS.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlockSize": number,
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "KerberosPrincipal": "string",
   "KmsKeyProviderUri": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "NameNodes": [ 
      { 
         "Hostname": "string",
         "Port": number
      }
   ],
   "QopConfiguration": { 
      "DataTransferProtection": "string",
      "RpcProtection": "string"
   },
   "ReplicationFactor": number,
   "SimpleUser": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationHdfs_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.

 ** [AgentArns](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-AgentArns"></a>
O ARNs dos DataSync agentes que podem se conectar ao seu cluster HDFS.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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}$` 

 ** [AuthenticationType](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-AuthenticationType"></a>
O tipo de autenticação usado para determinar a identidade do usuário.   
Tipo: string  
Valores válidos: `SIMPLE | KERBEROS` 

 ** [BlockSize](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-BlockSize"></a>
O tamanho dos blocos de dados a serem gravados no cluster do HDFS.   
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.048.576. Valor máximo de 1.073.741.824

 ** [CmkSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-CmkSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como `KerberosKeytab` aquele DataSync usado para acessar um local de armazenamento específico, com um segredo gerenciado pelo cliente AWS KMS key.  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)

 ** [CreationTime](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-CreationTime"></a>
O horário em que a localização do HDFS foi criada.  
Tipo: Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-CustomSecretConfig"></a>
Descreve as informações de configuração de um segredo gerenciado pelo cliente, como `KerberosKeytab` aquele DataSync usado para acessar um local de armazenamento específico, com uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)

 ** [KerberosPrincipal](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-KerberosPrincipal"></a>
A entidade principal do Kerberos com acesso aos arquivos e pastas no cluster do HDFS. Esse parâmetro é usado se o `AuthenticationType` for definido como `KERBEROS`.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$` 

 ** [KmsKeyProviderUri](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-KmsKeyProviderUri"></a>
 O URI do Key Management Server (KMS) do cluster do HDFS.   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$` 

 ** [LocationArn](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-LocationArn"></a>
O ARN do local do HDFS.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-LocationUri"></a>
O URI do local do HDFS.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como `KerberosKeytab` aquele DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)

 ** [NameNodes](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-NameNodes"></a>
O NameNode que gerencia o namespace HDFS.   
Tipo: matriz de objetos [HdfsNameNode](API_HdfsNameNode.md)  
Membros da matriz: número mínimo de 1 item.

 ** [QopConfiguration](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-QopConfiguration"></a>
A configuração de Qualidade de Proteção (QOP), que especifica as configurações de Chamada de Procedimento Remoto (RPC) e de proteção de transferência de dados definidas no cluster do HDFS.   
Tipo: objeto [QopConfiguration](API_QopConfiguration.md)

 ** [ReplicationFactor](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-ReplicationFactor"></a>
O número de DataNodes para os quais replicar os dados ao gravar no cluster HDFS.   
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 512.

 ** [SimpleUser](#API_DescribeLocationHdfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationHdfs-response-SimpleUser"></a>
O nome de usuário para identificar o cliente no sistema operacional do host. Esse parâmetro é usado se o `AuthenticationType` for definido como `SIMPLE`.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationNfs
<a name="API_DescribeLocationNfs"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um servidor de arquivos do Sistema de Arquivos de Rede (NFS) é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationNfs_RequestSyntax) **   <a name="DataSync-DescribeLocationNfs-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local do NFS sobre o qual deseja 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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "LocationArn": "string",
   "LocationUri": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "OnPremConfig": { 
      "AgentArns": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_DescribeLocationNfs_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.

 ** [CreationTime](#API_DescribeLocationNfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationNfs-response-CreationTime"></a>
O horário em que o local do NFS foi criado.  
Tipo: Timestamp

 ** [LocationArn](#API_DescribeLocationNfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationNfs-response-LocationArn"></a>
O ARN do local do NFS.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationNfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationNfs-response-LocationUri"></a>
O URI do local do NFS.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [MountOptions](#API_DescribeLocationNfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationNfs-response-MountOptions"></a>
As opções de montagem DataSync usadas para montar seu servidor de arquivos NFS.  
Tipo: objeto [NfsMountOptions](API_NfsMountOptions.md)

 ** [OnPremConfig](#API_DescribeLocationNfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationNfs-response-OnPremConfig"></a>
Os AWS DataSync agentes que podem se conectar ao seu servidor de arquivos do Sistema de Arquivos de Rede (NFS).  
Tipo: objeto [OnPremConfig](API_OnPremConfig.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeLocationNfs_Examples"></a>

### Exemplo
<a name="API_DescribeLocationNfs_Example_1"></a>

O exemplo a seguir retorna informações sobre o local do NFS especificado na solicitação de amostras.

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

```
{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa"
}
```

### Exemplo
<a name="API_DescribeLocationNfs_Example_2"></a>

Este exemplo ilustra um uso do. DescribeLocationNfs

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

```
{
   "CreationTime": 1532660733.39,
   "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
   "LocationUri": "hostname.amazon.com",
   "OnPremConfig": { 
      "AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ]
   }
}
```

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

# DescribeLocationObjectStorage
<a name="API_DescribeLocationObjectStorage"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um sistema de armazenamento de objetos é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationObjectStorage_RequestSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local do sistema de armazenamento de objetos.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "ServerCertificate": blob,
   "ServerPort": number,
   "ServerProtocol": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationObjectStorage_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.

 ** [AccessKey](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-AccessKey"></a>
A chave de acesso (por exemplo, um nome de usuário) necessária para se autenticar com o sistema de armazenamento de objetos.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Padrão: `^.*$` 

 ** [AgentArns](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-AgentArns"></a>
O ARNs dos DataSync agentes que podem se conectar ao seu sistema de armazenamento de objetos.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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}$` 

 ** [CmkSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-CmkSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)

 ** [CreationTime](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-CreationTime"></a>
O horário em que a localização foi criada.  
Tipo: Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-CustomSecretConfig"></a>
Descreve as informações de configuração de um segredo gerenciado pelo cliente, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)

 ** [LocationArn](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-LocationArn"></a>
O ARN do local do sistema de armazenamento de objetos.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-LocationUri"></a>
O URI do local do sistema de armazenamento de objetos.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação ou um conjunto de credenciais DataSync usado para acessar um local de transferência específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)

 ** [ServerCertificate](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-ServerCertificate"></a>
A cadeia de certificados DataSync para autenticação em seu sistema de armazenamento de objetos se o sistema usar uma autoridade de certificação (CA) privada ou autoassinada.  
Tipo: Objeto de dados binários codificado em Base64  
Restrições de tamanho: tamanho máximo de 32768.

 ** [ServerPort](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-ServerPort"></a>
A porta em que o servidor de armazenamento de objetos aceita o tráfego de rede de entrada (por exemplo, a porta 443).  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 65536.

 ** [ServerProtocol](#API_DescribeLocationObjectStorage_ResponseSyntax) **   <a name="DataSync-DescribeLocationObjectStorage-response-ServerProtocol"></a>
O protocolo que o seu sistema de armazenamento de objetos usa para se comunicar.  
Tipo: string  
Valores válidos: `HTTPS | HTTP` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# DescribeLocationS3
<a name="API_DescribeLocationS3"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um bucket do S3 é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationS3_RequestSyntax) **   <a name="DataSync-DescribeLocationS3-request-LocationArn"></a>
O nome do recurso da Amazon (ARN) do local do Amazon S3.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AgentArns": [ "string" ],
   "CreationTime": number,
   "LocationArn": "string",
   "LocationUri": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationS3_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.

 ** [AgentArns](#API_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-AgentArns"></a>
O ARNs dos DataSync agentes implantados em seu Outpost ao trabalhar com o Amazon S3 em Outposts.  
Para obter mais informações, consulte [Implantar seu DataSync agente em AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent).  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-CreationTime"></a>
O horário em que o local do bucket da Amazon S3 foi criado.  
Tipo: Timestamp

 ** [LocationArn](#API_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-LocationArn"></a>
O ARN do local do Amazon S3.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-LocationUri"></a>
O URL do local do Amazon S3 que foi descrito.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [S3Config](#API_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-S3Config"></a>
Especifica o Amazon Resource Name (ARN) AWS Identity and Access Management da função DataSync (IAM) usada para acessar seu bucket do S3.  
Para obter mais informações, consulte [Fornecendo DataSync acesso aos buckets do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).  
Tipo: objeto [S3Config](API_S3Config.md)

 ** [S3StorageClass](#API_DescribeLocationS3_ResponseSyntax) **   <a name="DataSync-DescribeLocationS3-response-S3StorageClass"></a>
Quando o Amazon S3 é um local de destino, essa é a classe de armazenamento que você escolheu para seus objetos.  
Algumas classes de armazenamento têm comportamentos que podem afetar os custos de armazenamento do Amazon S3. Para obter mais informações, consulte [Considerações sobre classes de armazenamento com transferências do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).  
Tipo: string  
Valores válidos: `STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeLocationS3_Examples"></a>

### Exemplo
<a name="API_DescribeLocationS3_Example_1"></a>

O exemplo a seguir retorna informações sobre o local do Amazon S3 especificado no exemplo de solicitação.

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

```
{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3"
}
```

### Exemplo
<a name="API_DescribeLocationS3_Example_2"></a>

Este exemplo ilustra um uso do DescribeLocation S3.

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

```
{
   "CreationTime": 1532660733.39,
   "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3",
   "LocationUri": "s3://amzn-s3-demo-bucket",
   "S3Config": { 
      "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role",
   }
    "S3StorageClass": "STANDARD"
}
```

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

# DescribeLocationSmb
<a name="API_DescribeLocationSmb"></a>

Fornece detalhes sobre como um local AWS DataSync de transferência para um servidor de arquivos SMB (Server Message Block) é configurado.

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

```
{
   "LocationArn": "string"
}
```

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

 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) **   <a name="DataSync-DescribeLocationSmb-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local SMB sobre o qual você deseja 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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: sim

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosPrincipal": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "MountOptions": { 
      "Version": "string"
   },
   "User": "string"
}
```

## Elementos de resposta
<a name="API_DescribeLocationSmb_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.

 ** [AgentArns](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AgentArns"></a>
O ARNs dos DataSync agentes que podem se conectar ao seu servidor de arquivos SMB.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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}$` 

 ** [AuthenticationType](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AuthenticationType"></a>
O protocolo de autenticação DataSync usado para se conectar ao seu servidor de arquivos SMB.  
Tipo: string  
Valores válidos: `NTLM | KERBEROS` 

 ** [CmkSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CmkSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um `Password` ou `KerberosKeytab` que é DataSync usado para acessar um local de armazenamento específico, com um gerenciado pelo cliente AWS KMS key.  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)

 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CreationTime"></a>
O horário em que o local do SMB foi criado.  
Tipo: Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CustomSecretConfig"></a>
Descreve as informações de configuração de um segredo gerenciado pelo cliente, como um `Password` ou `KerberosKeytab` que é DataSync usado para acessar um local de armazenamento específico, com uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)

 ** [DnsIpAddresses](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-DnsIpAddresses"></a>
Os IPv6 endereços IPv4 ou dos servidores DNS aos quais seu servidor de arquivos SMB pertence. Esse elemento se aplica somente se `AuthenticationType` estiver definido como `KERBEROS`.  
Tipo: matriz de strings  
Membros da matriz: número máximo de 2 itens.  
Restrições de comprimento: comprimento mínimo de 7. Comprimento máximo de 39.  
Padrão: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` 

 ** [Domain](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-Domain"></a>
O nome do domínio do Windows ao qual o servidor de arquivos SMB pertence. Esse elemento se aplica somente se `AuthenticationType` estiver definido como `NTLM`.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 

 ** [KerberosPrincipal](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-KerberosPrincipal"></a>
A entidade principal Kerberos que tem permissão para acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$` 

 ** [LocationArn](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationArn"></a>
O ARN do local SMB.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [LocationUri](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationUri"></a>
O URI do local SMB.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como um `Password` ou `KerberosKeytab` que é DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)

 ** [MountOptions](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-MountOptions"></a>
A versão do protocolo SMB DataSync usada para acessar seu servidor de arquivos SMB.  
Tipo: objeto [SmbMountOptions](API_SmbMountOptions.md)

 ** [User](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-User"></a>
O usuário que pode montar e acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB. Esse elemento se aplica somente se `AuthenticationType` estiver definido como `NTLM`.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeLocationSmb_Examples"></a>

### Exemplo
<a name="API_DescribeLocationSmb_Example_1"></a>

Este exemplo ilustra um uso do. DescribeLocationSmb

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

```
{
  "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```

### Exemplo
<a name="API_DescribeLocationSmb_Example_2"></a>

Este exemplo ilustra um uso do. DescribeLocationSmb

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

```
{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f"
   ],
   "CreationTime":"1532660733.39",
   "Domain":"AMAZON",
   "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49",
   "LocationUri":"smb://hostname.amazon.com/share",
   "MountOptions":{
      "Version":"SMB3"
   },
   "User":"user-1"
}
```

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

# DescribeTask
<a name="API_DescribeTask"></a>

Fornece informações sobre uma *tarefa*, que definem para onde e como o AWS DataSync transfere os dados.

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

```
{
   "TaskArn": "string"
}
```

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

 ** [TaskArn](#API_DescribeTask_RequestSyntax) **   <a name="DataSync-DescribeTask-request-TaskArn"></a>
Especifica o nome do recurso da Amazon (ARN) a tarefa de transferência sobre a qual você deseja 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}:task/task-[0-9a-f]{17}$`   
Obrigatório: sim

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

```
{
   "CloudWatchLogGroupArn": "string",
   "CreationTime": number,
   "CurrentTaskExecutionArn": "string",
   "DestinationLocationArn": "string",
   "DestinationNetworkInterfaceArns": [ "string" ],
   "ErrorCode": "string",
   "ErrorDetail": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "Name": "string",
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Schedule": { 
      "ScheduleExpression": "string",
      "Status": "string"
   },
   "ScheduleDetails": { 
      "DisabledBy": "string",
      "DisabledReason": "string",
      "StatusUpdateTime": number
   },
   "SourceLocationArn": "string",
   "SourceNetworkInterfaceArns": [ "string" ],
   "Status": "string",
   "TaskArn": "string",
   "TaskMode": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeTask_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.

 ** [CloudWatchLogGroupArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CloudWatchLogGroupArn"></a>
O Amazon Resource Name (ARN) de um grupo de CloudWatch logs da Amazon para monitorar sua tarefa.  
Para mais informações, consulte [Monitoramento de transferências de dados com o CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 562.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` 

 ** [CreationTime](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CreationTime"></a>
A data e hora em que a tarefa foi criada.  
Tipo: Timestamp

 ** [CurrentTaskExecutionArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-CurrentTaskExecutionArn"></a>
O ARN da última execução da tarefa.  
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$` 

 ** [DestinationLocationArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-DestinationLocationArn"></a>
O ARN do local de destino da transferência.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-DestinationNetworkInterfaceArns"></a>
A ARNs das [interfaces de rede](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) DataSync criadas para seu local de destino.  
Tipo: matriz de strings  
Restrições de Tamanho: Tamanho máximo de 128.  
Padrão: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` 

 ** [ErrorCode](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ErrorCode"></a>
Se houver um problema com a tarefa, você pode usar o código de erro para ajudar você a solucionar o problema. Para obter mais informações, consulte [Solução de problemas com DataSync transferências](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Tipo: string

 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ErrorDetail"></a>
Se houver um problema com a tarefa, você pode usar os detalhes do erro para ajudar você a solucionar o problema. Para obter mais informações, consulte [Solução de problemas com DataSync transferências](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Tipo: string

 ** [Excludes](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Excludes"></a>
Os filtros de exclusão que definem os arquivos, objetos e pastas em seu local de origem que você não DataSync deseja transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

 ** [Includes](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Includes"></a>
Incluem filtros que definem os arquivos, objetos e pastas no local de origem que você DataSync deseja transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ManifestConfig"></a>
A configuração do manifesto que lista os arquivos ou objetos que você DataSync deseja transferir. Para obter mais informações, consulte [Especificando quais DataSync transferências usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Tipo: objeto [ManifestConfig](API_ManifestConfig.md)

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

 ** [Options](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Options"></a>
As configurações da tarefa. Por exemplo, quais metadados de arquivos são preservados, como a integridade dos dados é verificada no final da transferência, limites de largura de banda, entre outras opções.  
Tipo: objeto [Options](API_Options.md)

 ** [Schedule](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Schedule"></a>
O agendamento de quando você deseja que a tarefa seja executada. Para obter mais informações, consulte [Programar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Tipo: objeto [TaskSchedule](API_TaskSchedule.md)

 ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-ScheduleDetails"></a>
Os detalhes sobre o [agendamento da tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Tipo: objeto [TaskScheduleDetails](API_TaskScheduleDetails.md)

 ** [SourceLocationArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-SourceLocationArn"></a>
O ARN do local de origem da transferência.  
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}:location/loc-[0-9a-z]{17}$` 

 ** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-SourceNetworkInterfaceArns"></a>
A ARNs das [interfaces de rede](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) DataSync criadas para seu local de origem.  
Tipo: matriz de strings  
Restrições de Tamanho: Tamanho máximo de 128.  
Padrão: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` 

 ** [Status](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-Status"></a>
O status da tarefa. Para obter informações sobre o significado de cada status, consulte [Status das tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses).  
Tipo: string  
Valores válidos: `AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE` 

 ** [TaskArn](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskArn"></a>
O ARN da tarefa.  
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}:task/task-[0-9a-f]{17}$` 

 ** [TaskMode](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskMode"></a>
O modo de tarefa que você está usando. Para obter mais informações, consulte [Como escolher um modo de tarefa para a transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Tipo: string  
Valores válidos: `BASIC | ENHANCED` 

 ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) **   <a name="DataSync-DescribeTask-response-TaskReportConfig"></a>
A configuração do seu relatório de tarefas, que fornece informações detalhadas sobre sua DataSync transferência. Para obter mais informações, consulte [Monitorando suas DataSync transferências com relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Tipo: objeto [TaskReportConfig](API_TaskReportConfig.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeTask_Examples"></a>

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

O exemplo a seguir especifica o ARN de DataSync uma tarefa sobre a qual obter informações.

```
{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```

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

O exemplo a seguir mostra uma resposta `DescribeTask`.

```
{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026",
  "Name": "MyTask",
  "TaskMode": "BASIC",
  "Status": "RUNNING",
  "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
  "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
  "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
  "CreationTime": 1532660733.39,
  "Options": { 
    "Atime": "BEST_EFFORT",
    "BytesPerSecond": 1000,
    "Gid": "NONE",
    "Mtime": "PRESERVE",
    "PosixPermissions": "PRESERVE",
    "PreserveDevices": "NONE",
    "PreserveDeletedFiles": "PRESERVE",
    "Uid": "NONE",
    "VerifyMode": "POINT_IN_TIME_CONSISTENT"
  },
  "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*"
}
```

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

# DescribeTaskExecution
<a name="API_DescribeTaskExecution"></a>

Fornece informações sobre a execução de sua AWS DataSync tarefa. Você pode usar essa operação para ajudar a monitorar o progresso de uma transferência de dados em andamento ou verificar os resultados da transferência.

**nota**  
Alguns elementos da resposta `DescribeTaskExecution` são relevantes somente para um modo de tarefa específico. Para obter informações, consulte [Como entender as diferenças do modo de tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences) e [Como entender os contadores de desempenho da transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html).

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

```
{
   "TaskExecutionArn": "string"
}
```

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

 ** [TaskExecutionArn](#API_DescribeTaskExecution_RequestSyntax) **   <a name="DataSync-DescribeTaskExecution-request-TaskExecutionArn"></a>
Especifica o nome do recurso da Amazon (ARN) da execução da tarefa sobre a qual você deseja 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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`   
Obrigatório: sim

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

```
{
   "BytesCompressed": number,
   "BytesTransferred": number,
   "BytesWritten": number,
   "EndTime": number,
   "EstimatedBytesToTransfer": number,
   "EstimatedFilesToDelete": number,
   "EstimatedFilesToTransfer": number,
   "EstimatedFoldersToDelete": number,
   "EstimatedFoldersToTransfer": number,
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "FilesDeleted": number,
   "FilesFailed": { 
      "Delete": number,
      "Prepare": number,
      "Transfer": number,
      "Verify": number
   },
   "FilesListed": { 
      "AtDestinationForDelete": number,
      "AtSource": number
   },
   "FilesPrepared": number,
   "FilesSkipped": number,
   "FilesTransferred": number,
   "FilesVerified": number,
   "FoldersDeleted": number,
   "FoldersFailed": { 
      "Delete": number,
      "List": number,
      "Prepare": number,
      "Transfer": number,
      "Verify": number
   },
   "FoldersListed": { 
      "AtDestinationForDelete": number,
      "AtSource": number
   },
   "FoldersPrepared": number,
   "FoldersSkipped": number,
   "FoldersTransferred": number,
   "FoldersVerified": number,
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "LaunchTime": number,
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "ReportResult": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "Status": "string"
   },
   "Result": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "PrepareDuration": number,
      "PrepareStatus": "string",
      "TotalDuration": number,
      "TransferDuration": number,
      "TransferStatus": "string",
      "VerifyDuration": number,
      "VerifyStatus": "string"
   },
   "StartTime": number,
   "Status": "string",
   "TaskExecutionArn": "string",
   "TaskMode": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeTaskExecution_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.

 ** [BytesCompressed](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-BytesCompressed"></a>
O número de bytes físicos que são DataSync transferidos pela rede após a compactação (se a compactação for possível). Tipicamente, esse número é menor do que [BytesTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred), a menos que os dados não sejam compactáveis.  
Tipo: longo

 ** [BytesTransferred](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-BytesTransferred"></a>
O número de bytes DataSync enviados para a rede antes da compactação (se a compactação for possível). Para saber o número de bytes transferidos pela rede, consulte [BytesCompressed](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed).   
Tipo: longo

 ** [BytesWritten](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-BytesWritten"></a>
O número de bytes lógicos que DataSync realmente gravam no local de destino.  
Tipo: longo

 ** [EndTime](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EndTime"></a>
A hora em que a tarefa de transferência termina.  
Tipo: Timestamp

 ** [EstimatedBytesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EstimatedBytesToTransfer"></a>
O número de bytes lógicos que DataSync esperam gravar no local de destino.  
Tipo: longo

 ** [EstimatedFilesToDelete](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EstimatedFilesToDelete"></a>
O número de arquivos, objetos e diretórios que você DataSync espera excluir no local de destino. Se você não [configurar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) para excluir os dados no destino que não estão na origem, o valor sempre será `0`.  
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [EstimatedFoldersToDelete](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToDelete). 
Tipo: longo

 ** [EstimatedFilesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EstimatedFilesToTransfer"></a>
O número de arquivos, objetos e diretórios que DataSync esperam ser transferidos pela rede. Esse valor é calculado enquanto DataSync [prepara](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses) a transferência.  
Como isso é calculado depende principalmente da configuração de [modo de transferência](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode) da tarefa:  
+ Se `TranserMode` estiver definido como `CHANGED`: o cálculo será baseado na comparação do conteúdo dos locais de origem e na diferença e na determinação da diferença que precisa ser transferida. A diferença pode incluir:
  + Tudo o que for adicionado ou modificado no local de origem.
  + Qualquer coisa que esteja nos dois locais e modificada no destino após uma transferência inicial (a menos que [OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode)esteja configurada como`NEVER`).
  +  **(Somente no modo de tarefa básica)** O número de itens que DataSync espera excluir (se [PreserveDeletedFiles](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles)estiver definido como`REMOVE`).
+ Se `TranserMode` estiver definido como `ALL` - O cálculo é baseado somente nos itens DataSync encontrados no local de origem.
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [EstimatedFoldersToTransfer](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToTransfer). 
Tipo: longo

 ** [EstimatedFoldersToDelete](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EstimatedFoldersToDelete"></a>
O número de diretórios que você DataSync espera excluir em seu local de destino. Se você não [configurar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) para excluir os dados no destino que não estão na origem, o valor sempre será `0`.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [EstimatedFoldersToTransfer](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-EstimatedFoldersToTransfer"></a>
O número de diretórios que DataSync esperam ser transferidos pela rede. Esse valor é calculado à medida que DataSync [prepara os](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses) diretórios para transferência.  
Como isso é calculado depende principalmente da configuração de [modo de transferência](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode) da tarefa:  
+ Se `TranserMode` estiver definido como `CHANGED`: o cálculo será baseado na comparação do conteúdo dos locais de origem e na diferença e na determinação da diferença que precisa ser transferida. A diferença pode incluir:
  + Tudo o que for adicionado ou modificado no local de origem.
  + Qualquer coisa que esteja nos dois locais e modificada no destino após uma transferência inicial (a menos que [OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode)esteja configurada como`NEVER`).
+ Se `TranserMode` estiver definido como `ALL` - O cálculo é baseado somente nos itens DataSync encontrados no local de origem.
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [Excludes](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-Excludes"></a>
Uma lista de regras de filtro que excluem dados específicos durante a transferência. Para obter mais informações e exemplos, consulte [Filtragem de dados transferidos por DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

 ** [FilesDeleted](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesDeleted"></a>
O número de arquivos, objetos e diretórios que DataSync realmente são excluídos em seu local de destino. Se você não [configurar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) para excluir os dados no destino que não estão na origem, o valor sempre será `0`.  
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [FoldersDeleted](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersDeleted). 
Tipo: longo

 ** [FilesFailed](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesFailed"></a>
O número de arquivos ou objetos que DataSync falham na preparação, transferência, verificação e exclusão durante a execução da tarefa.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: objeto [TaskExecutionFilesFailedDetail](API_TaskExecutionFilesFailedDetail.md)

 ** [FilesListed](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesListed"></a>
O número de arquivos ou objetos DataSync encontrados em seus locais.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: objeto [TaskExecutionFilesListedDetail](API_TaskExecutionFilesListedDetail.md)

 ** [FilesPrepared](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesPrepared"></a>
O número de arquivos ou objetos que DataSync tentarão ser transferidos depois de comparar seus locais de origem e destino.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Esse contador não é aplicável se você configurar a tarefa para [transferir todos os dados](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode). Nesse cenário, DataSync copia tudo da origem ao destino sem comparar as diferenças entre os locais.  
Tipo: longo

 ** [FilesSkipped](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesSkipped"></a>
O número de arquivos, objetos e diretórios que são DataSync ignorados durante a transferência.  
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [FoldersSkipped](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersSkipped). 
Tipo: longo

 ** [FilesTransferred](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesTransferred"></a>
O número de arquivos, objetos e diretórios que DataSync realmente são transferidos pela rede. Esse valor é atualizado periodicamente durante a fase de execução da tarefa, quando algo é lido na fonte e enviado pela rede.  
Se DataSync não conseguir transferir algo, esse valor pode ser menor que`EstimatedFilesToTransfer`. Em alguns casos, esse valor também pode ser maior que `EstimatedFilesToTransfer`. Esse elemento é específico da implementação para alguns tipos de local e, portanto, não o use como uma indicação exata do que está sendo transferido nem para monitorar a execução da tarefa.  
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [FoldersTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersTransferred). 
Tipo: longo

 ** [FilesVerified](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FilesVerified"></a>
O número de arquivos, objetos e diretórios que são DataSync verificados durante a transferência.  
Quando você configura sua tarefa para [verificar somente os dados transferidos](https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html), DataSync não verifica diretórios em algumas situações ou arquivos que falham na transferência.  
Para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html), esse contador inclui somente arquivos ou objetos. Os diretórios são contados [FoldersVerified](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersVerified). 
Tipo: longo

 ** [FoldersDeleted](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersDeleted"></a>
O número de diretórios que DataSync realmente são excluídos em seu local de destino. Se você não [configurar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) para excluir os dados no destino que não estão na origem, o valor sempre será `0`.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [FoldersFailed](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersFailed"></a>
O número de diretórios que DataSync não conseguem listar, preparar, transferir, verificar e excluir durante a execução da tarefa.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: objeto [TaskExecutionFoldersFailedDetail](API_TaskExecutionFoldersFailedDetail.md)

 ** [FoldersListed](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersListed"></a>
O número de diretórios DataSync encontrados em seus locais.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: objeto [TaskExecutionFoldersListedDetail](API_TaskExecutionFoldersListedDetail.md)

 ** [FoldersPrepared](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersPrepared"></a>
O número de diretórios que DataSync tentarão transferir depois de comparar seus locais de origem e destino.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Esse contador não é aplicável se você configurar a tarefa para [transferir todos os dados](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode). Nesse cenário, DataSync copia tudo da origem ao destino sem comparar as diferenças entre os locais.  
Tipo: longo

 ** [FoldersSkipped](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersSkipped"></a>
O número de diretórios que são DataSync ignorados durante sua transferência.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [FoldersTransferred](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersTransferred"></a>
O número de diretórios que DataSync realmente são transferidos pela rede. Esse valor é atualizado periodicamente durante a fase de execução da tarefa, quando algo é lido na fonte e enviado pela rede.  
Se DataSync não conseguir transferir algo, esse valor pode ser menor que`EstimatedFoldersToTransfer`. Em alguns casos, esse valor também pode ser maior que `EstimatedFoldersToTransfer`.   
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [FoldersVerified](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-FoldersVerified"></a>
O número de diretórios que são DataSync verificados durante sua transferência.  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).
Tipo: longo

 ** [Includes](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-Includes"></a>
Uma lista de regras de filtro que incluem dados específicos durante a transferência. Para obter mais informações e exemplos, consulte [Filtragem de dados transferidos por DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

 ** [LaunchTime](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-LaunchTime"></a>
A hora em que a execução da tarefa realmente começa. Para tarefas que não estão em fila, `LaunchTime` e `StartTime` geralmente são as mesmas. Para tarefas em fila, geralmente `LaunchTime` é mais tarde do que `StartTime` porque as tarefas anteriormente na fila devem terminar de ser executadas antes que as mais recentes possam começar.  
Tipo: Timestamp

 ** [ManifestConfig](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-ManifestConfig"></a>
A configuração do manifesto que lista os arquivos ou os objetos que você deseja transferir. Para obter mais informações, consulte [Especificando quais DataSync transferências usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Tipo: objeto [ManifestConfig](API_ManifestConfig.md)

 ** [Options](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-Options"></a>
Indica como sua tarefa de transferência está configurada. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados durante a transferência. Você também pode especificar como verificar a integridade dos dados, definir limites de largura de banda para sua tarefa, entre outras opções.  
Cada opção tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhuma opção antes de ligar [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).  
Você também pode substituir suas opções de tarefa para cada execução de tarefa. Por exemplo, pode ser bom ajustar o `LogLevel` para uma execução individual.  
Tipo: objeto [Options](API_Options.md)

 ** [ReportResult](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-ReportResult"></a>
Indica se DataSync gerou um [relatório de tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) completo para sua transferência.  
Tipo: objeto [ReportResult](API_ReportResult.md)

 ** [Result](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-Result"></a>
O resultado da execução da tarefa.  
Tipo: objeto [TaskExecutionResultDetail](API_TaskExecutionResultDetail.md)

 ** [StartTime](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-StartTime"></a>
A hora em que a solicitação é DataSync enviada para iniciar a execução da tarefa. Para tarefas que não estão em fila, `LaunchTime` e `StartTime` geralmente são as mesmas. Para tarefas em fila, geralmente `LaunchTime` é mais tarde do que `StartTime` porque as tarefas anteriormente na fila devem terminar de ser executadas antes que as mais recentes possam começar.  
Tipo: Timestamp

 ** [Status](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-Status"></a>
O status da execução da tarefa.   
Para obter informações detalhadas sobre os status de execução de tarefas, consulte [Status de execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Tipo: string  
Valores válidos: `QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR` 

 ** [TaskExecutionArn](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-TaskExecutionArn"></a>
O ARN da execução da tarefa sobre a qual deseja obter informações. O `TaskExecutionArn` é hierárquico e inclui `TaskArn` para a tarefa que foi executada.   
Por exemplo, um valor `TaskExecution` com o ARN `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b` executou a tarefa com o ARN `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2`.   
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$` 

 ** [TaskMode](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-TaskMode"></a>
O modo de tarefa que você está usando. Para obter mais informações, consulte [Como escolher um modo de tarefa para a transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Tipo: string  
Valores válidos: `BASIC | ENHANCED` 

 ** [TaskReportConfig](#API_DescribeTaskExecution_ResponseSyntax) **   <a name="DataSync-DescribeTaskExecution-response-TaskReportConfig"></a>
A configuração do seu relatório de tarefas, que fornece informações detalhadas sobre sua DataSync transferência. Para obter mais informações, consulte [Criar uma relatório de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Tipo: objeto [TaskReportConfig](API_TaskReportConfig.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_DescribeTaskExecution_Examples"></a>

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

Este exemplo ilustra uma solicitação `DescribeTaskExecution`.

```
{
    "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1"
}
```

### Exemplo de resposta 1 para uma execução de tarefa no modo Avançado
<a name="API_DescribeTaskExecution_Example_2"></a>

O exemplo a seguir descreve a execução de uma DataSync tarefa que usa o modo Avançado. A execução também transfere dados específicos usando filtros de exclusão e inclusão.

```
{
    "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
    "Status": "SUCCESS",
    "Options": {
        "VerifyMode": "ONLY_FILES_TRANSFERRED",
        "OverwriteMode": "ALWAYS",
        "Atime": "BEST_EFFORT",
        "Mtime": "PRESERVE",
        "Uid": "NONE",
        "Gid": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "PreserveDevices": "NONE",
        "PosixPermissions": "NONE",
        "BytesPerSecond": -1,
        "TaskQueueing": "ENABLED",
        "LogLevel": "BASIC",
        "TransferMode": "CHANGED",
        "SecurityDescriptorCopyFlags": "NONE",
        "ObjectTags": "PRESERVE"
    },
    "Excludes": [{
        "FilterType": "SIMPLE_PATTERN",
        "Value": "/archive-files"
    }],
    "Includes": [{
        "FilterType": "SIMPLE_PATTERN",
        "Value": "/files"
    }],
    "StartTime": "2024-10-16T11:19:56.844000-04:00",
    "EstimatedFilesToTransfer": 7,
    "EstimatedFoldersToTransfer": 2,
    "EstimatedBytesToTransfer": 30,
    "FilesTransferred": 7,
    "FoldersTransferred": 2,
    "BytesWritten": 30,
    "BytesTransferred": 30,
    "BytesCompressed": 30,
    "Result": {
        "PrepareDuration": 0,
        "PrepareStatus": "SUCCESS",
        "TotalDuration": 3310,
        "TransferDuration": 0,
        "TransferStatus": "SUCCESS",
        "VerifyDuration": 0,
        "VerifyStatus": "SUCCESS"
    },
    "FilesDeleted": 0,
    "FilesSkipped": 0,
    "FilesVerified": 7,
    "EstimatedFilesToDelete": 0,
    "TaskMode": "ENHANCED",
    "FilesPrepared": 7,
    "FilesListed": {
        "AtSource": 7,
        "AtDestinationForDelete": 0
    },
    "FilesFailed": {
        "Prepare": 0,
        "Transfer": 0,
        "Verify": 0,
        "Delete": 0
    },
    "FoldersDeleted": 0,
    "FoldersSkipped": 0,
    "FoldersVerified": 2,
    "FoldersPrepared": 2,
    "FoldersListed": {
        "AtSource": 2,
        "AtDestinationForDelete": 0
    },
    "FoldersFailed": {
        "List": 0,
        "Prepare": 0,
        "Transfer": 0,
        "Verify": 0,
        "Delete": 0
    }
}
```

### Exemplo de resposta 2 para uma execução de tarefa no modo Avançado
<a name="API_DescribeTaskExecution_Example_3"></a>

O exemplo a seguir descreve outra execução de DataSync tarefa que usa o modo Avançado. Nessa situação, a execução está transferindo dados específicos usando um manifesto em vez de filtros.

```
{
    "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
    "Status": "SUCCESS",
    "Options": {
        "VerifyMode": "ONLY_FILES_TRANSFERRED",
        "OverwriteMode": "ALWAYS",
        "Atime": "BEST_EFFORT",
        "Mtime": "PRESERVE",
        "Uid": "NONE",
        "Gid": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "PreserveDevices": "NONE",
        "PosixPermissions": "NONE",
        "BytesPerSecond": -1,
        "TaskQueueing": "ENABLED",
        "LogLevel": "TRANSFER",
        "TransferMode": "CHANGED",
        "SecurityDescriptorCopyFlags": "NONE",
        "ObjectTags": "PRESERVE"
    },
    "Excludes": [],
    "Includes": [],
    "ManifestConfig": {
        "Action": "TRANSFER",
        "Format": "CSV",
        "S3AccessRoleArn": "arn:aws:iam::111222333444:role/service-role/DataSyncS3ManifestAccess",
        "S3Bucket": "arn:aws:s3:::manifests-datasync",
        "VersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG",
        "Source": {
            "S3": {
                "ManifestObjectPath": "manifest-folder/manifest-versioned-files",
                "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-manifest-role/DataSyncS3ManifestAccess",
                "S3BucketArn": "arn:aws:s3:::manifests-datasync",
                "ManifestObjectVersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG"
            }
        }
    },
    "StartTime": "2024-10-16T09:29:56.757000-04:00",
    "EstimatedFilesToTransfer": 1,
    "EstimatedFoldersToTransfer": 0,
    "EstimatedBytesToTransfer": 6,
    "FilesTransferred": 1,
    "FoldersTransferred": 1,
    "BytesWritten": 6,
    "BytesTransferred": 6,
    "BytesCompressed": 6,
    "Result": {
        "PrepareDuration": 0,
        "PrepareStatus": "SUCCESS",
        "TotalDuration": 3089,
        "TransferDuration": 0,
        "TransferStatus": "SUCCESS",
        "VerifyDuration": 0,
        "VerifyStatus": "SUCCESS"
    },
    "TaskReportConfig": {
        "Destination": {
            "S3": {
                "Subdirectory": "reports/",
                "S3BucketArn": "arn:aws:s3:::my-task-report",
                "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-task-report-role/DataSyncTaskReportS3BucketAccess"
            }
        },
        "OutputType": "STANDARD",
        "ReportLevel": "SUCCESSES_AND_ERRORS",
        "ObjectVersionIds": "INCLUDE"
    },
    "FilesDeleted": 0,
    "FilesSkipped": 0,
    "FilesVerified": 1,
    "ReportResult": {
        "Status": "SUCCESS"
    },
    "EstimatedFilesToDelete": 0,
    "TaskMode": "ENHANCED",
    "FilesPrepared": 1,
    "FilesListed": {
        "AtSource": 1,
        "AtDestinationForDelete": 0
    },
    "FilesFailed": {
        "Prepare": 0,
        "Transfer": 0,
        "Verify": 0,
        "Delete": 0
    },
    "FoldersDeleted": 0,
    "FoldersSkipped": 0,
    "FoldersVerified": 0,
    "FoldersPrepared": 0,
    "FoldersListed": {
        "AtSource": 0,
        "AtDestinationForDelete": 0
    },
    "FoldersFailed": {
        "List": 0,
        "Prepare": 0,
        "Transfer": 0,
        "Verify": 0,
        "Delete": 0
    }
  }
```

### Exemplo de resposta para a execução de uma tarefa no modo Básico
<a name="API_DescribeTaskExecution_Example_4"></a>

O exemplo a seguir descreve a execução de uma DataSync tarefa que usa o modo Básico.

```
{
    "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
    "BytesCompressed": 3500,
    "BytesTransferred": 5000,
    "BytesWritten": 5000,
    "EstimatedBytesToTransfer": 5000,
    "EstimatedFilesToDelete": 10,
    "EstimatedFilesToTransfer": 100,
    "FilesDeleted": 10,
    "FilesSkipped": 0,
    "FilesTransferred": 100,
    "FilesVerified": 100,
    "Result": {
        "PrepareDuration": 100,
        "PrepareStatus": "SUCCESS",
        "TransferDuration": 60,
        "TransferStatus": "SUCCESS",
        "VerifyDuration": 30,
        "VerifyStatus": "SUCCESS"
    },
    "StartTime": "2024-10-16T11:19:56.844000-04:00",
    "Status": "SUCCESS",
    "OverrideOptions": {
        "Atime": "BEST_EFFORT",
        "BytesPerSecond": "1000",
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "TaskReportConfig": {
        "Destination": {
            "S3": {
                "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync-role",
                "S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*",
                "Subdirectory": "reports"
            }
        },
        "ObjectVersionIds": "INCLUDE",
        "OutputType": "STANDARD",
        "Overrides": {
            "Deleted": {
                "ReportLevel": "ERRORS_ONLY"
            },
            "Skipped": {
                "ReportLevel": "SUCCESSES_AND_ERRORS"
            },
            "Transferred": {
                "ReportLevel": "ERRORS_ONLY"
            },
            "Verified": {
                "ReportLevel": "ERRORS_ONLY"
            }
        },
        "ReportLevel": "ERRORS_ONLY"
    }
}
```

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

# ListAgents
<a name="API_ListAgents"></a>

Retorna uma lista de AWS DataSync agentes que pertencem a um Conta da AWS no Região da AWS especificado na solicitação.

Com a paginação, você pode reduzir o número de atendentes retornados em uma resposta. Se você receber uma lista truncada de atendentes em uma resposta, a resposta conterá um marcador que você pode especificar em sua próxima solicitação para buscar a próxima página de atendentes.

 `ListAgents` eventualmente é consistente. Isso significa que o resultado da execução da operação pode não refletir que você acabou de criar ou excluir um atendente. Por exemplo, se você criar um agente com [CreateAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html)e depois executá-lo imediatamente`ListAgents`, esse agente pode não aparecer na lista imediatamente. Em situações como essa, você sempre pode confirmar se um agente foi criado (ou excluído) usando [DescribeAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html)o.

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

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

 ** [MaxResults](#API_ListAgents_RequestSyntax) **   <a name="DataSync-ListAgents-request-MaxResults"></a>
Especifica o número máximo de DataSync agentes a serem listados em uma resposta. Por padrão, uma resposta mostra no máximo 100 atendentes.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListAgents_RequestSyntax) **   <a name="DataSync-ListAgents-request-NextToken"></a>
Especifica uma string opaca que indica a posição para começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+`   
Obrigatório: Não

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

```
{
   "Agents": [ 
      { 
         "AgentArn": "string",
         "Name": "string",
         "Platform": { 
            "Version": "string"
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListAgents_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.

 ** [Agents](#API_ListAgents_ResponseSyntax) **   <a name="DataSync-ListAgents-response-Agents"></a>
Uma lista de DataSync agentes Conta da AWS em sua área Região da AWS especificada na solicitação. A lista é ordenada pelos nomes de recursos da Amazon dos agentes (ARNs).  
Tipo: matriz de objetos [AgentListEntry](API_AgentListEntry.md)

 ** [NextToken](#API_ListAgents_ResponseSyntax) **   <a name="DataSync-ListAgents-response-NextToken"></a>
Uma string opaca que indica a posição para começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# ListLocations
<a name="API_ListLocations"></a>

Retorna uma lista de pontos de origem e de destino.

Se você tiver mais locais do que os retornados em uma resposta (ou seja, a resposta retornará apenas uma lista truncada de seus agentes), a resposta conterá um token que você pode especificar em sua próxima solicitação para buscar a próxima página de locais.

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

```
{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

 ** [Filters](#API_ListLocations_RequestSyntax) **   <a name="DataSync-ListLocations-request-Filters"></a>
Você pode usar filtros de API para refinar a lista de recursos retornados por `ListLocations`. Por exemplo, para recuperar todas as tarefas em um local de origem específico, você pode usar `ListLocations` com o nome do filtro `LocationType S3` e `Operator Equals`.  
Tipo: matriz de objetos [LocationFilter](API_LocationFilter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListLocations_RequestSyntax) **   <a name="DataSync-ListLocations-request-MaxResults"></a>
O número máximo de localizações a serem retornadas.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListLocations_RequestSyntax) **   <a name="DataSync-ListLocations-request-NextToken"></a>
Uma sequência opaca que indica a posição na qual começar a próxima lista de locais.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+`   
Obrigatório: Não

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

```
{
   "Locations": [ 
      { 
         "LocationArn": "string",
         "LocationUri": "string"
      }
   ],
   "NextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListLocations_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.

 ** [Locations](#API_ListLocations_ResponseSyntax) **   <a name="DataSync-ListLocations-response-Locations"></a>
Uma matriz que contém uma lista de locais.  
Tipo: matriz de objetos [LocationListEntry](API_LocationListEntry.md)

 ** [NextToken](#API_ListLocations_ResponseSyntax) **   <a name="DataSync-ListLocations-response-NextToken"></a>
Uma sequência opaca que indica a posição na qual começar a retornar a próxima lista de locais.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Retorna todas as tags associadas a um AWS recurso.

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

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceArn": "string"
}
```

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

 ** [MaxResults](#API_ListTagsForResource_RequestSyntax) **   <a name="DataSync-ListTagsForResource-request-MaxResults"></a>
Especifica quantos resultados você deseja na resposta.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="DataSync-ListTagsForResource-request-NextToken"></a>
Especifica uma string opaca que indica a posição para começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+`   
Obrigatório: não

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="DataSync-ListTagsForResource-request-ResourceArn"></a>
Especifica o nome do recurso da Amazon (ARN) do recurso sobre o qual você deseja obter informações de tag.  
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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`   
Obrigatório: sim

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

```
{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListTagsForResource_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.

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="DataSync-ListTagsForResource-response-NextToken"></a>
Uma string opaca que indica a posição para começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+` 

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="DataSync-ListTagsForResource-response-Tags"></a>
Uma matriz de tags aplicadas ao recurso especificado.  
Tipo: matriz de objetos [TagListEntry](API_TagListEntry.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 55 itens.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# ListTaskExecutions
<a name="API_ListTaskExecutions"></a>

Retorna uma lista de execuções para uma tarefa AWS DataSync de transferência.

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

```
{
   "MaxResults": number,
   "NextToken": "string",
   "TaskArn": "string"
}
```

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

 ** [MaxResults](#API_ListTaskExecutions_RequestSyntax) **   <a name="DataSync-ListTaskExecutions-request-MaxResults"></a>
Especifica quantos resultados você deseja na resposta.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListTaskExecutions_RequestSyntax) **   <a name="DataSync-ListTaskExecutions-request-NextToken"></a>
Especifica uma string opaca que indica a posição na qual começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+`   
Obrigatório: não

 ** [TaskArn](#API_ListTaskExecutions_RequestSyntax) **   <a name="DataSync-ListTaskExecutions-request-TaskArn"></a>
Especifica o nome do recurso da Amazon (ARN) da tarefa sobre cuja execução você deseja 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}:task/task-[0-9a-f]{17}$`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "TaskExecutions": [ 
      { 
         "Status": "string",
         "TaskExecutionArn": "string",
         "TaskMode": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListTaskExecutions_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.

 ** [NextToken](#API_ListTaskExecutions_ResponseSyntax) **   <a name="DataSync-ListTaskExecutions-response-NextToken"></a>
Uma string opaca que indica a posição para começar a próxima lista de resultados na resposta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+` 

 ** [TaskExecutions](#API_ListTaskExecutions_ResponseSyntax) **   <a name="DataSync-ListTaskExecutions-response-TaskExecutions"></a>
Uma lista de execuções da tarefa.  
Tipo: matriz de objetos [TaskExecutionListEntry](API_TaskExecutionListEntry.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# ListTasks
<a name="API_ListTasks"></a>

Retorna uma lista das AWS DataSync tarefas que você criou.

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

```
{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

 ** [Filters](#API_ListTasks_RequestSyntax) **   <a name="DataSync-ListTasks-request-Filters"></a>
Você pode usar filtros de API para refinar a lista de recursos retornados por `ListTasks`. Por exemplo, para recuperar todas as tarefas em um local de origem específico, você pode usar `ListTasks` com o nome do filtro `LocationId` e `Operator Equals` com o ARN do local.  
Tipo: matriz de objetos [TaskFilter](API_TaskFilter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListTasks_RequestSyntax) **   <a name="DataSync-ListTasks-request-MaxResults"></a>
O número máximo de tarefas a serem retornadas.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListTasks_RequestSyntax) **   <a name="DataSync-ListTasks-request-NextToken"></a>
Um string opaco que indica a posição de onde começar a próxima lista de locais.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "Tasks": [ 
      { 
         "Name": "string",
         "Status": "string",
         "TaskArn": "string",
         "TaskMode": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_ListTasks_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.

 ** [NextToken](#API_ListTasks_ResponseSyntax) **   <a name="DataSync-ListTasks-response-NextToken"></a>
Um string opaco que indica a posição de onde começar a próxima lista de locais.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 65535.  
Padrão: `[a-zA-Z0-9=_-]+` 

 ** [Tasks](#API_ListTasks_ResponseSyntax) **   <a name="DataSync-ListTasks-response-Tasks"></a>
Uma lista de todas as tarefas que são retornadas.  
Tipo: matriz de objetos [TaskListEntry](API_TaskListEntry.md)

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# StartTaskExecution
<a name="API_StartTaskExecution"></a>

Inicia uma tarefa AWS DataSync de transferência. Para cada tarefa, você só pode executar uma tarefa por vez.

Há várias etapas na execução de uma tarefa. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses).

**Importante**  
Se você planeja transferir dados de ou para um local do Amazon S3, analise [como isso DataSync pode afetar as cobranças de suas solicitações do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) e a [página de DataSync preços](https://aws.amazon.com/datasync/pricing/) antes de começar.

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

```
{
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "OverrideOptions": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskArn": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}
```

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

 ** [Excludes](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-Excludes"></a>
Especifica uma lista de regras de filtro que determina quais arquivos excluir de uma tarefa. A lista contém uma única string de filtro que consiste nos padrões a serem excluídos. Os padrões são delimitados por “\$1” (isto é, um tubo), por exemplo, `"/folder1|/folder2"`.   
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [Includes](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-Includes"></a>
Especifica uma lista de regras de filtro que determina quais arquivos incluir ao executar uma tarefa. O padrão deverá conter uma única string de filtro que consiste nos padrões a serem incluídos. Os padrões são delimitados por “\$1” (isto é, um tubo), por exemplo, `"/folder1|/folder2"`.   
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [ManifestConfig](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-ManifestConfig"></a>
Configura um manifesto, que é uma lista de arquivos ou objetos que você deseja DataSync transferir. Para obter mais informações e exemplos de configuração, consulte [Especificação do que é DataSync transferido usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Para remover uma configuração de manifesto, especifique esse parâmetro com um valor vazio.  
Tipo: objeto [ManifestConfig](API_ManifestConfig.md)  
Obrigatório: não

 ** [OverrideOptions](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-OverrideOptions"></a>
Indica como sua tarefa de transferência está configurada. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados durante a transferência. Você também pode especificar como verificar a integridade dos dados, definir limites de largura de banda para sua tarefa, entre outras opções.  
Cada opção tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhuma opção antes de ligar [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).  
Você também pode substituir suas opções de tarefa para cada execução de tarefa. Por exemplo, pode ser bom ajustar o `LogLevel` para uma execução individual.  
Tipo: objeto [Options](API_Options.md)  
Obrigatório: não

 ** [Tags](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-Tags"></a>
Especifica as tags que você deseja aplicar ao nome do recurso da Amazon (ARN) que representa a execução da tarefa.  
 As *tags* são pares de valores-chave que ajudam você a gerenciar, filtrar e pesquisar seus DataSync recursos.  
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

 ** [TaskArn](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-TaskArn"></a>
Especifica o nome do recurso da Amazon (ARN) da tarefa que você deseja iniciar.  
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}:task/task-[0-9a-f]{17}$`   
Obrigatório: Sim

 ** [TaskReportConfig](#API_StartTaskExecution_RequestSyntax) **   <a name="DataSync-StartTaskExecution-request-TaskReportConfig"></a>
Especifica como você deseja configurar um relatório de tarefas, que fornece informações detalhadas sobre sua DataSync transferência. Para obter mais informações, consulte [Monitorando suas DataSync transferências com relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Para remover uma configuração de relatório de tarefa, especifique esse parâmetro como vazio.  
Tipo: objeto [TaskReportConfig](API_TaskReportConfig.md)  
Obrigatório: não

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

```
{
   "TaskExecutionArn": "string"
}
```

## Elementos de resposta
<a name="API_StartTaskExecution_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.

 ** [TaskExecutionArn](#API_StartTaskExecution_ResponseSyntax) **   <a name="DataSync-StartTaskExecution-response-TaskExecutionArn"></a>
O ARN da execução da tarefa em execução.  
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$` 

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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_StartTaskExecution_Examples"></a>

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

O exemplo a seguir inicia a execução de uma tarefa usando as opções padrão para a tarefa especificada.

```
{
    "OverrideOptions": {
        "Atime": "BEST_EFFORT",
        "BytesPerSecond": 1000,
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}
```

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

Este exemplo ilustra um uso do. StartTaskExecution

```
{
  "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}
```

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

# TagResource
<a name="API_TagResource"></a>

Aplica uma *tag* a um AWS recurso. Tags são pares chave-valor que podem ajudar você a gerenciar, filtrar e pesquisar recursos.

Isso inclui AWS DataSync recursos, como locais, tarefas e execuções de tarefas.

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

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="DataSync-TagResource-request-ResourceArn"></a>
Especifica o nome do recurso da Amazon (ARN) do recurso ao qual aplicar a tag.  
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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`   
Obrigatório: Sim

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="DataSync-TagResource-request-Tags"></a>
Especifique as tags que você quer aplicar ao recurso.  
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: Sim

## Elementos de resposta
<a name="API_TagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UntagResource
<a name="API_UntagResource"></a>

Remove as tags de um AWS recurso.

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

```
{
   "Keys": [ "string" ],
   "ResourceArn": "string"
}
```

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

 ** [Keys](#API_UntagResource_RequestSyntax) **   <a name="DataSync-UntagResource-request-Keys"></a>
Especifica as chaves nas tags que você deseja remover.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 50 itens.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^[a-zA-Z0-9\s+=._:/-]+$`   
Obrigatório: Sim

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="DataSync-UntagResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso do qual remover as tags.  
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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_UntagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UntagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UntagResource) 

# UpdateAgent
<a name="API_UpdateAgent"></a>

Atualiza o nome de um AWS DataSync agente.

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

```
{
   "AgentArn": "string",
   "Name": "string"
}
```

## Parâmetros da solicitação
<a name="API_UpdateAgent_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_UpdateAgent_RequestSyntax) **   <a name="DataSync-UpdateAgent-request-AgentArn"></a>
O nome do recurso da Amazon (ARN) do atendente para ser atualizado.  
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

 ** [Name](#API_UpdateAgent_RequestSyntax) **   <a name="DataSync-UpdateAgent-request-Name"></a>
Escolha o nome que você deseja usar para configurar o atendente.  
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

## Elementos de resposta
<a name="API_UpdateAgent_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationAzureBlob
<a name="API_UpdateLocationAzureBlob"></a>

Modifica as seguintes configurações do local de transferência do Microsoft Azure Blob Storage com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com o Azure Blob Storage.](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html)

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

```
{
   "AccessTier": "string",
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlobType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "LocationArn": "string",
   "SasConfiguration": { 
      "Token": "string"
   },
   "Subdirectory": "string"
}
```

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

 ** [AccessTier](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-AccessTier"></a>
Especifica o nível de acesso para o qual deseja que seus objetos ou arquivos sejam transferidos. Isso só se aplica ao usar o local como destino de transferência. Para obter mais informações, consulte [Níveis de acesso](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers).  
Tipo: String  
Valores válidos: `HOT | COOL | ARCHIVE`   
Obrigatório: não

 ** [AgentArns](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-AgentArns"></a>
(Opcional) Especifica o Amazon Resource Name (ARN) do agente que pode se conectar DataSync ao seu contêiner do Azure Blob Storage. Se você estiver configurando uma transferência entre nuvens sem atendente, não precisará especificar um valor para esse parâmetro.  
Você pode especificar mais de um atendente. Para obter mais informações, consulte [Utilizar vários agentes para sua transferência](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html).  
Você não pode adicionar ou remover atendentes de um local de armazenamento depois de criá-lo inicialmente.
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [AuthenticationType](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-AuthenticationType"></a>
Especifica o método de autenticação DataSync usado para acessar seu Armazenamento de Blobs do Azure. DataSync pode acessar o armazenamento de blobs usando uma assinatura de acesso compartilhado (SAS).  
Tipo: string  
Valores válidos: `SAS | NONE`   
Obrigatório: Não

 ** [BlobType](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-BlobType"></a>
Especifica o tipo de blob que você deseja que seus objetos ou arquivos sejam ao transferi-los para o Armazenamento de Blobs do Azure. Atualmente, DataSync só dá suporte à movimentação de dados para o Armazenamento de Blobs do Azure como blobs de blocos. Para obter mais informações sobre os tipos de blob, consulte a [Documentação do armazenamento de blobs do Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs).  
Tipo: String  
Valores válidos: `BLOCK`   
Obrigatório: não

 ** [CmkSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-LocationArn"></a>
Especifica o ARN do local de transferência do Armazenamento de Blobs do Azure que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [SasConfiguration](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-SasConfiguration"></a>
Especifica a configuração SAS que permite acessar seu DataSync Armazenamento de Blobs do Azure.  
Tipo: objeto [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md)  
Obrigatório: Não

 ** [Subdirectory](#API_UpdateLocationAzureBlob_RequestSyntax) **   <a name="DataSync-UpdateLocationAzureBlob-request-Subdirectory"></a>
Especifica segmentos de caminho se você quiser limitar a transferência para um diretório virtual no contêiner (por exemplo, `/my/images`).  
Tipo: String  
Restrições de comprimento: comprimento máximo de 1024.  
Padrão: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationAzureBlob_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationAzureBlob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationAzureBlob) 

# UpdateLocationEfs
<a name="API_UpdateLocationEfs"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon EFS com AWS DataSync o qual você está usando.

Para obter mais informações, consulte [Configuração de DataSync transferências com o Amazon EFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html).

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

```
{
   "AccessPointArn": "string",
   "FileSystemAccessRoleArn": "string",
   "InTransitEncryption": "string",
   "LocationArn": "string",
   "Subdirectory": "string"
}
```

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

 ** [AccessPointArn](#API_UpdateLocationEfs_RequestSyntax) **   <a name="DataSync-UpdateLocationEfs-request-AccessPointArn"></a>
Especifica o Amazon Resource Name (ARN) do ponto DataSync de acesso usado para montar seu sistema de arquivos Amazon EFS.  
Para obter mais informações, consulte [Acesso a sistemas de arquivos Amazon EFS restritos](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam).  
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):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$)|(^$)`   
Obrigatório: não

 ** [FileSystemAccessRoleArn](#API_UpdateLocationEfs_RequestSyntax) **   <a name="DataSync-UpdateLocationEfs-request-FileSystemAccessRoleArn"></a>
Especifica uma função AWS Identity and Access Management (IAM) que permite DataSync acessar seu sistema de arquivos Amazon EFS.  
Para obter informações sobre a criação dessa função, consulte [Criação de uma função DataSync do IAM para acesso ao sistema de arquivos do Amazon EFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `(^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$)|(^$)`   
Obrigatório: não

 ** [InTransitEncryption](#API_UpdateLocationEfs_RequestSyntax) **   <a name="DataSync-UpdateLocationEfs-request-InTransitEncryption"></a>
Especifica se você deseja usar DataSync a criptografia Transport Layer Security (TLS) 1.2 ao transferir dados para ou do seu sistema de arquivos Amazon EFS.  
Se você especificar um ponto de acesso usando `AccessPointArn` ou um perfil do IAM usando `FileSystemAccessRoleArn`, deverá definir esse parâmetro como `TLS1_2`.  
Tipo: string  
Valores válidos: `NONE | TLS1_2`   
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationEfs_RequestSyntax) **   <a name="DataSync-UpdateLocationEfs-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local de transferência do Amazon EFS que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Subdirectory](#API_UpdateLocationEfs_RequestSyntax) **   <a name="DataSync-UpdateLocationEfs-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos do Amazon EFS. É aqui que DataSync lê ou grava dados em seu sistema de arquivos (dependendo se esse é um local de origem ou destino).  
Por padrão, DataSync usa o diretório raiz (ou [ponto de acesso](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html), se você fornecer um usando`AccessPointArn`). Você também pode incluir subdiretórios usando barras (por exemplo, `/path/to/folder`).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationEfs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationFsxLustre
<a name="API_UpdateLocationFsxLustre"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon FSx for Lustre com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com o FSx for Lustre](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html).

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

```
{
   "LocationArn": "string",
   "Subdirectory": "string"
}
```

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

 ** [LocationArn](#API_UpdateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxLustre-request-LocationArn"></a>
Especifica o Amazon Resource Name (ARN) do local de transferência FSx do Lustre que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Subdirectory](#API_UpdateLocationFsxLustre_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxLustre-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos FSx for Lustre. O caminho pode incluir subdiretórios.  
Quando o local é usado como fonte, DataSync lê os dados do caminho de montagem. Quando o local é usado como destino, DataSync grava dados no caminho de montagem. Se você não incluir esse parâmetro, DataSync usa o diretório raiz do sistema de arquivos (`/`).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationFsxLustre_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationFsxOntap
<a name="API_UpdateLocationFsxOntap"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon FSx for NetApp ONTAP com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com o FSx for ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html).

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

```
{
   "LocationArn": "string",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "Subdirectory": "string"
}
```

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

 ** [LocationArn](#API_UpdateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOntap-request-LocationArn"></a>
Especifica o Amazon Resource Name (ARN) do local de FSx transferência para ONTAP que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Protocol](#API_UpdateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOntap-request-Protocol"></a>
Especifica o protocolo de transferência de dados DataSync usado para acessar seu sistema de FSx arquivos da Amazon.  
Tipo: objeto [FsxUpdateProtocol](API_FsxUpdateProtocol.md)  
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationFsxOntap_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOntap-request-Subdirectory"></a>
Especifica um caminho para o compartilhamento de arquivos na máquina virtual de armazenamento (SVM) de/para o qual você deseja transferir dados.  
Você pode especificar um caminho de união (também conhecido como ponto de montagem), caminho qtree (para compartilhamentos de arquivos NFS) ou nome de compartilhamento (para compartilhamentos de arquivos SMB). Por exemplo, seu caminho de montagem pode ser `/vol1`, `/vol1/tree1` ou `/share1`.  
Não especifique um caminho de junção no volume raiz do SVM. Para obter mais informações, consulte [Gerenciamento FSx de máquinas virtuais de armazenamento ONTAP no Guia](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) do *usuário do Amazon FSx for NetApp ONTAP*.
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationFsxOntap_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationFsxOpenZfs
<a name="API_UpdateLocationFsxOpenZfs"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon FSx for OpenZFS com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com FSx para OpenZFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html).

**nota**  
Os parâmetros de solicitação relacionados a `SMB` não são compatíveis com a operação `UpdateLocationFsxOpenZfs`.

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

```
{
   "LocationArn": "string",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "string"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "string",
            "SecretArn": "string"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "string",
            "SecretArn": "string"
         },
         "Domain": "string",
         "ManagedSecretConfig": { 
            "SecretArn": "string"
         },
         "MountOptions": { 
            "Version": "string"
         },
         "Password": "string",
         "User": "string"
      }
   },
   "Subdirectory": "string"
}
```

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

 ** [LocationArn](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOpenZfs-request-LocationArn"></a>
Especifica o Amazon Resource Name (ARN) do local de FSx transferência para OpenZFS que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Protocol](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOpenZfs-request-Protocol"></a>
Especifica o protocolo de transferência de dados AWS DataSync usado para acessar seu sistema de FSx arquivos da Amazon.  
Tipo: objeto [FsxProtocol](API_FsxProtocol.md)  
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxOpenZfs-request-Subdirectory"></a>
Especifica um subdiretório no caminho do local que deve começar com. `/fsx` DataSync usa esse subdiretório para ler ou gravar dados (dependendo se o sistema de arquivos é um local de origem ou destino).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationFsxOpenZfs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationFsxWindows
<a name="API_UpdateLocationFsxWindows"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon FSx para Windows File Server com AWS DataSync o qual você está usando.

Para obter mais informações, consulte [Configurando DataSync transferências com o FSx Windows File Server](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html).

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

```
{
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "Domain": "string",
   "LocationArn": "string",
   "Password": "string",
   "Subdirectory": "string",
   "User": "string"
}
```

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

 ** [CmkSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um `Password` ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um `Password` conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [Domain](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-Domain"></a>
Especifica o nome do domínio do Windows ao qual seu sistema FSx de arquivos do Windows File Server pertence.  
Se você tiver vários domínios do Active Directory em seu ambiente, a configuração desse parâmetro garante que ele DataSync se conecte ao sistema de arquivos correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$`   
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-LocationArn"></a>
Especifica o ARN do local de transferência FSx do Windows File Server que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [Password](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-Password"></a>
Especifica a senha do usuário com as permissões para montar e acessar os arquivos, pastas e metadados de arquivos no seu FSx sistema de arquivos do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-Subdirectory"></a>
Especifica um caminho de montagem para seu sistema de arquivos usando barras. DataSync usa esse subdiretório para ler ou gravar dados (dependendo se o sistema de arquivos é um local de origem ou destino).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: não

 ** [User](#API_UpdateLocationFsxWindows_RequestSyntax) **   <a name="DataSync-UpdateLocationFsxWindows-request-User"></a>
Especifica o usuário com as permissões para montar e acessar os arquivos, pastas e metadados de arquivos no seu FSx sistema de arquivos do Windows File Server.  
Para obter informações sobre como escolher um usuário com o nível certo de acesso para sua transferência, consulte [as permissões necessárias](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) FSx para locais do Windows File Server.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationFsxWindows_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationHdfs
<a name="API_UpdateLocationHdfs"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Hadoop Distributed File System (HDFS) com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com um cluster HDFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html).

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "BlockSize": number,
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "KmsKeyProviderUri": "string",
   "LocationArn": "string",
   "NameNodes": [ 
      { 
         "Hostname": "string",
         "Port": number
      }
   ],
   "QopConfiguration": { 
      "DataTransferProtection": "string",
      "RpcProtection": "string"
   },
   "ReplicationFactor": number,
   "SimpleUser": "string",
   "Subdirectory": "string"
}
```

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

 ** [AgentArns](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-AgentArns"></a>
Os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu cluster HDFS.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [AuthenticationType](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-AuthenticationType"></a>
O tipo de autenticação usado para determinar a identidade do usuário.   
Tipo: string  
Valores válidos: `SIMPLE | KERBEROS`   
Obrigatório: não

 ** [BlockSize](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-BlockSize"></a>
O tamanho dos blocos de dados a serem gravados no cluster do HDFS.   
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.048.576. Valor máximo de 1.073.741.824  
Obrigatório: não

 ** [CmkSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um `KerberosKeytab` ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um `KerberosKeytab` conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [KerberosKeytab](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-KerberosKeytab"></a>
A tabela de chaves Kerberos (keytab) que contém mapeamentos entre a entidade principal Kerberos definida e as chaves criptografadas. Você pode carregar o keytab de um arquivo fornecendo o endereço do arquivo.  
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 65536.  
Obrigatório: não

 ** [KerberosKrb5Conf](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-KerberosKrb5Conf"></a>
O arquivo `krb5.conf` que contém as informações de configuração do Kerberos. Você pode carregar o arquivo `krb5.conf` fornecendo o endereço do arquivo. Se você estiver usando o AWS CLI, ele executa a codificação base64 para você. Caso contrário, você deve fornecer o texto codificado em base64.  
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 131.072.  
Obrigatório: não

 ** [KerberosPrincipal](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-KerberosPrincipal"></a>
A entidade principal do Kerberos com acesso aos arquivos e pastas no cluster do HDFS.   
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$`   
Obrigatório: não

 ** [KmsKeyProviderUri](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-KmsKeyProviderUri"></a>
O URI do Key Management Server (KMS) do cluster do HDFS.   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$`   
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-LocationArn"></a>
O nome do recurso da Amazon (ARN) do local do cluster do HDFS de origem.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [NameNodes](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-NameNodes"></a>
O NameNode que gerencia o namespace HDFS. O NameNode executa operações como abrir, fechar e renomear arquivos e diretórios. O NameNode contém as informações para mapear blocos de dados para DataNodes o. Você pode usar apenas um NameNode.  
Tipo: matriz de objetos [HdfsNameNode](API_HdfsNameNode.md)  
Membros da matriz: número mínimo de 1 item.  
Obrigatório: não

 ** [QopConfiguration](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-QopConfiguration"></a>
A configuração da Qualidade da Proteção (QOP) especifica as configurações de privacidade da Chamada de Procedimento Remoto (RPC) e da transferência de dados definidas no cluster do Sistema de Arquivos Distribuído do Hadoop (HDFS).   
Tipo: objeto [QopConfiguration](API_QopConfiguration.md)  
Obrigatório: não

 ** [ReplicationFactor](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-ReplicationFactor"></a>
O número de DataNodes para os quais replicar os dados ao gravar no cluster HDFS.   
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 512.  
Obrigatório: não

 ** [SimpleUser](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-SimpleUser"></a>
O nome de usuário utilizado para identificar o cliente no sistema operacional host.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationHdfs_RequestSyntax) **   <a name="DataSync-UpdateLocationHdfs-request-Subdirectory"></a>
Um subdiretório no cluster do HDFS. Esse subdiretório é utilizado para ler ou gravar dados no cluster do HDFS.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationHdfs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationNfs
<a name="API_UpdateLocationNfs"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Sistema de Arquivos de Rede (NFS) com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Como configurar transferências com um servidor de arquivos do NFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html).

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

```
{
   "LocationArn": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "OnPremConfig": { 
      "AgentArns": [ "string" ]
   },
   "ServerHostname": "string",
   "Subdirectory": "string"
}
```

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

 ** [LocationArn](#API_UpdateLocationNfs_RequestSyntax) **   <a name="DataSync-UpdateLocationNfs-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local de transferência do NFS que deseja atualizar.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [MountOptions](#API_UpdateLocationNfs_RequestSyntax) **   <a name="DataSync-UpdateLocationNfs-request-MountOptions"></a>
Especifica como DataSync acessar um local usando o protocolo NFS.  
Tipo: objeto [NfsMountOptions](API_NfsMountOptions.md)  
Obrigatório: não

 ** [OnPremConfig](#API_UpdateLocationNfs_RequestSyntax) **   <a name="DataSync-UpdateLocationNfs-request-OnPremConfig"></a>
Os AWS DataSync agentes que podem se conectar ao seu servidor de arquivos do Sistema de Arquivos de Rede (NFS).  
Tipo: objeto [OnPremConfig](API_OnPremConfig.md)  
Obrigatório: não

 ** [ServerHostname](#API_UpdateLocationNfs_RequestSyntax) **   <a name="DataSync-UpdateLocationNfs-request-ServerHostname"></a>
Especifica o nome DNS ou endereço IP (IPv4 ou IPv6) do servidor de arquivos NFS ao qual seu DataSync agente se conecta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationNfs_RequestSyntax) **   <a name="DataSync-UpdateLocationNfs-request-Subdirectory"></a>
Especifica o caminho de exportação no servidor de arquivos NFS que você deseja DataSync montar.  
Esse caminho (ou um subdiretório do caminho) é onde os dados são DataSync transferidos de ou para. Para obter informações sobre como configurar uma exportação para DataSync, consulte [Acessando servidores de arquivos NFS](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationNfs_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationObjectStorage
<a name="API_UpdateLocationObjectStorage"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do armazenamento de objetos com AWS DataSync o qual você está usando.

Para obter mais informações, consulte [Configurando DataSync transferências com um sistema de armazenamento de objetos](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

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

```
{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "LocationArn": "string",
   "SecretKey": "string",
   "ServerCertificate": blob,
   "ServerHostname": "string",
   "ServerPort": number,
   "ServerProtocol": "string",
   "Subdirectory": "string"
}
```

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

 ** [AccessKey](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-AccessKey"></a>
Especifica a chave de acesso (por exemplo, um nome de usuário) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Padrão: `^.*$`   
Obrigatório: não

 ** [AgentArns](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-AgentArns"></a>
(Opcional) Especifica os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu sistema de armazenamento de objetos. Se você estiver configurando uma transferência entre nuvens sem atendente, não precisará especificar um valor para esse parâmetro.  
Você não pode adicionar ou remover atendentes de um local de armazenamento depois de criá-lo inicialmente.
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [CmkSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um token de autenticação ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-LocationArn"></a>
Especifica o ARN do local do sistema de armazenamento de objetos que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [SecretKey](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-SecretKey"></a>
Especifica a chave secreta (por exemplo, uma senha) se as credenciais forem necessárias para autenticação no servidor de armazenamento de objetos.  
Se você fornecer um segredo usando`SecretKey`, mas não fornecer detalhes de configuração secreta usando `CmkSecretConfig` ou`CustomSecretConfig`, então DataSync armazena o token usando o segredo do Secrets Manager da sua AWS conta.
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.  
Padrão: `^.*$`   
Obrigatório: não

 ** [ServerCertificate](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-ServerCertificate"></a>
Especifica uma cadeia de certificados DataSync para autenticação em seu sistema de armazenamento de objetos se o sistema usar uma autoridade de certificação (CA) privada ou autoassinada. Você deve especificar um único arquivo `.pem` com uma cadeia de certificados completa (por exemplo, `file:///home/user/.ssh/object_storage_certificates.pem`).  
A cadeia de certificados pode incluir:  
+ O certificado do sistema de armazenamento de objetos
+ Todos os certificados intermediários (se for o caso)
+ O certificado-raiz da CA assinante
Você pode concatenar os certificados em um arquivo `.pem` (que pode ter até 32.768 bytes antes da codificação base64). O exemplo de comando `cat` a seguir cria um arquivo `object_storage_certificates.pem` que inclui três certificados:  
 `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`   
Para usar esse parâmetro, configure `ServerProtocol` para `HTTPS`.  
A atualização desse parâmetro não interfere nas tarefas que estão em andamento.  
Tipo: Objeto de dados binários codificado em Base64  
Restrições de tamanho: tamanho máximo de 32768.  
Obrigatório: não

 ** [ServerHostname](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-ServerHostname"></a>
Especifica o nome de domínio ou endereço IP (IPv4 ou IPv6) do servidor de armazenamento de objetos ao qual seu DataSync agente se conecta.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: não

 ** [ServerPort](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-ServerPort"></a>
Especifica a porta em que o servidor de armazenamento de objetos aceita o tráfego de rede de entrada (por exemplo, a porta 443).  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 65536.  
Obrigatório: não

 ** [ServerProtocol](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-ServerProtocol"></a>
Especifica o protocolo que o servidor de armazenamento de objetos utiliza para se comunicar.  
Tipo: string  
Valores válidos: `HTTPS | HTTP`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationObjectStorage_RequestSyntax) **   <a name="DataSync-UpdateLocationObjectStorage-request-Subdirectory"></a>
Especifica o prefixo de objeto do servidor de armazenamento de objetos. Se esse for um local de origem, DataSync copiará somente objetos com esse prefixo. Se for um local de destino, DataSync grava todos os objetos com esse prefixo.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationObjectStorage_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationObjectStorage) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationObjectStorage) 

# UpdateLocationS3
<a name="API_UpdateLocationS3"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Amazon S3 com o qual você está usando. AWS DataSync

**Importante**  
Antes de começar, não deixe de ler os seguintes tópicos:  
 [Considerações sobre a classe de armazenamento com locais do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) 
 [Avaliando os custos de solicitação do S3 ao usar DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) 

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

```
{
   "LocationArn": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "string",
   "Subdirectory": "string"
}
```

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

 ** [LocationArn](#API_UpdateLocationS3_RequestSyntax) **   <a name="DataSync-UpdateLocationS3-request-LocationArn"></a>
Especifica o nome do recurso da Amazon (ARN) do local de transferência do Amazon S3 que você está atualizando.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [S3Config](#API_UpdateLocationS3_RequestSyntax) **   <a name="DataSync-UpdateLocationS3-request-S3Config"></a>
Especifica o Amazon Resource Name (ARN) AWS Identity and Access Management da função DataSync (IAM) usada para acessar seu bucket do S3.  
Para obter mais informações, consulte [Fornecendo DataSync acesso aos buckets do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).  
Tipo: objeto [S3Config](API_S3Config.md)  
Obrigatório: não

 ** [S3StorageClass](#API_UpdateLocationS3_RequestSyntax) **   <a name="DataSync-UpdateLocationS3-request-S3StorageClass"></a>
Especifica a classe de armazenamento que você deseja que seus objetos usem quando o Amazon S3 for um destino de transferência.  
Para buckets em Regiões da AWS, o padrão da classe de armazenamento é. `STANDARD` Para buckets ativados AWS Outposts, o padrão da classe de armazenamento é. `OUTPOSTS`  
Para obter mais informações, consulte [Considerações sobre classes de armazenamento com transferências do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).  
Tipo: string  
Valores válidos: `STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationS3_RequestSyntax) **   <a name="DataSync-UpdateLocationS3-request-Subdirectory"></a>
Especifica um prefixo no bucket do S3 que DataSync lê ou grava (dependendo se o bucket é um local de origem ou destino).  
DataSync não é possível transferir objetos com um prefixo que comece com uma barra (`/`) ou inclua `//``/./`, ou `/../` padrões. Por exemplo:  
+  `/photos` 
+  `photos//2006/January` 
+  `photos/./2006/February` 
+  `photos/../2006/March` 
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationS3_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateLocationSmb
<a name="API_UpdateLocationSmb"></a>

Modifica os seguintes parâmetros de configuração do local de transferência do Server Message Block (SMB) com o qual você está usando. AWS DataSync

Para obter mais informações, consulte [Configurando DataSync transferências com um servidor de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html).

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "LocationArn": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "User": "string"
}
```

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

 ** [AgentArns](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-AgentArns"></a>
Especifica o DataSync agente (ou agentes) que podem se conectar ao seu servidor de arquivos SMB. Você especifica um agente usando seu nome do recurso da Amazon (ARN).  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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: não

 ** [AuthenticationType](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-AuthenticationType"></a>
Especifica o protocolo de autenticação DataSync usado para se conectar ao seu servidor de arquivos SMB. DataSync suporte `NTLM` (padrão) e `KERBEROS` autenticação.  
Para obter mais informações, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Valores válidos: `NTLM | KERBEROS`   
Obrigatório: não

 ** [CmkSecretConfig](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um `Password` ou `KerberosKeytab` ou um conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** [CustomSecretConfig](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um `Password` ou `KerberosKeytab` ou um conjunto de credenciais DataSync usado para acessar um local de transferência específico e uma função gerenciada pelo cliente AWS Identity and Access Management (IAM) que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** [DnsIpAddresses](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-DnsIpAddresses"></a>
Especifica os endereços IP (IPv4 ou IPv6) dos servidores DNS aos quais seu servidor de arquivos SMB pertence. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `KERBEROS`.  
Se você tiver vários domínios em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao servidor de arquivos SMB correto.   
Tipo: matriz de strings  
Membros da matriz: número máximo de 2 itens.  
Restrições de comprimento: comprimento mínimo de 7. Comprimento máximo de 39.  
Padrão: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`   
Obrigatório: não

 ** [Domain](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-Domain"></a>
Especifica o nome de domínio do Windows ao qual o servidor de arquivos SMB pertence. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Se você tiver vários domínios em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao servidor de arquivos correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`   
Obrigatório: não

 ** [KerberosKeytab](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-KerberosKeytab"></a>
Especifica o arquivo da tabela de chaves Kerberos (keytab), que inclui mapeamentos entre a entidade principal Kerberos e as chaves de criptografia.  
Para evitar erros de execução de tarefas, confira se a entidade principal Kerberos usada para criar o arquivo keytab corresponde exatamente ao que você especificou para `KerberosPrincipal`.  
Tipo: objeto de dados binários codificado pelo Base64  
Restrições de tamanho: tamanho máximo de 65536.  
Obrigatório: não

 ** [KerberosKrb5Conf](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-KerberosKrb5Conf"></a>
Especifica um arquivo de configuração Kerberos (`krb5.conf`) que define a configuração do realm Kerberos.  
O arquivo deve ser codificado em base64. Se você estiver usando o AWS CLI, a codificação é feita para você.  
Tipo: Objeto de dados binários codificado em Base64  
Restrições de tamanho: tamanho máximo de 131.072.  
Obrigatório: não

 ** [KerberosPrincipal](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-KerberosPrincipal"></a>
Especifica uma entidade principal Kerberos, que é uma identidade no realm Kerberos com permissão para acessar os arquivos, pastas e metadados de arquivos no servidor de arquivos SMB.  
Uma entidade principal Kerberos pode ter a aparência de `HOST/kerberosuser@MYDOMAIN.ORG`.  
Os nomes de entidade principal diferenciam letras maiúsculas de minúsculas A execução da DataSync tarefa falhará se o principal que você especificar para esse parâmetro não corresponder exatamente ao principal usado para criar o arquivo keytab.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `^.+$`   
Obrigatório: não

 ** [LocationArn](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-LocationArn"></a>
Especifica o ARN do local do SMB que você deseja atualizar.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: Sim

 ** [MountOptions](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-MountOptions"></a>
Especifica a versão do protocolo Server Message Block (SMB) AWS DataSync usada para acessar um servidor de arquivos SMB.  
Tipo: objeto [SmbMountOptions](API_SmbMountOptions.md)  
Obrigatório: não

 ** [Password](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-Password"></a>
Especifica a senha do usuário que pode montar o servidor de arquivos SMB e tenha permissão para acessar os arquivos e pastas envolvidos na sua transferência. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: não

 ** [ServerHostname](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-ServerHostname"></a>
Especifica o nome de domínio ou endereço IP (IPv4 ou IPv6) do servidor de arquivos SMB ao qual seu DataSync agente se conecta.  
Se você estiver usando a autenticação Kerberos, deverá especificar um nome de domínio.
Tipo: string  
Restrições de tamanho: tamanho máximo de 255.  
Padrão: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$`   
Obrigatório: não

 ** [Subdirectory](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-Subdirectory"></a>
Especifica o nome do compartilhamento exportado pelo seu servidor de arquivos SMB onde DataSync lerá ou gravará dados. Você pode incluir um subdiretório no caminho de compartilhamento (por exemplo, `/path/to/subdirectory`). Certifique-se de que outros clientes do SMB em sua rede também possam montar este caminho.  
Para copiar todos os dados no subdiretório especificado, DataSync deve ser capaz de montar o compartilhamento SMB e acessar todos os seus dados. Para obter mais informações, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$`   
Obrigatório: não

 ** [User](#API_UpdateLocationSmb_RequestSyntax) **   <a name="DataSync-UpdateLocationSmb-request-User"></a>
Especifica o nome de usuário que pode montar seu servidor de arquivos SMB e tem permissão para acessar os arquivos e pastas envolvidos na sua transferência. Esse parâmetro será aplicado somente se `AuthenticationType` estiver definido como `NTLM`.  
Para obter informações sobre como escolher um usuário com o nível certo de acesso para sua transferência, consulte [Fornecendo DataSync acesso a servidores de arquivos SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: Não

## Elementos de resposta
<a name="API_UpdateLocationSmb_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateTask
<a name="API_UpdateTask"></a>

Atualiza a configuração de uma *tarefa*, que define onde e como o AWS DataSync transfere os dados.

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

```
{
   "CloudWatchLogGroupArn": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "Name": "string",
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Schedule": { 
      "ScheduleExpression": "string",
      "Status": "string"
   },
   "TaskArn": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}
```

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

 ** [CloudWatchLogGroupArn](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-CloudWatchLogGroupArn"></a>
Especifica o Amazon Resource Name (ARN) de um grupo de logs da CloudWatch Amazon para monitorar sua tarefa.  
Para tarefas do modo Avançado, você deve usar `/aws/datasync` como nome do grupo de logs. Por exemplo:  
 `arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*`   
Para mais informações, consulte [Monitoramento de transferências de dados com o CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 562.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$`   
Obrigatório: não

 ** [Excludes](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-Excludes"></a>
Especifica filtros de exclusão que definem os arquivos, objetos e pastas em seu local de origem que você não deseja DataSync transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [Includes](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-Includes"></a>
Especifica que os filtros de inclusão definem os arquivos, objetos e pastas em seu local de origem que você deseja DataSync transferir. Para obter mais informações e exemplos, consulte [Especificação do que é DataSync transferido usando filtros](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).  
Tipo: matriz de objetos [FilterRule](API_FilterRule.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.  
Obrigatório: não

 ** [ManifestConfig](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-ManifestConfig"></a>
Configura um manifesto, que é uma lista de arquivos ou objetos que você deseja DataSync transferir. Para obter mais informações e exemplos de configuração, consulte [Especificação do que é DataSync transferido usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função do IAM DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Para remover uma configuração de manifesto, especifique esse parâmetro como vazio.  
Tipo: objeto [ManifestConfig](API_ManifestConfig.md)  
Obrigatório: não

 ** [Name](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-Name"></a>
Especifica o nome da tarefa.  
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

 ** [Options](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-Options"></a>
Indica como sua tarefa de transferência está configurada. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados durante a transferência. Você também pode especificar como verificar a integridade dos dados, definir limites de largura de banda para sua tarefa, entre outras opções.  
Cada opção tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhuma opção antes de ligar [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).  
Você também pode substituir suas opções de tarefa para cada execução de tarefa. Por exemplo, pode ser bom ajustar o `LogLevel` para uma execução individual.  
Tipo: objeto [Options](API_Options.md)  
Obrigatório: não

 ** [Schedule](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-Schedule"></a>
Especifica um agendamento de quando você deseja que a tarefa seja executada. Para obter mais informações, consulte [Programar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).  
Tipo: objeto [TaskSchedule](API_TaskSchedule.md)  
Obrigatório: não

 ** [TaskArn](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-TaskArn"></a>
Especifica o ARN da tarefa que você deseja atualizar.  
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}:task/task-[0-9a-f]{17}$`   
Obrigatório: Sim

 ** [TaskReportConfig](#API_UpdateTask_RequestSyntax) **   <a name="DataSync-UpdateTask-request-TaskReportConfig"></a>
Especifica como você deseja configurar um relatório de tarefas, que fornece informações detalhadas sobre sua DataSync transferência. Para obter mais informações, consulte [Monitorando suas DataSync transferências com relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Ao usar esse parâmetro, sua identidade de chamador (a função do IAM DataSync com a qual você está usando) deve ter a `iam:PassRole` permissão. A [AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess)política inclui essa permissão.  
Para remover uma configuração de relatório de tarefa, especifique esse parâmetro como vazio.  
Tipo: objeto [TaskReportConfig](API_TaskReportConfig.md)  
Obrigatório: não

## Elementos de resposta
<a name="API_UpdateTask_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# UpdateTaskExecution
<a name="API_UpdateTaskExecution"></a>

Atualiza a configuração da execução de uma AWS DataSync tarefa em execução.

**nota**  
Atualmente, o único `Option` que você pode modificar com `UpdateTaskExecution` é ` [BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) `, que faz o controle de utilização da largura de banda para a execução de uma tarefa em execução ou em fila.

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

```
{
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "TaskExecutionArn": "string"
}
```

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

 ** [Options](#API_UpdateTaskExecution_RequestSyntax) **   <a name="DataSync-UpdateTaskExecution-request-Options"></a>
Indica como sua tarefa de transferência está configurada. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados durante a transferência. Você também pode especificar como verificar a integridade dos dados, definir limites de largura de banda para sua tarefa, entre outras opções.  
Cada opção tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhuma opção antes de ligar [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).  
Você também pode substituir suas opções de tarefa para cada execução de tarefa. Por exemplo, pode ser bom ajustar o `LogLevel` para uma execução individual.  
Tipo: objeto [Options](API_Options.md)  
Obrigatório: Sim

 ** [TaskExecutionArn](#API_UpdateTaskExecution_RequestSyntax) **   <a name="DataSync-UpdateTaskExecution-request-TaskExecutionArn"></a>
Especifica o nome do recurso da Amazon (ARN) da execução da tarefa que você está atualizando.  
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`   
Obrigatório: sim

## Elementos de resposta
<a name="API_UpdateTaskExecution_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros 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

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

# Tipos de dados
<a name="API_Types"></a>

Os seguintes tipos de dados são compatíveis:
+  [AgentListEntry](API_AgentListEntry.md) 
+  [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) 
+  [CmkSecretConfig](API_CmkSecretConfig.md) 
+  [CustomSecretConfig](API_CustomSecretConfig.md) 
+  [Ec2Config](API_Ec2Config.md) 
+  [FilterRule](API_FilterRule.md) 
+  [FsxProtocol](API_FsxProtocol.md) 
+  [FsxProtocolNfs](API_FsxProtocolNfs.md) 
+  [FsxProtocolSmb](API_FsxProtocolSmb.md) 
+  [FsxUpdateProtocol](API_FsxUpdateProtocol.md) 
+  [FsxUpdateProtocolSmb](API_FsxUpdateProtocolSmb.md) 
+  [HdfsNameNode](API_HdfsNameNode.md) 
+  [LocationFilter](API_LocationFilter.md) 
+  [LocationListEntry](API_LocationListEntry.md) 
+  [ManagedSecretConfig](API_ManagedSecretConfig.md) 
+  [ManifestConfig](API_ManifestConfig.md) 
+  [NfsMountOptions](API_NfsMountOptions.md) 
+  [OnPremConfig](API_OnPremConfig.md) 
+  [Options](API_Options.md) 
+  [Platform](API_Platform.md) 
+  [PrivateLinkConfig](API_PrivateLinkConfig.md) 
+  [QopConfiguration](API_QopConfiguration.md) 
+  [ReportDestination](API_ReportDestination.md) 
+  [ReportDestinationS3](API_ReportDestinationS3.md) 
+  [ReportOverride](API_ReportOverride.md) 
+  [ReportOverrides](API_ReportOverrides.md) 
+  [ReportResult](API_ReportResult.md) 
+  [S3Config](API_S3Config.md) 
+  [S3ManifestConfig](API_S3ManifestConfig.md) 
+  [SmbMountOptions](API_SmbMountOptions.md) 
+  [SourceManifestConfig](API_SourceManifestConfig.md) 
+  [TagListEntry](API_TagListEntry.md) 
+  [TaskExecutionFilesFailedDetail](API_TaskExecutionFilesFailedDetail.md) 
+  [TaskExecutionFilesListedDetail](API_TaskExecutionFilesListedDetail.md) 
+  [TaskExecutionFoldersFailedDetail](API_TaskExecutionFoldersFailedDetail.md) 
+  [TaskExecutionFoldersListedDetail](API_TaskExecutionFoldersListedDetail.md) 
+  [TaskExecutionListEntry](API_TaskExecutionListEntry.md) 
+  [TaskExecutionResultDetail](API_TaskExecutionResultDetail.md) 
+  [TaskFilter](API_TaskFilter.md) 
+  [TaskListEntry](API_TaskListEntry.md) 
+  [TaskReportConfig](API_TaskReportConfig.md) 
+  [TaskSchedule](API_TaskSchedule.md) 
+  [TaskScheduleDetails](API_TaskScheduleDetails.md) 

# AgentListEntry
<a name="API_AgentListEntry"></a>

Representa uma única entrada em uma lista (ou matriz) de AWS DataSync agentes quando você chama a [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html)operação.

## Conteúdo
<a name="API_AgentListEntry_Contents"></a>

 ** AgentArn **   <a name="DataSync-Type-AgentListEntry-AgentArn"></a>
O nome de recurso da Amazon (ARN) de um DataSync 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}$`   
Obrigatório: não

 ** Name **   <a name="DataSync-Type-AgentListEntry-Name"></a>
O nome de um agente.  
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

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

 ** Status **   <a name="DataSync-Type-AgentListEntry-Status"></a>
O status de um 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`   
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AgentListEntry) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AgentListEntry) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AgentListEntry) 

# AzureBlobSasConfiguration
<a name="API_AzureBlobSasConfiguration"></a>

A configuração de assinatura de acesso compartilhado (SAS) que permite AWS DataSync acessar seu Microsoft Azure Blob Storage.

Para obter mais informações, consulte [Tokens SAS](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) para acessar seu Azure Blob Storage.

## Conteúdo
<a name="API_AzureBlobSasConfiguration_Contents"></a>

 ** Token **   <a name="DataSync-Type-AzureBlobSasConfiguration-Token"></a>
Especifica um token SAS que fornece permissões para acessar seu Azure Blob Storage.  
O token faz parte da string SAS URI que vem depois do URI do recurso de armazenamento e de um ponto de interrogação. Um token é semelhante ao seguinte:  
 `sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D`   
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: : `^.+$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AzureBlobSasConfiguration) 

# CmkSecretConfig
<a name="API_CmkSecretConfig"></a>

Especifica as informações de configuração de um segredo DataSync gerenciado, como um token de autenticação, chave secreta, senha ou keytab Kerberos que é DataSync usado para acessar um local de armazenamento específico, com um gerenciado pelo cliente. AWS KMS key

**nota**  
Você pode usar um `CmkSecretConfig` ou `CustomSecretConfig` para fornecer credenciais para uma solicitação `CreateLocation`. Não forneça os dois parâmetros para a mesma solicitação.

## Conteúdo
<a name="API_CmkSecretConfig_Contents"></a>

 ** KmsKeyArn **   <a name="DataSync-Type-CmkSecretConfig-KmsKeyArn"></a>
Especifica o ARN do servidor gerenciado pelo AWS KMS key cliente DataSync que usa para criptografar o segredo gerenciado armazenado DataSync para. `SecretArn` DataSync fornece essa chave para AWS Secrets Manager.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z\-0-9]+:[0-9]{12}:key/.*|)$`   
Obrigatório: não

 ** SecretArn **   <a name="DataSync-Type-CmkSecretConfig-SecretArn"></a>
Especifica o ARN para DataSync o segredo AWS Secrets Manager gerenciado que é usado para acessar um local de armazenamento específico. Essa propriedade é gerada por DataSync e é somente para leitura. DataSync criptografa esse segredo com a chave KMS que você especifica. `KmsKeyArn`  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CmkSecretConfig) 

# CustomSecretConfig
<a name="API_CustomSecretConfig"></a>

Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que as credenciais de um local de armazenamento são armazenadas no Secrets Manager como texto simples (para token de autenticação, chave secreta ou senha) ou como binário (para Kerberos keytab). Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo.

**nota**  
Você pode usar um `CmkSecretConfig` ou `CustomSecretConfig` para fornecer credenciais para uma solicitação `CreateLocation`. Não forneça os dois parâmetros para a mesma solicitação.

## Conteúdo
<a name="API_CustomSecretConfig_Contents"></a>

 ** SecretAccessRoleArn **   <a name="DataSync-Type-CustomSecretConfig-SecretAccessRoleArn"></a>
Especifica o ARN AWS Identity and Access Management da função DataSync usada para acessar o segredo especificado para. `SecretArn`  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+|)$`   
Obrigatório: não

 ** SecretArn **   <a name="DataSync-Type-CustomSecretConfig-SecretArn"></a>
Especifica o ARN de um segredo. AWS Secrets Manager   
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CustomSecretConfig) 

# Ec2Config
<a name="API_Ec2Config"></a>

A sub-rede e os grupos de segurança AWS DataSync usados para se conectar a um dos [destinos de montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) do seu sistema de arquivos Amazon EFS.

## Conteúdo
<a name="API_Ec2Config_Contents"></a>

 ** SecurityGroupArns **   <a name="DataSync-Type-Ec2Config-SecurityGroupArns"></a>
Especifica os nomes de recursos da Amazon (ARNs) dos grupos de segurança associados ao destino de montagem do sistema de arquivos Amazon EFS.  
Tipo: matriz de strings  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
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]+$`   
Exigido: Sim

 ** SubnetArn **   <a name="DataSync-Type-Ec2Config-SubnetArn"></a>
Especifica o ARN de uma sub-rede DataSync onde cria as interfaces de [rede para gerenciar o](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) tráfego durante sua transferência.  
A sub-rede deve estar localizada:  
+ Na mesma nuvem privada virtual (VPC) que o sistema de arquivos do Amazon EFS.
+ Na mesma zona de disponibilidade que pelo menos um destino de montagem para o sistema de arquivos do Amazon EFS.
Você não precisa especificar uma sub-rede que inclua um destino de montagem do sistema de arquivos.
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):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Ec2Config) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Ec2Config) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Ec2Config) 

# FilterRule
<a name="API_FilterRule"></a>

Especifica quais arquivos, pastas e objetos devem ser incluídos ou excluídos ao transferir arquivos da origem para o destino.

## Conteúdo
<a name="API_FilterRule_Contents"></a>

 ** FilterType **   <a name="DataSync-Type-FilterRule-FilterType"></a>
O tipo de regra de filtro a ser aplicada. O AWS DataSync oferece suporte somente ao tipo de regra SIMPLE\$1PATTERN.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 128.  
Padrão: : `^[A-Z0-9_]+$`   
Valores Válidos: `SIMPLE_PATTERN`   
Obrigatório: Não

 ** Value **   <a name="DataSync-Type-FilterRule-Value"></a>
Uma única string de filtro que consiste nos padrões a serem incluídos ou excluídos. Os padrões são delimitados por “\$1” (isto é, um pipe), por exemplo: `/folder1|/folder2`   
   
Tipo: String  
Restrições de comprimento: comprimento máximo de 102.400.  
Padrão: : `^[^\x00]+$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FilterRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FilterRule) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FilterRule) 

# FsxProtocol
<a name="API_FsxProtocol"></a>

Especifica o protocolo de transferência de dados que o AWS DataSync usa para acessar o sistema de arquivos Amazon FSx.

## Conteúdo
<a name="API_FsxProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxProtocol-NFS"></a>
Especifica a configuração do protocolo NFS (Network File System) que o DataSync usa para acessar seu sistema de arquivos FSx for OpenZFS ou a máquina virtual de armazenamento (SVM) do seu sistema de arquivos FSx for ONTAP.  
Tipo: objeto [FsxProtocolNfs](API_FsxProtocolNfs.md)  
Obrigatório: Não

 ** SMB **   <a name="DataSync-Type-FsxProtocol-SMB"></a>
Especifica a configuração do protocolo do Server Message Block (SMB) que o DataSync usa para acessar a SVM do sistema de arquivos do FSx for ONTAP.  
Tipo: objeto [FsxProtocolSmb](API_FsxProtocolSmb.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocol) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocol) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocol) 

# FsxProtocolNfs
<a name="API_FsxProtocolNfs"></a>

Especifica a configuração do protocolo NFS (Network File System) que o DataSync usa para acessar seu sistema de arquivos FSx for OpenZFS ou a máquina virtual de armazenamento (SVM) do seu sistema de arquivos FSx for ONTAP.

## Conteúdo
<a name="API_FsxProtocolNfs_Contents"></a>

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolNfs-MountOptions"></a>
Especifica como o DataSync pode acessar um local usando o protocolo NFS.  
Tipo: objeto [NfsMountOptions](API_NfsMountOptions.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolNfs) 

# FsxProtocolSmb
<a name="API_FsxProtocolSmb"></a>

Especifica a configuração do protocolo Server Message Block (SMB) AWS DataSync usada para acessar a máquina virtual de armazenamento (SVM) do sistema de arquivos Amazon FSx for NetApp ONTAP. Para obter mais informações, consulte [Fornecendo DataSync acesso aos sistemas FSx de arquivos ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).

## Conteúdo
<a name="API_FsxProtocolSmb_Contents"></a>

 ** User **   <a name="DataSync-Type-FsxProtocolSmb-User"></a>
Especifica um usuário que pode montar e acessar os arquivos, pastas e metadados necessários na SVM.  
Para obter informações sobre a escolha de um usuário com o nível certo de acesso para a transferência, consulte [Uso do protocolo SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: Sim

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CmkSecretConfig"></a>
Especifica as informações de configuração de um segredo DataSync gerenciado, que inclui a senha DataSync usada para acessar um local de armazenamento específico FSx do ONTAP (usando SMB), com um local gerenciado pelo cliente. AWS KMS key  
Ao incluir esse parâmetro como parte de uma `CreateLocationFsxOntap` solicitação, você fornece somente o ARN da chave KMS. DataSync usa essa chave KMS junto com a `Password` que você especificou para criar um segredo DataSync gerenciado para armazenar as credenciais de acesso à localização.  
Verifique se ele DataSync tem permissão para acessar a chave KMS que você especificou. Para obter mais informações, consulte [Usando um segredo gerenciado pelo serviço criptografado com um personalizado](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). AWS KMS key  
Você pode usar `CmkSecretConfig` (com `Password`) ou `CustomSecretConfig` (sem `Password`) para fornecer credenciais para uma solicitação `CreateLocationFsxOntap`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CustomSecretConfig"></a>
Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente, em que a senha de um FSx local de armazenamento do ONTAP (usando SMB) é armazenada em texto simples, no Secrets Manager. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo. Para obter mais informações, consulte [Usando um segredo que você gerencia](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key).  
Você pode usar `CmkSecretConfig` (com `Password`) ou `CustomSecretConfig` (sem `Password`) para fornecer credenciais para uma solicitação `CreateLocationFsxOntap`. Não forneça os dois parâmetros para a mesma solicitação.
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** Domain **   <a name="DataSync-Type-FsxProtocolSmb-Domain"></a>
Especifica o nome do domínio do Windows ao qual a máquina virtual de armazenamento (SVM) pertence.  
Se você tiver vários domínios em seu ambiente, definir essa configuração garante que ele se DataSync conecte ao SVM correto.  
Se você tiver vários domínios do Active Directory em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao SVM correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`   
Obrigatório: não

 ** ManagedSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-ManagedSecretConfig"></a>
Descreve as informações de configuração DataSync de um segredo gerenciado, como `Password` aquele DataSync usado para acessar um local de armazenamento específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager  
Não forneça isso para uma `CreateLocation` solicitação. `ManagedSecretConfig`é uma ReadOnly propriedade e só pode ser preenchida na `DescribeLocation` resposta.
Tipo: objeto [ManagedSecretConfig](API_ManagedSecretConfig.md)  
Obrigatório: não

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolSmb-MountOptions"></a>
Especifica a versão do protocolo Server Message Block (SMB) AWS DataSync usada para acessar um servidor de arquivos SMB.  
Tipo: objeto [SmbMountOptions](API_SmbMountOptions.md)  
Obrigatório: não

 ** Password **   <a name="DataSync-Type-FsxProtocolSmb-Password"></a>
Especifica a senha de um usuário que tem permissão para acessar seu SVM.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolSmb) 

# FsxUpdateProtocol
<a name="API_FsxUpdateProtocol"></a>

Especifica o protocolo de transferência de dados que o AWS DataSync usa para acessar o sistema de arquivos Amazon FSx.

**nota**  
Você não pode atualizar a configuração do protocolo Network File System (NFS) para locais do FSx para ONTAP. Atualmente, o DataSync oferece suporte apenas para a versão 3 do NFS com esse tipo de local.

## Conteúdo
<a name="API_FsxUpdateProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxUpdateProtocol-NFS"></a>
Especifica a configuração do protocolo NFS (Network File System) que o DataSync usa para acessar seu sistema de arquivos FSx for OpenZFS ou a máquina virtual de armazenamento (SVM) do seu sistema de arquivos FSx for ONTAP.  
Tipo: objeto [FsxProtocolNfs](API_FsxProtocolNfs.md)  
Obrigatório: Não

 ** SMB **   <a name="DataSync-Type-FsxUpdateProtocol-SMB"></a>
Especifica a configuração do protocolo do Server Message Block (SMB) que o DataSync usa para acessar a máquina virtual de armazenamento (SVM) no sistema de arquivos FSx para ONTAP.  
Tipo: objeto [FsxUpdateProtocolSmb](API_FsxUpdateProtocolSmb.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocol) 

# FsxUpdateProtocolSmb
<a name="API_FsxUpdateProtocolSmb"></a>

Especifica a configuração do protocolo Server Message Block (SMB) AWS DataSync usada para acessar a máquina virtual de armazenamento (SVM) do sistema de arquivos Amazon FSx for NetApp ONTAP. Para obter mais informações, consulte [Fornecendo DataSync acesso aos sistemas FSx de arquivos ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).

## Conteúdo
<a name="API_FsxUpdateProtocolSmb_Contents"></a>

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CmkSecretConfig"></a>
Especifica as informações de configuração DataSync de um segredo gerenciado, como um `Password` ou conjunto de credenciais DataSync usado para acessar um local de transferência específico e um gerenciado pelo cliente. AWS KMS key  
Tipo: objeto [CmkSecretConfig](API_CmkSecretConfig.md)  
Obrigatório: não

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CustomSecretConfig"></a>
Especifica as informações de configuração de um segredo gerenciado pelo cliente, como um conjunto de credenciais `Password` ou um conjunto de credenciais DataSync usado para acessar um local de transferência específico. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo.  
Tipo: objeto [CustomSecretConfig](API_CustomSecretConfig.md)  
Obrigatório: não

 ** Domain **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Domain"></a>
Especifica o nome do domínio do Windows ao qual a máquina virtual de armazenamento (SVM) pertence.  
Se você tiver vários domínios do Active Directory em seu ambiente, a configuração desse parâmetro garante que ele se DataSync conecte ao SVM correto.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 253.  
Padrão: `^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$`   
Obrigatório: não

 ** MountOptions **   <a name="DataSync-Type-FsxUpdateProtocolSmb-MountOptions"></a>
Especifica a versão do protocolo Server Message Block (SMB) AWS DataSync usada para acessar um servidor de arquivos SMB.  
Tipo: objeto [SmbMountOptions](API_SmbMountOptions.md)  
Obrigatório: não

 ** Password **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Password"></a>
Especifica a senha de um usuário que tem permissão para acessar seu SVM.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^.{0,104}$`   
Obrigatório: não

 ** User **   <a name="DataSync-Type-FsxUpdateProtocolSmb-User"></a>
Especifica um usuário que pode montar e acessar os arquivos, pastas e metadados necessários na SVM.  
Para obter informações sobre a escolha de um usuário com o nível certo de acesso para a transferência, consulte [Uso do protocolo SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 104.  
Padrão: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocolSmb) 

# HdfsNameNode
<a name="API_HdfsNameNode"></a>

O NameNode do Sistema de Arquivos Distribuído do Hadoop (HDFS). O NameNode gerencia o namespace do sistema de arquivos. O NameNode realiza operações como abrir, fechar e renomear arquivos e diretórios. O NameNode contém as informações para mapear blocos de dados para os DataNodes.

## Conteúdo
<a name="API_HdfsNameNode_Contents"></a>

 ** Hostname **   <a name="DataSync-Type-HdfsNameNode-Hostname"></a>
O nome do host do NameNode no cluster HDFS. Este valor é o endereço IP ou o nome do Sistema de Nomes de Domínio (DNS) do NameNode. Um agente instalado on-premises usa esse nome de host para se comunicar com o NameNode na rede.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: : `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Exigido: Sim

 ** Port **   <a name="DataSync-Type-HdfsNameNode-Port"></a>
A porta que o NameNode usa para ouvir as solicitações do cliente.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1. Valor máximo de 65536.  
Obrigatório: Sim

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/HdfsNameNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/HdfsNameNode) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/HdfsNameNode) 

# LocationFilter
<a name="API_LocationFilter"></a>

Limite a lista de recursos retornados por `ListLocations`. Por exemplo, para ver todos os seus locais do Amazon S3, crie um filtro usando `"Name": "LocationType"`, `"Operator": "Equals"` e `"Values": "S3"`.

Para obter mais informações, consulte [Recursos de filtragem](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).

## Conteúdo
<a name="API_LocationFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-LocationFilter-Name"></a>
O nome do filtro que está sendo usado. Cada chamada de API é compatível com uma lista de filtros que estão disponíveis para ela (por exemplo, `LocationType` para `ListLocations`).  
Tipo: String  
Valores Válidos: `LocationUri | LocationType | CreationTime`   
Obrigatório: Sim

 ** Operator **   <a name="DataSync-Type-LocationFilter-Operator"></a>
O operador usado para comparar valores de filtro (por exemplo, `Equals` ou `Contains`).  
Tipo: String  
Valores Válidos: `Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
Obrigatório: Sim

 ** Values **   <a name="DataSync-Type-LocationFilter-Values"></a>
Os valores que você deseja filtrar. Por exemplo, talvez você queira exibir somente locais do Amazon S3.  
Tipo: matriz de strings  
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 255.  
Padrão: : `^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationFilter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationFilter) 

# LocationListEntry
<a name="API_LocationListEntry"></a>

Representa uma única entrada em uma lista de locais. `LocationListEntry`retorna uma matriz que contém uma lista de locais quando a [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html)operação é chamada.

## Conteúdo
<a name="API_LocationListEntry_Contents"></a>

 ** LocationArn **   <a name="DataSync-Type-LocationListEntry-LocationArn"></a>
O nome do recurso da Amazon (ARN) do local. Para o Network File System (NFS) ou o Amazon EFS, o local é o caminho de exportação. Para o Amazon S3, o local é o caminho do prefixo que você deseja montar e usar como a raiz do local.  
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}:location/loc-[0-9a-z]{17}$`   
Obrigatório: não

 ** LocationUri **   <a name="DataSync-Type-LocationListEntry-LocationUri"></a>
Representa uma lista URIs de um local. `LocationUri`retorna uma matriz que contém uma lista de locais quando a [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html)operação é chamada.  
Formato: `TYPE://GLOBAL_ID/SUBDIR`.  
TYPE designa o tipo de local (por exemplo, `nfs` ou `s3`).  
GLOBAL\$1ID é o identificador globalmente exclusivo do recurso que respalda o local. Um exemplo para o EFS é `us-east-2.fs-abcd1234`. Um exemplo para o Amazon S3 é o nome do bucket, como `myBucket`. Um exemplo de NFS é um IPv6 endereço IPv4 ou nome de host válido compatível com o DNS.  
SUBDIR é um caminho válido do sistema de arquivos, delimitado por barras, seguindo a convenção \$1nix. Para NFS e Amazon EFS, é o caminho de exportação para criar o local. Para o Amazon S3, é o caminho do prefixo que você monta e usa como a raiz do local.  
  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.360.  
Padrão: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationListEntry) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationListEntry) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationListEntry) 

# ManagedSecretConfig
<a name="API_ManagedSecretConfig"></a>

Especifica as informações de configuração DataSync de um segredo gerenciado, como um token de autenticação ou um conjunto de credenciais DataSync usado para acessar um local de transferência específico. DataSync usa a chave KMS AWS gerenciada padrão para criptografar esse segredo. AWS Secrets Manager

## Conteúdo
<a name="API_ManagedSecretConfig_Contents"></a>

 ** SecretArn **   <a name="DataSync-Type-ManagedSecretConfig-SecretArn"></a>
Especifica o ARN de um segredo. AWS Secrets Manager   
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManagedSecretConfig) 

# ManifestConfig
<a name="API_ManifestConfig"></a>

Configura um manifesto, que é uma lista dos arquivos ou objetos que você deseja que o AWS DataSync transfira. Para obter mais informações e exemplos de configuração, consulte [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Conteúdo
<a name="API_ManifestConfig_Contents"></a>

 ** Action **   <a name="DataSync-Type-ManifestConfig-Action"></a>
Especifica para que o DataSync usa o manifesto.  
Tipo: String  
Valores Válidos: `TRANSFER`   
Obrigatório: Não

 ** Format **   <a name="DataSync-Type-ManifestConfig-Format"></a>
Especifica o formato de arquivo do manifesto. Para obter mais informações, consulte [Creating a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create).  
Tipo: String  
Valores Válidos: `CSV`   
Obrigatório: Não

 ** Source **   <a name="DataSync-Type-ManifestConfig-Source"></a>
Especifica o manifesto que você deseja que o DataSync use e onde ele é hospedado.  
Você deve especificar esse parâmetro for configurar um novo manifesto depois de 7 de fevereiro de 2024.  
Caso contrário, você receberá um código de status 400 e um erro `ValidationException` informando que falta o perfil do IAM para que o DataSync acesse o bucket do S3 em que você está hospedando seu manifesto. Para obter mais informações, consulte [Fornecer ao DataSync acesso ao manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access).
Tipo: objeto [SourceManifestConfig](API_SourceManifestConfig.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManifestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManifestConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManifestConfig) 

# NfsMountOptions
<a name="API_NfsMountOptions"></a>

Especifica como o DataSync pode acessar um local usando o protocolo NFS.

## Conteúdo
<a name="API_NfsMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-NfsMountOptions-Version"></a>
A versão específica do NFS que você deseja que o DataSync use para montar o compartilhamento do NFS. Se o servidor se recusar a usar a versão especificada, a tarefa apresentará falha.  
Você pode especificar as seguintes opções:  
+  `AUTOMATIC` (padrão): o DataSync escolhe o NFS versão 4.1.
+  `NFS3`: versão de protocolo stateless que permite gravações assíncronas no servidor.
+  `NFSv4_0`: versão de protocolo stateful, amigável para firewalls, que suporta delegações e pseudossistemas de arquivos.
+  `NFSv4_1`: versão de protocolo stateful que suporta sessões, delegações de diretório e processamento de dados paralelo. NFS versão 4.1 também inclui todos os recursos disponíveis na versão 4.0.
Atualmente, o DataSync oferece suporte apenas para a versão 3 do NFS em locais do Amazon FSx para NetApp ONTAP.
Tipo: String  
Valores Válidos: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/NfsMountOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/NfsMountOptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/NfsMountOptions) 

# OnPremConfig
<a name="API_OnPremConfig"></a>

Os AWS DataSync agentes que podem se conectar ao seu servidor de arquivos do Sistema de Arquivos de Rede (NFS).

## Conteúdo
<a name="API_OnPremConfig_Contents"></a>

 ** AgentArns **   <a name="DataSync-Type-OnPremConfig-AgentArns"></a>
Os nomes de recursos da Amazon (ARNs) dos DataSync agentes que podem se conectar ao seu servidor de arquivos NFS.  
Você pode especificar mais de um atendente. Para obter mais informações, consulte [Uso de vários DataSync agentes](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents).  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 8 itens.  
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}$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/OnPremConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/OnPremConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/OnPremConfig) 

# Options
<a name="API_Options"></a>

Indica como sua tarefa de transferência está configurada. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados durante a transferência. Você também pode especificar como verificar a integridade dos dados, definir limites de largura de banda para sua tarefa, entre outras opções.

Cada opção tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhuma opção antes de ligar [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).

Você também pode substituir suas opções de tarefa para cada execução de tarefa. Por exemplo, pode ser bom ajustar o `LogLevel` para uma execução individual.

## Conteúdo
<a name="API_Options_Contents"></a>

 ** Atime **   <a name="DataSync-Type-Options-Atime"></a>
Especifica se os metadados que indicam a última vez que um arquivo foi lido ou gravado devem ser preservados.  
O comportamento do `Atime` não é totalmente padrão em todas as plataformas, então só DataSync posso fazer isso com base no melhor esforço.
+  `BEST_EFFORT`(padrão) - DataSync tenta preservar o `Atime` atributo original em todos os arquivos de origem (ou seja, a versão anterior às `PREPARING` etapas da execução da tarefa). Essa opção não é recomendada.
+  `NONE`: ignora `Atime`.
Se `Atime` estiver definido como `BEST_EFFORT`, o `Mtime` deverá ser definido como `PRESERVE`.   
Se `Atime` estiver definido como `NONE`, o `Mtime` também deverá ser `NONE`. 
Tipo: string  
Valores válidos: `NONE | BEST_EFFORT`   
Obrigatório: não

 ** BytesPerSecond **   <a name="DataSync-Type-Options-BytesPerSecond"></a>
Limita a largura de banda usada por uma DataSync tarefa. Por exemplo, se você quiser DataSync usar no máximo 1 MB, defina esse valor como `1048576` (`=1024*1024`).  
Tipo: longo  
Intervalo válido: valor mínimo de -1.  
Obrigatório: não

 ** Gid **   <a name="DataSync-Type-Options-Gid"></a>
O ID do grupo (GID) POSIX dos proprietários do arquivo.  
+  `INT_VALUE` (padrão): preserva o valor inteiro do ID do usuário (UID) e do ID de grupo (GID), o que é recomendado.
+  `NONE`: ignora o UID e o GID.
Para obter mais informações, consulte [Entendendo como DataSync manipula metadados de arquivos e objetos](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
Tipo: string  
Valores válidos: `NONE | INT_VALUE | NAME | BOTH`   
Obrigatório: não

 ** LogLevel **   <a name="DataSync-Type-Options-LogLevel"></a>
Especifica o tipo de registros que são DataSync publicados em um grupo de registros do Amazon CloudWatch Logs. Para especificar o grupo de registros, consulte [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn).  
+  `BASIC`: publica logs apenas com informações básicas (como erros de transferência).
+  `TRANSFER`- Publica registros de todos os arquivos ou objetos que sua DataSync tarefa transfere e realiza verificações de integridade de dados.
+  `OFF`: nenhum log é publicado.
Tipo: string  
Valores válidos: `OFF | BASIC | TRANSFER`   
Obrigatório: não

 ** Mtime **   <a name="DataSync-Type-Options-Mtime"></a>
Especifica se os metadados que indicam a última vez que um arquivo foi lido ou gravado devem ser preservados antes da etapa de `PREPARING` da execução da tarefa. Esta opção é necessária para casos em que você precisa executar a mesma tarefa mais de uma vez.  
+  `PRESERVE` (padrão): preserva o `Mtime` original, o que é recomendado.
+  `NONE`: ignora `Mtime`.
Se `Mtime` estiver definido como `PRESERVE`, o `Atime` deverá ser definido como `BEST_EFFORT`.  
Se `Mtime` estiver definido como `NONE`, o `Atime` também deverá ser definido como `NONE`. 
Tipo: string  
Valores válidos: `NONE | PRESERVE`   
Obrigatório: não

 ** ObjectTags **   <a name="DataSync-Type-Options-ObjectTags"></a>
Especifica se você deseja DataSync `PRESERVE` objetar tags (comportamento padrão) ao transferir entre sistemas de armazenamento de objetos. Se você quiser que sua DataSync tarefa ignore as tags de objeto, especifique o `NONE` valor.  
Tipo: string  
Valores válidos: `PRESERVE | NONE`   
Obrigatório: não

 ** OverwriteMode **   <a name="DataSync-Type-Options-OverwriteMode"></a>
Especifica se os dados DataSync devem ser modificados ou preservados no local de destino.  
+  `ALWAYS`(padrão) - DataSync modifica os dados no local de destino quando os dados de origem (incluindo metadados) são alterados.

  Se DataSync sobrescrever objetos, você poderá incorrer em cobranças adicionais para determinadas classes de armazenamento do Amazon S3 (por exemplo, para recuperação ou exclusão antecipada). Para obter mais informações, consulte [Considerações sobre classes de armazenamento com transferências do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `NEVER`- DataSync não sobrescreve os dados no local de destino, mesmo que os dados de origem tenham sido alterados. Você pode usar essa opção como proteção contra a substituição de alterações feitas em arquivos ou objetos no destino.
Tipo: string  
Valores válidos: `ALWAYS | NEVER`   
Obrigatório: não

 ** PosixPermissions **   <a name="DataSync-Type-Options-PosixPermissions"></a>
Especifica quais usuários ou grupos podem acessar um arquivo para uma finalidade específica, como leitura, gravação ou execução do arquivo.  
Para obter mais informações, consulte [Entendendo como DataSync manipula metadados de arquivos e objetos](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
+  `PRESERVE` (padrão): preserva as permissões no estilo POSIX, o que é recomendado.
+  `NONE`: ignora as permissões no estilo POSIX. 
DataSync pode preservar as permissões existentes de um local de origem.
Tipo: string  
Valores válidos: `NONE | PRESERVE`   
Obrigatório: não

 ** PreserveDeletedFiles **   <a name="DataSync-Type-Options-PreserveDeletedFiles"></a>
Especifica se os arquivos no local de destino que não existem na origem devem ser preservados. Esta opção pode afetar seu custo do armazenamento no Amazon S3. Se a tarefa excluir objetos, você poderá estar sujeito a cobranças mínimas de duração de armazenamento para determinadas classes de armazenamento. Para obter informações detalhadas, consulte [Considerações ao trabalhar com as classes de armazenamento do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) em. DataSync  
+  `PRESERVE` (padrão): ignora esses arquivos de destino, o que é recomendado. 
+  `REMOVE`: exclui os arquivos de destino que não estão presentes na origem.
Se você definir este parâmetro como `REMOVE`, não poderá definir `TransferMode` como `ALL`. Quando você transfere todos os dados, DataSync não escaneia sua localização de destino e não sabe o que excluir.
Tipo: string  
Valores válidos: `PRESERVE | REMOVE`   
Obrigatório: não

 ** PreserveDevices **   <a name="DataSync-Type-Options-PreserveDevices"></a>
Especifica se os metadados dos dispositivos de blocos e caracteres DataSync devem ser preservados no local de origem e recriar os arquivos com o nome do dispositivo e os metadados no destino. DataSync copia somente o nome e os metadados desses dispositivos.  
DataSync não consigo copiar o conteúdo real desses dispositivos porque eles não são terminais e não retornam um marcador end-of-file (EOF).
+  `NONE` (padrão): ignora dispositivos especiais (recomendado).
+  `PRESERVE`: preserva os metadados de caractere e dispositivo de blocos. Esta opção não é compatível, no momento, com o Amazon EFS.
Tipo: string  
Valores válidos: `NONE | PRESERVE`   
Obrigatório: não

 ** SecurityDescriptorCopyFlags **   <a name="DataSync-Type-Options-SecurityDescriptorCopyFlags"></a>
Especifica os componentes do descritor de segurança SMB que são copiados dos objetos de origem para o destino.   
Esse valor é usado somente para transferências entre SMB e Amazon FSx para locais do Windows File Server ou entre dois FSx para locais do Windows File Server. Para obter mais informações, consulte [Entendendo como DataSync manipula metadados de arquivos e objetos](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
+  `OWNER_DACL`(padrão) - Para cada objeto copiado, DataSync copia os seguintes metadados:
  + O proprietário do objeto.
  + Listas de controle de acesso discricionário do NTFS (DACLs), que determinam se o acesso a um objeto deve ser concedido.

    DataSync não copiará listas de controle de acesso do sistema NTFS (SACLs) com essa opção.
+  `OWNER_DACL_SACL`- Para cada objeto copiado, DataSync copie os seguintes metadados:
  + O proprietário do objeto.
  + Listas de controle de acesso discricionário do NTFS (DACLs), que determinam se o acesso a um objeto deve ser concedido.
  + SACLs, que são usados pelos administradores para registrar tentativas de acesso a um objeto protegido.

    A cópia SACLs requer a concessão de permissões adicionais ao usuário do Windows que DataSync usa para acessar sua localização SMB. Para obter informações sobre como escolher um usuário com as permissões corretas, consulte Permissões necessárias para [SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions), [FSx Windows File Server](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) ou [FSx ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb) (dependendo do tipo de local em sua transferência).
+  `NONE`: nenhum dos componentes do descritor de segurança SMB é copiado. Os objetos de destino pertencem ao usuário que foi fornecido para acessar o local de destino. DACLs e SACLs são definidos com base na configuração do servidor de destino. 
Tipo: string  
Valores válidos: `NONE | OWNER_DACL | OWNER_DACL_SACL`   
Obrigatório: não

 ** TaskQueueing **   <a name="DataSync-Type-Options-TaskQueueing"></a>
Especifica se suas tarefas de transferência devem ser colocadas em uma fila em determinados cenários ao [executar várias tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks). Isto é `ENABLED` por padrão.  
Tipo: string  
Valores válidos: `ENABLED | DISABLED`   
Obrigatório: não

 ** TransferMode **   <a name="DataSync-Type-Options-TransferMode"></a>
Especifica se DataSync transfere somente os dados (incluindo metadados) que diferem entre os locais após uma cópia inicial ou se transfere todos os dados sempre que você executa a tarefa. Se estiver planejando transferências recorrentes, talvez queira transferir somente o que mudou desde a execução anterior da tarefa.  
+  `CHANGED`(padrão) - Após a transferência inicial completa, DataSync copia somente os dados e os metadados que diferem entre o local de origem e o local de destino.
+  `ALL`- DataSync copia tudo na origem para o destino sem comparar as diferenças entre os locais.
Tipo: string  
Valores válidos: `CHANGED | ALL`   
Obrigatório: não

 ** Uid **   <a name="DataSync-Type-Options-Uid"></a>
Especifica o ID de usuário (UID) do POSIX do proprietário do arquivo.  
+  `INT_VALUE` (padrão): preserva o valor inteiro do UID do usuário e do ID de grupo (GID), o que é recomendado.
+  `NONE`: ignora o UID e o GID. 
Para obter mais informações, consulte [Metadados copiados por. DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied)  
Tipo: string  
Valores válidos: `NONE | INT_VALUE | NAME | BOTH`   
Obrigatório: não

 ** VerifyMode **   <a name="DataSync-Type-Options-VerifyMode"></a>
Especifica se e como DataSync verifica a integridade dos seus dados no final da transferência.  
+  `ONLY_FILES_TRANSFERRED`(recomendado) - DataSync calcula a soma de verificação dos dados transferidos (incluindo metadados) no local de origem. Ao final da transferência, DataSync compara essa soma de verificação com a soma de verificação calculada com base nesses dados no destino.
**nota**  
Essa é a opção padrão para [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

  Recomendamos esta opção ao transferir para as classes de armazenamento do S3 Glacier Flexible Retrieval ou para o S3 Glacier Deep Archive. Para obter mais informações, consulte [Considerações sobre a classe de armazenamento com locais do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `POINT_IN_TIME_CONSISTENT`- Ao final da transferência, DataSync verifica toda a origem e o destino para verificar se os dois locais estão totalmente sincronizados.
**nota**  
Essa é a opção padrão para [tarefas do modo Básico](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html) e atualmente não é compatível com as tarefas do modo Avançado.

  Se você usa um [manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), DataSync apenas digitaliza e verifica o que está listado no manifesto.

  Você não pode usar esta opção em transferências para as classes de armazenamento S3 Glacier Flexible Retrieval ou S3 Glacier Deep Archive. Para obter mais informações, consulte [Considerações sobre a classe de armazenamento com locais do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `NONE`- DataSync realiza verificações de integridade de dados somente durante sua transferência. Ao contrário de outras opções, não há verificação adicional no fim da transferência.
Tipo: string  
Valores válidos: `POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE`   
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Options) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Options) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Options) 

# Platform
<a name="API_Platform"></a>

Os detalhes relacionados à plataforma sobre o agente AWS DataSync, como o número da versão.

## Conteúdo
<a name="API_Platform_Contents"></a>

 ** Version **   <a name="DataSync-Type-Platform-Version"></a>
A versão do agente do DataSync.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: : `^[a-zA-Z0-9\s+=._:@/-]+$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Platform) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Platform) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Platform) 

# PrivateLinkConfig
<a name="API_PrivateLinkConfig"></a>

Especifica como seu AWS DataSync agente se conecta AWS usando um endpoint de serviço de [nuvem privada virtual (VPC)](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc). Um agente que usa um endpoint da VPC não está acessível pela Internet pública.

## Conteúdo
<a name="API_PrivateLinkConfig_Contents"></a>

 ** PrivateLinkEndpoint **   <a name="DataSync-Type-PrivateLinkConfig-PrivateLinkEndpoint"></a>
Especifica o endpoint da VPC fornecido por [AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html) pelo qual seu agente se conecta.  
Tipo: string  
Restrições de comprimento: comprimento mínimo de 7. Comprimento máximo de 15.  
Padrão: `\A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z`   
Obrigatório: não

 ** SecurityGroupArns **   <a name="DataSync-Type-PrivateLinkConfig-SecurityGroupArns"></a>
Especifica os nomes de recursos da Amazon (ARN) do grupo de segurança que DataSync fornece acesso ao seu VPC endpoint. 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 **   <a name="DataSync-Type-PrivateLinkConfig-SubnetArns"></a>
Especifica o ARN da sub-rede em que seu 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

 ** VpcEndpointId **   <a name="DataSync-Type-PrivateLinkConfig-VpcEndpointId"></a>
Especifica o ID do endpoint da VPC ao qual seu agente se conecta.  
Tipo: sequência  
Padrão: `^vpce-[0-9a-f]{17}$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/PrivateLinkConfig) 

# QopConfiguration
<a name="API_QopConfiguration"></a>

A configuração da Qualidade da Proteção (QOP) especifica as configurações de privacidade da Chamada de Procedimento Remoto (RPC) e da transferência de dados definidas no cluster do Sistema de Arquivos Distribuído do Hadoop (HDFS).

## Conteúdo
<a name="API_QopConfiguration_Contents"></a>

 ** DataTransferProtection **   <a name="DataSync-Type-QopConfiguration-DataTransferProtection"></a>
A configuração de proteção de transferência de dados definida no cluster HDFS. Essa configuração corresponde à configuração `dfs.data.transfer.protection` no arquivo `hdfs-site.xml` do cluster do Hadoop.  
Tipo: String  
Valores Válidos: `DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
Obrigatório: Não

 ** RpcProtection **   <a name="DataSync-Type-QopConfiguration-RpcProtection"></a>
A configuração de proteção de RPC definida no cluster HDFS. Essa configuração corresponde à configuração `hadoop.rpc.protection` no arquivo `core-site.xml` do cluster do Hadoop.  
Tipo: String  
Valores Válidos: `DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/QopConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/QopConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/QopConfiguration) 

# ReportDestination
<a name="API_ReportDestination"></a>

Especifica onde o DataSync carrega o seu [relatório de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Conteúdo
<a name="API_ReportDestination_Contents"></a>

 ** S3 **   <a name="DataSync-Type-ReportDestination-S3"></a>
Especifica o bucket do Amazon S3 onde o DataSync carrega o seu relatório de tarefas.  
Tipo: objeto [ReportDestinationS3](API_ReportDestinationS3.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestination) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestination) 

# ReportDestinationS3
<a name="API_ReportDestinationS3"></a>

[Especifica o bucket do Amazon S3 DataSync onde carrega seu relatório de tarefas.](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)

## Conteúdo
<a name="API_ReportDestinationS3_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-ReportDestinationS3-BucketAccessRoleArn"></a>
Especifica o Amazon Resource Name (ARN) da política do IAM que DataSync permite fazer o upload de um relatório de tarefas para seu bucket do S3. Para obter mais informações, consulte [Permitir DataSync o upload de um relatório de tarefas em um bucket do Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Exigido: Sim

 ** S3BucketArn **   <a name="DataSync-Type-ReportDestinationS3-S3BucketArn"></a>
Especifica o ARN do bucket do S3 DataSync onde carrega seu relatório.  
Tipo: string  
Restrições de comprimento: comprimento máximo de 268.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`   
Exigido: Sim

 ** Subdirectory **   <a name="DataSync-Type-ReportDestinationS3-Subdirectory"></a>
Especifica um prefixo de bucket para seu relatório.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestinationS3) 

# ReportOverride
<a name="API_ReportOverride"></a>

Especifica o nível de detalhe de um aspecto específico do seu [relatório de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) do DataSync.

## Conteúdo
<a name="API_ReportOverride_Contents"></a>

 ** ReportLevel **   <a name="DataSync-Type-ReportOverride-ReportLevel"></a>
Especifica se seu relatório de tarefas inclui somente erros ou acertos e erros.  
Por exemplo, seu relatório pode incluir principalmente apenas o que não transcorreu bem na sua transferência (`ERRORS_ONLY`). Ao mesmo tempo, você deseja verificar se seu [filtro de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) está funcionando corretamente. Neste caso, você pode obter uma lista de quais arquivos o DataSync ignorou com sucesso e se algo que você não queria transferir foi transferido (`SUCCESSES_AND_ERRORS`).  
Tipo: String  
Valores Válidos: `ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverride) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverride) 

# ReportOverrides
<a name="API_ReportOverrides"></a>

O nível de detalhe incluído em cada aspecto do seu [relatório de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) do DataSync.

## Conteúdo
<a name="API_ReportOverrides_Contents"></a>

 ** Deleted **   <a name="DataSync-Type-ReportOverrides-Deleted"></a>
Especifica o nível de relatório para os arquivos, objetos e diretórios que o DataSync tentou excluir em seu local de destino. Isso só se aplica se você [configurar sua tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) para excluir dados no destino que não estejam na origem.  
Tipo: objeto [ReportOverride](API_ReportOverride.md)  
Obrigatório: Não

 ** Skipped **   <a name="DataSync-Type-ReportOverrides-Skipped"></a>
Especifica o nível de relatório dos arquivos, objetos e diretórios que o DataSync tentou ignorar durante a transferência.  
Tipo: objeto [ReportOverride](API_ReportOverride.md)  
Obrigatório: Não

 ** Transferred **   <a name="DataSync-Type-ReportOverrides-Transferred"></a>
Especifica o nível de relatório dos arquivos, objetos e diretórios que o DataSync tentou transferir.  
Tipo: objeto [ReportOverride](API_ReportOverride.md)  
Obrigatório: Não

 ** Verified **   <a name="DataSync-Type-ReportOverrides-Verified"></a>
Especifica o nível de relatório dos arquivos, objetos e diretórios que o DataSync tentou verificar no final da transferência.  
Tipo: objeto [ReportOverride](API_ReportOverride.md)  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverrides) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverrides) 

# ReportResult
<a name="API_ReportResult"></a>

Indica se o DataSync criou um [relatório de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) completo para sua transferência.

## Conteúdo
<a name="API_ReportResult_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-ReportResult-ErrorCode"></a>
Indica o código associado ao erro se o DataSync não conseguir criar um relatório completo.  
Tipo: String  
Obrigatório: Não

 ** ErrorDetail **   <a name="DataSync-Type-ReportResult-ErrorDetail"></a>
Fornece detalhes sobre problemas na criação de um relatório.  
Tipo: String  
Obrigatório: Não

 ** Status **   <a name="DataSync-Type-ReportResult-Status"></a>
Indica se o DataSync ainda está trabalhando no seu relatório, criou um relatório ou não consegue criar um relatório completo.  
Tipo: String  
Valores Válidos: `PENDING | SUCCESS | ERROR`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportResult) 

# S3Config
<a name="API_S3Config"></a>

Especifica o Amazon Resource Name (ARN) AWS Identity and Access Management da função DataSync (IAM) usada para acessar seu bucket do S3.

Para obter mais informações, consulte [Fornecendo DataSync acesso aos buckets do S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).

## Conteúdo
<a name="API_S3Config_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3Config-BucketAccessRoleArn"></a>
Especifica o ARN da função DataSync do IAM usada para acessar seu bucket do S3.  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3Config) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3Config) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3Config) 

# S3ManifestConfig
<a name="API_S3ManifestConfig"></a>

Especifica o bucket do S3 em que você está hospedando o manifesto que deseja AWS DataSync usar. Para obter mais informações e exemplos de configuração, consulte [Especificação do que é DataSync transferido usando um manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Conteúdo
<a name="API_S3ManifestConfig_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3ManifestConfig-BucketAccessRoleArn"></a>
Especifica a função AWS Identity and Access Management (IAM) que permite DataSync acessar seu manifesto. Para obter mais informações, consulte [Fornecendo DataSync acesso ao seu manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Exigido: Sim

 ** ManifestObjectPath **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectPath"></a>
Especifica a chave de objeto do Amazon S3 do manifesto. Isso pode incluir um prefixo (por exemplo, `prefix/my-manifest.csv`).  
Tipo: string  
Restrições de tamanho: tamanho máximo de 4.096.  
Padrão: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Exigido: Sim

 ** S3BucketArn **   <a name="DataSync-Type-S3ManifestConfig-S3BucketArn"></a>
Especifica o nome do recurso da Amazon (ARN) do bucket do S3 onde você está hospedando o manifesto.  
Tipo: string  
Restrições de comprimento: comprimento máximo de 268.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`   
Exigido: Sim

 ** ManifestObjectVersionId **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectVersionId"></a>
Especifica o ID da versão do objeto do manifesto que você deseja DataSync usar. Se você não definir isso, DataSync usa a versão mais recente do objeto.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.  
Padrão: `^.+$`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3ManifestConfig) 

# SmbMountOptions
<a name="API_SmbMountOptions"></a>

Especifica a versão do protocolo do Server Message Block (SMB) que é o AWS DataSync usa para acessar um servidor de arquivos SMB.

## Conteúdo
<a name="API_SmbMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-SmbMountOptions-Version"></a>
Por padrão, o DataSync escolhe automaticamente uma versão do protocolo SMB com base na negociação com seu servidor de arquivos SMB. Você também pode configurar o DataSync para usar uma versão específica do SMB, mas recomendamos fazer isso apenas se o DataSync tiver problemas para negociar automaticamente com o servidor de arquivos SMB.  
Essas são as opções para a configuração da versão do SMB:  
+  `AUTOMATIC` (padrão): o DataSync e o servidor de arquivos SMB negociam a versão mais alta de SMB que suportam mutuamente entre 2.1 e 3.1.1.

  Essa é a opção recomendada. Se, em vez disso, você escolher uma versão específica que seu servidor de arquivos não suporta, você pode receber um erro `Operation Not Supported`.
+  `SMB3`: restringe a negociação do protocolo somente à versão 3.0.2 do SMB.
+  `SMB2`: restringe a negociação do protocolo somente à versão 2.1 do SMB.
+  `SMB2_0`: restringe a negociação do protocolo somente à versão 2.0 do SMB.
+  `SMB1`: restringe a negociação do protocolo somente à versão 1.0 do SMB.
**nota**  
A opção `SMB1` não está disponível ao [criar um local do Amazon FSx para NetApp ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html).
Tipo: String  
Valores Válidos: `AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SmbMountOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SmbMountOptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SmbMountOptions) 

# SourceManifestConfig
<a name="API_SourceManifestConfig"></a>

Especifica o manifesto que você deseja que o AWS DataSync use e onde ele está hospedado. Para obter mais informações e exemplos de configuração, consulte [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Conteúdo
<a name="API_SourceManifestConfig_Contents"></a>

 ** S3 **   <a name="DataSync-Type-SourceManifestConfig-S3"></a>
Especifica o bucket do S3 onde você está hospedando o manifesto.  
Tipo: objeto [S3ManifestConfig](API_S3ManifestConfig.md)  
Obrigatório: Sim

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SourceManifestConfig) 

# TagListEntry
<a name="API_TagListEntry"></a>

Um par chave-valor representando uma única tag que foi aplicada a um recurso da AWS.

## Conteúdo
<a name="API_TagListEntry_Contents"></a>

 ** Key **   <a name="DataSync-Type-TagListEntry-Key"></a>
A chave para a tag de um recurso da AWS.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: : `^[a-zA-Z0-9\s+=._:/-]+$`   
Exigido: Sim

 ** Value **   <a name="DataSync-Type-TagListEntry-Value"></a>
O valor para a tag de um recurso da AWS.  
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

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TagListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagListEntry) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TagListEntry) 

# TaskExecutionFilesFailedDetail
<a name="API_TaskExecutionFilesFailedDetail"></a>

O número de arquivos ou objetos que DataSync falham na preparação, transferência, verificação e exclusão durante a execução da tarefa.

**nota**  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Conteúdo
<a name="API_TaskExecutionFilesFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Delete"></a>
O número de arquivos ou objetos que DataSync não conseguem ser excluídos durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Prepare"></a>
O número de arquivos ou objetos que DataSync não foram preparados durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Transfer"></a>
O número de arquivos ou objetos que DataSync não são transferidos durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Verify **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Verify"></a>
O número de arquivos ou objetos que DataSync não são verificados durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 

# TaskExecutionFilesListedDetail
<a name="API_TaskExecutionFilesListedDetail"></a>

O número de arquivos ou objetos DataSync encontrados em seus locais.

**nota**  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Conteúdo
<a name="API_TaskExecutionFilesListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtDestinationForDelete"></a>
O número de arquivos ou objetos DataSync encontrados no local de destino. Este contador só se aplicará se você [configurar a tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling) para excluir dados no destino que não estejam na origem.  
Tipo: longo  
Obrigatório: não

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtSource"></a>
O número de arquivos ou objetos DataSync encontrados no local de origem.  
+ Com um [manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), DataSync lista somente o que está em seu manifesto (e não tudo em seu local de origem).
+ Com um [filtro](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) de inclusão, DataSync lista somente o que corresponde ao filtro no local de origem.
+ Com um filtro de exclusão, DataSync lista tudo no local de origem antes de aplicar o filtro.
Tipo: longo  
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesListedDetail) 

# TaskExecutionFoldersFailedDetail
<a name="API_TaskExecutionFoldersFailedDetail"></a>

O número de diretórios que DataSync não conseguem listar, preparar, transferir, verificar e excluir durante a execução da tarefa.

**nota**  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Conteúdo
<a name="API_TaskExecutionFoldersFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Delete"></a>
O número de diretórios que DataSync não conseguem ser excluídos durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** List **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-List"></a>
O número de diretórios que DataSync não são listados durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Prepare"></a>
O número de diretórios que DataSync falham na preparação durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Transfer"></a>
O número de diretórios que DataSync não são transferidos durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

 ** Verify **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Verify"></a>
O número de diretórios que DataSync não são verificados durante a execução da tarefa.  
Tipo: longo  
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 

# TaskExecutionFoldersListedDetail
<a name="API_TaskExecutionFoldersListedDetail"></a>

O número de diretórios DataSync encontrados em seus locais.

**nota**  
Aplica-se somente às [tarefas do modo Avançado](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Conteúdo
<a name="API_TaskExecutionFoldersListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtDestinationForDelete"></a>
O número de diretórios DataSync encontrados no seu local de destino. Este contador só se aplicará se você [configurar a tarefa](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling) para excluir dados no destino que não estejam na origem.  
Tipo: longo  
Obrigatório: não

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtSource"></a>
O número de diretórios DataSync encontrados no local de origem.  
+ Com um [manifesto](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), DataSync lista somente o que está em seu manifesto (e não tudo em seu local de origem).
+ Com um [filtro](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) de inclusão, DataSync lista somente o que corresponde ao filtro no local de origem.
+ Com um filtro de exclusão, DataSync lista tudo no local de origem antes de aplicar o filtro.
Tipo: longo  
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 

# TaskExecutionListEntry
<a name="API_TaskExecutionListEntry"></a>

Representa uma única entrada em uma lista de execuções de AWS DataSync tarefas que é retornada com a [ListTaskExecutions](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html)operação.

## Conteúdo
<a name="API_TaskExecutionListEntry_Contents"></a>

 ** Status **   <a name="DataSync-Type-TaskExecutionListEntry-Status"></a>
O status de execução de uma tarefa. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Tipo: string  
Valores válidos: `QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR`   
Obrigatório: não

 ** TaskExecutionArn **   <a name="DataSync-Type-TaskExecutionListEntry-TaskExecutionArn"></a>
O nome do recurso da Amazon (ARN) da execução da tarefa.  
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}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`   
Obrigatório: não

 ** TaskMode **   <a name="DataSync-Type-TaskExecutionListEntry-TaskMode"></a>
O modo de tarefa que você está usando. Para obter mais informações, consulte [Como escolher um modo de tarefa para a transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Tipo: string  
Valores válidos: `BASIC | ENHANCED`   
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionListEntry) 

# TaskExecutionResultDetail
<a name="API_TaskExecutionResultDetail"></a>

Fornece informações detalhadas sobre o resultado da execução de da tarefa do AWS DataSync.

## Conteúdo
<a name="API_TaskExecutionResultDetail_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorCode"></a>
Um erro encontrado pelo DataSync durante a execução da tarefa. Você pode usar essas informações para ajudar a [solucionar problemas](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Tipo: String  
Obrigatório: Não

 ** ErrorDetail **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorDetail"></a>
A descrição detalhada de um erro que o DataSync encontrou durante a execução da tarefa. Você pode usar essas informações para ajudar a [solucionar problemas](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).   
Tipo: String  
Obrigatório: Não

 ** PrepareDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareDuration"></a>
O tempo em milissegundos que a execução da tarefa ficou na etapa de `PREPARING`. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Para tarefas do modo Avançado, o valor é sempre `0`. Para obter mais informações, consulte [Como o DataSync prepara a transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares).  
Tipo: longo  
Intervalo válido: valor mínimo de 0.  
Obrigatório: Não

 ** PrepareStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareStatus"></a>
O status da etapa de `PREPARING` da execução da tarefa. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Tipo: String  
Valores Válidos: `PENDING | SUCCESS | ERROR`   
Obrigatório: Não

 ** TotalDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TotalDuration"></a>
O tempo em milissegundos que a execução da tarefa levou.  
Tipo: longo  
Intervalo válido: valor mínimo de 0.  
Obrigatório: Não

 ** TransferDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferDuration"></a>
O tempo em milissegundos que a execução da tarefa ficou na etapa de `TRANSFERRING`. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Para tarefas do modo Avançado, o valor é sempre `0`. Para obter mais informações, consulte [Como o DataSync transfere os dados](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers).  
Tipo: longo  
Intervalo válido: valor mínimo de 0.  
Obrigatório: Não

 ** TransferStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferStatus"></a>
O status da etapa de `TRANSFERRING` da execução da tarefa. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Tipo: String  
Valores Válidos: `PENDING | SUCCESS | ERROR`   
Obrigatório: Não

 ** VerifyDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyDuration"></a>
O tempo em milissegundos que a execução da tarefa ficou na etapa de `VERIFYING`. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Para tarefas do modo Avançado, o valor é sempre `0`. Para obter mais informações, consulte [Como o DataSync verifica a integridade dos dados](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works).  
Tipo: longo  
Intervalo válido: valor mínimo de 0.  
Obrigatório: Não

 ** VerifyStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyStatus"></a>
O status da etapa de `VERIFYING` da execução da tarefa. Para obter mais informações, consulte [Status da execução de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Tipo: String  
Valores Válidos: `PENDING | SUCCESS | ERROR`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionResultDetail) 

# TaskFilter
<a name="API_TaskFilter"></a>

Você pode usar filtros de API para refinar a lista de recursos retornados por `ListTasks`. Por exemplo, para recuperar todas as tarefas em um local de origem, você pode usar `ListTasks` com o nome do filtro `LocationId` e `Operator Equals` com o ARN para o local.

Para obter mais informações, consulte [Filtragem dos recursos do DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).

## Conteúdo
<a name="API_TaskFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskFilter-Name"></a>
O nome do filtro que está sendo usado. Cada chamada de API é compatível com uma lista de filtros que estão disponíveis para ela. Por exemplo, `LocationId` para `ListTasks`.  
Tipo: String  
Valores Válidos: `LocationId | CreationTime`   
Obrigatório: Sim

 ** Operator **   <a name="DataSync-Type-TaskFilter-Operator"></a>
O operador usado para comparar valores de filtro (por exemplo, `Equals` ou `Contains`).  
Tipo: String  
Valores Válidos: `Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
Obrigatório: Sim

 ** Values **   <a name="DataSync-Type-TaskFilter-Values"></a>
Os valores que você deseja filtrar. Por exemplo, talvez você queira exibir somente tarefas de um local de destino específico.  
Tipo: matriz de strings  
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 255.  
Padrão: : `^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`   
Exigido: Sim

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskFilter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskFilter) 

# TaskListEntry
<a name="API_TaskListEntry"></a>

Representa uma única entrada em uma lista de tarefas. `TaskListEntry`retorna uma matriz que contém uma lista de tarefas quando a [ListTasks](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html)operação é chamada. Uma tarefa inclui os sistemas de arquivos de origem e destino a serem sincronizados e as opções a serem usadas nas tarefas.

## Conteúdo
<a name="API_TaskListEntry_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskListEntry-Name"></a>
O nome da tarefa .  
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

 ** Status **   <a name="DataSync-Type-TaskListEntry-Status"></a>
O status da tarefa.  
Tipo: string  
Valores válidos: `AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE`   
Obrigatório: não

 ** TaskArn **   <a name="DataSync-Type-TaskListEntry-TaskArn"></a>
O nome de recurso da Amazon (ARN) da tarefa.  
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}:task/task-[0-9a-f]{17}$`   
Obrigatório: não

 ** TaskMode **   <a name="DataSync-Type-TaskListEntry-TaskMode"></a>
O modo de tarefa que você está usando. Para obter mais informações, consulte [Como escolher um modo de tarefa para a transferência de dados](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Tipo: string  
Valores válidos: `BASIC | ENHANCED`   
Obrigatório: não

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskListEntry) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskListEntry) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskListEntry) 

# TaskReportConfig
<a name="API_TaskReportConfig"></a>

Especifica como você deseja configurar um relatório de tarefas, que fornece informações detalhadas sobre a transferência AWS DataSync.

Para obter mais informações, consulte [Relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Conteúdo
<a name="API_TaskReportConfig_Contents"></a>

 ** Destination **   <a name="DataSync-Type-TaskReportConfig-Destination"></a>
Especifica o bucket do Amazon S3 onde o DataSync carrega o seu relatório de tarefas. Para obter mais informações, consulte [Relatórios de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access).  
Tipo: objeto [ReportDestination](API_ReportDestination.md)  
Obrigatório: Não

 ** ObjectVersionIds **   <a name="DataSync-Type-TaskReportConfig-ObjectVersionIds"></a>
Especifica se o relatório de tarefas inclui a nova versão de cada objeto transferido para um bucket do S3. Isso só se aplica se você [ativar o controle de versão em seu bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html). Lembre-se de que definir isso como `INCLUDE` pode aumentar a duração da execução da tarefa.  
Tipo: String  
Valores Válidos: `INCLUDE | NONE`   
Obrigatório: Não

 ** OutputType **   <a name="DataSync-Type-TaskReportConfig-OutputType"></a>
Especifica o tipo de relatório de tarefas que você deseja:  
+  `SUMMARY_ONLY`: fornece os detalhes necessários sobre sua tarefa, incluindo o número de arquivos, objetos e diretórios transferidos e a duração da transferência.
+  `STANDARD`: fornece detalhes completos sobre sua tarefa, incluindo uma lista completa de arquivos, objetos e diretórios que foram transferidos, ignorados, verificados e muito mais.
Tipo: String  
Valores Válidos: `SUMMARY_ONLY | STANDARD`   
Obrigatório: Não

 ** Overrides **   <a name="DataSync-Type-TaskReportConfig-Overrides"></a>
Personaliza o nível de relatório para aspectos do seu relatório de tarefas. Por exemplo, seu relatório geralmente pode incluir apenas erros, mas você pode especificar que deseja uma lista de sucessos e erros apenas para os arquivos que o DataSync tentou excluir em seu local de destino.  
Tipo: objeto [ReportOverrides](API_ReportOverrides.md)  
Obrigatório: Não

 ** ReportLevel **   <a name="DataSync-Type-TaskReportConfig-ReportLevel"></a>
Especifica se você deseja que seu relatório de tarefas inclua somente o que deu errado com sua transferência ou uma lista do que foi bem-sucedido ou não.  
+  `ERRORS_ONLY`: um relatório mostra o que o DataSync não conseguiu transferir, ignorar, verificar e excluir.
+  `SUCCESSES_AND_ERRORS`: um relatório mostra o que o DataSync conseguiu ou não transferir, ignorar, verificar e excluir.
Tipo: String  
Valores Válidos: `ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskReportConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskReportConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskReportConfig) 

# TaskSchedule
<a name="API_TaskSchedule"></a>

Configura a tarefa do AWS DataSync para ser executada segundo um [agendamento](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) (a intervalos mínimos de 1 hora).

## Conteúdo
<a name="API_TaskSchedule_Contents"></a>

 ** ScheduleExpression **   <a name="DataSync-Type-TaskSchedule-ScheduleExpression"></a>
Especifica o agendamento da tarefa usando uma expressão cron ou rate.  
Use expressões cron para agendamentos de tarefas executadas em hora e dia específicos. Por exemplo, a expressão cron a seguir cria um agendamento de tarefa que é executada às 8 horas na primeira quarta-feira de cada mês:  
 `cron(0 8 * * 3#1)`   
Use expressões rate para agendamentos de tarefas que devem ser executadas a intervalos regulares. Por exemplo, a expressão rate a seguir cria um agendamento de tarefa que é executada a cada 12 horas:  
 `rate(12 hours)`   
Para obter informações sobre a sintaxe das expressões cron e rate, consulte o [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).  
Tipo: String  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: : `^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$`   
Exigido: Sim

 ** Status **   <a name="DataSync-Type-TaskSchedule-Status"></a>
Especifica se você deseja habilitar ou desabilitar o agendamento da tarefa. O agendamento é habilitado por padrão, mas pode haver situações em que você precise desabilitá-lo. Por exemplo, pode ser necessário pausar uma transferência recorrente para corrigir um problema com a tarefa ou realizar a manutenção do sistema de armazenamento.  
O DataSync pode desabilitar o agendamento automaticamente se houver uma falha recorrente da tarefa com o mesmo erro. Para obter mais informações, consulte [TaskScheduleDetails](https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html).  
Tipo: String  
Valores Válidos: `ENABLED | DISABLED`   
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskSchedule) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskSchedule) 

# TaskScheduleDetails
<a name="API_TaskScheduleDetails"></a>

Fornece informações sobre o [agendamento de tarefas](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) do AWS DataSync.

## Conteúdo
<a name="API_TaskScheduleDetails_Contents"></a>

 ** DisabledBy **   <a name="DataSync-Type-TaskScheduleDetails-DisabledBy"></a>
Indica como o agendamento de tarefas foi desabilitado.  
+  `USER`: o agendamento foi desabilitado manualmente usando a operação [UpdateTask](https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html) ou o console DataSync.
+  `SERVICE`: o agendamento foi automaticamente desabilitado pelo DataSync porque houve uma falha recorrente da tarefa com o mesmo erro.
Tipo: String  
Valores Válidos: `USER | SERVICE`   
Obrigatório: Não

 ** DisabledReason **   <a name="DataSync-Type-TaskScheduleDetails-DisabledReason"></a>
Fornece um motivo se o agendamento de tarefa for desabilitado.  
Se o agendamento for desabilitado pelo `USER`, você verá uma mensagem `Manually disabled by user.`.  
Se o agendamento for desabilitado pelo `SERVICE`, você verá uma mensagem de erro para ajudar a entender por que a tarefa continua apresentando falhas. Para obter mais informações sobre a solução de erros do DataSync, consulte [Troubleshooting issues with DataSync transfers](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Tipo: String  
Restrições de comprimento: comprimento máximo de 8192.  
Padrão: : `^[\w\s.,'?!:;\/=|<>()-]*$`   
Obrigatório: Não

 ** StatusUpdateTime **   <a name="DataSync-Type-TaskScheduleDetails-StatusUpdateTime"></a>
Indica a última vez que o status do agendamento de tarefas foi alterado. Por exemplo, se o DataSync desabilitar automaticamente o agendamento devido a um erro recorrente, você poderá ver quando o agendamento foi desabilitado.  
Tipo: Timestamp  
Obrigatório: Não

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskScheduleDetails) 

# Erros comuns
<a name="CommonErrors"></a>

Esta seção lista os erros comuns às ações de API de todos os serviços da AWS. Para saber os erros específicos de uma ação de API para esse serviço, consulte o tópico sobre a ação de API em questão.

 **AccessDeniedException**   
Você não tem acesso suficiente para executar essa ação.  
Código de Status HTTP: 400

 **IncompleteSignature**   
A assinatura da solicitação não segue os padrões da AWS.  
Código de Status HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
O processamento da solicitação falhou por causa de um erro, uma exceção ou uma falha desconhecida.  
Código de Status HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
A ação ou operação solicitada é inválida. Verifique se a ação foi digitada corretamente.  
Código de Status HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
O certificado X.509 ou o ID de chave de acesso da AWS fornecido não existe em nossos registros.  
Código de status HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Você não tem permissão para realizar esta ação.  
Código de Status HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
O ID da chave de acesso da AWS precisa de uma assinatura do serviço.  
Código de status HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
A solicitação atingiu o serviço mais de 15 minutos após a data na solicitação ou mais de 15 minutos após a data de expiração da solicitação (como para URLs predeterminados), ou a data na solicitação está a mais de 15 minutos no futuro.  
Código de Status HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Falha na solicitação devido a um erro temporário do servidor.  
Código de status HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
A solicitação foi negada devido à limitação da solicitação.  
Código de Status HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
A entrada não atende às restrições especificadas por um serviço da AWS.  
Código de Status HTTP: 400

# Parâmetros gerais
<a name="CommonParameters"></a>

A lista a seguir contém os parâmetros que todas as ações usam para assinar solicitações do Signature versão 4 com uma string de consulta. Todos os parâmetros específicos de uma ação são listados no tópico para a ação. Para obter mais informações sobre o Signature versão 4, consulte [Assinatura de solicitações de API da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) no *Guia do usuário do IAM*.

 **Action**   <a name="CommonParameters-Action"></a>
A ação a ser executada.  
Tipo: string  
Obrigatório: Sim

 **Version**   <a name="CommonParameters-Version"></a>
A versão da API para a qual a solicitação foi escrita, expressa no formato AAAA-MM-DD.  
Tipo: string  
Obrigatório: Sim

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
O algoritmo de hash que foi usado para criar a assinatura da solicitação.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Valores Válidos: `AWS4-HMAC-SHA256`   
Obrigatório: condicional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
O valor de escopo da credencial, uma string que inclui a sua chave de acesso, a data, a região visada, o serviço que está sendo solicitado e uma sequência de encerramento ("aws4\$1request"). O valor é expresso no seguinte formato: *chave\$1acesso*/*AAAAMMDD*/*região*/*serviço*/aws4\$1request.  
Para obter mais informações, consulte [Criação de uma solicitação de API da AWS assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
A data usada para criar a assinatura. O formato deve ser o formato básico ISO 8601 (AAAAMMDD'T'HHMMSS'Z'). Por exemplo, a data/hora a seguir é um valor X-Amz-Date válido: `20120325T120000Z`.  
Condição: X-Amz-Date é opcional para todas as solicitações e pode ser usado para substituir a data usada para assinar solicitações. Se o cabeçalho Date (Data) for especificado no formato básico ISO 8601, o valor X-Amz-Date não será necessário. Quando X-Amz-Date é usado, sempre substitui o valor do cabeçalho Date (Data). Para obter mais informações, consulte [Elementos de uma assinatura de solicitação de API da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) no *Guia do usuário do IAM*.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
O token de segurança temporário que foi obtido por meio de uma chamada para o AWS Security Token Service (AWS STS). Para obter uma lista de serviços que oferecem suporte a credenciais de segurança temporárias do AWS STS, consulte [Serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) no *Guia do usuário do IAM*.  
Condição: se estiver usando credenciais de segurança temporárias do AWS STS, será necessário incluir o token de segurança.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Especifica a assinatura com codificação hexadecimal que foi calculada com base na string a ser assinada e na chave de assinatura derivada.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Especifica todos os cabeçalhos HTTP que foram incluídos como parte da solicitação canônica. Para obter mais informações sobre a especificação de cabeçalhos assinados, consulte [Criação de uma solicitação de API da AWS assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional