VoiceID / Client / describe_fraudster

describe_fraudster#

VoiceID.Client.describe_fraudster(**kwargs)#

Describes the specified fraudster.

Request Syntax

response = client.describe_fraudster(
    DomainId='string',
    FraudsterId='string'
)

Parameters:

DomainId (string) –
[REQUIRED]

The identifier of the domain that contains the fraudster.
FraudsterId (string) –
[REQUIRED]

The identifier of the fraudster you are describing.

Return type:

dict

Returns:

Response Syntax

{
    'Fraudster': {
        'CreatedAt': datetime(2015, 1, 1),
        'DomainId': 'string',
        'GeneratedFraudsterId': 'string',
        'WatchlistIds': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- Fraudster (dict) –
  
  Information about the specified fraudster.
  - CreatedAt (datetime) –
    
    The timestamp of when Voice ID identified the fraudster.
  - DomainId (string) –
    
    The identifier of the domain that contains the fraudster.
  - GeneratedFraudsterId (string) –
    
    The service-generated identifier for the fraudster.
  - WatchlistIds (list) –
    
    The identifier of the watchlists the fraudster is a part of.
    - (string) –

Exceptions

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