Network.AWS.WorkDocs.CreateComment

Adds a new comment to the specified document version.

Creating a Request

createComment

Arguments

:: Text

ccDocumentId

-> Text

ccVersionId

-> Text

ccText

-> CreateComment

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

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

• ccNotifyCollaborators - Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
• ccAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• ccVisibility - The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
• ccThreadId - The ID of the root comment in the thread.
• ccParentId - The ID of the parent comment.
• ccDocumentId - The ID of the document.
• ccVersionId - The ID of the document version.
• ccText - The text of the comment.

data CreateComment

See: createComment smart constructor.

Instances

Eq CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

(==) :: CreateComment -> CreateComment -> Bool

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

Data CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateComment -> c CreateComment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateComment

toConstr :: CreateComment -> Constr

dataTypeOf :: CreateComment -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateComment)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateComment)

gmapT :: (forall b. Data b => b -> b) -> CreateComment -> CreateComment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateComment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateComment -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateComment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateComment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateComment -> m CreateComment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateComment -> m CreateComment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateComment -> m CreateComment

Show CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

showsPrec :: Int -> CreateComment -> ShowS

show :: CreateComment -> String

showList :: [CreateComment] -> ShowS

Generic CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Associated Types

type Rep CreateComment :: Type -> Type

Methods

from :: CreateComment -> Rep CreateComment x

to :: Rep CreateComment x -> CreateComment

Hashable CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

hashWithSalt :: Int -> CreateComment -> Int

hash :: CreateComment -> Int

ToJSON CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

toJSON :: CreateComment -> Value

toEncoding :: CreateComment -> Encoding

toJSONList :: [CreateComment] -> Value

toEncodingList :: [CreateComment] -> Encoding

AWSRequest CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Associated Types

type Rs CreateComment :: Type

Methods

request :: CreateComment -> Request CreateComment

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateComment -> ClientResponse -> m (Response CreateComment)

ToHeaders CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

toHeaders :: CreateComment -> [Header]

ToPath CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

toPath :: CreateComment -> ByteString

ToQuery CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

toQuery :: CreateComment -> QueryString

NFData CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

Methods

rnf :: CreateComment -> ()

type Rep CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

type Rep CreateComment = D1 (MetaData "CreateComment" "Network.AWS.WorkDocs.CreateComment" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "CreateComment'" PrefixI True) (((S1 (MetaSel (Just "_ccNotifyCollaborators") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_ccAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 (MetaSel (Just "_ccVisibility") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CommentVisibilityType)) :*: S1 (MetaSel (Just "_ccThreadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ccParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ccVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ccText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))))))

type Rs CreateComment

Defined in Network.AWS.WorkDocs.CreateComment

type Rs CreateComment = CreateCommentResponse

Request Lenses

ccNotifyCollaborators :: Lens' CreateComment (Maybe Bool)

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

ccAuthenticationToken :: Lens' CreateComment (Maybe Text)

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

ccVisibility :: Lens' CreateComment (Maybe CommentVisibilityType)

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

ccThreadId :: Lens' CreateComment (Maybe Text)

The ID of the root comment in the thread.

ccParentId :: Lens' CreateComment (Maybe Text)

The ID of the parent comment.

ccDocumentId :: Lens' CreateComment Text

The ID of the document.

ccVersionId :: Lens' CreateComment Text

The ID of the document version.

ccText :: Lens' CreateComment Text

The text of the comment.

Destructuring the Response

createCommentResponse

Arguments

:: Int

ccrsResponseStatus

-> CreateCommentResponse

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

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

• ccrsComment - The comment that has been created.
• ccrsResponseStatus - -- | The response status code.

data CreateCommentResponse

See: createCommentResponse smart constructor.

Instances

Eq CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

Methods

(==) :: CreateCommentResponse -> CreateCommentResponse -> Bool

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

Data CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCommentResponse -> c CreateCommentResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCommentResponse

toConstr :: CreateCommentResponse -> Constr

dataTypeOf :: CreateCommentResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateCommentResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCommentResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateCommentResponse -> CreateCommentResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCommentResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCommentResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateCommentResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCommentResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCommentResponse -> m CreateCommentResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCommentResponse -> m CreateCommentResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCommentResponse -> m CreateCommentResponse

Show CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

Methods

showsPrec :: Int -> CreateCommentResponse -> ShowS

show :: CreateCommentResponse -> String

showList :: [CreateCommentResponse] -> ShowS

Generic CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

Associated Types

type Rep CreateCommentResponse :: Type -> Type

Methods

from :: CreateCommentResponse -> Rep CreateCommentResponse x

to :: Rep CreateCommentResponse x -> CreateCommentResponse

NFData CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

Methods

rnf :: CreateCommentResponse -> ()

type Rep CreateCommentResponse

Defined in Network.AWS.WorkDocs.CreateComment

type Rep CreateCommentResponse = D1 (MetaData "CreateCommentResponse" "Network.AWS.WorkDocs.CreateComment" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "CreateCommentResponse'" PrefixI True) (S1 (MetaSel (Just "_ccrsComment") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Comment)) :*: S1 (MetaSel (Just "_ccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ccrsComment :: Lens' CreateCommentResponse (Maybe Comment)

The comment that has been created.

ccrsResponseStatus :: Lens' CreateCommentResponse Int

• - | The response status code.