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

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

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

Overview

Note:

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

{
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
}

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:



1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1613

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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)


1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1613

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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)


1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1613

class SearchUsersRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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:



1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1613

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