activities

Creates, updates, deletes, gets or lists an activities resource.

Overview

Name	activities
Type	Resource
Id	aws.workdocs.activities

Fields

The following fields are returned by SELECT queries:

describe_activities

Name	Datatype	Description
comment_metadata	object	Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
initiator	object	The user who performed the action.
is_indirect_activity	boolean	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).
organization_id	string	The ID of the organization. (pattern: <code>[&\w+-.@]+</code>)
original_parent	object	The original parent of the resource. This is an optional field and is filled for move activities.
participants	object	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.
resource_metadata	object	The metadata of the resource involved in the user action.
time_stamp	string (date-time)	The timestamp when the action was performed.
type	string	The activity type. (DOCUMENT_CHECKED_IN, DOCUMENT_CHECKED_OUT, DOCUMENT_RENAMED, DOCUMENT_VERSION_UPLOADED, DOCUMENT_VERSION_DELETED, DOCUMENT_VERSION_VIEWED, DOCUMENT_VERSION_DOWNLOADED, DOCUMENT_RECYCLED, DOCUMENT_RESTORED, DOCUMENT_REVERTED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, DOCUMENT_SHARE_PERMISSION_CHANGED, DOCUMENT_SHAREABLE_LINK_CREATED, DOCUMENT_SHAREABLE_LINK_REMOVED, DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED, DOCUMENT_MOVED, DOCUMENT_COMMENT_ADDED, DOCUMENT_COMMENT_DELETED, DOCUMENT_ANNOTATION_ADDED, DOCUMENT_ANNOTATION_DELETED, FOLDER_CREATED, FOLDER_DELETED, FOLDER_RENAMED, FOLDER_RECYCLED, FOLDER_RESTORED, FOLDER_SHARED, FOLDER_UNSHARED, FOLDER_SHARE_PERMISSION_CHANGED, FOLDER_SHAREABLE_LINK_CREATED, FOLDER_SHAREABLE_LINK_REMOVED, FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED, FOLDER_MOVED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_activities	select	region	Authentication, startTime, endTime, organizationId, activityTypes, resourceId, userId, includeIndirectActivities, limit, marker	Describes the user activities in a specified time period.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Authentication	string	Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
activityTypes	string	Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
endTime	string (date-time)	The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
includeIndirectActivities	boolean	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).
limit	integer	The maximum number of items to return.
marker	string	The marker for the next set of results.
organizationId	string	The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
resourceId	string	The document or folder ID for which to describe activity types.
startTime	string (date-time)	The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
userId	string	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.

SELECT examples

describe_activities

Describes the user activities in a specified time period.

SELECT
comment_metadata,
initiator,
is_indirect_activity,
organization_id,
original_parent,
participants,
resource_metadata,
time_stamp,
type
FROM aws.workdocs.activities
WHERE region = '{{ region }}' -- required
AND Authentication = '{{ Authentication }}'
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND organizationId = '{{ organizationId }}'
AND activityTypes = '{{ activityTypes }}'
AND resourceId = '{{ resourceId }}'
AND userId = '{{ userId }}'
AND includeIndirectActivities = '{{ includeIndirectActivities }}'
AND limit = '{{ limit }}'
AND marker = '{{ marker }}'
;