CloudWatchEvidently / Client / put_project_events

put_project_events#

CloudWatchEvidently.Client.put_project_events(**kwargs)#

Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.

See also: AWS API Documentation

Request Syntax

response = client.put_project_events(
    events=[
        {
            'data': 'string',
            'timestamp': datetime(2015, 1, 1),
            'type': 'aws.evidently.evaluation'|'aws.evidently.custom'
        },
    ],
    project='string'
)
Parameters:

  • events (list) –

    [REQUIRED]

    An array of event structures that contain the performance data that is being sent to Evidently.

    • (dict) –

      A structure that contains the information about one evaluation event or custom event sent to Evidently. This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the defined event schema.

      • data (string) – [REQUIRED]

        The event data.

      • timestamp (datetime) – [REQUIRED]

        The timestamp of the event.

      • type (string) – [REQUIRED]

        aws.evidently.evaluation specifies an evaluation event, which determines which feature variation that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user actions such as clicks and checkouts.

  • project (string) –

    [REQUIRED]

    The name or ARN of the project to write the events to.

Return type:

dict

Returns:

Response Syntax

{
    'eventResults': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'eventId': 'string'
        },
    ],
    'failedEventCount': 123
}

Response Structure

  • (dict) –

    • eventResults (list) –

      A structure that contains Evidently’s response to the sent events, including an event ID and error codes, if any.

      • (dict) –

        A structure that contains Evidently’s response to the sent events, including an event ID and error codes, if any.

        • errorCode (string) –

          If the PutProjectEvents operation has an error, the error code is returned here.

        • errorMessage (string) –

          If the PutProjectEvents operation has an error, the error message is returned here.

        • eventId (string) –

          A unique ID assigned to this PutProjectEvents operation.

    • failedEventCount (integer) –

      The number of events in the operation that could not be used by Evidently.

Exceptions