[ aws . frauddetector ]

get-external-models

Description

Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults , this actions retrieves a maximum of 10 records per page. If you provide a maxResults , the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-external-models
[--model-endpoint <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--model-endpoint (string)

The Amazon SageMaker model endpoint.

--next-token (string)

The next page token for the request.

--max-results (integer)

The maximum number of objects to return for the request.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

externalModels -> (list)

Gets the Amazon SageMaker models.

(structure)

The Amazon SageMaker model.

modelEndpoint -> (string)

The Amazon SageMaker model endpoints.

eventTypeName -> (string)

The event type names.

modelSource -> (string)

The source of the model.

role -> (structure)

The role used to invoke the model.

arn -> (string)

The role ARN.

name -> (string)

The role name.

inputConfiguration -> (structure)

The input configuration.

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.

outputConfiguration -> (structure)

The 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)

modelEndpointStatus -> (string)

The Amazon Fraud Detector status for the external model endpoint

lastUpdatedTime -> (string)

Timestamp of when the model was last updated.

createdTime -> (string)

Timestamp of when the model was last created.

arn -> (string)

The model ARN.

nextToken -> (string)

The next page token to be used in subsequent requests.