Copyright	(c) 2013-2017 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.S3.DeleteObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

Creating a Request

deleteObjects Source #

Arguments

:: BucketName	`dosBucket`
-> Delete	`dosDelete`
-> DeleteObjects

Creates a value of DeleteObjects with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dosMFA - The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
dosRequestPayer - Undocumented member.
dosBucket - Undocumented member.
dosDelete - Undocumented member.

data DeleteObjects Source #

See: deleteObjects smart constructor.

Instances

Eq DeleteObjects Source #
Methods (==) :: DeleteObjects -> DeleteObjects -> Bool # (/=) :: DeleteObjects -> DeleteObjects -> Bool #
Data DeleteObjects Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteObjects -> c DeleteObjects # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteObjects # toConstr :: DeleteObjects -> Constr # dataTypeOf :: DeleteObjects -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteObjects) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteObjects) # gmapT :: (forall b. Data b => b -> b) -> DeleteObjects -> DeleteObjects # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjects -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjects -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteObjects -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteObjects -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteObjects -> m DeleteObjects # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjects -> m DeleteObjects # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjects -> m DeleteObjects #
Read DeleteObjects Source #
Methods readsPrec :: Int -> ReadS DeleteObjects # readList :: ReadS [DeleteObjects] # readPrec :: ReadPrec DeleteObjects # readListPrec :: ReadPrec [DeleteObjects] #
Show DeleteObjects Source #
Methods showsPrec :: Int -> DeleteObjects -> ShowS # show :: DeleteObjects -> String # showList :: [DeleteObjects] -> ShowS #
Generic DeleteObjects Source #
Associated Types type Rep DeleteObjects :: * -> * # Methods from :: DeleteObjects -> Rep DeleteObjects x # to :: Rep DeleteObjects x -> DeleteObjects #
Hashable DeleteObjects Source #
Methods hashWithSalt :: Int -> DeleteObjects -> Int # hash :: DeleteObjects -> Int #
NFData DeleteObjects Source #
Methods rnf :: DeleteObjects -> () #
AWSRequest DeleteObjects Source #
Associated Types type Rs DeleteObjects :: * # Methods request :: DeleteObjects -> Request DeleteObjects # response :: MonadResource m => Logger -> Service -> Proxy * DeleteObjects -> ClientResponse -> m (Response DeleteObjects) #
ToElement DeleteObjects Source #
Methods toElement :: DeleteObjects -> Element #
ToQuery DeleteObjects Source #
Methods toQuery :: DeleteObjects -> QueryString #
ToPath DeleteObjects Source #
Methods toPath :: DeleteObjects -> ByteString #
ToHeaders DeleteObjects Source #
Methods toHeaders :: DeleteObjects -> [Header] #
type Rep DeleteObjects Source #
type Rep DeleteObjects = D1 (MetaData "DeleteObjects" "Network.AWS.S3.DeleteObjects" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "DeleteObjects'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_dosMFA") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dosRequestPayer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestPayer)))) ((:*:) (S1 (MetaSel (Just Symbol "_dosBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName)) (S1 (MetaSel (Just Symbol "_dosDelete") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Delete)))))
type Rs DeleteObjects Source #
type Rs DeleteObjects = DeleteObjectsResponse

Request Lenses

dosMFA :: Lens' DeleteObjects (Maybe Text) Source #

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

dosRequestPayer :: Lens' DeleteObjects (Maybe RequestPayer) Source #

Undocumented member.

dosBucket :: Lens' DeleteObjects BucketName Source #

Undocumented member.

dosDelete :: Lens' DeleteObjects Delete Source #

Undocumented member.

Destructuring the Response

deleteObjectsResponse Source #

Arguments

:: Int	`drsResponseStatus`
-> DeleteObjectsResponse

Creates a value of DeleteObjectsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drsRequestCharged - Undocumented member.
drsDeleted - Undocumented member.
drsErrors - Undocumented member.
drsResponseStatus - -- | The response status code.

data DeleteObjectsResponse Source #

See: deleteObjectsResponse smart constructor.

Instances

Eq DeleteObjectsResponse Source #
Methods (==) :: DeleteObjectsResponse -> DeleteObjectsResponse -> Bool # (/=) :: DeleteObjectsResponse -> DeleteObjectsResponse -> Bool #
Data DeleteObjectsResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteObjectsResponse -> c DeleteObjectsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteObjectsResponse # toConstr :: DeleteObjectsResponse -> Constr # dataTypeOf :: DeleteObjectsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteObjectsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteObjectsResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteObjectsResponse -> DeleteObjectsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjectsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteObjectsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteObjectsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteObjectsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteObjectsResponse -> m DeleteObjectsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjectsResponse -> m DeleteObjectsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteObjectsResponse -> m DeleteObjectsResponse #
Read DeleteObjectsResponse Source #
Methods readsPrec :: Int -> ReadS DeleteObjectsResponse # readList :: ReadS [DeleteObjectsResponse] # readPrec :: ReadPrec DeleteObjectsResponse # readListPrec :: ReadPrec [DeleteObjectsResponse] #
Show DeleteObjectsResponse Source #
Methods showsPrec :: Int -> DeleteObjectsResponse -> ShowS # show :: DeleteObjectsResponse -> String # showList :: [DeleteObjectsResponse] -> ShowS #
Generic DeleteObjectsResponse Source #
Associated Types type Rep DeleteObjectsResponse :: * -> * # Methods from :: DeleteObjectsResponse -> Rep DeleteObjectsResponse x # to :: Rep DeleteObjectsResponse x -> DeleteObjectsResponse #
NFData DeleteObjectsResponse Source #
Methods rnf :: DeleteObjectsResponse -> () #
type Rep DeleteObjectsResponse Source #
type Rep DeleteObjectsResponse = D1 (MetaData "DeleteObjectsResponse" "Network.AWS.S3.DeleteObjects" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "DeleteObjectsResponse'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_drsRequestCharged") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestCharged))) (S1 (MetaSel (Just Symbol "_drsDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DeletedObject])))) ((:*:) (S1 (MetaSel (Just Symbol "_drsErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [S3ServiceError]))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

drsRequestCharged :: Lens' DeleteObjectsResponse (Maybe RequestCharged) Source #

Undocumented member.

drsDeleted :: Lens' DeleteObjectsResponse [DeletedObject] Source #

Undocumented member.

drsErrors :: Lens' DeleteObjectsResponse [S3ServiceError] Source #

Undocumented member.

drsResponseStatus :: Lens' DeleteObjectsResponse Int Source #

- | The response status code.