S3 Restore

Overview

You can use this Snap to restore an archived S3 object in an S3 bucket.



Prerequisites

  • A valid account with the required permissions.

  • The S3 object should have been archived by changing its storage class to GlacierFlexibleRetrieval or DeepArchive before executing the S3 Restore Snap.

Snap views

View Description Examples of upstream and downstream Snaps
Input An upstream Snap is optional. Any document with key-value pairs to evaluate expression properties.
Output When Check Status Until Completed is selected in Settings:


When Check Status Until Completed is not selected in Settings:
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 when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with 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.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: S3 Restore

Example: Restore Invoice
Bucket String/Expression/ Suggestion

Required. Specify the S3 bucket name where the S3 object to be restored is located.

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

  • 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 using the following syntax:

    • <S3_bucket_name>@<region_name>

  • You can also access the S3 bucket in an S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name using the following syntax:

    • <S3_bucket_name>@<VPC_S3_endpoint>

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

Default value: None.

Examples:

  • mybucket

  • mybucket@eu-west-1

  • S3 Bucket in S3 region:

  • 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
Object Key Dropdown list/Expression

Required. Specify the S3 object key name, which may include one or more forward-slash ('/') characters.

The S3 object should have been archived by changing its storage class to GlacierFlexibleRetrieval or DeepArchive before executing the S3 Restore Snap.

Note: The forward-slash character is part of the S3 object key name and there is no folder object defined in AWS S3. The maximum length of the suggested list is 1,000.

Default value: None.

Examples:

  • test.csv

  • abc/test.json

  • abc/xyz/test.xml
Expiration (Days) Integer/Expression

Enter the lifetime of the active copy of the S3 object in days.

If an S3 object's restoring process is completed, the content of the S3 object can be accessed until its active copy expires.

Default value: 1

Minimum value: 1

Example: 2
Retrieval Tier Dropdown list/Expression

Choose one of the available S3 Glacier retrieval tiers: Bulk, Standard, or Expedited.

Default value: None.

Example:

  • Bulk

  • Standard

  • Expedited
Check Status Until Completed Checkbox Select this checkbox to poll the job status of restoring an archived S3 object until it is completed.
Note: The restore process may take 5 to 12 hours. When this checkbox is selected, the Snap checks the S3 object restore status continuously in a given interval until the restore is completed.

Default status: Deselected
Check Status Interval (Minutes) Integer/Expression Appears when you select the Check Status Until Completed checkbox.

Enter the minimum amount of time in minutes to pause between the polling of the job status of restoring an archived S3 object.

Default value: 10

Minimum value: 1

Example: 30
Show Advanced Properties Checkbox Select this checkbox to display the advanced properties.

Deselect this checkbox to hide the properties.

Default status: Deselected
Thread Pool Size Integer/Expression Appears when you select the Show Advanced Properties checkbox.
Specify the maximum number of threads to be used to restore multiple S3 objects in parallel with Bucket and Object Key properties expression-enabled.
Note: If the Thread Pool Size property is expression-enabled, it can be evaluated with a Pipeline parameter, but not with an input document. Therefore, the value of this property remains constant throughout the Pipeline execution.

Default value: 10

Example: 20
Maximum Retries Integer/Expression

Appears when you select the Show Advanced Properties checkbox.

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

Default value: 3

Example: 2
Pass Through Checkbox Appears when you select the Show Advanced Properties checkbox.

Select this checkbox to pass the input document to the output view as a value to the 'original' key .

Default status: Deselected
Snap execution Dropdown list
Choose 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.

Default value: Execute only

Example: Validate & Execute

Examples