awsSQS (AWS SQS)

An AWS SQS triggerer reaches out to an AWS SQS (Amazon Simple Queue Service) queue and picks up messages from it as though it was a dbQueue or memQueue.

The access key, secret key, queue URL and region are mandatory fields.

class names

scala: code.model.flows.processors.aws.sqs.AwsSqsTriggererFactory
javascript: code_model_flows_processors_aws_sqs_AwsSqsTriggererFactory

aliases

awsSQSqueue amazonSQS amazonSQSqueue awsSimpleQueueService amazonSimpleQueueService

end type

config

{"categories":[{"defaultCollapsed":true,"fields":["streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics"],"name":"Advanced Run Configuration"}],"fieldName":"awsSQS","fields":[{"default":[],"fieldName":"awsSQS.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"awsSQS.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"awsSQS.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[],"fieldName":"awsSQS.providerConfig","fields":[{"default":null,"fieldName":"awsSQS.providerConfig.queueUrl","hidden":false,"hideLabel":false,"name":"queueUrl","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.providerConfig.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"awsSQSConfiguration","fieldName":"awsSQS.providerConfig.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[],"fieldName":"awsSQS.providerConfig.awsCredentials","fields":[{"default":null,"fieldName":"awsSQS.providerConfig.awsCredentials.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"awsCredentials","fieldName":"awsSQS.providerConfig.awsCredentials.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"T1726099537083_F99803548183QJHE2Z","fieldName":"awsSQS.providerConfig.awsCredentials.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.providerConfig.awsCredentials.accessKey","hidden":false,"hideLabel":false,"name":"accessKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.providerConfig.awsCredentials.secretKey","hidden":false,"hideLabel":false,"name":"secretKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"name":"awsCredentials","readonly":false,"renderStrategies":[],"type":"O"},{"default":"T1726099537083_F99803548190H2QKVJ","fieldName":"awsSQS.providerConfig.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.providerConfig.region","hidden":false,"hideLabel":false,"name":"region","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"name":"providerConfig","readonly":false,"renderStrategies":[],"type":"O"},{"default":"awsSQS","fieldName":"awsSQS.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"collecting","fieldName":"awsSQS.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"awsSQS.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":[],"fieldName":"awsSQS.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"awsSQS.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":"","fieldName":"awsSQS.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"awsSQS.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"awsSQS.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":["All"],"fieldName":"awsSQS.attributes","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"awsSQS.attributes","hidden":false,"hideLabel":false,"name":"attributes","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"attributes","readonly":false,"renderStrategies":[],"type":"A"},{"default":"T1726099537083_F99803548236JMGSY2","fieldName":"awsSQS.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":[],"fieldName":"awsSQS.messageAttributes","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"awsSQS.messageAttributes","hidden":false,"hideLabel":false,"name":"messageAttributes","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"messageAttributes","readonly":false,"renderStrategies":[],"type":"A"},{"default":[],"fieldName":"awsSQS.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"awsSQS.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"awsSQS.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"awsSQS.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"canReference":false,"default":180000,"fieldName":"awsSQS.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"awsSQS.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"awsSQS.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"awsSQS","readonly":false,"renderStrategies":[],"type":"O"}