FraudDetector / Client / get_event

get_event

FraudDetector.Client.get_event(**kwargs)

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

See also: AWS API Documentation

Request Syntax

response = client.get_event(
    eventId='string',
    eventTypeName='string'
)

Parameters:

• eventId (string) –

  [REQUIRED]

  The ID of the event to retrieve.

• eventTypeName (string) –

  [REQUIRED]

  The event type of the event to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'event': {
        'eventId': 'string',
        'eventTypeName': 'string',
        'eventTimestamp': 'string',
        'eventVariables': {
            'string': 'string'
        },
        'currentLabel': 'string',
        'labelTimestamp': 'string',
        'entities': [
            {
                'entityType': 'string',
                'entityId': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • event (dict) –

    The details of the event.

    • eventId (string) –

      The event ID.

    • eventTypeName (string) –

      The event type.

    • eventTimestamp (string) –

      The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

    • eventVariables (dict) –

      Names of the event type’s variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

      • (string) –

        • (string) –

    • currentLabel (string) –

      The label associated with the event.

    • labelTimestamp (string) –

      The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.

    • entities (list) –

      The event entities.

      • (dict) –

        The entity details.

        • entityType (string) –

          The entity type.

        • entityId (string) –

          The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.

Exceptions

• FraudDetector.Client.exceptions.ValidationException

• FraudDetector.Client.exceptions.ResourceNotFoundException

• FraudDetector.Client.exceptions.InternalServerException

• FraudDetector.Client.exceptions.ThrottlingException

• FraudDetector.Client.exceptions.AccessDeniedException