Versions Compared

Key

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

In this article

...

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

...

Snap Type

S3 Copy Snap is a WRITEWrite-type Snap.

Prerequisites

None.

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

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

...

Field Name

Field Type

Field Dependency

Description

Label*

Default ValueS3 Copy
ExampleS3 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

String/Expression

N/A

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

Note

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

  • 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 a an S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name using the following syntax:

    • <S3_bucket_name>@<VPC_S3_endpoint>

Note: When you enter an incorrect region name, but if the bucket name is valid, the AWS S3 service may successfully access the bucket without any error.

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 have to must use '/’ to copy it.

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.

Target Bucket*

Default Value: N/A
Examples: xyzBucket

String/Expression

N/A

Specify the target bucket name to copy to.

Warning

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

Target Object Key*

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

String/Expression

N/A

Specify the target object key to copy.

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.

Show Advanced Properties

Default Value: Deselected

Checkbox

Displays Advanced Properties when you select this checkbox.

Select this checkbox to display the advanced properties.
Deselect the 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.

Maximum Retries

Default Value: 3
Example: 5

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

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.

...

Attachments
patterns*.slp, *.zip
sortByname

Insert excerpt
PREVIEW | Amazon S3 Snap PackPREVIEW |
Amazon S3 Snap Pack
nameS3 Snap Pack History
nopaneltrue

...