DescribeDetectorCommand

Suggest an Edit

Gets all versions for a specified detector.

Example Syntax

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

import { FraudDetectorClient, DescribeDetectorCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, DescribeDetectorCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // DescribeDetectorRequest
  detectorId: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new DescribeDetectorCommand(input);
const response = await client.send(command);
// { // DescribeDetectorResult
//   detectorId: "STRING_VALUE",
//   detectorVersionSummaries: [ // DetectorVersionSummaryList
//     { // DetectorVersionSummary
//       detectorVersionId: "STRING_VALUE",
//       status: "DRAFT" || "ACTIVE" || "INACTIVE",
//       description: "STRING_VALUE",
//       lastUpdatedTime: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
//   arn: "STRING_VALUE",
// };

DescribeDetectorCommand Input

See DescribeDetectorCommandInput for more details

Parameter
Type
Description
detectorId
Required
string | undefined

The detector ID.

maxResults
number | undefined

The maximum number of results to return for the request.

nextToken
string | undefined

The next token from the previous response.

DescribeDetectorCommand Output

See DescribeDetectorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
string | undefined

The detector ARN.

detectorId
string | undefined

The detector ID.

detectorVersionSummaries
DetectorVersionSummary[] | undefined

The status and description for each detector version.

nextToken
string | undefined

The next token to be used for subsequent requests.

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.