DeleteList

Delete a list of objects in an S3 bucket.

yaml
type: "io.kestra.plugin.aws.s3.DeleteList"

Examples

yaml
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 *string

The S3 bucket where to download the file.

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.

concurrent integer

Minimum >= 2

Number of concurrent parallels deletion

delimiter string

A delimiter is a character you use to group keys.

encodingType string

The EncodingType property for this object.

endpointOverride string

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

errorOnEmpty booleanstring

Default false

raise an error if the file is not found

expectedBucketOwner string

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

filter string

Default BOTH

Possible Values

FILESDIRECTORYBOTH

The type of objects to filter: files, directory, or both.

forcePathStyle booleanstring

Force path style access.

Must only be used when compatibilityMode is enabled.

marker string

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.

maxKeys integerstring

Default 1000

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

prefix string

Limits the response to keys that begin with the specified prefix.

regexp string

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

region string

AWS region with which the SDK should communicate.

requestPayer string

Sets the value of the RequestPayer property for this object.

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

Default PT15M

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 string

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Outputs

count integer

Default 0

The count of blobs deleted

size integer

Default 0

The size of all blobs deleted

​Delete​List

DeleteList