Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Searches devices and lists the ones that meet a set of filter criteria.
This operation returns paginated results.
Synopsis
- searchDevices :: SearchDevices
- data SearchDevices
- sdFilters :: Lens' SearchDevices [Filter]
- sdSortCriteria :: Lens' SearchDevices [Sort]
- sdNextToken :: Lens' SearchDevices (Maybe Text)
- sdMaxResults :: Lens' SearchDevices (Maybe Natural)
- searchDevicesResponse :: Int -> SearchDevicesResponse
- data SearchDevicesResponse
- sdrsNextToken :: Lens' SearchDevicesResponse (Maybe Text)
- sdrsDevices :: Lens' SearchDevicesResponse [DeviceData]
- sdrsTotalCount :: Lens' SearchDevicesResponse (Maybe Int)
- sdrsResponseStatus :: Lens' SearchDevicesResponse Int
Creating a Request
searchDevices :: SearchDevices Source #
Creates a value of SearchDevices
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdFilters
- The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).sdSortCriteria
- The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.sdNextToken
- 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 byMaxResults
.sdMaxResults
- The maximum number of results to include in the response. If more results exist than the specifiedMaxResults
value, a token is included in the response so that the remaining results can be retrieved.
data SearchDevices Source #
See: searchDevices
smart constructor.
Instances
Request Lenses
sdFilters :: Lens' SearchDevices [Filter] Source #
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
sdSortCriteria :: Lens' SearchDevices [Sort] Source #
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
sdNextToken :: Lens' SearchDevices (Maybe Text) Source #
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
.
sdMaxResults :: Lens' SearchDevices (Maybe Natural) Source #
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.
Destructuring the Response
searchDevicesResponse Source #
Creates a value of SearchDevicesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdrsNextToken
- The token returned to indicate that there is more data available.sdrsDevices
- The devices that meet the specified set of filter criteria, in sort order.sdrsTotalCount
- The total number of devices returned.sdrsResponseStatus
- -- | The response status code.
data SearchDevicesResponse Source #
See: searchDevicesResponse
smart constructor.
Instances
Response Lenses
sdrsNextToken :: Lens' SearchDevicesResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
sdrsDevices :: Lens' SearchDevicesResponse [DeviceData] Source #
The devices that meet the specified set of filter criteria, in sort order.
sdrsTotalCount :: Lens' SearchDevicesResponse (Maybe Int) Source #
The total number of devices returned.
sdrsResponseStatus :: Lens' SearchDevicesResponse Int Source #
- - | The response status code.