FraudDetector / Client / get_detectors

get_detectors#

FraudDetector.Client.get_detectors(**kwargs)#

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.

Request Syntax

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

Parameters:

detectorId (string) – The detector ID.
nextToken (string) – The next token for the subsequent request.
maxResults (integer) – The maximum number of objects to return for the request.

Return type:

dict

Returns:

Response Syntax

{
    'detectors': [
        {
            'detectorId': 'string',
            'description': 'string',
            'eventTypeName': 'string',
            'lastUpdatedTime': 'string',
            'createdTime': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- detectors (list) –
  
  The detectors.
  - (dict) –
    
    The detector.
    - detectorId (string) –
      
      The detector ID.
    - description (string) –
      
      The detector description.
    - eventTypeName (string) –
      
      The name of the event type.
    - lastUpdatedTime (string) –
      
      Timestamp of when the detector was last updated.
    - createdTime (string) –
      
      Timestamp of when the detector was created.
    - arn (string) –
      
      The detector ARN.
- nextToken (string) –
  
  The next page token.

Exceptions

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