Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

DescribeComments

class WorkDocs.Paginator.DescribeComments
paginator = client.get_paginator('describe_comments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_comments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
  • DocumentId (string) --

    [REQUIRED]

    The ID of the document.

  • VersionId (string) --

    [REQUIRED]

    The ID of the document version.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Comments': [
        {
            'CommentId': 'string',
            'ParentId': 'string',
            'ThreadId': 'string',
            'Text': 'string',
            'Contributor': {
                'Id': 'string',
                'Username': 'string',
                'EmailAddress': 'string',
                'GivenName': 'string',
                'Surname': 'string',
                'OrganizationId': 'string',
                'RootFolderId': 'string',
                'RecycleBinFolderId': 'string',
                'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'TimeZoneId': 'string',
                'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                'Storage': {
                    'StorageUtilizedInBytes': 123,
                    'StorageRule': {
                        'StorageAllocatedInBytes': 123,
                        'StorageType': 'UNLIMITED'|'QUOTA'
                    }
                }
            },
            'CreatedTimestamp': datetime(2015, 1, 1),
            'Status': 'DRAFT'|'PUBLISHED'|'DELETED',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'RecipientId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Comments (list) --

      The list of comments for the specified document version.

      • (dict) --

        Describes a comment.

        • CommentId (string) --

          The ID of the comment.

        • ParentId (string) --

          The ID of the parent comment.

        • ThreadId (string) --

          The ID of the root comment in the thread.

        • Text (string) --

          The text of the comment.

        • Contributor (dict) --

          The details of the user who made the comment.

          • Id (string) --

            The ID of the user.

          • Username (string) --

            The login name of the user.

          • EmailAddress (string) --

            The email address of the user.

          • GivenName (string) --

            The given name of the user.

          • Surname (string) --

            The surname of the user.

          • OrganizationId (string) --

            The ID of the organization.

          • RootFolderId (string) --

            The ID of the root folder.

          • RecycleBinFolderId (string) --

            The ID of the recycle bin folder.

          • Status (string) --

            The status of the user.

          • Type (string) --

            The type of user.

          • CreatedTimestamp (datetime) --

            The time when the user was created.

          • ModifiedTimestamp (datetime) --

            The time when the user was modified.

          • TimeZoneId (string) --

            The time zone ID of the user.

          • Locale (string) --

            The locale of the user.

          • Storage (dict) --

            The storage for the user.

            • StorageUtilizedInBytes (integer) --

              The amount of storage used, in bytes.

            • StorageRule (dict) --

              The storage for a user.

              • StorageAllocatedInBytes (integer) --

                The amount of storage allocated, in bytes.

              • StorageType (string) --

                The type of storage.

        • CreatedTimestamp (datetime) --

          The time that the comment was created.

        • Status (string) --

          The status of the comment.

        • Visibility (string) --

          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.

        • RecipientId (string) --

          If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

    • NextToken (string) --

      A token to resume pagination.