Versions Compared

Old Version 24

changes.mady.by.user Cindy Hall

Saved on

compared with

New Version 25

changes.mady.by.user Cindy Hall

Saved on

Key

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

...

Field Name

Type

Field Dependency

Description

Label*

Default Value: S3 Download
Example: S3 Download

String

N/A

Specify a unique name for the Snap.

Bucket*

Default Value: None
Examples: 

String/Expression/Suggestion

N/A

Specify the S3 bucket name, from where an S3 object is to be downloaded.

Note

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

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

Object Key

Default Value: None
Examples: 

  • test.csv

  • abc/test.json

  • abc/xyz/test.xml

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

Checkbox

N/A

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

Thread Pool Size

Default Value: 10

Integer/Expression

Appears 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
Example: 5

Integer/Expression

Appears when you select Show Advanced Properties checkbox.

Specify the maximum number of retry attempts to perform in case of a temporary network loss.

Version ID

Default Value:  N/A
Example:   xvcnB8gPi37l3hbOzlsRFxjVwQ.numQz

String/Expression/Suggestion

Appears 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. S3 versioning is not supported in S3 Express One Zone.

You can use the Suggestion (blue star) icon to view the list of version IDs for the S3 object in the Object Key field. Each line in the suggested list also includes the last modified date and the file size to help you select a version. If the versioning is not enabled in the S3 bucket, no version ID is suggested.

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: 

  • If an S3 object had existed before enabling the versioning; therefore, its version does not have any version ID assigned to it.

  • Any version ID with a 'Deleted Marker' resource type.

Version ID Suggestion Interval

Use this field set to configure the time interval for the version ID suggestion.

  • Enter two separate rows to enter a start date and an end date. If you provide only one row, the suggestion interval is considered from the specified data until the current date.

  • If you leave this field empty, the Snap suggests all version IDs. This may be helpful when a specific S3 file has many versions. This property is used only for the Version ID suggestion, not during the Snap preview or execution.

Year

Default value: N/A
Example:  2017

Integer

Appears when you select Show Advanced Properties checkbox.

Enter the year as a 4-digit integer.

Month

Default value: N/A
Examples: 9, 09, 12

Integer

Appears when you select Show Advanced Properties checkbox.

Enter the month as an integer.

Date

Default value:  N/A
Examples: 28, 09, 12

Integer

Appears when you select Show Advanced Properties checkbox.

Enter the day of the month.

Zone

Default value:  N/A
Example: US/Pacific

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.

Note

Only zone IDs are supported in the suggested list.

Get Object Tags

Default Value: Not selected

Checkbox

Appears 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 S3:GetObjectTagging permission to be able to use this feature.

  • S3 object tagging is not supported in S3 Express One Zone.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

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.

...