DescribeModelVersions
Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.
Request Syntax
{
"maxResults": number,
"modelId": "string",
"modelType": "string",
"modelVersionNumber": "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 results to return.
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_INSIGHTSRequired: No
- modelVersionNumber
-
The model version number.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 7.
Pattern:
^[1-9][0-9]{0,3}\.[0-9]{1,2}$Required: No
- nextToken
-
The next token from the previous results.
Type: String
Required: No
Response Syntax
{
"modelVersionDetails": [
{
"arn": "string",
"createdTime": "string",
"externalEventsDetail": {
"dataAccessRoleArn": "string",
"dataLocation": "string"
},
"ingestedEventsDetail": {
"ingestedEventsTimeWindow": {
"endTime": "string",
"startTime": "string"
}
},
"lastUpdatedTime": "string",
"modelId": "string",
"modelType": "string",
"modelVersionNumber": "string",
"status": "string",
"trainingDataSchema": {
"labelSchema": {
"labelMapper": {
"string" : [ "string" ]
},
"unlabeledEventsTreatment": "string"
},
"modelVariables": [ "string" ]
},
"trainingDataSource": "string",
"trainingResult": {
"dataValidationMetrics": {
"fieldLevelMessages": [
{
"content": "string",
"fieldName": "string",
"identifier": "string",
"title": "string",
"type": "string"
}
],
"fileLevelMessages": [
{
"content": "string",
"title": "string",
"type": "string"
}
]
},
"trainingMetrics": {
"auc": number,
"metricDataPoints": [
{
"fpr": number,
"precision": number,
"threshold": number,
"tpr": number
}
]
},
"variableImportanceMetrics": {
"logOddsMetrics": [
{
"variableImportance": number,
"variableName": "string",
"variableType": "string"
}
]
}
},
"trainingResultV2": {
"aggregatedVariablesImportanceMetrics": {
"logOddsMetrics": [
{
"aggregatedVariablesImportance": number,
"variableNames": [ "string" ]
}
]
},
"dataValidationMetrics": {
"fieldLevelMessages": [
{
"content": "string",
"fieldName": "string",
"identifier": "string",
"title": "string",
"type": "string"
}
],
"fileLevelMessages": [
{
"content": "string",
"title": "string",
"type": "string"
}
]
},
"trainingMetricsV2": {
"ati": {
"metricDataPoints": [
{
"adr": number,
"atodr": number,
"cr": number,
"threshold": number
}
],
"modelPerformance": {
"asi": number
}
},
"ofi": {
"metricDataPoints": [
{
"fpr": number,
"precision": number,
"threshold": number,
"tpr": number
}
],
"modelPerformance": {
"auc": number,
"uncertaintyRange": {
"lowerBoundValue": number,
"upperBoundValue": number
}
}
},
"tfi": {
"metricDataPoints": [
{
"fpr": number,
"precision": number,
"threshold": number,
"tpr": number
}
],
"modelPerformance": {
"auc": number,
"uncertaintyRange": {
"lowerBoundValue": number,
"upperBoundValue": number
}
}
}
},
"variableImportanceMetrics": {
"logOddsMetrics": [
{
"variableImportance": number,
"variableName": "string",
"variableType": "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.
- modelVersionDetails
-
The model version details.
Type: Array of ModelVersionDetail objects
- nextToken
-
The next token.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
