Scan Scan

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

Scan items from a table.

Examples

Scan all items from a table.

yaml
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: "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 connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

compatibilityMode

  • Type: boolean
  • Dynamic: βœ”οΈ
  • Required: ❌

endpointOverride

  • Type: string
  • Dynamic: βœ”οΈ
  • Required: ❌

The endpoint with which the SDK should communicate.

This property should normally not be used except for local development.

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 connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

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 connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

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. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.

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
  • Dynamic: ❓
  • Required: ❌

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

rows

  • Type: array
  • Dynamic: ❓
  • Required: ❌

List containing the fetched data.

Only populated if using fetchType=FETCH.

size

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

The number of fetched rows.

uri

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Format: uri

Kestra's internal storage URI of the stored data.

Only populated if using fetchType=STORE.

Was this page helpful?