NAME

Paws::WorkDocs::CreateComment - Arguments for method CreateComment on Paws::WorkDocs

DESCRIPTION

This class represents the parameters used for calling the method CreateComment on the Amazon WorkDocs service. Use the attributes of this class as arguments to method CreateComment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateComment.

SYNOPSIS

    my $workdocs = Paws->service('WorkDocs');
    my $CreateCommentResponse = $workdocs->CreateComment(
      DocumentId          => 'MyResourceIdType',
      Text                => 'MyCommentTextType',
      VersionId           => 'MyDocumentVersionIdType',
      AuthenticationToken => 'MyAuthenticationHeaderType',    # OPTIONAL
      NotifyCollaborators => 1,                               # OPTIONAL
      ParentId            => 'MyCommentIdType',               # OPTIONAL
      ThreadId            => 'MyCommentIdType',               # OPTIONAL
      Visibility          => 'PUBLIC',                        # OPTIONAL
    );
    # Results:
    my $Comment = $CreateCommentResponse->Comment;
    # Returns a L<Paws::WorkDocs::CreateCommentResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/workdocs/CreateComment>

ATTRIBUTES

AuthenticationToken => Str

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

REQUIRED DocumentId => Str

The ID of the document.

NotifyCollaborators => Bool

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

ParentId => Str

The ID of the parent comment.

REQUIRED Text => Str

The text of the comment.

ThreadId => Str

The ID of the root comment in the thread.

REQUIRED VersionId => Str

The ID of the document version.

Visibility => Str

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.

Valid values are: "PUBLIC", "PRIVATE"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>