GetModelVersion - Amazon Fraud Detector
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

GetModelVersion

Gets the details of the specified model version.

Request Syntax

{
   "modelId": "string",
   "modelType": "string",
   "modelVersionNumber": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

modelId

The model ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_]+$

Required: Yes

modelType

The model type.

Type: String

Valid Values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS | ACCOUNT_TAKEOVER_INSIGHTS

Required: Yes

modelVersionNumber

The model version number.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 7.

Pattern: ^[1-9][0-9]{0,3}\.[0-9]{1,2}$

Required: Yes

Response Syntax

{
   "arn": "string",
   "externalEventsDetail": { 
      "dataAccessRoleArn": "string",
      "dataLocation": "string"
   },
   "ingestedEventsDetail": { 
      "ingestedEventsTimeWindow": { 
         "endTime": "string",
         "startTime": "string"
      }
   },
   "modelId": "string",
   "modelType": "string",
   "modelVersionNumber": "string",
   "status": "string",
   "trainingDataSchema": { 
      "labelSchema": { 
         "labelMapper": { 
            "string" : [ "string" ]
         },
         "unlabeledEventsTreatment": "string"
      },
      "modelVariables": [ "string" ]
   },
   "trainingDataSource": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The model version ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn\:aws[a-z-]{0,15}\:frauddetector\:[a-z0-9-]{3,20}\:[0-9]{12}\:[^\s]{2,128}$

externalEventsDetail

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

Type: ExternalEventsDetail object

ingestedEventsDetail

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

Type: IngestedEventsDetail object

modelId

The model ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_]+$

modelType

The model type.

Type: String

Valid Values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS | ACCOUNT_TAKEOVER_INSIGHTS

modelVersionNumber

The model version number.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 7.

Pattern: ^[1-9][0-9]{0,3}\.[0-9]{1,2}$

status

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

Type: String

trainingDataSchema

The training data schema.

Type: TrainingDataSchema object

trainingDataSource

The training data source.

Type: String

Valid Values: EXTERNAL_EVENTS | INGESTED_EVENTS

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 400

InternalServerException

An exception indicating an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

An exception indicating the specified resource was not found.

HTTP Status Code: 400

ThrottlingException

An exception indicating a throttling error.

HTTP Status Code: 400

ValidationException

An exception indicating a specified value is not allowed.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: