Skip to main content

S3 Delete Object

Removes an object from a bucket.

component image

In-ports​

s3-uri String — a S3 object location.

trigger <any> — triggers the S3 request.

abort <any> — aborts all pending requests.

config JSON (dynamic) — accepts a JSON object with configuration properties.

Out-ports​

response Object — emits a response wrapped into JSON object.

errors JSON — emits any errors that occur during action execution.

Overview​

The S3 Delete Object component removes an object from an Amazon S3 bucket. This component is part of the group of components that are designed to perform operations with Amazon S3.

To use this component, send an S3 URI of the object you want to delete to the s3-uri port. S3 URI indicates an S3 location in the format s3://amzn-s3-demo-bucket/mykey, where amzn-s3-demo-bucket is the bucket name and mykey is the key.

The behavior depends on the bucket's versioning state:

  • If bucket versioning is not enabled, the operation permanently deletes the object.
  • If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object.
  • If bucket versioning is suspended, the operation removes the object that has a null versionId, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId, and all versions of the object have a versionId, Amazon S3 does not remove the object and only inserts a delete marker.

To permanently delete an object in a versioned bucket, you must include the object’s versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.

If the trigger input port is used, the component waits until an event is received before executing the action. The action is performed with each event. Errors encountered will be emitted on the errors output port. Use the abort port to cancel the execution.

If the action is successful, the service sends back an HTTP 204 response.

Settings​

Enable realtime config port​

When enabled, this setting allows the component to be configured via the config port. The port accepts a configuration object as input, enabling dynamic property updates during runtime. While using this port won't trigger component reinitialization, it may result in the loss of some previous component state.

Region (region)​

Specifies the region in which the S3 client operates.

  • Required: Yes
  • Default: None

Version ID (versionId)​

Version ID used to reference a specific version of the object.

  • Required: No
  • Default: None

Keep always active​

Determines whether the component will remain active even if it is not connected to a visible widget or another active component.

See also​

For more information about Amazon S3, see the following: