Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

Comment

Describes a comment.

Contents

CommentId

The ID of the comment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: Yes

Contributor

The details of the user who made the comment.

Type: User object

Required: No

CreatedTimestamp

The time that the comment was created.

Type: Timestamp

Required: No

ParentId

The ID of the parent comment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: No

RecipientId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Required: No

Status

The status of the comment.

Type: String

Valid Values: DRAFT | PUBLISHED | DELETED

Required: No

Text

The text of the comment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ThreadId

The ID of the root comment in the thread.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: No

Visibility

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.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: