AWS Scan
CertifiedScan items from a DynamoDB table
AWS Scan
Scan items from a DynamoDB table
Performs a Scan over the table. fetchType defaults to STORE; FETCH and FETCH_ONE read into memory. Optional limit and filterExpression reduce the returned set.
type: io.kestra.plugin.aws.dynamodb.ScanExamples
Scan all items from a table
id: aws_dynamo_db_scan
namespace: company.team
tasks:
- id: scan
type: io.kestra.plugin.aws.dynamodb.Scan
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
tableName: "persons"
Scan items from a table with a filter expression
id: aws_dynamo_db_scan
namespace: company.team
tasks:
- id: scan
type: io.kestra.plugin.aws.dynamodb.Scan
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
tableName: "persons"
filterExpression: "lastname = :lastname"
expressionAttributeValues:
:lastname: "Doe"
Properties
tableName *Requiredstring
Table name
Target DynamoDB table for the operation.
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.
expressionAttributeValues object
Expression attribute values
Map of placeholders used in expressions.
fetchType string
STORESTOREFETCHFETCH_ONENONEFetch strategy
STORE (default) writes rows to internal storage; FETCH loads all rows; FETCH_ONE returns the first row.
filterExpression string
Filter expression
Server-side filter applied after the scan; requires expressionAttributeValues.
forcePathStyle booleanstring
Force path style access
Must only be used when compatibilityMode is enabled.
limit integerstring
Max results
Maximum items to return.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
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
PT15MAWS 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
uriKestra's internal storage URI of the stored data.
Only populated if using fetchType=STORE.
Metrics
records counter
itemsNumber of items scanned from DynamoDB
