Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.DescribeComments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List all the comments for the specified document version.

This operation returns paginated results.

Synopsis

data DescribeComments = DescribeComments' {
- authenticationToken :: Maybe (Sensitive Text)
- limit :: Maybe Natural
- marker :: Maybe Text
- documentId :: Text
- versionId :: Text
}
newDescribeComments :: Text -> Text -> DescribeComments
describeComments_authenticationToken :: Lens' DescribeComments (Maybe Text)
describeComments_limit :: Lens' DescribeComments (Maybe Natural)
describeComments_marker :: Lens' DescribeComments (Maybe Text)
describeComments_documentId :: Lens' DescribeComments Text
describeComments_versionId :: Lens' DescribeComments Text
data DescribeCommentsResponse = DescribeCommentsResponse' {
- comments :: Maybe [Comment]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeCommentsResponse :: Int -> DescribeCommentsResponse
describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment])
describeCommentsResponse_marker :: Lens' DescribeCommentsResponse (Maybe Text)
describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int

Creating a Request

data DescribeComments Source #

See: newDescribeComments smart constructor.

Constructors

DescribeComments'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
limit :: Maybe Natural
The maximum number of items to return.
marker :: Maybe Text
The marker for the next set of results. This marker was received from a previous call.
documentId :: Text
The ID of the document.
versionId :: Text
The ID of the document version.

Instances

Instances details

ToHeaders DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods toHeaders :: DescribeComments -> [Header] #
ToPath DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods toPath :: DescribeComments -> ByteString #
ToQuery DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods toQuery :: DescribeComments -> QueryString #
AWSPager DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods page :: DescribeComments -> AWSResponse DescribeComments -> Maybe DescribeComments #
AWSRequest DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Associated Types type AWSResponse DescribeComments # Methods request :: (Service -> Service) -> DescribeComments -> Request DescribeComments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeComments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeComments))) #
Generic DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Associated Types type Rep DescribeComments :: Type -> Type # Methods from :: DescribeComments -> Rep DescribeComments x # to :: Rep DescribeComments x -> DescribeComments #
Show DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods showsPrec :: Int -> DescribeComments -> ShowS # show :: DescribeComments -> String # showList :: [DescribeComments] -> ShowS #
NFData DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods rnf :: DescribeComments -> () #
Eq DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods (==) :: DescribeComments -> DescribeComments -> Bool # (/=) :: DescribeComments -> DescribeComments -> Bool #
Hashable DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods hashWithSalt :: Int -> DescribeComments -> Int # hash :: DescribeComments -> Int #
type AWSResponse DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments type AWSResponse DescribeComments = DescribeCommentsResponse
type Rep DescribeComments Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments type Rep DescribeComments = D1 ('MetaData "DescribeComments" "Amazonka.WorkDocs.DescribeComments" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeComments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeComments Source #

Arguments

:: Text	`$sel:documentId:DescribeComments'`
-> Text	`DescribeComments`
-> DescribeComments

Create a value of DescribeComments 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:DescribeComments', describeComments_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:limit:DescribeComments', describeComments_limit - The maximum number of items to return.

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

$sel:documentId:DescribeComments', describeComments_documentId - The ID of the document.

DescribeComments, describeComments_versionId - The ID of the document version.

Request Lenses

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

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

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

The maximum number of items to return.

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

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

describeComments_documentId :: Lens' DescribeComments Text Source #

The ID of the document.

describeComments_versionId :: Lens' DescribeComments Text Source #

The ID of the document version.

Destructuring the Response

data DescribeCommentsResponse Source #

See: newDescribeCommentsResponse smart constructor.

Constructors

DescribeCommentsResponse'
Fields comments :: Maybe [Comment] The list of comments for the specified document version. marker :: Maybe Text The marker for the next set of results. This marker was received from a previous call. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeCommentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Associated Types type Rep DescribeCommentsResponse :: Type -> Type # Methods from :: DescribeCommentsResponse -> Rep DescribeCommentsResponse x # to :: Rep DescribeCommentsResponse x -> DescribeCommentsResponse #
Show DescribeCommentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods showsPrec :: Int -> DescribeCommentsResponse -> ShowS # show :: DescribeCommentsResponse -> String # showList :: [DescribeCommentsResponse] -> ShowS #
NFData DescribeCommentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods rnf :: DescribeCommentsResponse -> () #
Eq DescribeCommentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments Methods (==) :: DescribeCommentsResponse -> DescribeCommentsResponse -> Bool # (/=) :: DescribeCommentsResponse -> DescribeCommentsResponse -> Bool #
type Rep DescribeCommentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeComments type Rep DescribeCommentsResponse = D1 ('MetaData "DescribeCommentsResponse" "Amazonka.WorkDocs.DescribeComments" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeCommentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Comment])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCommentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeCommentsResponse'`
-> DescribeCommentsResponse

Create a value of DescribeCommentsResponse 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:comments:DescribeCommentsResponse', describeCommentsResponse_comments - The list of comments for the specified document version.

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

$sel:httpStatus:DescribeCommentsResponse', describeCommentsResponse_httpStatus - The response's http status code.

Response Lenses

describeCommentsResponse_comments :: Lens' DescribeCommentsResponse (Maybe [Comment]) Source #

The list of comments for the specified document version.

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

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

describeCommentsResponse_httpStatus :: Lens' DescribeCommentsResponse Int Source #

The response's http status code.