User user
The user information.
String type
The activity type.
Date timeStamp
The timestamp when the action was performed.
Boolean isIndirectActivity
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).
String organizationId
The ID of the organization.
UserMetadata initiator
The user who performed the action.
Participants 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.
ResourceMetadata resourceMetadata
The metadata of the resource involved in the user action.
ResourceMetadata originalParent
The original parent of the resource. This is an optional field and is filled for move activities.
CommentMetadata commentMetadata
Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String resourceId
The ID of the resource.
List<E> principals
The users, groups, or organization being granted permission.
NotificationOptions notificationOptions
The notification options.
String commentId
The ID of the comment.
String parentId
The ID of the parent comment.
String threadId
The ID of the root comment in the thread.
String text
The text of the comment.
User contributor
The details of the user who made the comment.
Date createdTimestamp
The time that the comment was created.
String status
The status of the comment.
String 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.
String recipientId
If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
String commentId
The ID of the comment.
User contributor
The user who made the comment.
Date createdTimestamp
The timestamp that the comment was created.
String commentStatus
The status of the comment.
String recipientId
The ID of the user being replied to.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String versionId
The ID of the document version.
String parentId
The ID of the parent comment.
String threadId
The ID of the root comment in the thread.
String text
The text of the comment.
String 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.
Boolean notifyCollaborators
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
Comment comment
The comment that has been created.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String resourceId
The ID of the resource.
String versionId
The ID of the version, if the custom metadata is being added to a document version.
Map<K,V> customMetadata
Custom metadata in the form of name-value pairs.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String name
The name of the new folder.
String parentFolderId
The ID of the parent folder.
FolderMetadata metadata
The metadata of the folder.
String resourceId
The ID of the resource.
List<E> labels
List of labels to add to the resource.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String organizationId
The ID of the organization.
String endpoint
The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with
https.
String protocol
The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
String subscriptionType
The notification type.
Subscription subscription
The subscription.
String organizationId
The ID of the organization.
String username
The login name of the user.
String emailAddress
The email address of the user.
String givenName
The given name of the user.
String surname
The surname of the user.
String password
The password of the user.
String timeZoneId
The time zone ID of the user.
StorageRuleType storageRule
The amount of storage for the user.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
User user
The user information.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String versionId
The ID of the document version.
String commentId
The ID of the comment.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String resourceId
The ID of the resource, either a document or folder.
String versionId
The ID of the version, if the custom metadata is being deleted from a document version.
List<E> keys
List of properties to remove.
Boolean deleteAll
Flag to indicate removal of all custom metadata properties from the specified resource.
String resourceId
The ID of the resource.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
List<E> labels
List of labels to delete from the resource.
Boolean deleteAll
Flag to request removal of all labels from the specified resource.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
Date startTime
The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
Date endTime
The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
String organizationId
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
String activityTypes
Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
String resourceId
The document or folder ID for which to describe activity types.
String userId
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.
Boolean includeIndirectActivities
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).
Integer limit
The maximum number of items to return.
String marker
The marker for the next set of results.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String versionId
The ID of the document version.
Integer limit
The maximum number of items to return.
String marker
The marker for the next set of results. This marker was received from a previous call.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer limit
The maximum number of versions to return with this call.
String include
A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
String fields
Specify "SOURCE" to include initialized versions and a URL for the source document.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String folderId
The ID of the folder.
String sort
The sorting criteria.
String order
The order for the contents of the folder.
Integer limit
The maximum number of items to return with this call.
String marker
The marker for the next set of results. This marker was received from a previous call.
String type
The type of items.
String include
The contents to include. Specify "INITIALIZED" to include initialized documents.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String searchQuery
A query to describe groups by group name.
String organizationId
The ID of the organization.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer limit
The maximum number of items to return with this call.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String resourceId
The ID of the resource.
String principalId
The ID of the principal to filter permissions by.
Integer limit
The maximum number of items to return with this call.
String marker
The marker for the next set of results. (You received this marker from a previous call)
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
Integer limit
The maximum number of items to return.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String organizationId
The ID of the organization.
String userIds
The IDs of the users.
String query
A query to filter users by user name.
String include
The state of the users. Specify "ALL" to include inactive users.
String order
The order for the results.
String sort
The sorting criteria.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer limit
The maximum number of items to return.
String fields
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
String id
The ID of the document.
String creatorId
The ID of the creator.
String parentFolderId
The ID of the parent folder.
Date createdTimestamp
The time when the document was created.
Date modifiedTimestamp
The time when the document was updated.
DocumentVersionMetadata latestVersionMetadata
The latest version of the document.
String resourceState
The resource state.
List<E> labels
List of labels on the document.
String id
The ID of the version.
String name
The name of the version.
String contentType
The content type of the document.
Long size
The size of the document, in bytes.
String signature
The signature of the document.
String status
The status of the document.
Date createdTimestamp
The timestamp when the document was first uploaded.
Date modifiedTimestamp
The timestamp when the document was last uploaded.
Date contentCreatedTimestamp
The timestamp when the content of the document was originally created.
Date contentModifiedTimestamp
The timestamp when the content of the document was modified.
String creatorId
The ID of the creator.
Map<K,V> thumbnail
The thumbnail of the document.
Map<K,V> source
The source of the document.
String id
The ID of the folder.
String name
The name of the folder.
String creatorId
The ID of the creator.
String parentFolderId
The ID of the parent folder.
Date createdTimestamp
The time when the folder was created.
Date modifiedTimestamp
The time when the folder was updated.
String resourceState
The resource state of the folder.
String signature
The unique identifier created from the subfolders and documents of the folder.
List<E> labels
List of labels on the folder.
Long size
The size of the folder metadata.
Long latestVersionSize
The size of the latest version of the folder metadata.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
User user
Metadata of the user.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
Integer limit
The maximum number of levels in the hierarchy to return.
String fields
A comma-separated list of values. Specify NAME to include the names of the parent folders.
String marker
This value is not supported.
ResourcePath path
The path information.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
Boolean includeCustomMetadata
Set this to TRUE to include custom metadata in the response.
DocumentMetadata metadata
The metadata details of the document.
Map<K,V> customMetadata
The custom metadata on the document.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String versionId
The version ID of the document.
String fields
A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.
Boolean includeCustomMetadata
Set this to TRUE to include custom metadata in the response.
DocumentVersionMetadata metadata
The version metadata.
Map<K,V> customMetadata
The custom metadata on the document version.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String folderId
The ID of the folder.
Integer limit
The maximum number of levels in the hierarchy to return.
String fields
A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
String marker
This value is not supported.
ResourcePath path
The path information.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String folderId
The ID of the folder.
Boolean includeCustomMetadata
Set to TRUE to include custom metadata in the response.
FolderMetadata metadata
The metadata of the folder.
Map<K,V> customMetadata
The custom metadata on the folder.
String authenticationToken
The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials.
String userId
The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.
String collectionType
The collection type.
Integer limit
The maximum number of resources to return.
String marker
The marker for the next set of results. This marker was received from a previous call.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String id
The ID of the document.
String name
The name of the document.
Date contentCreatedTimestamp
The timestamp when the content of the document was originally created.
Date contentModifiedTimestamp
The timestamp when the content of the document was modified.
String contentType
The content type of the document.
Long documentSizeInBytes
The size of the document, in bytes.
String parentFolderId
The ID of the parent folder.
DocumentMetadata metadata
The document metadata.
UploadMetadata uploadMetadata
The upload metadata.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String resourceId
The ID of the resource.
String principalId
The principal ID of the resource.
String principalType
The principal type of the resource.
String type
The type of resource.
String name
The name of the resource.
String originalName
The original name of the resource before a rename operation.
String id
The ID of the resource.
String versionId
The version ID of the resource. This is an optional field and is filled for action on document version.
UserMetadata owner
The owner of the resource.
String parentId
The parent ID of the resource before a rename operation.
String principalId
The ID of the principal.
String inviteePrincipalId
The ID of the invited user.
String role
The role.
String status
The status.
String shareId
The ID of the resource that was shared.
String statusMessage
The status message.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String name
The name of the document.
String parentFolderId
The ID of the parent folder.
String resourceState
The resource state of the document. Only ACTIVE and RECYCLED are supported.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String documentId
The ID of the document.
String versionId
The version ID of the document.
String versionStatus
The status of the version.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String folderId
The ID of the folder.
String name
The name of the folder.
String parentFolderId
The ID of the parent folder.
String resourceState
The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.
String authenticationToken
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
String userId
The ID of the user.
String givenName
The given name of the user.
String surname
The surname of the user.
String type
The type of the user.
StorageRuleType storageRule
The amount of storage for the user.
String timeZoneId
The time zone ID of the user.
String locale
The locale of the user.
String grantPoweruserPrivileges
Boolean value to determine whether the user is granted Poweruser privileges.
User user
The user information.
String id
The ID of the user.
String username
The login name of the user.
String emailAddress
The email address of the user.
String givenName
The given name of the user.
String surname
The surname of the user.
String organizationId
The ID of the organization.
String rootFolderId
The ID of the root folder.
String recycleBinFolderId
The ID of the recycle bin folder.
String status
The status of the user.
String type
The type of user.
Date createdTimestamp
The time when the user was created.
Date modifiedTimestamp
The time when the user was modified.
String timeZoneId
The time zone ID of the user.
String locale
The locale of the user.
UserStorageMetadata storage
The storage for the user.
Long storageUtilizedInBytes
The amount of storage used, in bytes.
StorageRuleType storageRule
The storage for a user.
Copyright © 2020. All rights reserved.