GetDetectorVersion - Amazon Fraud Detector

GetDetectorVersion

Gets a particular detector version.

Request Syntax

{ "detectorId": "string", "detectorVersionId": "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.

detectorId

The detector ID.

Type: String

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

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

Required: Yes

detectorVersionId

The detector version ID.

Type: String

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

Pattern: ^([1-9][0-9]*)$

Required: Yes

Response Syntax

{ "arn": "string", "createdTime": "string", "description": "string", "detectorId": "string", "detectorVersionId": "string", "externalModelEndpoints": [ "string" ], "lastUpdatedTime": "string", "modelVersions": [ { "arn": "string", "modelId": "string", "modelType": "string", "modelVersionNumber": "string" } ], "ruleExecutionMode": "string", "rules": [ { "detectorId": "string", "ruleId": "string", "ruleVersion": "string" } ], "status": "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.

arn

The detector version ARN.

Type: String

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

Pattern: ^arn\:aws[a-z-]{0,15}\:frauddetector\:[a-z0-9-]{3,20}\:[0-9]{12}\:[^\s]{2,128}$

createdTime

The timestamp when the detector version was created.

Type: String

description

The detector version description.

Type: String

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

detectorId

The detector ID.

Type: String

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

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

detectorVersionId

The detector version ID.

Type: String

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

Pattern: ^([1-9][0-9]*)$

externalModelEndpoints

The Amazon SageMaker model endpoints included in the detector version.

Type: Array of strings

lastUpdatedTime

The timestamp when the detector version was last updated.

Type: String

modelVersions

The model versions included in the detector version.

Type: Array of ModelVersion objects

ruleExecutionMode

The execution mode of the rule in the dectector

FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

Type: String

Valid Values: ALL_MATCHED | FIRST_MATCHED

rules

The rules included in the detector version.

Type: Array of Rule objects

status

The status of the detector version.

Type: String

Valid Values: DRAFT | ACTIVE | INACTIVE

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: