PutEventType
Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
Request Syntax
{
"description": "string",
"entityTypes": [ "string" ],
"eventIngestion": "string",
"eventOrchestration": {
"eventBridgeEnabled": boolean
},
"eventVariables": [ "string" ],
"labels": [ "string" ],
"name": "string",
"tags": [
{
"key": "string",
"value": "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.
- description
-
The description of the event type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- entityTypes
-
The entity type for the event type. Example entity types: customer, merchant, account.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes
- eventIngestion
-
Specifies if ingestion is enabled or disabled.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- eventOrchestration
-
Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.
Type: EventOrchestration object
Required: No
- eventVariables
-
The event type variables.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes
- labels
-
The event type labels.
Type: Array of strings
Required: No
- name
-
The name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_-]+$Required: Yes
-
A collection of key and value pairs.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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
- 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:
