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.FraudDetector.SendEvent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

Synopsis

data SendEvent = SendEvent' {
- assignedLabel :: Maybe Text
- labelTimestamp :: Maybe Text
- eventId :: Text
- eventTypeName :: Text
- eventTimestamp :: Text
- eventVariables :: HashMap Text (Sensitive Text)
- entities :: [Sensitive Entity]
}
newSendEvent :: Text -> Text -> Text -> SendEvent
sendEvent_assignedLabel :: Lens' SendEvent (Maybe Text)
sendEvent_labelTimestamp :: Lens' SendEvent (Maybe Text)
sendEvent_eventId :: Lens' SendEvent Text
sendEvent_eventTypeName :: Lens' SendEvent Text
sendEvent_eventTimestamp :: Lens' SendEvent Text
sendEvent_eventVariables :: Lens' SendEvent (HashMap Text Text)
sendEvent_entities :: Lens' SendEvent [Entity]
data SendEventResponse = SendEventResponse' {
- httpStatus :: Int
}
newSendEventResponse :: Int -> SendEventResponse
sendEventResponse_httpStatus :: Lens' SendEventResponse Int

Creating a Request

data SendEvent Source #

See: newSendEvent smart constructor.

Constructors

SendEvent'

Fields

assignedLabel :: Maybe Text
The label to associate with the event. Required if specifying labelTimestamp.
labelTimestamp :: Maybe Text
The timestamp associated with the label. Required if specifying assignedLabel.
eventId :: Text
The event ID to upload.
eventTypeName :: Text
The event type name of the event.
eventTimestamp :: Text
The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
eventVariables :: HashMap Text (Sensitive Text)
Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
entities :: [Sensitive Entity]
An array of entities.

Instances

Instances details

ToJSON SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods toJSON :: SendEvent -> Value # toEncoding :: SendEvent -> Encoding # toJSONList :: [SendEvent] -> Value # toEncodingList :: [SendEvent] -> Encoding #
ToHeaders SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods toHeaders :: SendEvent -> [Header] #
ToPath SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods toPath :: SendEvent -> ByteString #
ToQuery SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods toQuery :: SendEvent -> QueryString #
AWSRequest SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Associated Types type AWSResponse SendEvent # Methods request :: (Service -> Service) -> SendEvent -> Request SendEvent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendEvent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendEvent))) #
Generic SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Associated Types type Rep SendEvent :: Type -> Type # Methods from :: SendEvent -> Rep SendEvent x # to :: Rep SendEvent x -> SendEvent #
Show SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods showsPrec :: Int -> SendEvent -> ShowS # show :: SendEvent -> String # showList :: [SendEvent] -> ShowS #
NFData SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods rnf :: SendEvent -> () #
Eq SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods (==) :: SendEvent -> SendEvent -> Bool # (/=) :: SendEvent -> SendEvent -> Bool #
Hashable SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent Methods hashWithSalt :: Int -> SendEvent -> Int # hash :: SendEvent -> Int #
type AWSResponse SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent type AWSResponse SendEvent = SendEventResponse
type Rep SendEvent Source #
Instance details Defined in Amazonka.FraudDetector.SendEvent type Rep SendEvent = D1 ('MetaData "SendEvent" "Amazonka.FraudDetector.SendEvent" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "SendEvent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assignedLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "labelTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "eventTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "eventTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "eventVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text (Sensitive Text))) :: S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Sensitive Entity])))))

newSendEvent Source #

Arguments

:: Text	`SendEvent`
-> Text	`SendEvent`
-> Text	`SendEvent`
-> SendEvent

Create a value of SendEvent 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:assignedLabel:SendEvent', sendEvent_assignedLabel - The label to associate with the event. Required if specifying labelTimestamp.

SendEvent, sendEvent_labelTimestamp - The timestamp associated with the label. Required if specifying assignedLabel.

SendEvent, sendEvent_eventId - The event ID to upload.

SendEvent, sendEvent_eventTypeName - The event type name of the event.

SendEvent, sendEvent_eventTimestamp - The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

SendEvent, sendEvent_eventVariables - Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

SendEvent, sendEvent_entities - An array of entities.

Request Lenses

sendEvent_assignedLabel :: Lens' SendEvent (Maybe Text) Source #

The label to associate with the event. Required if specifying labelTimestamp.

sendEvent_labelTimestamp :: Lens' SendEvent (Maybe Text) Source #

The timestamp associated with the label. Required if specifying assignedLabel.

sendEvent_eventId :: Lens' SendEvent Text Source #

The event ID to upload.

sendEvent_eventTypeName :: Lens' SendEvent Text Source #

The event type name of the event.

sendEvent_eventTimestamp :: Lens' SendEvent Text Source #

The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

sendEvent_eventVariables :: Lens' SendEvent (HashMap Text Text) Source #

Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

sendEvent_entities :: Lens' SendEvent [Entity] Source #

An array of entities.

Destructuring the Response

data SendEventResponse Source #

See: newSendEventResponse smart constructor.

Constructors

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

Instances

Instances details

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

newSendEventResponse Source #

Arguments

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

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

Response Lenses

sendEventResponse_httpStatus :: Lens' SendEventResponse Int Source #

The response's http status code.