Class: Aws::WorkDocs::Types::DescribeActivitiesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DescribeActivitiesRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[:authentication_token]

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)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#authentication_tokenString

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

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#end_timeTime

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

Returns:

  • (Time)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

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


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#markerString

The marker for the next set of results.

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#organization_idString

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

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#resource_idString

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

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#start_timeTime

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

Returns:

  • (Time)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

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


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1037

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :activity_types,
  :resource_id,
  :user_id,
  :include_indirect_activities,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end