You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkDocs::Types::DescribeActivitiesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkDocs::Types::DescribeActivitiesRequest
- Defined in:
- (unknown)
Overview
When passing DescribeActivitiesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
authentication_token: "AuthenticationHeaderType",
start_time: Time.now,
end_time: Time.now,
organization_id: "IdType",
activity_types: "ActivityNamesFilterType",
resource_id: "IdType",
user_id: "IdType",
include_indirect_activities: false,
limit: 1,
marker: "MarkerType",
}
Instance Attribute Summary collapse
-
#activity_types ⇒ String
Specifies which activity types to include in the response.
-
#authentication_token ⇒ String
Amazon WorkDocs authentication token.
-
#end_time ⇒ Time
The timestamp that determines the end time of the activities.
-
#include_indirect_activities ⇒ Boolean
Includes indirect activities.
-
#limit ⇒ Integer
The maximum number of items to return.
-
#marker ⇒ String
The marker for the next set of results.
-
#organization_id ⇒ String
The ID of the organization.
-
#resource_id ⇒ String
The document or folder ID for which to describe activity types.
-
#start_time ⇒ Time
The timestamp that determines the starting time of the activities.
-
#user_id ⇒ String
The ID of the user who performed the action.
Instance Attribute Details
#activity_types ⇒ String
Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
#authentication_token ⇒ String
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
#end_time ⇒ Time
The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
#include_indirect_activities ⇒ 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.
#organization_id ⇒ String
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
#resource_id ⇒ String
The document or folder ID for which to describe activity types.
#start_time ⇒ Time
The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
#user_id ⇒ 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.