DeleteEventCommand

Suggest an Edit

Deletes the specified event.

When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FraudDetectorClient, DeleteEventCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, DeleteEventCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // DeleteEventRequest
  eventId: "STRING_VALUE", // required
  eventTypeName: "STRING_VALUE", // required
  deleteAuditHistory: true || false,
};
const command = new DeleteEventCommand(input);
const response = await client.send(command);
// {};

DeleteEventCommand Input

See DeleteEventCommandInput for more details

Parameter
Type
Description
eventId
Required
string | undefined

The ID of the event to delete.

eventTypeName
Required
string | undefined

The name of the event type.

deleteAuditHistory
boolean | undefined

Specifies whether or not to delete any predictions associated with the event. If set to True,

DeleteEventCommand Output

See DeleteEventCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

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.

InternalServerException
server

An exception indicating an internal server error.

ThrottlingException
client

An exception indicating a throttling error.

ValidationException
client

An exception indicating a specified value is not allowed.

FraudDetectorServiceException
Base exception class for all service exceptions from FraudDetector service.