GetModels - Amazon Fraud Detector

GetModels

Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination.

Request Syntax

{ "maxResults": number, "modelId": "string", "modelType": "string", "nextToken": "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.

maxResults

The maximum results to return for the request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: No

modelId

The model ID.

Type: String

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

Pattern: ^[0-9a-z_-]+$

Required: No

modelType

The model type.

Type: String

Valid Values: ONLINE_FRAUD_INSIGHTS

Required: No

nextToken

The next token for the request.

Type: String

Required: No

Response Syntax

{ "models": [ { "createdTime": "string", "description": "string", "labelSchema": { "labelKey": "string", "labelMapper": { "string" : [ "string" ] } }, "lastUpdatedTime": "string", "modelId": "string", "modelType": "string", "modelVariables": [ { "index": number, "name": "string" } ], "trainingDataSource": { "dataAccessRoleArn": "string", "dataLocation": "string" } } ], "nextToken": "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.

models

The returned models.

Type: Array of Model objects

nextToken

The next token for subsequent requests.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

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: