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

StartTaskExecution

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

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

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

{
   "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"
         }
      }
   },
   "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",
   "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.

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

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.

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

Tipo: objeto ManifestConfig

Obrigatório: Não

OverrideOptions

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

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

TaskArn

Especifica o nome do recurso da Amazon (ARN) da tarefa que você 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}$

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

Sintaxe da Resposta

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

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

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

Resposta da amostra

Este exemplo ilustra um uso do 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 SDKs específicos de linguagem AWS, consulte: