S3 Presigned

Overview

You can use this Snap to generate a presigned URL in the output document to access an S3 object. You can use the presigned URL in external applications to read or write S3 objects, for example, Postman, REST Get Snap, and REST Put Snap.

Note:

The Snap may produce a presigned URL without any error if Snap properties contain invalid values, and this may cause the external application to fail.



Snap views

View Description Examples of upstream and downstream Snaps
Input Receives document data containing file content and metadata from the upstream Mapper transformation, providing the necessary context to generate a presigned URL for the specified S3 object.
Output Produces document data containing the generated presigned URL and associated metadata, providing a time-limited, authenticated link for secure access to the specified S3 object.
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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • 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

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: S3 Presigned

Example: GET presigned URL
Bucket String/Expression/ Suggestion

Required. Specify the S3 bucket name, from where you need to fetch or post the presigned URL.

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

  • 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 an S3 bucket in an 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 the bucket name is valid, the AWS S3 service may successfully access the bucket without any error.

Default value: None.

Examples:

  • mybucket

  • mybucket@eu-west-1

  • Example of S3 Bucket in S3 region:

  • 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
Object Key String/Expression/ Suggestion

Required. Specify or select the S3 object key name, which may include one or more forward-slash '/' characters.

Note: The forward-slash character is part of the S3 object key name, and there is no folder object defined in AWS S3. The Snap uses the existing Object Key value as a prefix to produce the suggested list. The maximum length of the suggested list is 1,000.

Default value: None.

Examples:

  • test.csv

  • abc/test.json

  • abc/xyz/test.xml
Expire in (seconds) Checkbox Required. Specify the time in seconds at which the generated presigned URL will expire.

Min: 1

Max: 604800 (7 days)

Default value: 3600

Example: 2000
HTTP Method String/Expression/ Suggestion

Specify the HTTP method verb to use for the presigned URL. The supported methods are GET and PUT.

Default value: GET

Example: PUT
Snap execution Dropdown list
Choose 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.

Default value: Execute only

Example: Validate & Execute

Examples