Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns a list of devices.
Synopsis
- data ListDevices = ListDevices' {}
- newListDevices :: ListDevices
- listDevices_deviceAggregatedStatusFilter :: Lens' ListDevices (Maybe DeviceAggregatedStatus)
- listDevices_maxResults :: Lens' ListDevices (Maybe Natural)
- listDevices_nameFilter :: Lens' ListDevices (Maybe Text)
- listDevices_nextToken :: Lens' ListDevices (Maybe Text)
- listDevices_sortBy :: Lens' ListDevices (Maybe ListDevicesSortBy)
- listDevices_sortOrder :: Lens' ListDevices (Maybe SortOrder)
- data ListDevicesResponse = ListDevicesResponse' {}
- newListDevicesResponse :: Int -> ListDevicesResponse
- listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text)
- listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int
- listDevicesResponse_devices :: Lens' ListDevicesResponse [Device]
Creating a Request
data ListDevices Source #
See: newListDevices
smart constructor.
ListDevices' | |
|
Instances
newListDevices :: ListDevices Source #
Create a value of ListDevices
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceAggregatedStatusFilter:ListDevices'
, listDevices_deviceAggregatedStatusFilter
- Filter based on a device's status.
$sel:maxResults:ListDevices'
, listDevices_maxResults
- The maximum number of devices to return in one page of results.
$sel:nameFilter:ListDevices'
, listDevices_nameFilter
- Filter based on device's name. Prefixes supported.
ListDevices
, listDevices_nextToken
- Specify the pagination token from a previous request to retrieve the
next page of results.
$sel:sortBy:ListDevices'
, listDevices_sortBy
- The target column to be sorted on. Default column sort is CREATED_TIME.
$sel:sortOrder:ListDevices'
, listDevices_sortOrder
- The sorting order for the returned list. SortOrder is DESCENDING by
default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
Request Lenses
listDevices_deviceAggregatedStatusFilter :: Lens' ListDevices (Maybe DeviceAggregatedStatus) Source #
Filter based on a device's status.
listDevices_maxResults :: Lens' ListDevices (Maybe Natural) Source #
The maximum number of devices to return in one page of results.
listDevices_nameFilter :: Lens' ListDevices (Maybe Text) Source #
Filter based on device's name. Prefixes supported.
listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #
Specify the pagination token from a previous request to retrieve the next page of results.
listDevices_sortBy :: Lens' ListDevices (Maybe ListDevicesSortBy) Source #
The target column to be sorted on. Default column sort is CREATED_TIME.
listDevices_sortOrder :: Lens' ListDevices (Maybe SortOrder) Source #
The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
Destructuring the Response
data ListDevicesResponse Source #
See: newListDevicesResponse
smart constructor.
Instances
newListDevicesResponse Source #
Create a value of ListDevicesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDevices
, listDevicesResponse_nextToken
- A pagination token that's included if more results are available.
$sel:httpStatus:ListDevicesResponse'
, listDevicesResponse_httpStatus
- The response's http status code.
$sel:devices:ListDevicesResponse'
, listDevicesResponse_devices
- A list of devices.
Response Lenses
listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #
A pagination token that's included if more results are available.
listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #
The response's http status code.
listDevicesResponse_devices :: Lens' ListDevicesResponse [Device] Source #
A list of devices.