Amazonka.WorkDocs.DeleteComment

Deletes the specified comment from the document version.

Creating a Request

data DeleteComment

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

ToHeaders DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

toHeaders :: DeleteComment -> [Header]

ToPath DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

toPath :: DeleteComment -> ByteString

ToQuery DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

toQuery :: DeleteComment -> QueryString

AWSRequest DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Associated Types

type AWSResponse DeleteComment

Methods

request :: (Service -> Service) -> DeleteComment -> Request DeleteComment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteComment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteComment)))

Generic DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Associated Types

type Rep DeleteComment :: Type -> Type

Methods

from :: DeleteComment -> Rep DeleteComment x

to :: Rep DeleteComment x -> DeleteComment

Show DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

showsPrec :: Int -> DeleteComment -> ShowS

show :: DeleteComment -> String

showList :: [DeleteComment] -> ShowS

NFData DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

rnf :: DeleteComment -> ()

Eq DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

(==) :: DeleteComment -> DeleteComment -> Bool

(/=) :: DeleteComment -> DeleteComment -> Bool

Hashable DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

Methods

hashWithSalt :: Int -> DeleteComment -> Int

hash :: DeleteComment -> Int

type AWSResponse DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

type AWSResponse DeleteComment = DeleteCommentResponse

type Rep DeleteComment

Defined in Amazonka.WorkDocs.DeleteComment

type Rep DeleteComment = D1 ('MetaData "DeleteComment" "Amazonka.WorkDocs.DeleteComment" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" '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))))

newDeleteComment

Arguments

:: Text

$sel:documentId:DeleteComment'

-> Text

DeleteComment

-> Text

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.

DeleteComment, deleteComment_versionId - The ID of the document version.

DeleteComment, deleteComment_commentId - The ID of the comment.

Request Lenses

deleteComment_authenticationToken :: Lens' DeleteComment (Maybe Text)

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

deleteComment_documentId :: Lens' DeleteComment Text

The ID of the document.

deleteComment_versionId :: Lens' DeleteComment Text

The ID of the document version.

deleteComment_commentId :: Lens' DeleteComment Text

The ID of the comment.

Destructuring the Response

data DeleteCommentResponse

See: newDeleteCommentResponse smart constructor.

Constructors

DeleteCommentResponse'

Instances

Generic DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

Associated Types

type Rep DeleteCommentResponse :: Type -> Type

Methods

from :: DeleteCommentResponse -> Rep DeleteCommentResponse x

to :: Rep DeleteCommentResponse x -> DeleteCommentResponse

Read DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

Methods

readsPrec :: Int -> ReadS DeleteCommentResponse

readList :: ReadS [DeleteCommentResponse]

readPrec :: ReadPrec DeleteCommentResponse

readListPrec :: ReadPrec [DeleteCommentResponse]

Show DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

Methods

showsPrec :: Int -> DeleteCommentResponse -> ShowS

show :: DeleteCommentResponse -> String

showList :: [DeleteCommentResponse] -> ShowS

NFData DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

Methods

rnf :: DeleteCommentResponse -> ()

Eq DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

Methods

(==) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool

(/=) :: DeleteCommentResponse -> DeleteCommentResponse -> Bool

type Rep DeleteCommentResponse

Defined in Amazonka.WorkDocs.DeleteComment

type Rep DeleteCommentResponse = D1 ('MetaData "DeleteCommentResponse" "Amazonka.WorkDocs.DeleteComment" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteCommentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCommentResponse :: DeleteCommentResponse

Create a value of DeleteCommentResponse with all optional fields omitted.

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