UpdateListCommand

Suggest an Edit

Updates a list.

Example Syntax

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

import { FraudDetectorClient, UpdateListCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, UpdateListCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // UpdateListRequest
  name: "STRING_VALUE", // required
  elements: [ // ElementsList
    "STRING_VALUE",
  ],
  description: "STRING_VALUE",
  updateMode: "REPLACE" || "APPEND" || "REMOVE",
  variableType: "STRING_VALUE",
};
const command = new UpdateListCommand(input);
const response = await client.send(command);
// {};

UpdateListCommand Input

See UpdateListCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the list to update.

description
string | undefined

The new description.

elements
string[] | undefined

One or more list elements to add or replace. If you are providing the elements, make sure to specify the updateMode to use.

If you are deleting all elements from the list, use REPLACE for the updateMode and provide an empty list (0 elements).

updateMode
ListUpdateMode | undefined

The update mode (type).

  • Use APPEND if you are adding elements to the list.

  • Use REPLACE if you replacing existing elements in the list.

  • Use REMOVE if you are removing elements from the list.

variableType
string | undefined

The variable type you want to assign to the list.

You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.

UpdateListCommand Output

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

ResourceNotFoundException
client

An exception indicating the specified resource was not found.

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.