This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AWS.S3.
Summary
Removes the null version (if there is one) of an object and inserts a delete
marker, which becomes the latest version of the object. If there isn't a null
version, Amazon S3 does not remove any objects.
- Assembly
- Cake
.AWS .S3 .dll - Namespace
- Cake
.AWS .S3 - Containing Type
- IS3Manager
Syntax
Task Delete(string key, string version, S3Settings settings, CancellationToken cancellationToken = null)Parameters
| Name | Type | Description |
|---|---|---|
| key | string | The key under which the Amazon S3 object is stored. |
| version | string | The identifier for the specific version of the object to be deleted, if required. |
| settings | S3Settings | The S3Settings required to delete from Amazon S3. |
| cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
| Type | Description |
|---|---|
| Task |