amazonka-workdocs-1.6.1: Amazon WorkDocs SDK.

Copyright(c) 2013-2018 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.DescribeComments

Contents

Description

List all the comments for the specified document version.

Synopsis

Creating a Request

describeComments Source #

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

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

  • dcAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
  • dcMarker - The marker for the next set of results. This marker was received from a previous call.
  • dcLimit - The maximum number of items to return.
  • dcDocumentId - The ID of the document.
  • dcVersionId - The ID of the document version.

data DescribeComments Source #

See: describeComments smart constructor.

Instances
Eq DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Data DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Methods

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

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

toConstr :: DescribeComments -> Constr #

dataTypeOf :: DescribeComments -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeComments -> DescribeComments #

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

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

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

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

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

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

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

Show DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Generic DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Associated Types

type Rep DescribeComments :: Type -> Type #

Hashable DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

AWSRequest DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Associated Types

type Rs DescribeComments :: Type #

ToHeaders DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

ToPath DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

ToQuery DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

NFData DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Methods

rnf :: DescribeComments -> () #

type Rep DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

type Rep DescribeComments = D1 (MetaData "DescribeComments" "Network.AWS.WorkDocs.DescribeComments" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeComments'" PrefixI True) ((S1 (MetaSel (Just "_dcAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 (MetaSel (Just "_dcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dcLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: (S1 (MetaSel (Just "_dcDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dcVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeComments Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Request Lenses

dcAuthenticationToken :: Lens' DescribeComments (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.

dcMarker :: Lens' DescribeComments (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

dcLimit :: Lens' DescribeComments (Maybe Natural) Source #

The maximum number of items to return.

dcDocumentId :: Lens' DescribeComments Text Source #

The ID of the document.

dcVersionId :: Lens' DescribeComments Text Source #

The ID of the document version.

Destructuring the Response

describeCommentsResponse Source #

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

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

  • dcrsMarker - The marker for the next set of results. This marker was received from a previous call.
  • dcrsComments - The list of comments for the specified document version.
  • dcrsResponseStatus - -- | The response status code.

data DescribeCommentsResponse Source #

See: describeCommentsResponse smart constructor.

Instances
Eq DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Data DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Methods

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

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

toConstr :: DescribeCommentsResponse -> Constr #

dataTypeOf :: DescribeCommentsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeCommentsResponse -> DescribeCommentsResponse #

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

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

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

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

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

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

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

Show DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Generic DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

Associated Types

type Rep DescribeCommentsResponse :: Type -> Type #

NFData DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

type Rep DescribeCommentsResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeComments

type Rep DescribeCommentsResponse = D1 (MetaData "DescribeCommentsResponse" "Network.AWS.WorkDocs.DescribeComments" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeCommentsResponse'" PrefixI True) (S1 (MetaSel (Just "_dcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dcrsComments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Comment])) :*: S1 (MetaSel (Just "_dcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dcrsMarker :: Lens' DescribeCommentsResponse (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

dcrsComments :: Lens' DescribeCommentsResponse [Comment] Source #

The list of comments for the specified document version.