TagContact

typed block

Sets a collection of tag to the current contact. With this type of operation, either all tags are set or none are set. Each tag on a contact is a key-value pair, that is, it is composed of a key and a value. There are two types of tags: user-defined tags and system tags. You create a user-defined tag. A system tag is automatically created by AWS services. A system tag is prefixed with aws:. You cannot change it. The TagContact action parameters correspond to user-defined tags that are applied on a contact.

Factories

TagContact

TagContact() -> TagContactHandle

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

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

TagContact

TagContact(id: String) -> TagContactHandle

Construct a TagContact block with an operator-supplied id.

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

Methods

tags

tags(value: Map<String, String>) -> TagContactHandle

Set the Tags parameter. Tags map written onto the contact for downstream routing / reporting. Keys are arbitrary tag names; values are tag values. The doc-generator originally inferred a struct-with-Key1/Value1/Key2/… field shape from Connect's { "Key1": "Value1", "Key2": "Value2", … } schema notation; the wire shape is genuinely Map<String, String> so the typed setter accepts a Rhai map literal directly via Dynamic.

ParameterTypeRequiredDescription
valueMap<String, String>yesTags map written onto the contact for downstream routing / reporting. Keys are arbitrary tag names; values are tag values. The doc-generator originally inferred a struct-with-Key1/Value1/Key2/… field shape from Connect's { "Key1": "Value1", "Key2": "Value2", … } schema notation; the wire shape is genuinely Map<String, String> so the typed setter accepts a Rhai map literal directly via Dynamic.

next

next(target: Handle) -> TagContactHandle

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.

on_no_matching

on_no_matching(target: Handle) -> TagContactHandle

Wire an error transition for NoMatchingError: Route to take when Connect rejects the TagContact action (most commonly: malformed tags map or downstream tag-quota violation).

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingError. Route to take when Connect rejects the TagContact action (most commonly: malformed tags map or downstream tag-quota violation).

set_id

set_id(id: String) -> TagContactHandle

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

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

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

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

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> TagContactHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> TagContactHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).