...
To delete multiple S3 objects, use the S3 Browser Snap as the upstream Snap with Bucket and Object Key fields expression-enabled.
When the specified object does not exist, the Snap displays the
'200 OK'
status in the output document without any error.
...
Snap Type
The S3 Delete Snap is a WRITEWrite-type Snap that writes the status of the deleted S3 objects.
...
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps |
---|---|---|---|
Input | Document |
|
|
Output | Document |
|
|
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 |
:
|
Learn more about Error handling in Pipelines. |
Snap Settings
Info |
---|
|
Field Name | Field Type | Field Dependency | Description |
---|---|---|---|
Label* Default Value: S3 Delete | String | N/A | Specify a unique name for the Snap. |
Bucket* Default Value: |
Example:
None
|
<S3_bucket_name>@<s3_endpoint>
)
| String/Expression/Suggestion | N/A | Specify the S3 bucket name where the S3 object to be deleted is located.
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>@<endpoint>
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.
|
Object Key* Default Value: |
None |
| String/Expression/Suggestion | N/A | Specify 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 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. |
this checkbox to hide the properties. | ||
Thread Pool Size Default Value: 10 | Integer/Expression | Appears |
when you select Show Advanced Properties checkbox. | Specify the maximum number of threads to be used to delete multiple S3 objects in parallel with Bucket and Object Key properties expression-enabled. 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. | |
Maximum Retries* Default Value: 3 | 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. | ||
Pass Through Default Value: Deselected | Checkbox | Appears |
when you select 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: | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
Example
S3 Browser | Refer Managing-Data-in-S3.
Downloads
Info |
---|
|
Attachments | ||||
---|---|---|---|---|
|
Snap Pack History
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
Related Links
...
...