- 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.
DeleteListCommand
Deletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { FraudDetectorClient, DeleteListCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, DeleteListCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // DeleteListRequest
name: "STRING_VALUE", // required
};
const command = new DeleteListCommand(input);
const response = await client.send(command);
// {};
DeleteListCommand Input
See DeleteListCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
name Required | string | undefined | The name of the list to delete. |
DeleteListCommand Output
See DeleteListCommandOutput 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. |