CreateTask

Configura una tarea que define dónde y cómo se AWS DataSync transfieren los datos.

Una tarea incluye una ubicación de origen, una ubicación de destino y opciones de transferencia (como límites de ancho de banda, la programación, entre otras opciones).

importante

Si planea transferir datos a o desde una ubicación de Amazon S3, consulte cómo DataSync pueden afectar los cargos por solicitud de S3 y la página de DataSync precios antes de empezar.

Sintaxis de la solicitud

{
   "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 de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

CloudWatchLogGroupArn

Especifica el nombre de recurso de Amazon (ARN) de un grupo de CloudWatch registros de Amazon para supervisar la tarea.

En el caso de las tareas del modo mejorado, no necesita especificar nada. DataSyncenvía automáticamente los registros a un grupo de CloudWatch registros denominado/aws/datasync.

Para obtener más información, consulte Supervisar las transferencias de datos con CloudWatch registros.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 562 caracteres.

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

Obligatorio: no

DestinationLocationArn

Especifica el ARN de la ubicación de destino de la transferencia.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^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}$

Obligatorio: sí

Excludes

Especifica los filtros de exclusión que definen los archivos, objetos y carpetas de la ubicación de origen que no se DataSync desean transferir. Para obtener más información y ejemplos, consulte Especificar qué se DataSync transfiere mediante filtros.

Tipo: matriz de objetos FilterRule

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 1 elemento.

Obligatorio: no

Includes

Especifica incluir filtros que definan los archivos, objetos y carpetas de la ubicación de origen que DataSync desea transferir. Para obtener más información y ejemplos, consulte Especificar qué se DataSync transfiere mediante filtros.

Tipo: matriz de objetos FilterRule

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 1 elemento.

Obligatorio: no

ManifestConfig

Configura un manifiesto, que es una lista de archivos u objetos que se desean DataSync transferir. Para obtener más información y ejemplos de configuración, consulte Especificar lo que se DataSync transfiere mediante un manifiesto.

Al usar este parámetro, la identidad de la persona que llama (el rol DataSync con el que estás usando) debe tener el iam:PassRole permiso. La AWSDataSyncFullAccesspolítica incluye este permiso.

Tipo: objeto ManifestConfig

Obligatorio: no

Name

Especifica el nombre de la tarea.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 256 caracteres.

Patrón: ^[a-zA-Z0-9\s+=._:@/-]+$

Obligatorio: no

Options

Especifica la configuración de la tarea, como la conservación de los metadatos de los archivos y la verificación de la integridad de los datos, entre otras opciones.

Tipo: objeto Options

Obligatorio: no

Schedule

Especifica el momento en que quiere que la tarea se ejecute. Para obtener más información, consulte Scheduling your task (Programación de tareas).

Tipo: objeto TaskSchedule

Obligatorio: no

SourceLocationArn

Especifica el ARN de la ubicación de origen de la transferencia.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^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}$

Obligatorio: sí

Tags

Las etiquetas que desea aplicar a la tarea.

Las etiquetas son pares clave-valor que ayudan a administrar, filtrar y buscar los recursos. DataSync

Tipo: matriz de objetos TagListEntry

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 50 artículos.

Obligatorio: no

TaskMode

Especifica uno de los siguientes modos de tarea para la transferencia de datos:

• ENHANCED- Transfiera un número prácticamente ilimitado de objetos con un rendimiento superior al del modo Básico. Las tareas del modo mejorado optimizan el proceso de transferencia de datos al enumerar, preparar, transferir y verificar los datos en paralelo. El modo mejorado está disponible actualmente para transferencias entre ubicaciones de Amazon S3.

  nota

  Para crear una tarea en modo mejorado, la función de IAM que utilice para llamar a la CreateTask operación debe contar con el iam:CreateServiceLinkedRole permiso.

• BASIC(predeterminado): transfiere archivos u objetos entre el AWS almacenamiento y todas las demás DataSync ubicaciones compatibles. Las tareas del modo básico están sujetas a cuotas en cuanto al número de archivos, objetos y directorios de un conjunto de datos. El modo básico prepara, transfiere y verifica los datos de forma secuencial, lo que lo hace más lento que el modo mejorado para la mayoría de las cargas de trabajo.

Para obtener más información, consulte Comprender las diferencias entre los modos de tarea.

Tipo: cadena

Valores válidos: BASIC | ENHANCED

Obligatorio: no

TaskReportConfig

Especifica cómo desea configurar un informe de tareas, que proporciona información detallada sobre la DataSync transferencia. Para obtener más información, consulte Supervisar DataSync las transferencias con informes de tareas.

Al usar este parámetro, la identidad de la persona que llama (el rol DataSync con el que estás usando) debe tener el iam:PassRole permiso. La AWSDataSyncFullAccesspolítica incluye este permiso.

Tipo: objeto TaskReportConfig

Obligatorio: no

Sintaxis de la respuesta

{
   "TaskArn": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

TaskArn

El nombre de recurso de Amazon (ARN) de la tarea.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^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}$

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalException

Esta excepción se produce cuando se genera un error en el servicio AWS DataSync .

Código de estado HTTP: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

Código de estado HTTP: 400

Ejemplos

Ejemplo de solicitud para una tarea en modo mejorado

En el siguiente ejemplo, se crea una DataSync tarea que utiliza el modo mejorado.

A diferencia de cuando se crean tareas en modo Básico, no es necesario especificar un grupo de CloudWatch registros de Amazon. Con las tareas del modo mejorado, envía DataSync automáticamente los registros de tareas a un grupo de registros denominado/aws/datasync. Si ese grupo de registros no existe en su cuenta Región de AWS, DataSync crea el grupo de registros en su nombre al crear la tarea.

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

Ejemplo de solicitud para una tarea en modo básico

En el siguiente ejemplo, se crea una DataSync tarea que utiliza el 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"
        }
    ]
}

Respuesta de ejemplo

La siguiente respuesta incluye el ARN de una tarea creada.

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

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:

• Interfaz de la línea de comandos de AWS

• AWS SDK para .NET

• AWS SDK para C++

• AWS SDK para Go v2

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK para PHP V3

• AWS SDK para Python

• AWS SDK para Ruby V3