Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetModels

Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

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 number of objects 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 | TRANSACTION_FRAUD_INSIGHTS | ACCOUNT_TAKEOVER_INSIGHTS

Required: No

nextToken

The next token for the subsequent request.

Type: String

Required: No

Response Syntax


{
   "models": [ 
      { 
         "arn": "string",
         "createdTime": "string",
         "description": "string",
         "eventTypeName": "string",
         "lastUpdatedTime": "string",
         "modelId": "string",
         "modelType": "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 array of models.

Type: Array of Model objects

nextToken

The next page token to be used in subsequent requests.

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

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