...
Field Name | Field Type | Field Dependency | Description | ||
---|---|---|---|---|---|
Label* Default Value: S3 Browser | String | N/A | Specify a unique name for the Snap. | ||
Bucket* Default Value: N/A
| String/Expression/Suggestion | N/A | Specify or select the S3 bucket name, from where the S3 objects are to be listed.
Note: When you enter an incorrect region name, but with a valid bucket name, AWS S3 service may successfully access the bucket without any error.
| ||
Prefix Default Value: None
| String/Expression/Suggestion | N/A | Specify the prefix of S3 object key names. When you specify the Bucket and Prefix field values and leave default values for the remaining fields, the Snap lists all S3 objects matching the prefix in the bucket. | ||
Filter Default Value: **
| String/Expression | N/A | Specify the filter the Snap should use internally to list all S3 objects. The Snap matches the specified Bucket and Prefix and then applies the filter. A glob pattern of <Prefix> + <Filter> is applied to the entire string of each S3 object key.
| ||
Show Advanced Properties Default Value: Deselected | Checkbox | Displays Advanced Properties when you select this checkbox. | Select this checkbox to display the advanced properties. | ||
Maximum Object Keys Default Value: All | String/Integer/Expression | Appears on selecting Show Advanced Properties checkbox. | Specify the maximum number of object keys at the output view. ‘All’ or an empty field produces all matching object key names. If the Delimiter is blank, the Maximum Object Keys are the number of object keys in the first output view plus the number of common prefixes in the second output view regardless of the the second output view being open or closed. | ||
Ignore Empty Result Default Value: Selected | Checkbox | Appears on selecting Show Advanced Properties checkbox. | Select this checkbox if you want the Snap to produce no output when there is no matching S3 object key. Else, the Snap outputs a blank document when there are no matching S3 object keys. | ||
Maximum Retries* Default Value: 3 | 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 under the ' | ||
Delimiter
| String/Expression | Appears on selecting Show Advanced Properties checkbox. | Specify an optional delimiter to produce object keys that contain the same string between the prefix and the first occurrence of the delimiter. A delimiter '/' causes the Snap to produce a nonrecursive object-key listing. When the Delimiter field is not empty and if there is a common prefix, it is displayed in the second output view. The common prefix is similar to a subfolder with one or more S3 objects in it. | ||
Snap Execution Default Value: Validate & Execute | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
Example
Basic Use Case - Managing Data in S3
This example Pipeline basic use case demonstrates how to do perfrom the following operations using the Amazon S3 Snaps from the S3 Snap Pack:
Upload a single JSON file in the S3 object.
Copy the file,
List the S3 Object and its attributes.
Download the file.
Delete the file.
...
Configure key-value pairs containing parameters to pass to the Pipeline during execution.
Configure the JSON Generator Snap with sample data as follows.
Configure the JSON Formatter Snap to format the data. You can view the JSON binary data in the output preview of the Snap.
Configure the S3 Upload Snap to upload the binary data to S3 objects residing in the S3 bucket.
Configure the S3 Copy Snap to copy the S3 object from source folder to target folder.
Configure the S3 Browser Snap to list the attributes for S3 objects.
Configure the S3 Download Snap to download S3 objects.
As the output is in binary format, you need to convert the binary data to document data using the Binary to Document Snap.
Configure the S3 Delete Snap to delete the S3 objects. You can view the status of the deleted object in the output preview.
...