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 '200 OK' status in the output document without any error.

Snap Type

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

Min: 0
Max: 1

Binary to Document
S3 Copy

Output

Document

Min: 0
Max: 1

S3 Browser
Mapper

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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 Example: Delete Demo object	String	N/A	Specify a unique name for the Snap.
Bucket* Default Value: [None] Example: mybucket mybucket@eu-west-1 Example of S3 Bucket in S3 region: mybucket@s3.eu-west-1.amazonaws.com Example of S3 VPC endpoint: my-bucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com testBucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com	String/Expression/Suggestion	N/A	Specify the S3 bucket name where the S3 object to be deleted is located. Adding S3: and trailing slash /// after the bucket name is not mandatory. Bucket names are unique globally and can be accessed without its region name in most cases. If you cannot access a bucket name without its region name, you can specify the region information in the following syntax `<S3_bucket_name>@<region_name>` You can also access S3 bucket in a S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name in the following syntax: `<S3_bucket_name>@<VPC_S3_endpoint>` Note: When you enter an incorrect region name, but if the bucket name is valid, the AWS S3 service may successfully access the bucket without any error.
Object Key* Default Value: [None] Examples: test.csv abc/test.json abc/xyz/test.xml	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 Example: Selected	Checkbox	N/A	Select this checkbox to display the advanced properties. Deselect the checkbox to hide the properties.
Thread Pool Size Default Value: 10 Example: 20	Integer/Expression	Appears on selecting 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 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 Example: 2	Integer/Expression	Appears on selecting Show Advanced Properties* checkbox.*	Specify the maximum number of retry attempts to to perform in case of a temporary network loss.
Pass Through Default Value: Deselected Example: Selected	Checkbox	Appears on selecting Show Advanced Properties* checkbox.*	Select this checkbox to pass the input document to the output view as a value to the '`original`' key .
Snap Execution Default Value: Example: Validate & Execute	Dropdown list	N/A	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

Example

Refer Managing-Data-in-S3.

Downloads

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified

No files shared here yet.

Error rendering macro 'excerpt-include' : No link could be created for 'PREVIEW | S3 Snap Pack'.

PREVIEW | S3 Delete