aws workdocs create-comment

Adds a new comment to the specified document version. AWS CLI reference

1 example 8 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To add a new comment

The following create-comment example adds a new comment to the specified document version.

aws workdocs create-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --text "This is a comment."

Identify

--document-idThe ID of the document.

--version-idThe ID of the document version.

--textThe text of the comment.

Its output

{
    "Comment": {
        "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
        "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
        "Text": "This is a comment.",
        "Contributor": {
            "Id": "arn:aws:iam::123456789012:user/exampleUser",
            "Username": "exampleUser",
            "GivenName": "Example",
            "Surname": "User",
            "Status": "ACTIVE"
        },
        "CreatedTimestamp": 1534799058.197,
        "Status": "PUBLISHED",
        "Visibility": "PUBLIC"
    }
}

Options

8 in the AWS CLI reference

--authentication-tokenAmazon WorkDocs authentication token.

--document-idThe ID of the document.

--notify-collaboratorsSet this parameter to TRUE to send an email out to the document collaborators after the comment is created.

--parent-idThe ID of the parent comment.

--textThe text of the comment.

--thread-idThe ID of the root comment in the thread.

--version-idThe ID of the document version.

--visibilityThe visibility of the comment.