Trigger

Wait for files on S3 bucket.

This trigger will poll every interval s3 bucket. You can search for all files in a bucket or directory in from or you can filter the files with a regExp. The detection is atomic, internally we do a list and interact only with files listed. Once a file is detected, we download the file on internal storage and processed with declared action in order to move or delete the files from the bucket (to avoid double detection on new poll).

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

Wait for a list of files on a s3 bucket and iterate through the files.

yaml
id: s3_listen
namespace: company.team

tasks:
  - id: each
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.objects | jq('.[].uri') }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value }}"

triggers:
  - id: watch
    type: io.kestra.plugin.aws.s3.Trigger
    interval: "PT5M"
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    bucket: "my-bucket"
    prefix: "sub-dir"
    action: MOVE
    moveTo:
      key: archive
      bucket: "new-bucket"

Wait for a list of files on a s3 bucket and iterate through the files. Delete files manually after processing to prevent infinite triggering.

yaml
    id: s3_listen
    namespace: company.team

    tasks:
      - id: each
        type: io.kestra.plugin.core.flow.ForEach
        values: "{{ trigger.objects | jq('.[].key') }}"
        tasks:
          - id: return
            type: io.kestra.plugin.core.debug.Return
            format: "{{ taskrun.value }}"

          - id: delete
            type: io.kestra.plugin.aws.s3.Delete
            accessKeyId: "<access-key>"
            secretKeyId: "<secret-key>"
            region: "eu-central-1"
            bucket: "my-bucket"
            key: "{{ taskrun.value }}"

    triggers:
      - id: watch
        type: io.kestra.plugin.aws.s3.Trigger
        interval: "PT5M"
        accessKeyId: "<access-key>"
        secretKeyId: "<secret-key>"
        region: "eu-central-1"
        bucket: "my-bucket"
        prefix: "sub-dir"
        action: NONE

Dynamic YES

Possible Values

MOVEDELETENONE

The action to perform on the retrieved files. If using 'NONE' make sure to handle the files inside your flow to avoid infinite triggering.

Dynamic YES

The S3 bucket where to download the file.

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

A delimiter is a character you use to group keys.

Dynamic YES

The EncodingType property for this object.

Dynamic YES

The endpoint with which the SDK should communicate.

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

Dynamic YES

The account ID of the expected bucket owner.

If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Dynamic YES

Default BOTH

Possible Values

FILESDIRECTORYBOTH

The type of objects to filter: files, directory, or both.

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

Marker is where you want Amazon S3 to start listing from.

Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Dynamic YES

Default 1000

Dynamic YES

The destination bucket and key for MOVE action.

Dynamic YES

Limits the response to keys that begin with the specified prefix.

Dynamic YES

A regexp to filter on full key.

ex: regExp: .* to match all files regExp: .*2020-01-0.\\.csv to match files between 01 and 09 of january ending with .csv

Dynamic YES

AWS region with which the SDK should communicate.

Dynamic YES

Sets the value of the RequestPayer property for this object.

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

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.

SubType

The list of S3 objects.

Dynamic NO

Format date-time

Dynamic NO

Format uri

Dynamic NO

Dynamic YES

The bucket name

Dynamic YES

The bucket key

​Trigger

Trigger