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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:authentication_token]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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_token ⇒ String

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

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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_time ⇒ Time

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

Returns:

  • (Time) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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

Returns:

  • (Boolean) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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

#limit ⇒ Integer

The maximum number of items to return.

Returns:

  • (Integer) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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

#marker ⇒ String

The marker for the next set of results.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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_id ⇒ String

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

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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_id ⇒ String

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

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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_time ⇒ Time

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

Returns:

  • (Time) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/aws-sdk-workdocs/types.rb', line 886

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