UpdateModelVersion - Amazon Fraud Detector

UpdateModelVersion

Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.

Request Syntax

{ "externalEventsDetail": { "dataAccessRoleArn": "string", "dataLocation": "string" }, "ingestedEventsDetail": { "ingestedEventsTimeWindow": { "endTime": "string", "startTime": "string" } }, "majorVersionNumber": "string", "modelId": "string", "modelType": "string", "tags": [ { "key": "string", "value": "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

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

Type: ExternalEventsDetail object

Required: No

ingestedEventsDetail

The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.

Type: IngestedEventsDetail object

Required: No

majorVersionNumber

The major version number.

Type: String

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

Pattern: ^([1-9][0-9]*)$

Required: Yes

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

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 updated.

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

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

ConflictException

An exception indicating there was a conflict during a delete operation.

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: