DescribeModelVersions - Amazon Fraud Detector

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

Required: No

modelVersionNumber

The model version.

Type: String

Length Constraints: Minimum length of 1.

Required: No

nextToken

The next token from the previous results.

Type: String

Required: No

Response Syntax

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

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: