Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

put-events

Description

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--events-request (structure)

Specifies a batch of events to process.

JSON Syntax:

{
  "BatchItem": {"string": {
        "Endpoint": {
          "Address": "string",
          "Attributes": {"string": ["string", ...]
            ...},
          "ChannelType": "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM",
          "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.

Output

EventsResponse -> (structure)

Provides information about endpoints and the events that they're associated with.

Results -> (map)

A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

key -> (string)

value -> (structure)

Provides information about the results of a request to create or update an endpoint that's associated with an event.

EndpointItemResponse -> (structure)

The response that was received after the endpoint data was accepted.

Message -> (string)

The custom message that's returned in the response as a result of processing the endpoint data.

StatusCode -> (integer)

The status code that's returned in the response as a result of processing the endpoint data.

EventsItemResponse -> (map)

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

key -> (string)

value -> (structure)

Provides the status code and message that result from processing an event.

Message -> (string)

A custom message that's returned in the response as a result of processing the event.

StatusCode -> (integer)

The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.