pluginsplugin-awsathena

Query​Query

Query an Amazon Athena table.

The query will wait for completion, except if fetchMode is set to NONE, and will output converted rows. Row conversion is based on the types listed in Athena Data Types. Complex data types like array, map, and struct will be converted to a string.

yaml
type: "io.kestra.plugin.aws.athena.Query"
yaml
id: aws_athena_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.aws.athena.Query
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    database: my_database
    outputLocation: s3://some-s3-bucket
    query: |
      select * from cloudfront_logs limit 10
Properties

Athena database.

Athena output location.

The query results will be stored in this output location. Must be an existing S3 bucket.

Athena SQL query.

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.

Athena catalog.

Enable compatibility mode.

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

The endpoint with which the SDK should communicate.

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

Default STORE
Possible Values
STOREFETCHFETCH_ONENONE

The way you want to store the data.

FETCH_ONE outputs the first row, FETCH outputs all the rows, STORE stores all rows in a file, NONE does nothing — in this case, the task submits the query without waiting for its completion.

Force path style access.

Must only be used when compatibilityMode is enabled.

AWS region with which the SDK should communicate.

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.

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.

Default true

Whether to skip the first row which is usually the header.

The AWS STS endpoint with which the SDKClient should communicate.

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.

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.

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.

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

The query execution identifier.

Map containing the first row of fetched data.

Only populated if fetchType=FETCH_ONE.

List containing the fetched data.

Only populated if fetchType=FETCH.

The size of the fetched rows.

Format uri

The URI of stored data.

Only populated if fetchType=STORE.