S3 Copy

Overview

You can use this Snap to send a copy request to the AWS S3 service to copy an S3 object from a source bucket to a target bucket.

Note:

The copy operation is performed in the AWS S3 service. The content of the S3 object does not flow through the Snap. If you must copy multiple S3 objects, use S3 Browser Snap upstream with Source Bucket, Source Key, Target Bucket, and Target Key fields expression enabled.



Snap views

View Description Examples of upstream and downstream Snaps
Input The Input view receives document data containing metadata from the upstream S3 Upload operation, which triggers the S3 Copy Snap to execute the file copy operation.
Output The Output view produces document data containing the status and metadata of the completed S3 copy operation, confirming successful file duplication within the bucket.
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 Copy

Example: S3 Copy
Source Bucket String/Expression/ Suggestion

Required. Specify or select the S3 bucket name, from where the S3 objects are to be copied.

Warning: 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 using 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 may successfully access the bucket without any 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.

  • The objects in S3 Express One Zone cannot be copied to a traditional S3 bucket.

Default value: N/A

Examples:
Source Object Key String/Expression/ Suggestion

Required. Specify the source object key to copy from, which may include one or more forward-slash '/' characters. If an S3 object was created with its name starting with ‘/', you must use '/’ to copy it.

Note: The (/) forward-slash character is part of the S3 object key name; there is no folder object defined in AWS S3. You can select the object key from the suggested list. The Snap uses the existing value of Object Key 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
Target Bucket String/Expression/ Suggestion

Required. Specify the target bucket name to copy to.

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

Warning:

If both Source Bucket and Target Bucket have region information which are different, the Snap displays an error because it cannot perform the copy operation in two different regions unless they are “default” regions. Buckets are accessed without region names.

Default value: N/A

Example:
Target Object Key String/Expression/ Suggestion Required. Specify the target object key to copy.

Default value: N/A

Example: def/stu.csv

Show Advanced Properties Checkbox

Displays Advanced Properties when you select this checkbox.

Select this checkbox to display the advanced properties.

Deselect this checkbox to hide the properties.

Default status: Deselected
Thread Pool Size Integer/Expression

Maximum number of threads to be used to copy 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, not with an input document. Therefore, the value of this property remains constant throughout a pipeline execution.

Default value: 10
Multipart Size (MB) Integer/Expression

Appears when you select the Show Advanced Properties checkbox

Specify the multipart size in MB:

  • The minimum multipart size is 5 MB.

  • The maximum multipart size is 5 GB.

  • The maximum number of parts in an S3 object is 10,000, and the maximum size of an S3 object is 5 TB.

  • To copy S3 objects that are more than 100 GB, the Multipart Size should be larger than the possible S3 object size divided by 10,000.

Default value: 100MB

Example: 180
Maximum Retries Integer/Expression

Appears when you select the Show Advanced Properties checkbox.

Specify the maximum number of retry attempts to perform in case of a temporary network loss.

Default value: 3

Example: 5
Pass Through 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.

Default status: Deselected
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