
Downloads
Downloads multiple files from a S3 bucket.
Downloads multiple files from a S3 bucket.
Downloads multiple files from a S3 bucket.
type: "io.kestra.plugin.aws.s3.Downloads"Examples
id: aws_s3_downloads
namespace: company.team
tasks:
- id: downloads
type: io.kestra.plugin.aws.s3.Downloads
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
bucket: "my-bucket"
prefix: "sub-dir"
Properties
action*Requiredstring
MOVEDELETENONEThe action to perform on the retrieved files. If using 'NONE' make sure to handle the files inside your flow to avoid infinite triggering.
bucket*Requiredstring
The S3 bucket where to download the file.
accessKeyIdstring
Access Key Id in order to connect to AWS.
compatibilityModebooleanstring
falseThis property will use the AWS S3 DefaultAsyncClient instead of the S3CrtAsyncClient, which maximizes compatibility with S3-compatible services but restricts uploads and downloads to 2GB.
delimiterstring
A delimiter is a character you use to group keys.
encodingTypestring
The EncodingType property for this object.
endpointOverridestring
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
expectedBucketOwnerstring
The account ID of the expected bucket owner.
If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
filterstring
BOTHFILESDIRECTORYBOTHThe type of objects to filter: files, directory, or both.
forcePathStylebooleanstring
Force path style access.
Must only be used when compatibilityMode is enabled.
markerstring
Marker is where you want Amazon S3 to start listing from.
Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
maxKeysintegerstring
1000Sets the maximum number of keys returned in the response.
By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
moveTo
The destination bucket and key for MOVE action.
io.kestra.plugin.aws.s3.Copy-CopyObject
The bucket name
The bucket key
KMS Key ARN or Key ID to use when server side encryption is AWS_KMS
NONEAES256AWS_KMSServer side encryption to apply to the target object.
Example: AES256 or AWS_KMS
prefixstring
Limits the response to keys that begin with the specified prefix.
regexpstring
A regexp to filter on full key.
ex:
regExp: .* to match all files
regExp: .*2020-01-0.\\.csv to match files between 01 and 09 of january ending with .csv
regionstring
AWS region with which the SDK should communicate.
requestPayerstring
Sets the value of the RequestPayer property for this object.
secretKeyIdstring
Secret Key Id in order to connect to AWS.
sessionTokenstring
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.
stsEndpointOverridestring
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArnstring
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.
stsRoleExternalIdstring
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.
stsRoleSessionDurationstring
PT15MdurationAWS 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.
stsRoleSessionNamestring
AWS STS Session name.
This property is only used when an stsRoleArn is defined.
Outputs
objectsarray
The list of S3 objects.
io.kestra.plugin.aws.s3.models.S3Object
date-timeio.kestra.plugin.aws.s3.models.Owner
urioutputFilesobject
The downloaded files as a map of from/to URIs.
Metrics
files.countcounter
objectsThe number of files downloaded from the S3 bucket.
files.size.totalcounter
bytesThe total size in bytes of all downloaded files.