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

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