[ aws . frauddetector ]

update-model-version

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-model-version
--model-id <value>
--model-type <value>
--major-version-number <value>
[--external-events-detail <value>]
[--ingested-events-detail <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--model-id (string)

The model ID.

--model-type (string)

The model type.

Possible values:

• ONLINE_FRAUD_INSIGHTS

• TRANSACTION_FRAUD_INSIGHTS

• ACCOUNT_TAKEOVER_INSIGHTS

--major-version-number (string)

The major version number.

--external-events-detail (structure)

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

dataLocation -> (string)

The Amazon S3 bucket location for the data.

dataAccessRoleArn -> (string)

The ARN of the role that provides Amazon Fraud Detector access to the data location.

Shorthand Syntax:

dataLocation=string,dataAccessRoleArn=string

JSON Syntax:

{
  "dataLocation": "string",
  "dataAccessRoleArn": "string"
}

--ingested-events-detail (structure)

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

ingestedEventsTimeWindow -> (structure)

The start and stop time of the ingested events.

startTime -> (string)

Timestamp of the first ingensted event.

endTime -> (string)

Timestamp of the final ingested event.

Shorthand Syntax:

ingestedEventsTimeWindow={startTime=string,endTime=string}

JSON Syntax:

{
  "ingestedEventsTimeWindow": {
    "startTime": "string",
    "endTime": "string"
  }
}

--tags (list)

A collection of key and value pairs.

(structure)

A key and value pair.

key -> (string)

A tag key.

value -> (string)

A value assigned to a tag key.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

modelId -> (string)

The model ID.

modelType -> (string)

The model type.

modelVersionNumber -> (string)

The model version number of the model version updated.

status -> (string)

The status of the updated model version.