Network.AWS.WorkDocs.DescribeComments

List all the comments for the specified document version.

Creating a Request

describeComments

Arguments

:: Text

dcDocumentId

-> Text

dcVersionId

-> DescribeComments

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. This field should not be set 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

See: describeComments smart constructor.

Instances

Eq DescribeComments

Methods

(==) :: DescribeComments -> DescribeComments -> Bool

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

Data 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

Methods

showsPrec :: Int -> DescribeComments -> ShowS

show :: DescribeComments -> String

showList :: [DescribeComments] -> ShowS

Generic DescribeComments

Associated Types

type Rep DescribeComments :: * -> *

Methods

from :: DescribeComments -> Rep DescribeComments x

to :: Rep DescribeComments x -> DescribeComments

Hashable DescribeComments

Methods

hashWithSalt :: Int -> DescribeComments -> Int

hash :: DescribeComments -> Int

NFData DescribeComments

Methods

rnf :: DescribeComments -> ()

AWSRequest DescribeComments

Associated Types

type Rs DescribeComments :: *

Methods

request :: DescribeComments -> Request DescribeComments

response :: MonadResource m => Logger -> Service -> Proxy * DescribeComments -> ClientResponse -> m (Response DescribeComments)

ToQuery DescribeComments

Methods

toQuery :: DescribeComments -> QueryString

ToPath DescribeComments

Methods

toPath :: DescribeComments -> ByteString

ToHeaders DescribeComments

Methods

toHeaders :: DescribeComments -> [Header]

type Rep DescribeComments

type Rep DescribeComments = D1 (MetaData "DescribeComments" "Network.AWS.WorkDocs.DescribeComments" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeComments'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dcAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_dcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dcLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_dcDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dcVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs DescribeComments

type Rs DescribeComments = DescribeCommentsResponse

Request Lenses

dcAuthenticationToken :: Lens' DescribeComments (Maybe Text)

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

dcMarker :: Lens' DescribeComments (Maybe Text)

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

dcLimit :: Lens' DescribeComments (Maybe Natural)

The maximum number of items to return.

dcDocumentId :: Lens' DescribeComments Text

The ID of the document.

dcVersionId :: Lens' DescribeComments Text

The ID of the document version.

Destructuring the Response

describeCommentsResponse

Arguments

:: Int

dcrsResponseStatus

-> DescribeCommentsResponse

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

See: describeCommentsResponse smart constructor.

Instances

Eq DescribeCommentsResponse

Methods

(==) :: DescribeCommentsResponse -> DescribeCommentsResponse -> Bool

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

Data DescribeCommentsResponse

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

Methods

showsPrec :: Int -> DescribeCommentsResponse -> ShowS

show :: DescribeCommentsResponse -> String

showList :: [DescribeCommentsResponse] -> ShowS

Generic DescribeCommentsResponse

Associated Types

type Rep DescribeCommentsResponse :: * -> *

Methods

from :: DescribeCommentsResponse -> Rep DescribeCommentsResponse x

to :: Rep DescribeCommentsResponse x -> DescribeCommentsResponse

NFData DescribeCommentsResponse

Methods

rnf :: DescribeCommentsResponse -> ()

type Rep DescribeCommentsResponse

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

Response Lenses

dcrsMarker :: Lens' DescribeCommentsResponse (Maybe Text)

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

dcrsComments :: Lens' DescribeCommentsResponse [Comment]

The list of comments for the specified document version.

dcrsResponseStatus :: Lens' DescribeCommentsResponse Int

• - | The response status code.