Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateModelVersion

Creates a version of the model using the specified model type and model id.

Request Syntax


{
   "externalEventsDetail": { 
      "dataAccessRoleArn": "string",
      "dataLocation": "string"
   },
   "ingestedEventsDetail": { 
      "ingestedEventsTimeWindow": { 
         "endTime": "string",
         "startTime": "string"
      }
   },
   "modelId": "string",
   "modelType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "trainingDataSchema": { 
      "labelSchema": { 
         "labelMapper": { 
            "string" : [ "string" ]
         },
         "unlabeledEventsTreatment": "string"
      },
      "modelVariables": [ "string" ]
   },
   "trainingDataSource": "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.

externalEventsDetail

Details of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

Type: ExternalEventsDetail object

Required: No

ingestedEventsDetail

Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.

Type: IngestedEventsDetail object

Required: No

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

tags

A collection of key and value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

trainingDataSchema

The training data schema.

Type: TrainingDataSchema object

Required: Yes

trainingDataSource

The training data source location in Amazon S3.

Type: String

Valid Values: EXTERNAL_EVENTS | INGESTED_EVENTS

Required: Yes

Response Syntax


{
   "modelId": "string",
   "modelType": "string",
   "modelVersionNumber": "string",
   "status": "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.

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 of the model version created.

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.

Type: String

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