| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.S3.DeleteObject
Description
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.
See: AWS API Reference for DeleteObject.
- deleteObject :: BucketName -> ObjectKey -> DeleteObject
- data DeleteObject
- doVersionId :: Lens' DeleteObject (Maybe ObjectVersionId)
- doMFA :: Lens' DeleteObject (Maybe Text)
- doRequestPayer :: Lens' DeleteObject (Maybe RequestPayer)
- doBucket :: Lens' DeleteObject BucketName
- doKey :: Lens' DeleteObject ObjectKey
- deleteObjectResponse :: Int -> DeleteObjectResponse
- data DeleteObjectResponse
- dorsRequestCharged :: Lens' DeleteObjectResponse (Maybe RequestCharged)
- dorsVersionId :: Lens' DeleteObjectResponse (Maybe ObjectVersionId)
- dorsDeleteMarker :: Lens' DeleteObjectResponse (Maybe Bool)
- dorsResponseStatus :: Lens' DeleteObjectResponse Int
Creating a Request
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> DeleteObject |
Creates a value of DeleteObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeleteObject Source
See: deleteObject smart constructor.
Instances
Request Lenses
doVersionId :: Lens' DeleteObject (Maybe ObjectVersionId) Source
VersionId used to reference a specific version of the object.
doMFA :: Lens' DeleteObject (Maybe Text) Source
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
doRequestPayer :: Lens' DeleteObject (Maybe RequestPayer) Source
Undocumented member.
doBucket :: Lens' DeleteObject BucketName Source
Undocumented member.
doKey :: Lens' DeleteObject ObjectKey Source
Undocumented member.
Destructuring the Response
Arguments
| :: Int | |
| -> DeleteObjectResponse |
Creates a value of DeleteObjectResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeleteObjectResponse Source
See: deleteObjectResponse smart constructor.
Response Lenses
dorsRequestCharged :: Lens' DeleteObjectResponse (Maybe RequestCharged) Source
Undocumented member.
dorsVersionId :: Lens' DeleteObjectResponse (Maybe ObjectVersionId) Source
Returns the version ID of the delete marker created as a result of the DELETE operation.
dorsDeleteMarker :: Lens' DeleteObjectResponse (Maybe Bool) Source
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
dorsResponseStatus :: Lens' DeleteObjectResponse Int Source
The response status code.