You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  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)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  include Aws::Structure
end

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  include Aws::Structure
end

#markerString

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

  • (String)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  include Aws::Structure
end

#organization_idString

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

Returns:

  • (String)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  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)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  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)


939
940
941
942
943
944
945
946
947
948
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 939

class DescribeActivitiesRequest < Struct.new(
  :authentication_token,
  :start_time,
  :end_time,
  :organization_id,
  :user_id,
  :limit,
  :marker)
  include Aws::Structure
end