Input 

Document

• Min: 0

• Max: 1

• Mapper

• S3 Upload

• S3 Browser

Output

Document

• Min: 0

• Max: 1

• S3 Browser

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.

Label*

Default Value: S3 Copy
Example: S3 Copy

String

N/A

Specify a unique name for the Snap.

Source Bucket*

Default Value: None
Examples: 

• mybucket

• mybucket@eu-west-1

• Example of S3 Bucket in S3 region:

  • mybucket@s3.eu-west-1.amazonaws.com

• 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

• Example of S3 Express One Zone bucket:

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

String/Expression

N/A

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

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.

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

Source Object Key*

Default Value: None
Examples: 

• test.csv

• abc/test.json

• abc/xyz/test.xml

String/Expression

N/A

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.

Target Bucket*

Default Value: N/A
Examples: 

• mybucket

• mybucket@eu-west-1

• Example of S3 Bucket in S3 region:

  • mybucket@s3.eu-west-1.amazonaws.com

• 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

• Example of S3 Express One Zone bucket:

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

String/Expression

N/A

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.

Target Object Key*

Default Value: N/A
Examples: def/stu.csv

String/Expression

N/A

Specify the target object key to copy.

Show Advanced Properties

Default Value: Deselected

Checkbox

Displays Advanced Properties when you select this checkbox.

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

Thread Pool Size

Default Value: 10

Integer/Expression

Appears on selecting Show Advanced Properties checkbox.

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.

Multipart Size (MB)

Default Value: 100MB

Integer/Expression

Appears on selecting 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.

Maximum Retries

Default Value: 3
Example: 5

Integer/Expression

Appears on selecting 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

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.