Flujos de trabajo
La API de flujos de trabajo permite describir los tipos de datos y la API relacionados con la creación, actualización o visualización de flujos de trabajo en AWS Glue. El historial de ejecución de trabajos está disponible durante 90 días para su flujo de trabajo y ejecución de trabajos.
Tipos de datos
Estructura JobNodeDetails
Los detalles de un nodo de trabajo presente en el flujo de trabajo.
Campos
-
JobRuns
: matriz de objetos JobRun.La información para las ejecuciones de trabajo representada por el nodo de trabajo.
Estructura CrawlerNodeDetails
Los detalles de un nodo de rastreador presente en el flujo de trabajo.
Campos
-
Crawls
: matriz de objetos Rastreo.Una lista de rastreadores representada por el nodo de rastreo.
Estructura TriggerNodeDetails
Los detalles de un nodo de desencadenador presente en el flujo de trabajo.
Campos
-
Trigger
: un objeto Desencadenador.La información del desencadenador representado por el nodo de desencadenador.
Estructura de rastreo
Los detalles de un rastreo en el flujo de trabajo.
Campos
-
State
: cadena UTF-8 (valores válidos:RUNNING
|CANCELLING
|CANCELLED
|SUCCEEDED
|FAILED
|ERROR
).El estado del rastreador.
-
StartedOn
: marca temporal.La fecha y hora en las que se inició el rastreo.
-
CompletedOn
: marca temporal.La fecha y hora en las que se completó el rastreo.
-
ErrorMessage
: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.El mensaje de error asociado con el rastreo.
-
LogGroup
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el Log group string pattern.El grupo de registros asociado al rastreo.
-
LogStream
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el Log-stream string pattern.El flujo de registros asociado al rastreo.
Estructura de nodos
Un nodo representa un componente de AWS Glue (desencadenador, rastreador o trabajo) en un gráfico de flujo de trabajo.
Campos
-
Type
: cadena UTF-8 (valores válidos:CRAWLER
|JOB
|TRIGGER
).El tipo de componente de AWS Glue representado por el nodo.
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del componente de AWS Glue representado por el nodo.
-
UniqueId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID exclusivo asignado al nodo en el flujo de trabajo.
-
TriggerDetails
: un objeto TriggerNodeDetails.Detalles del desencadenador cuando el nodo representa a un desencadenador.
-
JobDetails
: un objeto JobNodeDetails.Detalles del trabajo cuando el nodo representa a un trabajo.
-
CrawlerDetails
: un objeto CrawlerNodeDetails.Detalles del rastreador cuando el nodo representa a un rastreador.
Estructura perimetral
Un borde representa una conexión dirigida entre dos componentes de AWS Glue que forman parte del flujo de trabajo al que pertenece el borde.
Campos
-
SourceId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nodo único dentro del flujo de trabajo en el que se inicia el perímetro.
-
DestinationId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El único del nodo en el flujo de trabajo donde finaliza el perímetro.
Estructura de flujo de trabajo
Un flujo de trabajo es una recopilación de varios trabajos y rastreadores de AWS Glue que se ejecutan para completar una tarea ETL compleja. Los flujos de trabajo administran la ejecución y monitoreo de todos sus trabajos y rastreadores.
Campos
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo.
-
Description
: cadena UTF-8.Una descripción del flujo de trabajo.
-
DefaultRunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Una colección de propiedades que se va a utilizar como parte de cada ejecución del flujo de trabajo. Las propiedades de ejecución están disponibles para cada trabajo del flujo de trabajo. Un trabajo puede modificar las propiedades de los siguientes trabajos en el flujo.
-
CreatedOn
: marca temporal.La fecha y hora en las que se ha creado el flujo de trabajo.
-
LastModifiedOn
: marca temporal.La fecha y hora en las que se ha modificado el flujo de trabajo por última vez.
-
LastRun
: un objeto WorkflowRun.La información sobre la última ejecución del flujo de trabajo.
-
Graph
: un objeto WorkflowGraph.El gráfico que representa todos los componentes de AWS Glue que pertenecen al flujo de trabajo como nodos y conexiones dirigidas entre ellos como bordes.
-
CreationStatus
: cadena UTF-8 (valores válidos:CREATING
|CREATED
|CREATION_FAILED
).El estado de creación del flujo de trabajo.
-
MaxConcurrentRuns
: número (entero).Puede utilizar este parámetro para evitar varias actualizaciones no deseadas de datos, para controlar los costos o, en algunos casos, para evitar que se supere el número máximo de ejecuciones concurrentes de cualquiera de los trabajos de los componentes. Si deja este parámetro en blanco, no hay límite en el número de ejecuciones concurrentes de flujos de trabajo.
-
BlueprintDetails
: un objeto BlueprintDetails.Esta estructura indica los detalles del proyecto desde el que se crea este flujo de trabajo en particular.
Estructura WorkflowGraph
Un gráfico de flujo de trabajo representa el flujo de trabajo completo que contiene todos los componentes de AWS Glue presentes en el flujo de trabajo y todas las conexiones dirigidas entre ellos.
Campos
Estructura WorkflowRun
Una ejecución de flujo de trabajo proporciona toda la información sobre el tiempo de ejecución.
Campos
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se ejecutó.
-
WorkflowRunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de esta ejecución de flujo de trabajo.
-
PreviousRunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución de flujo de trabajo anterior.
-
WorkflowRunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Las propiedades de ejecución de flujo de trabajo que se establecieron durante la ejecución.
-
StartedOn
: marca temporal.La fecha y hora en las que se inició la ejecución de flujo de trabajo.
-
CompletedOn
: marca temporal.La fecha y hora en las que se completó la ejecución de flujo de trabajo.
-
Status
: cadena UTF-8 (valores válidos:RUNNING
|COMPLETED
|STOPPING
|STOPPED
|ERROR
).El estado de la ejecución de flujo de trabajo.
-
ErrorMessage
: cadena UTF-8.Este mensaje de error describe cualquier error que se haya producido al iniciar la ejecución del flujo de trabajo. Actualmente, el único mensaje de error es “Concurrent runs exceeded for workflow:
foo
(Exceso de ejecuciones simultáneas para el flujo de trabajo: foo)”. -
Statistics
: un objeto WorkflowRunStatistics.Las estadísticas de la ejecución.
-
Graph
: un objeto WorkflowGraph.El gráfico que representa todos los componentes de AWS Glue que pertenecen al flujo de trabajo como nodos y conexiones dirigidas entre ellos como bordes.
-
StartingEventBatchCondition
: un objeto StartingEventBatchCondition.La condición del lote que inició la ejecución del flujo de trabajo.
Estructura WorkflowRunStatistics
Las estadísticas de ejecución de flujo de trabajo proporcionan estadísticas sobre la ejecución de flujo de trabajo.
Campos
-
TotalActions
: número (entero).Número total de acciones en la ejecución de flujo de trabajo.
-
TimeoutActions
: número (entero).Número total de acciones para las que se agotó el tiempo de espera.
-
FailedActions
: número (entero).Número total de acciones erróneas.
-
StoppedActions
: número (entero).Número total de acciones detenidas.
-
SucceededActions
: número (entero).Número total de acciones correctas.
-
RunningActions
: número (entero).Número total de acciones en estado de ejecución.
-
ErroredActions
: número (entero).Indica el recuento de ejecuciones de trabajos en estado ERROR en la ejecución del flujo de trabajo.
-
WaitingActions
: número (entero).Indica el recuento de ejecuciones de trabajos en estado WAITING (EN ESPERA) en la ejecución del flujo de trabajo.
Estructura StartingEventBatchCondition
La condición del lote que inició la ejecución del flujo de trabajo. El número de eventos indicado en el tamaño del lote llegó, en cuyo caso el miembro BatchSize es distinto de cero, o la ventana del lote venció, en cuyo caso el miembro BatchWindow es distinto de cero.
Campos
-
BatchSize
: número (entero).Número de eventos en el lote.
-
BatchWindow
: número (entero).Duración en segundos de la ventana del lote.
Estructura de proyecto
Los detalles de un proyecto.
Campos
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
Description
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo.Descripción del proyecto.
-
CreatedOn
: marca temporal.La fecha y la hora en que se registró el proyecto.
-
LastModifiedOn
: marca temporal.La fecha y hora en la que se modificó el proyecto por última vez.
-
ParameterSpec
: cadena UTF-8, con 1 byte de largo como mínimo y 131 072 bytes de largo como máximo.Cadena JSON que indica la lista de especificaciones de parámetros para el proyecto.
-
BlueprintLocation
: cadena UTF-8.Especifica la ruta en Amazon S3 donde se publica el proyecto.
-
BlueprintServiceLocation
: cadena UTF-8.Especifica una ruta en Amazon S3 donde se copia el proyecto cuando se llama a
CreateBlueprint/UpdateBlueprint
para registrar el proyecto en AWS Glue. -
Status
: cadena UTF-8 (valores válidos:CREATING
|ACTIVE
|UPDATING
|FAILED
).El estado del registro del proyecto.
-
Creating (Creación): el registro del proyecto está en curso.
-
Active (Activo): el proyecto se ha registrado correctamente.
-
Updating (Actualización): está en curso una actualización al registro del proyecto.
-
Failed (Error): error en el registro del proyecto.
-
-
ErrorMessage
: cadena UTF-8.Mensaje de error.
-
LastActiveDefinition
: un objeto LastActiveDefinition.Cuando hay varias versiones de un proyecto y la última versión tiene algunos errores, este atributo indica la última definición del proyecto correcta que está disponible con el servicio.
Estructura BlueprintDetails
Los detalles de un proyecto.
Campos
-
BlueprintName
: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
RunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de ejecución de este proyecto.
Estructura LastActiveDefinition
Cuando hay varias versiones de un proyecto y la última versión tiene algunos errores, este atributo indica la última definición del proyecto correcta que está disponible con el servicio.
Campos
-
Description
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo.Descripción del proyecto.
-
LastModifiedOn
: marca temporal.La fecha y hora en la que se modificó el proyecto por última vez.
-
ParameterSpec
: cadena UTF-8, con 1 byte de largo como mínimo y 131 072 bytes de largo como máximo.Una cadena JSON que especifica los parámetros para el proyecto.
-
BlueprintLocation
: cadena UTF-8.Especifica una ruta en Amazon S3 donde el desarrollador de AWS Glue publica el proyecto.
-
BlueprintServiceLocation
: cadena UTF-8.Especifica una ruta en Amazon S3 donde se copia el esquema cuando se crea o actualiza el esquema.
Estructura BlueprintRun
Los detalles de una ejecución del proyecto.
Campos
-
BlueprintName
: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
RunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de ejecución de esta ejecución del proyecto.
-
WorkflowName
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre de un flujo de trabajo que se crea como resultado de una ejecución correcta del proyecto. Si la ejecución del proyecto presenta un error, no se creará ningún flujo de trabajo.
-
State
: cadena UTF-8 (valores válidos:RUNNING
|SUCCEEDED
|FAILED
|ROLLING_BACK
).Estado de la ejecución del proyecto. Los valores posibles son los siguientes:
-
Running (Ejecución): la ejecución del proyecto está en curso.
-
Succeeded (Correcta): la ejecución del proyecto se completó correctamente.
-
Failed (Error): la ejecución del proyecto falló y se completó la restauración.
-
Rolling back (Restauración): la ejecución del proyecto falló y la restauración está en curso.
-
-
StartedOn
: marca temporal.La fecha y la hora en las que se inició la ejecución del proyecto.
-
CompletedOn
: marca temporal.La fecha y la hora en las que se completó la ejecución de proyecto.
-
ErrorMessage
: cadena UTF-8.Indica los errores que se detectan al ejecutar el proyecto.
-
RollbackErrorMessage
: cadena UTF-8.Si hay algún error al crear las entidades de un flujo de trabajo, intentamos restaurar las entidades creadas hasta ese punto y eliminarlas. Este atributo indica los errores detectados al intentar eliminar las entidades que se crean.
-
Parameters
: cadena UTF-8, con 1 byte de largo como mínimo y 131 072 bytes de largo como máximo.Los parámetros del proyecto como una cadena. Será necesario que proporcione un valor para cada clave que se requiera a partir de la especificación de parámetros definida en la
Blueprint$ParameterSpec
. -
RoleArn
: cadena UTF-8, con 1 byte como mínimo o más de 1024 bytes de largo, que coincide con el Custom string pattern #30.El ARN del rol. Este rol será asumido por el servicio de AWS Glue y se utilizará para crear el flujo de trabajo y otras entidades de un flujo de trabajo.
Operaciones
Acción CreateWorkflow (Python: create_workflow)
Crea un nuevo flujo de trabajo.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre que se va a asignar al flujo de trabajo. Debe ser único en su cuenta.
-
Description
: cadena UTF-8.Una descripción del flujo de trabajo.
-
DefaultRunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Una colección de propiedades que se va a utilizar como parte de cada ejecución del flujo de trabajo.
Es posible que se registren los argumentos del trabajo. No utilice secretos con formato de texto no cifrado como argumentos. Recupere los secretos desde una conexión de AWS Glue, AWS Secrets Manager u otro mecanismo de administración de secretos si tiene la intención de conservarlos en el trabajo.
-
Tags
: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Las etiquetas que se van a utilizar con este flujo de trabajo.
-
MaxConcurrentRuns
: número (entero).Puede utilizar este parámetro para evitar varias actualizaciones no deseadas de datos, para controlar los costos o, en algunos casos, para evitar que se supere el número máximo de ejecuciones concurrentes de cualquiera de los trabajos de los componentes. Si deja este parámetro en blanco, no hay límite en el número de ejecuciones concurrentes de flujos de trabajo.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del flujo de trabajo que se proporcionó como parte de la solicitud.
Errores
AlreadyExistsException
InvalidInputException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentModificationException
Acción UpdateWorkflow (Python: update_workflow)
Actualiza un flujo de trabajo existente.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se va a actualizar.
-
Description
: cadena UTF-8.La descripción del flujo de trabajo.
-
DefaultRunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Una colección de propiedades que se va a utilizar como parte de cada ejecución del flujo de trabajo.
Es posible que se registren los argumentos del trabajo. No utilice secretos con formato de texto no cifrado como argumentos. Recupere los secretos desde una conexión de AWS Glue, AWS Secrets Manager u otro mecanismo de administración de secretos si tiene la intención de conservarlos en el trabajo.
-
MaxConcurrentRuns
: número (entero).Puede utilizar este parámetro para evitar varias actualizaciones no deseadas de datos, para controlar los costos o, en algunos casos, para evitar que se supere el número máximo de ejecuciones concurrentes de cualquiera de los trabajos de los componentes. Si deja este parámetro en blanco, no hay límite en el número de ejecuciones concurrentes de flujos de trabajo.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del flujo de trabajo que se especificó en la entrada.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ConcurrentModificationException
DeleteWorkflow Action (Python: delete_workflow)
Elimina un flujo de trabajo.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se va a eliminar.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del flujo de trabajo especificado en la entrada.
Errores
InvalidInputException
InternalServiceException
OperationTimeoutException
ConcurrentModificationException
Acción GetWorkFlow (Python: get_workflow)
Recupera metadatos de recursos para un flujo de trabajo.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se va a recuperar.
-
IncludeGraph
: booleano.Especifica si se debe incluir un gráfico cuando se devuelven los metadatos de recursos de flujo de trabajo.
Respuesta
-
Workflow
: un objeto Flujo de trabajo.Metadatos de recursos para el flujo de trabajo.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
Acción ListWorkflows (Python: list_workflows)
Permite enumerar los nombres de flujos de trabajo creados en la cuenta.
Solicitud
-
NextToken
: cadena UTF-8.Token de continuación, si se trata de una solicitud de continuidad.
-
MaxResults
: número (entero), mayor que 1 y menor que 25.Tamaño máximo de una lista que se devolverá.
Respuesta
-
Workflows
: matriz de cadenas UTF-8, con una cadena como mínimo y 25 cadenas como máximo.Lista de nombres de flujos de trabajo en la cuenta.
-
NextToken
: cadena UTF-8.Token de continuación, si no se han devuelto todos los nombres de flujo de trabajo.
Errores
InvalidInputException
InternalServiceException
OperationTimeoutException
Acción BatchGetWorkflows (Python: batch_get_workflows)
Devuelve la lista de metadatos de recursos de una determinada lista de nombres de flujos de trabajo. Después de llamar a la operación ListWorkflows
, puede llamar a esta operación para obtener acceso a los datos a los que ha concedido permisos. Esta operación admite todos los permisos de IAM, incluidas las condiciones de permisos que utilizan etiquetas.
Solicitud
-
Names
– Obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 25 cadenas como máximo.Lista de nombres de flujos de trabajo, que pueden ser los nombres devueltos en la operación
ListWorkflows
. -
IncludeGraph
: booleano.Especifica si se debe incluir un gráfico cuando se devuelven los metadatos de recursos de flujo de trabajo.
Respuesta
-
Workflows
: matriz de objetos Flujo de trabajo, con una estructura como mínimo y 25 estructuras como máximo.Una lista de los metadatos de recursos de flujo de trabajo.
-
MissingWorkflows
: matriz de cadenas UTF-8, con una cadena como mínimo y 25 cadenas como máximo.Una lista de nombres de flujos de trabajo no encontrados.
Errores
InternalServiceException
OperationTimeoutException
InvalidInputException
Acción GetWorkflowRun (Python: get_workflow_run)
Recupera los metadatos para una ejecución de flujo de trabajo especificada. El historial de ejecución de trabajos está disponible durante 90 días para su flujo de trabajo y ejecución de trabajos.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo en ejecución.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución de flujos de trabajo.
-
IncludeGraph
: booleano.Especifica si se debe incluir el gráfico de flujo de trabajo en la respuesta o no.
Respuesta
-
Run
: un objeto WorkflowRun.Los metadatos de ejecución de ejecución de flujo de trabajo solicitados.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
Acción GetWorkflowRuns (Python: get_workflow_runs)
Recupera los metadatos para todas las ejecuciones de un flujo de trabajo especificado.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo cuyos metadatos de ejecuciones deben devolverse.
-
IncludeGraph
: booleano.Especifica si se debe incluir el gráfico de flujo de trabajo en la respuesta o no.
-
NextToken
: cadena UTF-8.Tamaño máximo de la respuesta.
-
MaxResults
: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de ejecuciones de flujo de trabajo que se incluirá en la respuesta.
Respuesta
-
Runs
: matriz de objetos WorkflowRun, con una estructura como mínimo y 1000 estructuras como máximo.Una lista de objetos de metadatos de ejecución de flujo de trabajo.
-
NextToken
: cadena UTF-8.Token de continuación, si no se han devuelto todas las ejecuciones de flujo de trabajo solicitadas.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
Acción GetWorkflowRunProperties (Python: get_workflow_run_properties)
Permite recuperar las propiedades de ejecución de flujo de trabajo que se establecieron durante la ejecución.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se ejecutó.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución de flujo de trabajo cuyas propiedades de ejecución se deben devolver.
Respuesta
-
RunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Las propiedades de ejecución de flujo de trabajo que se establecieron durante la ejecución especificada.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
PutWorkflowRunProperties Action (Python: put_workflow_run_properties)
Permite colocar las propiedades de ejecución del flujo de trabajo especificado para la ejecución del flujo de trabajo determinado. Si una propiedad ya existe para la ejecución especificada, sobrescribe el valor o añade la propiedad a las propiedades existentes.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se ejecutó.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución de flujo de trabajo para el que se deben actualizar las propiedades de ejecución.
-
RunProperties
– Obligatorio: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Las propiedades que colocar para la ejecución especificada.
Es posible que se registren los argumentos del trabajo. No utilice secretos con formato de texto no cifrado como argumentos. Recupere los secretos desde una conexión de AWS Glue, AWS Secrets Manager u otro mecanismo de administración de secretos si tiene la intención de conservarlos en el trabajo.
Respuesta
Sin parámetros de respuesta.
Errores
AlreadyExistsException
EntityNotFoundException
InvalidInputException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentModificationException
Acción CreateBlueprint (Python: create_blueprint)
Registra un proyecto con AWS Glue.
Solicitud
-
Name
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
Description
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo.Una descripción del proyecto.
-
BlueprintLocation
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 8192 bytes de largo como máximo, que coincide con el Custom string pattern #32.Especifica la ruta en Amazon S3 donde se publica el proyecto.
-
Tags
: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Las etiquetas que se van a aplicar a este proyecto.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Devuelve el nombre del proyecto que se registró.
Errores
AlreadyExistsException
InvalidInputException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
Acción UpdateBlueprint (Python: update_blueprint)
Actualiza un proyecto registrado.
Solicitud
-
Name
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
Description
: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo.Una descripción del proyecto.
-
BlueprintLocation
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 8192 bytes de largo como máximo, que coincide con el Custom string pattern #32.Especifica la ruta en Amazon S3 donde se publica el proyecto.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Devuelve el nombre del proyecto que se actualizó.
Errores
EntityNotFoundException
ConcurrentModificationException
InvalidInputException
OperationTimeoutException
InternalServiceException
IllegalBlueprintStateException
Acción DeleteBlueprint (Python: delete_blueprint)
Elimina un proyecto existente.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del proyecto que se va a eliminar.
Respuesta
-
Name
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Devuelve el nombre del proyecto que se eliminó.
Errores
InvalidInputException
OperationTimeoutException
InternalServiceException
Acción ListBlueprints (Python: list_blueprints)
Muestra todos los nombres de proyecto de una cuenta.
Solicitud
-
NextToken
: cadena UTF-8.Token de continuación, si se trata de una solicitud de continuidad.
-
MaxResults
: número (entero), mayor que 1 y menor que 25.Tamaño máximo de una lista que se devolverá.
-
Tags
: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Filtra la lista por una etiqueta de recursos de AWS.
Respuesta
-
Blueprints
: matriz de cadenas UTF-8.Lista de los nombres del proyectos en la cuenta.
-
NextToken
: cadena UTF-8.Un token de continuación, si no se han devuelto todos los nombres de proyectos.
Errores
InvalidInputException
InternalServiceException
OperationTimeoutException
Acción BatchGetBlueprints (Python: batch_get_blueprints)
Recupera información sobre una lista de proyectos.
Solicitud
-
Names
– Obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 25 cadenas como máximo.Una lista de nombres de proyectos.
-
IncludeBlueprint
: booleano.Especifica si se debe incluir el proyecto en la respuesta.
-
IncludeParameterSpec
: booleano.Especifica si se deben incluir los parámetros, como una cadena de JSON, para el proyecto en la respuesta.
Respuesta
-
Blueprints
: matriz de objetos Proyecto.Devuelve una lista de proyectos como un objeto
Blueprints
. -
MissingBlueprints
: matriz de cadenas UTF-8.Devuelve una lista de
BlueprintNames
que no se encontraron.
Errores
InternalServiceException
OperationTimeoutException
InvalidInputException
Acción StartBlueprintRun (Python: start_blueprint_run)
Inicia una nueva ejecución del proyecto especificado.
Solicitud
-
BlueprintName
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
Parameters
: cadena UTF-8, con 1 byte de largo como mínimo y 131 072 bytes de largo como máximo.Especifica los parámetros como un objeto
BlueprintParameters
. -
RoleArn
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el Custom string pattern #30.Especifica el rol de IAM utilizado para crear el flujo de trabajo.
Respuesta
-
RunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de ejecución de esta ejecución del proyecto.
Errores
InvalidInputException
OperationTimeoutException
InternalServiceException
ResourceNumberLimitExceededException
EntityNotFoundException
IllegalBlueprintStateException
Acción GetBlueprintRun (Python: get_blueprint_run)
Recupera los detalles de una ejecución de proyecto.
Solicitud
-
BlueprintName
– Obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #31.El nombre del proyecto.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de ejecución de la ejecución de proyecto que desea recuperar.
Respuesta
-
BlueprintRun
: un objeto BlueprintRun.Devuelve un objeto
BlueprintRun
.
Errores
EntityNotFoundException
InternalServiceException
OperationTimeoutException
Acción GetBlueprintRuns (Python: get_blueprint_runs)
Recupera los detalles de las ejecuciones de proyecto de un proyecto especificado.
Solicitud
-
BlueprintName
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del proyecto.
-
NextToken
: cadena UTF-8.Token de continuación, si se trata de una solicitud de continuidad.
-
MaxResults
: número (entero) que no es inferior a 1 ni es superior a 1000.Tamaño máximo de una lista que se devolverá.
Respuesta
-
BlueprintRuns
: matriz de objetos BlueprintRun.Devuelve una lista de objetos
BlueprintRun
. -
NextToken
: cadena UTF-8.Un token de continuación, si no se han devuelto todas las ejecuciones de proyectos.
Errores
EntityNotFoundException
InternalServiceException
OperationTimeoutException
InvalidInputException
Acción StartWorkflowRun (Python: start_workflow_run)
Inicia una nueva ejecución del flujo de trabajo especificado.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se va a iniciar.
-
RunProperties
: matriz de mapas de pares clave-valor.Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.
Cada valor es una cadena UTF-8.
Las propiedades de ejecución del flujo de trabajo para la ejecución del flujo de trabajo nuevo.
Es posible que se registren los argumentos del trabajo. No utilice secretos con formato de texto no cifrado como argumentos. Recupere los secretos desde una conexión de AWS Glue, AWS Secrets Manager u otro mecanismo de administración de secretos si tiene la intención de conservarlos en el trabajo.
Respuesta
-
RunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Una identificación para la nueva carrera.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ResourceNumberLimitExceededException
ConcurrentRunsExceededException
Acción StopWorkflowRun (Python: stop_workflow_run)
Detiene la ejecución del flujo de trabajo especificado.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se va a detener.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de los flujos de trabajo que se detendrán.
Respuesta
Sin parámetros de respuesta.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
IllegalWorkflowStateException
Acción ResumeWorkflowRun (Python: resume_workflow_run)
Reinicia los nodos seleccionados de una ejecución de flujo de trabajo anterior parcialmente completada y reanuda la ejecución del flujo de trabajo. Se ejecutan los nodos seleccionados y todos los nodos descendentes a los nodos seleccionados.
Solicitud
-
Name
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre del flujo de trabajo que se reanudará.
-
RunId
: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución del flujo de trabajo que se reanudará.
-
NodeIds
– Obligatorio: una matriz de cadenas UTF-8.Una lista de ID de nodos para los nodos que desea reiniciar. Los nodos que se reiniciarán deben tener un intento de ejecución en la ejecución original.
Respuesta
-
RunId
: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nuevo ID asignado a la ejecución del flujo de trabajo reanudado. Cada reanudación de una ejecución de flujo de trabajo tendrá un nuevo ID de ejecución.
-
NodeIds
: matriz de cadenas UTF-8.Una lista de los ID de los nodos para los nodos que realmente se reiniciaron.
Errores
InvalidInputException
EntityNotFoundException
InternalServiceException
OperationTimeoutException
ConcurrentRunsExceededException
IllegalWorkflowStateException