DeleteEntityTypeCommand

Suggest an Edit

Deletes an entity type.

You cannot delete an entity type that is included in an event type.

When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

Example Syntax

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

import { FraudDetectorClient, DeleteEntityTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, DeleteEntityTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // DeleteEntityTypeRequest
  name: "STRING_VALUE", // required
};
const command = new DeleteEntityTypeCommand(input);
const response = await client.send(command);
// {};

DeleteEntityTypeCommand Input

See DeleteEntityTypeCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the entity type to delete.

DeleteEntityTypeCommand Output

See DeleteEntityTypeCommandOutput 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.

ConflictException
client

An exception indicating there was a conflict during a delete operation.

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.