GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::AlexaForBusiness::SearchUsers(3) User Contributed Perl Documentation Paws::AlexaForBusiness::SearchUsers(3)

Paws::AlexaForBusiness::SearchUsers - Arguments for method SearchUsers on Paws::AlexaForBusiness

This class represents the parameters used for calling the method SearchUsers on the Alexa For Business service. Use the attributes of this class as arguments to method SearchUsers.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchUsers.

    my $a4b = Paws->service('AlexaForBusiness');
    my $SearchUsersResponse = $a4b->SearchUsers(
      Filters => [
        {
          Key    => 'MyFilterKey',    # min: 1, max: 500
          Values => [
            'MyFilterValue', ...      # min: 1, max: 500
          ],    # max: 50
        },
        ...
      ],    # OPTIONAL
      MaxResults   => 1,                # OPTIONAL
      NextToken    => 'MyNextToken',    # OPTIONAL
      SortCriteria => [
        {
          Key   => 'MySortKey',    # min: 1, max: 500
          Value => 'ASC',          # values: ASC, DESC
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $NextToken  = $SearchUsersResponse->NextToken;
    my $TotalCount = $SearchUsersResponse->TotalCount;
    my $Users      = $SearchUsersResponse->Users;
    # Returns a L<Paws::AlexaForBusiness::SearchUsersResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/a4b/SearchUsers>

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

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.

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.

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

This class forms part of Paws, documenting arguments for method SearchUsers in Paws::AlexaForBusiness

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.