Class: Aws::ChimeSDKMessaging::Types::Processor

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb

Overview

Note:

When making an API call, you may pass Processor data as a hash:

{
  name: "NonEmptyResourceName", # required
  configuration: { # required
    lambda: { # required
      resource_arn: "LambdaFunctionArn", # required
      invocation_type: "ASYNC", # required, accepts ASYNC
    },
  },
  execution_order: 1, # required
  fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
}

The information about a processor in a channel flow.

Constant Summary collapse

SENSITIVE =
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationTypes::ProcessorConfiguration

The information about the type of processor and its identifier.



2552
2553
2554
2555
2556
2557
2558
2559
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2552

class Processor < Struct.new(
  :name,
  :configuration,
  :execution_order,
  :fallback_action)
  SENSITIVE = [:name]
  include Aws::Structure
end

#execution_orderInteger

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.

Returns:

  • (Integer)


2552
2553
2554
2555
2556
2557
2558
2559
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2552

class Processor < Struct.new(
  :name,
  :configuration,
  :execution_order,
  :fallback_action)
  SENSITIVE = [:name]
  include Aws::Structure
end

#fallback_actionString

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.

Returns:

  • (String)


2552
2553
2554
2555
2556
2557
2558
2559
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2552

class Processor < Struct.new(
  :name,
  :configuration,
  :execution_order,
  :fallback_action)
  SENSITIVE = [:name]
  include Aws::Structure
end

#nameString

The name of the channel flow.

Returns:

  • (String)


2552
2553
2554
2555
2556
2557
2558
2559
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2552

class Processor < Struct.new(
  :name,
  :configuration,
  :execution_order,
  :fallback_action)
  SENSITIVE = [:name]
  include Aws::Structure
end