Scan

yaml

type: "io.kestra.plugin.aws.dynamodb.Scan"

Scan items from a table.

Examples

Scan all items from a table.

yaml

id: aws_dynamo_db_scan
namespace: company.team

tasks:
  - id: scan
    type: io.kestra.plugin.aws.dynamodb.Scan
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    tableName: "persons"

Scan items from a table with a filter expression.

yaml

id: aws_dynamo_db_scan
namespace: company.team

tasks:
  - id: scan
    type: io.kestra.plugin.aws.dynamodb.Scan
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    tableName: "persons"
    filterExpression: "lastname = :lastname"
    expressionAttributeValues:
      :lastname: "Doe"

Properties

`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.

`expressionAttributeValues`

Type: object
Dynamic: ✔️
Required: ❌

Scan expression attributes.

It's a map of string -> object.

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

Scan filter expression.

When used, expressionAttributeValues property must also be provided.

`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.