Trigger

Consume messages periodically from an SQS queue and create one execution per batch.

Requires maxDuration or maxRecords. Note that you don't need an extra task to consume the message from the event trigger. The trigger will automatically consume messages and you can retrieve their content in your flow using the {{ trigger.uri }} variable. If you would like to consume each message from an SQS queue in real-time and create one execution per message, you can use the io.kestra.plugin.aws.sqs.RealtimeTrigger instead.

yaml
type: "io.kestra.plugin.aws.sqs.Trigger"

yaml
id: sqs
namespace: company.team

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ trigger.data }}"

triggers:
  - id: trigger
    type: io.kestra.plugin.aws.sqs.Trigger
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    queueUrl: "https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue"
    maxRecords: 10

Dynamic YES

The SQS queue URL. The queue must already exist.

Dynamic YES

Access Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

SubType

Dynamic NO

List of conditions in order to limit the flow trigger.

Dynamic YES

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

Dynamic NO

Default 60

Format duration

Interval between polling.

The interval between 2 different polls of schedule, this can avoid to overload the remote system with too many calls. For most of the triggers that depend on external systems, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval values.

Dynamic YES

Format duration

Max duration in the Duration ISO format, after that the task will end.

Dynamic YES

AWS region with which the SDK should communicate.

Dynamic YES

Secret Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

Default STRING

Possible Values

STRINGJSON

The serializer/deserializer to use.

Dynamic YES

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

SubType string

Dynamic NO

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Dynamic YES

The AWS STS endpoint with which the SDKClient should communicate.

Dynamic YES

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

AWS STS External Id.

A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

Dynamic YES

Default PT15M

Format duration

AWS STS Session duration.

The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

Dynamic YES

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Number of consumed rows.

Format uri

File URI containing consumed messages.

​Trigger

Trigger