CreateTask - AWS DataSync

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

CreateTask

Configura uma tarefa, que define onde e como AWS DataSync transfere seus dados.

Uma tarefa inclui um local de origem, um local de destino e as preferências de como e quando você deseja transferir seus dados (como limites de largura de banda, agendamento, entre outras opções).

Importante

Se você planeja transferir dados de ou para um local do Amazon S3, analise como isso DataSync pode afetar suas cobranças de solicitação do S3 e a página de DataSync preços antes de começar.

Sintaxe da solicitação

{ "CloudWatchLogGroupArn": "string", "DestinationLocationArn": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "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" }, "SourceLocationArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Parâmetros de solicitação

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

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

CloudWatchLogGroupArn

O nome de recurso da Amazon (ARN) do grupo de CloudWatch log da Amazon usado para monitorar e registrar eventos na tarefa.

Para obter mais informações sobre como usar CloudWatch registros comDataSync, consulte Monitorando sua tarefa no Guia AWS DataSync do usuário.

Para obter mais informações sobre esses grupos, consulte Trabalhando com grupos de log e fluxos de log no Guia do usuário do Amazon CloudWatch Logs.

Tipo: String

Restrições de comprimento: comprimento 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

O nome do recurso da Amazon (ARN) da localização de um recurso de armazenamento da AWS.

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}$

Obrigatório: Sim

Excludes

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

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

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

Name

O nome de uma tarefa. Esse valor é uma referência de texto usada para identificar a tarefa no console.

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

Options

Especifica as opções de configuração para uma tarefa. Algumas opções incluem preservar metadados de arquivos ou de objetos e verificar a integridade dos dados.

Você também pode substituir essas opções antes de iniciar uma execução individual de uma tarefa (também conhecida como execução de tarefa). Para obter mais informações, consulte StartTaskExecution.

Tipo: objeto Options

Obrigatório: não

Schedule

Especifica uma programação usada para transferir periodicamente arquivos de uma origem para um local de destino. A programação deve ser especificada no horário UTC. Para obter mais informações, consulte Programar sua tarefa.

Tipo: objeto TaskSchedule

Obrigatório: não

SourceLocationArn

O nome de recurso da Amazon (ARN) do local de origem 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}:location/loc-[0-9a-z]{17}$

Obrigatório: Sim

Tags

Especifica as tags que você deseja aplicar ao nome do recurso da Amazon (ARN) que representa a tarefa.

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

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

Sintaxe da resposta

{ "TaskArn": "string" }

Elementos de resposta

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

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

TaskArn

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-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 a todas as ações, consulteErros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no AWS DataSync serviço.

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

Exemplo de solicitação

O exemplo a seguir cria uma tarefa usando uma origem e um local de destino.

{ "Options": { "Atime": "BEST_EFFORT", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "Schedule": { "ScheduleExpression": "0 12 ? * SUN,WED *" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb", "Name": "MyTask", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0f01451b140b2af49", "Tags": [{ "Key": "Name", "Value": "Task-1" }] }

Exemplo de resposta

A resposta a seguir retorna o nome de recurso da Amazon (ARN) da tarefa.

{ "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 AWS SDKs específicos de linguagem, consulte o seguinte: