You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkDocs::Types::DeleteCommentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DeleteCommentRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  document_id: "ResourceIdType", # required
  version_id: "DocumentVersionIdType", # required
  comment_id: "CommentIdType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


658
659
660
661
662
663
664
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 658

class DeleteCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :comment_id)
  include Aws::Structure
end

#comment_idString

The ID of the comment.

Returns:

  • (String)


658
659
660
661
662
663
664
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 658

class DeleteCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :comment_id)
  include Aws::Structure
end

#document_idString

The ID of the document.

Returns:

  • (String)


658
659
660
661
662
663
664
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 658

class DeleteCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :comment_id)
  include Aws::Structure
end

#version_idString

The ID of the document version.

Returns:

  • (String)


658
659
660
661
662
663
664
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 658

class DeleteCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :comment_id)
  include Aws::Structure
end