amazonka-workdocs-1.5.0: Amazon WorkDocs 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.WorkDocs.DeleteComment

Contents

Description

Deletes the specified comment from the document version.

Synopsis

Creating a Request

deleteComment Source #

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. This field should not be set 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 # 
Data DeleteComment Source # 

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 # 
Generic DeleteComment Source # 

Associated Types

type Rep DeleteComment :: * -> * #

Hashable DeleteComment Source # 
NFData DeleteComment Source # 

Methods

rnf :: DeleteComment -> () #

AWSRequest DeleteComment Source # 
ToQuery DeleteComment Source # 
ToPath DeleteComment Source # 
ToHeaders DeleteComment Source # 
type Rep DeleteComment Source # 
type Rep DeleteComment = D1 (MetaData "DeleteComment" "Network.AWS.WorkDocs.DeleteComment" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DeleteComment'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_delAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_delDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_delVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_delCommentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DeleteComment Source # 

Request Lenses

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

Amazon WorkDocs authentication token. This field should not be set 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 # 
Data DeleteCommentResponse Source # 

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 # 
Show DeleteCommentResponse Source # 
Generic DeleteCommentResponse Source # 
NFData DeleteCommentResponse Source # 

Methods

rnf :: DeleteCommentResponse -> () #

type Rep DeleteCommentResponse Source # 
type Rep DeleteCommentResponse = D1 (MetaData "DeleteCommentResponse" "Network.AWS.WorkDocs.DeleteComment" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DeleteCommentResponse'" PrefixI False) U1)