FraudDetector / Client / get_detector_version

get_detector_version#

FraudDetector.Client.get_detector_version(**kwargs)#

Gets a particular detector version.

Request Syntax

response = client.get_detector_version(
    detectorId='string',
    detectorVersionId='string'
)

Parameters:

detectorId (string) –
[REQUIRED]

The detector ID.
detectorVersionId (string) –
[REQUIRED]

The detector version ID.

Return type:

dict

Returns:

Response Syntax

{
    'detectorId': 'string',
    'detectorVersionId': 'string',
    'description': 'string',
    'externalModelEndpoints': [
        'string',
    ],
    'modelVersions': [
        {
            'modelId': 'string',
            'modelType': 'ONLINE_FRAUD_INSIGHTS'|'TRANSACTION_FRAUD_INSIGHTS'|'ACCOUNT_TAKEOVER_INSIGHTS',
            'modelVersionNumber': 'string',
            'arn': 'string'
        },
    ],
    'rules': [
        {
            'detectorId': 'string',
            'ruleId': 'string',
            'ruleVersion': 'string'
        },
    ],
    'status': 'DRAFT'|'ACTIVE'|'INACTIVE',
    'lastUpdatedTime': 'string',
    'createdTime': 'string',
    'ruleExecutionMode': 'ALL_MATCHED'|'FIRST_MATCHED',
    'arn': 'string'
}

Response Structure

(dict) –
- detectorId (string) –
  
  The detector ID.
- detectorVersionId (string) –
  
  The detector version ID.
- description (string) –
  
  The detector version description.
- externalModelEndpoints (list) –
  
  The Amazon SageMaker model endpoints included in the detector version.
  - (string) –
- modelVersions (list) –
  
  The model versions included in the detector version.
  - (dict) –
    
    The model version.
    - modelId (string) –
      
      The model ID.
    - modelType (string) –
      
      The model type.
    - modelVersionNumber (string) –
      
      The model version number.
    - arn (string) –
      
      The model version ARN.
- rules (list) –
  
  The rules included in the detector version.
  - (dict) –
    
    A rule.
    - detectorId (string) –
      
      The detector for which the rule is associated.
    - ruleId (string) –
      
      The rule ID.
    - ruleVersion (string) –
      
      The rule version.
- status (string) –
  
  The status of the detector version.
- lastUpdatedTime (string) –
  
  The timestamp when the detector version was last updated.
- createdTime (string) –
  
  The timestamp when the detector version was created.
- ruleExecutionMode (string) –
  
  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.
- arn (string) –
  
  The detector version ARN.

Exceptions

FraudDetector.Client.exceptions.ValidationException
FraudDetector.Client.exceptions.ResourceNotFoundException
FraudDetector.Client.exceptions.InternalServerException
FraudDetector.Client.exceptions.ThrottlingException
FraudDetector.Client.exceptions.AccessDeniedException