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

Amazonka.IoT1ClickDevices.ListDeviceEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

This operation returns paginated results.

Synopsis

data ListDeviceEvents = ListDeviceEvents' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- deviceId :: Text
- fromTimeStamp :: ISO8601
- toTimeStamp :: ISO8601
}
newListDeviceEvents :: Text -> UTCTime -> UTCTime -> ListDeviceEvents
listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural)
listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text)
listDeviceEvents_deviceId :: Lens' ListDeviceEvents Text
listDeviceEvents_fromTimeStamp :: Lens' ListDeviceEvents UTCTime
listDeviceEvents_toTimeStamp :: Lens' ListDeviceEvents UTCTime
data ListDeviceEventsResponse = ListDeviceEventsResponse' {
- events :: Maybe [DeviceEvent]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDeviceEventsResponse :: Int -> ListDeviceEventsResponse
listDeviceEventsResponse_events :: 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.

Constructors

ListDeviceEvents'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per request. If not set, a default value of 100 is used.
nextToken :: Maybe Text
The token to retrieve the next set of results.
deviceId :: Text
The unique identifier of the device.
fromTimeStamp :: ISO8601
The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z
toTimeStamp :: ISO8601
The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

Instances

Instances details

ToHeaders ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods toHeaders :: ListDeviceEvents -> [Header] #
ToPath ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods toPath :: ListDeviceEvents -> ByteString #
ToQuery ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods toQuery :: ListDeviceEvents -> QueryString #
AWSPager ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods page :: ListDeviceEvents -> AWSResponse ListDeviceEvents -> Maybe ListDeviceEvents #
AWSRequest ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Associated Types type AWSResponse ListDeviceEvents # Methods request :: (Service -> Service) -> ListDeviceEvents -> Request ListDeviceEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDeviceEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeviceEvents))) #
Generic ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Associated Types type Rep ListDeviceEvents :: Type -> Type # Methods from :: ListDeviceEvents -> Rep ListDeviceEvents x # to :: Rep ListDeviceEvents x -> ListDeviceEvents #
Read ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods readsPrec :: Int -> ReadS ListDeviceEvents # readList :: ReadS [ListDeviceEvents] # readPrec :: ReadPrec ListDeviceEvents # readListPrec :: ReadPrec [ListDeviceEvents] #
Show ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods showsPrec :: Int -> ListDeviceEvents -> ShowS # show :: ListDeviceEvents -> String # showList :: [ListDeviceEvents] -> ShowS #
NFData ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods rnf :: ListDeviceEvents -> () #
Eq ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods (==) :: ListDeviceEvents -> ListDeviceEvents -> Bool # (/=) :: ListDeviceEvents -> ListDeviceEvents -> Bool #
Hashable ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods hashWithSalt :: Int -> ListDeviceEvents -> Int # hash :: ListDeviceEvents -> Int #
type AWSResponse ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents type AWSResponse ListDeviceEvents = ListDeviceEventsResponse
type Rep ListDeviceEvents Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents type Rep ListDeviceEvents = D1 ('MetaData "ListDeviceEvents" "Amazonka.IoT1ClickDevices.ListDeviceEvents" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "ListDeviceEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "fromTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: S1 ('MetaSel ('Just "toTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newListDeviceEvents Source #

Arguments

:: Text	`ListDeviceEvents`
-> UTCTime	`$sel:fromTimeStamp:ListDeviceEvents'`
-> UTCTime	`$sel:toTimeStamp:ListDeviceEvents'`
-> ListDeviceEvents

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:maxResults:ListDeviceEvents', listDeviceEvents_maxResults - The maximum number of results to return per request. If not set, a default value of 100 is used.

ListDeviceEvents, listDeviceEvents_nextToken - The token to retrieve the next set of results.

ListDeviceEvents, listDeviceEvents_deviceId - The unique identifier of the device.

$sel:fromTimeStamp:ListDeviceEvents', listDeviceEvents_fromTimeStamp - The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

$sel:toTimeStamp:ListDeviceEvents', listDeviceEvents_toTimeStamp - The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

Request Lenses

listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural) Source #

The maximum number of results to return per request. If not set, a default value of 100 is used.

listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text) Source #

The token to retrieve the next set of results.

listDeviceEvents_deviceId :: Lens' ListDeviceEvents Text Source #

The unique identifier of the device.

listDeviceEvents_fromTimeStamp :: Lens' ListDeviceEvents UTCTime Source #

The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

listDeviceEvents_toTimeStamp :: Lens' ListDeviceEvents UTCTime Source #

The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

Destructuring the Response

data ListDeviceEventsResponse Source #

See: newListDeviceEventsResponse smart constructor.

Constructors

ListDeviceEventsResponse'
Fields events :: Maybe [DeviceEvent] An array of zero or more elements describing the event(s) associated with the device. nextToken :: Maybe Text The token to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Associated Types type Rep ListDeviceEventsResponse :: Type -> Type # Methods from :: ListDeviceEventsResponse -> Rep ListDeviceEventsResponse x # to :: Rep ListDeviceEventsResponse x -> ListDeviceEventsResponse #
Read ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods readsPrec :: Int -> ReadS ListDeviceEventsResponse # readList :: ReadS [ListDeviceEventsResponse] # readPrec :: ReadPrec ListDeviceEventsResponse # readListPrec :: ReadPrec [ListDeviceEventsResponse] #
Show ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods showsPrec :: Int -> ListDeviceEventsResponse -> ShowS # show :: ListDeviceEventsResponse -> String # showList :: [ListDeviceEventsResponse] -> ShowS #
NFData ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods rnf :: ListDeviceEventsResponse -> () #
Eq ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents Methods (==) :: ListDeviceEventsResponse -> ListDeviceEventsResponse -> Bool # (/=) :: ListDeviceEventsResponse -> ListDeviceEventsResponse -> Bool #
type Rep ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.ListDeviceEvents type Rep ListDeviceEventsResponse = D1 ('MetaData "ListDeviceEventsResponse" "Amazonka.IoT1ClickDevices.ListDeviceEvents" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "ListDeviceEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceEvent])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDeviceEventsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDeviceEventsResponse'`
-> ListDeviceEventsResponse

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:events:ListDeviceEventsResponse', listDeviceEventsResponse_events - An array of zero or more elements describing the event(s) associated with the device.

ListDeviceEvents, listDeviceEventsResponse_nextToken - The token to retrieve the next set of results.

$sel:httpStatus:ListDeviceEventsResponse', listDeviceEventsResponse_httpStatus - The response's http status code.

Response Lenses

listDeviceEventsResponse_events :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent]) Source #

An array of zero or more elements describing the event(s) associated with the device.

listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text) Source #

The token to retrieve the next set of results.

listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int Source #

The response's http status code.