...
You can use this Snap to download S3 objects from the S3 bucket.
...
Snap Type
The S3 Download Snap is a READRead-type Snap.
Prerequisites
None.
...
The current Snap functionality supports the AWS S3 Cloud Service and will be is applicable for the AWSGovCloud setup.
Known Issues
...
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| An upstream Snap is optional. Any document with key-value pairs to evaluate expression properties in the S3 Download Snap. Each input document, if any, results in one download operation of the Snap. |
Output | Binary |
|
| Binary data downloaded from AWS S3 is specified in the Bucket and Object Key fields with header information about the binary stream. |
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:
Learn more about Error handling in Pipelines. |
...
Field Name | Type | Field Dependency | Description | |||
---|---|---|---|---|---|---|
Label* Default Value: S3 Download | String | N/A | Specify a unique name for the Snap. | |||
Bucket* Default Value: [ None]
| String/Expression/Suggestion | N/A | Specify the S3 bucket name, from where an S3 object is to be downloaded.
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. | |||
Object Key Default Value: [ None]
| String/Expression/Suggestion | N/A | Specify or select the S3 object key name, which may include one or more forward-slash '/' characters. The forward-slash character is part of the S3 object key name, and there is no folder object defined in AWS S3. The Snap uses the existing Object Key value as a prefix to produce the suggested list. The maximum length of the suggested list is 1,000. | |||
Show Advanced Properties Default Value: Deselected | CheckboxDisplays Advanced Properties when you select this checkbox. | N/A | Select this checkbox to display the advanced properties. | |||
Thread Pool Size Default Value: 10 | Integer/Expression | Appears on selecting when you select Show Advanced Properties checkbox. | Specify the maximum number of threads to use to download multiple S3 objects in parallel. | |||
Maximum Retries* Default Value: 3 | Integer/Expression | Appears on selecting when you select Show Advanced Properties checkbox. | Specify the maximum number of retry attempts to to perform in case of a temporary network loss. | |||
Version ID Default Value: N/A | String/Expression/Suggestion | Appears on selecting when you select Show Advanced Properties checkbox. | Specify or select the version ID of the S3 file object. If you leave this field empty, the Snap downloads the latest version. You can use the Suggestion When you specify a static value in this field, you must enter only the version ID. The Snap ignores the last modified date and size information of a version when it downloads the version. The versions for the following cases are ignored in the suggested list because you cannot download them:
| |||
Version ID Suggestion Interval | Use this field set fieldset to configure the time interval for the version ID suggestion.
| |||||
Year Default value: N/A | Integer | Appears on selecting when you select Show Advanced Properties checkbox. | Enter the year as a 4-digit integer. | |||
Month Default value: N/A | Integer | Appears on selecting when you select Show Advanced Properties checkbox. | Enter the month as an integer. | |||
Date Default value: N/A | Integer | Appears on selecting when you select Show Advanced Properties checkbox. | Enter the day of the month. | |||
Zone Default value: N/A | String/Suggestion | Appears on selecting Show Advanced Properties checkbox. | Enter or select a time zone ID from the suggested list. For the UTC time zone, this field may be empty.
| |||
Get Object Tags Default Value: Not selected | Checkbox | Appears on selecting when you select Show Advanced Properties checkbox. | Select this property to include object tags in the header of the output binary data. Learn more about object tags. You must have the | |||
Snap Execution Default Value: Validate & Execute | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
...
Info |
---|
|
...
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Related Links
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
...