DescribeExecution - AWS Transfer Family

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.

DescribeExecution

Puede utilizar DescribeExecution para comprobar los detalles de la ejecución del flujo de trabajo especificado.

nota

Esta API llamada solo devuelve detalles de los flujos de trabajo en curso.

Si proporciona un identificador para una ejecución que no está en curso o si la ejecución no coincide con el identificador del flujo de trabajo especificado, recibirá una excepción ResourceNotFound.

Sintaxis de la solicitud

{ "ExecutionId": "string", "WorkflowId": "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 JSON formato.

ExecutionId

Un identificador único para la ejecución del flujo de trabajo.

Tipo: cadena

Limitaciones de longitud: longitud fija de 36.

Patrón: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Obligatorio: sí

WorkflowId

Un identificador único para el flujo de trabajo.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: w-([a-z0-9]{17})

Obligatorio: sí

Sintaxis de la respuesta

{ "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "string" }

Elementos de respuesta

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

El servicio devuelve los siguientes datos en JSON formato.

Execution

La estructura que contiene los detalles de la ejecución del flujo de trabajo.

Tipo: objeto DescribedExecution

WorkflowId

Un identificador único para el flujo de trabajo.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: w-([a-z0-9]{17})

Errores

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

InternalServiceError

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

HTTPCódigo de estado: 500

InvalidRequestException

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

HTTPCódigo de estado: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

HTTPCódigo de estado: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

HTTPCódigo de estado: 500

Véase también

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