amazonka-chime-sdk-messaging-2.0: Amazon Chime SDK Messaging SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ChimeSDKMessaging.Types.Processor

Description

 
Synopsis

Documentation

data Processor Source #

The information about a processor in a channel flow.

See: newProcessor smart constructor.

Constructors

Processor' 

Fields

  • name :: Sensitive Text

    The name of the channel flow.

  • configuration :: ProcessorConfiguration

    The information about the type of processor and its identifier.

  • executionOrder :: Natural

    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.

  • fallbackAction :: 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.

Instances

Instances details
FromJSON Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

ToJSON Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

Generic Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

Associated Types

type Rep Processor :: Type -> Type #

Show Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

NFData Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

Methods

rnf :: Processor -> () #

Eq Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

Hashable Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

type Rep Processor Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.Types.Processor

type Rep Processor = D1 ('MetaData "Processor" "Amazonka.ChimeSDKMessaging.Types.Processor" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "Processor'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessorConfiguration)) :*: (S1 ('MetaSel ('Just "executionOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "fallbackAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FallbackAction))))

newProcessor Source #

Create a value of Processor with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Processor', processor_name - The name of the channel flow.

$sel:configuration:Processor', processor_configuration - The information about the type of processor and its identifier.

$sel:executionOrder:Processor', processor_executionOrder - 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.

$sel:fallbackAction:Processor', processor_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.

processor_name :: Lens' Processor Text Source #

The name of the channel flow.

processor_configuration :: Lens' Processor ProcessorConfiguration Source #

The information about the type of processor and its identifier.

processor_executionOrder :: Lens' Processor Natural Source #

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.

processor_fallbackAction :: Lens' Processor FallbackAction Source #

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.