create-comment¶
Description¶
Adds a new comment to the specified document version.
See also: AWS API Documentation
Synopsis¶
create-comment
[--authentication-token <value>]
--document-id <value>
--version-id <value>
[--parent-id <value>]
[--thread-id <value>]
--text <value>
[--visibility <value>]
[--notify-collaborators | --no-notify-collaborators]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--authentication-token (string)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
--document-id (string)
The ID of the document.
--version-id (string)
The ID of the document version.
--parent-id (string)
The ID of the parent comment.
--thread-id (string)
The ID of the root comment in the thread.
--text (string)
The text 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.
Possible values:
PUBLIC
PRIVATE
--notify-collaborators | --no-notify-collaborators (boolean)
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To add a new comment
This example adds a new comment to the specified document version.
Command:
aws workdocs create-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --text "This is a comment."
Output:
{
"Comment": {
"CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"Text": "This is a comment.",
"Contributor": {
"Id": "arn:aws:iam::123456789123:user/exampleUser",
"Username": "exampleUser",
"GivenName": "Example",
"Surname": "User",
"Status": "ACTIVE"
},
"CreatedTimestamp": 1534799058.197,
"Status": "PUBLISHED",
"Visibility": "PUBLIC"
}
}
Output¶
Comment -> (structure)
The comment that has been created.
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 -> (structure)
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 -> (timestamp)
The time when the user was created.
ModifiedTimestamp -> (timestamp)
The time when the user was modified.
TimeZoneId -> (string)
The time zone ID of the user.
Locale -> (string)
The locale of the user.
Storage -> (structure)
The storage for the user.
StorageUtilizedInBytes -> (long)
The amount of storage used, in bytes.
StorageRule -> (structure)
The storage for a user.
StorageAllocatedInBytes -> (long)
The amount of storage allocated, in bytes.
StorageType -> (string)
The type of storage.
CreatedTimestamp -> (timestamp)
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.