Delete Object
Deletes one object from an Amazon S3 bucket.
Delete Object removes one object from an Amazon S3 bucket.
Before you start
The AWS S3 actions don't use a stored credential. Each action has the same four connection fields:
| Field | Type | Required | What to put |
|---|---|---|---|
| Access Key | Text | Yes | The access key ID of an AWS IAM user, for example AKIAโฆ. |
| Secret Key | Text | Yes | The secret access key that belongs to that access key. |
| Region | Text | Yes | The AWS region of the bucket, as its code, for example eu-central-1. |
| Bucket | Text | Yes | The bucket name, for example my-company-invoices. |
The IAM user needs S3 permissions on the bucket for the operation you run. The values you type are visible to everyone who can edit the process, so prefer an IAM user limited to the buckets the process needs.
Add the action
In the Process Designer toolbox, open AWS S3 and pick Delete Object (or type Delete Object in the search box).
Inputs and outputs
| Field | Direction | Type | Required | What to put / what you get |
|---|---|---|---|---|
| Access Key, Secret Key, Region, Bucket | Input | Text | Yes | The connection fields described above. |
| Object Key | Input | Text | Yes | The full key of the object to delete, for example inbox/order-17.csv. |
| Result | Output | Boolean | No | true if the object was deleted, false if it wasn't there. |
Example
Object Key inbox/order-17.csv โ the object is removed and Result is true. Run it again and Result is false, because the object is gone.
Good to know
- A missing object doesn't fail the step: Result is
false. - On a bucket with versioning switched on, S3 keeps the older versions.
- If Object Key is empty, the step fails with "Missing object key."
- If a connection field is empty, the step fails with "Invalid connection details."
- Common errors from S3: "Access forbidden! Ensure the connection details are valid." (wrong keys or missing permission), "Unable to connect! Ensure the provided region matches the bucket one." (wrong Region), and "Unrecognized Amazon Region: โฆ" (a region code that doesn't exist).