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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeUsersRequest as input to an Aws::Client method, you can use a vanilla 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)

    Amazon WorkDocs authentication token.

#fieldsString

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

Returns:

  • (String)

    A comma-separated list of values.

#includeString

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

Possible values:

  • ALL
  • ACTIVE_PENDING

Returns:

  • (String)

    The state of the users.

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)

    The maximum number of items to return.

#markerString

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

Returns:

  • (String)

    The marker for the next set of results.

#orderString

The order for the results.

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String)

    The order for the results.

#organization_idString

The ID of the organization.

Returns:

  • (String)

    The ID of the organization.

#queryString

A query to filter users by user name.

Returns:

  • (String)

    A query to filter users by user name.

#sortString

The sorting criteria.

Possible values:

  • USER_NAME
  • FULL_NAME
  • STORAGE_LIMIT
  • USER_STATUS
  • STORAGE_USED

Returns:

  • (String)

    The sorting criteria.

#user_idsString

The IDs of the users.

Returns:

  • (String)

    The IDs of the users.