Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
List all the comments for the specified document version.
Synopsis
- describeComments :: Text -> Text -> DescribeComments
- data DescribeComments
- dcAuthenticationToken :: Lens' DescribeComments (Maybe Text)
- dcMarker :: Lens' DescribeComments (Maybe Text)
- dcLimit :: Lens' DescribeComments (Maybe Natural)
- dcDocumentId :: Lens' DescribeComments Text
- dcVersionId :: Lens' DescribeComments Text
- describeCommentsResponse :: Int -> DescribeCommentsResponse
- data DescribeCommentsResponse
- dcrsMarker :: Lens' DescribeCommentsResponse (Maybe Text)
- dcrsComments :: Lens' DescribeCommentsResponse [Comment]
- dcrsResponseStatus :: Lens' DescribeCommentsResponse Int
Creating a Request
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
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.
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
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.
dcrsResponseStatus :: Lens' DescribeCommentsResponse Int Source #
- - | The response status code.