StartTaskExecution - AWS DataSync
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosExemplosConsulte também

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

StartTaskExecution

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

Há várias fases na execução de uma tarefa. Para obter mais informações, consulte Status de execução de tarefas.

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

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

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.

Excludes

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 “|” (isto é, um tubo), por exemplo, "/folder1|/folder2".

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 determina quais arquivos incluir ao executar uma tarefa. O padrão deve conter uma única string de filtro que consiste nos padrões a serem incluídos. Os padrões são delimitados por “|” (isto é, um tubo), por exemplo, "/folder1|/folder2".

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

OverrideOptions

Define as configurações da sua AWS DataSync tarefa. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados. Você também pode especificar como DataSync verifica a integridade dos dados, define limites de largura de banda para sua tarefa, entre outras opções.

Cada configuração de tarefa tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhum deles Options antes de iniciar sua tarefa.

Tipo: objeto Options

Obrigatório: não

Tags

Especifica as tags que você deseja aplicar ao nome do recurso da Amazon (ARN) que representa a execução da 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

TaskArn

Especifica o Nome de recurso da Amazon (ARN) da tarefa que deseja iniciar.

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

Obrigatório: Sim

Sintaxe da resposta

{
   "TaskExecutionArn": "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.

TaskExecutionArn

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

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

Exemplo de resposta

Este exemplo ilustra um uso de. StartTaskExecution

{
  "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

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: