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.Rum.PutRumEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.

Each PutRumEvents operation can send a batch of events from one user session.

Creating a Request

data PutRumEvents Source #

See: newPutRumEvents smart constructor.

Constructors

PutRumEvents'

Fields

appMonitorDetails :: AppMonitorDetails
A structure that contains information about the app monitor that collected this telemetry information.
batchId :: Text
A unique identifier for this batch of RUM event data.
id :: Text
The ID of the app monitor that is sending this data.
rumEvents :: [RumEvent]
An array of structures that contain the telemetry event data.
userDetails :: UserDetails
A structure that contains information about the user session that this batch of events was collected from.

Instances

Instances details

ToJSON PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods toJSON :: PutRumEvents -> Value # toEncoding :: PutRumEvents -> Encoding # toJSONList :: [PutRumEvents] -> Value # toEncodingList :: [PutRumEvents] -> Encoding #
ToHeaders PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods toHeaders :: PutRumEvents -> [Header] #
ToPath PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods toPath :: PutRumEvents -> ByteString #
ToQuery PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods toQuery :: PutRumEvents -> QueryString #
AWSRequest PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Associated Types type AWSResponse PutRumEvents # Methods request :: (Service -> Service) -> PutRumEvents -> Request PutRumEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutRumEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutRumEvents))) #
Generic PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Associated Types type Rep PutRumEvents :: Type -> Type # Methods from :: PutRumEvents -> Rep PutRumEvents x # to :: Rep PutRumEvents x -> PutRumEvents #
Read PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods readsPrec :: Int -> ReadS PutRumEvents # readList :: ReadS [PutRumEvents] # readPrec :: ReadPrec PutRumEvents # readListPrec :: ReadPrec [PutRumEvents] #
Show PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods showsPrec :: Int -> PutRumEvents -> ShowS # show :: PutRumEvents -> String # showList :: [PutRumEvents] -> ShowS #
NFData PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods rnf :: PutRumEvents -> () #
Eq PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods (==) :: PutRumEvents -> PutRumEvents -> Bool # (/=) :: PutRumEvents -> PutRumEvents -> Bool #
Hashable PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods hashWithSalt :: Int -> PutRumEvents -> Int # hash :: PutRumEvents -> Int #
type AWSResponse PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents type AWSResponse PutRumEvents = PutRumEventsResponse
type Rep PutRumEvents Source #
Instance details Defined in Amazonka.Rum.PutRumEvents type Rep PutRumEvents = D1 ('MetaData "PutRumEvents" "Amazonka.Rum.PutRumEvents" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "PutRumEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appMonitorDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppMonitorDetails) :: S1 ('MetaSel ('Just "batchId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "rumEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RumEvent]) :: S1 ('MetaSel ('Just "userDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserDetails)))))

newPutRumEvents Source #

Arguments

:: AppMonitorDetails	`$sel:appMonitorDetails:PutRumEvents'`
-> Text	`$sel:batchId:PutRumEvents'`
-> Text	`PutRumEvents`
-> UserDetails	`$sel:userDetails:PutRumEvents'`
-> PutRumEvents

Create a value of PutRumEvents 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:appMonitorDetails:PutRumEvents', putRumEvents_appMonitorDetails - A structure that contains information about the app monitor that collected this telemetry information.

$sel:batchId:PutRumEvents', putRumEvents_batchId - A unique identifier for this batch of RUM event data.

PutRumEvents, putRumEvents_id - The ID of the app monitor that is sending this data.

$sel:rumEvents:PutRumEvents', putRumEvents_rumEvents - An array of structures that contain the telemetry event data.

$sel:userDetails:PutRumEvents', putRumEvents_userDetails - A structure that contains information about the user session that this batch of events was collected from.

Request Lenses

putRumEvents_appMonitorDetails :: Lens' PutRumEvents AppMonitorDetails Source #

A structure that contains information about the app monitor that collected this telemetry information.

putRumEvents_batchId :: Lens' PutRumEvents Text Source #

A unique identifier for this batch of RUM event data.

putRumEvents_id :: Lens' PutRumEvents Text Source #

The ID of the app monitor that is sending this data.

putRumEvents_rumEvents :: Lens' PutRumEvents [RumEvent] Source #

An array of structures that contain the telemetry event data.

putRumEvents_userDetails :: Lens' PutRumEvents UserDetails Source #

A structure that contains information about the user session that this batch of events was collected from.

Destructuring the Response

data PutRumEventsResponse Source #

See: newPutRumEventsResponse smart constructor.

Constructors

PutRumEventsResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Associated Types type Rep PutRumEventsResponse :: Type -> Type # Methods from :: PutRumEventsResponse -> Rep PutRumEventsResponse x # to :: Rep PutRumEventsResponse x -> PutRumEventsResponse #
Read PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods readsPrec :: Int -> ReadS PutRumEventsResponse # readList :: ReadS [PutRumEventsResponse] # readPrec :: ReadPrec PutRumEventsResponse # readListPrec :: ReadPrec [PutRumEventsResponse] #
Show PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods showsPrec :: Int -> PutRumEventsResponse -> ShowS # show :: PutRumEventsResponse -> String # showList :: [PutRumEventsResponse] -> ShowS #
NFData PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods rnf :: PutRumEventsResponse -> () #
Eq PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents Methods (==) :: PutRumEventsResponse -> PutRumEventsResponse -> Bool # (/=) :: PutRumEventsResponse -> PutRumEventsResponse -> Bool #
type Rep PutRumEventsResponse Source #
Instance details Defined in Amazonka.Rum.PutRumEvents type Rep PutRumEventsResponse = D1 ('MetaData "PutRumEventsResponse" "Amazonka.Rum.PutRumEvents" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "PutRumEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutRumEventsResponse Source #

Arguments

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

Create a value of PutRumEventsResponse 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:httpStatus:PutRumEventsResponse', putRumEventsResponse_httpStatus - The response's http status code.

Response Lenses

putRumEventsResponse_httpStatus :: Lens' PutRumEventsResponse Int Source #

The response's http status code.