ShowView

typed block

Initiates a UI-based workflow that can be surfaced to users of front end applications. This action can be used to create step-by-step guides for agents who are using the Amazon Connect agent workspace.

Factories

ShowView

ShowView() -> ShowViewHandle

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

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

ShowView

ShowView(id: String) -> ShowViewHandle

Construct a ShowView block with an operator-supplied id.

ParameterTypeRequiredDescription
idStringyesWire identifier, typically a Connect UUID restored by decompile so round-trips stay byte-stable.

Methods

view_resource

view_resource(value: Map (ViewResource)) -> ShowViewHandle

Set the ViewResource parameter.

ParameterTypeRequiredDescription
valueMap (ViewResource)yes

invocation_time_limit_seconds

invocation_time_limit_seconds(value: String) -> ShowViewHandle

Set the InvocationTimeLimitSeconds parameter. 400,

ParameterTypeRequiredDescription
valueStringyes400,

view_data

view_data(value?: Map<String, String>) -> ShowViewHandle

Set the ViewData parameter. Operator-defined data map passed to the View resource. Keys and values may be set statically or as JSONPath references; keys are arbitrary view-field names (e.g. CustomerName, AdditionalNotes_Header_Title). The doc-generator inferred a struct with a single Description field from Connect's schema notation, but the wire shape is Map<String, String> (the parameter doc itself says "An optional map of data"). The typed setter accepts a Rhai map literal directly.

ParameterTypeRequiredDescription
valueMap<String, String>noOperator-defined data map passed to the View resource. Keys and values may be set statically or as JSONPath references; keys are arbitrary view-field names (e.g. CustomerName, AdditionalNotes_Header_Title). The doc-generator inferred a struct with a single Description field from Connect's schema notation, but the wire shape is Map<String, String> (the parameter doc itself says "An optional map of data"). The typed setter accepts a Rhai map literal directly.

sensitive_data_configuration

sensitive_data_configuration(value?: Map (SensitiveDataConfiguration)) -> ShowViewHandle

Set the SensitiveDataConfiguration parameter.

ParameterTypeRequiredDescription
valueMap (SensitiveDataConfiguration)no

next

next(target: Handle) -> ShowViewHandle

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

ParameterTypeRequiredDescription
targetHandleyesThe block to route to once this block completes successfully.

when

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

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

ParameterTypeRequiredDescription
condConditionHandleyesBuilt from the Cond::<op>(...) namespace, e.g. Cond::equals("42").
targetHandleyesBlock to route to when the condition matches.

on_no_matching

on_no_matching(target: Handle) -> ShowViewHandle

Wire an error transition for NoMatchingError: if no other Error matches.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingError. if no other Error matches.

on_no_matching_condition

on_no_matching_condition(target: Handle) -> ShowViewHandle

Wire an error transition for NoMatchingCondition: if no other Condition matches.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingCondition. if no other Condition matches.

on_time_limit_exceeded

on_time_limit_exceeded(target: Handle) -> ShowViewHandle

Wire an error transition for TimeLimitExceeded: if there is no response before the configured InvocationTimeLimitSeconds.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on TimeLimitExceeded. if there is no response before the configured InvocationTimeLimitSeconds.

set_id

set_id(id: String) -> ShowViewHandle

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

ParameterTypeRequiredDescription
idStringyesWire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

meta_position

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

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.

ParameterTypeRequiredDescription
xi64yesCanvas X coordinate.
yi64yesCanvas Y coordinate.

set_meta

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

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

ParameterTypeRequiredDescription
keyStringyesWire key name (under Metadata.ActionMetadata[<id>]).
valueDynamicyesAny JSON-serializable Rhai value.

overwrite_meta

overwrite_meta(value: Map) -> ShowViewHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement map for the entire ActionMetadata sub-object.

set_meta_param

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

Set a single per-parameter ActionMetadata flag.

ParameterTypeRequiredDescription
paramStringyesParameter name (e.g. "Text").
flagStringyesFlag name ("useDynamic", "MFLAG_*", etc.).
valueDynamicyesFlag value.

overwrite_meta_param

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> ShowViewHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> ShowViewHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).