Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. The available options are:

  • 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.

...

Field Name

Field Type

Field Dependency

Description

Label*

Default ValueS3 Delete
ExampleS3 Delete Demo object

String

N/A

Specify a unique name for the Snap.

Bucket*

Default Value: [None]
Example:

String/Expression/Suggestion

N/A

Specify the S3 bucket name where the S3 object to be deleted is located.

Bucket names are globally unique, hence you can access them without its region name. In case you are unable to access a bucket without specifying its region name, you can specify the same using the following syntax:

<S3_bucket_name>@<region_name>

<S3_bucket_name>@<endpoint>

The <endpoint> also applies to Virtual Private Cloud (VPC) S3 endpoint.

Note: When you specify an incorrect region name, however if the bucket name is valid, the AWS S3 service may allow you to 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.

...