Desencadenadores

La API de desencadenadores describe los tipos de datos y la API relacionados con la creación, actualización o eliminación, y el inicio y la detención de desencadenadores de trabajos en AWS Glue.

Tipos de datos

• Estructura del desencadenador

• Estructura de TriggerUpdate

• Estructura de Predicate

• Estructura de Condition

• Estructura de acción

• Estructura EventBatchingCondition

Estructura del desencadenador

Información sobre un disparador específico.

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 desencadenador.

• 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.

  El nombre del flujo de trabajo asociado con el desencadenador.

• Id: 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.

  Reservado para uso futuro.

• Type: cadena UTF-8 (valores válidos: SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

  Tipo de desencadenador en cuestión.

• State: cadena UTF-8 (valores válidos: CREATING | CREATED | ACTIVATING | ACTIVATED | DEACTIVATING | DEACTIVATED | DELETING | UPDATING).

  Estado actual del disparador.

• Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

  Descripción de este desencadenador.

• Schedule: cadena UTF-8.

  Expresión cron utilizada para especificar el programa (consulte Programaciones basadas en tiempo para trabajos y rastreadores). Por ejemplo, para ejecutar algo todos los días a las 12:15 UTC, especifique: cron(15 12 * * ? *).

• Actions: matriz de objetos Acción.

  Acciones iniciadas por este desencadenador.

• Predicate: un objeto Predicate.

  Predicado de este desencadenador, que define el momento en que se desencadenará.

• EventBatchingCondition: un objeto EventBatchingCondition.

  Condición del lote que debe cumplirse (número especificado de eventos recibidos o ventana de tiempo del lote vencida) antes de que se desencadene el evento EventBridge.

Estructura de TriggerUpdate

Una estructura usada para proporcionar información que se emplea para actualizar un disparador. Este objeto actualizará la definición del disparador anterior sobrescribiéndola por completo.

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.

  Reservado para uso futuro.

• Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

  Descripción de este desencadenador.

• Schedule: cadena UTF-8.

  Expresión cron utilizada para especificar el programa (consulte Programaciones basadas en tiempo para trabajos y rastreadores). Por ejemplo, para ejecutar algo todos los días a las 12:15 UTC, especifique: cron(15 12 * * ? *).

• Actions: matriz de objetos Acción.

  Acciones iniciadas por este desencadenador.

• Predicate: un objeto Predicate.

  Predicado de este desencadenador, que define el momento en que se desencadenará.

• EventBatchingCondition: un objeto EventBatchingCondition.

  Condición del lote que debe cumplirse (número especificado de eventos recibidos o ventana de tiempo del lote vencida) antes de que se desencadene el evento EventBridge.

Estructura de Predicate

Define el predicado del disparador, que determina cuándo se activa este.

Campos

• Logical: cadena UTF-8 (valores válidos: AND | ANY).

  Un campo opcional si solo se indica una condición. Si se indican varias condiciones, este campo es obligatorio.

• Conditions: matriz de objetos Condición.

  Lista de condiciones que determinan cuándo se desencadenará el disparador.

Estructura de Condition

Define una condición en la que se desencadena un desencadenador.

Campos

• LogicalOperator: cadena UTF-8 (valores válidos: EQUALS).

  Operador lógico.

• JobName: 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 trabajo a cuyo JobRuns se aplica esta condición y en el que espera este disparador.

• State: Cadena UTF-8 (valores válidos: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT | ERROR | WAITING | EXPIRED).

  El estado de la condición. Actualmente, los únicos estados de trabajo que un desencadenador puede escuchar son SUCCEEDED, STOPPED, FAILED, y TIMEOUT. Los únicos estados de rastreadores que un disparador puede escuchar son SUCCEEDED, FAILED, y CANCELLED.

• CrawlerName: 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 rastreador al que se aplica esta condición.

• CrawlState: cadena UTF-8 (valores válidos: RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR).

  El estado del rastreador al que se aplica esta condición.

Estructura de acción

Define la acción que un desencadenador iniciará.

Campos

• JobName: 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 trabajo que se ejecutará.

• Arguments: matriz de mapas de pares clave-valor.

  Cada clave es una cadena UTF-8.

  Cada valor es una cadena UTF-8.

  Argumentos de trabajo que se utilizan cuando se activa este desencadenador. En esta ejecución del trabajo, sustituyen a los argumentos predeterminados definidos en la propia definición del trabajo.

  Aquí puede especificar argumentos que su propio script de ejecución de tareas consume, así como argumentos que AWS Glue consume.

  Para obtener información acerca de cómo especificar y utilizar sus propios argumentos de trabajo, consulte Llamadas a las API de AWS Glue en Python en la guía para desarrolladores.

  Para obtener información acerca de los pares clave-valor que AWS Glue utiliza para configurar su trabajo, consulte el tema Parámetros especiales usados por AWS Glue en la guía para desarrolladores.

• Timeout: número (entero), como mínimo 1.

  Tiempo de espera de JobRun en minutos. Es el tiempo máximo que una ejecución de trabajo puede consumir recursos antes de que se termine y cambie al estado TIMEOUT. El valor predeterminado es 2880 minutos (48 horas). Sustituye el valor de tiempo de espera establecido en el flujo de trabajo principal.

• SecurityConfiguration: 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 de la estructura SecurityConfiguration que se va a utilizar con esta acción.

• NotificationProperty: un objeto NotificationProperty.

  Especifica las propiedades de configuración de una notificación de ejecución de trabajo.

• CrawlerName: 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 rastreador que se va a utilizar con esta acción.

Estructura EventBatchingCondition

Condición del lote que debe cumplirse (número especificado de eventos recibidos o ventana de tiempo del lote vencida) antes de que se desencadene el evento EventBridge.

Campos

• BatchSize – Obligatorio: número (entero), que no es inferior a 1 ni es superior a 100.

  Número de eventos que se deben recibir de Amazon EventBridge antes de que se desencadene el evento EventBridge.

• BatchWindow: número (entero), que no es inferior a 1 ni es superior a 900.

  Ventana de tiempo en segundos después de la cual se activa el evento EventBridge. La ventana se inicia cuando se recibe el primer evento.

Operaciones

• Acción CreateTrigger (Python: create_trigger)

• Acción StartTrigger (Python: start_trigger)

• Acción GetTrigger (Python: get_trigger)

• Acción GetTriggers (Python: get_triggers)

• Acción UpdateTrigger (Python: update_trigger)

• Acción StopTrigger (Python: stop_trigger)

• Acción DeleteTrigger (Python: delete_trigger)

• Acción ListTriggers (Python: list_triggers)

• Acción BatchGetTriggers (Python: batch_get_triggers)

Acción CreateTrigger (Python: create_trigger)

Crea un nuevo disparador.

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 desencadenador.

• 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.

  El nombre del flujo de trabajo asociado con el desencadenador.

• Type – Obligatorio: cadena UTF-8 (valores válidos: SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

  Tipo del nuevo disparador.

• Schedule: cadena UTF-8.

  Expresión cron utilizada para especificar el programa (consulte Programaciones basadas en tiempo para trabajos y rastreadores). Por ejemplo, para ejecutar algo todos los días a las 12:15 UTC, especifique: cron(15 12 * * ? *).

  Este campo es obligatorio cuando el tipo de disparador es SCHEDULED.

• Predicate: un objeto Predicate.

  Un predicado para especificar cuándo debe desencadenarse el nuevo disparador.

  Este campo es obligatorio cuando el tipo de disparador es CONDITIONAL.

• Actions (obligatorio): una matriz de objetos Acción.

  Acciones que inicia este disparador cuando se desencadena.

• Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

  Descripción del nuevo disparador.

• StartOnCreation: booleano.

  Establezca este parámetro en true para iniciar los disparadores SCHEDULED y CONDITIONAL cuando se crea. True no es compatible con los disparadores ON_DEMAND.

• 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.

  Etiquetas que se van a utilizar con este desencadenador. Puede utilizar etiquetas para limitar el acceso al desencadenador. Para obtener más información acerca de las etiquetas en AWS Glue, consulte Etiquetas de AWS en AWS Glue en la guía para desarrolladores.

• EventBatchingCondition: un objeto EventBatchingCondition.

  Condición del lote que debe cumplirse (número especificado de eventos recibidos o ventana de tiempo del lote vencida) antes de que se desencadene el evento EventBridge.

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.

  Nombre del desencadenador.

Errores

• AlreadyExistsException

• EntityNotFoundException

• InvalidInputException

• IdempotentParameterMismatchException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

Acción StartTrigger (Python: start_trigger)

Inicia un disparador ya existente. Consulte Activación de trabajos para obtener información acerca de cómo se desencadenan los diferentes tipos de disparadores.

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 disparador que debe iniciarse.

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.

  Nombre del disparador que se inició.

Errores

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentRunsExceededException

Acción GetTrigger (Python: get_trigger)

Recupera la definición de un disparador.

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 disparador que debe recuperarse.

Respuesta

• Trigger: un objeto Desencadenador.

  Definición del disparador solicitada.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Acción GetTriggers (Python: get_triggers)

Obtiene todos los disparadores asociados a un flujo de trabajo.

Solicitud

• NextToken: cadena UTF-8.

  Token de continuación si se trata de una llamada de continuidad.

• DependentJobName: 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 trabajo para recuperar disparadores. Se devolverá el disparador que puede iniciar este trabajo y, si dicho disparador no existe, se devolverán todos los disparadores.

• MaxResults: número (entero), mayor que 1 y menor que 200.

  Tamaño máximo de la respuesta.

Respuesta

• Triggers: matriz de objetos Desencadenador.

  Lista de disparadores para el flujo de trabajo especificado.

• NextToken: cadena UTF-8.

  Token de continuación si todavía no se han devuelto todos los disparadores solicitados.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Acción UpdateTrigger (Python: update_trigger)

Actualiza una definición de disparador.

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 disparador que debe actualizarse.

• TriggerUpdate: obligatorio: objeto TriggerUpdate.

  Nuevos valores con los que se actualizará el disparador.

Respuesta

• Trigger: un objeto Desencadenador.

  Definición del disparador resultante.

Errores

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ConcurrentModificationException

Acción StopTrigger (Python: stop_trigger)

Detiene un disparador 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 disparador que debe detenerse.

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.

  Nombre del disparador que se detuvo.

Errores

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ConcurrentModificationException

Acción DeleteTrigger (Python: delete_trigger)

Elimina un disparador especificado. Si no se encuentra el disparador, no se genera una excepció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 disparador 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.

  Nombre del disparador que se eliminó.

Errores

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

Acción ListTriggers (Python: list_triggers)

Recupera los nombres de todos los recursos de desencadenadores de esta cuenta de AWS o los recursos con la etiqueta especificada. Esta operación permite ver qué recursos están disponibles en la cuenta y sus nombres.

Esta operación toma el campo Tags opcional, que se puede utilizar como filtro en la respuesta para que los recursos etiquetados se devuelvan agrupados. Si decide utilizar el filtrado de etiquetas, solo se devolverán los recursos con la etiqueta especificada.

Solicitud

• NextToken: cadena UTF-8.

  Token de continuación, si se trata de una solicitud de continuidad.

• DependentJobName: 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 trabajo para el que se quieren recuperar disparadores. Se devuelve el disparador que puede comenzar este trabajo. Si no existe dicho disparador, se devuelven todos los disparadores.

• MaxResults: número (entero), mayor que 1 y menor que 200.

  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.

  Especifica que se devuelvan solamente los recursos etiquetados.

Respuesta

• TriggerNames: matriz de cadenas UTF-8.

  Nombres de todos los disparadores de la cuenta o de los disparadores con las etiquetas especificadas.

• NextToken: cadena UTF-8.

  Token de continuación, si la lista devuelta no contiene la última métrica disponible.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Acción BatchGetTriggers (Python: batch_get_triggers)

Devuelve la lista de metadatos de recursos de una determinada lista de nombres de disparadores. Después de llamar a la operación ListTriggers, 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

• TriggerNames – Obligatorio: una matriz de cadenas UTF-8.

  Lista de nombres de disparadores, que pueden ser los nombres devueltos en la operación ListTriggers.

Respuesta

• Triggers: matriz de objetos Desencadenador.

  Lista de definiciones de disparadores.

• TriggersNotFound: matriz de cadenas UTF-8.

  No se encuentra ninguna lista de nombres de disparadores.

Errores

• InternalServiceException

• OperationTimeoutException

• InvalidInputException