AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#activity_typesString

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

Returns:

  • (String)

    Specifies which activity types to include in the response.

#authentication_tokenString

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Returns:

  • (String)

    Amazon WorkDocs authentication token.

#end_timeTime

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

Returns:

  • (Time)

    The timestamp that determines the end time of the activities.

#include_indirect_activitiesBoolean

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).

Returns:

  • (Boolean)

    Includes indirect activities.

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)

    The maximum number of items to return.

#markerString

The marker for the next set of results.

Returns:

  • (String)

    The marker for the next set of results.

#organization_idString

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

Returns:

  • (String)

    The ID of the organization.

#resource_idString

The document or folder ID for which to describe activity types.

Returns:

  • (String)

    The document or folder ID for which to describe activity types.

#start_timeTime

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

Returns:

  • (Time)

    The timestamp that determines the starting time of the activities.

#user_idString

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.

Returns:

  • (String)

    The ID of the user who performed the action.