Versions Compared

Version Old Version 4 New Version Current
Changes made by

Kalpana Malladi

Gouri Bhagchandani (Deactivated)

Saved on

Key

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

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

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 WRITEWrite-type Snap that writes the status of the deleted S3 objects.

...

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

Mapper

  • Binary to Document

  • Copy

  • ..

    • Requires the EDI data and internal ID as a JSON document.

    • S3 Copy

    Output

    Document

    • Min: 0

    • Max: 1

    • ..

    • ..

    The EDI transaction ID and order confirmation.

    • 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

    when 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

    • 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

    Info

    • Asterisk (*): Indicates a mandatory field.

    • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ( (blue star) ): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ((blue star)): Indicates that you can add fields in the fieldset.

    • Remove icon ((blue star)): Indicates that you can remove fields from the fieldset.

    Field Name

    Field Type

    Field Dependency

    Description

    Label*

    Default Value: S3 Delete
    Example: 

    S3

    Delete Demo object

    String

    N/A

    Specify

    the

    a unique name for the Snap.

    Bucket*

    Default Value:

     [None]
    Example:

     None
    Examples: 

    (an example of <S3_bucket_name>@<s3_endpoint>)
    (an example of <S3_bucket>@<VPC_S3_endpoint>)

    • Example of S3 Express One Zone bucket:

      • snapexpress--usw2-az2--x-s3

    String/Expression/Suggestion

    N/A

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

    info

    Note

    Do not add S3:/// before bucket name, because the Snap can fail.

    Bucket names are unique globally

    unique, hence you can access them without its region name. In case you are unable to

    and can be accessed without the region name in most cases. If you cannot access a bucket name without

    specifying

    its region name, you can specify the

    same using

    region information with 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

    If you

    specify

    enter an incorrect region name,

    however if

    but the bucket name is valid, the AWS S3 service

    may allow you to

    might successfully access the bucket without

    any error

    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.

    Info

    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

    this checkbox to hide the properties.

    Thread Pool Size

    Default Value: 10
    Example: 20

    Integer/Expression

    Appears

    on selecting

    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.

    Info

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

    Integer/Expression

    Appears

    on selecting

    when you select 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

    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.

    Troubleshooting

    ...

    Error

    ...

    Reason

    ...

    Resolution

    ...

    Account validation failed.

    ...

    The Pipeline ended before the batch could complete execution due to a connection error.

    ...

    Example

    Refer Managing-Data-in-S3.

    Downloads

    Info

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Provide Pipeline parameters as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    Snap Pack History

    Insert excerpt
    Amazon S3 Snap Pack
    Amazon S3 Snap Pack
    nameS3 Snap Pack History
    nopaneltrue

    ...

    ...

    SnapLogic Glossary

    ...