NAME

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

DESCRIPTION

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.

SYNOPSIS

    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

ATTRIBUTES

Filters => ArrayRef[Paws::AlexaForBusiness::Filter]

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

MaxResults => Int

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.

NextToken => Str

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.

SortCriteria => ArrayRef[Paws::AlexaForBusiness::Sort]

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

SEE ALSO

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

BUGS and CONTRIBUTIONS

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