PutEntityTypeCommand

Suggest an Edit

Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.

Example Syntax

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

import { FraudDetectorClient, PutEntityTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, PutEntityTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // PutEntityTypeRequest
  name: "STRING_VALUE", // required
  description: "STRING_VALUE",
  tags: [ // tagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
};
const command = new PutEntityTypeCommand(input);
const response = await client.send(command);
// {};

PutEntityTypeCommand Input

See PutEntityTypeCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the entity type.

description
string | undefined

The description.

tags
Tag[] | undefined

A collection of key and value pairs.

PutEntityTypeCommand Output

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