Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

Activity

Describes the activity information.

Contents

CommentMetadata

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

Type: CommentMetadata object

Required: No

Initiator

The user who performed the action.

Type: UserMetadata object

Required: No

OrganizationId

The ID of the organization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Required: No

OriginalParent

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

Type: ResourceMetadata object

Required: No

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.

Type: Participants object

Required: No

ResourceMetadata

The metadata of the resource involved in the user action.

Type: ResourceMetadata object

Required: No

TimeStamp

The timestamp when the action was performed.

Type: Timestamp

Required: No

Type

The activity type.

Type: String

Valid Values: DOCUMENT_CHECKED_IN | DOCUMENT_CHECKED_OUT | DOCUMENT_RENAMED | DOCUMENT_VERSION_UPLOADED | DOCUMENT_VERSION_DELETED | 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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: