Class: Aws::WorkDocs::Types::DescribeUsersRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::DescribeUsersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DescribeUsersRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  organization_id: "IdType",
  user_ids: "UserIdsType",
  query: "SearchQueryType",
  include: "ALL", # accepts ALL, ACTIVE_PENDING
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
  sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
  marker: "PageMarkerType",
  limit: 1,
  fields: "FieldNamesType",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #authentication_token ⇒ String

  Amazon WorkDocs authentication token.

• #fields ⇒ String

  A comma-separated list of values.

• #include ⇒ String

  The state of the users.

• #limit ⇒ Integer

  The maximum number of items to return.

• #marker ⇒ String

  The marker for the next set of results.

• #order ⇒ String

  The order for the results.

• #organization_id ⇒ String

  The ID of the organization.

• #query ⇒ String

  A query to filter users by user name.

• #sort ⇒ String

  The sorting criteria.

• #user_ids ⇒ String

  The IDs of the users.

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#fields ⇒ String

A comma-separated list of values. Specify “STORAGE_METADATA” to include the user storage quota and utilization information.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#include ⇒ String

The state of the users. Specify “ALL” to include inactive users.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items to return.

Returns:

• (Integer)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#marker ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#order ⇒ String

The order for the results.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#organization_id ⇒ String

The ID of the organization.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#query ⇒ String

A query to filter users by user name.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#sort ⇒ String

The sorting criteria.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end

#user_ids ⇒ String

The IDs of the users.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1508

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  include Aws::Structure
end