SendEvent
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.
Request Syntax
{
"assignedLabel": "string
",
"entities": [
{
"entityId": "string
",
"entityType": "string
"
}
],
"eventId": "string
",
"eventTimestamp": "string
",
"eventTypeName": "string
",
"eventVariables": {
"string
" : "string
"
},
"labelTimestamp": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- assignedLabel
-
The label to associate with the event. Required if specifying
labelTimestamp
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_-]+$
Required: No
- entities
-
An array of entities.
Type: Array of Entity objects
Required: Yes
- eventId
-
The event ID to upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_-]+$
Required: Yes
- eventTimestamp
-
The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 30.
Required: Yes
- eventTypeName
-
The event type name of the event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_-]+$
Required: Yes
- 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.
Type: String to string map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Value Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: Yes
- labelTimestamp
-
The timestamp associated with the label. Required if specifying
assignedLabel
.Type: String
Length Constraints: Minimum length of 10. Maximum length of 30.
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as
PutExternalModel
, that specifies a role that is not in your account.HTTP Status Code: 400
- ConflictException
-
An exception indicating there was a conflict during a delete operation.
HTTP Status Code: 400
- InternalServerException
-
An exception indicating an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
An exception indicating the specified resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
An exception indicating a throttling error.
HTTP Status Code: 400
- ValidationException
-
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: