BatchGetVariableCommand

Suggest an Edit

Gets a batch of variables.

Example Syntax

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

import { FraudDetectorClient, BatchGetVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, BatchGetVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // BatchGetVariableRequest
  names: [ // NameList // required
    "STRING_VALUE",
  ],
};
const command = new BatchGetVariableCommand(input);
const response = await client.send(command);
// { // BatchGetVariableResult
//   variables: [ // VariableList
//     { // Variable
//       name: "STRING_VALUE",
//       dataType: "STRING" || "INTEGER" || "FLOAT" || "BOOLEAN" || "DATETIME",
//       dataSource: "EVENT" || "MODEL_SCORE" || "EXTERNAL_MODEL_SCORE",
//       defaultValue: "STRING_VALUE",
//       description: "STRING_VALUE",
//       variableType: "STRING_VALUE",
//       lastUpdatedTime: "STRING_VALUE",
//       createdTime: "STRING_VALUE",
//       arn: "STRING_VALUE",
//     },
//   ],
//   errors: [ // BatchGetVariableErrorList
//     { // BatchGetVariableError
//       name: "STRING_VALUE",
//       code: Number("int"),
//       message: "STRING_VALUE",
//     },
//   ],
// };

BatchGetVariableCommand Input

See BatchGetVariableCommandInput for more details

Parameter
Type
Description
names
Required
string[] | undefined

The list of variable names to get.

BatchGetVariableCommand Output

See BatchGetVariableCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
errors
BatchGetVariableError[] | undefined

The errors from the request.

variables
Variable[] | undefined

The returned variables.

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.