NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $a4b = Paws->service('AlexaForBusiness');
    my $SearchDevicesResponse = $a4b->SearchDevices(
      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 $Devices    = $SearchDevicesResponse->Devices;
    my $NextToken  = $SearchDevicesResponse->NextToken;
    my $TotalCount = $SearchDevicesResponse->TotalCount;

    # Returns a L<Paws::AlexaForBusiness::SearchDevicesResponse> 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/SearchDevices

ATTRIBUTES

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

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

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.

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.

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

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

SEE ALSO

This class forms part of Paws, documenting arguments for method SearchDevices 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