Publish

Publish a message to an AWS SQS queue.

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

Examples

Publish a message to an SQS queue

yaml
id: aws_sqs_publish
namespace: company.team

tasks:
  - id: publish
    type: io.kestra.plugin.aws.sqs.Publish
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
    region: "{{ secret('AWS_DEFAULT_REGION') }}"
    queueUrl: "https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue"
    from:
    - data: Hello World
    - data: Hello Kestra
      delaySeconds: 5

Publish an input to an SQS queue

yaml
id: sqs_publish_message
namespace: company.team

inputs:
  - id: message
    type: STRING
    defaults: Hi from Kestra!

tasks:
  - id: publish_message
    type: io.kestra.plugin.aws.sqs.Publish
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
    region: "{{ secret('AWS_DEFAULT_REGION') }}"
    queueUrl: https://sqs.eu-central-1.amazonaws.com/123456789/kestra
    from:
      data: "{{ inputs.message }}"

Properties

from *stringarrayMessage

The source of the published data.

Can be an internal storage URI, a list of SQS messages, or a single SQS message.

queueUrl *string

The SQS queue URL. The queue must already exist.

accessKeyId string

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.

compatibilityMode booleanstring

Enable compatibility mode.

Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.

endpointOverride string

The endpoint with which the SDK should communicate.

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

forcePathStyle booleanstring

Force path style access.

Must only be used when compatibilityMode is enabled.

region string

AWS region with which the SDK should communicate.

secretKeyId string

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.

sessionToken string

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.

stsEndpointOverride string

The AWS STS endpoint with which the SDKClient should communicate.

stsRoleArn string

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.

stsRoleExternalId string

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.

stsRoleSessionDuration string

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.

stsRoleSessionName string

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Outputs

messagesCount integer

Number of published messages.

Definitions

io.kestra.plugin.aws.sqs.model.Message

data *string

The message data.

deduplicationId string

The message deduplication ID.

delaySeconds integer

The message delay in seconds.

groupId string

The message group ID.

​Publish

Publish