GetListsMetadataCommand

Suggest an Edit

Gets the metadata of either all the lists under the account or the specified list.

Example Syntax

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

import { FraudDetectorClient, GetListsMetadataCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, GetListsMetadataCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // GetListsMetadataRequest
  name: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new GetListsMetadataCommand(input);
const response = await client.send(command);
// { // GetListsMetadataResult
//   lists: [ // AllowDenyLists
//     { // AllowDenyList
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       variableType: "STRING_VALUE",
//       createdTime: "STRING_VALUE",
//       updatedTime: "STRING_VALUE",
//       arn: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

GetListsMetadataCommand Input

See GetListsMetadataCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

The maximum number of objects to return for the request.

name
string | undefined

The name of the list.

nextToken
string | undefined

The next token for the subsequent request.

GetListsMetadataCommand Output

See GetListsMetadataCommandOutput for details

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

The metadata of the specified list or all lists under the account.

nextToken
string | undefined

The next page token.

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.

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.