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

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

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 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",
}

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)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#fieldsString

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

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#includeString

The state of the users. Specify "ALL" to include inactive users.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#markerString

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

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#orderString

The order for the results.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#organization_idString

The ID of the organization.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#queryString

A query to filter users by user name.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#sortString

The sorting criteria.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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

#user_idsString

The IDs of the users.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1477

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