Copyright	(c) 2013-2021 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

Amazonka.WorkDocs.DeleteComment

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified comment from the document version.

Synopsis

Creating a Request

data DeleteComment Source #

See: newDeleteComment smart constructor.

Constructors

DeleteComment'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. documentId :: Text The ID of the document. versionId :: Text The ID of the document version. commentId :: Text The ID of the comment.

Instances

Instances details

Eq DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods (==) :: DeleteComment -> DeleteComment -> Bool # (/=) :: DeleteComment -> DeleteComment -> Bool #
Show DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods showsPrec :: Int -> DeleteComment -> ShowS # show :: DeleteComment -> String # showList :: [DeleteComment] -> ShowS #
Generic DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Associated Types type Rep DeleteComment :: Type -> Type # Methods from :: DeleteComment -> Rep DeleteComment x # to :: Rep DeleteComment x -> DeleteComment #
NFData DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods rnf :: DeleteComment -> () #
Hashable DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods hashWithSalt :: Int -> DeleteComment -> Int # hash :: DeleteComment -> Int #
AWSRequest DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Associated Types type AWSResponse DeleteComment # Methods request :: DeleteComment -> Request DeleteComment # response :: MonadResource m => Logger -> Service -> Proxy DeleteComment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteComment))) #
ToHeaders DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods toHeaders :: DeleteComment -> [Header] #
ToPath DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods toPath :: DeleteComment -> ByteString #
ToQuery DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods toQuery :: DeleteComment -> QueryString #
type Rep DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment type Rep DeleteComment = D1 ('MetaData "DeleteComment" "Amazonka.WorkDocs.DeleteComment" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "DeleteComment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "commentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteComment Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment type AWSResponse DeleteComment = DeleteCommentResponse

newDeleteComment Source #

Arguments

:: Text	`$sel:documentId:DeleteComment'`
-> Text	`$sel:versionId:DeleteComment'`
-> Text	`$sel:commentId:DeleteComment'`
-> DeleteComment

Create a value of DeleteComment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationToken:DeleteComment', deleteComment_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:documentId:DeleteComment', deleteComment_documentId - The ID of the document.

$sel:versionId:DeleteComment', deleteComment_versionId - The ID of the document version.

$sel:commentId:DeleteComment', deleteComment_commentId - The ID of the comment.

Request Lenses

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

deleteComment_documentId :: Lens' DeleteComment Text Source #

The ID of the document.

deleteComment_versionId :: Lens' DeleteComment Text Source #

The ID of the document version.

deleteComment_commentId :: Lens' DeleteComment Text Source #

The ID of the comment.

Destructuring the Response

data DeleteCommentResponse Source #

See: newDeleteCommentResponse smart constructor.

Constructors

DeleteCommentResponse'

Instances

Instances details

Eq DeleteCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods (==) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool # (/=) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool #
Read DeleteCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods readsPrec :: Int -> ReadS DeleteCommentResponse # readList :: ReadS [DeleteCommentResponse] # readPrec :: ReadPrec DeleteCommentResponse # readListPrec :: ReadPrec [DeleteCommentResponse] #
Show DeleteCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment Methods showsPrec :: Int -> DeleteCommentResponse -> ShowS # show :: DeleteCommentResponse -> String # showList :: [DeleteCommentResponse] -> ShowS #
Generic DeleteCommentResponse Source #
Instance details Defined in Amazonka.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 Amazonka.WorkDocs.DeleteComment Methods rnf :: DeleteCommentResponse -> () #
type Rep DeleteCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteComment type Rep DeleteCommentResponse = D1 ('MetaData "DeleteCommentResponse" "Amazonka.WorkDocs.DeleteComment" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "DeleteCommentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCommentResponse :: DeleteCommentResponse Source #

Create a value of DeleteCommentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.