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 |
Lists the device event history, including device connection status, for up to 30 days.
This operation returns paginated results.
Synopsis
- data ListDeviceEvents = ListDeviceEvents' {}
- newListDeviceEvents :: Text -> ListDeviceEvents
- listDeviceEvents_eventType :: Lens' ListDeviceEvents (Maybe DeviceEventType)
- listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural)
- listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text)
- listDeviceEvents_deviceArn :: Lens' ListDeviceEvents Text
- data ListDeviceEventsResponse = ListDeviceEventsResponse' {
- deviceEvents :: Maybe [DeviceEvent]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListDeviceEventsResponse :: Int -> ListDeviceEventsResponse
- listDeviceEventsResponse_deviceEvents :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent])
- listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text)
- listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int
Creating a Request
data ListDeviceEvents Source #
See: newListDeviceEvents
smart constructor.
ListDeviceEvents' | |
|
Instances
Create a value of ListDeviceEvents
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:eventType:ListDeviceEvents'
, listDeviceEvents_eventType
- The event type to filter device events. If EventType isn't specified,
this returns a list of all device events in reverse chronological order.
If EventType is specified, this returns a list of device events for that
EventType in reverse chronological order.
$sel:maxResults:ListDeviceEvents'
, listDeviceEvents_maxResults
- The maximum number of results to include in the response. The default
value is 50. If more results exist than the specified MaxResults value,
a token is included in the response so that the remaining results can be
retrieved.
ListDeviceEvents
, listDeviceEvents_nextToken
- 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 only includes results beyond the token, up to the value
specified by MaxResults. When the end of results is reached, the
response has a value of null.
ListDeviceEvents
, listDeviceEvents_deviceArn
- The ARN of a device.
Request Lenses
listDeviceEvents_eventType :: Lens' ListDeviceEvents (Maybe DeviceEventType) Source #
The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural) Source #
The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
listDeviceEvents_nextToken :: Lens' ListDeviceEvents (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 only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
listDeviceEvents_deviceArn :: Lens' ListDeviceEvents Text Source #
The ARN of a device.
Destructuring the Response
data ListDeviceEventsResponse Source #
See: newListDeviceEventsResponse
smart constructor.
ListDeviceEventsResponse' | |
|
Instances
newListDeviceEventsResponse Source #
Create a value of ListDeviceEventsResponse
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:deviceEvents:ListDeviceEventsResponse'
, listDeviceEventsResponse_deviceEvents
- The device events requested for the device ARN.
ListDeviceEvents
, listDeviceEventsResponse_nextToken
- The token returned to indicate that there is more data available.
$sel:httpStatus:ListDeviceEventsResponse'
, listDeviceEventsResponse_httpStatus
- The response's http status code.
Response Lenses
listDeviceEventsResponse_deviceEvents :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent]) Source #
The device events requested for the device ARN.
listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int Source #
The response's http status code.