CreateListCommand

Suggest an Edit

Creates a list.

List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists .

Example Syntax

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

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

CreateListCommand Input

See CreateListCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the list.

description
string | undefined

The description of the list.

elements
string[] | undefined

The names of the elements, if providing. You can also create an empty list and add elements later using the UpdateList  API.

tags
Tag[] | undefined

A collection of the key and value pairs.

variableType
string | undefined

The variable type of the list. You can only assign the variable type with String data type. For more information, see Variable types .

CreateListCommand Output

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