UpdateContactTextToSpeechVoice

typed block

Updates the Amazon Polly voice used by text-to-speech for voice contacts (message with text-to-speech, or Amazon Lex bots). This defaults to Joanna if this action is never run.

Factories

UpdateContactTextToSpeechVoice

UpdateContactTextToSpeechVoice() -> UpdateContactTextToSpeechVoiceHandle

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

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

UpdateContactTextToSpeechVoice

UpdateContactTextToSpeechVoice(id: String) -> UpdateContactTextToSpeechVoiceHandle

Construct a UpdateContactTextToSpeechVoice block with an operator-supplied id.

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

Methods

text_to_speech_voice

text_to_speech_voice(value: String) -> UpdateContactTextToSpeechVoiceHandle

Set the TextToSpeechVoice parameter. A string holding the name of an Amazon Polly voice. May be defined statically or dynamically. If this is an invalid text to speech voice, text to speech is no longer function for this contact.

ParameterTypeRequiredDescription
valueStringyesA string holding the name of an Amazon Polly voice. May be defined statically or dynamically. If this is an invalid text to speech voice, text to speech is no longer function for this contact.

text_to_speech_engine

text_to_speech_engine(value?: String) -> UpdateContactTextToSpeechVoiceHandle

Set the TextToSpeechEngine parameter. The engine associated with the Amazon Polly voice. May be defined statically or dynamically.

ParameterTypeRequiredDescription
valueStringnoThe engine associated with the Amazon Polly voice. May be defined statically or dynamically.

text_to_speech_style

text_to_speech_style(value?: String) -> UpdateContactTextToSpeechVoiceHandle

Set the TextToSpeechStyle parameter. The speech style associated with the Amazon Polly Voice. It could be None, Coversational, or Newscaster. May be defined statically or dynamically.

ParameterTypeRequiredDescription
valueStringnoThe speech style associated with the Amazon Polly Voice. It could be None, Coversational, or Newscaster. May be defined statically or dynamically.

external_credential_secret_arn

external_credential_secret_arn(value?: String) -> UpdateContactTextToSpeechVoiceHandle

Set the ExternalCredentialSecretARN parameter. The ARN of the Secrets Manager secret holding a third-party text-to-speech provider's credentials. Read from the console's third-party voice fixtures.

ParameterTypeRequiredDescription
valueStringnoThe ARN of the Secrets Manager secret holding a third-party text-to-speech provider's credentials. Read from the console's third-party voice fixtures.

next

next(target: Handle) -> UpdateContactTextToSpeechVoiceHandle

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

Wire an error transition for NoMatchingError: if no other Error matches. Must always be defined.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingError. if no other Error matches. Must always be defined.

set_id

set_id(id: String) -> UpdateContactTextToSpeechVoiceHandle

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

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

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

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

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> UpdateContactTextToSpeechVoiceHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> UpdateContactTextToSpeechVoiceHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).