amazonka-s3-1.5.0: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.DeleteObject

Contents

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.

Synopsis

Creating a Request

deleteObject Source #

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:

  • doVersionId - VersionId used to reference a specific version of the object.
  • doMFA - The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
  • doRequestPayer - Undocumented member.
  • doBucket - Undocumented member.
  • doKey - Undocumented member.

data DeleteObject Source #

See: deleteObject smart constructor.

Instances

Eq DeleteObject Source # 
Data DeleteObject Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteObject -> c DeleteObject #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteObject #

toConstr :: DeleteObject -> Constr #

dataTypeOf :: DeleteObject -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteObject) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteObject) #

gmapT :: (forall b. Data b => b -> b) -> DeleteObject -> DeleteObject #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObject -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObject -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteObject -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteObject -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteObject -> m DeleteObject #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObject -> m DeleteObject #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObject -> m DeleteObject #

Read DeleteObject Source # 
Show DeleteObject Source # 
Generic DeleteObject Source # 

Associated Types

type Rep DeleteObject :: * -> * #

Hashable DeleteObject Source # 
NFData DeleteObject Source # 

Methods

rnf :: DeleteObject -> () #

AWSRequest DeleteObject Source # 
ToQuery DeleteObject Source # 
ToPath DeleteObject Source # 
ToHeaders DeleteObject Source # 
type Rep DeleteObject Source # 
type Rs DeleteObject Source # 

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.

doBucket :: Lens' DeleteObject BucketName Source #

Undocumented member.

doKey :: Lens' DeleteObject ObjectKey Source #

Undocumented member.

Destructuring the Response

deleteObjectResponse Source #

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:

  • dorsRequestCharged - Undocumented member.
  • dorsVersionId - Returns the version ID of the delete marker created as a result of the DELETE operation.
  • dorsDeleteMarker - Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
  • dorsResponseStatus - -- | The response status code.

data DeleteObjectResponse Source #

See: deleteObjectResponse smart constructor.

Instances

Eq DeleteObjectResponse Source # 
Data DeleteObjectResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteObjectResponse -> c DeleteObjectResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteObjectResponse #

toConstr :: DeleteObjectResponse -> Constr #

dataTypeOf :: DeleteObjectResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteObjectResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteObjectResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteObjectResponse -> DeleteObjectResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjectResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjectResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteObjectResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteObjectResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteObjectResponse -> m DeleteObjectResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjectResponse -> m DeleteObjectResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjectResponse -> m DeleteObjectResponse #

Read DeleteObjectResponse Source # 
Show DeleteObjectResponse Source # 
Generic DeleteObjectResponse Source # 
NFData DeleteObjectResponse Source # 

Methods

rnf :: DeleteObjectResponse -> () #

type Rep DeleteObjectResponse Source # 
type Rep DeleteObjectResponse = D1 (MetaData "DeleteObjectResponse" "Network.AWS.S3.DeleteObject" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "DeleteObjectResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dorsRequestCharged") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestCharged))) (S1 (MetaSel (Just Symbol "_dorsVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectVersionId)))) ((:*:) (S1 (MetaSel (Just Symbol "_dorsDeleteMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_dorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

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.