Consume
type: "io.kestra.plugin.aws.sqs.Consume"
Consume messages from a SQS queue.
Required a maxDuration or a maxRecords.
# Examples
id: "consume"
type: "io.kestra.plugin.aws.sqs.Consume"
queueUrl: "https://sqs.us-east-2.amazonaws.com/000000000000/test-queue"
# Properties
# accessKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
The Access Key Id in order to connect to AWS
If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value
# endpointOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
The endpoint with which the SDK should communicate.
Should normally not be used except for local development.
# maxDuration
- Type: string
- Dynamic: ❌
- Required: ❌
- Format:
duration
Max duration in the Duration ISO format, after that the task will end.
# maxRecords
- Type: integer
- Dynamic: ❌
- Required: ❌
Max number of records, when reached the task will end.
# queueUrl
- Type: string
- Dynamic: ✔️
- Required: ❌
The SQS queue URL. The queue must already exist.
# region
- Type: string
- Dynamic: ✔️
- Required: ❌
The region with which the SDK should communicate.
# secretKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
The Secret Key Id in order to connect to AWS
If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value
# sessionToken
- Type: string
- Dynamic: ✔️
- Required: ❌
The he AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.
If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value
# Outputs
# count
- Type: integer
Number of consumed rows.
# uri
- Type: string
File URI containing consumed messages.