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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:authentication_token, :query]

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. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

• (String)

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

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  SENSITIVE = [:authentication_token, :query]
  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 1353

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  SENSITIVE = [:authentication_token, :query]
  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 1353

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

#limit ⇒ Integer

The maximum number of items to return.

Returns:

• (Integer)

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

class DescribeUsersRequest < Struct.new(
  :authentication_token,
  :organization_id,
  :user_ids,
  :query,
  :include,
  :order,
  :sort,
  :marker,
  :limit,
  :fields)
  SENSITIVE = [:authentication_token, :query]
  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 1353

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

#order ⇒ String

The order for the results.

Returns:

• (String)

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

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

#organization_id ⇒ String

The ID of the organization.

Returns:

• (String)

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

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

#query ⇒ String

A query to filter users by user name. Remember the following about the ‘Userids` and `Query` parameters:

• If you don’t use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the ‘Query` parameter.

• The ‘Userid` parameter only returns user names that match a corresponding user ID.

• The ‘Query` parameter runs a “prefix” search for users by the `GivenName`, `SurName`, or `UserName` fields included in a

  CreateUser][1

  API call. For example, querying on ‘Ma` returns

  Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on ‘Ma J` only returns Mateo Jackson.

[1]: docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html

Returns:

• (String)

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

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

#sort ⇒ String

The sorting criteria.

Returns:

• (String)

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

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

#user_ids ⇒ String

The IDs of the users.

Returns:

• (String)

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

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