DescribeActivities
Describes the user activities in a specified time period.
Request Syntax
GET /api/v1/activities?activityTypes=ActivityTypes&endTime=EndTime&includeIndirectActivities=IncludeIndirectActivities&limit=Limit&marker=Marker&organizationId=OrganizationId&resourceId=ResourceId&startTime=StartTime&userId=UserId HTTP/1.1
Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
- ActivityTypes
-
Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\w,]+ - AuthenticationToken
-
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Length Constraints: Minimum length of 1. Maximum length of 8199.
- EndTime
-
The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
- 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).
- Limit
-
The maximum number of items to return.
Valid Range: Minimum value of 1. Maximum value of 999.
- Marker
-
The marker for the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 12288.
Pattern:
[\u0000-\u00FF]+ - OrganizationId
-
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[&\w+-.@]+ - ResourceId
-
The document or folder ID for which to describe activity types.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[&\w+-.@]+ - StartTime
-
The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
- 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.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[&\w+-.@]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Marker": "string",
"UserActivities": [
{
"CommentMetadata": {
"CommentId": "string",
"CommentStatus": "string",
"Contributor": {
"CreatedTimestamp": number,
"EmailAddress": "string",
"GivenName": "string",
"Id": "string",
"Locale": "string",
"ModifiedTimestamp": number,
"OrganizationId": "string",
"RecycleBinFolderId": "string",
"RootFolderId": "string",
"Status": "string",
"Storage": {
"StorageRule": {
"StorageAllocatedInBytes": number,
"StorageType": "string"
},
"StorageUtilizedInBytes": number
},
"Surname": "string",
"TimeZoneId": "string",
"Type": "string",
"Username": "string"
},
"ContributorId": "string",
"CreatedTimestamp": number,
"RecipientId": "string"
},
"Initiator": {
"EmailAddress": "string",
"GivenName": "string",
"Id": "string",
"Surname": "string",
"Username": "string"
},
"IsIndirectActivity": boolean,
"OrganizationId": "string",
"OriginalParent": {
"Id": "string",
"Name": "string",
"OriginalName": "string",
"Owner": {
"EmailAddress": "string",
"GivenName": "string",
"Id": "string",
"Surname": "string",
"Username": "string"
},
"ParentId": "string",
"Type": "string",
"VersionId": "string"
},
"Participants": {
"Groups": [
{
"Id": "string",
"Name": "string"
}
],
"Users": [
{
"EmailAddress": "string",
"GivenName": "string",
"Id": "string",
"Surname": "string",
"Username": "string"
}
]
},
"ResourceMetadata": {
"Id": "string",
"Name": "string",
"OriginalName": "string",
"Owner": {
"EmailAddress": "string",
"GivenName": "string",
"Id": "string",
"Surname": "string",
"Username": "string"
},
"ParentId": "string",
"Type": "string",
"VersionId": "string"
},
"TimeStamp": number,
"Type": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Marker
-
The marker for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 12288.
Pattern:
[\u0000-\u00FF]+ - UserActivities
-
The list of activities for the specified user and time period.
Type: Array of Activity objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- FailedDependencyException
-
The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
HTTP Status Code: 424
- InvalidArgumentException
-
The pagination marker or limit fields are not valid.
HTTP Status Code: 400
- ServiceUnavailableException
-
One or more of the dependencies is unavailable.
HTTP Status Code: 503
- UnauthorizedOperationException
-
The operation is not permitted.
HTTP Status Code: 403
- UnauthorizedResourceAccessException
-
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
