GetCustomerProfile

typed block

Retrieve a customer profile based any search identifier, up to five total. Customer Profiles must be enabled for your Amazon Connect instance. See SearchProfiles in the Amazon Connect Customer Profiles API Reference.

Factories

`GetCustomerProfile`

GetCustomerProfile() -> GetCustomerProfileHandle

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

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

`GetCustomerProfile`

GetCustomerProfile(id: String) -> GetCustomerProfileHandle

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

`profile_request_data`

profile_request_data(value: ProfileRequestData (SingleIdentifier | Search | PhoneNumber | EmailAddress)) -> GetCustomerProfileHandle

Set the ProfileRequestData parameter.

Parameter	Type	Required	Description
`value`	`ProfileRequestData (SingleIdentifier \| Search \| PhoneNumber \| EmailAddress)`	yes

`profile_response_data`

profile_response_data(value?: Map<String, String>) -> GetCustomerProfileHandle

Set the ProfileResponseData parameter.

Parameter	Type	Required	Description
`value`	`Map<String, String>`	no

`next`

next(target: Handle) -> GetCustomerProfileHandle

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_multiple_found`

on_multiple_found(target: Handle) -> GetCustomerProfileHandle

Wire an error transition for MultipleFoundError: if multiple profiles were found for the associated profile search key.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `MultipleFoundError`. if multiple profiles were found for the associated profile search key.

`on_none_found`

on_none_found(target: Handle) -> GetCustomerProfileHandle

Wire an error transition for NoneFoundError: if no profiles were found for the associated profile search key.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoneFoundError`. if no profiles were found for the associated profile search key.

`on_no_matching`

on_no_matching(target: Handle) -> GetCustomerProfileHandle

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

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches.

`set_id`

set_id(id: String) -> GetCustomerProfileHandle

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

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

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

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

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

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

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

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

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