Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]



Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--application-id <value>
--events-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--application-id (string) The unique ID of your Amazon Pinpoint application.

--events-request (structure) A set of events to process.

JSON Syntax:

  "BatchItem": {"string": {
        "Endpoint": {
          "Address": "string",
          "Attributes": {"string": ["string", ...]
          "Demographic": {
            "AppVersion": "string",
            "Locale": "string",
            "Make": "string",
            "Model": "string",
            "ModelVersion": "string",
            "Platform": "string",
            "PlatformVersion": "string",
            "Timezone": "string"
          "EffectiveDate": "string",
          "EndpointStatus": "string",
          "Location": {
            "City": "string",
            "Country": "string",
            "Latitude": double,
            "Longitude": double,
            "PostalCode": "string",
            "Region": "string"
          "Metrics": {"string": double
          "OptOut": "string",
          "RequestId": "string",
          "User": {
            "UserAttributes": {"string": ["string", ...]
            "UserId": "string"
        "Events": {"string": {
              "AppPackageName": "string",
              "AppTitle": "string",
              "AppVersionCode": "string",
              "Attributes": {"string": "string"
              "ClientSdkVersion": "string",
              "EventType": "string",
              "Metrics": {"string": double
              "SdkName": "string",
              "Session": {
                "Duration": integer,
                "Id": "string",
                "StartTimestamp": "string",
                "StopTimestamp": "string"
              "Timestamp": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


EventsResponse -> (structure)

Custom messages associated with events.

Results -> (map)

A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value. If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing).

key -> (string)

value -> (structure)

The response that's provided after registering the endpoint.

EndpointItemResponse -> (structure)

The response received after the endpoint was accepted.

Message -> (string)

A custom message associated with the registration of an endpoint when issuing a response.

StatusCode -> (integer)

The status code associated with the merging of an endpoint when issuing a response.

EventsItemResponse -> (map)

A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value.

key -> (string)

value -> (structure)

A complex object that holds the status code and message as a result of processing an event.

Message -> (string)

A custom message that is associated with the processing of an event.

StatusCode -> (integer)

The status returned in the response as a result of processing the event. Possible values: 400 (for invalid events) and 202 (for events that were accepted).