Copyright	(c) 2013-2021 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

Amazonka.AlexaBusiness.ListDeviceEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the device event history, including device connection status, for up to 30 days.

This operation returns paginated results.

Synopsis

data ListDeviceEvents = ListDeviceEvents' {
- nextToken :: Maybe Text
- eventType :: Maybe DeviceEventType
- maxResults :: Maybe Natural
- deviceArn :: Text
}
newListDeviceEvents :: Text -> ListDeviceEvents
listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text)
listDeviceEvents_eventType :: Lens' ListDeviceEvents (Maybe DeviceEventType)
listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural)
listDeviceEvents_deviceArn :: Lens' ListDeviceEvents Text
data ListDeviceEventsResponse = ListDeviceEventsResponse' {
- nextToken :: Maybe Text
- deviceEvents :: Maybe [DeviceEvent]
- httpStatus :: Int
}
newListDeviceEventsResponse :: Int -> ListDeviceEventsResponse
listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text)
listDeviceEventsResponse_deviceEvents :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent])
listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int

Creating a Request

data ListDeviceEvents Source #

See: newListDeviceEvents smart constructor.

Constructors

ListDeviceEvents'

Fields

nextToken :: Maybe Text
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.
eventType :: Maybe DeviceEventType
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.
maxResults :: Maybe Natural
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.
deviceArn :: Text
The ARN of a device.

Instances

Instances details

Eq ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods (==) :: ListDeviceEvents -> ListDeviceEvents -> Bool # (/=) :: ListDeviceEvents -> ListDeviceEvents -> Bool #
Read ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods readsPrec :: Int -> ReadS ListDeviceEvents # readList :: ReadS [ListDeviceEvents] # readPrec :: ReadPrec ListDeviceEvents # readListPrec :: ReadPrec [ListDeviceEvents] #
Show ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods showsPrec :: Int -> ListDeviceEvents -> ShowS # show :: ListDeviceEvents -> String # showList :: [ListDeviceEvents] -> ShowS #
Generic ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Associated Types type Rep ListDeviceEvents :: Type -> Type # Methods from :: ListDeviceEvents -> Rep ListDeviceEvents x # to :: Rep ListDeviceEvents x -> ListDeviceEvents #
NFData ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods rnf :: ListDeviceEvents -> () #
Hashable ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods hashWithSalt :: Int -> ListDeviceEvents -> Int # hash :: ListDeviceEvents -> Int #
ToJSON ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods toJSON :: ListDeviceEvents -> Value # toEncoding :: ListDeviceEvents -> Encoding # toJSONList :: [ListDeviceEvents] -> Value # toEncodingList :: [ListDeviceEvents] -> Encoding #
AWSPager ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods page :: ListDeviceEvents -> AWSResponse ListDeviceEvents -> Maybe ListDeviceEvents #
AWSRequest ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Associated Types type AWSResponse ListDeviceEvents # Methods request :: ListDeviceEvents -> Request ListDeviceEvents # response :: MonadResource m => Logger -> Service -> Proxy ListDeviceEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeviceEvents))) #
ToHeaders ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods toHeaders :: ListDeviceEvents -> [Header] #
ToPath ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods toPath :: ListDeviceEvents -> ByteString #
ToQuery ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods toQuery :: ListDeviceEvents -> QueryString #
type Rep ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents type Rep ListDeviceEvents = D1 ('MetaData "ListDeviceEvents" "Amazonka.AlexaBusiness.ListDeviceEvents" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "ListDeviceEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceEventType))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListDeviceEvents Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents type AWSResponse ListDeviceEvents = ListDeviceEventsResponse

newListDeviceEvents Source #

Arguments

:: Text	`$sel:deviceArn: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:nextToken: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.

$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.

$sel:deviceArn:ListDeviceEvents', listDeviceEvents_deviceArn - The ARN of a device.

Request Lenses

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_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_deviceArn :: Lens' ListDeviceEvents Text Source #

The ARN of a device.

Destructuring the Response

data ListDeviceEventsResponse Source #

See: newListDeviceEventsResponse smart constructor.

Constructors

ListDeviceEventsResponse'
Fields nextToken :: Maybe Text The token returned to indicate that there is more data available. deviceEvents :: Maybe [DeviceEvent] The device events requested for the device ARN. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods (==) :: ListDeviceEventsResponse -> ListDeviceEventsResponse -> Bool # (/=) :: ListDeviceEventsResponse -> ListDeviceEventsResponse -> Bool #
Read ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods readsPrec :: Int -> ReadS ListDeviceEventsResponse # readList :: ReadS [ListDeviceEventsResponse] # readPrec :: ReadPrec ListDeviceEventsResponse # readListPrec :: ReadPrec [ListDeviceEventsResponse] #
Show ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods showsPrec :: Int -> ListDeviceEventsResponse -> ShowS # show :: ListDeviceEventsResponse -> String # showList :: [ListDeviceEventsResponse] -> ShowS #
Generic ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Associated Types type Rep ListDeviceEventsResponse :: Type -> Type # Methods from :: ListDeviceEventsResponse -> Rep ListDeviceEventsResponse x # to :: Rep ListDeviceEventsResponse x -> ListDeviceEventsResponse #
NFData ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents Methods rnf :: ListDeviceEventsResponse -> () #
type Rep ListDeviceEventsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.ListDeviceEvents type Rep ListDeviceEventsResponse = D1 ('MetaData "ListDeviceEventsResponse" "Amazonka.AlexaBusiness.ListDeviceEvents" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "ListDeviceEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deviceEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceEvent])) :: 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:nextToken:ListDeviceEvents', listDeviceEventsResponse_nextToken - The token returned to indicate that there is more data available.

$sel:deviceEvents:ListDeviceEventsResponse', listDeviceEventsResponse_deviceEvents - The device events requested for the device ARN.

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

Response Lenses

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

The token returned to indicate that there is more data available.

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

The device events requested for the device ARN.

listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int Source #

The response's http status code.