S3 Restore
In this article
Overview
You can use this Snap to restore an archived S3 object in an S3 bucket.
Snap Type
The S3 Restore Snap is a Write-type Snap.
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.
Support for Ultra Pipelines
Works in Ultra Pipelines.Â
Limitations and Known Issues
None.
Snap Views
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. |
Output | Document  |
|
| 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 while 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. |
Snap Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Field Dependency | Description |
---|---|---|---|
Label* Â Default Value:Â S3 Restore | String | None | 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:Â None
| String/Expression/Suggestion | None   | Specify the S3 bucket name where the S3 object to be restored is located. Do not add S3:/// before the bucket name, because the Snap can fail.
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. |
Object Key* Default Value: None
| String/Expression/Suggestion | None | 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. |
Expiration (Days) Default Value: 1 Minimum Value: 1 | Integer Expression | None | 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. |
Retrieval Tier
| Dropdown list | None | Choose one of the available S3 Glacier retrieval tiers: Bulk, Standard, or Expedited. |
Check Status Until Completed Default Value: Deselected Examples:Â Selected | Checkbox | None | Select this checkbox to poll the job status of restoring an archived S3 object until it is completed. |
Check Status Interval (Minutes) Default Value: 10 Minimum Value: 1 | 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. Â |
Show Advanced Properties Default Value: Deselected | Checkbox | None | Select this checkbox to display the advanced properties. |
Thread Pool Size Default Value: 10 | 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. |
Maximum Retries* Default Value: 3 | Integer/Expression | Appears when you select the 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 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 ' |
Snap Execution Default Value:Â Execute only | Dropdown list | None | Select one of the following three modes in which the Snap executes:
|
Examples
Browsing and Restoring Amazon S3 Objects
This example Pipeline demonstrates how to browse an S3 object and then restore it.
Prerequisites: A valid AWS S3 Account
Configure the S3 Browser Snap to browse the mrtest/test100.json object from the mrtest bucket.
Â
Validate the Pipeline. The output displays the details of the browsed S3 object. Note that the storage class (GlacierFlexibleRetrieval) is eligible for restoration.
Â
Next, configure the S3 Restore Snap to restore the S3 object, which is currently archived.
Â
Validate the Pipeline. The output displays the details of the restored S3 object, including the restoration status of the object (Restore requested or Restore completed).
When Check Status Until Completed is not selected:
When Check Status Until Completed is selected:
Downloads
Snap Pack History
Related Links
Â
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.