describe_detector

FraudDetector.Client.describe_detector(**kwargs)

Gets all versions for a specified detector.

See also: AWS API Documentation

Request Syntax

response = client.describe_detector(
    detectorId='string',
    nextToken='string',
    maxResults=123
)

Parameters

• detectorId (string) --

  [REQUIRED]

  The detector ID.

• nextToken (string) -- The next token from the previous response.
• maxResults (integer) -- The maximum number of results to return for the request.

Return type

dict

Returns

Response Syntax

{
    'detectorId': 'string',
    'detectorVersionSummaries': [
        {
            'detectorVersionId': 'string',
            'status': 'DRAFT'|'ACTIVE'|'INACTIVE',
            'description': 'string',
            'lastUpdatedTime': 'string'
        },
    ],
    'nextToken': 'string',
    'arn': 'string'
}

Response Structure

• (dict) --

  • detectorId (string) --

    The detector ID.

  • detectorVersionSummaries (list) --

    The status and description for each detector version.

    • (dict) --

      The summary of the detector version.

      • detectorVersionId (string) --

        The detector version ID.

      • status (string) --

        The detector version status.

      • description (string) --

        The detector version description.

      • lastUpdatedTime (string) --

        Timestamp of when the detector version was last updated.

  • nextToken (string) --

    The next token to be used for subsequent requests.

  • arn (string) --

    The detector ARN.

Exceptions

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