Skip to content

Processor

Source code in docs_src/capo_chime_sdk_messaging/types/processor.py
class Processor(TypedDict, closed=True):
    name: "capo_chime_sdk_messaging.types.non_empty_resource_name.NonEmptyResourceName"
    """<p>The name of the channel flow.</p>"""
    configuration: (
        "capo_chime_sdk_messaging.types.processor_configuration.ProcessorConfiguration"
    )
    """<p>The information about the type of processor and its identifier.</p>"""
    execution_order: "capo_chime_sdk_messaging.types.channel_flow_execution_order.ChannelFlowExecutionOrder"
    """<p>The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.</p>"""
    fallback_action: "capo_chime_sdk_messaging.types.fallback_action.FallbackAction"
    """<p>Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of <code>ABORT</code> and communication with it fails, the processor sets the message status to <code>FAILED</code> and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of <code>CONTINUE</code> and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.</p>"""

configuration instance-attribute

configuration: ProcessorConfiguration

The information about the type of processor and its identifier.

execution_order instance-attribute

execution_order: ChannelFlowExecutionOrder

The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

fallback_action instance-attribute

fallback_action: FallbackAction

Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

name instance-attribute

The name of the channel flow.