Skip to content
AWS for Query.Farm

aws.workdocs.describe_activities

Example SQL Queries

SELECT * FROM
aws.workdocs.describe_activities;

Description

Describes the user activities in a specified time period.

Table Definition

Column NameColumn Data Type
activity_types Input Column

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

VARCHAR
authentication_token Input Column

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

VARCHAR
end_time Input Column

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

TIMESTAMP_S
include_indirect_activities Input Column

Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

BOOLEAN
organization_id Input Column

The ID of the organization.

VARCHAR
resource_id Input Column

The document or folder ID for which to describe activity types.

VARCHAR
start_time Input Column

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

TIMESTAMP_S
user_id Input Column

The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

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_metadata

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

STRUCT(
    "comment_id" VARCHAR,
    "contributor" 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
            )
        )
    ),
    "created_timestamp" TIMESTAMP_S,
    "comment_status" VARCHAR,
    "recipient_id" VARCHAR,
    "contributor_id" VARCHAR
)
Show child fields
comment_metadata.comment_id

The ID of the comment.

comment_metadata.comment_status

The status of the comment.

comment_metadata.contributor

The user who made the comment.

Show child fields
comment_metadata.contributor.created_timestamp

The time when the user was created.

comment_metadata.contributor.email_address

The email address of the user.

comment_metadata.contributor.given_name

The given name of the user.

comment_metadata.contributor.id

The ID of the user.

comment_metadata.contributor.locale

The locale of the user.

comment_metadata.contributor.modified_timestamp

The time when the user was modified.

comment_metadata.contributor.organization_id

The ID of the organization.

comment_metadata.contributor.recycle_bin_folder_id

The ID of the recycle bin folder.

comment_metadata.contributor.root_folder_id

The ID of the root folder.

comment_metadata.contributor.status

The status of the user.

comment_metadata.contributor.storage

The storage for the user.

Show child fields
comment_metadata.contributor.storage.storage_rule

The storage for a user.

Show child fields
comment_metadata.contributor.storage.storage_rule.storage_allocated_in_bytes

The amount of storage allocated, in bytes.

comment_metadata.contributor.storage.storage_rule.storage_type

The type of storage.

comment_metadata.contributor.storage.storage_utilized_in_bytes

The amount of storage used, in bytes.

comment_metadata.contributor.surname

The surname of the user.

comment_metadata.contributor.time_zone_id

The time zone ID of the user.

comment_metadata.contributor.type

The type of user.

comment_metadata.contributor.username

The login name of the user.

comment_metadata.contributor_id

The ID of the user who made the comment.

comment_metadata.created_timestamp

The timestamp that the comment was created.

comment_metadata.recipient_id

The ID of the user being replied to.

initiator

The user who performed the action.

STRUCT(
    "id" VARCHAR,
    "username" VARCHAR,
    "given_name" VARCHAR,
    "surname" VARCHAR,
    "email_address" VARCHAR
)
Show child fields
initiator.email_address

The email address of the user.

initiator.given_name

The given name of the user before a rename operation.

initiator.id

The ID of the user.

initiator.surname

The surname of the user.

initiator.username

The name of the user.

is_indirect_activity

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

BOOLEAN
original_parent

The original parent of the resource. This is an optional field and is filled for move activities.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "original_name" VARCHAR,
    "id" VARCHAR,
    "version_id" VARCHAR,
    "owner" STRUCT(
        "id" VARCHAR,
        "username" VARCHAR,
        "given_name" VARCHAR,
        "surname" VARCHAR,
        "email_address" VARCHAR
    ),
    "parent_id" VARCHAR
)
Show child fields
original_parent.id

The ID of the resource.

original_parent.name

The name of the resource.

original_parent.original_name

The original name of the resource before a rename operation.

original_parent.owner

The owner of the resource.

Show child fields
original_parent.owner.email_address

The email address of the user.

original_parent.owner.given_name

The given name of the user before a rename operation.

original_parent.owner.id

The ID of the user.

original_parent.owner.surname

The surname of the user.

original_parent.owner.username

The name of the user.

original_parent.parent_id

The parent ID of the resource before a rename operation.

original_parent.type

The type of resource.

original_parent.version_id

The version ID of the resource. This is an optional field and is filled for action on document version.

participants

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

STRUCT(
    "users" STRUCT(
        "id" VARCHAR,
        "username" VARCHAR,
        "given_name" VARCHAR,
        "surname" VARCHAR,
        "email_address" VARCHAR
    )[],
    "groups" STRUCT(
        "id" VARCHAR,
        "name" VARCHAR
    )[]
)
Show child fields
participants.groups[]
Show child fields
participants.groups[].id

The ID of the user group.

participants.groups[].name

The name of the group.

participants.users[]
Show child fields
participants.users[].email_address

The email address of the user.

participants.users[].given_name

The given name of the user before a rename operation.

participants.users[].id

The ID of the user.

participants.users[].surname

The surname of the user.

participants.users[].username

The name of the user.

resource_metadata

The metadata of the resource involved in the user action.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "original_name" VARCHAR,
    "id" VARCHAR,
    "version_id" VARCHAR,
    "owner" STRUCT(
        "id" VARCHAR,
        "username" VARCHAR,
        "given_name" VARCHAR,
        "surname" VARCHAR,
        "email_address" VARCHAR
    ),
    "parent_id" VARCHAR
)
Show child fields
resource_metadata.id

The ID of the resource.

resource_metadata.name

The name of the resource.

resource_metadata.original_name

The original name of the resource before a rename operation.

resource_metadata.owner

The owner of the resource.

Show child fields
resource_metadata.owner.email_address

The email address of the user.

resource_metadata.owner.given_name

The given name of the user before a rename operation.

resource_metadata.owner.id

The ID of the user.

resource_metadata.owner.surname

The surname of the user.

resource_metadata.owner.username

The name of the user.

resource_metadata.parent_id

The parent ID of the resource before a rename operation.

resource_metadata.type

The type of resource.

resource_metadata.version_id

The version ID of the resource. This is an optional field and is filled for action on document version.

time_stamp

The timestamp when the action was performed.

TIMESTAMP_S
type

The activity type.

VARCHAR