DeleteList
Delete a list of objects in an S3 bucket.
Delete a list of objects in an S3 bucket.
Delete a list of objects in an S3 bucket.
type: "io.kestra.plugin.aws.s3.DeleteList"Examples
id: aws_s3_delete_list
namespace: company.team
tasks:
- id: delete_list
type: io.kestra.plugin.aws.s3.DeleteList
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
bucket: "my-bucket"
prefix: "sub-dir"
Properties
bucket*Requiredstring
The S3 bucket where to download the file.
accessKeyIdstring
Access Key Id in order to connect to AWS.
compatibilityModebooleanstring
Enable compatibility mode.
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
concurrentNon-dynamicinteger
>= 2Number of concurrent parallels deletion
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.
errorOnEmptybooleanstring
falseraise an error if the file is not found
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.
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
countinteger
0The count of blobs deleted
sizeinteger
0The size of all blobs deleted
Metrics
s3.objects.deleted.countcounter
objectsThe total number of objects deleted from the S3 bucket.
s3.objects.deleted.sizecounter
bytesThe total size in bytes of objects deleted from the S3 bucket.
