UpdateTask - DataSync AWS
Sintaxe da SolicitaçãoParâmetros da solicitaçãoElementos de RespostaErrosConsulte Também

UpdateTask

Atualiza a configuração de uma tarefa, que define onde e como o AWS DataSync transfere os dados.

Sintaxe da Solicitação

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

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.

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 obter mais informações, consulte 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

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 do IAM com o qual você está usando o DataSync) deve ter a permissão de iam:PassRole. A política AWSDataSyncFullAccess inclui essa permissão.

Para remover uma configuração de manifesto, especifique esse parâmetro como vazio.

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

Indica como sua tarefa de transferência está configurada. Essas opções incluem como o DataSync lida com 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 dessas opções antes de chamar StartTaskExecution.

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

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

TaskArn

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

Exigido: Sim

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 do IAM com o qual você está usando o DataSync) deve ter a permissão de iam:PassRole. A política AWSDataSyncFullAccess inclui essa permissão.

Para remover uma configuração de relatório de tarefa, especifique esse parâmetro como vazio.

Tipo: objeto TaskReportConfig

Obrigatório: Não

Elementos de Resposta

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

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

Consulte Também

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