get_event_types

FraudDetector.Client.get_event_types(**kwargs)

Gets all event types or a specific event type if name is provided. 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 GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

Request Syntax

response = client.get_event_types(
    name='string',
    nextToken='string',
    maxResults=123
)

Parameters

• name (string) -- The name.
• 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

{
    'eventTypes': [
        {
            'name': 'string',
            'description': 'string',
            'eventVariables': [
                'string',
            ],
            'labels': [
                'string',
            ],
            'entityTypes': [
                'string',
            ],
            'eventIngestion': 'ENABLED'|'DISABLED',
            'ingestedEventStatistics': {
                'numberOfEvents': 123,
                'eventDataSizeInBytes': 123,
                'leastRecentEvent': 'string',
                'mostRecentEvent': 'string',
                'lastUpdatedTime': 'string'
            },
            'lastUpdatedTime': 'string',
            'createdTime': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • eventTypes (list) --

    An array of event types.

    • (dict) --

      The event type details.

      • name (string) --

        The event type name.

      • description (string) --

        The event type description.

      • eventVariables (list) --

        The event type event variables.

        • (string) --

      • labels (list) --

        The event type labels.

        • (string) --

      • entityTypes (list) --

        The event type entity types.

        • (string) --

      • eventIngestion (string) --

        If Enabled , Amazon Fraud Detector stores event data when you generate a prediction and uses that data to update calculated variables in near real-time. Amazon Fraud Detector uses this data, known as INGESTED_EVENTS , to train your model and improve fraud predictions.

      • ingestedEventStatistics (dict) --

        Data about the stored events.

        • numberOfEvents (integer) --

          The number of stored events.

        • eventDataSizeInBytes (integer) --

          The total size of the stored events.

        • leastRecentEvent (string) --

          The oldest stored event.

        • mostRecentEvent (string) --

          The newest stored event.

        • lastUpdatedTime (string) --

          Timestamp of when the stored event was last updated.

      • lastUpdatedTime (string) --

        Timestamp of when the event type was last updated.

      • createdTime (string) --

        Timestamp of when the event type was created.

      • arn (string) --

        The entity type 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