CmdID

CmdID / aws / aws workdocs

aws workdocs describe-comments

List all the comments for the specified document version. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To list all comments for a specified document version

The following describe-comments example lists all the comments for the specified document version.

aws workdocs describe-comments --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920Identify
--document-idThe ID of the document.
--version-idThe ID of the document version.
Its output
{
    "Comments": [
        {
            "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
            "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
            "Text": "This is a comment.",
            "Contributor": {
                "Username": "arn:aws:iam::123456789012:user/exampleUser",
                "Type": "USER"
            },
            "CreatedTimestamp": 1534799058.197,
            "Status": "PUBLISHED",
            "Visibility": "PUBLIC"
        }
    ]
}

Options

5 in the AWS CLI reference
--authentication-tokenAmazon WorkDocs authentication token.
--document-idThe ID of the document.
--limitThe maximum number of items to return.
--markerThe marker for the next set of results.
--version-idThe ID of the document version.