- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutDetectorCommand
Creates or updates a detector.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { FraudDetectorClient, PutDetectorCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, PutDetectorCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // PutDetectorRequest
detectorId: "STRING_VALUE", // required
description: "STRING_VALUE",
eventTypeName: "STRING_VALUE", // required
tags: [ // tagList
{ // Tag
key: "STRING_VALUE", // required
value: "STRING_VALUE", // required
},
],
};
const command = new PutDetectorCommand(input);
const response = await client.send(command);
// {};
PutDetectorCommand Input
See PutDetectorCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
detectorId Required | string | undefined | The detector ID. |
eventTypeName Required | string | undefined | The name of the event type. |
description | string | undefined | The description of the detector. |
tags | Tag[] | undefined | A collection of key and value pairs. |
PutDetectorCommand Output
See PutDetectorCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
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 |
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. |