sqs_input_device

messageflux.iodevices.sqs.sqs_input_device

SQSInputDevice

SQSInputDevice(
    device_manager,
    queue_name,
    max_messages_per_request=1,
    included_message_attributes=None,
)

Bases: InputDevice['SQSInputDeviceManager']

represents an SQS input device

constructs a new input SQS device

Parameters:

Name	Type	Description	Default
`device_manager`	`SQSInputDeviceManager`	the SQS device Manager that holds this device	required
`queue_name`	`str`	the name for the queue	required
`max_messages_per_request`	`int`	maximum messages to retrieve from the queue (max 10)	`1`
`included_message_attributes`	`Optional[Union[str, List[str]]]`	list of message attributes to get for the message. defaults to ALL	`None`

SQSInputDeviceManager(
    *,
    sqs_resource=None,
    max_messages_per_request=1,
    included_message_attributes=None,
    **kwargs
)

SQS input device manager

Parameters:

Name	Type	Description	Default
`sqs_resource`	`Optional[SQSServiceResource]`	the boto sqs service resource. Defaults to creating from env vars	`None`
`max_messages_per_request`	`int`	maximum messages to retrieve from the queue (max 10)	`1`
`included_message_attributes`	`Optional[Union[str, List[str]]]`	list of message attributes to get for the message. defaults to ALL	`None`

SQSInputTransaction(device, message)

represents a InputTransaction for SQS

Parameters:

Name	Type	Description	Default
`device`	`SQSInputDevice`	the device that returned this transaction	required
`message`	`Message`	the received message	required