Label*

Default Value: S3 Browser
Example: S3 Browser

String

N/A

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Bucket

Default Value: N/A
Example:

• mybucket

• mybucket@eu-west-1

• mybucket@s3.eu-west-1.amazonaws.com (an example of <S3_bucket_name>@<s3_endpoint>)

• testBucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com (an example of <S3_bucket>@<VPC_S3_endpoint>)

String/Expression

N/A

Specify the S3 bucket name, from where S3 objects are to be listed.

Prefix

Default Value: [None]
Examples: 

• test

• test/

• abc/xyz/

Integer/Expression

N/A

Specify the prefix of S3 object key names. If Bucket and Prefix are given and all other properties are at default values, the Snap lists all S3 objects matching the prefix in the bucket. An object key can be selected from the suggested list and edited for the prefix. The maximum length of the suggested list is 1,000. If Prefix is expression-enabled, it can be evaluated from an input header document as well as a pipeline parameter.

Filter

Default Value: [None]
Examples: 

• *.csv Matches an object name that represents a file name ending in .csv

• * .* Matches object names containing a dot

• {.csv, .json} Matches object names ending with .csv or .json

• foo.? Matches object names starting with foo. and a single character extension

• home/*/*Matches home/gus/data

• home/**. Matches home/gus and home/gus/data

Integer/Expression

N/A

Specify the filter the Snap should use internally to list all S3 objects first matching given bucket and prefix. Filter is applied to the entire string of each S3 object key. Filter is a glob pattern which is defined as following:

• The * character matches zero or more characters of an S3 object name without crossing '/' boundaries.

• The ** characters matches zero or more characters crossing '/' boundaries.

• The ? character matches exactly one character of a name component.

• The backslash character (\) is used to escape characters that would otherwise be interpreted as special characters. The expression \\ matches a single backslash and "\{" matches a left brace for example.

• The [ ] characters are a bracket expression that match a single character of a name component out of a set of characters. For example, [abc] matches "a", "b", or "c". The hyphen (-) may be used to specify a range so [a-z] specifies a range that matches from "a" to "z" (inclusive). These forms can be mixed so [abce-g] matches "a", "b", "c", "e", "f" or "g". If the character after the [ is a ! then it is used for negation so [!a-c] matches any character except "a", "b", or "c".

  Within a bracket expression the *, ? and \ characters match themselves. The (-) character matches itself if it is the first character within the brackets, or the first character after the ! if negating.

• The { } characters are a group of subpatterns, where the group matches if any subpattern in the group matches. The "," character is used to separate the subpatterns. Groups cannot be nested.

• Leading period and dot characters in names are treated as regular characters in match operations. For example, the "*" glob pattern matches file name ".login".

Show Advanced Properties

Checkbox

N/A

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

Maximum Object Keys

Integer/Expression

Appears on selecting Show Advanced Properties checkbox.

Maximum number of object keys at the output view. ‘All’ or an empty field produces all matching object key names.

Examples: 2500

Default Value: All

Ignore Empty Result

Checkbox

Appears on selecting Show Advanced Properties checkbox.

If selected and there is no matching S3 object key, the Snap produces no output document, and if not selected, an empty document.

Default Value: Selected

Maximum Retries*

Default Value: 3
Examples: 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: Not Selected

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 .

Delimiter

Default Value: [None]
Examples: /

Integer/Expression

Appears on selecting Show Advanced Properties checkbox.

Optional delimiter that causes to produce object keys that contain the same string between the prefix and the first occurrence of the delimiter. For example, a delimiter '/' causes the Snap to produce a non-recursive object-key listing.

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.

Account validation failed.

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

Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.