SearchDevicesRequest

import type { SearchDevicesRequest } from "https://aws-api.deno.dev/v0.4/services/alexaforbusiness.ts?docs=full";

interface SearchDevicesRequest {

Filters?: Filter[] | null;

MaxResults?: number | null;

NextToken?: string | null;

SortCriteria?: Sort[] | null;

}

§Properties

Filters?: Filter[] | null

[src]

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?: number | null

[src]

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?: string | null

[src]

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?: Sort[] | null

[src]

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.