GetModelVersionCommand

Suggest an Edit

Gets the details of the specified model version.

Example Syntax

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

import { FraudDetectorClient, GetModelVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, GetModelVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // GetModelVersionRequest
  modelId: "STRING_VALUE", // required
  modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS", // required
  modelVersionNumber: "STRING_VALUE", // required
};
const command = new GetModelVersionCommand(input);
const response = await client.send(command);
// { // GetModelVersionResult
//   modelId: "STRING_VALUE",
//   modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS",
//   modelVersionNumber: "STRING_VALUE",
//   trainingDataSource: "EXTERNAL_EVENTS" || "INGESTED_EVENTS",
//   trainingDataSchema: { // TrainingDataSchema
//     modelVariables: [ // ListOfStrings // required
//       "STRING_VALUE",
//     ],
//     labelSchema: { // LabelSchema
//       labelMapper: { // labelMapper
//         "<keys>": [
//           "STRING_VALUE",
//         ],
//       },
//       unlabeledEventsTreatment: "IGNORE" || "FRAUD" || "LEGIT" || "AUTO",
//     },
//   },
//   externalEventsDetail: { // ExternalEventsDetail
//     dataLocation: "STRING_VALUE", // required
//     dataAccessRoleArn: "STRING_VALUE", // required
//   },
//   ingestedEventsDetail: { // IngestedEventsDetail
//     ingestedEventsTimeWindow: { // IngestedEventsTimeWindow
//       startTime: "STRING_VALUE", // required
//       endTime: "STRING_VALUE", // required
//     },
//   },
//   status: "STRING_VALUE",
//   arn: "STRING_VALUE",
// };

GetModelVersionCommand Input

See GetModelVersionCommandInput for more details

Parameter
Type
Description
modelId
Required
string | undefined

The model ID.

modelType
Required
ModelTypeEnum | undefined

The model type.

modelVersionNumber
Required
string | undefined

The model version number.

GetModelVersionCommand Output

See GetModelVersionCommandOutput for details

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

The model version ARN.

externalEventsDetail
ExternalEventsDetail | undefined

The details of the external events data used for training the model version. This will be populated if the trainingDataSource is EXTERNAL_EVENTS

ingestedEventsDetail
IngestedEventsDetail | undefined

The details of the ingested events data used for training the model version. This will be populated if the trainingDataSource is INGESTED_EVENTS.

modelId
string | undefined

The model ID.

modelType
ModelTypeEnum | undefined

The model type.

modelVersionNumber
string | undefined

The model version number.

status
string | undefined

The model version status.

Possible values are:

  • TRAINING_IN_PROGRESS

  • TRAINING_COMPLETE

  • ACTIVATE_REQUESTED

  • ACTIVATE_IN_PROGRESS

  • ACTIVE

  • INACTIVATE_REQUESTED

  • INACTIVATE_IN_PROGRESS

  • INACTIVE

  • ERROR

trainingDataSchema
TrainingDataSchema | undefined

The training data schema.

trainingDataSource
TrainingDataSourceEnum | undefined

The training data source.

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.