Class: Aws::AlexaForBusiness::Types::SearchUsersRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-alexaforbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:



4239
4240
4241
4242
4243
4244
4245
4246
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4239

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to include in the response. If more results exist than the specified ‘MaxResults` value, a token is included in the response so that the remaining results can be retrieved. Required.

Returns:

  • (Integer)


4239
4240
4241
4242
4243
4244
4245
4246
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4239

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by ‘MaxResults`. Required.

Returns:

  • (String)


4239
4240
4241
4242
4243
4244
4245
4246
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4239

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#sort_criteriaArray<Types::Sort>

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:



4239
4240
4241
4242
4243
4244
4245
4246
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4239

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end