GetDetectorVersionCommand

Gets a particular detector version.

Example Syntax

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

import { FraudDetectorClient, GetDetectorVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, GetDetectorVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // GetDetectorVersionRequest
  detectorId: "STRING_VALUE", // required
  detectorVersionId: "STRING_VALUE", // required
};
const command = new GetDetectorVersionCommand(input);
const response = await client.send(command);
// { // GetDetectorVersionResult
//   detectorId: "STRING_VALUE",
//   detectorVersionId: "STRING_VALUE",
//   description: "STRING_VALUE",
//   externalModelEndpoints: [ // ListOfStrings
//     "STRING_VALUE",
//   ],
//   modelVersions: [ // ListOfModelVersions
//     { // ModelVersion
//       modelId: "STRING_VALUE", // required
//       modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS", // required
//       modelVersionNumber: "STRING_VALUE", // required
//       arn: "STRING_VALUE",
//     },
//   ],
//   rules: [ // RuleList
//     { // Rule
//       detectorId: "STRING_VALUE", // required
//       ruleId: "STRING_VALUE", // required
//       ruleVersion: "STRING_VALUE", // required
//     },
//   ],
//   status: "DRAFT" || "ACTIVE" || "INACTIVE",
//   lastUpdatedTime: "STRING_VALUE",
//   createdTime: "STRING_VALUE",
//   ruleExecutionMode: "ALL_MATCHED" || "FIRST_MATCHED",
//   arn: "STRING_VALUE",
// };

GetDetectorVersionCommand Input

See GetDetectorVersionCommandInput for more details

Parameter
Type
Description
detectorId
Required
string | undefined

The detector ID.

detectorVersionId
Required
string | undefined

The detector version ID.

GetDetectorVersionCommand Output

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

The detector version ARN.

createdTime
string | undefined

The timestamp when the detector version was created.

description
string | undefined

The detector version description.

detectorId
string | undefined

The detector ID.

detectorVersionId
string | undefined

The detector version ID.

externalModelEndpoints
string[] | undefined

The Amazon SageMaker model endpoints included in the detector version.

lastUpdatedTime
string | undefined

The timestamp when the detector version was last updated.

modelVersions
ModelVersion[] | undefined

The model versions included in the detector version.

ruleExecutionMode
RuleExecutionMode | undefined

The execution mode of the rule in the dectector

FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

rules
Rule[] | undefined

The rules included in the detector version.

status
DetectorVersionStatus | undefined

The status of the detector version.

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.