DescribeTaskExecution - AWS DataSync
Sintaxis de la solicitudParámetros de solicitudSintaxis de la respuestaElementos de respuestaErroresEjemplosVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeTaskExecution

Devuelve los metadatos detallados de una tarea que se está ejecutando.

Sintaxis de la solicitud

{
   "TaskExecutionArn": "string"
}

Parámetros de 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.

TaskExecutionArn

El nombre de recurso de Amazon (ARN) de la tarea que se está ejecutando.

Tipo: String

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}/execution/exec-[0-9a-f]{17}$

Obligatorio: sí

Sintaxis de la respuesta

{
   "BytesCompressed": number,
   "BytesTransferred": number,
   "BytesWritten": number,
   "EstimatedBytesToTransfer": number,
   "EstimatedFilesToTransfer": number,
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "FilesTransferred": number,
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "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"
   },
   "Result": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "PrepareDuration": number,
      "PrepareStatus": "string",
      "TotalDuration": number,
      "TransferDuration": number,
      "TransferStatus": "string",
      "VerifyDuration": number,
      "VerifyStatus": "string"
   },
   "StartTime": number,
   "Status": "string",
   "TaskExecutionArn": "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.

BytesCompressed

El número físico de bytes transferidos a través de la red después de aplicar la compresión. En la mayoría de los casos, este número es inferior BytesTransferred a, a menos que los datos no se puedan comprimir.

Tipo: largo

BytesTransferred

El número total de bytes que intervienen en la transferencia. El número de bytes enviados a través de la red, consulteBytesCompressed.

Tipo: largo

BytesWritten

El número de bytes lógicos escritos en el recurso AWS de almacenamiento de destino.

Tipo: largo

EstimatedBytesToTransfer

El número físico estimado de bytes que se van a transferir a través de la red.

Tipo: largo

EstimatedFilesToTransfer

El número esperado de archivos que se van a transferir a través de la red. Este valor se calcula durante la PREPARING fase anterior a la TRANSFERRING fase de ejecución de la tarea. Este valor es el número esperado de archivos que se van a transferir. Se calcula comparando el contenido de las ubicaciones de origen y destino y encontrando el delta que se debe transferir.

Tipo: largo

Excludes

Una lista de reglas de filtrado que excluyen datos específicos durante la transferencia. Para obtener más información y ejemplos, consulte Filtrar los datos transferidos por DataSync.

Tipo: Matriz de objetos FilterRule

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

FilesTransferred

La cantidad real de archivos que se transfirieron a través de la red. Este valor se calcula y actualiza de forma continua durante la TRANSFERRING fase de ejecución de la tarea. Se actualiza periódicamente cuando se lee cada archivo de la fuente y se envía a través de la red.

Si se producen errores durante una transferencia, este valor puede ser inferior a EstimatedFilesToTransfer. En algunos casos, este valor también puede ser superior aEstimatedFilesToTransfer. Este elemento es específico de la implementación para algunos tipos de ubicación, por tanto, no lo utilice como indicador para un número de archivo correcto o para monitorizar la ejecución de tareas.

Tipo: largo

Includes

Una lista de reglas de filtrado que incluyen datos específicos durante la transferencia. Para obtener más información y ejemplos, consulte Filtrar los datos transferidos por DataSync.

Tipo: Matriz de objetos FilterRule

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

Options

Configura los ajustes de las AWS DataSync tareas. Estas opciones incluyen cómo DataSync gestiona los archivos, los objetos y sus metadatos asociados. También puede especificar cómo DataSync verifica la integridad de los datos, establecer límites de ancho de banda para su tarea, entre otras opciones.

La configuración de tareas tiene un valor predeterminado. A menos que lo necesite, no tiene que configurar ninguna de estas opciones Options antes de iniciar la tarea.

Tipo: objeto Options

Result

El resultado de la ejecución de tareas.

Tipo: objeto TaskExecutionResultDetail

StartTime

La hora en que se inició la ejecución de la tarea.

Tipo: Timestamp

Status

El estado de ejecución de tareas.

Para obtener información detallada sobre los estados de ejecución de las tareas, consulte Comprender los estados de las tareas.

Tipo: String

Valores válidos: QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

El nombre de recurso de Amazon (ARN) de la ejecución de tareas que se describió. TaskExecutionArnes jerárquico e incluye TaskArn la tarea que se ejecutó.

Por ejemplo, un TaskExecution valor con el ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b ejecutó la tarea con el ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Tipo: String

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}/execution/exec-[0-9a-f]{17}$

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

InternalException

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

Código de estado HTTP: 500

InvalidRequestException

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

Código de estado HTTP: 400

Ejemplos

Solicitud de muestra

Este ejemplo ilustra una DescribeTaskExecution solicitud.

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

Respuesta de ejemplo

Este ejemplo ilustra una DescribeTaskExecution respuesta.

{
   "BytesCompressed": "3500",
   "BytesTransferred": "5000",
   "BytesWritten": "5000",
   "EstimatedBytesToTransfer": "5000",
   "EstimatedFilesToTransfer": "100",
   "FilesTransferred": "100",
   "Result": { 
      "ErrorCode": "??????",
      "ErrorDetail": "??????",
      "PrepareDuration": "100",
      "PrepareStatus": "SUCCESS",
      "TransferDuration": "60",
      "TransferStatus": "AVAILABLE",
      "VerifyDuration": "30",
      "VerifyStatus": "SUCCESS"
   },
   "StartTime": "1532660733.39",
   "Status": "SUCCESS",
   "OverrideOptions": { 
      "Atime": "BEST_EFFORT",
      "BytesPerSecond": "1000",
      "Gid": "NONE",
      "Mtime": "PRESERVE",
      "PosixPermissions": "PRESERVE",
      "PreserveDevices": "NONE",
      "PreserveDeletedFiles": "PRESERVE",
      "Uid": "NONE",
      "VerifyMode": "POINT_IN_TIME_CONSISTENT"
   },
   "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: