DescribeTask - AWS DataSync

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.

DescribeTask

Devuelve metadatos sobre una tarea.

Sintaxis de la solicitud

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

TaskArn

Nombre de recurso de Amazon (ARN) de la tarea que se va a describir.

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

Obligatorio: sí

Sintaxis de la respuesta

{ "CloudWatchLogGroupArn": "string", "CreationTime": number, "CurrentTaskExecutionArn": "string", "DestinationLocationArn": "string", "DestinationNetworkInterfaceArns": [ "string" ], "ErrorCode": "string", "ErrorDetail": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "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" }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "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.

CloudWatchLogGroupArn

Nombre de recurso de Amazon (ARN) del grupo de CloudWatch registro de Amazon que se utilizó para supervisar y registrar eventos en la tarea.

Para obtener más información, consulte Trabajo con grupos de registro y secuencias de registros en la Guía del CloudWatch usuario de Amazon.

Tipo: String

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:([^:\*]*)(:\*)?$

CreationTime

La hora a la que se creó la tarea.

Tipo: Timestamp

CurrentTaskExecutionArn

Nombre de recurso de Amazon (ARN) de la ejecución de la tarea que transfiere archivos.

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

DestinationLocationArn

Nombre de recurso de Amazon (ARN) de ubicación del recurso de AWS almacenamiento.

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}:location/loc-[0-9a-z]{17}$

DestinationNetworkInterfaceArns

Los nombres de recursos de Amazon (ARN) de las interfaces de red que se crearon para la ubicación de destino. Para obtener más información, consulte Requisitos de interfaz de red.

Tipo: matriz de cadenas

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

Patrón: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

ErrorCode

Errores que AWS DataSync se produjeron durante la ejecución de la tarea. Puede usar este código de error para ayudar a solucionar problemas.

Tipo: String

ErrorDetail

Descripción detallada de un error que se encontró durante la ejecución de la tarea. Puede utilizar esta información para ayudar a solucionar problemas.

Tipo: String

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.

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.

Name

El nombre de la tarea que se describió.

Tipo: String

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

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

Options

Las opciones de configuración que controlan el comportamiento de la StartTaskExecution operación. Algunas opciones incluyen conservar los metadatos de archivos u objetos y verificar la integridad de los datos.

Puede anular estas opciones para cada ejecución de la tarea. Para obtener más información, consulte StartTaskExecution.

Tipo: objeto Options

Schedule

La programación que se utiliza para transferir archivos en forma periódica de una ubicación de origen a una de destino.

Tipo: objeto TaskSchedule

SourceLocationArn

Nombre de recurso de Amazon (ARN) de ubicación del sistema de archivos de origen.

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}:location/loc-[0-9a-z]{17}$

SourceNetworkInterfaceArns

Los nombres de recursos de Amazon (ARN) de las interfaces de red que se crearon para la ubicación de origen. Para obtener más información, consulte Requisitos de interfaz de red.

Tipo: matriz de cadenas

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

Patrón: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

Status

El estado de la tarea que se describió.

Para obtener información detallada sobre los estados de ejecución de las tareas, consulte Descripción de los estados de las tareas en la Guía del AWS DataSyncusuario.

Tipo: String

Valores válidos: AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE

TaskArn

Nombre de recurso de Amazon (ARN) de la tarea que se describió.

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

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

Ejemplo

En el siguiente ejemplo, se devuelve información sobre la tarea especificada en la solicitud de ejemplo.

Solicitud de muestra

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

Ejemplo

Este ejemplo ilustra un uso deDescribeTask.

Respuesta de ejemplo

{ "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group" "CreationTime": 1532660733.39, "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb", "ErrorCode": "???????", "ErrorDetail": "??????", "Name": "MyTask", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa", "Status": "CREATING", "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 un SDK de AWS de un lenguaje específico, consulte: