Skip to content

FunctionRef

Source code in docs_src/capo_mediatailor/types/function_ref.py 
11
12
13
14
15
16
17
class FunctionRef(TypedDict, closed=True):
    run_condition: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>An optional expression that evaluates to a boolean. MediaTailor evaluates this expression immediately before running the step, using the accumulated state at that point in the sequence. If the expression evaluates to <code>false</code>, MediaTailor skips the step and moves to the next one. If omitted, the step always runs.</p>"""
    function_id: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The identifier of the child function to execute in this step.</p>"""
    alias: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>An optional alternate name for the function within the executor. If omitted, MediaTailor uses the function identifier.</p>"""

alias instance-attribute 

alias: NotRequired[__string]

An optional alternate name for the function within the executor. If omitted, MediaTailor uses the function identifier.

function_id instance-attribute 

function_id: NotRequired[__string]

The identifier of the child function to execute in this step.

run_condition instance-attribute 

run_condition: NotRequired[__string]

An optional expression that evaluates to a boolean. MediaTailor evaluates this expression immediately before running the step, using the accumulated state at that point in the sequence. If the expression evaluates to false, MediaTailor skips the step and moves to the next one. If omitted, the step always runs.