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

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 when 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 remaining 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

Field Name

Field Type

Field Dependency

Description

Label*

 

Default ValueS3 Delete
ExampleDelete Demo object

String

N/A

Specify a unique name for the Snap.

 

Bucket*

 

Default Value: None
Examples

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:

<S3_bucket_name>@<region_name>

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.

  • You can access an S3 bucket in an S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name with the following syntax:

    • <S3_bucket_name>@<VPC_S3_endpoint>

  • You can access an S3 Express One Zone bucket with the following syntax:

    • <bucket-name>--<region>-<available-zone>--x-s3

  • S3 Express One Zone does not support the following bucket name pattern:

    • <bucket>@<region_info>.

  • S3 Express One Zone does not support VPC.

 

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.

 

Show Advanced Properties

 

Default Value: Deselected
Example: Selected

Checkbox

N/A

Select this checkbox to display the advanced properties.
Deselect this checkbox to hide the properties.

Thread Pool Size

 

Default Value: 10
Example: 20

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
Example: 2

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
Example: Selected

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 '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

 

  File Modified

File Example_Managing_Data_in_S3.slp

Jun 09, 2022 by Kalpana Malladi

Snap Pack History


Related Links