S3 Delete
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.
|
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. |
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
Snap Pack History
Related Links
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.