CreateTask - DataSync AWS
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosExemplosConsulte também

CreateTask

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, confira como o DataSync pode afetar suas cobranças de solicitação do S3 e a página de preços do DataSync antes de começar.

Sintaxe da Solicitação

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

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

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

CloudWatchLogGroupArn

Especifica o nome do recurso da Amazon (ARN) de um grupo de logs do Amazon CloudWatch para monitorar a tarefa.

Em tarefas do modo Avançado, você não precisa especificar nada. O DataSync envia logs automaticamente a um grupo de logs do CloudWatch chamado /aws/datasync.

Para obter mais informações, consulte Como monitorar transferências de dados com logs do CloudWatch.

Tipo: String

Restrições de tamanho: tamanho máximo de 562.

Padrão: : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

Obrigatório: Não

DestinationLocationArn

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-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Exigido: Sim

Excludes

Especifica os filtros de exclusão que definem os arquivos, os objetos e as pastas do local de origem que você não deseja que o DataSync transfira. Para obter mais informações e exemplos, consulte Specifying what DataSync transfers by using filters.

Tipo: matriz de objetos FilterRule

Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

Obrigatório: Não

Includes

Especifica os filtros de inclusão que definem os arquivos, os objetos e as pastas do local de origem que você deseja que o DataSync transfira. Para obter mais informações e exemplos, consulte Specifying what DataSync transfers by using filters.

Tipo: matriz de objetos FilterRule

Membros da Matriz: número mínimo de 0 itens. Número máximo de 1 item.

Obrigatório: Não

ManifestConfig

Configura um manifesto, que é uma lista dos arquivos ou objetos que você deseja que o DataSync transfira. Para obter mais informações e exemplos de configuração, consulte Specifying what DataSync transfers by using a manifest.

Ao usar esse parâmetro, sua identidade de chamador (o perfil com o qual você está usando o DataSync) deve ter a permissão de iam:PassRole. A política AWSDataSyncFullAccess inclui essa permissão.

Tipo: objeto ManifestConfig

Obrigatório: Não

Name

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

Especifica as configurações da tarefa, como preservar os metadados do arquivo, verificar a integridade dos dados, entre outras opções.

Tipo: objeto Options

Obrigatório: Não

Schedule

Especifica um agendamento de quando você deseja que a tarefa seja executada. Para obter mais informações, consulte Programar sua tarefa.

Tipo: objeto TaskSchedule

Obrigatório: Não

SourceLocationArn

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-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Exigido: Sim

Tags

Especifica as tags que você deseja aplicar à tarefa.

Tags são pares chave-valor que ajudam você a gerenciar, filtrar e pesquisar os recursos do DataSync.

Tipo: matriz de objetos TagListEntry

Membros da Matriz: número mínimo de 0 itens. Número máximo de 50 itens.

Obrigatório: Não

TaskMode

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 armazenamento AWS e todos os outros locais compatíveis do DataSync. As tarefas do modo Básico estão sujeitas a cotas 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.

Tipo: String

Valores Válidos: BASIC | ENHANCED

Obrigatório: Não

TaskReportConfig

Especifica como você deseja configurar um relatório de tarefa, que fornece informações detalhadas sobre a transferência do DataSync. Para obter mais informações, consulte Monitoring your DataSync transfers with task reports.

Ao usar esse parâmetro, sua identidade de chamador (o perfil com o qual você está usando o DataSync) deve ter a permissão de iam:PassRole. A política AWSDataSyncFullAccess inclui essa permissão.

Tipo: objeto TaskReportConfig

Obrigatório: Não

Sintaxe da Resposta

{
   "TaskArn": "string"
}

Elementos de Resposta

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

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-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

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

Solicitação de amostra para uma tarefa no modo Avançado

O exemplo a seguir cria uma tarefa do DataSync 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 logs do Amazon CloudWatch. Nas tarefas do modo Avançado, o DataSync envia automaticamente os logs de tarefas para um grupo de logs chamado /aws/datasync. Se esse grupo de logs não existir no Região da AWS, o DataSync criará o grupo de registros no seu nome quando você 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

O exemplo a seguir cria uma tarefa do DataSync 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 resposta a seguir inclui o ARN de uma tarefa criada.

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

Consulte também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: