Skip to content

Trigger

Source code in docs_src/capo_glue/types/trigger.py
class Trigger(TypedDict, closed=True):
    name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the trigger.</p>"""
    workflow_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the workflow associated with the trigger.</p>"""
    id: NotRequired["capo_glue.types.id_string.IdString"]
    """<p>Reserved for future use.</p>"""
    type: NotRequired["capo_glue.types.trigger_type.TriggerType"]
    """<p>The type of trigger that this is.</p>"""
    state: NotRequired["capo_glue.types.trigger_state.TriggerState"]
    """<p>The current state of the trigger.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>A description of this trigger.</p>"""
    schedule: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A <code>cron</code> expression used to specify the schedule (see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run something every day at 12:15 UTC, you would specify: <code>cron(15 12 * * ? *)</code>.</p>"""
    actions: NotRequired["capo_glue.types.action_list.ActionList"]
    """<p>The actions initiated by this trigger.</p>"""
    predicate: NotRequired["capo_glue.types.predicate.Predicate"]
    """<p>The predicate of this trigger, which defines when it will fire.</p>"""
    event_batching_condition: NotRequired[
        "capo_glue.types.event_batching_condition.EventBatchingCondition"
    ]
    """<p>Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.</p>"""

actions instance-attribute

actions: NotRequired[ActionList]

The actions initiated by this trigger.

description instance-attribute

description: NotRequired[DescriptionString]

A description of this trigger.

event_batching_condition instance-attribute

event_batching_condition: NotRequired[EventBatchingCondition]

Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

id instance-attribute

id: NotRequired[IdString]

Reserved for future use.

name instance-attribute

name: NotRequired[NameString]

The name of the trigger.

predicate instance-attribute

predicate: NotRequired[Predicate]

The predicate of this trigger, which defines when it will fire.

schedule instance-attribute

schedule: NotRequired[GenericString]

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

state instance-attribute

state: NotRequired[TriggerState]

The current state of the trigger.

type instance-attribute

type: NotRequired[TriggerType]

The type of trigger that this is.

workflow_name instance-attribute

workflow_name: NotRequired[NameString]

The name of the workflow associated with the trigger.