Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.WorkDocs.DeleteComment

Contents

Description

Deletes the specified comment from the document version.

Synopsis

Creating a Request

deleteComment Source #

Arguments

:: Text	`delDocumentId`
-> Text	`delVersionId`
-> Text	`delCommentId`
-> DeleteComment

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

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

delAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
delDocumentId - The ID of the document.
delVersionId - The ID of the document version.
delCommentId - The ID of the comment.

data DeleteComment Source #

See: deleteComment smart constructor.

Instances

Eq DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods (==) :: DeleteComment -> DeleteComment -> Bool # (/=) :: DeleteComment -> DeleteComment -> Bool #
Data DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteComment -> c DeleteComment # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteComment # toConstr :: DeleteComment -> Constr # dataTypeOf :: DeleteComment -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteComment) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteComment) # gmapT :: (forall b. Data b => b -> b) -> DeleteComment -> DeleteComment # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteComment -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteComment -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteComment -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteComment -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteComment -> m DeleteComment # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteComment -> m DeleteComment # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteComment -> m DeleteComment #
Show DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods showsPrec :: Int -> DeleteComment -> ShowS # show :: DeleteComment -> String # showList :: [DeleteComment] -> ShowS #
Generic DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Associated Types type Rep DeleteComment :: Type -> Type # Methods from :: DeleteComment -> Rep DeleteComment x # to :: Rep DeleteComment x -> DeleteComment #
Hashable DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods hashWithSalt :: Int -> DeleteComment -> Int # hash :: DeleteComment -> Int #
AWSRequest DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Associated Types type Rs DeleteComment :: Type # Methods request :: DeleteComment -> Request DeleteComment # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DeleteComment -> ClientResponse -> m (Response DeleteComment) #
ToHeaders DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods toHeaders :: DeleteComment -> [Header] #
ToPath DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods toPath :: DeleteComment -> ByteString #
ToQuery DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods toQuery :: DeleteComment -> QueryString #
NFData DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods rnf :: DeleteComment -> () #
type Rep DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment type Rep DeleteComment = D1 (MetaData "DeleteComment" "Network.AWS.WorkDocs.DeleteComment" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DeleteComment'" PrefixI True) ((S1 (MetaSel (Just "_delAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_delDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_delVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_delCommentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DeleteComment Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment type Rs DeleteComment = DeleteCommentResponse

Request Lenses

delAuthenticationToken :: Lens' DeleteComment (Maybe Text) Source #

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

delDocumentId :: Lens' DeleteComment Text Source #

The ID of the document.

delVersionId :: Lens' DeleteComment Text Source #

The ID of the document version.

delCommentId :: Lens' DeleteComment Text Source #

The ID of the comment.

Destructuring the Response

deleteCommentResponse :: DeleteCommentResponse Source #

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

data DeleteCommentResponse Source #

See: deleteCommentResponse smart constructor.

Instances

Eq DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods (==) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # (/=) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool #
Data DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteCommentResponse -> c DeleteCommentResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteCommentResponse # toConstr :: DeleteCommentResponse -> Constr # dataTypeOf :: DeleteCommentResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteCommentResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteCommentResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteCommentResponse -> DeleteCommentResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCommentResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCommentResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteCommentResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteCommentResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteCommentResponse -> m DeleteCommentResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCommentResponse -> m DeleteCommentResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCommentResponse -> m DeleteCommentResponse #
Read DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods readsPrec :: Int -> ReadS DeleteCommentResponse # readList :: ReadS [DeleteCommentResponse] # readPrec :: ReadPrec DeleteCommentResponse # readListPrec :: ReadPrec [DeleteCommentResponse] #
Show DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods showsPrec :: Int -> DeleteCommentResponse -> ShowS # show :: DeleteCommentResponse -> String # showList :: [DeleteCommentResponse] -> ShowS #
Generic DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Associated Types type Rep DeleteCommentResponse :: Type -> Type # Methods from :: DeleteCommentResponse -> Rep DeleteCommentResponse x # to :: Rep DeleteCommentResponse x -> DeleteCommentResponse #
NFData DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment Methods rnf :: DeleteCommentResponse -> () #
type Rep DeleteCommentResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DeleteComment type Rep DeleteCommentResponse = D1 (MetaData "DeleteCommentResponse" "Network.AWS.WorkDocs.DeleteComment" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DeleteCommentResponse'" PrefixI False) (U1 :: Type -> Type))