Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . frauddetector ]

put-external-model

Description

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-external-model
--model-endpoint <value>
--model-source <value>
--invoke-model-endpoint-role-arn <value>
--input-configuration <value>
--output-configuration <value>
--model-endpoint-status <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--model-endpoint (string)

The model endpoints name.

--model-source (string)

The source of the model.

Possible values:

  • SAGEMAKER

--invoke-model-endpoint-role-arn (string)

The IAM role used to invoke the model endpoint.

--input-configuration (structure)

The model endpoint input configuration.

eventTypeName -> (string)

The event type name.

format -> (string)

The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.

useEventVariables -> (boolean)

The event variables.

jsonInputTemplate -> (string)

Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.

csvInputTemplate -> (string)

Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.

Shorthand Syntax:

eventTypeName=string,format=string,useEventVariables=boolean,jsonInputTemplate=string,csvInputTemplate=string

JSON Syntax:

{
  "eventTypeName": "string",
  "format": "TEXT_CSV"|"APPLICATION_JSON",
  "useEventVariables": true|false,
  "jsonInputTemplate": "string",
  "csvInputTemplate": "string"
}

--output-configuration (structure)

The model endpoint output configuration.

format -> (string)

The format of the model output configuration.

jsonKeyToVariableMap -> (map)

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

key -> (string)

value -> (string)

csvIndexToVariableMap -> (map)

A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.

key -> (string)

value -> (string)

Shorthand Syntax:

format=string,jsonKeyToVariableMap={KeyName1=string,KeyName2=string},csvIndexToVariableMap={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "format": "TEXT_CSV"|"APPLICATION_JSONLINES",
  "jsonKeyToVariableMap": {"string": "string"
    ...},
  "csvIndexToVariableMap": {"string": "string"
    ...}
}

--model-endpoint-status (string)

The model endpoint’s status in Amazon Fraud Detector.

Possible values:

  • ASSOCIATED
  • DISSOCIATED

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None