AWS Metrics API Event Schema

The AWS Metrics Gem provides the following JSON schema for validating input events. See the advanced topic on Metrics Event Schema for information on customizing the schema.

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "AWSMetrics API Event Schema",
    "description": "Metrics Event sent to the service API",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "application_id": {
            "type": "string",
            "pattern": "^[0-9-.]+-\\{[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}\\}$",
            "description": "Identifier for the application that generated the event."
        },
        "event_id": {
            "type": "string",
            "pattern": "^\\{[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}\\}$",
            "description": "A random UUID that uniquely identifies an event."
        },
        "event_type": {
            "type": "string",
            "pattern": "^[A-Za-z0-9-_.]+$",
            "description": "Identifies the type of event."
        },
        "event_name": {
            "type": "string",
            "pattern": "^[A-Za-z0-9-_.]+$",
            "description": "Name of the event that occurred."
        },
        "event_timestamp": {
            "type": "string",
            "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2})\\:(\\d{2})\\:(\\d{2})Z$",
            "description": "Timestamp of the event in the UTC ISO8601 format."
        },
        "event_version": {
            "type": "string",
            "pattern": "^[A-Za-z0-9-_.]+$",
            "description": "An API version for this event format."
        },
        "event_source": {
            "type": "string",
            "pattern": "^[A-Za-z0-9-_.]+$",
            "description": "Source of the event."
        },
        "event_data": {
            "type": "object",
            "description": "Custom metrics attributes defined by this event."
        }
    },
    "required": [ "application_id", "event_id", "event_name", "event_timestamp" ]
}

Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.