Amazon S3

Frends.AmazonS3.DeleteObject / 2.0.0

Summary

Removes named objects from a bucket, several in one call, and lets you decide whether an object that was already gone counts as a problem.

Typical use — cleaning up after a transfer, where treating a missing object as success keeps a re-run of the same Process from failing

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0

Input parameters.

Name Type Default Example Description
Objects S3ObjectArray[] [ { BucketName: "ExampleBucket", Key: "ExampleKey", VersionId: "1" }, { BucketName: "ExampleBucket", Key: "ExampleKey2", VersionId: "" } ]

Array of S3 objects to be deleted. Each object contains bucket name, key, and optional version ID.

ActionOnObjectNotFound NotExistsHandler None NotExistsHandler.None

Defines how to handle objects that don't exist:

  • None (Default): Task doesn't check if the object exists before deletion. Each delete operation will return version ID and be included in DeletedObjects unless an exception occurs.
  • Info: Task will check if the object exists before each delete operation. Non-existing objects will be skipped and included in DeletedObjects with null version ID.
  • Throw: Throw an exception if any object doesn't exist. Task will check all objects in Input.Objects before starting the delete process.

Possible values:

  • None: Task doesn't check if the object exists before the delete operation. Each delete operation will return versionid and success = true unless an exception occurs.

  • Info: Each nonexisting object will return Success = false and an error message.

  • Throw: Throw an exception if the object doesn't exists. Task will check all objects listed in Input.Objects before continuing to delete process.

An unhandled error has occurred. Reload 🗙