Query

Query items from a DynamoDB table.

yaml
type: "io.kestra.plugin.aws.dynamodb.Query"

Examples

Query items from a table.

yaml
id: aws_dynamo_db_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.aws.dynamodb.Query
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    tableName: "persons"
    keyConditionExpression: id = :id
    expressionAttributeValues:
      :id: "1"

Query items from a table with a filter expression.

yaml
id: aws_dynamo_db_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.aws.dynamodb.Query
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    tableName: "persons"
    keyConditionExpression: id = :id
    expressionAttributeValues:
      :id: "1"
      :lastname: "Doe"

Properties

expressionAttributeValues *object

Query expression attributes.

It's a map of string -> object.

keyConditionExpression *string

Query key condition expression.

tableName *string

The DynamoDB table name.

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.

fetchType string

Default STORE

Possible Values

STOREFETCHFETCH_ONENONE

The way you want to store the data.

FETCH_ONE output the first row, FETCH output all the rows, STORE store all rows in a file, NONE do nothing.

filterExpression string

Query filter expression.

forcePathStyle booleanstring

Force path style access.

Must only be used when compatibilityMode is enabled.

limit integerstring

Maximum numbers of returned results.

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

row object

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

rows array

List containing the fetched data.

Only populated if using fetchType=FETCH.

size integer

The number of fetched rows.

uri string

Format uri

Kestra's internal storage URI of the stored data.

Only populated if using fetchType=STORE.

​Query

Query