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",
  user_id: "IdType",
  limit: 1,
  marker: "MarkerType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

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.

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

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