ConnectParticipantWithLexBot

typed block

Connects the participant with the specified Amazon Lex bot. When the interaction is over, the Intent and Slots of the bot are available to the flow during its run.

Factories

`ConnectParticipantWithLexBot`

ConnectParticipantWithLexBot() -> ConnectParticipantWithLexBotHandle

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

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

`ConnectParticipantWithLexBot`

ConnectParticipantWithLexBot(id: String) -> ConnectParticipantWithLexBotHandle

Construct a ConnectParticipantWithLexBot 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

`text`

text(value: String) -> ConnectParticipantWithLexBotHandle

Set the Text parameter. Initial prompt the Lex bot uses to greet the caller. May be a literal string or a JSONPath reference (e.g. $.Attributes.LexPrompt).

Parameter	Type	Required	Description
`value`	`String`	yes	Initial prompt the Lex bot uses to greet the caller. May be a literal string or a JSONPath reference (e.g. `$.Attributes.LexPrompt`).

`ssml`

ssml(value?: String) -> ConnectParticipantWithLexBotHandle

Set the SSML parameter. SSML greeting the Lex bot speaks to the caller, as an alternative to the plain Text prompt. May be a literal <speak>…</speak> string or a JSONPath reference. Authored as .ssml("<speak>…</speak>").

Parameter	Type	Required	Description
`value`	`String`	no	SSML greeting the Lex bot speaks to the caller, as an alternative to the plain `Text` prompt. May be a literal `<speak>…</speak>` string or a JSONPath reference. Authored as `.ssml("<speak>…</speak>")`.

`media`

media(value?: Map (Media)) -> ConnectParticipantWithLexBotHandle

Set the Media parameter. S3 audio greeting the Lex bot plays to the caller, as an alternative to the Text/SSML prompts. Authored as .media(#{ MediaType: "Audio", SourceType: "S3", Uri: "s3://…" }).

Parameter	Type	Required	Description
`value`	`Map (Media)`	no	S3 audio greeting the Lex bot plays to the caller, as an alternative to the `Text`/`SSML` prompts. Authored as `.media(#{ MediaType: "Audio", SourceType: "S3", Uri: "s3://…" })`.

`lex_bot`

lex_bot(value?: Map (LexBot)) -> ConnectParticipantWithLexBotHandle

Set the LexBot parameter. Lex v1 bot reference ({Name, Region, Alias}). One of LexBot (v1) or LexV2Bot (v2) is required — they are mutually-exclusive alternatives. Connect validates the wire shape, not the resource (a non-existent bot name still passes deploy). The deploy-gate enforces the at-least-one constraint (registry F47).

Parameter	Type	Required	Description
`value`	`Map (LexBot)`	no	Lex v1 bot reference (`{Name, Region, Alias}`). One of `LexBot` (v1) or `LexV2Bot` (v2) is required — they are mutually-exclusive alternatives. Connect validates the wire shape, not the resource (a non-existent bot name still passes deploy). The deploy-gate enforces the at-least-one constraint (registry F47).

`lex_v2_bot`

lex_v2_bot(value?: Map (LexV2Bot)) -> ConnectParticipantWithLexBotHandle

Set the LexV2Bot parameter. Lex v2 bot reference ({AliasArn}). Mutually exclusive with the v1 LexBot; one of the two is required. Authored as .lex_v2_bot(#{ AliasArn: "arn:aws:lex:…:bot-alias/…" }). Empirically confirmed deployable on the Connect test instance 2026-06-09 (registry F48) — the prior "v2 is rejected by Connect" note was a misattribution of the missing-NextAction rejection (F47).

Parameter	Type	Required	Description
`value`	`Map (LexV2Bot)`	no	Lex v2 bot reference (`{AliasArn}`). Mutually exclusive with the v1 `LexBot`; one of the two is required. Authored as `.lex_v2_bot(#{ AliasArn: "arn:aws:lex:…:bot-alias/…" })`. Empirically confirmed deployable on `the Connect test instance` 2026-06-09 (registry F48) — the prior "v2 is rejected by Connect" note was a misattribution of the missing-NextAction rejection (F47).

`lex_session_attributes`

lex_session_attributes(value?: Map<String, String>) -> ConnectParticipantWithLexBotHandle

Set the LexSessionAttributes parameter. Pre-populated Lex session attributes ({intent: "Welcome"} etc.). Defaults to Strategy::Raw because of the kind: map shape — the typed setter accepts a Rhai map literal directly via Dynamic.

Parameter	Type	Required	Description
`value`	`Map<String, String>`	no	Pre-populated Lex session attributes (`{intent: "Welcome"}` etc.). Defaults to `Strategy::Raw` because of the `kind: map` shape — the typed setter accepts a Rhai map literal directly via `Dynamic`.

`prompt_id`

prompt_id(value?: String) -> ConnectParticipantWithLexBotHandle

Set the PromptId parameter. Prompt the Lex bot plays to greet the caller: a prompt id, a prompt ARN, or a JSONPath reference.

Parameter	Type	Required	Description
`value`	`String`	no	Prompt the Lex bot plays to greet the caller: a prompt id, a prompt ARN, or a JSONPath reference.

`lex_initialization_data`

lex_initialization_data(value?: Map (LexInitializationData)) -> ConnectParticipantWithLexBotHandle

Set the LexInitializationData parameter. Message the Lex bot is initialised with. Authored as .lex_initialization_data(#{ InitialMessage: "…" }).

Parameter	Type	Required	Description
`value`	`Map (LexInitializationData)`	no	Message the Lex bot is initialised with. Authored as `.lex_initialization_data(#{ InitialMessage: "…" })`.

`next`

next(target: Handle) -> ConnectParticipantWithLexBotHandle

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.

`when`

when(cond: ConditionHandle, target: Handle) -> ConnectParticipantWithLexBotHandle

Append a Conditions[] branch. Multiple .when(...) calls chain, evaluation runs in source order, first match wins.

Parameter	Type	Required	Description
`cond`	`ConditionHandle`	yes	Built from the `Cond::<op>(...)` namespace, e.g. `Cond::equals("42")`.
`target`	`Handle`	yes	Block to route to when the condition matches.

`on_no_matching_condition`

on_no_matching_condition(target: Handle) -> ConnectParticipantWithLexBotHandle

Wire an error transition for NoMatchingCondition:

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingCondition`.

`on_no_matching`

on_no_matching(target: Handle) -> ConnectParticipantWithLexBotHandle

Wire an error transition for NoMatchingError:

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`.

`set_id`

set_id(id: String) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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) -> ConnectParticipantWithLexBotHandle

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

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