PLUGINSPLUGIN-AWSTASKSDYNAMODBIO.KESTRA.PLUGIN.AWS.DYNAMODB.QUERY

​Query

Query Query

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

Query items from a table.

Examples

Query items of a table.

yaml
id: "query"
type: "io.kestra.plugin.aws.dynamodb.Query"
tableName: "persons"
keyConditionExpression: id = :id
expressionAttributeValues:
  :id: "1"

Query items of a table with a filter expression.

yaml
id: "query"
type: "io.kestra.plugin.aws.dynamodb.Query"
tableName: "persons"
keyConditionExpression: id = :id
expressionAttributeValues:
  :id: "1"
  :lastname: "Doe"

Properties

expressionAttributeValues

  • Type: object
  • Dynamic: ✔️
  • Required: ✔️

Query expression attributes.

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: ❌

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.

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: ❌

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

row

  • Type: object

Map containing the first row of fetched data

Only populated if using fetchType=FETCH_ONE.

rows

  • Type: array

List containing the fetched data

Only populated if using fetchType=FETCH.

size

  • Type: integer

The size of the fetched rows

uri

  • Type: string

The uri of stored data

Only populated if using fetchType=STORE