In this article
Overview
You can use this Snap to delete an S3 object specified in the Bucket and Object Key fields.
To delete multiple S3 objects, use the S3 Browser Snap as the upstream Snap with Bucket and Object Key fields expression-enabled.
When the specified object does not exist, the Snap displays the
'200 OK'status in the output document without any error.
Snap Type
The S3 Delete Snap is a Write-type Snap that writes the status of the deleted S3 objects.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps |
|---|---|---|---|
Input | Document |
|
|
Output | Document |
|
|
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | ||
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.Expression icon (
): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.Add icon (
): Indicates that you can add fields in the fieldset.Remove icon (
): Indicates that you can remove fields from the fieldset.
Field Name | Field Type | Field Dependency | Description |
|---|---|---|---|
Label* Default Value: S3 Delete | String | N/A | Specify a unique name for the Snap. |
Bucket* Default Value: None
| String/Expression/Suggestion | N/A | Specify the S3 bucket name where the S3 object to be deleted is located. Do not add S3:/// before bucket name, because the Snap can fail. Bucket names are unique globally and can be accessed without the region name in most cases. If you cannot access a bucket name without its region name, you can specify the region information with the following syntax:
Note: If you enter an incorrect region name, but the bucket name is valid, the AWS S3 service might successfully access the bucket without errors.
|
Object Key* Default Value: None
| String/Expression/Suggestion | N/A | Specify the S3 object key name, which may include one or more forward-slash ('/') characters. The forward-slash character is part of the S3 object key name and there is no folder object defined in AWS S3. The maximum length of the suggested list is 1,000. |
Show Advanced Properties Default Value: Deselected | Checkbox | N/A | Select this checkbox to display the advanced properties. |
Thread Pool Size Default Value: 10 | Integer/Expression | Appears when you select Show Advanced Properties checkbox. | Specify the maximum number of threads to be used to delete multiple S3 objects in parallel with Bucket and Object Key properties expression-enabled. If the Thread Pool Size property is expression-enabled, it can be evaluated with a Pipeline parameter, but not with an input document. Therefore, the value of this property remains constant throughout the Pipeline execution. |
Maximum Retries* Default Value: 3 | Integer/Expression | Appears when you select Show Advanced Properties checkbox. | Specify the maximum number of retry attempts to perform in case of a temporary network loss. |
Pass Through Default Value: Deselected | Checkbox | Appears when you select Show Advanced Properties checkbox. | Select this checkbox to pass the input document to the output view as a value to the ' |
Snap Execution Default Value: | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
Example
Refer Managing-Data-in-S3.
Downloads
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
Snap Pack History
Release | Snap Pack Version | Date | Type | Updates |
|---|---|---|---|---|
November 2024 | 439patches29535 |
| Latest | Fixed the account validation issue in the Amazon S3 Account. Previously, the account validation failed even when Snap execution was successful within the same account. The fix includes an enhancement, introducing a new Bucket for account validation field that allows you to specify a bucket name for validating the account. |
January 2025 | 439patches29484 |
| Latest | Enhanced the S3 Account to access AWS S3 successfully in the ECS environment with IAM roles. Learn more. |
November 2024 | main29029 |
| Stable | Updated and certified against the current Snaplogic Platform release. |
August 2024 | 438patches28445 |
| Latest | Enhanced the S3 Download Snap with an Enable Staging checkbox that enables you to download an S3 object into a local temporary file. This enhancement addresses the cases where certain downstream Snaps take longer to process large volumes of data, potentially causing a connection reset error and pipeline failure. |
August 2024 | main27765 |
| Stable | Updated and certified against the current Snaplogic Platform release. |
May 2024 | 437patches26643 |
| Latest | Fixed an issue with the S3 Browser Snap that could not initialize the output document properly, causing an error in the downstream Snaps. |
May 2024 | main26341 |
| Stable | Enhanced the S3 Select Snap to capture metadata and lineage information from the input document. |
February 2024 | 436patches25360 |
| Latest | Fixed an issue with the Amazon S3 Snaps that displayed a |
February 2024 | main25112 |
| Stable | Updated and certified against the current Snaplogic Platform release. |
November 2023 | 435patches24238 |
| Latest | Added support for Amazon S3 Express One Zone in the Amazon S3 Snap Pack. |
November 2023 | main23721 |
| Stable | Updated and certified against the current Snaplogic Platform release. |
August 2023 | main22460 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
May 2023 | 433patches21816 |
| Latest | The Amazon S3 Snaps automatically detect the Maximum session duration value for the Cross-Account IAM role (1 through 12 hours). The Snaps round down the value to the nearest hour. So, if the Snap administrator sets the Maximum session duration at 3 hours and 45 minutes, the Snaps read it as 3 hours. The Snaps also refresh the session before it expires. However, the automatic session refresh does not support the case of very large file upload or download that takes longer than the maximum session duration. |
May 2023 | main21015 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | 432patches20385 |
| Latest | Added support for Ultra Task Pipelines. |
February 2023 | main19844 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
November 2022 | main18944 |
| Stable |
|
October 2022 | 430patches18674 |
| Latest |
|
August 2022 | 430patches17354 |
| Latest | The KMS Region field in the S3 Account now suggests the regions when you click the suggestion |
August 2022 | main17386 |
| Stable | Introduced the Amazon S3 Snap Pack, which enables you to browse, copy, delete, download, or upload objects in S3. This Snap Pack contains the following Snaps:
|