Query
type: "io.kestra.plugin.aws.dynamodb.Query"
Query items from a table.
Examples
Query items from a table.
id: aws_dynamo_db_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.aws.dynamodb.Query
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
tableName: "persons"
keyConditionExpression: id = :id
expressionAttributeValues:
:id: "1"
Query items from a table with a filter expression.
id: aws_dynamo_db_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.aws.dynamodb.Query
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
tableName: "persons"
keyConditionExpression: id = :id
expressionAttributeValues:
:id: "1"
:lastname: "Doe"
Properties
expressionAttributeValues
- Type: object
- Dynamic: ✔️
- Required: ✔️
Query expression attributes.
It's a map of string -> object.
keyConditionExpression
- Type: string
- Dynamic: ✔️
- Required: ✔️
Query key condition expression.
tableName
- Type: string
- Dynamic: ✔️
- Required: ✔️
The DynamoDB table name.
accessKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: boolean
- Dynamic: ✔️
- Required: ❌
endpointOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
fetchType
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
STORE
- Possible Values:
STORE
FETCH
FETCH_ONE
NONE
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
- Type: string
- Dynamic: ✔️
- Required: ❌
Query filter expression.
Query filter expression.
limit
- Type: integer
- Dynamic: ❌
- Required: ❌
Maximum numbers of returned results.
region
- Type: string
- Dynamic: ✔️
- Required: ❌
AWS region with which the SDK should communicate.
secretKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArn
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
900.000000000
- 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
- Type: string
- Dynamic: ✔️
- Required: ❌
AWS STS Session name.
This property is only used when an
stsRoleArn
is defined.
Outputs
row
- Type: object
- Required: ❌
Map containing the first row of fetched data.
Only populated if using
fetchType=FETCH_ONE
.
rows
- Type: array
- SubType:
- Required: ❌
List containing the fetched data.
Only populated if using
fetchType=FETCH
.
size
- Type: integer
- Required: ❌
The number of fetched rows.
uri
- Type: string
- Required: ❌
- Format:
uri
Kestra's internal storage URI of the stored data.
Only populated if using
fetchType=STORE
.
Was this page helpful?