Skip to content
AWS for Query.Farm

aws.workdocs.describe_comments

Example SQL Queries

SELECT * FROM
aws.workdocs.describe_comments
WHERE
"document_id" = 'VALUE'
AND "version_id" = 'VALUE';

Description

List all the comments for the specified document version.

Table Definition

Column NameColumn Data Type
document_id Required Input Column

The ID of the document.

VARCHAR
version_id Required Input Column

The ID of the document version.

VARCHAR
authentication_token Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
comment_id

The ID of the comment.

VARCHAR
contributor

The details of the user who made the comment.

STRUCT(
    "id" VARCHAR,
    "username" VARCHAR,
    "email_address" VARCHAR,
    "given_name" VARCHAR,
    "surname" VARCHAR,
    "organization_id" VARCHAR,
    "root_folder_id" VARCHAR,
    "recycle_bin_folder_id" VARCHAR,
    "status" VARCHAR,
    "type" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "modified_timestamp" TIMESTAMP_S,
    "time_zone_id" VARCHAR,
    "locale" VARCHAR,
    "storage" STRUCT(
        "storage_utilized_in_bytes" BIGINT,
        "storage_rule" STRUCT(
            "storage_allocated_in_bytes" BIGINT,
            "storage_type" VARCHAR
        )
    )
)
Show child fields
contributor.created_timestamp

The time when the user was created.

contributor.email_address

The email address of the user.

contributor.given_name

The given name of the user.

contributor.id

The ID of the user.

contributor.locale

The locale of the user.

contributor.modified_timestamp

The time when the user was modified.

contributor.organization_id

The ID of the organization.

contributor.recycle_bin_folder_id

The ID of the recycle bin folder.

contributor.root_folder_id

The ID of the root folder.

contributor.status

The status of the user.

contributor.storage

The storage for the user.

Show child fields
contributor.storage.storage_rule

The storage for a user.

Show child fields
contributor.storage.storage_rule.storage_allocated_in_bytes

The amount of storage allocated, in bytes.

contributor.storage.storage_rule.storage_type

The type of storage.

contributor.storage.storage_utilized_in_bytes

The amount of storage used, in bytes.

contributor.surname

The surname of the user.

contributor.time_zone_id

The time zone ID of the user.

contributor.type

The type of user.

contributor.username

The login name of the user.

created_timestamp

The time that the comment was created.

TIMESTAMP_S
parent_id

The ID of the parent comment.

VARCHAR
recipient_id

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

VARCHAR
status

The status of the comment.

VARCHAR
text

The text of the comment.

VARCHAR
thread_id

The ID of the root comment in the thread.

VARCHAR
visibility

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.

VARCHAR