🚀 New! Kestra raises $3 million to grow Learn more

DeleteList DeleteList

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

Delete a list of keys on a S3 bucket.

Examples

yaml
id: "delete_list"
type: "io.kestra.plugin.aws.s3.DeleteList"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
bucket: "my-bucket"
prefix: "sub-dir"

Properties

bucket

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The S3 bucket where to download the file.

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:

concurrent

  • Type: integer
  • Dynamic:
  • Required:
  • Minimum: >= 2

Number of concurrent parallels deletion

delimiter

  • Type: string
  • Dynamic: ✔️
  • Required:

A delimiter is a character you use to group keys.

encodingType

  • Type: string
  • Dynamic: ✔️
  • Required:

The EncodingType property for this object.

endpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required:

The endpoint with which the SDK should communicate. This property should normally not be used except for local development.

errorOnEmpty

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: false

raise an error if the file is not found

expectedBucketOwner

  • Type: string
  • Dynamic: ✔️
  • Required:

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

  • Type: string
  • Dynamic:
  • Required:
  • Default: BOTH
  • Possible Values:
    • FILES
    • DIRECTORY
    • BOTH

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

marker

  • Type: string
  • Dynamic: ✔️
  • Required:

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

  • Type: integer
  • Dynamic: ✔️
  • Required:
  • 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

  • Type: string
  • Dynamic: ✔️
  • Required:

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

regexp

  • Type: string
  • Dynamic: ✔️
  • Required:

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

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS region with which the SDK should communicate.

requestPayer

  • Type: string
  • Dynamic: ✔️
  • Required:

Sets the value of the RequestPayer property for this object.

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.

Outputs

count

  • Type: integer
  • Dynamic:
  • Required:
  • Default: 0

The count of blobs deleted

size

  • Type: integer
  • Dynamic:
  • Required:
  • Default: 0

The size of all blobs deleted