InvokeFlowModule

typed block

Invokes a flow module. Flow modules are reusable sections of a flow. You use them to extract repeatable logic across your flows, and create common functions. For more information about flow modules, see Flow modules for reusable functions, in the Amazon Connect Administrator Guide.

Factories

`InvokeFlowModule`

InvokeFlowModule() -> InvokeFlowModuleHandle

Construct a fresh InvokeFlowModule block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`InvokeFlowModule`

InvokeFlowModule(id: String) -> InvokeFlowModuleHandle

Construct a InvokeFlowModule block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`flow_module_id`

flow_module_id(value: String) -> InvokeFlowModuleHandle

Set the FlowModuleId parameter. The flow module ID or flow module ARN to be invoked. May be defined statically or dynamically.

Parameter	Type	Required	Description
`value`	`String`	yes	The flow module ID or flow module ARN to be invoked. May be defined statically or dynamically.

`next`

next(target: Handle) -> InvokeFlowModuleHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`on_no_matching`

on_no_matching(target: Handle) -> InvokeFlowModuleHandle

Wire an error transition for NoMatchingError: if no other Error matches. Connect requires it on InvokeFlowModule deploys.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches. Connect requires it on InvokeFlowModule deploys.

`on_no_matching_condition`

on_no_matching_condition(target: Handle) -> InvokeFlowModuleHandle

Wire an error transition for NoMatchingCondition: if the invoked module returned without matching any of the configured transition branches.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingCondition`. if the invoked module returned without matching any of the configured transition branches.

`on_success`

on_success(target: Handle) -> InvokeFlowModuleHandle

Wire a condition transition for Equals=Success: Route to take when the invoked module ends via EndFlowModuleExecution with a Success result. Compiles to a Transitions.Conditions[] entry matching Operands: ["Success"], so the caller branches on the module's result without hand-writing raw_transitions.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to when the condition matches `Operator=Equals, Operands=[Success]`. Route to take when the invoked module ends via EndFlowModuleExecution with a Success result. Compiles to a Transitions.Conditions[] entry matching Operands: ["Success"], so the caller branches on the module's result without hand-writing raw_transitions.

`on_fail`

on_fail(target: Handle) -> InvokeFlowModuleHandle

Wire a condition transition for Equals=Fail: Route to take when the invoked module ends with a Fail result. Compiles to a Transitions.Conditions[] entry matching Operands: ["Fail"].

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to when the condition matches `Operator=Equals, Operands=[Fail]`. Route to take when the invoked module ends with a Fail result. Compiles to a Transitions.Conditions[] entry matching Operands: ["Fail"].

`set_id`

set_id(id: String) -> InvokeFlowModuleHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> InvokeFlowModuleHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> InvokeFlowModuleHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> InvokeFlowModuleHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> InvokeFlowModuleHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> InvokeFlowModuleHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> InvokeFlowModuleHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> InvokeFlowModuleHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).